org.el 757 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215
  1. ;;; org.el --- Outline-based notes management and organizer
  2. ;; Carstens outline-mode for keeping track of everything.
  3. ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
  4. ;; Free Software Foundation, Inc.
  5. ;;
  6. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  7. ;; Keywords: outlines, hypermedia, calendar, wp
  8. ;; Homepage: http://orgmode.org
  9. ;; Version: 7.5
  10. ;;
  11. ;; This file is part of GNU Emacs.
  12. ;;
  13. ;; GNU Emacs is free software: you can redistribute it and/or modify
  14. ;; it under the terms of the GNU General Public License as published by
  15. ;; the Free Software Foundation, either version 3 of the License, or
  16. ;; (at your option) any later version.
  17. ;; GNU Emacs is distributed in the hope that it will be useful,
  18. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20. ;; GNU General Public License for more details.
  21. ;; You should have received a copy of the GNU General Public License
  22. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  23. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  24. ;;
  25. ;;; Commentary:
  26. ;;
  27. ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
  28. ;; project planning with a fast and effective plain-text system.
  29. ;;
  30. ;; Org-mode develops organizational tasks around NOTES files that contain
  31. ;; information about projects as plain text. Org-mode is implemented on
  32. ;; top of outline-mode, which makes it possible to keep the content of
  33. ;; large files well structured. Visibility cycling and structure editing
  34. ;; help to work with the tree. Tables are easily created with a built-in
  35. ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
  36. ;; and scheduling. It dynamically compiles entries into an agenda that
  37. ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
  38. ;; Plain text URL-like links connect to websites, emails, Usenet
  39. ;; messages, BBDB entries, and any files related to the projects. For
  40. ;; printing and sharing of notes, an Org-mode file can be exported as a
  41. ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
  42. ;; iCalendar file. It can also serve as a publishing tool for a set of
  43. ;; linked webpages.
  44. ;;
  45. ;; Installation and Activation
  46. ;; ---------------------------
  47. ;; See the corresponding sections in the manual at
  48. ;;
  49. ;; http://orgmode.org/org.html#Installation
  50. ;;
  51. ;; Documentation
  52. ;; -------------
  53. ;; The documentation of Org-mode can be found in the TeXInfo file. The
  54. ;; distribution also contains a PDF version of it. At the homepage of
  55. ;; Org-mode, you can read the same text online as HTML. There is also an
  56. ;; excellent reference card made by Philip Rooke. This card can be found
  57. ;; in the etc/ directory of Emacs 22.
  58. ;;
  59. ;; A list of recent changes can be found at
  60. ;; http://orgmode.org/Changes.html
  61. ;;
  62. ;;; Code:
  63. (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
  64. (defvar org-table-formula-constants-local nil
  65. "Local version of `org-table-formula-constants'.")
  66. (make-variable-buffer-local 'org-table-formula-constants-local)
  67. ;;;; Require other packages
  68. (eval-when-compile
  69. (require 'cl)
  70. (require 'gnus-sum))
  71. (require 'calendar)
  72. ;; Emacs 22 calendar compatibility: Make sure the new variables are available
  73. (when (fboundp 'defvaralias)
  74. (unless (boundp 'calendar-view-holidays-initially-flag)
  75. (defvaralias 'calendar-view-holidays-initially-flag
  76. 'view-calendar-holidays-initially))
  77. (unless (boundp 'calendar-view-diary-initially-flag)
  78. (defvaralias 'calendar-view-diary-initially-flag
  79. 'view-diary-entries-initially))
  80. (unless (boundp 'diary-fancy-buffer)
  81. (defvaralias 'diary-fancy-buffer 'fancy-diary-buffer)))
  82. (require 'outline) (require 'noutline)
  83. ;; Other stuff we need.
  84. (require 'time-date)
  85. (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
  86. (require 'easymenu)
  87. (require 'overlay)
  88. (require 'org-macs)
  89. (require 'org-entities)
  90. (require 'org-compat)
  91. (require 'org-faces)
  92. (require 'org-list)
  93. (require 'org-pcomplete)
  94. (require 'org-src)
  95. (require 'org-footnote)
  96. (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
  97. (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
  98. (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
  99. ;; babel
  100. (require 'ob)
  101. (require 'ob-table)
  102. (require 'ob-lob)
  103. (require 'ob-ref)
  104. (require 'ob-tangle)
  105. (require 'ob-comint)
  106. (require 'ob-keys)
  107. ;; load languages based on value of `org-babel-load-languages'
  108. (defvar org-babel-load-languages)
  109. ;;;###autoload
  110. (defun org-babel-do-load-languages (sym value)
  111. "Load the languages defined in `org-babel-load-languages'."
  112. (set-default sym value)
  113. (mapc (lambda (pair)
  114. (let ((active (cdr pair)) (lang (symbol-name (car pair))))
  115. (if active
  116. (progn
  117. (require (intern (concat "ob-" lang))))
  118. (progn
  119. (funcall 'fmakunbound
  120. (intern (concat "org-babel-execute:" lang)))
  121. (funcall 'fmakunbound
  122. (intern (concat "org-babel-expand-body:" lang)))))))
  123. org-babel-load-languages))
  124. (defcustom org-babel-load-languages '((emacs-lisp . t))
  125. "Languages which can be evaluated in Org-mode buffers.
  126. This list can be used to load support for any of the languages
  127. below, note that each language will depend on a different set of
  128. system executables and/or Emacs modes. When a language is
  129. \"loaded\", then code blocks in that language can be evaluated
  130. with `org-babel-execute-src-block' bound by default to C-c
  131. C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
  132. be set to remove code block evaluation from the C-c C-c
  133. keybinding. By default only Emacs Lisp (which has no
  134. requirements) is loaded."
  135. :group 'org-babel
  136. :set 'org-babel-do-load-languages
  137. :type '(alist :tag "Babel Languages"
  138. :key-type
  139. (choice
  140. (const :tag "C" C)
  141. (const :tag "R" R)
  142. (const :tag "Asymptote" asymptote)
  143. (const :tag "Calc" calc)
  144. (const :tag "Clojure" clojure)
  145. (const :tag "CSS" css)
  146. (const :tag "Ditaa" ditaa)
  147. (const :tag "Dot" dot)
  148. (const :tag "Emacs Lisp" emacs-lisp)
  149. (const :tag "Gnuplot" gnuplot)
  150. (const :tag "Haskell" haskell)
  151. (const :tag "Javascript" js)
  152. (const :tag "Latex" latex)
  153. (const :tag "Ledger" ledger)
  154. (const :tag "Maxima" maxima)
  155. (const :tag "Matlab" matlab)
  156. (const :tag "Mscgen" mscgen)
  157. (const :tag "Ocaml" ocaml)
  158. (const :tag "Octave" octave)
  159. (const :tag "Org" org)
  160. (const :tag "Perl" perl)
  161. (const :tag "PlantUML" plantuml)
  162. (const :tag "Python" python)
  163. (const :tag "Ruby" ruby)
  164. (const :tag "Sass" sass)
  165. (const :tag "Scheme" scheme)
  166. (const :tag "Screen" screen)
  167. (const :tag "Shell Script" sh)
  168. (const :tag "Sql" sql)
  169. (const :tag "Sqlite" sqlite))
  170. :value-type (boolean :tag "Activate" :value t)))
  171. ;;;; Customization variables
  172. (defcustom org-clone-delete-id nil
  173. "Remove ID property of clones of a subtree.
  174. When non-nil, clones of a subtree don't inherit the ID property.
  175. Otherwise they inherit the ID property with a new unique
  176. identifier."
  177. :type 'boolean
  178. :group 'org-id)
  179. ;;; Version
  180. (defconst org-version "7.5"
  181. "The version number of the file org.el.")
  182. (defun org-version (&optional here)
  183. "Show the org-mode version in the echo area.
  184. With prefix arg HERE, insert it at point."
  185. (interactive "P")
  186. (let* ((origin default-directory)
  187. (version org-version)
  188. (git-version)
  189. (dir (concat (file-name-directory (locate-library "org")) "../" )))
  190. (when (and (file-exists-p (expand-file-name ".git" dir))
  191. (executable-find "git"))
  192. (unwind-protect
  193. (progn
  194. (cd dir)
  195. (when (eql 0 (shell-command "git describe --abbrev=4 HEAD"))
  196. (with-current-buffer "*Shell Command Output*"
  197. (goto-char (point-min))
  198. (setq git-version (buffer-substring (point) (point-at-eol))))
  199. (subst-char-in-string ?- ?. git-version t)
  200. (when (string-match "\\S-"
  201. (shell-command-to-string
  202. "git diff-index --name-only HEAD --"))
  203. (setq git-version (concat git-version ".dirty")))
  204. (setq version (concat version " (" git-version ")"))))
  205. (cd origin)))
  206. (setq version (format "Org-mode version %s" version))
  207. (if here (insert version))
  208. (message version)))
  209. ;;; Compatibility constants
  210. ;;; The custom variables
  211. (defgroup org nil
  212. "Outline-based notes management and organizer."
  213. :tag "Org"
  214. :group 'outlines
  215. :group 'calendar)
  216. (defcustom org-mode-hook nil
  217. "Mode hook for Org-mode, run after the mode was turned on."
  218. :group 'org
  219. :type 'hook)
  220. (defcustom org-load-hook nil
  221. "Hook that is run after org.el has been loaded."
  222. :group 'org
  223. :type 'hook)
  224. (defvar org-modules) ; defined below
  225. (defvar org-modules-loaded nil
  226. "Have the modules been loaded already?")
  227. (defun org-load-modules-maybe (&optional force)
  228. "Load all extensions listed in `org-modules'."
  229. (when (or force (not org-modules-loaded))
  230. (mapc (lambda (ext)
  231. (condition-case nil (require ext)
  232. (error (message "Problems while trying to load feature `%s'" ext))))
  233. org-modules)
  234. (setq org-modules-loaded t)))
  235. (defun org-set-modules (var value)
  236. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  237. (set var value)
  238. (when (featurep 'org)
  239. (org-load-modules-maybe 'force)))
  240. (when (org-bound-and-true-p org-modules)
  241. (let ((a (member 'org-infojs org-modules)))
  242. (and a (setcar a 'org-jsinfo))))
  243. (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)
  244. "Modules that should always be loaded together with org.el.
  245. If a description starts with <C>, the file is not part of Emacs
  246. and loading it will require that you have downloaded and properly installed
  247. the org-mode distribution.
  248. You can also use this system to load external packages (i.e. neither Org
  249. core modules, nor modules from the CONTRIB directory). Just add symbols
  250. to the end of the list. If the package is called org-xyz.el, then you need
  251. to add the symbol `xyz', and the package must have a call to
  252. (provide 'org-xyz)"
  253. :group 'org
  254. :set 'org-set-modules
  255. :type
  256. '(set :greedy t
  257. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  258. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  259. (const :tag " crypt: Encryption of subtrees" org-crypt)
  260. (const :tag " ctags: Access to Emacs tags with links" org-ctags)
  261. (const :tag " docview: Links to doc-view buffers" org-docview)
  262. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  263. (const :tag " id: Global IDs for identifying entries" org-id)
  264. (const :tag " info: Links to Info nodes" org-info)
  265. (const :tag " jsinfo: Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
  266. (const :tag " habit: Track your consistency with habits" org-habit)
  267. (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
  268. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  269. (const :tag " mac-message: Links to messages in Apple Mail" org-mac-message)
  270. (const :tag " mew Links to Mew folders/messages" org-mew)
  271. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  272. (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
  273. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  274. (const :tag " special-blocks: Turn blocks into LaTeX envs and HTML divs" org-special-blocks)
  275. (const :tag " vm: Links to VM folders/messages" org-vm)
  276. (const :tag " wl: Links to Wanderlust folders/messages" org-wl)
  277. (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
  278. (const :tag " mouse: Additional mouse support" org-mouse)
  279. (const :tag " TaskJuggler: Export tasks to a TaskJuggler project" org-taskjuggler)
  280. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  281. (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
  282. (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
  283. (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
  284. (const :tag "C collector: Collect properties into tables" org-collector)
  285. (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
  286. (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
  287. (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
  288. (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
  289. (const :tag "C eval: Include command output as text" org-eval)
  290. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  291. (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
  292. (const :tag "C exp-bibtex: Export citations using BibTeX" org-exp-bibtex)
  293. (const :tag "C git-link: Provide org links to specific file version" org-git-link)
  294. (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
  295. (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
  296. (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
  297. (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
  298. (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
  299. (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
  300. (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
  301. (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
  302. (const :tag "C man: Support for links to manpages in Org-mode" org-man)
  303. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  304. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  305. (const :tag "C registry: A registry for Org-mode links" org-registry)
  306. (const :tag "C org2rem: Convert org appointments into reminders" org2rem)
  307. (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
  308. (const :tag "C secretary: Team management with org-mode" org-secretary)
  309. (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
  310. (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
  311. (const :tag "C track: Keep up with Org-mode development" org-track)
  312. (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
  313. (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
  314. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  315. (defcustom org-support-shift-select nil
  316. "Non-nil means make shift-cursor commands select text when possible.
  317. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
  318. selecting a region, or enlarge regions started in this way.
  319. In Org-mode, in special contexts, these same keys are used for other
  320. purposes, important enough to compete with shift selection. Org tries
  321. to balance these needs by supporting `shift-select-mode' outside these
  322. special contexts, under control of this variable.
  323. The default of this variable is nil, to avoid confusing behavior. Shifted
  324. cursor keys will then execute Org commands in the following contexts:
  325. - on a headline, changing TODO state (left/right) and priority (up/down)
  326. - on a time stamp, changing the time
  327. - in a plain list item, changing the bullet type
  328. - in a property definition line, switching between allowed values
  329. - in the BEGIN line of a clock table (changing the time block).
  330. Outside these contexts, the commands will throw an error.
  331. When this variable is t and the cursor is not in a special context,
  332. Org-mode will support shift-selection for making and enlarging regions.
  333. To make this more effective, the bullet cycling will no longer happen
  334. anywhere in an item line, but only if the cursor is exactly on the bullet.
  335. If you set this variable to the symbol `always', then the keys
  336. will not be special in headlines, property lines, and item lines, to make
  337. shift selection work there as well. If this is what you want, you can
  338. use the following alternative commands: `C-c C-t' and `C-c ,' to
  339. change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
  340. TODO sets, `C-c -' to cycle item bullet types, and properties can be
  341. edited by hand or in column view.
  342. However, when the cursor is on a timestamp, shift-cursor commands
  343. will still edit the time stamp - this is just too good to give up.
  344. XEmacs user should have this variable set to nil, because shift-select-mode
  345. is Emacs 23 only."
  346. :group 'org
  347. :type '(choice
  348. (const :tag "Never" nil)
  349. (const :tag "When outside special context" t)
  350. (const :tag "Everywhere except timestamps" always)))
  351. (defgroup org-startup nil
  352. "Options concerning startup of Org-mode."
  353. :tag "Org Startup"
  354. :group 'org)
  355. (defcustom org-startup-folded t
  356. "Non-nil means entering Org-mode will switch to OVERVIEW.
  357. This can also be configured on a per-file basis by adding one of
  358. the following lines anywhere in the buffer:
  359. #+STARTUP: fold (or `overview', this is equivalent)
  360. #+STARTUP: nofold (or `showall', this is equivalent)
  361. #+STARTUP: content
  362. #+STARTUP: showeverything"
  363. :group 'org-startup
  364. :type '(choice
  365. (const :tag "nofold: show all" nil)
  366. (const :tag "fold: overview" t)
  367. (const :tag "content: all headlines" content)
  368. (const :tag "show everything, even drawers" showeverything)))
  369. (defcustom org-startup-truncated t
  370. "Non-nil means entering Org-mode will set `truncate-lines'.
  371. This is useful since some lines containing links can be very long and
  372. uninteresting. Also tables look terrible when wrapped."
  373. :group 'org-startup
  374. :type 'boolean)
  375. (defcustom org-startup-indented nil
  376. "Non-nil means turn on `org-indent-mode' on startup.
  377. This can also be configured on a per-file basis by adding one of
  378. the following lines anywhere in the buffer:
  379. #+STARTUP: indent
  380. #+STARTUP: noindent"
  381. :group 'org-structure
  382. :type '(choice
  383. (const :tag "Not" nil)
  384. (const :tag "Globally (slow on startup in large files)" t)))
  385. (defcustom org-use-sub-superscripts t
  386. "Non-nil means interpret \"_\" and \"^\" for export.
  387. When this option is turned on, you can use TeX-like syntax for sub- and
  388. superscripts. Several characters after \"_\" or \"^\" will be
  389. considered as a single item - so grouping with {} is normally not
  390. needed. For example, the following things will be parsed as single
  391. sub- or superscripts.
  392. 10^24 or 10^tau several digits will be considered 1 item.
  393. 10^-12 or 10^-tau a leading sign with digits or a word
  394. x^2-y^3 will be read as x^2 - y^3, because items are
  395. terminated by almost any nonword/nondigit char.
  396. x_{i^2} or x^(2-i) braces or parenthesis do grouping.
  397. Still, ambiguity is possible - so when in doubt use {} to enclose the
  398. sub/superscript. If you set this variable to the symbol `{}',
  399. the braces are *required* in order to trigger interpretations as
  400. sub/superscript. This can be helpful in documents that need \"_\"
  401. frequently in plain text.
  402. Not all export backends support this, but HTML does.
  403. This option can also be set with the +OPTIONS line, e.g. \"^:nil\"."
  404. :group 'org-startup
  405. :group 'org-export-translation
  406. :type '(choice
  407. (const :tag "Always interpret" t)
  408. (const :tag "Only with braces" {})
  409. (const :tag "Never interpret" nil)))
  410. (if (fboundp 'defvaralias)
  411. (defvaralias 'org-export-with-sub-superscripts 'org-use-sub-superscripts))
  412. (defcustom org-startup-with-beamer-mode nil
  413. "Non-nil means turn on `org-beamer-mode' on startup.
  414. This can also be configured on a per-file basis by adding one of
  415. the following lines anywhere in the buffer:
  416. #+STARTUP: beamer"
  417. :group 'org-startup
  418. :type 'boolean)
  419. (defcustom org-startup-align-all-tables nil
  420. "Non-nil means align all tables when visiting a file.
  421. This is useful when the column width in tables is forced with <N> cookies
  422. in table fields. Such tables will look correct only after the first re-align.
  423. This can also be configured on a per-file basis by adding one of
  424. the following lines anywhere in the buffer:
  425. #+STARTUP: align
  426. #+STARTUP: noalign"
  427. :group 'org-startup
  428. :type 'boolean)
  429. (defcustom org-startup-with-inline-images nil
  430. "Non-nil means show inline images when loading a new Org file.
  431. This can also be configured on a per-file basis by adding one of
  432. the following lines anywhere in the buffer:
  433. #+STARTUP: inlineimages
  434. #+STARTUP: noinlineimages"
  435. :group 'org-startup
  436. :type 'boolean)
  437. (defcustom org-insert-mode-line-in-empty-file nil
  438. "Non-nil means insert the first line setting Org-mode in empty files.
  439. When the function `org-mode' is called interactively in an empty file, this
  440. normally means that the file name does not automatically trigger Org-mode.
  441. To ensure that the file will always be in Org-mode in the future, a
  442. line enforcing Org-mode will be inserted into the buffer, if this option
  443. has been set."
  444. :group 'org-startup
  445. :type 'boolean)
  446. (defcustom org-replace-disputed-keys nil
  447. "Non-nil means use alternative key bindings for some keys.
  448. Org-mode uses S-<cursor> keys for changing timestamps and priorities.
  449. These keys are also used by other packages like shift-selection-mode'
  450. \(built into Emacs 23), `CUA-mode' or `windmove.el'.
  451. If you want to use Org-mode together with one of these other modes,
  452. or more generally if you would like to move some Org-mode commands to
  453. other keys, set this variable and configure the keys with the variable
  454. `org-disputed-keys'.
  455. This option is only relevant at load-time of Org-mode, and must be set
  456. *before* org.el is loaded. Changing it requires a restart of Emacs to
  457. become effective."
  458. :group 'org-startup
  459. :type 'boolean)
  460. (defcustom org-use-extra-keys nil
  461. "Non-nil means use extra key sequence definitions for certain commands.
  462. This happens automatically if you run XEmacs or if `window-system'
  463. is nil. This variable lets you do the same manually. You must
  464. set it before loading org.
  465. Example: on Carbon Emacs 22 running graphically, with an external
  466. keyboard on a Powerbook, the default way of setting M-left might
  467. not work for either Alt or ESC. Setting this variable will make
  468. it work for ESC."
  469. :group 'org-startup
  470. :type 'boolean)
  471. (if (fboundp 'defvaralias)
  472. (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys))
  473. (defcustom org-disputed-keys
  474. '(([(shift up)] . [(meta p)])
  475. ([(shift down)] . [(meta n)])
  476. ([(shift left)] . [(meta -)])
  477. ([(shift right)] . [(meta +)])
  478. ([(control shift right)] . [(meta shift +)])
  479. ([(control shift left)] . [(meta shift -)]))
  480. "Keys for which Org-mode and other modes compete.
  481. This is an alist, cars are the default keys, second element specifies
  482. the alternative to use when `org-replace-disputed-keys' is t.
  483. Keys can be specified in any syntax supported by `define-key'.
  484. The value of this option takes effect only at Org-mode's startup,
  485. therefore you'll have to restart Emacs to apply it after changing."
  486. :group 'org-startup
  487. :type 'alist)
  488. (defun org-key (key)
  489. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  490. Or return the original if not disputed.
  491. Also apply the translations defined in `org-xemacs-key-equivalents'."
  492. (when org-replace-disputed-keys
  493. (let* ((nkey (key-description key))
  494. (x (org-find-if (lambda (x)
  495. (equal (key-description (car x)) nkey))
  496. org-disputed-keys)))
  497. (setq key (if x (cdr x) key))))
  498. (when (featurep 'xemacs)
  499. (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
  500. key)
  501. (defun org-find-if (predicate seq)
  502. (catch 'exit
  503. (while seq
  504. (if (funcall predicate (car seq))
  505. (throw 'exit (car seq))
  506. (pop seq)))))
  507. (defun org-defkey (keymap key def)
  508. "Define a key, possibly translated, as returned by `org-key'."
  509. (define-key keymap (org-key key) def))
  510. (defcustom org-ellipsis nil
  511. "The ellipsis to use in the Org-mode outline.
  512. When nil, just use the standard three dots. When a string, use that instead,
  513. When a face, use the standard 3 dots, but with the specified face.
  514. The change affects only Org-mode (which will then use its own display table).
  515. Changing this requires executing `M-x org-mode' in a buffer to become
  516. effective."
  517. :group 'org-startup
  518. :type '(choice (const :tag "Default" nil)
  519. (face :tag "Face" :value org-warning)
  520. (string :tag "String" :value "...#")))
  521. (defvar org-display-table nil
  522. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  523. (defgroup org-keywords nil
  524. "Keywords in Org-mode."
  525. :tag "Org Keywords"
  526. :group 'org)
  527. (defcustom org-deadline-string "DEADLINE:"
  528. "String to mark deadline entries.
  529. A deadline is this string, followed by a time stamp. Should be a word,
  530. terminated by a colon. You can insert a schedule keyword and
  531. a timestamp with \\[org-deadline].
  532. Changes become only effective after restarting Emacs."
  533. :group 'org-keywords
  534. :type 'string)
  535. (defcustom org-scheduled-string "SCHEDULED:"
  536. "String to mark scheduled TODO entries.
  537. A schedule is this string, followed by a time stamp. Should be a word,
  538. terminated by a colon. You can insert a schedule keyword and
  539. a timestamp with \\[org-schedule].
  540. Changes become only effective after restarting Emacs."
  541. :group 'org-keywords
  542. :type 'string)
  543. (defcustom org-closed-string "CLOSED:"
  544. "String used as the prefix for timestamps logging closing a TODO entry."
  545. :group 'org-keywords
  546. :type 'string)
  547. (defcustom org-clock-string "CLOCK:"
  548. "String used as prefix for timestamps clocking work hours on an item."
  549. :group 'org-keywords
  550. :type 'string)
  551. (defcustom org-comment-string "COMMENT"
  552. "Entries starting with this keyword will never be exported.
  553. An entry can be toggled between COMMENT and normal with
  554. \\[org-toggle-comment].
  555. Changes become only effective after restarting Emacs."
  556. :group 'org-keywords
  557. :type 'string)
  558. (defcustom org-quote-string "QUOTE"
  559. "Entries starting with this keyword will be exported in fixed-width font.
  560. Quoting applies only to the text in the entry following the headline, and does
  561. not extend beyond the next headline, even if that is lower level.
  562. An entry can be toggled between QUOTE and normal with
  563. \\[org-toggle-fixed-width-section]."
  564. :group 'org-keywords
  565. :type 'string)
  566. (defconst org-repeat-re
  567. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)"
  568. "Regular expression for specifying repeated events.
  569. After a match, group 1 contains the repeat expression.")
  570. (defgroup org-structure nil
  571. "Options concerning the general structure of Org-mode files."
  572. :tag "Org Structure"
  573. :group 'org)
  574. (defgroup org-reveal-location nil
  575. "Options about how to make context of a location visible."
  576. :tag "Org Reveal Location"
  577. :group 'org-structure)
  578. (defconst org-context-choice
  579. '(choice
  580. (const :tag "Always" t)
  581. (const :tag "Never" nil)
  582. (repeat :greedy t :tag "Individual contexts"
  583. (cons
  584. (choice :tag "Context"
  585. (const agenda)
  586. (const org-goto)
  587. (const occur-tree)
  588. (const tags-tree)
  589. (const link-search)
  590. (const mark-goto)
  591. (const bookmark-jump)
  592. (const isearch)
  593. (const default))
  594. (boolean))))
  595. "Contexts for the reveal options.")
  596. (defcustom org-show-hierarchy-above '((default . t))
  597. "Non-nil means show full hierarchy when revealing a location.
  598. Org-mode often shows locations in an org-mode file which might have
  599. been invisible before. When this is set, the hierarchy of headings
  600. above the exposed location is shown.
  601. Turning this off for example for sparse trees makes them very compact.
  602. Instead of t, this can also be an alist specifying this option for different
  603. contexts. Valid contexts are
  604. agenda when exposing an entry from the agenda
  605. org-goto when using the command `org-goto' on key C-c C-j
  606. occur-tree when using the command `org-occur' on key C-c /
  607. tags-tree when constructing a sparse tree based on tags matches
  608. link-search when exposing search matches associated with a link
  609. mark-goto when exposing the jump goal of a mark
  610. bookmark-jump when exposing a bookmark location
  611. isearch when exiting from an incremental search
  612. default default for all contexts not set explicitly"
  613. :group 'org-reveal-location
  614. :type org-context-choice)
  615. (defcustom org-show-following-heading '((default . nil))
  616. "Non-nil means show following heading when revealing a location.
  617. Org-mode often shows locations in an org-mode file which might have
  618. been invisible before. When this is set, the heading following the
  619. match is shown.
  620. Turning this off for example for sparse trees makes them very compact,
  621. but makes it harder to edit the location of the match. In such a case,
  622. use the command \\[org-reveal] to show more context.
  623. Instead of t, this can also be an alist specifying this option for different
  624. contexts. See `org-show-hierarchy-above' for valid contexts."
  625. :group 'org-reveal-location
  626. :type org-context-choice)
  627. (defcustom org-show-siblings '((default . nil) (isearch t))
  628. "Non-nil means show all sibling heading when revealing a location.
  629. Org-mode often shows locations in an org-mode file which might have
  630. been invisible before. When this is set, the sibling of the current entry
  631. heading are all made visible. If `org-show-hierarchy-above' is t,
  632. the same happens on each level of the hierarchy above the current entry.
  633. By default this is on for the isearch context, off for all other contexts.
  634. Turning this off for example for sparse trees makes them very compact,
  635. but makes it harder to edit the location of the match. In such a case,
  636. use the command \\[org-reveal] to show more context.
  637. Instead of t, this can also be an alist specifying this option for different
  638. contexts. See `org-show-hierarchy-above' for valid contexts."
  639. :group 'org-reveal-location
  640. :type org-context-choice)
  641. (defcustom org-show-entry-below '((default . nil))
  642. "Non-nil means show the entry below a headline when revealing a location.
  643. Org-mode often shows locations in an org-mode file which might have
  644. been invisible before. When this is set, the text below the headline that is
  645. exposed is also shown.
  646. By default this is off for all contexts.
  647. Instead of t, this can also be an alist specifying this option for different
  648. contexts. See `org-show-hierarchy-above' for valid contexts."
  649. :group 'org-reveal-location
  650. :type org-context-choice)
  651. (defcustom org-indirect-buffer-display 'other-window
  652. "How should indirect tree buffers be displayed?
  653. This applies to indirect buffers created with the commands
  654. \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
  655. Valid values are:
  656. current-window Display in the current window
  657. other-window Just display in another window.
  658. dedicated-frame Create one new frame, and re-use it each time.
  659. new-frame Make a new frame each time. Note that in this case
  660. previously-made indirect buffers are kept, and you need to
  661. kill these buffers yourself."
  662. :group 'org-structure
  663. :group 'org-agenda-windows
  664. :type '(choice
  665. (const :tag "In current window" current-window)
  666. (const :tag "In current frame, other window" other-window)
  667. (const :tag "Each time a new frame" new-frame)
  668. (const :tag "One dedicated frame" dedicated-frame)))
  669. (defcustom org-use-speed-commands nil
  670. "Non-nil means activate single letter commands at beginning of a headline.
  671. This may also be a function to test for appropriate locations where speed
  672. commands should be active."
  673. :group 'org-structure
  674. :type '(choice
  675. (const :tag "Never" nil)
  676. (const :tag "At beginning of headline stars" t)
  677. (function)))
  678. (defcustom org-speed-commands-user nil
  679. "Alist of additional speed commands.
  680. This list will be checked before `org-speed-commands-default'
  681. when the variable `org-use-speed-commands' is non-nil
  682. and when the cursor is at the beginning of a headline.
  683. The car if each entry is a string with a single letter, which must
  684. be assigned to `self-insert-command' in the global map.
  685. The cdr is either a command to be called interactively, a function
  686. to be called, or a form to be evaluated.
  687. An entry that is just a list with a single string will be interpreted
  688. as a descriptive headline that will be added when listing the speed
  689. commands in the Help buffer using the `?' speed command."
  690. :group 'org-structure
  691. :type '(repeat :value ("k" . ignore)
  692. (choice :value ("k" . ignore)
  693. (list :tag "Descriptive Headline" (string :tag "Headline"))
  694. (cons :tag "Letter and Command"
  695. (string :tag "Command letter")
  696. (choice
  697. (function)
  698. (sexp))))))
  699. (defgroup org-cycle nil
  700. "Options concerning visibility cycling in Org-mode."
  701. :tag "Org Cycle"
  702. :group 'org-structure)
  703. (defcustom org-cycle-skip-children-state-if-no-children t
  704. "Non-nil means skip CHILDREN state in entries that don't have any."
  705. :group 'org-cycle
  706. :type 'boolean)
  707. (defcustom org-cycle-max-level nil
  708. "Maximum level which should still be subject to visibility cycling.
  709. Levels higher than this will, for cycling, be treated as text, not a headline.
  710. When `org-odd-levels-only' is set, a value of N in this variable actually
  711. means 2N-1 stars as the limiting headline.
  712. When nil, cycle all levels.
  713. Note that the limiting level of cycling is also influenced by
  714. `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
  715. `org-inlinetask-min-level' is, cycling will be limited to levels one less
  716. than its value."
  717. :group 'org-cycle
  718. :type '(choice
  719. (const :tag "No limit" nil)
  720. (integer :tag "Maximum level")))
  721. (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK")
  722. "Names of drawers. Drawers are not opened by cycling on the headline above.
  723. Drawers only open with a TAB on the drawer line itself. A drawer looks like
  724. this:
  725. :DRAWERNAME:
  726. .....
  727. :END:
  728. The drawer \"PROPERTIES\" is special for capturing properties through
  729. the property API.
  730. Drawers can be defined on the per-file basis with a line like:
  731. #+DRAWERS: HIDDEN STATE PROPERTIES"
  732. :group 'org-structure
  733. :group 'org-cycle
  734. :type '(repeat (string :tag "Drawer Name")))
  735. (defcustom org-hide-block-startup nil
  736. "Non-nil means entering Org-mode will fold all blocks.
  737. This can also be set in on a per-file basis with
  738. #+STARTUP: hideblocks
  739. #+STARTUP: showblocks"
  740. :group 'org-startup
  741. :group 'org-cycle
  742. :type 'boolean)
  743. (defcustom org-cycle-global-at-bob nil
  744. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  745. This makes it possible to do global cycling without having to use S-TAB or
  746. \\[universal-argument] TAB. For this special case to work, the first line \
  747. of the buffer
  748. must not be a headline - it may be empty or some other text. When used in
  749. this way, `org-cycle-hook' is disables temporarily, to make sure the
  750. cursor stays at the beginning of the buffer.
  751. When this option is nil, don't do anything special at the beginning
  752. of the buffer."
  753. :group 'org-cycle
  754. :type 'boolean)
  755. (defcustom org-cycle-level-after-item/entry-creation t
  756. "Non-nil means cycle entry level or item indentation in new empty entries.
  757. When the cursor is at the end of an empty headline, i.e with only stars
  758. and maybe a TODO keyword, TAB will then switch the entry to become a child,
  759. and then all possible ancestor states, before returning to the original state.
  760. This makes data entry extremely fast: M-RET to create a new headline,
  761. on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
  762. When the cursor is at the end of an empty plain list item, one TAB will
  763. make it a subitem, two or more tabs will back up to make this an item
  764. higher up in the item hierarchy."
  765. :group 'org-cycle
  766. :type 'boolean)
  767. (defcustom org-cycle-emulate-tab t
  768. "Where should `org-cycle' emulate TAB.
  769. nil Never
  770. white Only in completely white lines
  771. whitestart Only at the beginning of lines, before the first non-white char
  772. t Everywhere except in headlines
  773. exc-hl-bol Everywhere except at the start of a headline
  774. If TAB is used in a place where it does not emulate TAB, the current subtree
  775. visibility is cycled."
  776. :group 'org-cycle
  777. :type '(choice (const :tag "Never" nil)
  778. (const :tag "Only in completely white lines" white)
  779. (const :tag "Before first char in a line" whitestart)
  780. (const :tag "Everywhere except in headlines" t)
  781. (const :tag "Everywhere except at bol in headlines" exc-hl-bol)
  782. ))
  783. (defcustom org-cycle-separator-lines 2
  784. "Number of empty lines needed to keep an empty line between collapsed trees.
  785. If you leave an empty line between the end of a subtree and the following
  786. headline, this empty line is hidden when the subtree is folded.
  787. Org-mode will leave (exactly) one empty line visible if the number of
  788. empty lines is equal or larger to the number given in this variable.
  789. So the default 2 means at least 2 empty lines after the end of a subtree
  790. are needed to produce free space between a collapsed subtree and the
  791. following headline.
  792. If the number is negative, and the number of empty lines is at least -N,
  793. all empty lines are shown.
  794. Special case: when 0, never leave empty lines in collapsed view."
  795. :group 'org-cycle
  796. :type 'integer)
  797. (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
  798. (defcustom org-pre-cycle-hook nil
  799. "Hook that is run before visibility cycling is happening.
  800. The function(s) in this hook must accept a single argument which indicates
  801. the new state that will be set right after running this hook. The
  802. argument is a symbol. Before a global state change, it can have the values
  803. `overview', `content', or `all'. Before a local state change, it can have
  804. the values `folded', `children', or `subtree'."
  805. :group 'org-cycle
  806. :type 'hook)
  807. (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
  808. org-cycle-hide-drawers
  809. org-cycle-show-empty-lines
  810. org-optimize-window-after-visibility-change)
  811. "Hook that is run after `org-cycle' has changed the buffer visibility.
  812. The function(s) in this hook must accept a single argument which indicates
  813. the new state that was set by the most recent `org-cycle' command. The
  814. argument is a symbol. After a global state change, it can have the values
  815. `overview', `content', or `all'. After a local state change, it can have
  816. the values `folded', `children', or `subtree'."
  817. :group 'org-cycle
  818. :type 'hook)
  819. (defgroup org-edit-structure nil
  820. "Options concerning structure editing in Org-mode."
  821. :tag "Org Edit Structure"
  822. :group 'org-structure)
  823. (defcustom org-odd-levels-only nil
  824. "Non-nil means skip even levels and only use odd levels for the outline.
  825. This has the effect that two stars are being added/taken away in
  826. promotion/demotion commands. It also influences how levels are
  827. handled by the exporters.
  828. Changing it requires restart of `font-lock-mode' to become effective
  829. for fontification also in regions already fontified.
  830. You may also set this on a per-file basis by adding one of the following
  831. lines to the buffer:
  832. #+STARTUP: odd
  833. #+STARTUP: oddeven"
  834. :group 'org-edit-structure
  835. :group 'org-appearance
  836. :type 'boolean)
  837. (defcustom org-adapt-indentation t
  838. "Non-nil means adapt indentation to outline node level.
  839. When this variable is set, Org assumes that you write outlines by
  840. indenting text in each node to align with the headline (after the stars).
  841. The following issues are influenced by this variable:
  842. - When this is set and the *entire* text in an entry is indented, the
  843. indentation is increased by one space in a demotion command, and
  844. decreased by one in a promotion command. If any line in the entry
  845. body starts with text at column 0, indentation is not changed at all.
  846. - Property drawers and planning information is inserted indented when
  847. this variable s set. When nil, they will not be indented.
  848. - TAB indents a line relative to context. The lines below a headline
  849. will be indented when this variable is set.
  850. Note that this is all about true indentation, by adding and removing
  851. space characters. See also `org-indent.el' which does level-dependent
  852. indentation in a virtual way, i.e. at display time in Emacs."
  853. :group 'org-edit-structure
  854. :type 'boolean)
  855. (defcustom org-special-ctrl-a/e nil
  856. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  857. When t, `C-a' will bring back the cursor to the beginning of the
  858. headline text, i.e. after the stars and after a possible TODO keyword.
  859. In an item, this will be the position after the bullet.
  860. When the cursor is already at that position, another `C-a' will bring
  861. it to the beginning of the line.
  862. `C-e' will jump to the end of the headline, ignoring the presence of tags
  863. in the headline. A second `C-e' will then jump to the true end of the
  864. line, after any tags. This also means that, when this variable is
  865. non-nil, `C-e' also will never jump beyond the end of the heading of a
  866. folded section, i.e. not after the ellipses.
  867. When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
  868. going to the true line boundary first. Only a directly following, identical
  869. keypress will bring the cursor to the special positions.
  870. This may also be a cons cell where the behavior for `C-a' and `C-e' is
  871. set separately."
  872. :group 'org-edit-structure
  873. :type '(choice
  874. (const :tag "off" nil)
  875. (const :tag "on: after stars/bullet and before tags first" t)
  876. (const :tag "reversed: true line boundary first" reversed)
  877. (cons :tag "Set C-a and C-e separately"
  878. (choice :tag "Special C-a"
  879. (const :tag "off" nil)
  880. (const :tag "on: after stars/bullet first" t)
  881. (const :tag "reversed: before stars/bullet first" reversed))
  882. (choice :tag "Special C-e"
  883. (const :tag "off" nil)
  884. (const :tag "on: before tags first" t)
  885. (const :tag "reversed: after tags first" reversed)))))
  886. (if (fboundp 'defvaralias)
  887. (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
  888. (defcustom org-special-ctrl-k nil
  889. "Non-nil means `C-k' will behave specially in headlines.
  890. When nil, `C-k' will call the default `kill-line' command.
  891. When t, the following will happen while the cursor is in the headline:
  892. - When the cursor is at the beginning of a headline, kill the entire
  893. line and possible the folded subtree below the line.
  894. - When in the middle of the headline text, kill the headline up to the tags.
  895. - When after the headline text, kill the tags."
  896. :group 'org-edit-structure
  897. :type 'boolean)
  898. (defcustom org-ctrl-k-protect-subtree nil
  899. "Non-nil means, do not delete a hidden subtree with C-k.
  900. When set to the symbol `error', simply throw an error when C-k is
  901. used to kill (part-of) a headline that has hidden text behind it.
  902. Any other non-nil value will result in a query to the user, if it is
  903. OK to kill that hidden subtree. When nil, kill without remorse."
  904. :group 'org-edit-structure
  905. :type '(choice
  906. (const :tag "Do not protect hidden subtrees" nil)
  907. (const :tag "Protect hidden subtrees with a security query" t)
  908. (const :tag "Never kill a hidden subtree with C-k" error)))
  909. (defcustom org-yank-folded-subtrees t
  910. "Non-nil means when yanking subtrees, fold them.
  911. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  912. it starts with a heading and all other headings in it are either children
  913. or siblings, then fold all the subtrees. However, do this only if no
  914. text after the yank would be swallowed into a folded tree by this action."
  915. :group 'org-edit-structure
  916. :type 'boolean)
  917. (defcustom org-yank-adjusted-subtrees nil
  918. "Non-nil means when yanking subtrees, adjust the level.
  919. With this setting, `org-paste-subtree' is used to insert the subtree, see
  920. this function for details."
  921. :group 'org-edit-structure
  922. :type 'boolean)
  923. (defcustom org-M-RET-may-split-line '((default . t))
  924. "Non-nil means M-RET will split the line at the cursor position.
  925. When nil, it will go to the end of the line before making a
  926. new line.
  927. You may also set this option in a different way for different
  928. contexts. Valid contexts are:
  929. headline when creating a new headline
  930. item when creating a new item
  931. table in a table field
  932. default the value to be used for all contexts not explicitly
  933. customized"
  934. :group 'org-structure
  935. :group 'org-table
  936. :type '(choice
  937. (const :tag "Always" t)
  938. (const :tag "Never" nil)
  939. (repeat :greedy t :tag "Individual contexts"
  940. (cons
  941. (choice :tag "Context"
  942. (const headline)
  943. (const item)
  944. (const table)
  945. (const default))
  946. (boolean)))))
  947. (defcustom org-insert-heading-respect-content nil
  948. "Non-nil means insert new headings after the current subtree.
  949. When nil, the new heading is created directly after the current line.
  950. The commands \\[org-insert-heading-respect-content] and
  951. \\[org-insert-todo-heading-respect-content] turn this variable on
  952. for the duration of the command."
  953. :group 'org-structure
  954. :type 'boolean)
  955. (defcustom org-blank-before-new-entry '((heading . auto)
  956. (plain-list-item . auto))
  957. "Should `org-insert-heading' leave a blank line before new heading/item?
  958. The value is an alist, with `heading' and `plain-list-item' as car,
  959. and a boolean flag as cdr. The cdr may also be the symbol `auto', and then
  960. Org will look at the surrounding headings/items and try to make an
  961. intelligent decision whether to insert a blank line or not.
  962. For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
  963. set, the setting here is ignored and no empty line is inserted, to avoid
  964. breaking the list structure."
  965. :group 'org-edit-structure
  966. :type '(list
  967. (cons (const heading)
  968. (choice (const :tag "Never" nil)
  969. (const :tag "Always" t)
  970. (const :tag "Auto" auto)))
  971. (cons (const plain-list-item)
  972. (choice (const :tag "Never" nil)
  973. (const :tag "Always" t)
  974. (const :tag "Auto" auto)))))
  975. (defcustom org-insert-heading-hook nil
  976. "Hook being run after inserting a new heading."
  977. :group 'org-edit-structure
  978. :type 'hook)
  979. (defcustom org-enable-fixed-width-editor t
  980. "Non-nil means lines starting with \":\" are treated as fixed-width.
  981. This currently only means they are never auto-wrapped.
  982. When nil, such lines will be treated like ordinary lines.
  983. See also the QUOTE keyword."
  984. :group 'org-edit-structure
  985. :type 'boolean)
  986. (defcustom org-goto-auto-isearch t
  987. "Non-nil means typing characters in `org-goto' starts incremental search."
  988. :group 'org-edit-structure
  989. :type 'boolean)
  990. (defgroup org-sparse-trees nil
  991. "Options concerning sparse trees in Org-mode."
  992. :tag "Org Sparse Trees"
  993. :group 'org-structure)
  994. (defcustom org-highlight-sparse-tree-matches t
  995. "Non-nil means highlight all matches that define a sparse tree.
  996. The highlights will automatically disappear the next time the buffer is
  997. changed by an edit command."
  998. :group 'org-sparse-trees
  999. :type 'boolean)
  1000. (defcustom org-remove-highlights-with-change t
  1001. "Non-nil means any change to the buffer will remove temporary highlights.
  1002. Such highlights are created by `org-occur' and `org-clock-display'.
  1003. When nil, `C-c C-c needs to be used to get rid of the highlights.
  1004. The highlights created by `org-preview-latex-fragment' always need
  1005. `C-c C-c' to be removed."
  1006. :group 'org-sparse-trees
  1007. :group 'org-time
  1008. :type 'boolean)
  1009. (defcustom org-occur-hook '(org-first-headline-recenter)
  1010. "Hook that is run after `org-occur' has constructed a sparse tree.
  1011. This can be used to recenter the window to show as much of the structure
  1012. as possible."
  1013. :group 'org-sparse-trees
  1014. :type 'hook)
  1015. (defgroup org-imenu-and-speedbar nil
  1016. "Options concerning imenu and speedbar in Org-mode."
  1017. :tag "Org Imenu and Speedbar"
  1018. :group 'org-structure)
  1019. (defcustom org-imenu-depth 2
  1020. "The maximum level for Imenu access to Org-mode headlines.
  1021. This also applied for speedbar access."
  1022. :group 'org-imenu-and-speedbar
  1023. :type 'integer)
  1024. (defgroup org-table nil
  1025. "Options concerning tables in Org-mode."
  1026. :tag "Org Table"
  1027. :group 'org)
  1028. (defcustom org-enable-table-editor 'optimized
  1029. "Non-nil means lines starting with \"|\" are handled by the table editor.
  1030. When nil, such lines will be treated like ordinary lines.
  1031. When equal to the symbol `optimized', the table editor will be optimized to
  1032. do the following:
  1033. - Automatic overwrite mode in front of whitespace in table fields.
  1034. This makes the structure of the table stay in tact as long as the edited
  1035. field does not exceed the column width.
  1036. - Minimize the number of realigns. Normally, the table is aligned each time
  1037. TAB or RET are pressed to move to another field. With optimization this
  1038. happens only if changes to a field might have changed the column width.
  1039. Optimization requires replacing the functions `self-insert-command',
  1040. `delete-char', and `backward-delete-char' in Org-mode buffers, with a
  1041. slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
  1042. very good at guessing when a re-align will be necessary, but you can always
  1043. force one with \\[org-ctrl-c-ctrl-c].
  1044. If you would like to use the optimized version in Org-mode, but the
  1045. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  1046. This variable can be used to turn on and off the table editor during a session,
  1047. but in order to toggle optimization, a restart is required.
  1048. See also the variable `org-table-auto-blank-field'."
  1049. :group 'org-table
  1050. :type '(choice
  1051. (const :tag "off" nil)
  1052. (const :tag "on" t)
  1053. (const :tag "on, optimized" optimized)))
  1054. (defcustom org-self-insert-cluster-for-undo t
  1055. "Non-nil means cluster self-insert commands for undo when possible.
  1056. If this is set, then, like in the Emacs command loop, 20 consecutive
  1057. characters will be undone together.
  1058. This is configurable, because there is some impact on typing performance."
  1059. :group 'org-table
  1060. :type 'boolean)
  1061. (defcustom org-table-tab-recognizes-table.el t
  1062. "Non-nil means TAB will automatically notice a table.el table.
  1063. When it sees such a table, it moves point into it and - if necessary -
  1064. calls `table-recognize-table'."
  1065. :group 'org-table-editing
  1066. :type 'boolean)
  1067. (defgroup org-link nil
  1068. "Options concerning links in Org-mode."
  1069. :tag "Org Link"
  1070. :group 'org)
  1071. (defvar org-link-abbrev-alist-local nil
  1072. "Buffer-local version of `org-link-abbrev-alist', which see.
  1073. The value of this is taken from the #+LINK lines.")
  1074. (make-variable-buffer-local 'org-link-abbrev-alist-local)
  1075. (defcustom org-link-abbrev-alist nil
  1076. "Alist of link abbreviations.
  1077. The car of each element is a string, to be replaced at the start of a link.
  1078. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  1079. links in Org-mode buffers can have an optional tag after a double colon, e.g.
  1080. [[linkkey:tag][description]]
  1081. The 'linkkey' must be a word word, starting with a letter, followed
  1082. by letters, numbers, '-' or '_'.
  1083. If REPLACE is a string, the tag will simply be appended to create the link.
  1084. If the string contains \"%s\", the tag will be inserted there. Alternatively,
  1085. the placeholder \"%h\" will cause a url-encoded version of the tag to
  1086. be inserted at that point (see the function `url-hexify-string').
  1087. REPLACE may also be a function that will be called with the tag as the
  1088. only argument to create the link, which should be returned as a string.
  1089. See the manual for examples."
  1090. :group 'org-link
  1091. :type '(repeat
  1092. (cons
  1093. (string :tag "Protocol")
  1094. (choice
  1095. (string :tag "Format")
  1096. (function)))))
  1097. (defcustom org-descriptive-links t
  1098. "Non-nil means hide link part and only show description of bracket links.
  1099. Bracket links are like [[link][description]]. This variable sets the initial
  1100. state in new org-mode buffers. The setting can then be toggled on a
  1101. per-buffer basis from the Org->Hyperlinks menu."
  1102. :group 'org-link
  1103. :type 'boolean)
  1104. (defcustom org-link-file-path-type 'adaptive
  1105. "How the path name in file links should be stored.
  1106. Valid values are:
  1107. relative Relative to the current directory, i.e. the directory of the file
  1108. into which the link is being inserted.
  1109. absolute Absolute path, if possible with ~ for home directory.
  1110. noabbrev Absolute path, no abbreviation of home directory.
  1111. adaptive Use relative path for files in the current directory and sub-
  1112. directories of it. For other files, use an absolute path."
  1113. :group 'org-link
  1114. :type '(choice
  1115. (const relative)
  1116. (const absolute)
  1117. (const noabbrev)
  1118. (const adaptive)))
  1119. (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
  1120. "Types of links that should be activated in Org-mode files.
  1121. This is a list of symbols, each leading to the activation of a certain link
  1122. type. In principle, it does not hurt to turn on most link types - there may
  1123. be a small gain when turning off unused link types. The types are:
  1124. bracket The recommended [[link][description]] or [[link]] links with hiding.
  1125. angle Links in angular brackets that may contain whitespace like
  1126. <bbdb:Carsten Dominik>.
  1127. plain Plain links in normal text, no whitespace, like http://google.com.
  1128. radio Text that is matched by a radio target, see manual for details.
  1129. tag Tag settings in a headline (link to tag search).
  1130. date Time stamps (link to calendar).
  1131. footnote Footnote labels.
  1132. Changing this variable requires a restart of Emacs to become effective."
  1133. :group 'org-link
  1134. :type '(set :greedy t
  1135. (const :tag "Double bracket links" bracket)
  1136. (const :tag "Angular bracket links" angle)
  1137. (const :tag "Plain text links" plain)
  1138. (const :tag "Radio target matches" radio)
  1139. (const :tag "Tags" tag)
  1140. (const :tag "Timestamps" date)
  1141. (const :tag "Footnotes" footnote)))
  1142. (defcustom org-make-link-description-function nil
  1143. "Function to use to generate link descriptions from links.
  1144. If nil the link location will be used. This function must take
  1145. two parameters; the first is the link and the second the
  1146. description `org-insert-link' has generated, and should return the
  1147. description to use."
  1148. :group 'org-link
  1149. :type 'function)
  1150. (defgroup org-link-store nil
  1151. "Options concerning storing links in Org-mode."
  1152. :tag "Org Store Link"
  1153. :group 'org-link)
  1154. (defcustom org-email-link-description-format "Email %c: %.30s"
  1155. "Format of the description part of a link to an email or usenet message.
  1156. The following %-escapes will be replaced by corresponding information:
  1157. %F full \"From\" field
  1158. %f name, taken from \"From\" field, address if no name
  1159. %T full \"To\" field
  1160. %t first name in \"To\" field, address if no name
  1161. %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
  1162. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  1163. %s subject
  1164. %d date
  1165. %m message-id.
  1166. You may use normal field width specification between the % and the letter.
  1167. This is for example useful to limit the length of the subject.
  1168. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  1169. :group 'org-link-store
  1170. :type 'string)
  1171. (defcustom org-from-is-user-regexp
  1172. (let (r1 r2)
  1173. (when (and user-mail-address (not (string= user-mail-address "")))
  1174. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  1175. (when (and user-full-name (not (string= user-full-name "")))
  1176. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  1177. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  1178. "Regexp matched against the \"From:\" header of an email or usenet message.
  1179. It should match if the message is from the user him/herself."
  1180. :group 'org-link-store
  1181. :type 'regexp)
  1182. (defcustom org-link-to-org-use-id 'create-if-interactive-and-no-custom-id
  1183. "Non-nil means storing a link to an Org file will use entry IDs.
  1184. Note that before this variable is even considered, org-id must be loaded,
  1185. so please customize `org-modules' and turn it on.
  1186. The variable can have the following values:
  1187. t Create an ID if needed to make a link to the current entry.
  1188. create-if-interactive
  1189. If `org-store-link' is called directly (interactively, as a user
  1190. command), do create an ID to support the link. But when doing the
  1191. job for remember, only use the ID if it already exists. The
  1192. purpose of this setting is to avoid proliferation of unwanted
  1193. IDs, just because you happen to be in an Org file when you
  1194. call `org-remember' that automatically and preemptively
  1195. creates a link. If you do want to get an ID link in a remember
  1196. template to an entry not having an ID, create it first by
  1197. explicitly creating a link to it, using `C-c C-l' first.
  1198. create-if-interactive-and-no-custom-id
  1199. Like create-if-interactive, but do not create an ID if there is
  1200. a CUSTOM_ID property defined in the entry. This is the default.
  1201. use-existing
  1202. Use existing ID, do not create one.
  1203. nil Never use an ID to make a link, instead link using a text search for
  1204. the headline text."
  1205. :group 'org-link-store
  1206. :type '(choice
  1207. (const :tag "Create ID to make link" t)
  1208. (const :tag "Create if storing link interactively"
  1209. create-if-interactive)
  1210. (const :tag "Create if storing link interactively and no CUSTOM_ID is present"
  1211. create-if-interactive-and-no-custom-id)
  1212. (const :tag "Only use existing" use-existing)
  1213. (const :tag "Do not use ID to create link" nil)))
  1214. (defcustom org-context-in-file-links t
  1215. "Non-nil means file links from `org-store-link' contain context.
  1216. A search string will be added to the file name with :: as separator and
  1217. used to find the context when the link is activated by the command
  1218. `org-open-at-point'. When this option is t, the entire active region
  1219. will be placed in the search string of the file link. If set to a
  1220. positive integer, only the first n lines of context will be stored.
  1221. Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  1222. negates this setting for the duration of the command."
  1223. :group 'org-link-store
  1224. :type '(choice boolean integer))
  1225. (defcustom org-keep-stored-link-after-insertion nil
  1226. "Non-nil means keep link in list for entire session.
  1227. The command `org-store-link' adds a link pointing to the current
  1228. location to an internal list. These links accumulate during a session.
  1229. The command `org-insert-link' can be used to insert links into any
  1230. Org-mode file (offering completion for all stored links). When this
  1231. option is nil, every link which has been inserted once using \\[org-insert-link]
  1232. will be removed from the list, to make completing the unused links
  1233. more efficient."
  1234. :group 'org-link-store
  1235. :type 'boolean)
  1236. (defgroup org-link-follow nil
  1237. "Options concerning following links in Org-mode."
  1238. :tag "Org Follow Link"
  1239. :group 'org-link)
  1240. (defcustom org-link-translation-function nil
  1241. "Function to translate links with different syntax to Org syntax.
  1242. This can be used to translate links created for example by the Planner
  1243. or emacs-wiki packages to Org syntax.
  1244. The function must accept two parameters, a TYPE containing the link
  1245. protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
  1246. which is everything after the link protocol. It should return a cons
  1247. with possibly modified values of type and path.
  1248. Org contains a function for this, so if you set this variable to
  1249. `org-translate-link-from-planner', you should be able follow many
  1250. links created by planner."
  1251. :group 'org-link-follow
  1252. :type 'function)
  1253. (defcustom org-follow-link-hook nil
  1254. "Hook that is run after a link has been followed."
  1255. :group 'org-link-follow
  1256. :type 'hook)
  1257. (defcustom org-tab-follows-link nil
  1258. "Non-nil means on links TAB will follow the link.
  1259. Needs to be set before org.el is loaded.
  1260. This really should not be used, it does not make sense, and the
  1261. implementation is bad."
  1262. :group 'org-link-follow
  1263. :type 'boolean)
  1264. (defcustom org-return-follows-link nil
  1265. "Non-nil means on links RET will follow the link."
  1266. :group 'org-link-follow
  1267. :type 'boolean)
  1268. (defcustom org-mouse-1-follows-link
  1269. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  1270. "Non-nil means mouse-1 on a link will follow the link.
  1271. A longer mouse click will still set point. Does not work on XEmacs.
  1272. Needs to be set before org.el is loaded."
  1273. :group 'org-link-follow
  1274. :type 'boolean)
  1275. (defcustom org-mark-ring-length 4
  1276. "Number of different positions to be recorded in the ring.
  1277. Changing this requires a restart of Emacs to work correctly."
  1278. :group 'org-link-follow
  1279. :type 'integer)
  1280. (defcustom org-link-search-must-match-exact-headline 'query-to-create
  1281. "Non-nil means internal links in Org files must exactly match a headline.
  1282. When nil, the link search tries to match a phrase with all words
  1283. in the search text."
  1284. :group 'org-link-follow
  1285. :type '(choice
  1286. (const :tag "Use fuzy text search" nil)
  1287. (const :tag "Match only exact headline" t)
  1288. (const :tag "Match extact headline or query to create it"
  1289. query-to-create)))
  1290. (defcustom org-link-frame-setup
  1291. '((vm . vm-visit-folder-other-frame)
  1292. (gnus . org-gnus-no-new-news)
  1293. (file . find-file-other-window)
  1294. (wl . wl-other-frame))
  1295. "Setup the frame configuration for following links.
  1296. When following a link with Emacs, it may often be useful to display
  1297. this link in another window or frame. This variable can be used to
  1298. set this up for the different types of links.
  1299. For VM, use any of
  1300. `vm-visit-folder'
  1301. `vm-visit-folder-other-window'
  1302. `vm-visit-folder-other-frame'
  1303. For Gnus, use any of
  1304. `gnus'
  1305. `gnus-other-frame'
  1306. `org-gnus-no-new-news'
  1307. For FILE, use any of
  1308. `find-file'
  1309. `find-file-other-window'
  1310. `find-file-other-frame'
  1311. For Wanderlust use any of
  1312. `wl'
  1313. `wl-other-frame'
  1314. For the calendar, use the variable `calendar-setup'.
  1315. For BBDB, it is currently only possible to display the matches in
  1316. another window."
  1317. :group 'org-link-follow
  1318. :type '(list
  1319. (cons (const vm)
  1320. (choice
  1321. (const vm-visit-folder)
  1322. (const vm-visit-folder-other-window)
  1323. (const vm-visit-folder-other-frame)))
  1324. (cons (const gnus)
  1325. (choice
  1326. (const gnus)
  1327. (const gnus-other-frame)
  1328. (const org-gnus-no-new-news)))
  1329. (cons (const file)
  1330. (choice
  1331. (const find-file)
  1332. (const find-file-other-window)
  1333. (const find-file-other-frame)))
  1334. (cons (const wl)
  1335. (choice
  1336. (const wl)
  1337. (const wl-other-frame)))))
  1338. (defcustom org-display-internal-link-with-indirect-buffer nil
  1339. "Non-nil means use indirect buffer to display infile links.
  1340. Activating internal links (from one location in a file to another location
  1341. in the same file) normally just jumps to the location. When the link is
  1342. activated with a \\[universal-argument] prefix (or with mouse-3), the link \
  1343. is displayed in
  1344. another window. When this option is set, the other window actually displays
  1345. an indirect buffer clone of the current buffer, to avoid any visibility
  1346. changes to the current buffer."
  1347. :group 'org-link-follow
  1348. :type 'boolean)
  1349. (defcustom org-open-non-existing-files nil
  1350. "Non-nil means `org-open-file' will open non-existing files.
  1351. When nil, an error will be generated.
  1352. This variable applies only to external applications because they
  1353. might choke on non-existing files. If the link is to a file that
  1354. will be opened in Emacs, the variable is ignored."
  1355. :group 'org-link-follow
  1356. :type 'boolean)
  1357. (defcustom org-open-directory-means-index-dot-org nil
  1358. "Non-nil means a link to a directory really means to index.org.
  1359. When nil, following a directory link will run dired or open a finder/explorer
  1360. window on that directory."
  1361. :group 'org-link-follow
  1362. :type 'boolean)
  1363. (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
  1364. "Function and arguments to call for following mailto links.
  1365. This is a list with the first element being a Lisp function, and the
  1366. remaining elements being arguments to the function. In string arguments,
  1367. %a will be replaced by the address, and %s will be replaced by the subject
  1368. if one was given like in <mailto:arthur@galaxy.org::this subject>."
  1369. :group 'org-link-follow
  1370. :type '(choice
  1371. (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
  1372. (const :tag "compose-mail" (compose-mail "%a" "%s"))
  1373. (const :tag "message-mail" (message-mail "%a" "%s"))
  1374. (cons :tag "other" (function) (repeat :tag "argument" sexp))))
  1375. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  1376. "Non-nil means ask for confirmation before executing shell links.
  1377. Shell links can be dangerous: just think about a link
  1378. [[shell:rm -rf ~/*][Google Search]]
  1379. This link would show up in your Org-mode document as \"Google Search\",
  1380. but really it would remove your entire home directory.
  1381. Therefore we advise against setting this variable to nil.
  1382. Just change it to `y-or-n-p' if you want to confirm with a
  1383. single keystroke rather than having to type \"yes\"."
  1384. :group 'org-link-follow
  1385. :type '(choice
  1386. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1387. (const :tag "with y-or-n (faster)" y-or-n-p)
  1388. (const :tag "no confirmation (dangerous)" nil)))
  1389. (put 'org-confirm-shell-link-function
  1390. 'safe-local-variable
  1391. '(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1392. (defcustom org-confirm-shell-link-not-regexp ""
  1393. "A regexp to skip confirmation for shell links."
  1394. :group 'org-link-follow
  1395. :type 'regexp)
  1396. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  1397. "Non-nil means ask for confirmation before executing Emacs Lisp links.
  1398. Elisp links can be dangerous: just think about a link
  1399. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  1400. This link would show up in your Org-mode document as \"Google Search\",
  1401. but really it would remove your entire home directory.
  1402. Therefore we advise against setting this variable to nil.
  1403. Just change it to `y-or-n-p' if you want to confirm with a
  1404. single keystroke rather than having to type \"yes\"."
  1405. :group 'org-link-follow
  1406. :type '(choice
  1407. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1408. (const :tag "with y-or-n (faster)" y-or-n-p)
  1409. (const :tag "no confirmation (dangerous)" nil)))
  1410. (put 'org-confirm-shell-link-function
  1411. 'safe-local-variable
  1412. '(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1413. (defcustom org-confirm-elisp-link-not-regexp ""
  1414. "A regexp to skip confirmation for Elisp links."
  1415. :group 'org-link-follow
  1416. :type 'regexp)
  1417. (defconst org-file-apps-defaults-gnu
  1418. '((remote . emacs)
  1419. (system . mailcap)
  1420. (t . mailcap))
  1421. "Default file applications on a UNIX or GNU/Linux system.
  1422. See `org-file-apps'.")
  1423. (defconst org-file-apps-defaults-macosx
  1424. '((remote . emacs)
  1425. (t . "open %s")
  1426. (system . "open %s")
  1427. ("ps.gz" . "gv %s")
  1428. ("eps.gz" . "gv %s")
  1429. ("dvi" . "xdvi %s")
  1430. ("fig" . "xfig %s"))
  1431. "Default file applications on a MacOS X system.
  1432. The system \"open\" is known as a default, but we use X11 applications
  1433. for some files for which the OS does not have a good default.
  1434. See `org-file-apps'.")
  1435. (defconst org-file-apps-defaults-windowsnt
  1436. (list
  1437. '(remote . emacs)
  1438. (cons t
  1439. (list (if (featurep 'xemacs)
  1440. 'mswindows-shell-execute
  1441. 'w32-shell-execute)
  1442. "open" 'file))
  1443. (cons 'system
  1444. (list (if (featurep 'xemacs)
  1445. 'mswindows-shell-execute
  1446. 'w32-shell-execute)
  1447. "open" 'file)))
  1448. "Default file applications on a Windows NT system.
  1449. The system \"open\" is used for most files.
  1450. See `org-file-apps'.")
  1451. (defcustom org-file-apps
  1452. '(
  1453. (auto-mode . emacs)
  1454. ("\\.mm\\'" . default)
  1455. ("\\.x?html?\\'" . default)
  1456. ("\\.pdf\\'" . default)
  1457. )
  1458. "External applications for opening `file:path' items in a document.
  1459. Org-mode uses system defaults for different file types, but
  1460. you can use this variable to set the application for a given file
  1461. extension. The entries in this list are cons cells where the car identifies
  1462. files and the cdr the corresponding command. Possible values for the
  1463. file identifier are
  1464. \"string\" A string as a file identifier can be interpreted in different
  1465. ways, depending on its contents:
  1466. - Alphanumeric characters only:
  1467. Match links with this file extension.
  1468. Example: (\"pdf\" . \"evince %s\")
  1469. to open PDFs with evince.
  1470. - Regular expression: Match links where the
  1471. filename matches the regexp. If you want to
  1472. use groups here, use shy groups.
  1473. Example: (\"\\.x?html\\'\" . \"firefox %s\")
  1474. (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
  1475. to open *.html and *.xhtml with firefox.
  1476. - Regular expression which contains (non-shy) groups:
  1477. Match links where the whole link, including \"::\", and
  1478. anything after that, matches the regexp.
  1479. In a custom command string, %1, %2, etc. are replaced with
  1480. the parts of the link that were matched by the groups.
  1481. For backwards compatibility, if a command string is given
  1482. that does not use any of the group matches, this case is
  1483. handled identically to the second one (i.e. match against
  1484. file name only).
  1485. In a custom lisp form, you can access the group matches with
  1486. (match-string n link).
  1487. Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
  1488. to open [[file:document.pdf::5]] with evince at page 5.
  1489. `directory' Matches a directory
  1490. `remote' Matches a remote file, accessible through tramp or efs.
  1491. Remote files most likely should be visited through Emacs
  1492. because external applications cannot handle such paths.
  1493. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1494. so all files Emacs knows how to handle. Using this with
  1495. command `emacs' will open most files in Emacs. Beware that this
  1496. will also open html files inside Emacs, unless you add
  1497. (\"html\" . default) to the list as well.
  1498. t Default for files not matched by any of the other options.
  1499. `system' The system command to open files, like `open' on Windows
  1500. and Mac OS X, and mailcap under GNU/Linux. This is the command
  1501. that will be selected if you call `C-c C-o' with a double
  1502. \\[universal-argument] \\[universal-argument] prefix.
  1503. Possible values for the command are:
  1504. `emacs' The file will be visited by the current Emacs process.
  1505. `default' Use the default application for this file type, which is the
  1506. association for t in the list, most likely in the system-specific
  1507. part.
  1508. This can be used to overrule an unwanted setting in the
  1509. system-specific variable.
  1510. `system' Use the system command for opening files, like \"open\".
  1511. This command is specified by the entry whose car is `system'.
  1512. Most likely, the system-specific version of this variable
  1513. does define this command, but you can overrule/replace it
  1514. here.
  1515. string A command to be executed by a shell; %s will be replaced
  1516. by the path to the file.
  1517. sexp A Lisp form which will be evaluated. The file path will
  1518. be available in the Lisp variable `file'.
  1519. For more examples, see the system specific constants
  1520. `org-file-apps-defaults-macosx'
  1521. `org-file-apps-defaults-windowsnt'
  1522. `org-file-apps-defaults-gnu'."
  1523. :group 'org-link-follow
  1524. :type '(repeat
  1525. (cons (choice :value ""
  1526. (string :tag "Extension")
  1527. (const :tag "System command to open files" system)
  1528. (const :tag "Default for unrecognized files" t)
  1529. (const :tag "Remote file" remote)
  1530. (const :tag "Links to a directory" directory)
  1531. (const :tag "Any files that have Emacs modes"
  1532. auto-mode))
  1533. (choice :value ""
  1534. (const :tag "Visit with Emacs" emacs)
  1535. (const :tag "Use default" default)
  1536. (const :tag "Use the system command" system)
  1537. (string :tag "Command")
  1538. (sexp :tag "Lisp form")))))
  1539. (defgroup org-refile nil
  1540. "Options concerning refiling entries in Org-mode."
  1541. :tag "Org Refile"
  1542. :group 'org)
  1543. (defcustom org-directory "~/org"
  1544. "Directory with org files.
  1545. This is just a default location to look for Org files. There is no need
  1546. at all to put your files into this directory. It is only used in the
  1547. following situations:
  1548. 1. When a remember template specifies a target file that is not an
  1549. absolute path. The path will then be interpreted relative to
  1550. `org-directory'
  1551. 2. When a remember note is filed away in an interactive way (when exiting the
  1552. note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
  1553. with `org-directory' as the default path."
  1554. :group 'org-refile
  1555. :group 'org-remember
  1556. :type 'directory)
  1557. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  1558. "Default target for storing notes.
  1559. Used as a fall back file for org-remember.el and org-capture.el, for
  1560. templates that do not specify a target file."
  1561. :group 'org-refile
  1562. :group 'org-remember
  1563. :type '(choice
  1564. (const :tag "Default from remember-data-file" nil)
  1565. file))
  1566. (defcustom org-goto-interface 'outline
  1567. "The default interface to be used for `org-goto'.
  1568. Allowed values are:
  1569. outline The interface shows an outline of the relevant file
  1570. and the correct heading is found by moving through
  1571. the outline or by searching with incremental search.
  1572. outline-path-completion Headlines in the current buffer are offered via
  1573. completion. This is the interface also used by
  1574. the refile command."
  1575. :group 'org-refile
  1576. :type '(choice
  1577. (const :tag "Outline" outline)
  1578. (const :tag "Outline-path-completion" outline-path-completion)))
  1579. (defcustom org-goto-max-level 5
  1580. "Maximum target level when running `org-goto' with refile interface."
  1581. :group 'org-refile
  1582. :type 'integer)
  1583. (defcustom org-reverse-note-order nil
  1584. "Non-nil means store new notes at the beginning of a file or entry.
  1585. When nil, new notes will be filed to the end of a file or entry.
  1586. This can also be a list with cons cells of regular expressions that
  1587. are matched against file names, and values."
  1588. :group 'org-remember
  1589. :group 'org-refile
  1590. :type '(choice
  1591. (const :tag "Reverse always" t)
  1592. (const :tag "Reverse never" nil)
  1593. (repeat :tag "By file name regexp"
  1594. (cons regexp boolean))))
  1595. (defcustom org-log-refile nil
  1596. "Information to record when a task is refiled.
  1597. Possible values are:
  1598. nil Don't add anything
  1599. time Add a time stamp to the task
  1600. note Prompt for a note and add it with template `org-log-note-headings'
  1601. This option can also be set with on a per-file-basis with
  1602. #+STARTUP: nologrefile
  1603. #+STARTUP: logrefile
  1604. #+STARTUP: lognoterefile
  1605. You can have local logging settings for a subtree by setting the LOGGING
  1606. property to one or more of these keywords.
  1607. When bulk-refiling from the agenda, the value `note' is forbidden and
  1608. will temporarily be changed to `time'."
  1609. :group 'org-refile
  1610. :group 'org-progress
  1611. :type '(choice
  1612. (const :tag "No logging" nil)
  1613. (const :tag "Record timestamp" time)
  1614. (const :tag "Record timestamp with note." note)))
  1615. (defcustom org-refile-targets nil
  1616. "Targets for refiling entries with \\[org-refile].
  1617. This is list of cons cells. Each cell contains:
  1618. - a specification of the files to be considered, either a list of files,
  1619. or a symbol whose function or variable value will be used to retrieve
  1620. a file name or a list of file names. If you use `org-agenda-files' for
  1621. that, all agenda files will be scanned for targets. Nil means consider
  1622. headings in the current buffer.
  1623. - A specification of how to find candidate refile targets. This may be
  1624. any of:
  1625. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  1626. This tag has to be present in all target headlines, inheritance will
  1627. not be considered.
  1628. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  1629. todo keyword.
  1630. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  1631. headlines that are refiling targets.
  1632. - a cons cell (:level . N). Any headline of level N is considered a target.
  1633. Note that, when `org-odd-levels-only' is set, level corresponds to
  1634. order in hierarchy, not to the number of stars.
  1635. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  1636. Note that, when `org-odd-levels-only' is set, level corresponds to
  1637. order in hierarchy, not to the number of stars.
  1638. You can set the variable `org-refile-target-verify-function' to a function
  1639. to verify each headline found by the simple criteria above.
  1640. When this variable is nil, all top-level headlines in the current buffer
  1641. are used, equivalent to the value `((nil . (:level . 1))'."
  1642. :group 'org-refile
  1643. :type '(repeat
  1644. (cons
  1645. (choice :value org-agenda-files
  1646. (const :tag "All agenda files" org-agenda-files)
  1647. (const :tag "Current buffer" nil)
  1648. (function) (variable) (file))
  1649. (choice :tag "Identify target headline by"
  1650. (cons :tag "Specific tag" (const :value :tag) (string))
  1651. (cons :tag "TODO keyword" (const :value :todo) (string))
  1652. (cons :tag "Regular expression" (const :value :regexp) (regexp))
  1653. (cons :tag "Level number" (const :value :level) (integer))
  1654. (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
  1655. (defcustom org-refile-target-verify-function nil
  1656. "Function to verify if the headline at point should be a refile target.
  1657. The function will be called without arguments, with point at the
  1658. beginning of the headline. It should return t and leave point
  1659. where it is if the headline is a valid target for refiling.
  1660. If the target should not be selected, the function must return nil.
  1661. In addition to this, it may move point to a place from where the search
  1662. should be continued. For example, the function may decide that the entire
  1663. subtree of the current entry should be excluded and move point to the end
  1664. of the subtree."
  1665. :group 'org-refile
  1666. :type 'function)
  1667. (defcustom org-refile-use-cache nil
  1668. "Non-nil means cache refile targets to speed up the process.
  1669. The cache for a particular file will be updated automatically when
  1670. the buffer has been killed, or when any of the marker used for flagging
  1671. refile targets no longer points at a live buffer.
  1672. If you have added new entries to a buffer that might themselves be targets,
  1673. you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
  1674. find that easier, `C-u C-u C-u C-c C-w'."
  1675. :group 'org-refile
  1676. :type 'boolean)
  1677. (defcustom org-refile-use-outline-path nil
  1678. "Non-nil means provide refile targets as paths.
  1679. So a level 3 headline will be available as level1/level2/level3.
  1680. When the value is `file', also include the file name (without directory)
  1681. into the path. In this case, you can also stop the completion after
  1682. the file name, to get entries inserted as top level in the file.
  1683. When `full-file-path', include the full file path."
  1684. :group 'org-refile
  1685. :type '(choice
  1686. (const :tag "Not" nil)
  1687. (const :tag "Yes" t)
  1688. (const :tag "Start with file name" file)
  1689. (const :tag "Start with full file path" full-file-path)))
  1690. (defcustom org-outline-path-complete-in-steps t
  1691. "Non-nil means complete the outline path in hierarchical steps.
  1692. When Org-mode uses the refile interface to select an outline path
  1693. \(see variable `org-refile-use-outline-path'), the completion of
  1694. the path can be done is a single go, or if can be done in steps down
  1695. the headline hierarchy. Going in steps is probably the best if you
  1696. do not use a special completion package like `ido' or `icicles'.
  1697. However, when using these packages, going in one step can be very
  1698. fast, while still showing the whole path to the entry."
  1699. :group 'org-refile
  1700. :type 'boolean)
  1701. (defcustom org-refile-allow-creating-parent-nodes nil
  1702. "Non-nil means allow to create new nodes as refile targets.
  1703. New nodes are then created by adding \"/new node name\" to the completion
  1704. of an existing node. When the value of this variable is `confirm',
  1705. new node creation must be confirmed by the user (recommended)
  1706. When nil, the completion must match an existing entry.
  1707. Note that, if the new heading is not seen by the criteria
  1708. listed in `org-refile-targets', multiple instances of the same
  1709. heading would be created by trying again to file under the new
  1710. heading."
  1711. :group 'org-refile
  1712. :type '(choice
  1713. (const :tag "Never" nil)
  1714. (const :tag "Always" t)
  1715. (const :tag "Prompt for confirmation" confirm)))
  1716. (defgroup org-todo nil
  1717. "Options concerning TODO items in Org-mode."
  1718. :tag "Org TODO"
  1719. :group 'org)
  1720. (defgroup org-progress nil
  1721. "Options concerning Progress logging in Org-mode."
  1722. :tag "Org Progress"
  1723. :group 'org-time)
  1724. (defvar org-todo-interpretation-widgets
  1725. '(
  1726. (:tag "Sequence (cycling hits every state)" sequence)
  1727. (:tag "Type (cycling directly to DONE)" type))
  1728. "The available interpretation symbols for customizing `org-todo-keywords'.
  1729. Interested libraries should add to this list.")
  1730. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  1731. "List of TODO entry keyword sequences and their interpretation.
  1732. \\<org-mode-map>This is a list of sequences.
  1733. Each sequence starts with a symbol, either `sequence' or `type',
  1734. indicating if the keywords should be interpreted as a sequence of
  1735. action steps, or as different types of TODO items. The first
  1736. keywords are states requiring action - these states will select a headline
  1737. for inclusion into the global TODO list Org-mode produces. If one of
  1738. the \"keywords\" is the vertical bar, \"|\", the remaining keywords
  1739. signify that no further action is necessary. If \"|\" is not found,
  1740. the last keyword is treated as the only DONE state of the sequence.
  1741. The command \\[org-todo] cycles an entry through these states, and one
  1742. additional state where no keyword is present. For details about this
  1743. cycling, see the manual.
  1744. TODO keywords and interpretation can also be set on a per-file basis with
  1745. the special #+SEQ_TODO and #+TYP_TODO lines.
  1746. Each keyword can optionally specify a character for fast state selection
  1747. \(in combination with the variable `org-use-fast-todo-selection')
  1748. and specifiers for state change logging, using the same syntax
  1749. that is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says
  1750. that the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  1751. indicates to record a time stamp each time this state is selected.
  1752. Each keyword may also specify if a timestamp or a note should be
  1753. recorded when entering or leaving the state, by adding additional
  1754. characters in the parenthesis after the keyword. This looks like this:
  1755. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  1756. record only the time of the state change. With X and Y being either
  1757. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  1758. Y when leaving the state if and only if the *target* state does not
  1759. define X. You may omit any of the fast-selection key or X or /Y,
  1760. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  1761. For backward compatibility, this variable may also be just a list
  1762. of keywords - in this case the interpretation (sequence or type) will be
  1763. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  1764. :group 'org-todo
  1765. :group 'org-keywords
  1766. :type '(choice
  1767. (repeat :tag "Old syntax, just keywords"
  1768. (string :tag "Keyword"))
  1769. (repeat :tag "New syntax"
  1770. (cons
  1771. (choice
  1772. :tag "Interpretation"
  1773. ;;Quick and dirty way to see
  1774. ;;`org-todo-interpretations'. This takes the
  1775. ;;place of item arguments
  1776. :convert-widget
  1777. (lambda (widget)
  1778. (widget-put widget
  1779. :args (mapcar
  1780. #'(lambda (x)
  1781. (widget-convert
  1782. (cons 'const x)))
  1783. org-todo-interpretation-widgets))
  1784. widget))
  1785. (repeat
  1786. (string :tag "Keyword"))))))
  1787. (defvar org-todo-keywords-1 nil
  1788. "All TODO and DONE keywords active in a buffer.")
  1789. (make-variable-buffer-local 'org-todo-keywords-1)
  1790. (defvar org-todo-keywords-for-agenda nil)
  1791. (defvar org-done-keywords-for-agenda nil)
  1792. (defvar org-drawers-for-agenda nil)
  1793. (defvar org-todo-keyword-alist-for-agenda nil)
  1794. (defvar org-tag-alist-for-agenda nil)
  1795. (defvar org-agenda-contributing-files nil)
  1796. (defvar org-not-done-keywords nil)
  1797. (make-variable-buffer-local 'org-not-done-keywords)
  1798. (defvar org-done-keywords nil)
  1799. (make-variable-buffer-local 'org-done-keywords)
  1800. (defvar org-todo-heads nil)
  1801. (make-variable-buffer-local 'org-todo-heads)
  1802. (defvar org-todo-sets nil)
  1803. (make-variable-buffer-local 'org-todo-sets)
  1804. (defvar org-todo-log-states nil)
  1805. (make-variable-buffer-local 'org-todo-log-states)
  1806. (defvar org-todo-kwd-alist nil)
  1807. (make-variable-buffer-local 'org-todo-kwd-alist)
  1808. (defvar org-todo-key-alist nil)
  1809. (make-variable-buffer-local 'org-todo-key-alist)
  1810. (defvar org-todo-key-trigger nil)
  1811. (make-variable-buffer-local 'org-todo-key-trigger)
  1812. (defcustom org-todo-interpretation 'sequence
  1813. "Controls how TODO keywords are interpreted.
  1814. This variable is in principle obsolete and is only used for
  1815. backward compatibility, if the interpretation of todo keywords is
  1816. not given already in `org-todo-keywords'. See that variable for
  1817. more information."
  1818. :group 'org-todo
  1819. :group 'org-keywords
  1820. :type '(choice (const sequence)
  1821. (const type)))
  1822. (defcustom org-use-fast-todo-selection t
  1823. "Non-nil means use the fast todo selection scheme with C-c C-t.
  1824. This variable describes if and under what circumstances the cycling
  1825. mechanism for TODO keywords will be replaced by a single-key, direct
  1826. selection scheme.
  1827. When nil, fast selection is never used.
  1828. When the symbol `prefix', it will be used when `org-todo' is called with
  1829. a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
  1830. in an agenda buffer.
  1831. When t, fast selection is used by default. In this case, the prefix
  1832. argument forces cycling instead.
  1833. In all cases, the special interface is only used if access keys have actually
  1834. been assigned by the user, i.e. if keywords in the configuration are followed
  1835. by a letter in parenthesis, like TODO(t)."
  1836. :group 'org-todo
  1837. :type '(choice
  1838. (const :tag "Never" nil)
  1839. (const :tag "By default" t)
  1840. (const :tag "Only with C-u C-c C-t" prefix)))
  1841. (defcustom org-provide-todo-statistics t
  1842. "Non-nil means update todo statistics after insert and toggle.
  1843. ALL-HEADLINES means update todo statistics by including headlines
  1844. with no TODO keyword as well, counting them as not done.
  1845. A list of TODO keywords means the same, but skip keywords that are
  1846. not in this list.
  1847. When this is set, todo statistics is updated in the parent of the
  1848. current entry each time a todo state is changed."
  1849. :group 'org-todo
  1850. :type '(choice
  1851. (const :tag "Yes, only for TODO entries" t)
  1852. (const :tag "Yes, including all entries" 'all-headlines)
  1853. (repeat :tag "Yes, for TODOs in this list"
  1854. (string :tag "TODO keyword"))
  1855. (other :tag "No TODO statistics" nil)))
  1856. (defcustom org-hierarchical-todo-statistics t
  1857. "Non-nil means TODO statistics covers just direct children.
  1858. When nil, all entries in the subtree are considered.
  1859. This has only an effect if `org-provide-todo-statistics' is set.
  1860. To set this to nil for only a single subtree, use a COOKIE_DATA
  1861. property and include the word \"recursive\" into the value."
  1862. :group 'org-todo
  1863. :type 'boolean)
  1864. (defcustom org-after-todo-state-change-hook nil
  1865. "Hook which is run after the state of a TODO item was changed.
  1866. The new state (a string with a TODO keyword, or nil) is available in the
  1867. Lisp variable `state'."
  1868. :group 'org-todo
  1869. :type 'hook)
  1870. (defvar org-blocker-hook nil
  1871. "Hook for functions that are allowed to block a state change.
  1872. Each function gets as its single argument a property list, see
  1873. `org-trigger-hook' for more information about this list.
  1874. If any of the functions in this hook returns nil, the state change
  1875. is blocked.")
  1876. (defvar org-trigger-hook nil
  1877. "Hook for functions that are triggered by a state change.
  1878. Each function gets as its single argument a property list with at least
  1879. the following elements:
  1880. (:type type-of-change :position pos-at-entry-start
  1881. :from old-state :to new-state)
  1882. Depending on the type, more properties may be present.
  1883. This mechanism is currently implemented for:
  1884. TODO state changes
  1885. ------------------
  1886. :type todo-state-change
  1887. :from previous state (keyword as a string), or nil, or a symbol
  1888. 'todo' or 'done', to indicate the general type of state.
  1889. :to new state, like in :from")
  1890. (defcustom org-enforce-todo-dependencies nil
  1891. "Non-nil means undone TODO entries will block switching the parent to DONE.
  1892. Also, if a parent has an :ORDERED: property, switching an entry to DONE will
  1893. be blocked if any prior sibling is not yet done.
  1894. Finally, if the parent is blocked because of ordered siblings of its own,
  1895. the child will also be blocked.
  1896. This variable needs to be set before org.el is loaded, and you need to
  1897. restart Emacs after a change to make the change effective. The only way
  1898. to change is while Emacs is running is through the customize interface."
  1899. :set (lambda (var val)
  1900. (set var val)
  1901. (if val
  1902. (add-hook 'org-blocker-hook
  1903. 'org-block-todo-from-children-or-siblings-or-parent)
  1904. (remove-hook 'org-blocker-hook
  1905. 'org-block-todo-from-children-or-siblings-or-parent)))
  1906. :group 'org-todo
  1907. :type 'boolean)
  1908. (defcustom org-enforce-todo-checkbox-dependencies nil
  1909. "Non-nil means unchecked boxes will block switching the parent to DONE.
  1910. When this is nil, checkboxes have no influence on switching TODO states.
  1911. When non-nil, you first need to check off all check boxes before the TODO
  1912. entry can be switched to DONE.
  1913. This variable needs to be set before org.el is loaded, and you need to
  1914. restart Emacs after a change to make the change effective. The only way
  1915. to change is while Emacs is running is through the customize interface."
  1916. :set (lambda (var val)
  1917. (set var val)
  1918. (if val
  1919. (add-hook 'org-blocker-hook
  1920. 'org-block-todo-from-checkboxes)
  1921. (remove-hook 'org-blocker-hook
  1922. 'org-block-todo-from-checkboxes)))
  1923. :group 'org-todo
  1924. :type 'boolean)
  1925. (defcustom org-treat-insert-todo-heading-as-state-change nil
  1926. "Non-nil means inserting a TODO heading is treated as state change.
  1927. So when the command \\[org-insert-todo-heading] is used, state change
  1928. logging will apply if appropriate. When nil, the new TODO item will
  1929. be inserted directly, and no logging will take place."
  1930. :group 'org-todo
  1931. :type 'boolean)
  1932. (defcustom org-treat-S-cursor-todo-selection-as-state-change t
  1933. "Non-nil means switching TODO states with S-cursor counts as state change.
  1934. This is the default behavior. However, setting this to nil allows a
  1935. convenient way to select a TODO state and bypass any logging associated
  1936. with that."
  1937. :group 'org-todo
  1938. :type 'boolean)
  1939. (defcustom org-todo-state-tags-triggers nil
  1940. "Tag changes that should be triggered by TODO state changes.
  1941. This is a list. Each entry is
  1942. (state-change (tag . flag) .......)
  1943. State-change can be a string with a state, and empty string to indicate the
  1944. state that has no TODO keyword, or it can be one of the symbols `todo'
  1945. or `done', meaning any not-done or done state, respectively."
  1946. :group 'org-todo
  1947. :group 'org-tags
  1948. :type '(repeat
  1949. (cons (choice :tag "When changing to"
  1950. (const :tag "Not-done state" todo)
  1951. (const :tag "Done state" done)
  1952. (string :tag "State"))
  1953. (repeat
  1954. (cons :tag "Tag action"
  1955. (string :tag "Tag")
  1956. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  1957. (defcustom org-log-done nil
  1958. "Information to record when a task moves to the DONE state.
  1959. Possible values are:
  1960. nil Don't add anything, just change the keyword
  1961. time Add a time stamp to the task
  1962. note Prompt for a note and add it with template `org-log-note-headings'
  1963. This option can also be set with on a per-file-basis with
  1964. #+STARTUP: nologdone
  1965. #+STARTUP: logdone
  1966. #+STARTUP: lognotedone
  1967. You can have local logging settings for a subtree by setting the LOGGING
  1968. property to one or more of these keywords."
  1969. :group 'org-todo
  1970. :group 'org-progress
  1971. :type '(choice
  1972. (const :tag "No logging" nil)
  1973. (const :tag "Record CLOSED timestamp" time)
  1974. (const :tag "Record CLOSED timestamp with note." note)))
  1975. ;; Normalize old uses of org-log-done.
  1976. (cond
  1977. ((eq org-log-done t) (setq org-log-done 'time))
  1978. ((and (listp org-log-done) (memq 'done org-log-done))
  1979. (setq org-log-done 'note)))
  1980. (defcustom org-log-reschedule nil
  1981. "Information to record when the scheduling date of a tasks is modified.
  1982. Possible values are:
  1983. nil Don't add anything, just change the date
  1984. time Add a time stamp to the task
  1985. note Prompt for a note and add it with template `org-log-note-headings'
  1986. This option can also be set with on a per-file-basis with
  1987. #+STARTUP: nologreschedule
  1988. #+STARTUP: logreschedule
  1989. #+STARTUP: lognotereschedule"
  1990. :group 'org-todo
  1991. :group 'org-progress
  1992. :type '(choice
  1993. (const :tag "No logging" nil)
  1994. (const :tag "Record timestamp" time)
  1995. (const :tag "Record timestamp with note." note)))
  1996. (defcustom org-log-redeadline nil
  1997. "Information to record when the deadline date of a tasks is modified.
  1998. Possible values are:
  1999. nil Don't add anything, just change the date
  2000. time Add a time stamp to the task
  2001. note Prompt for a note and add it with template `org-log-note-headings'
  2002. This option can also be set with on a per-file-basis with
  2003. #+STARTUP: nologredeadline
  2004. #+STARTUP: logredeadline
  2005. #+STARTUP: lognoteredeadline
  2006. You can have local logging settings for a subtree by setting the LOGGING
  2007. property to one or more of these keywords."
  2008. :group 'org-todo
  2009. :group 'org-progress
  2010. :type '(choice
  2011. (const :tag "No logging" nil)
  2012. (const :tag "Record timestamp" time)
  2013. (const :tag "Record timestamp with note." note)))
  2014. (defcustom org-log-note-clock-out nil
  2015. "Non-nil means record a note when clocking out of an item.
  2016. This can also be configured on a per-file basis by adding one of
  2017. the following lines anywhere in the buffer:
  2018. #+STARTUP: lognoteclock-out
  2019. #+STARTUP: nolognoteclock-out"
  2020. :group 'org-todo
  2021. :group 'org-progress
  2022. :type 'boolean)
  2023. (defcustom org-log-done-with-time t
  2024. "Non-nil means the CLOSED time stamp will contain date and time.
  2025. When nil, only the date will be recorded."
  2026. :group 'org-progress
  2027. :type 'boolean)
  2028. (defcustom org-log-note-headings
  2029. '((done . "CLOSING NOTE %t")
  2030. (state . "State %-12s from %-12S %t")
  2031. (note . "Note taken on %t")
  2032. (reschedule . "Rescheduled from %S on %t")
  2033. (delschedule . "Not scheduled, was %S on %t")
  2034. (redeadline . "New deadline from %S on %t")
  2035. (deldeadline . "Removed deadline, was %S on %t")
  2036. (refile . "Refiled on %t")
  2037. (clock-out . ""))
  2038. "Headings for notes added to entries.
  2039. The value is an alist, with the car being a symbol indicating the note
  2040. context, and the cdr is the heading to be used. The heading may also be the
  2041. empty string.
  2042. %t in the heading will be replaced by a time stamp.
  2043. %T will be an active time stamp instead the default inactive one
  2044. %s will be replaced by the new TODO state, in double quotes.
  2045. %S will be replaced by the old TODO state, in double quotes.
  2046. %u will be replaced by the user name.
  2047. %U will be replaced by the full user name.
  2048. In fact, it is not a good idea to change the `state' entry, because
  2049. agenda log mode depends on the format of these entries."
  2050. :group 'org-todo
  2051. :group 'org-progress
  2052. :type '(list :greedy t
  2053. (cons (const :tag "Heading when closing an item" done) string)
  2054. (cons (const :tag
  2055. "Heading when changing todo state (todo sequence only)"
  2056. state) string)
  2057. (cons (const :tag "Heading when just taking a note" note) string)
  2058. (cons (const :tag "Heading when clocking out" clock-out) string)
  2059. (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
  2060. (cons (const :tag "Heading when rescheduling" reschedule) string)
  2061. (cons (const :tag "Heading when changing deadline" redeadline) string)
  2062. (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
  2063. (cons (const :tag "Heading when refiling" refile) string)))
  2064. (unless (assq 'note org-log-note-headings)
  2065. (push '(note . "%t") org-log-note-headings))
  2066. (defcustom org-log-into-drawer nil
  2067. "Non-nil means insert state change notes and time stamps into a drawer.
  2068. When nil, state changes notes will be inserted after the headline and
  2069. any scheduling and clock lines, but not inside a drawer.
  2070. The value of this variable should be the name of the drawer to use.
  2071. LOGBOOK is proposed at the default drawer for this purpose, you can
  2072. also set this to a string to define the drawer of your choice.
  2073. A value of t is also allowed, representing \"LOGBOOK\".
  2074. If this variable is set, `org-log-state-notes-insert-after-drawers'
  2075. will be ignored.
  2076. You can set the property LOG_INTO_DRAWER to overrule this setting for
  2077. a subtree."
  2078. :group 'org-todo
  2079. :group 'org-progress
  2080. :type '(choice
  2081. (const :tag "Not into a drawer" nil)
  2082. (const :tag "LOGBOOK" t)
  2083. (string :tag "Other")))
  2084. (if (fboundp 'defvaralias)
  2085. (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer))
  2086. (defun org-log-into-drawer ()
  2087. "Return the value of `org-log-into-drawer', but let properties overrule.
  2088. If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
  2089. used instead of the default value."
  2090. (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
  2091. (cond
  2092. ((or (not p) (equal p "nil")) org-log-into-drawer)
  2093. ((equal p "t") "LOGBOOK")
  2094. (t p))))
  2095. (defcustom org-log-state-notes-insert-after-drawers nil
  2096. "Non-nil means insert state change notes after any drawers in entry.
  2097. Only the drawers that *immediately* follow the headline and the
  2098. deadline/scheduled line are skipped.
  2099. When nil, insert notes right after the heading and perhaps the line
  2100. with deadline/scheduling if present.
  2101. This variable will have no effect if `org-log-into-drawer' is
  2102. set."
  2103. :group 'org-todo
  2104. :group 'org-progress
  2105. :type 'boolean)
  2106. (defcustom org-log-states-order-reversed t
  2107. "Non-nil means the latest state note will be directly after heading.
  2108. When nil, the state change notes will be ordered according to time."
  2109. :group 'org-todo
  2110. :group 'org-progress
  2111. :type 'boolean)
  2112. (defcustom org-todo-repeat-to-state nil
  2113. "The TODO state to which a repeater should return the repeating task.
  2114. By default this is the first task in a TODO sequence, or the previous state
  2115. in a TODO_TYP set. But you can specify another task here.
  2116. alternatively, set the :REPEAT_TO_STATE: property of the entry."
  2117. :group 'org-todo
  2118. :type '(choice (const :tag "Head of sequence" nil)
  2119. (string :tag "Specific state")))
  2120. (defcustom org-log-repeat 'time
  2121. "Non-nil means record moving through the DONE state when triggering repeat.
  2122. An auto-repeating task is immediately switched back to TODO when
  2123. marked DONE. If you are not logging state changes (by adding \"@\"
  2124. or \"!\" to the TODO keyword definition), or set `org-log-done' to
  2125. record a closing note, there will be no record of the task moving
  2126. through DONE. This variable forces taking a note anyway.
  2127. nil Don't force a record
  2128. time Record a time stamp
  2129. note Record a note
  2130. This option can also be set with on a per-file-basis with
  2131. #+STARTUP: logrepeat
  2132. #+STARTUP: lognoterepeat
  2133. #+STARTUP: nologrepeat
  2134. You can have local logging settings for a subtree by setting the LOGGING
  2135. property to one or more of these keywords."
  2136. :group 'org-todo
  2137. :group 'org-progress
  2138. :type '(choice
  2139. (const :tag "Don't force a record" nil)
  2140. (const :tag "Force recording the DONE state" time)
  2141. (const :tag "Force recording a note with the DONE state" note)))
  2142. (defgroup org-priorities nil
  2143. "Priorities in Org-mode."
  2144. :tag "Org Priorities"
  2145. :group 'org-todo)
  2146. (defcustom org-enable-priority-commands t
  2147. "Non-nil means priority commands are active.
  2148. When nil, these commands will be disabled, so that you never accidentally
  2149. set a priority."
  2150. :group 'org-priorities
  2151. :type 'boolean)
  2152. (defcustom org-highest-priority ?A
  2153. "The highest priority of TODO items. A character like ?A, ?B etc.
  2154. Must have a smaller ASCII number than `org-lowest-priority'."
  2155. :group 'org-priorities
  2156. :type 'character)
  2157. (defcustom org-lowest-priority ?C
  2158. "The lowest priority of TODO items. A character like ?A, ?B etc.
  2159. Must have a larger ASCII number than `org-highest-priority'."
  2160. :group 'org-priorities
  2161. :type 'character)
  2162. (defcustom org-default-priority ?B
  2163. "The default priority of TODO items.
  2164. This is the priority an item get if no explicit priority is given."
  2165. :group 'org-priorities
  2166. :type 'character)
  2167. (defcustom org-priority-start-cycle-with-default t
  2168. "Non-nil means start with default priority when starting to cycle.
  2169. When this is nil, the first step in the cycle will be (depending on the
  2170. command used) one higher or lower that the default priority."
  2171. :group 'org-priorities
  2172. :type 'boolean)
  2173. (defcustom org-get-priority-function nil
  2174. "Function to extract the priority from a string.
  2175. The string is normally the headline. If this is nil Org computes the
  2176. priority from the priority cookie like [#A] in the headline. It returns
  2177. an integer, increasing by 1000 for each priority level.
  2178. The user can set a different function here, which should take a string
  2179. as an argument and return the numeric priority."
  2180. :group 'org-priorities
  2181. :type 'function)
  2182. (defgroup org-time nil
  2183. "Options concerning time stamps and deadlines in Org-mode."
  2184. :tag "Org Time"
  2185. :group 'org)
  2186. (defcustom org-insert-labeled-timestamps-at-point nil
  2187. "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
  2188. When nil, these labeled time stamps are forces into the second line of an
  2189. entry, just after the headline. When scheduling from the global TODO list,
  2190. the time stamp will always be forced into the second line."
  2191. :group 'org-time
  2192. :type 'boolean)
  2193. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  2194. "Formats for `format-time-string' which are used for time stamps.
  2195. It is not recommended to change this constant.")
  2196. (defcustom org-time-stamp-rounding-minutes '(0 5)
  2197. "Number of minutes to round time stamps to.
  2198. These are two values, the first applies when first creating a time stamp.
  2199. The second applies when changing it with the commands `S-up' and `S-down'.
  2200. When changing the time stamp, this means that it will change in steps
  2201. of N minutes, as given by the second value.
  2202. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  2203. numbers should be factors of 60, so for example 5, 10, 15.
  2204. When this is larger than 1, you can still force an exact time stamp by using
  2205. a double prefix argument to a time stamp command like `C-c .' or `C-c !',
  2206. and by using a prefix arg to `S-up/down' to specify the exact number
  2207. of minutes to shift."
  2208. :group 'org-time
  2209. :get '(lambda (var) ; Make sure both elements are there
  2210. (if (integerp (default-value var))
  2211. (list (default-value var) 5)
  2212. (default-value var)))
  2213. :type '(list
  2214. (integer :tag "when inserting times")
  2215. (integer :tag "when modifying times")))
  2216. ;; Normalize old customizations of this variable.
  2217. (when (integerp org-time-stamp-rounding-minutes)
  2218. (setq org-time-stamp-rounding-minutes
  2219. (list org-time-stamp-rounding-minutes
  2220. org-time-stamp-rounding-minutes)))
  2221. (defcustom org-display-custom-times nil
  2222. "Non-nil means overlay custom formats over all time stamps.
  2223. The formats are defined through the variable `org-time-stamp-custom-formats'.
  2224. To turn this on on a per-file basis, insert anywhere in the file:
  2225. #+STARTUP: customtime"
  2226. :group 'org-time
  2227. :set 'set-default
  2228. :type 'sexp)
  2229. (make-variable-buffer-local 'org-display-custom-times)
  2230. (defcustom org-time-stamp-custom-formats
  2231. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  2232. "Custom formats for time stamps. See `format-time-string' for the syntax.
  2233. These are overlayed over the default ISO format if the variable
  2234. `org-display-custom-times' is set. Time like %H:%M should be at the
  2235. end of the second format. The custom formats are also honored by export
  2236. commands, if custom time display is turned on at the time of export."
  2237. :group 'org-time
  2238. :type 'sexp)
  2239. (defun org-time-stamp-format (&optional long inactive)
  2240. "Get the right format for a time string."
  2241. (let ((f (if long (cdr org-time-stamp-formats)
  2242. (car org-time-stamp-formats))))
  2243. (if inactive
  2244. (concat "[" (substring f 1 -1) "]")
  2245. f)))
  2246. (defcustom org-time-clocksum-format "%d:%02d"
  2247. "The format string used when creating CLOCKSUM lines.
  2248. This is also used when org-mode generates a time duration."
  2249. :group 'org-time
  2250. :type 'string)
  2251. (defcustom org-time-clocksum-use-fractional nil
  2252. "If non-nil, \\[org-clock-display] uses fractional times.
  2253. org-mode generates a time duration."
  2254. :group 'org-time
  2255. :type 'boolean)
  2256. (defcustom org-time-clocksum-fractional-format "%.2f"
  2257. "The format string used when creating CLOCKSUM lines, or when
  2258. org-mode generates a time duration."
  2259. :group 'org-time
  2260. :type 'string)
  2261. (defcustom org-deadline-warning-days 14
  2262. "No. of days before expiration during which a deadline becomes active.
  2263. This variable governs the display in sparse trees and in the agenda.
  2264. When 0 or negative, it means use this number (the absolute value of it)
  2265. even if a deadline has a different individual lead time specified.
  2266. Custom commands can set this variable in the options section."
  2267. :group 'org-time
  2268. :group 'org-agenda-daily/weekly
  2269. :type 'integer)
  2270. (defcustom org-read-date-prefer-future t
  2271. "Non-nil means assume future for incomplete date input from user.
  2272. This affects the following situations:
  2273. 1. The user gives a month but not a year.
  2274. For example, if it is April and you enter \"feb 2\", this will be read
  2275. as Feb 2, *next* year. \"May 5\", however, will be this year.
  2276. 2. The user gives a day, but no month.
  2277. For example, if today is the 15th, and you enter \"3\", Org-mode will
  2278. read this as the third of *next* month. However, if you enter \"17\",
  2279. it will be considered as *this* month.
  2280. If you set this variable to the symbol `time', then also the following
  2281. will work:
  2282. 3. If the user gives a time, but no day. If the time is before now,
  2283. to will be interpreted as tomorrow.
  2284. Currently none of this works for ISO week specifications.
  2285. When this option is nil, the current day, month and year will always be
  2286. used as defaults.
  2287. See also `org-agenda-jump-prefer-future'."
  2288. :group 'org-time
  2289. :type '(choice
  2290. (const :tag "Never" nil)
  2291. (const :tag "Check month and day" t)
  2292. (const :tag "Check month, day, and time" time)))
  2293. (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
  2294. "Should the agenda jump command prefer the future for incomplete dates?
  2295. The default is to do the same as configured in `org-read-date-prefer-future'.
  2296. But you can also set a deviating value here.
  2297. This may t or nil, or the symbol `org-read-date-prefer-future'."
  2298. :group 'org-agenda
  2299. :group 'org-time
  2300. :type '(choice
  2301. (const :tag "Use org-read-date-prefer-future"
  2302. org-read-date-prefer-future)
  2303. (const :tag "Never" nil)
  2304. (const :tag "Always" t)))
  2305. (defcustom org-read-date-force-compatible-dates t
  2306. "Should date/time prompt force dates that are guaranteed to work in Emacs?
  2307. Depending on the system Emacs is running on, certain dates cannot
  2308. be represented with the type used internally to represent time.
  2309. Dates between 1970-1-1 and 2038-1-1 can always be represented
  2310. correctly. Some systems allow for earlier dates, some for later,
  2311. some for both. One way to find out it to insert any date into an
  2312. Org buffer, putting the cursor on the year and hitting S-up and
  2313. S-down to test the range.
  2314. When this variable is set to t, the date/time prompt will not let
  2315. you specify dates outside the 1970-2037 range, so it is certain that
  2316. these dates will work in whatever version of Emacs you are
  2317. running, and also that you can move a file from one Emacs implementation
  2318. to another. WHenever Org is forcing the year for you, it will display
  2319. a message and beep.
  2320. When this variable is nil, Org will check if the date is
  2321. representable in the specific Emacs implementation you are using.
  2322. If not, it will force a year, usually the current year, and beep
  2323. to remind you. Currently this setting is not recommended because
  2324. the likelihood that you will open your Org files in an Emacs that
  2325. has limited date range is not negligible.
  2326. A workaround for this problem is to use diary sexp dates for time
  2327. stamps outside of this range."
  2328. :group 'org-time
  2329. :type 'boolean)
  2330. (defcustom org-read-date-display-live t
  2331. "Non-nil means display current interpretation of date prompt live.
  2332. This display will be in an overlay, in the minibuffer."
  2333. :group 'org-time
  2334. :type 'boolean)
  2335. (defcustom org-read-date-popup-calendar t
  2336. "Non-nil means pop up a calendar when prompting for a date.
  2337. In the calendar, the date can be selected with mouse-1. However, the
  2338. minibuffer will also be active, and you can simply enter the date as well.
  2339. When nil, only the minibuffer will be available."
  2340. :group 'org-time
  2341. :type 'boolean)
  2342. (if (fboundp 'defvaralias)
  2343. (defvaralias 'org-popup-calendar-for-date-prompt
  2344. 'org-read-date-popup-calendar))
  2345. (defcustom org-read-date-minibuffer-setup-hook nil
  2346. "Hook to be used to set up keys for the date/time interface.
  2347. Add key definitions to `minibuffer-local-map', which will be a temporary
  2348. copy."
  2349. :group 'org-time
  2350. :type 'hook)
  2351. (defcustom org-extend-today-until 0
  2352. "The hour when your day really ends. Must be an integer.
  2353. This has influence for the following applications:
  2354. - When switching the agenda to \"today\". It it is still earlier than
  2355. the time given here, the day recognized as TODAY is actually yesterday.
  2356. - When a date is read from the user and it is still before the time given
  2357. here, the current date and time will be assumed to be yesterday, 23:59.
  2358. Also, timestamps inserted in remember templates follow this rule.
  2359. IMPORTANT: This is a feature whose implementation is and likely will
  2360. remain incomplete. Really, it is only here because past midnight seems to
  2361. be the favorite working time of John Wiegley :-)"
  2362. :group 'org-time
  2363. :type 'integer)
  2364. (defcustom org-edit-timestamp-down-means-later nil
  2365. "Non-nil means S-down will increase the time in a time stamp.
  2366. When nil, S-up will increase."
  2367. :group 'org-time
  2368. :type 'boolean)
  2369. (defcustom org-calendar-follow-timestamp-change t
  2370. "Non-nil means make the calendar window follow timestamp changes.
  2371. When a timestamp is modified and the calendar window is visible, it will be
  2372. moved to the new date."
  2373. :group 'org-time
  2374. :type 'boolean)
  2375. (defgroup org-tags nil
  2376. "Options concerning tags in Org-mode."
  2377. :tag "Org Tags"
  2378. :group 'org)
  2379. (defcustom org-tag-alist nil
  2380. "List of tags allowed in Org-mode files.
  2381. When this list is nil, Org-mode will base TAG input on what is already in the
  2382. buffer.
  2383. The value of this variable is an alist, the car of each entry must be a
  2384. keyword as a string, the cdr may be a character that is used to select
  2385. that tag through the fast-tag-selection interface.
  2386. See the manual for details."
  2387. :group 'org-tags
  2388. :type '(repeat
  2389. (choice
  2390. (cons (string :tag "Tag name")
  2391. (character :tag "Access char"))
  2392. (list :tag "Start radio group"
  2393. (const :startgroup)
  2394. (option (string :tag "Group description")))
  2395. (list :tag "End radio group"
  2396. (const :endgroup)
  2397. (option (string :tag "Group description")))
  2398. (const :tag "New line" (:newline)))))
  2399. (defcustom org-tag-persistent-alist nil
  2400. "List of tags that will always appear in all Org-mode files.
  2401. This is in addition to any in buffer settings or customizations
  2402. of `org-tag-alist'.
  2403. When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
  2404. The value of this variable is an alist, the car of each entry must be a
  2405. keyword as a string, the cdr may be a character that is used to select
  2406. that tag through the fast-tag-selection interface.
  2407. See the manual for details.
  2408. To disable these tags on a per-file basis, insert anywhere in the file:
  2409. #+STARTUP: noptag"
  2410. :group 'org-tags
  2411. :type '(repeat
  2412. (choice
  2413. (cons (string :tag "Tag name")
  2414. (character :tag "Access char"))
  2415. (const :tag "Start radio group" (:startgroup))
  2416. (const :tag "End radio group" (:endgroup))
  2417. (const :tag "New line" (:newline)))))
  2418. (defcustom org-complete-tags-always-offer-all-agenda-tags nil
  2419. "If non-nil, always offer completion for all tags of all agenda files.
  2420. Instead of customizing this variable directly, you might want to
  2421. set it locally for capture buffers, because there no list of
  2422. tags in that file can be created dynamically (there are none).
  2423. (add-hook 'org-capture-mode-hook
  2424. (lambda ()
  2425. (set (make-local-variable
  2426. 'org-complete-tags-always-offer-all-agenda-tags)
  2427. t)))"
  2428. :group 'org-tags
  2429. :type 'boolean)
  2430. (defvar org-file-tags nil
  2431. "List of tags that can be inherited by all entries in the file.
  2432. The tags will be inherited if the variable `org-use-tag-inheritance'
  2433. says they should be.
  2434. This variable is populated from #+FILETAGS lines.")
  2435. (defcustom org-use-fast-tag-selection 'auto
  2436. "Non-nil means use fast tag selection scheme.
  2437. This is a special interface to select and deselect tags with single keys.
  2438. When nil, fast selection is never used.
  2439. When the symbol `auto', fast selection is used if and only if selection
  2440. characters for tags have been configured, either through the variable
  2441. `org-tag-alist' or through a #+TAGS line in the buffer.
  2442. When t, fast selection is always used and selection keys are assigned
  2443. automatically if necessary."
  2444. :group 'org-tags
  2445. :type '(choice
  2446. (const :tag "Always" t)
  2447. (const :tag "Never" nil)
  2448. (const :tag "When selection characters are configured" 'auto)))
  2449. (defcustom org-fast-tag-selection-single-key nil
  2450. "Non-nil means fast tag selection exits after first change.
  2451. When nil, you have to press RET to exit it.
  2452. During fast tag selection, you can toggle this flag with `C-c'.
  2453. This variable can also have the value `expert'. In this case, the window
  2454. displaying the tags menu is not even shown, until you press C-c again."
  2455. :group 'org-tags
  2456. :type '(choice
  2457. (const :tag "No" nil)
  2458. (const :tag "Yes" t)
  2459. (const :tag "Expert" expert)))
  2460. (defvar org-fast-tag-selection-include-todo nil
  2461. "Non-nil means fast tags selection interface will also offer TODO states.
  2462. This is an undocumented feature, you should not rely on it.")
  2463. (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
  2464. "The column to which tags should be indented in a headline.
  2465. If this number is positive, it specifies the column. If it is negative,
  2466. it means that the tags should be flushright to that column. For example,
  2467. -80 works well for a normal 80 character screen."
  2468. :group 'org-tags
  2469. :type 'integer)
  2470. (defcustom org-auto-align-tags t
  2471. "Non-nil means realign tags after pro/demotion of TODO state change.
  2472. These operations change the length of a headline and therefore shift
  2473. the tags around. With this options turned on, after each such operation
  2474. the tags are again aligned to `org-tags-column'."
  2475. :group 'org-tags
  2476. :type 'boolean)
  2477. (defcustom org-use-tag-inheritance t
  2478. "Non-nil means tags in levels apply also for sublevels.
  2479. When nil, only the tags directly given in a specific line apply there.
  2480. This may also be a list of tags that should be inherited, or a regexp that
  2481. matches tags that should be inherited. Additional control is possible
  2482. with the variable `org-tags-exclude-from-inheritance' which gives an
  2483. explicit list of tags to be excluded from inheritance., even if the value of
  2484. `org-use-tag-inheritance' would select it for inheritance.
  2485. If this option is t, a match early-on in a tree can lead to a large
  2486. number of matches in the subtree when constructing the agenda or creating
  2487. a sparse tree. If you only want to see the first match in a tree during
  2488. a search, check out the variable `org-tags-match-list-sublevels'."
  2489. :group 'org-tags
  2490. :type '(choice
  2491. (const :tag "Not" nil)
  2492. (const :tag "Always" t)
  2493. (repeat :tag "Specific tags" (string :tag "Tag"))
  2494. (regexp :tag "Tags matched by regexp")))
  2495. (defcustom org-tags-exclude-from-inheritance nil
  2496. "List of tags that should never be inherited.
  2497. This is a way to exclude a few tags from inheritance. For way to do
  2498. the opposite, to actively allow inheritance for selected tags,
  2499. see the variable `org-use-tag-inheritance'."
  2500. :group 'org-tags
  2501. :type '(repeat (string :tag "Tag")))
  2502. (defun org-tag-inherit-p (tag)
  2503. "Check if TAG is one that should be inherited."
  2504. (cond
  2505. ((member tag org-tags-exclude-from-inheritance) nil)
  2506. ((eq org-use-tag-inheritance t) t)
  2507. ((not org-use-tag-inheritance) nil)
  2508. ((stringp org-use-tag-inheritance)
  2509. (string-match org-use-tag-inheritance tag))
  2510. ((listp org-use-tag-inheritance)
  2511. (member tag org-use-tag-inheritance))
  2512. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  2513. (defcustom org-tags-match-list-sublevels t
  2514. "Non-nil means list also sublevels of headlines matching a search.
  2515. This variable applies to tags/property searches, and also to stuck
  2516. projects because this search is based on a tags match as well.
  2517. When set to the symbol `indented', sublevels are indented with
  2518. leading dots.
  2519. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  2520. the sublevels of a headline matching a tag search often also match
  2521. the same search. Listing all of them can create very long lists.
  2522. Setting this variable to nil causes subtrees of a match to be skipped.
  2523. This variable is semi-obsolete and probably should always be true. It
  2524. is better to limit inheritance to certain tags using the variables
  2525. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  2526. :group 'org-tags
  2527. :type '(choice
  2528. (const :tag "No, don't list them" nil)
  2529. (const :tag "Yes, do list them" t)
  2530. (const :tag "List them, indented with leading dots" indented)))
  2531. (defcustom org-tags-sort-function nil
  2532. "When set, tags are sorted using this function as a comparator."
  2533. :group 'org-tags
  2534. :type '(choice
  2535. (const :tag "No sorting" nil)
  2536. (const :tag "Alphabetical" string<)
  2537. (const :tag "Reverse alphabetical" string>)
  2538. (function :tag "Custom function" nil)))
  2539. (defvar org-tags-history nil
  2540. "History of minibuffer reads for tags.")
  2541. (defvar org-last-tags-completion-table nil
  2542. "The last used completion table for tags.")
  2543. (defvar org-after-tags-change-hook nil
  2544. "Hook that is run after the tags in a line have changed.")
  2545. (defgroup org-properties nil
  2546. "Options concerning properties in Org-mode."
  2547. :tag "Org Properties"
  2548. :group 'org)
  2549. (defcustom org-property-format "%-10s %s"
  2550. "How property key/value pairs should be formatted by `indent-line'.
  2551. When `indent-line' hits a property definition, it will format the line
  2552. according to this format, mainly to make sure that the values are
  2553. lined-up with respect to each other."
  2554. :group 'org-properties
  2555. :type 'string)
  2556. (defcustom org-use-property-inheritance nil
  2557. "Non-nil means properties apply also for sublevels.
  2558. This setting is chiefly used during property searches. Turning it on can
  2559. cause significant overhead when doing a search, which is why it is not
  2560. on by default.
  2561. When nil, only the properties directly given in the current entry count.
  2562. When t, every property is inherited. The value may also be a list of
  2563. properties that should have inheritance, or a regular expression matching
  2564. properties that should be inherited.
  2565. However, note that some special properties use inheritance under special
  2566. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  2567. and the properties ending in \"_ALL\" when they are used as descriptor
  2568. for valid values of a property.
  2569. Note for programmers:
  2570. When querying an entry with `org-entry-get', you can control if inheritance
  2571. should be used. By default, `org-entry-get' looks only at the local
  2572. properties. You can request inheritance by setting the inherit argument
  2573. to t (to force inheritance) or to `selective' (to respect the setting
  2574. in this variable)."
  2575. :group 'org-properties
  2576. :type '(choice
  2577. (const :tag "Not" nil)
  2578. (const :tag "Always" t)
  2579. (repeat :tag "Specific properties" (string :tag "Property"))
  2580. (regexp :tag "Properties matched by regexp")))
  2581. (defun org-property-inherit-p (property)
  2582. "Check if PROPERTY is one that should be inherited."
  2583. (cond
  2584. ((eq org-use-property-inheritance t) t)
  2585. ((not org-use-property-inheritance) nil)
  2586. ((stringp org-use-property-inheritance)
  2587. (string-match org-use-property-inheritance property))
  2588. ((listp org-use-property-inheritance)
  2589. (member property org-use-property-inheritance))
  2590. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  2591. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  2592. "The default column format, if no other format has been defined.
  2593. This variable can be set on the per-file basis by inserting a line
  2594. #+COLUMNS: %25ITEM ....."
  2595. :group 'org-properties
  2596. :type 'string)
  2597. (defcustom org-columns-ellipses ".."
  2598. "The ellipses to be used when a field in column view is truncated.
  2599. When this is the empty string, as many characters as possible are shown,
  2600. but then there will be no visual indication that the field has been truncated.
  2601. When this is a string of length N, the last N characters of a truncated
  2602. field are replaced by this string. If the column is narrower than the
  2603. ellipses string, only part of the ellipses string will be shown."
  2604. :group 'org-properties
  2605. :type 'string)
  2606. (defcustom org-columns-modify-value-for-display-function nil
  2607. "Function that modifies values for display in column view.
  2608. For example, it can be used to cut out a certain part from a time stamp.
  2609. The function must take 2 arguments:
  2610. column-title The title of the column (*not* the property name)
  2611. value The value that should be modified.
  2612. The function should return the value that should be displayed,
  2613. or nil if the normal value should be used."
  2614. :group 'org-properties
  2615. :type 'function)
  2616. (defcustom org-effort-property "Effort"
  2617. "The property that is being used to keep track of effort estimates.
  2618. Effort estimates given in this property need to have the format H:MM."
  2619. :group 'org-properties
  2620. :group 'org-progress
  2621. :type '(string :tag "Property"))
  2622. (defconst org-global-properties-fixed
  2623. '(("VISIBILITY_ALL" . "folded children content all")
  2624. ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
  2625. "List of property/value pairs that can be inherited by any entry.
  2626. These are fixed values, for the preset properties. The user variable
  2627. that can be used to add to this list is `org-global-properties'.
  2628. The entries in this list are cons cells where the car is a property
  2629. name and cdr is a string with the value. If the value represents
  2630. multiple items like an \"_ALL\" property, separate the items by
  2631. spaces.")
  2632. (defcustom org-global-properties nil
  2633. "List of property/value pairs that can be inherited by any entry.
  2634. This list will be combined with the constant `org-global-properties-fixed'.
  2635. The entries in this list are cons cells where the car is a property
  2636. name and cdr is a string with the value.
  2637. You can set buffer-local values for the same purpose in the variable
  2638. `org-file-properties' this by adding lines like
  2639. #+PROPERTY: NAME VALUE"
  2640. :group 'org-properties
  2641. :type '(repeat
  2642. (cons (string :tag "Property")
  2643. (string :tag "Value"))))
  2644. (defvar org-file-properties nil
  2645. "List of property/value pairs that can be inherited by any entry.
  2646. Valid for the current buffer.
  2647. This variable is populated from #+PROPERTY lines.")
  2648. (make-variable-buffer-local 'org-file-properties)
  2649. (defgroup org-agenda nil
  2650. "Options concerning agenda views in Org-mode."
  2651. :tag "Org Agenda"
  2652. :group 'org)
  2653. (defvar org-category nil
  2654. "Variable used by org files to set a category for agenda display.
  2655. Such files should use a file variable to set it, for example
  2656. # -*- mode: org; org-category: \"ELisp\"
  2657. or contain a special line
  2658. #+CATEGORY: ELisp
  2659. If the file does not specify a category, then file's base name
  2660. is used instead.")
  2661. (make-variable-buffer-local 'org-category)
  2662. (put 'org-category 'safe-local-variable '(lambda (x) (or (symbolp x) (stringp x))))
  2663. (defcustom org-agenda-files nil
  2664. "The files to be used for agenda display.
  2665. Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
  2666. \\[org-remove-file]. You can also use customize to edit the list.
  2667. If an entry is a directory, all files in that directory that are matched by
  2668. `org-agenda-file-regexp' will be part of the file list.
  2669. If the value of the variable is not a list but a single file name, then
  2670. the list of agenda files is actually stored and maintained in that file, one
  2671. agenda file per line. In this file paths can be given relative to
  2672. `org-directory'. Tilde expansion and environment variable substitution
  2673. are also made."
  2674. :group 'org-agenda
  2675. :type '(choice
  2676. (repeat :tag "List of files and directories" file)
  2677. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  2678. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  2679. "Regular expression to match files for `org-agenda-files'.
  2680. If any element in the list in that variable contains a directory instead
  2681. of a normal file, all files in that directory that are matched by this
  2682. regular expression will be included."
  2683. :group 'org-agenda
  2684. :type 'regexp)
  2685. (defcustom org-agenda-text-search-extra-files nil
  2686. "List of extra files to be searched by text search commands.
  2687. These files will be search in addition to the agenda files by the
  2688. commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
  2689. Note that these files will only be searched for text search commands,
  2690. not for the other agenda views like todo lists, tag searches or the weekly
  2691. agenda. This variable is intended to list notes and possibly archive files
  2692. that should also be searched by these two commands.
  2693. In fact, if the first element in the list is the symbol `agenda-archives',
  2694. than all archive files of all agenda files will be added to the search
  2695. scope."
  2696. :group 'org-agenda
  2697. :type '(set :greedy t
  2698. (const :tag "Agenda Archives" agenda-archives)
  2699. (repeat :inline t (file))))
  2700. (if (fboundp 'defvaralias)
  2701. (defvaralias 'org-agenda-multi-occur-extra-files
  2702. 'org-agenda-text-search-extra-files))
  2703. (defcustom org-agenda-skip-unavailable-files nil
  2704. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  2705. A nil value means to remove them, after a query, from the list."
  2706. :group 'org-agenda
  2707. :type 'boolean)
  2708. (defcustom org-calendar-to-agenda-key [?c]
  2709. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  2710. The command `org-calendar-goto-agenda' will be bound to this key. The
  2711. default is the character `c' because then `c' can be used to switch back and
  2712. forth between agenda and calendar."
  2713. :group 'org-agenda
  2714. :type 'sexp)
  2715. (defcustom org-calendar-agenda-action-key [?k]
  2716. "The key to be installed in `calendar-mode-map' for agenda-action.
  2717. The command `org-agenda-action' will be bound to this key. The
  2718. default is the character `k' because we use the same key in the agenda."
  2719. :group 'org-agenda
  2720. :type 'sexp)
  2721. (defcustom org-calendar-insert-diary-entry-key [?i]
  2722. "The key to be installed in `calendar-mode-map' for adding diary entries.
  2723. This option is irrelevant until `org-agenda-diary-file' has been configured
  2724. to point to an Org-mode file. When that is the case, the command
  2725. `org-agenda-diary-entry' will be bound to the key given here, by default
  2726. `i'. In the calendar, `i' normally adds entries to `diary-file'. So
  2727. if you want to continue doing this, you need to change this to a different
  2728. key."
  2729. :group 'org-agenda
  2730. :type 'sexp)
  2731. (defcustom org-agenda-diary-file 'diary-file
  2732. "File to which to add new entries with the `i' key in agenda and calendar.
  2733. When this is the symbol `diary-file', the functionality in the Emacs
  2734. calendar will be used to add entries to the `diary-file'. But when this
  2735. points to a file, `org-agenda-diary-entry' will be used instead."
  2736. :group 'org-agenda
  2737. :type '(choice
  2738. (const :tag "The standard Emacs diary file" diary-file)
  2739. (file :tag "Special Org file diary entries")))
  2740. (eval-after-load "calendar"
  2741. '(progn
  2742. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  2743. 'org-calendar-goto-agenda)
  2744. (org-defkey calendar-mode-map org-calendar-agenda-action-key
  2745. 'org-agenda-action)
  2746. (add-hook 'calendar-mode-hook
  2747. (lambda ()
  2748. (unless (eq org-agenda-diary-file 'diary-file)
  2749. (define-key calendar-mode-map
  2750. org-calendar-insert-diary-entry-key
  2751. 'org-agenda-diary-entry))))))
  2752. (defgroup org-latex nil
  2753. "Options for embedding LaTeX code into Org-mode."
  2754. :tag "Org LaTeX"
  2755. :group 'org)
  2756. (defcustom org-format-latex-options
  2757. '(:foreground default :background default :scale 1.0
  2758. :html-foreground "Black" :html-background "Transparent"
  2759. :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
  2760. "Options for creating images from LaTeX fragments.
  2761. This is a property list with the following properties:
  2762. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  2763. `default' means use the foreground of the default face.
  2764. :background the background color, or \"Transparent\".
  2765. `default' means use the background of the default face.
  2766. :scale a scaling factor for the size of the images, to get more pixels
  2767. :html-foreground, :html-background, :html-scale
  2768. the same numbers for HTML export.
  2769. :matchers a list indicating which matchers should be used to
  2770. find LaTeX fragments. Valid members of this list are:
  2771. \"begin\" find environments
  2772. \"$1\" find single characters surrounded by $.$
  2773. \"$\" find math expressions surrounded by $...$
  2774. \"$$\" find math expressions surrounded by $$....$$
  2775. \"\\(\" find math expressions surrounded by \\(...\\)
  2776. \"\\ [\" find math expressions surrounded by \\ [...\\]"
  2777. :group 'org-latex
  2778. :type 'plist)
  2779. (defcustom org-format-latex-signal-error t
  2780. "Non-nil means signal an error when image creation of LaTeX snippets fails.
  2781. When nil, just push out a message."
  2782. :group 'org-latex
  2783. :type 'boolean)
  2784. (defcustom org-format-latex-header "\\documentclass{article}
  2785. \\usepackage[usenames]{color}
  2786. \\usepackage{amsmath}
  2787. \\usepackage[mathscr]{eucal}
  2788. \\pagestyle{empty} % do not remove
  2789. \[PACKAGES]
  2790. \[DEFAULT-PACKAGES]
  2791. % The settings below are copied from fullpage.sty
  2792. \\setlength{\\textwidth}{\\paperwidth}
  2793. \\addtolength{\\textwidth}{-3cm}
  2794. \\setlength{\\oddsidemargin}{1.5cm}
  2795. \\addtolength{\\oddsidemargin}{-2.54cm}
  2796. \\setlength{\\evensidemargin}{\\oddsidemargin}
  2797. \\setlength{\\textheight}{\\paperheight}
  2798. \\addtolength{\\textheight}{-\\headheight}
  2799. \\addtolength{\\textheight}{-\\headsep}
  2800. \\addtolength{\\textheight}{-\\footskip}
  2801. \\addtolength{\\textheight}{-3cm}
  2802. \\setlength{\\topmargin}{1.5cm}
  2803. \\addtolength{\\topmargin}{-2.54cm}"
  2804. "The document header used for processing LaTeX fragments.
  2805. It is imperative that this header make sure that no page number
  2806. appears on the page. The package defined in the variables
  2807. `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
  2808. will either replace the placeholder \"[PACKAGES]\" in this header, or they
  2809. will be appended."
  2810. :group 'org-latex
  2811. :type 'string)
  2812. (defvar org-format-latex-header-extra nil)
  2813. (defun org-set-packages-alist (var val)
  2814. "Set the packages alist and make sure it has 3 elements per entry."
  2815. (set var (mapcar (lambda (x)
  2816. (if (and (consp x) (= (length x) 2))
  2817. (list (car x) (nth 1 x) t)
  2818. x))
  2819. val)))
  2820. (defun org-get-packages-alist (var)
  2821. "Get the packages alist and make sure it has 3 elements per entry."
  2822. (mapcar (lambda (x)
  2823. (if (and (consp x) (= (length x) 2))
  2824. (list (car x) (nth 1 x) t)
  2825. x))
  2826. (default-value var)))
  2827. ;; The following variables are defined here because is it also used
  2828. ;; when formatting latex fragments. Originally it was part of the
  2829. ;; LaTeX exporter, which is why the name includes "export".
  2830. (defcustom org-export-latex-default-packages-alist
  2831. '(("AUTO" "inputenc" t)
  2832. ("T1" "fontenc" t)
  2833. ("" "fixltx2e" nil)
  2834. ("" "graphicx" t)
  2835. ("" "longtable" nil)
  2836. ("" "float" nil)
  2837. ("" "wrapfig" nil)
  2838. ("" "soul" t)
  2839. ("" "textcomp" t)
  2840. ("" "marvosym" t)
  2841. ("" "wasysym" t)
  2842. ("" "latexsym" t)
  2843. ("" "amssymb" t)
  2844. ("" "hyperref" nil)
  2845. "\\tolerance=1000"
  2846. )
  2847. "Alist of default packages to be inserted in the header.
  2848. Change this only if one of the packages here causes an incompatibility
  2849. with another package you are using.
  2850. The packages in this list are needed by one part or another of Org-mode
  2851. to function properly.
  2852. - inputenc, fontenc: for basic font and character selection
  2853. - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
  2854. for interpreting the entities in `org-entities'. You can skip some of these
  2855. packages if you don't use any of the symbols in it.
  2856. - graphicx: for including images
  2857. - float, wrapfig: for figure placement
  2858. - longtable: for long tables
  2859. - hyperref: for cross references
  2860. Therefore you should not modify this variable unless you know what you
  2861. are doing. The one reason to change it anyway is that you might be loading
  2862. some other package that conflicts with one of the default packages.
  2863. Each cell is of the format \( \"options\" \"package\" snippet-flag\).
  2864. If SNIPPET-FLAG is t, the package also needs to be included when
  2865. compiling LaTeX snippets into images for inclusion into HTML."
  2866. :group 'org-export-latex
  2867. :set 'org-set-packages-alist
  2868. :get 'org-get-packages-alist
  2869. :type '(repeat
  2870. (choice
  2871. (list :tag "options/package pair"
  2872. (string :tag "options")
  2873. (string :tag "package")
  2874. (boolean :tag "Snippet"))
  2875. (string :tag "A line of LaTeX"))))
  2876. (defcustom org-export-latex-packages-alist nil
  2877. "Alist of packages to be inserted in every LaTeX header.
  2878. These will be inserted after `org-export-latex-default-packages-alist'.
  2879. Each cell is of the format \( \"options\" \"package\" snippet-flag \).
  2880. SNIPPET-FLAG, when t, indicates that this package is also needed when
  2881. turning LaTeX snippets into images for inclusion into HTML.
  2882. Make sure that you only list packages here which:
  2883. - you want in every file
  2884. - do not conflict with the default packages in
  2885. `org-export-latex-default-packages-alist'
  2886. - do not conflict with the setup in `org-format-latex-header'."
  2887. :group 'org-export-latex
  2888. :set 'org-set-packages-alist
  2889. :get 'org-get-packages-alist
  2890. :type '(repeat
  2891. (choice
  2892. (list :tag "options/package pair"
  2893. (string :tag "options")
  2894. (string :tag "package")
  2895. (boolean :tag "Snippet"))
  2896. (string :tag "A line of LaTeX"))))
  2897. (defgroup org-appearance nil
  2898. "Settings for Org-mode appearance."
  2899. :tag "Org Appearance"
  2900. :group 'org)
  2901. (defcustom org-level-color-stars-only nil
  2902. "Non-nil means fontify only the stars in each headline.
  2903. When nil, the entire headline is fontified.
  2904. Changing it requires restart of `font-lock-mode' to become effective
  2905. also in regions already fontified."
  2906. :group 'org-appearance
  2907. :type 'boolean)
  2908. (defcustom org-hide-leading-stars nil
  2909. "Non-nil means hide the first N-1 stars in a headline.
  2910. This works by using the face `org-hide' for these stars. This
  2911. face is white for a light background, and black for a dark
  2912. background. You may have to customize the face `org-hide' to
  2913. make this work.
  2914. Changing it requires restart of `font-lock-mode' to become effective
  2915. also in regions already fontified.
  2916. You may also set this on a per-file basis by adding one of the following
  2917. lines to the buffer:
  2918. #+STARTUP: hidestars
  2919. #+STARTUP: showstars"
  2920. :group 'org-appearance
  2921. :type 'boolean)
  2922. (defcustom org-hidden-keywords nil
  2923. "List of symbols corresponding to keywords to be hidden the org buffer.
  2924. For example, a value '(title) for this list will make the document's title
  2925. appear in the buffer without the initial #+TITLE: keyword."
  2926. :group 'org-appearance
  2927. :type '(set (const :tag "#+AUTHOR" author)
  2928. (const :tag "#+DATE" date)
  2929. (const :tag "#+EMAIL" email)
  2930. (const :tag "#+TITLE" title)))
  2931. (defcustom org-fontify-done-headline nil
  2932. "Non-nil means change the face of a headline if it is marked DONE.
  2933. Normally, only the TODO/DONE keyword indicates the state of a headline.
  2934. When this is non-nil, the headline after the keyword is set to the
  2935. `org-headline-done' as an additional indication."
  2936. :group 'org-appearance
  2937. :type 'boolean)
  2938. (defcustom org-fontify-emphasized-text t
  2939. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  2940. Changing this variable requires a restart of Emacs to take effect."
  2941. :group 'org-appearance
  2942. :type 'boolean)
  2943. (defcustom org-fontify-whole-heading-line nil
  2944. "Non-nil means fontify the whole line for headings.
  2945. This is useful when setting a background color for the
  2946. org-level-* faces."
  2947. :group 'org-appearance
  2948. :type 'boolean)
  2949. (defcustom org-highlight-latex-fragments-and-specials nil
  2950. "Non-nil means fontify what is treated specially by the exporters."
  2951. :group 'org-appearance
  2952. :type 'boolean)
  2953. (defcustom org-hide-emphasis-markers nil
  2954. "Non-nil mean font-lock should hide the emphasis marker characters."
  2955. :group 'org-appearance
  2956. :type 'boolean)
  2957. (defcustom org-pretty-entities nil
  2958. "Non-nil means show entities as UTF8 characters.
  2959. When nil, the \\name form remains in the buffer."
  2960. :group 'org-appearance
  2961. :type 'boolean)
  2962. (defcustom org-pretty-entities-include-sub-superscripts t
  2963. "Non-nil means, pretty entity display includes formatting sub/superscripts."
  2964. :group 'org-appearance
  2965. :type 'boolean)
  2966. (defvar org-emph-re nil
  2967. "Regular expression for matching emphasis.
  2968. After a match, the match groups contain these elements:
  2969. 0 The match of the full regular expression, including the characters
  2970. before and after the proper match
  2971. 1 The character before the proper match, or empty at beginning of line
  2972. 2 The proper match, including the leading and trailing markers
  2973. 3 The leading marker like * or /, indicating the type of highlighting
  2974. 4 The text between the emphasis markers, not including the markers
  2975. 5 The character after the match, empty at the end of a line")
  2976. (defvar org-verbatim-re nil
  2977. "Regular expression for matching verbatim text.")
  2978. (defvar org-emphasis-regexp-components) ; defined just below
  2979. (defvar org-emphasis-alist) ; defined just below
  2980. (defun org-set-emph-re (var val)
  2981. "Set variable and compute the emphasis regular expression."
  2982. (set var val)
  2983. (when (and (boundp 'org-emphasis-alist)
  2984. (boundp 'org-emphasis-regexp-components)
  2985. org-emphasis-alist org-emphasis-regexp-components)
  2986. (let* ((e org-emphasis-regexp-components)
  2987. (pre (car e))
  2988. (post (nth 1 e))
  2989. (border (nth 2 e))
  2990. (body (nth 3 e))
  2991. (nl (nth 4 e))
  2992. (body1 (concat body "*?"))
  2993. (markers (mapconcat 'car org-emphasis-alist ""))
  2994. (vmarkers (mapconcat
  2995. (lambda (x) (if (eq (nth 4 x) 'verbatim) (car x) ""))
  2996. org-emphasis-alist "")))
  2997. ;; make sure special characters appear at the right position in the class
  2998. (if (string-match "\\^" markers)
  2999. (setq markers (concat (replace-match "" t t markers) "^")))
  3000. (if (string-match "-" markers)
  3001. (setq markers (concat (replace-match "" t t markers) "-")))
  3002. (if (string-match "\\^" vmarkers)
  3003. (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
  3004. (if (string-match "-" vmarkers)
  3005. (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
  3006. (if (> nl 0)
  3007. (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
  3008. (int-to-string nl) "\\}")))
  3009. ;; Make the regexp
  3010. (setq org-emph-re
  3011. (concat "\\([" pre "]\\|^\\)"
  3012. "\\("
  3013. "\\([" markers "]\\)"
  3014. "\\("
  3015. "[^" border "]\\|"
  3016. "[^" border "]"
  3017. body1
  3018. "[^" border "]"
  3019. "\\)"
  3020. "\\3\\)"
  3021. "\\([" post "]\\|$\\)"))
  3022. (setq org-verbatim-re
  3023. (concat "\\([" pre "]\\|^\\)"
  3024. "\\("
  3025. "\\([" vmarkers "]\\)"
  3026. "\\("
  3027. "[^" border "]\\|"
  3028. "[^" border "]"
  3029. body1
  3030. "[^" border "]"
  3031. "\\)"
  3032. "\\3\\)"
  3033. "\\([" post "]\\|$\\)")))))
  3034. (defcustom org-emphasis-regexp-components
  3035. '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
  3036. "Components used to build the regular expression for emphasis.
  3037. This is a list with five entries. Terminology: In an emphasis string
  3038. like \" *strong word* \", we call the initial space PREMATCH, the final
  3039. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  3040. and \"trong wor\" is the body. The different components in this variable
  3041. specify what is allowed/forbidden in each part:
  3042. pre Chars allowed as prematch. Beginning of line will be allowed too.
  3043. post Chars allowed as postmatch. End of line will be allowed too.
  3044. border The chars *forbidden* as border characters.
  3045. body-regexp A regexp like \".\" to match a body character. Don't use
  3046. non-shy groups here, and don't allow newline here.
  3047. newline The maximum number of newlines allowed in an emphasis exp.
  3048. Use customize to modify this, or restart Emacs after changing it."
  3049. :group 'org-appearance
  3050. :set 'org-set-emph-re
  3051. :type '(list
  3052. (sexp :tag "Allowed chars in pre ")
  3053. (sexp :tag "Allowed chars in post ")
  3054. (sexp :tag "Forbidden chars in border ")
  3055. (sexp :tag "Regexp for body ")
  3056. (integer :tag "number of newlines allowed")
  3057. (option (boolean :tag "Please ignore this button"))))
  3058. (defcustom org-emphasis-alist
  3059. `(("*" bold "<b>" "</b>")
  3060. ("/" italic "<i>" "</i>")
  3061. ("_" underline "<span style=\"text-decoration:underline;\">" "</span>")
  3062. ("=" org-code "<code>" "</code>" verbatim)
  3063. ("~" org-verbatim "<code>" "</code>" verbatim)
  3064. ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))
  3065. "<del>" "</del>")
  3066. )
  3067. "Special syntax for emphasized text.
  3068. Text starting and ending with a special character will be emphasized, for
  3069. example *bold*, _underlined_ and /italic/. This variable sets the marker
  3070. characters, the face to be used by font-lock for highlighting in Org-mode
  3071. Emacs buffers, and the HTML tags to be used for this.
  3072. For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
  3073. For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
  3074. Use customize to modify this, or restart Emacs after changing it."
  3075. :group 'org-appearance
  3076. :set 'org-set-emph-re
  3077. :type '(repeat
  3078. (list
  3079. (string :tag "Marker character")
  3080. (choice
  3081. (face :tag "Font-lock-face")
  3082. (plist :tag "Face property list"))
  3083. (string :tag "HTML start tag")
  3084. (string :tag "HTML end tag")
  3085. (option (const verbatim)))))
  3086. (defvar org-protecting-blocks
  3087. '("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")
  3088. "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
  3089. This is needed for font-lock setup.")
  3090. ;;; Miscellaneous options
  3091. (defgroup org-completion nil
  3092. "Completion in Org-mode."
  3093. :tag "Org Completion"
  3094. :group 'org)
  3095. (defcustom org-completion-use-ido nil
  3096. "Non-nil means use ido completion wherever possible.
  3097. Note that `ido-mode' must be active for this variable to be relevant.
  3098. If you decide to turn this variable on, you might well want to turn off
  3099. `org-outline-path-complete-in-steps'.
  3100. See also `org-completion-use-iswitchb'."
  3101. :group 'org-completion
  3102. :type 'boolean)
  3103. (defcustom org-completion-use-iswitchb nil
  3104. "Non-nil means use iswitchb completion wherever possible.
  3105. Note that `iswitchb-mode' must be active for this variable to be relevant.
  3106. If you decide to turn this variable on, you might well want to turn off
  3107. `org-outline-path-complete-in-steps'.
  3108. Note that this variable has only an effect if `org-completion-use-ido' is nil."
  3109. :group 'org-completion
  3110. :type 'boolean)
  3111. (defcustom org-completion-fallback-command 'hippie-expand
  3112. "The expansion command called by \\[pcomplete] in normal context.
  3113. Normal means, no org-mode-specific context."
  3114. :group 'org-completion
  3115. :type 'function)
  3116. ;;; Functions and variables from their packages
  3117. ;; Declared here to avoid compiler warnings
  3118. ;; XEmacs only
  3119. (defvar outline-mode-menu-heading)
  3120. (defvar outline-mode-menu-show)
  3121. (defvar outline-mode-menu-hide)
  3122. (defvar zmacs-regions) ; XEmacs regions
  3123. ;; Emacs only
  3124. (defvar mark-active)
  3125. ;; Various packages
  3126. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  3127. (declare-function calendar-forward-day "cal-move" (arg))
  3128. (declare-function calendar-goto-date "cal-move" (date))
  3129. (declare-function calendar-goto-today "cal-move" ())
  3130. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  3131. (defvar calc-embedded-close-formula)
  3132. (defvar calc-embedded-open-formula)
  3133. (declare-function cdlatex-tab "ext:cdlatex" ())
  3134. (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
  3135. (defvar font-lock-unfontify-region-function)
  3136. (declare-function iswitchb-read-buffer "iswitchb"
  3137. (prompt &optional default require-match start matches-set))
  3138. (defvar iswitchb-temp-buflist)
  3139. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  3140. (defvar org-agenda-tags-todo-honor-ignore-options)
  3141. (declare-function org-agenda-skip "org-agenda" ())
  3142. (declare-function
  3143. org-format-agenda-item "org-agenda"
  3144. (extra txt &optional category tags dotime noprefix remove-re habitp))
  3145. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  3146. (declare-function org-agenda-change-all-lines "org-agenda"
  3147. (newhead hdmarker &optional fixface just-this))
  3148. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  3149. (declare-function org-agenda-maybe-redo "org-agenda" ())
  3150. (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
  3151. (beg end))
  3152. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  3153. (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  3154. "org-agenda" (&optional end))
  3155. (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  3156. (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
  3157. (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
  3158. (declare-function org-inlinetask-goto-end "org-inlinetask" ())
  3159. (declare-function org-indent-mode "org-indent" (&optional arg))
  3160. (declare-function parse-time-string "parse-time" (string))
  3161. (declare-function org-attach-reveal "org-attach" (&optional if-exists))
  3162. (declare-function org-export-latex-fix-inputenc "org-latex" ())
  3163. (declare-function orgtbl-send-table "org-table" (&optional maybe))
  3164. (defvar remember-data-file)
  3165. (defvar texmathp-why)
  3166. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  3167. (declare-function table--at-cell-p "table" (position &optional object at-column))
  3168. (defvar w3m-current-url)
  3169. (defvar w3m-current-title)
  3170. (defvar org-latex-regexps)
  3171. ;;; Autoload and prepare some org modules
  3172. ;; Some table stuff that needs to be defined here, because it is used
  3173. ;; by the functions setting up org-mode or checking for table context.
  3174. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  3175. "Detect an org-type or table-type table.")
  3176. (defconst org-table-line-regexp "^[ \t]*|"
  3177. "Detect an org-type table line.")
  3178. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  3179. "Detect an org-type table line.")
  3180. (defconst org-table-hline-regexp "^[ \t]*|-"
  3181. "Detect an org-type table hline.")
  3182. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  3183. "Detect a table-type table hline.")
  3184. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  3185. "Detect the first line outside a table when searching from within it.
  3186. This works for both table types.")
  3187. ;; Autoload the functions in org-table.el that are needed by functions here.
  3188. (eval-and-compile
  3189. (org-autoload "org-table"
  3190. '(org-table-align org-table-begin org-table-blank-field
  3191. org-table-convert org-table-convert-region org-table-copy-down
  3192. org-table-copy-region org-table-create
  3193. org-table-create-or-convert-from-region
  3194. org-table-create-with-table.el org-table-current-dline
  3195. org-table-cut-region org-table-delete-column org-table-edit-field
  3196. org-table-edit-formulas org-table-end org-table-eval-formula
  3197. org-table-export org-table-field-info
  3198. org-table-get-stored-formulas org-table-goto-column
  3199. org-table-hline-and-move org-table-import org-table-insert-column
  3200. org-table-insert-hline org-table-insert-row org-table-iterate
  3201. org-table-justify-field-maybe org-table-kill-row
  3202. org-table-maybe-eval-formula org-table-maybe-recalculate-line
  3203. org-table-move-column org-table-move-column-left
  3204. org-table-move-column-right org-table-move-row
  3205. org-table-move-row-down org-table-move-row-up
  3206. org-table-next-field org-table-next-row org-table-paste-rectangle
  3207. org-table-previous-field org-table-recalculate
  3208. org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
  3209. org-table-toggle-coordinate-overlays
  3210. org-table-toggle-formula-debugger org-table-wrap-region
  3211. orgtbl-mode turn-on-orgtbl org-table-to-lisp
  3212. orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
  3213. orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
  3214. (defun org-at-table-p (&optional table-type)
  3215. "Return t if the cursor is inside an org-type table.
  3216. If TABLE-TYPE is non-nil, also check for table.el-type tables."
  3217. (if org-enable-table-editor
  3218. (save-excursion
  3219. (beginning-of-line 1)
  3220. (looking-at (if table-type org-table-any-line-regexp
  3221. org-table-line-regexp)))
  3222. nil))
  3223. (defsubst org-table-p () (org-at-table-p))
  3224. (defun org-at-table.el-p ()
  3225. "Return t if and only if we are at a table.el table."
  3226. (and (org-at-table-p 'any)
  3227. (save-excursion
  3228. (goto-char (org-table-begin 'any))
  3229. (looking-at org-table1-hline-regexp))))
  3230. (defun org-table-recognize-table.el ()
  3231. "If there is a table.el table nearby, recognize it and move into it."
  3232. (if org-table-tab-recognizes-table.el
  3233. (if (org-at-table.el-p)
  3234. (progn
  3235. (beginning-of-line 1)
  3236. (if (looking-at org-table-dataline-regexp)
  3237. nil
  3238. (if (looking-at org-table1-hline-regexp)
  3239. (progn
  3240. (beginning-of-line 2)
  3241. (if (looking-at org-table-any-border-regexp)
  3242. (beginning-of-line -1)))))
  3243. (if (re-search-forward "|" (org-table-end t) t)
  3244. (progn
  3245. (require 'table)
  3246. (if (table--at-cell-p (point))
  3247. t
  3248. (message "recognizing table.el table...")
  3249. (table-recognize-table)
  3250. (message "recognizing table.el table...done")))
  3251. (error "This should not happen"))
  3252. t)
  3253. nil)
  3254. nil))
  3255. (defun org-at-table-hline-p ()
  3256. "Return t if the cursor is inside a hline in a table."
  3257. (if org-enable-table-editor
  3258. (save-excursion
  3259. (beginning-of-line 1)
  3260. (looking-at org-table-hline-regexp))
  3261. nil))
  3262. (defvar org-table-clean-did-remove-column nil)
  3263. (defun org-table-map-tables (function &optional quietly)
  3264. "Apply FUNCTION to the start of all tables in the buffer."
  3265. (save-excursion
  3266. (save-restriction
  3267. (widen)
  3268. (goto-char (point-min))
  3269. (while (re-search-forward org-table-any-line-regexp nil t)
  3270. (unless quietly
  3271. (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
  3272. (beginning-of-line 1)
  3273. (when (looking-at org-table-line-regexp)
  3274. (save-excursion (funcall function))
  3275. (or (looking-at org-table-line-regexp)
  3276. (forward-char 1)))
  3277. (re-search-forward org-table-any-border-regexp nil 1))))
  3278. (unless quietly (message "Mapping tables: done")))
  3279. ;; Declare and autoload functions from org-exp.el & Co
  3280. (declare-function org-default-export-plist "org-exp")
  3281. (declare-function org-infile-export-plist "org-exp")
  3282. (declare-function org-get-current-options "org-exp")
  3283. (eval-and-compile
  3284. (org-autoload "org-exp"
  3285. '(org-export org-export-visible
  3286. org-insert-export-options-template
  3287. org-table-clean-before-export))
  3288. (org-autoload "org-ascii"
  3289. '(org-export-as-ascii org-export-ascii-preprocess
  3290. org-export-as-ascii-to-buffer org-replace-region-by-ascii
  3291. org-export-region-as-ascii))
  3292. (org-autoload "org-latex"
  3293. '(org-export-as-latex-batch org-export-as-latex-to-buffer
  3294. org-replace-region-by-latex org-export-region-as-latex
  3295. org-export-as-latex org-export-as-pdf
  3296. org-export-as-pdf-and-open))
  3297. (org-autoload "org-html"
  3298. '(org-export-as-html-and-open
  3299. org-export-as-html-batch org-export-as-html-to-buffer
  3300. org-replace-region-by-html org-export-region-as-html
  3301. org-export-as-html))
  3302. (org-autoload "org-docbook"
  3303. '(org-export-as-docbook-batch org-export-as-docbook-to-buffer
  3304. org-replace-region-by-docbook org-export-region-as-docbook
  3305. org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
  3306. org-export-as-docbook))
  3307. (org-autoload "org-icalendar"
  3308. '(org-export-icalendar-this-file
  3309. org-export-icalendar-all-agenda-files
  3310. org-export-icalendar-combine-agenda-files))
  3311. (org-autoload "org-xoxo" '(org-export-as-xoxo))
  3312. (org-autoload "org-beamer" '(org-beamer-mode org-beamer-sectioning)))
  3313. ;; Declare and autoload functions from org-agenda.el
  3314. (eval-and-compile
  3315. (org-autoload "org-agenda"
  3316. '(org-agenda org-agenda-list org-search-view
  3317. org-todo-list org-tags-view org-agenda-list-stuck-projects
  3318. org-diary org-agenda-to-appt
  3319. org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
  3320. ;; Autoload org-remember
  3321. (eval-and-compile
  3322. (org-autoload "org-remember"
  3323. '(org-remember-insinuate org-remember-annotation
  3324. org-remember-apply-template org-remember org-remember-handler)))
  3325. (eval-and-compile
  3326. (org-autoload "org-capture"
  3327. '(org-capture org-capture-insert-template-here
  3328. org-capture-import-remember-templates)))
  3329. ;; Autoload org-clock.el
  3330. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock"
  3331. (beg end))
  3332. (declare-function org-clock-update-mode-line "org-clock" ())
  3333. (declare-function org-resolve-clocks "org-clock"
  3334. (&optional also-non-dangling-p prompt last-valid))
  3335. (defvar org-clock-start-time)
  3336. (defvar org-clock-marker (make-marker)
  3337. "Marker recording the last clock-in.")
  3338. (defvar org-clock-hd-marker (make-marker)
  3339. "Marker recording the last clock-in, but the headline position.")
  3340. (defvar org-clock-heading ""
  3341. "The heading of the current clock entry.")
  3342. (defun org-clock-is-active ()
  3343. "Return non-nil if clock is currently running.
  3344. The return value is actually the clock marker."
  3345. (marker-buffer org-clock-marker))
  3346. (eval-and-compile
  3347. (org-autoload
  3348. "org-clock"
  3349. '(org-clock-in org-clock-out org-clock-cancel
  3350. org-clock-goto org-clock-sum org-clock-display
  3351. org-clock-remove-overlays org-clock-report
  3352. org-clocktable-shift org-dblock-write:clocktable
  3353. org-get-clocktable org-resolve-clocks)))
  3354. (defun org-clock-update-time-maybe ()
  3355. "If this is a CLOCK line, update it and return t.
  3356. Otherwise, return nil."
  3357. (interactive)
  3358. (save-excursion
  3359. (beginning-of-line 1)
  3360. (skip-chars-forward " \t")
  3361. (when (looking-at org-clock-string)
  3362. (let ((re (concat "[ \t]*" org-clock-string
  3363. " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
  3364. "\\([ \t]*=>.*\\)?\\)?"))
  3365. ts te h m s neg)
  3366. (cond
  3367. ((not (looking-at re))
  3368. nil)
  3369. ((not (match-end 2))
  3370. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3371. (> org-clock-marker (point))
  3372. (<= org-clock-marker (point-at-eol)))
  3373. ;; The clock is running here
  3374. (setq org-clock-start-time
  3375. (apply 'encode-time
  3376. (org-parse-time-string (match-string 1))))
  3377. (org-clock-update-mode-line)))
  3378. (t
  3379. (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
  3380. (end-of-line 1)
  3381. (setq ts (match-string 1)
  3382. te (match-string 3))
  3383. (setq s (- (org-float-time
  3384. (apply 'encode-time (org-parse-time-string te)))
  3385. (org-float-time
  3386. (apply 'encode-time (org-parse-time-string ts))))
  3387. neg (< s 0)
  3388. s (abs s)
  3389. h (floor (/ s 3600))
  3390. s (- s (* 3600 h))
  3391. m (floor (/ s 60))
  3392. s (- s (* 60 s)))
  3393. (insert " => " (format (if neg "-%d:%02d" "%2d:%02d") h m))
  3394. t))))))
  3395. (defun org-check-running-clock ()
  3396. "Check if the current buffer contains the running clock.
  3397. If yes, offer to stop it and to save the buffer with the changes."
  3398. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3399. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  3400. (buffer-name))))
  3401. (org-clock-out)
  3402. (when (y-or-n-p "Save changed buffer?")
  3403. (save-buffer))))
  3404. (defun org-clocktable-try-shift (dir n)
  3405. "Check if this line starts a clock table, if yes, shift the time block."
  3406. (when (org-match-line "#\\+BEGIN: clocktable\\>")
  3407. (org-clocktable-shift dir n)))
  3408. ;; Autoload org-timer.el
  3409. (eval-and-compile
  3410. (org-autoload
  3411. "org-timer"
  3412. '(org-timer-start org-timer org-timer-item
  3413. org-timer-change-times-in-region
  3414. org-timer-set-timer
  3415. org-timer-reset-timers
  3416. org-timer-show-remaining-time)))
  3417. ;; Autoload org-feed.el
  3418. (eval-and-compile
  3419. (org-autoload
  3420. "org-feed"
  3421. '(org-feed-update org-feed-update-all org-feed-goto-inbox)))
  3422. ;; Autoload org-indent.el
  3423. ;; Define the variable already here, to make sure we have it.
  3424. (defvar org-indent-mode nil
  3425. "Non-nil if Org-Indent mode is enabled.
  3426. Use the command `org-indent-mode' to change this variable.")
  3427. (eval-and-compile
  3428. (org-autoload
  3429. "org-indent"
  3430. '(org-indent-mode)))
  3431. ;; Autoload org-mobile.el
  3432. (eval-and-compile
  3433. (org-autoload
  3434. "org-mobile"
  3435. '(org-mobile-push org-mobile-pull org-mobile-create-sumo-agenda)))
  3436. ;; Autoload archiving code
  3437. ;; The stuff that is needed for cycling and tags has to be defined here.
  3438. (defgroup org-archive nil
  3439. "Options concerning archiving in Org-mode."
  3440. :tag "Org Archive"
  3441. :group 'org-structure)
  3442. (defcustom org-archive-location "%s_archive::"
  3443. "The location where subtrees should be archived.
  3444. The value of this variable is a string, consisting of two parts,
  3445. separated by a double-colon. The first part is a filename and
  3446. the second part is a headline.
  3447. When the filename is omitted, archiving happens in the same file.
  3448. %s in the filename will be replaced by the current file
  3449. name (without the directory part). Archiving to a different file
  3450. is useful to keep archived entries from contributing to the
  3451. Org-mode Agenda.
  3452. The archived entries will be filed as subtrees of the specified
  3453. headline. When the headline is omitted, the subtrees are simply
  3454. filed away at the end of the file, as top-level entries. Also in
  3455. the heading you can use %s to represent the file name, this can be
  3456. useful when using the same archive for a number of different files.
  3457. Here are a few examples:
  3458. \"%s_archive::\"
  3459. If the current file is Projects.org, archive in file
  3460. Projects.org_archive, as top-level trees. This is the default.
  3461. \"::* Archived Tasks\"
  3462. Archive in the current file, under the top-level headline
  3463. \"* Archived Tasks\".
  3464. \"~/org/archive.org::\"
  3465. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  3466. \"~/org/archive.org::From %s\"
  3467. Archive in file ~/org/archive.org (absolute path), under headlines
  3468. \"From FILENAME\" where file name is the current file name.
  3469. \"basement::** Finished Tasks\"
  3470. Archive in file ./basement (relative path), as level 3 trees
  3471. below the level 2 heading \"** Finished Tasks\".
  3472. You may set this option on a per-file basis by adding to the buffer a
  3473. line like
  3474. #+ARCHIVE: basement::** Finished Tasks
  3475. You may also define it locally for a subtree by setting an ARCHIVE property
  3476. in the entry. If such a property is found in an entry, or anywhere up
  3477. the hierarchy, it will be used."
  3478. :group 'org-archive
  3479. :type 'string)
  3480. (defcustom org-archive-tag "ARCHIVE"
  3481. "The tag that marks a subtree as archived.
  3482. An archived subtree does not open during visibility cycling, and does
  3483. not contribute to the agenda listings.
  3484. After changing this, font-lock must be restarted in the relevant buffers to
  3485. get the proper fontification."
  3486. :group 'org-archive
  3487. :group 'org-keywords
  3488. :type 'string)
  3489. (defcustom org-agenda-skip-archived-trees t
  3490. "Non-nil means the agenda will skip any items located in archived trees.
  3491. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  3492. variable is no longer recommended, you should leave it at the value t.
  3493. Instead, use the key `v' to cycle the archives-mode in the agenda."
  3494. :group 'org-archive
  3495. :group 'org-agenda-skip
  3496. :type 'boolean)
  3497. (defcustom org-columns-skip-archived-trees t
  3498. "Non-nil means ignore archived trees when creating column view."
  3499. :group 'org-archive
  3500. :group 'org-properties
  3501. :type 'boolean)
  3502. (defcustom org-cycle-open-archived-trees nil
  3503. "Non-nil means `org-cycle' will open archived trees.
  3504. An archived tree is a tree marked with the tag ARCHIVE.
  3505. When nil, archived trees will stay folded. You can still open them with
  3506. normal outline commands like `show-all', but not with the cycling commands."
  3507. :group 'org-archive
  3508. :group 'org-cycle
  3509. :type 'boolean)
  3510. (defcustom org-sparse-tree-open-archived-trees nil
  3511. "Non-nil means sparse tree construction shows matches in archived trees.
  3512. When nil, matches in these trees are highlighted, but the trees are kept in
  3513. collapsed state."
  3514. :group 'org-archive
  3515. :group 'org-sparse-trees
  3516. :type 'boolean)
  3517. (defun org-cycle-hide-archived-subtrees (state)
  3518. "Re-hide all archived subtrees after a visibility state change."
  3519. (when (and (not org-cycle-open-archived-trees)
  3520. (not (memq state '(overview folded))))
  3521. (save-excursion
  3522. (let* ((globalp (memq state '(contents all)))
  3523. (beg (if globalp (point-min) (point)))
  3524. (end (if globalp (point-max) (org-end-of-subtree t))))
  3525. (org-hide-archived-subtrees beg end)
  3526. (goto-char beg)
  3527. (if (looking-at (concat ".*:" org-archive-tag ":"))
  3528. (message "%s" (substitute-command-keys
  3529. "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
  3530. (defun org-force-cycle-archived ()
  3531. "Cycle subtree even if it is archived."
  3532. (interactive)
  3533. (setq this-command 'org-cycle)
  3534. (let ((org-cycle-open-archived-trees t))
  3535. (call-interactively 'org-cycle)))
  3536. (defun org-hide-archived-subtrees (beg end)
  3537. "Re-hide all archived subtrees after a visibility state change."
  3538. (save-excursion
  3539. (let* ((re (concat ":" org-archive-tag ":")))
  3540. (goto-char beg)
  3541. (while (re-search-forward re end t)
  3542. (when (org-on-heading-p)
  3543. (org-flag-subtree t)
  3544. (org-end-of-subtree t))))))
  3545. (defun org-flag-subtree (flag)
  3546. (save-excursion
  3547. (org-back-to-heading t)
  3548. (outline-end-of-heading)
  3549. (outline-flag-region (point)
  3550. (progn (org-end-of-subtree t) (point))
  3551. flag)))
  3552. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  3553. (eval-and-compile
  3554. (org-autoload "org-archive"
  3555. '(org-add-archive-files org-archive-subtree
  3556. org-archive-to-archive-sibling org-toggle-archive-tag
  3557. org-archive-subtree-default
  3558. org-archive-subtree-default-with-confirmation)))
  3559. ;; Autoload Column View Code
  3560. (declare-function org-columns-number-to-string "org-colview")
  3561. (declare-function org-columns-get-format-and-top-level "org-colview")
  3562. (declare-function org-columns-compute "org-colview")
  3563. (org-autoload (if (featurep 'xemacs) "org-colview-xemacs" "org-colview")
  3564. '(org-columns-number-to-string org-columns-get-format-and-top-level
  3565. org-columns-compute org-agenda-columns org-columns-remove-overlays
  3566. org-columns org-insert-columns-dblock org-dblock-write:columnview))
  3567. ;; Autoload ID code
  3568. (declare-function org-id-store-link "org-id")
  3569. (declare-function org-id-locations-load "org-id")
  3570. (declare-function org-id-locations-save "org-id")
  3571. (defvar org-id-track-globally)
  3572. (org-autoload "org-id"
  3573. '(org-id-get-create org-id-new org-id-copy org-id-get
  3574. org-id-get-with-outline-path-completion
  3575. org-id-get-with-outline-drilling org-id-store-link
  3576. org-id-goto org-id-find org-id-store-link))
  3577. ;; Autoload Plotting Code
  3578. (org-autoload "org-plot"
  3579. '(org-plot/gnuplot))
  3580. ;;; Variables for pre-computed regular expressions, all buffer local
  3581. (defvar org-drawer-regexp nil
  3582. "Matches first line of a hidden block.")
  3583. (make-variable-buffer-local 'org-drawer-regexp)
  3584. (defvar org-todo-regexp nil
  3585. "Matches any of the TODO state keywords.")
  3586. (make-variable-buffer-local 'org-todo-regexp)
  3587. (defvar org-not-done-regexp nil
  3588. "Matches any of the TODO state keywords except the last one.")
  3589. (make-variable-buffer-local 'org-not-done-regexp)
  3590. (defvar org-not-done-heading-regexp nil
  3591. "Matches a TODO headline that is not done.")
  3592. (make-variable-buffer-local 'org-not-done-regexp)
  3593. (defvar org-todo-line-regexp nil
  3594. "Matches a headline and puts TODO state into group 2 if present.")
  3595. (make-variable-buffer-local 'org-todo-line-regexp)
  3596. (defvar org-complex-heading-regexp nil
  3597. "Matches a headline and puts everything into groups:
  3598. group 1: the stars
  3599. group 2: The todo keyword, maybe
  3600. group 3: Priority cookie
  3601. group 4: True headline
  3602. group 5: Tags")
  3603. (make-variable-buffer-local 'org-complex-heading-regexp)
  3604. (defvar org-complex-heading-regexp-format nil
  3605. "Printf format to make regexp to match an exact headline.
  3606. This regexp will match the headline of any node which hase the exact
  3607. headline text that is put into the format, but may have any TODO state,
  3608. priority and tags.")
  3609. (make-variable-buffer-local 'org-complex-heading-regexp-format)
  3610. (defvar org-todo-line-tags-regexp nil
  3611. "Matches a headline and puts TODO state into group 2 if present.
  3612. Also put tags into group 4 if tags are present.")
  3613. (make-variable-buffer-local 'org-todo-line-tags-regexp)
  3614. (defvar org-nl-done-regexp nil
  3615. "Matches newline followed by a headline with the DONE keyword.")
  3616. (make-variable-buffer-local 'org-nl-done-regexp)
  3617. (defvar org-looking-at-done-regexp nil
  3618. "Matches the DONE keyword a point.")
  3619. (make-variable-buffer-local 'org-looking-at-done-regexp)
  3620. (defvar org-ds-keyword-length 12
  3621. "Maximum length of the Deadline and SCHEDULED keywords.")
  3622. (make-variable-buffer-local 'org-ds-keyword-length)
  3623. (defvar org-deadline-regexp nil
  3624. "Matches the DEADLINE keyword.")
  3625. (make-variable-buffer-local 'org-deadline-regexp)
  3626. (defvar org-deadline-time-regexp nil
  3627. "Matches the DEADLINE keyword together with a time stamp.")
  3628. (make-variable-buffer-local 'org-deadline-time-regexp)
  3629. (defvar org-deadline-line-regexp nil
  3630. "Matches the DEADLINE keyword and the rest of the line.")
  3631. (make-variable-buffer-local 'org-deadline-line-regexp)
  3632. (defvar org-scheduled-regexp nil
  3633. "Matches the SCHEDULED keyword.")
  3634. (make-variable-buffer-local 'org-scheduled-regexp)
  3635. (defvar org-scheduled-time-regexp nil
  3636. "Matches the SCHEDULED keyword together with a time stamp.")
  3637. (make-variable-buffer-local 'org-scheduled-time-regexp)
  3638. (defvar org-closed-time-regexp nil
  3639. "Matches the CLOSED keyword together with a time stamp.")
  3640. (make-variable-buffer-local 'org-closed-time-regexp)
  3641. (defvar org-keyword-time-regexp nil
  3642. "Matches any of the 4 keywords, together with the time stamp.")
  3643. (make-variable-buffer-local 'org-keyword-time-regexp)
  3644. (defvar org-keyword-time-not-clock-regexp nil
  3645. "Matches any of the 3 keywords, together with the time stamp.")
  3646. (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
  3647. (defvar org-maybe-keyword-time-regexp nil
  3648. "Matches a timestamp, possibly preceded by a keyword.")
  3649. (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
  3650. (defvar org-planning-or-clock-line-re nil
  3651. "Matches a line with planning or clock info.")
  3652. (make-variable-buffer-local 'org-planning-or-clock-line-re)
  3653. (defvar org-all-time-keywords nil
  3654. "List of time keywords.")
  3655. (make-variable-buffer-local 'org-all-time-keywords)
  3656. (defconst org-plain-time-of-day-regexp
  3657. (concat
  3658. "\\(\\<[012]?[0-9]"
  3659. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3660. "\\(--?"
  3661. "\\(\\<[012]?[0-9]"
  3662. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3663. "\\)?")
  3664. "Regular expression to match a plain time or time range.
  3665. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3666. groups carry important information:
  3667. 0 the full match
  3668. 1 the first time, range or not
  3669. 8 the second time, if it is a range.")
  3670. (defconst org-plain-time-extension-regexp
  3671. (concat
  3672. "\\(\\<[012]?[0-9]"
  3673. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3674. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  3675. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  3676. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3677. groups carry important information:
  3678. 0 the full match
  3679. 7 hours of duration
  3680. 9 minutes of duration")
  3681. (defconst org-stamp-time-of-day-regexp
  3682. (concat
  3683. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  3684. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  3685. "\\(--?"
  3686. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  3687. "Regular expression to match a timestamp time or time range.
  3688. After a match, the following groups carry important information:
  3689. 0 the full match
  3690. 1 date plus weekday, for back referencing to make sure both times are on the same day
  3691. 2 the first time, range or not
  3692. 4 the second time, if it is a range.")
  3693. (defconst org-startup-options
  3694. '(("fold" org-startup-folded t)
  3695. ("overview" org-startup-folded t)
  3696. ("nofold" org-startup-folded nil)
  3697. ("showall" org-startup-folded nil)
  3698. ("showeverything" org-startup-folded showeverything)
  3699. ("content" org-startup-folded content)
  3700. ("indent" org-startup-indented t)
  3701. ("noindent" org-startup-indented nil)
  3702. ("hidestars" org-hide-leading-stars t)
  3703. ("showstars" org-hide-leading-stars nil)
  3704. ("odd" org-odd-levels-only t)
  3705. ("oddeven" org-odd-levels-only nil)
  3706. ("align" org-startup-align-all-tables t)
  3707. ("noalign" org-startup-align-all-tables nil)
  3708. ("inlineimages" org-startup-with-inline-images t)
  3709. ("noinlineimages" org-startup-with-inline-images nil)
  3710. ("customtime" org-display-custom-times t)
  3711. ("logdone" org-log-done time)
  3712. ("lognotedone" org-log-done note)
  3713. ("nologdone" org-log-done nil)
  3714. ("lognoteclock-out" org-log-note-clock-out t)
  3715. ("nolognoteclock-out" org-log-note-clock-out nil)
  3716. ("logrepeat" org-log-repeat state)
  3717. ("lognoterepeat" org-log-repeat note)
  3718. ("nologrepeat" org-log-repeat nil)
  3719. ("logreschedule" org-log-reschedule time)
  3720. ("lognotereschedule" org-log-reschedule note)
  3721. ("nologreschedule" org-log-reschedule nil)
  3722. ("logredeadline" org-log-redeadline time)
  3723. ("lognoteredeadline" org-log-redeadline note)
  3724. ("nologredeadline" org-log-redeadline nil)
  3725. ("logrefile" org-log-refile time)
  3726. ("lognoterefile" org-log-refile note)
  3727. ("nologrefile" org-log-refile nil)
  3728. ("fninline" org-footnote-define-inline t)
  3729. ("nofninline" org-footnote-define-inline nil)
  3730. ("fnlocal" org-footnote-section nil)
  3731. ("fnauto" org-footnote-auto-label t)
  3732. ("fnprompt" org-footnote-auto-label nil)
  3733. ("fnconfirm" org-footnote-auto-label confirm)
  3734. ("fnplain" org-footnote-auto-label plain)
  3735. ("fnadjust" org-footnote-auto-adjust t)
  3736. ("nofnadjust" org-footnote-auto-adjust nil)
  3737. ("constcgs" constants-unit-system cgs)
  3738. ("constSI" constants-unit-system SI)
  3739. ("noptag" org-tag-persistent-alist nil)
  3740. ("hideblocks" org-hide-block-startup t)
  3741. ("nohideblocks" org-hide-block-startup nil)
  3742. ("beamer" org-startup-with-beamer-mode t)
  3743. ("entitiespretty" org-pretty-entities t)
  3744. ("entitiesplain" org-pretty-entities nil))
  3745. "Variable associated with STARTUP options for org-mode.
  3746. Each element is a list of three items: The startup options as written
  3747. in the #+STARTUP line, the corresponding variable, and the value to
  3748. set this variable to if the option is found. An optional forth element PUSH
  3749. means to push this value onto the list in the variable.")
  3750. (defun org-set-regexps-and-options ()
  3751. "Precompute regular expressions for current buffer."
  3752. (when (org-mode-p)
  3753. (org-set-local 'org-todo-kwd-alist nil)
  3754. (org-set-local 'org-todo-key-alist nil)
  3755. (org-set-local 'org-todo-key-trigger nil)
  3756. (org-set-local 'org-todo-keywords-1 nil)
  3757. (org-set-local 'org-done-keywords nil)
  3758. (org-set-local 'org-todo-heads nil)
  3759. (org-set-local 'org-todo-sets nil)
  3760. (org-set-local 'org-todo-log-states nil)
  3761. (org-set-local 'org-file-properties nil)
  3762. (org-set-local 'org-file-tags nil)
  3763. (let ((re (org-make-options-regexp
  3764. '("CATEGORY" "TODO" "COLUMNS"
  3765. "STARTUP" "ARCHIVE" "FILETAGS" "TAGS" "LINK" "PRIORITIES"
  3766. "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE" "LATEX_CLASS"
  3767. "OPTIONS")
  3768. "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
  3769. (splitre "[ \t]+")
  3770. (scripts org-use-sub-superscripts)
  3771. kwds kws0 kwsa key log value cat arch tags const links hw dws
  3772. tail sep kws1 prio props ftags drawers beamer-p
  3773. ext-setup-or-nil setup-contents (start 0))
  3774. (save-excursion
  3775. (save-restriction
  3776. (widen)
  3777. (goto-char (point-min))
  3778. (while (or (and ext-setup-or-nil
  3779. (string-match re ext-setup-or-nil start)
  3780. (setq start (match-end 0)))
  3781. (and (setq ext-setup-or-nil nil start 0)
  3782. (re-search-forward re nil t)))
  3783. (setq key (upcase (match-string 1 ext-setup-or-nil))
  3784. value (org-match-string-no-properties 2 ext-setup-or-nil))
  3785. (if (stringp value) (setq value (org-trim value)))
  3786. (cond
  3787. ((equal key "CATEGORY")
  3788. (setq cat value))
  3789. ((member key '("SEQ_TODO" "TODO"))
  3790. (push (cons 'sequence (org-split-string value splitre)) kwds))
  3791. ((equal key "TYP_TODO")
  3792. (push (cons 'type (org-split-string value splitre)) kwds))
  3793. ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
  3794. ;; general TODO-like setup
  3795. (push (cons (intern (downcase (match-string 1 key)))
  3796. (org-split-string value splitre)) kwds))
  3797. ((equal key "TAGS")
  3798. (setq tags (append tags (if tags '("\\n") nil)
  3799. (org-split-string value splitre))))
  3800. ((equal key "COLUMNS")
  3801. (org-set-local 'org-columns-default-format value))
  3802. ((equal key "LINK")
  3803. (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  3804. (push (cons (match-string 1 value)
  3805. (org-trim (match-string 2 value)))
  3806. links)))
  3807. ((equal key "PRIORITIES")
  3808. (setq prio (org-split-string value " +")))
  3809. ((equal key "PROPERTY")
  3810. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  3811. (push (cons (match-string 1 value) (match-string 2 value))
  3812. props)))
  3813. ((equal key "FILETAGS")
  3814. (when (string-match "\\S-" value)
  3815. (setq ftags
  3816. (append
  3817. ftags
  3818. (apply 'append
  3819. (mapcar (lambda (x) (org-split-string x ":"))
  3820. (org-split-string value)))))))
  3821. ((equal key "DRAWERS")
  3822. (setq drawers (org-split-string value splitre)))
  3823. ((equal key "CONSTANTS")
  3824. (setq const (append const (org-split-string value splitre))))
  3825. ((equal key "STARTUP")
  3826. (let ((opts (org-split-string value splitre))
  3827. l var val)
  3828. (while (setq l (pop opts))
  3829. (when (setq l (assoc l org-startup-options))
  3830. (setq var (nth 1 l) val (nth 2 l))
  3831. (if (not (nth 3 l))
  3832. (set (make-local-variable var) val)
  3833. (if (not (listp (symbol-value var)))
  3834. (set (make-local-variable var) nil))
  3835. (set (make-local-variable var) (symbol-value var))
  3836. (add-to-list var val))))))
  3837. ((equal key "ARCHIVE")
  3838. (setq arch value)
  3839. (remove-text-properties 0 (length arch)
  3840. '(face t fontified t) arch))
  3841. ((equal key "LATEX_CLASS")
  3842. (setq beamer-p (equal value "beamer")))
  3843. ((equal key "OPTIONS")
  3844. (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value)
  3845. (setq scripts (read (match-string 2 value)))))
  3846. ((equal key "SETUPFILE")
  3847. (setq setup-contents (org-file-contents
  3848. (expand-file-name
  3849. (org-remove-double-quotes value))
  3850. 'noerror))
  3851. (if (not ext-setup-or-nil)
  3852. (setq ext-setup-or-nil setup-contents start 0)
  3853. (setq ext-setup-or-nil
  3854. (concat (substring ext-setup-or-nil 0 start)
  3855. "\n" setup-contents "\n"
  3856. (substring ext-setup-or-nil start)))))
  3857. ))))
  3858. (org-set-local 'org-use-sub-superscripts scripts)
  3859. (when cat
  3860. (org-set-local 'org-category (intern cat))
  3861. (push (cons "CATEGORY" cat) props))
  3862. (when prio
  3863. (if (< (length prio) 3) (setq prio '("A" "C" "B")))
  3864. (setq prio (mapcar 'string-to-char prio))
  3865. (org-set-local 'org-highest-priority (nth 0 prio))
  3866. (org-set-local 'org-lowest-priority (nth 1 prio))
  3867. (org-set-local 'org-default-priority (nth 2 prio)))
  3868. (and props (org-set-local 'org-file-properties (nreverse props)))
  3869. (and ftags (org-set-local 'org-file-tags
  3870. (mapcar 'org-add-prop-inherited ftags)))
  3871. (and drawers (org-set-local 'org-drawers drawers))
  3872. (and arch (org-set-local 'org-archive-location arch))
  3873. (and links (setq org-link-abbrev-alist-local (nreverse links)))
  3874. ;; Process the TODO keywords
  3875. (unless kwds
  3876. ;; Use the global values as if they had been given locally.
  3877. (setq kwds (default-value 'org-todo-keywords))
  3878. (if (stringp (car kwds))
  3879. (setq kwds (list (cons org-todo-interpretation
  3880. (default-value 'org-todo-keywords)))))
  3881. (setq kwds (reverse kwds)))
  3882. (setq kwds (nreverse kwds))
  3883. (let (inter kws kw)
  3884. (while (setq kws (pop kwds))
  3885. (let ((kws (or
  3886. (run-hook-with-args-until-success
  3887. 'org-todo-setup-filter-hook kws)
  3888. kws)))
  3889. (setq inter (pop kws) sep (member "|" kws)
  3890. kws0 (delete "|" (copy-sequence kws))
  3891. kwsa nil
  3892. kws1 (mapcar
  3893. (lambda (x)
  3894. ;; 1 2
  3895. (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
  3896. (progn
  3897. (setq kw (match-string 1 x)
  3898. key (and (match-end 2) (match-string 2 x))
  3899. log (org-extract-log-state-settings x))
  3900. (push (cons kw (and key (string-to-char key))) kwsa)
  3901. (and log (push log org-todo-log-states))
  3902. kw)
  3903. (error "Invalid TODO keyword %s" x)))
  3904. kws0)
  3905. kwsa (if kwsa (append '((:startgroup))
  3906. (nreverse kwsa)
  3907. '((:endgroup))))
  3908. hw (car kws1)
  3909. dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
  3910. tail (list inter hw (car dws) (org-last dws))))
  3911. (add-to-list 'org-todo-heads hw 'append)
  3912. (push kws1 org-todo-sets)
  3913. (setq org-done-keywords (append org-done-keywords dws nil))
  3914. (setq org-todo-key-alist (append org-todo-key-alist kwsa))
  3915. (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
  3916. (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
  3917. (setq org-todo-sets (nreverse org-todo-sets)
  3918. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  3919. org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
  3920. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
  3921. ;; Process the constants
  3922. (when const
  3923. (let (e cst)
  3924. (while (setq e (pop const))
  3925. (if (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" e)
  3926. (push (cons (match-string 1 e) (match-string 2 e)) cst)))
  3927. (setq org-table-formula-constants-local cst)))
  3928. ;; Process the tags.
  3929. (when tags
  3930. (let (e tgs)
  3931. (while (setq e (pop tags))
  3932. (cond
  3933. ((equal e "{") (push '(:startgroup) tgs))
  3934. ((equal e "}") (push '(:endgroup) tgs))
  3935. ((equal e "\\n") (push '(:newline) tgs))
  3936. ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e)
  3937. (push (cons (match-string 1 e)
  3938. (string-to-char (match-string 2 e)))
  3939. tgs))
  3940. (t (push (list e) tgs))))
  3941. (org-set-local 'org-tag-alist nil)
  3942. (while (setq e (pop tgs))
  3943. (or (and (stringp (car e))
  3944. (assoc (car e) org-tag-alist))
  3945. (push e org-tag-alist)))))
  3946. ;; Compute the regular expressions and other local variables
  3947. (if (not org-done-keywords)
  3948. (setq org-done-keywords (and org-todo-keywords-1
  3949. (list (org-last org-todo-keywords-1)))))
  3950. (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
  3951. (length org-scheduled-string)
  3952. (length org-clock-string)
  3953. (length org-closed-string)))
  3954. org-drawer-regexp
  3955. (concat "^[ \t]*:\\("
  3956. (mapconcat 'regexp-quote org-drawers "\\|")
  3957. "\\):[ \t]*$")
  3958. org-not-done-keywords
  3959. (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
  3960. org-todo-regexp
  3961. (concat "\\<\\(" (mapconcat 'regexp-quote org-todo-keywords-1
  3962. "\\|") "\\)\\>")
  3963. org-not-done-regexp
  3964. (concat "\\<\\("
  3965. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  3966. "\\)\\>")
  3967. org-not-done-heading-regexp
  3968. (concat "^\\(\\*+\\)[ \t]+\\("
  3969. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  3970. "\\)\\>")
  3971. org-todo-line-regexp
  3972. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3973. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3974. "\\)\\>\\)?[ \t]*\\(.*\\)")
  3975. org-complex-heading-regexp
  3976. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3977. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3978. "\\)\\>\\)?\\(?:[ \t]*\\(\\[#.\\]\\)\\)?[ \t]*\\(.*?\\)"
  3979. "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?[ \t]*$")
  3980. org-complex-heading-regexp-format
  3981. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3982. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3983. "\\)\\>\\)?"
  3984. "\\(?:[ \t]*\\(\\[#.\\]\\)\\)?"
  3985. "\\(?:[ \t]*\\(?:\\[[0-9%%/]+\\]\\)\\)?" ;; stats cookie
  3986. "[ \t]*\\(%s\\)"
  3987. "\\(?:[ \t]*\\(?:\\[[0-9%%/]+\\]\\)\\)?" ;; stats cookie
  3988. "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?[ \t]*$")
  3989. org-nl-done-regexp
  3990. (concat "\n\\*+[ \t]+"
  3991. "\\(?:" (mapconcat 'regexp-quote org-done-keywords "\\|")
  3992. "\\)" "\\>")
  3993. org-todo-line-tags-regexp
  3994. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3995. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3996. (org-re
  3997. "\\)\\>\\)? *\\(.*?\\([ \t]:[[:alnum:]:_@#%]+:[ \t]*\\)?$\\)"))
  3998. org-looking-at-done-regexp
  3999. (concat "^" "\\(?:"
  4000. (mapconcat 'regexp-quote org-done-keywords "\\|") "\\)"
  4001. "\\>")
  4002. org-deadline-regexp (concat "\\<" org-deadline-string)
  4003. org-deadline-time-regexp
  4004. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  4005. org-deadline-line-regexp
  4006. (concat "\\<\\(" org-deadline-string "\\).*")
  4007. org-scheduled-regexp
  4008. (concat "\\<" org-scheduled-string)
  4009. org-scheduled-time-regexp
  4010. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  4011. org-closed-time-regexp
  4012. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  4013. org-keyword-time-regexp
  4014. (concat "\\<\\(" org-scheduled-string
  4015. "\\|" org-deadline-string
  4016. "\\|" org-closed-string
  4017. "\\|" org-clock-string "\\)"
  4018. " *[[<]\\([^]>]+\\)[]>]")
  4019. org-keyword-time-not-clock-regexp
  4020. (concat "\\<\\(" org-scheduled-string
  4021. "\\|" org-deadline-string
  4022. "\\|" org-closed-string
  4023. "\\)"
  4024. " *[[<]\\([^]>]+\\)[]>]")
  4025. org-maybe-keyword-time-regexp
  4026. (concat "\\(\\<\\(" org-scheduled-string
  4027. "\\|" org-deadline-string
  4028. "\\|" org-closed-string
  4029. "\\|" org-clock-string "\\)\\)?"
  4030. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
  4031. org-planning-or-clock-line-re
  4032. (concat "\\(?:^[ \t]*\\(" org-scheduled-string
  4033. "\\|" org-deadline-string
  4034. "\\|" org-closed-string "\\|" org-clock-string
  4035. "\\)\\>\\)")
  4036. org-all-time-keywords
  4037. (mapcar (lambda (w) (substring w 0 -1))
  4038. (list org-scheduled-string org-deadline-string
  4039. org-clock-string org-closed-string))
  4040. )
  4041. (org-compute-latex-and-specials-regexp)
  4042. (org-set-font-lock-defaults))))
  4043. (defun org-file-contents (file &optional noerror)
  4044. "Return the contents of FILE, as a string."
  4045. (if (or (not file)
  4046. (not (file-readable-p file)))
  4047. (if noerror
  4048. (progn
  4049. (message "Cannot read file \"%s\"" file)
  4050. (ding) (sit-for 2)
  4051. "")
  4052. (error "Cannot read file \"%s\"" file))
  4053. (with-temp-buffer
  4054. (insert-file-contents file)
  4055. (buffer-string))))
  4056. (defun org-extract-log-state-settings (x)
  4057. "Extract the log state setting from a TODO keyword string.
  4058. This will extract info from a string like \"WAIT(w@/!)\"."
  4059. (let (kw key log1 log2)
  4060. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  4061. (setq kw (match-string 1 x)
  4062. key (and (match-end 2) (match-string 2 x))
  4063. log1 (and (match-end 3) (match-string 3 x))
  4064. log2 (and (match-end 4) (match-string 4 x)))
  4065. (and (or log1 log2)
  4066. (list kw
  4067. (and log1 (if (equal log1 "!") 'time 'note))
  4068. (and log2 (if (equal log2 "!") 'time 'note)))))))
  4069. (defun org-remove-keyword-keys (list)
  4070. "Remove a pair of parenthesis at the end of each string in LIST."
  4071. (mapcar (lambda (x)
  4072. (if (string-match "(.*)$" x)
  4073. (substring x 0 (match-beginning 0))
  4074. x))
  4075. list))
  4076. (defun org-assign-fast-keys (alist)
  4077. "Assign fast keys to a keyword-key alist.
  4078. Respect keys that are already there."
  4079. (let (new e (alt ?0))
  4080. (while (setq e (pop alist))
  4081. (if (or (memq (car e) '(:newline :endgroup :startgroup))
  4082. (cdr e)) ;; Key already assigned.
  4083. (push e new)
  4084. (let ((clist (string-to-list (downcase (car e))))
  4085. (used (append new alist)))
  4086. (when (= (car clist) ?@)
  4087. (pop clist))
  4088. (while (and clist (rassoc (car clist) used))
  4089. (pop clist))
  4090. (unless clist
  4091. (while (rassoc alt used)
  4092. (incf alt)))
  4093. (push (cons (car e) (or (car clist) alt)) new))))
  4094. (nreverse new)))
  4095. ;;; Some variables used in various places
  4096. (defvar org-window-configuration nil
  4097. "Used in various places to store a window configuration.")
  4098. (defvar org-selected-window nil
  4099. "Used in various places to store a window configuration.")
  4100. (defvar org-finish-function nil
  4101. "Function to be called when `C-c C-c' is used.
  4102. This is for getting out of special buffers like remember.")
  4103. ;; FIXME: Occasionally check by commenting these, to make sure
  4104. ;; no other functions uses these, forgetting to let-bind them.
  4105. (defvar entry)
  4106. (defvar last-state)
  4107. (defvar date)
  4108. ;; Defined somewhere in this file, but used before definition.
  4109. (defvar org-entities) ;; defined in org-entities.el
  4110. (defvar org-struct-menu)
  4111. (defvar org-org-menu)
  4112. (defvar org-tbl-menu)
  4113. ;;;; Define the Org-mode
  4114. (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
  4115. (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"))
  4116. ;; We use a before-change function to check if a table might need
  4117. ;; an update.
  4118. (defvar org-table-may-need-update t
  4119. "Indicates that a table might need an update.
  4120. This variable is set by `org-before-change-function'.
  4121. `org-table-align' sets it back to nil.")
  4122. (defun org-before-change-function (beg end)
  4123. "Every change indicates that a table might need an update."
  4124. (setq org-table-may-need-update t))
  4125. (defvar org-mode-map)
  4126. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  4127. (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
  4128. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  4129. (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
  4130. (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
  4131. (defvar org-table-buffer-is-an nil)
  4132. (defconst org-outline-regexp "\\*+ ")
  4133. ;;;###autoload
  4134. (define-derived-mode org-mode outline-mode "Org"
  4135. "Outline-based notes management and organizer, alias
  4136. \"Carsten's outline-mode for keeping track of everything.\"
  4137. Org-mode develops organizational tasks around a NOTES file which
  4138. contains information about projects as plain text. Org-mode is
  4139. implemented on top of outline-mode, which is ideal to keep the content
  4140. of large files well structured. It supports ToDo items, deadlines and
  4141. time stamps, which magically appear in the diary listing of the Emacs
  4142. calendar. Tables are easily created with a built-in table editor.
  4143. Plain text URL-like links connect to websites, emails (VM), Usenet
  4144. messages (Gnus), BBDB entries, and any files related to the project.
  4145. For printing and sharing of notes, an Org-mode file (or a part of it)
  4146. can be exported as a structured ASCII or HTML file.
  4147. The following commands are available:
  4148. \\{org-mode-map}"
  4149. ;; Get rid of Outline menus, they are not needed
  4150. ;; Need to do this here because define-derived-mode sets up
  4151. ;; the keymap so late. Still, it is a waste to call this each time
  4152. ;; we switch another buffer into org-mode.
  4153. (if (featurep 'xemacs)
  4154. (when (boundp 'outline-mode-menu-heading)
  4155. ;; Assume this is Greg's port, it uses easymenu
  4156. (easy-menu-remove outline-mode-menu-heading)
  4157. (easy-menu-remove outline-mode-menu-show)
  4158. (easy-menu-remove outline-mode-menu-hide))
  4159. (define-key org-mode-map [menu-bar headings] 'undefined)
  4160. (define-key org-mode-map [menu-bar hide] 'undefined)
  4161. (define-key org-mode-map [menu-bar show] 'undefined))
  4162. (org-load-modules-maybe)
  4163. (easy-menu-add org-org-menu)
  4164. (easy-menu-add org-tbl-menu)
  4165. (org-install-agenda-files-menu)
  4166. (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
  4167. (add-to-invisibility-spec '(org-cwidth))
  4168. (add-to-invisibility-spec '(org-hide-block . t))
  4169. (when (featurep 'xemacs)
  4170. (org-set-local 'line-move-ignore-invisible t))
  4171. (org-set-local 'outline-regexp org-outline-regexp)
  4172. (org-set-local 'outline-level 'org-outline-level)
  4173. (when (and org-ellipsis
  4174. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  4175. (fboundp 'make-glyph-code))
  4176. (unless org-display-table
  4177. (setq org-display-table (make-display-table)))
  4178. (set-display-table-slot
  4179. org-display-table 4
  4180. (vconcat (mapcar
  4181. (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
  4182. org-ellipsis)))
  4183. (if (stringp org-ellipsis) org-ellipsis "..."))))
  4184. (setq buffer-display-table org-display-table))
  4185. (org-set-regexps-and-options)
  4186. (when (and org-tag-faces (not org-tags-special-faces-re))
  4187. ;; tag faces set outside customize.... force initialization.
  4188. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  4189. ;; Calc embedded
  4190. (org-set-local 'calc-embedded-open-mode "# ")
  4191. (modify-syntax-entry ?@ "w")
  4192. (if org-startup-truncated (setq truncate-lines t))
  4193. (org-set-local 'font-lock-unfontify-region-function
  4194. 'org-unfontify-region)
  4195. ;; Activate before-change-function
  4196. (org-set-local 'org-table-may-need-update t)
  4197. (org-add-hook 'before-change-functions 'org-before-change-function nil
  4198. 'local)
  4199. ;; Check for running clock before killing a buffer
  4200. (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  4201. ;; Paragraphs and auto-filling
  4202. (org-set-autofill-regexps)
  4203. (setq indent-line-function 'org-indent-line-function)
  4204. (org-update-radio-target-regexp)
  4205. ;; Beginning/end of defun
  4206. (org-set-local 'beginning-of-defun-function 'org-beginning-of-defun)
  4207. (org-set-local 'end-of-defun-function 'org-end-of-defun)
  4208. ;; Next error for sparse trees
  4209. (org-set-local 'next-error-function 'org-occur-next-match)
  4210. ;; Make sure dependence stuff works reliably, even for users who set it
  4211. ;; too late :-(
  4212. (if org-enforce-todo-dependencies
  4213. (add-hook 'org-blocker-hook
  4214. 'org-block-todo-from-children-or-siblings-or-parent)
  4215. (remove-hook 'org-blocker-hook
  4216. 'org-block-todo-from-children-or-siblings-or-parent))
  4217. (if org-enforce-todo-checkbox-dependencies
  4218. (add-hook 'org-blocker-hook
  4219. 'org-block-todo-from-checkboxes)
  4220. (remove-hook 'org-blocker-hook
  4221. 'org-block-todo-from-checkboxes))
  4222. ;; Comment characters
  4223. (org-set-local 'comment-start "#")
  4224. (org-set-local 'comment-padding " ")
  4225. ;; Align options lines
  4226. (org-set-local
  4227. 'align-mode-rules-list
  4228. '((org-in-buffer-settings
  4229. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  4230. (modes . '(org-mode)))))
  4231. ;; Imenu
  4232. (org-set-local 'imenu-create-index-function
  4233. 'org-imenu-get-tree)
  4234. ;; Make isearch reveal context
  4235. (if (or (featurep 'xemacs)
  4236. (not (boundp 'outline-isearch-open-invisible-function)))
  4237. ;; Emacs 21 and XEmacs make use of the hook
  4238. (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
  4239. ;; Emacs 22 deals with this through a special variable
  4240. (org-set-local 'outline-isearch-open-invisible-function
  4241. (lambda (&rest ignore) (org-show-context 'isearch))))
  4242. ;; Turn on org-beamer-mode?
  4243. (and org-startup-with-beamer-mode (org-beamer-mode 1))
  4244. ;; Setup the pcomplete hooks
  4245. (set (make-local-variable 'pcomplete-command-completion-function)
  4246. 'org-pcomplete-initial)
  4247. (set (make-local-variable 'pcomplete-command-name-function)
  4248. 'org-command-at-point)
  4249. (set (make-local-variable 'pcomplete-default-completion-function)
  4250. 'ignore)
  4251. (set (make-local-variable 'pcomplete-parse-arguments-function)
  4252. 'org-parse-arguments)
  4253. (set (make-local-variable 'pcomplete-termination-string) "")
  4254. ;; If empty file that did not turn on org-mode automatically, make it to.
  4255. (if (and org-insert-mode-line-in-empty-file
  4256. (interactive-p)
  4257. (= (point-min) (point-max)))
  4258. (insert "# -*- mode: org -*-\n\n"))
  4259. (unless org-inhibit-startup
  4260. (when org-startup-align-all-tables
  4261. (let ((bmp (buffer-modified-p)))
  4262. (org-table-map-tables 'org-table-align 'quietly)
  4263. (set-buffer-modified-p bmp)))
  4264. (when org-startup-with-inline-images
  4265. (org-display-inline-images))
  4266. (when org-startup-indented
  4267. (require 'org-indent)
  4268. (org-indent-mode 1))
  4269. (unless org-inhibit-startup-visibility-stuff
  4270. (org-set-startup-visibility))))
  4271. (when (fboundp 'abbrev-table-put)
  4272. (abbrev-table-put org-mode-abbrev-table
  4273. :parents (list text-mode-abbrev-table)))
  4274. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  4275. (defun org-current-time ()
  4276. "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
  4277. (if (> (car org-time-stamp-rounding-minutes) 1)
  4278. (let ((r (car org-time-stamp-rounding-minutes))
  4279. (time (decode-time)))
  4280. (apply 'encode-time
  4281. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  4282. (nthcdr 2 time))))
  4283. (current-time)))
  4284. (defun org-today ()
  4285. "Return today date, considering `org-extend-today-until'."
  4286. (time-to-days
  4287. (time-subtract (current-time)
  4288. (list 0 (* 3600 org-extend-today-until) 0))))
  4289. ;;;; Font-Lock stuff, including the activators
  4290. (defvar org-mouse-map (make-sparse-keymap))
  4291. (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
  4292. (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
  4293. (when org-mouse-1-follows-link
  4294. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  4295. (when org-tab-follows-link
  4296. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  4297. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  4298. (require 'font-lock)
  4299. (defconst org-non-link-chars "]\t\n\r<>")
  4300. (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
  4301. "shell" "elisp" "doi" "message"))
  4302. (defvar org-link-types-re nil
  4303. "Matches a link that has a url-like prefix like \"http:\"")
  4304. (defvar org-link-re-with-space nil
  4305. "Matches a link with spaces, optional angular brackets around it.")
  4306. (defvar org-link-re-with-space2 nil
  4307. "Matches a link with spaces, optional angular brackets around it.")
  4308. (defvar org-link-re-with-space3 nil
  4309. "Matches a link with spaces, only for internal part in bracket links.")
  4310. (defvar org-angle-link-re nil
  4311. "Matches link with angular brackets, spaces are allowed.")
  4312. (defvar org-plain-link-re nil
  4313. "Matches plain link, without spaces.")
  4314. (defvar org-bracket-link-regexp nil
  4315. "Matches a link in double brackets.")
  4316. (defvar org-bracket-link-analytic-regexp nil
  4317. "Regular expression used to analyze links.
  4318. Here is what the match groups contain after a match:
  4319. 1: http:
  4320. 2: http
  4321. 3: path
  4322. 4: [desc]
  4323. 5: desc")
  4324. (defvar org-bracket-link-analytic-regexp++ nil
  4325. "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
  4326. (defvar org-any-link-re nil
  4327. "Regular expression matching any link.")
  4328. (defcustom org-match-sexp-depth 3
  4329. "Number of stacked braces for sub/superscript matching.
  4330. This has to be set before loading org.el to be effective."
  4331. :group 'org-export-translation ; ??????????????????????????/
  4332. :type 'integer)
  4333. (defun org-create-multibrace-regexp (left right n)
  4334. "Create a regular expression which will match a balanced sexp.
  4335. Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
  4336. as single character strings.
  4337. The regexp returned will match the entire expression including the
  4338. delimiters. It will also define a single group which contains the
  4339. match except for the outermost delimiters. The maximum depth of
  4340. stacked delimiters is N. Escaping delimiters is not possible."
  4341. (let* ((nothing (concat "[^" left right "]*?"))
  4342. (or "\\|")
  4343. (re nothing)
  4344. (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
  4345. (while (> n 1)
  4346. (setq n (1- n)
  4347. re (concat re or next)
  4348. next (concat "\\(?:" nothing left next right "\\)+" nothing)))
  4349. (concat left "\\(" re "\\)" right)))
  4350. (defvar org-match-substring-regexp
  4351. (concat
  4352. "\\([^\\]\\)\\([_^]\\)\\("
  4353. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4354. "\\|"
  4355. "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
  4356. "\\|"
  4357. "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
  4358. "The regular expression matching a sub- or superscript.")
  4359. (defvar org-match-substring-with-braces-regexp
  4360. (concat
  4361. "\\([^\\]\\)\\([_^]\\)\\("
  4362. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4363. "\\)")
  4364. "The regular expression matching a sub- or superscript, forcing braces.")
  4365. (defun org-make-link-regexps ()
  4366. "Update the link regular expressions.
  4367. This should be called after the variable `org-link-types' has changed."
  4368. (setq org-link-types-re
  4369. (concat
  4370. "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
  4371. org-link-re-with-space
  4372. (concat
  4373. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4374. "\\([^" org-non-link-chars " ]"
  4375. "[^" org-non-link-chars "]*"
  4376. "[^" org-non-link-chars " ]\\)>?")
  4377. org-link-re-with-space2
  4378. (concat
  4379. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4380. "\\([^" org-non-link-chars " ]"
  4381. "[^\t\n\r]*"
  4382. "[^" org-non-link-chars " ]\\)>?")
  4383. org-link-re-with-space3
  4384. (concat
  4385. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4386. "\\([^" org-non-link-chars " ]"
  4387. "[^\t\n\r]*\\)")
  4388. org-angle-link-re
  4389. (concat
  4390. "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4391. "\\([^" org-non-link-chars " ]"
  4392. "[^" org-non-link-chars "]*"
  4393. "\\)>")
  4394. org-plain-link-re
  4395. (concat
  4396. "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4397. (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
  4398. ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  4399. org-bracket-link-regexp
  4400. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  4401. org-bracket-link-analytic-regexp
  4402. (concat
  4403. "\\[\\["
  4404. "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
  4405. "\\([^]]+\\)"
  4406. "\\]"
  4407. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4408. "\\]")
  4409. org-bracket-link-analytic-regexp++
  4410. (concat
  4411. "\\[\\["
  4412. "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
  4413. "\\([^]]+\\)"
  4414. "\\]"
  4415. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4416. "\\]")
  4417. org-any-link-re
  4418. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  4419. org-angle-link-re "\\)\\|\\("
  4420. org-plain-link-re "\\)")))
  4421. (org-make-link-regexps)
  4422. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^\r\n>]*?\\)>"
  4423. "Regular expression for fast time stamp matching.")
  4424. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?\\)[]>]"
  4425. "Regular expression for fast time stamp matching.")
  4426. (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4427. "Regular expression matching time strings for analysis.
  4428. This one does not require the space after the date, so it can be used
  4429. on a string that terminates immediately after the date.")
  4430. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4431. "Regular expression matching time strings for analysis.")
  4432. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  4433. "Regular expression matching time stamps, with groups.")
  4434. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  4435. "Regular expression matching time stamps (also [..]), with groups.")
  4436. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  4437. "Regular expression matching a time stamp range.")
  4438. (defconst org-tr-regexp-both
  4439. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  4440. "Regular expression matching a time stamp range.")
  4441. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  4442. org-ts-regexp "\\)?")
  4443. "Regular expression matching a time stamp or time stamp range.")
  4444. (defconst org-tsr-regexp-both (concat org-ts-regexp-both "\\(--?-?"
  4445. org-ts-regexp-both "\\)?")
  4446. "Regular expression matching a time stamp or time stamp range.
  4447. The time stamps may be either active or inactive.")
  4448. (defvar org-emph-face nil)
  4449. (defun org-do-emphasis-faces (limit)
  4450. "Run through the buffer and add overlays to links."
  4451. (let (rtn a)
  4452. (while (and (not rtn) (re-search-forward org-emph-re limit t))
  4453. (if (not (= (char-after (match-beginning 3))
  4454. (char-after (match-beginning 4))))
  4455. (progn
  4456. (setq rtn t)
  4457. (setq a (assoc (match-string 3) org-emphasis-alist))
  4458. (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
  4459. 'face
  4460. (nth 1 a))
  4461. (and (nth 4 a)
  4462. (org-remove-flyspell-overlays-in
  4463. (match-beginning 0) (match-end 0)))
  4464. (add-text-properties (match-beginning 2) (match-end 2)
  4465. '(font-lock-multiline t org-emphasis t))
  4466. (when org-hide-emphasis-markers
  4467. (add-text-properties (match-end 4) (match-beginning 5)
  4468. '(invisible org-link))
  4469. (add-text-properties (match-beginning 3) (match-end 3)
  4470. '(invisible org-link)))))
  4471. (backward-char 1))
  4472. rtn))
  4473. (defun org-emphasize (&optional char)
  4474. "Insert or change an emphasis, i.e. a font like bold or italic.
  4475. If there is an active region, change that region to a new emphasis.
  4476. If there is no region, just insert the marker characters and position
  4477. the cursor between them.
  4478. CHAR should be either the marker character, or the first character of the
  4479. HTML tag associated with that emphasis. If CHAR is a space, the means
  4480. to remove the emphasis of the selected region.
  4481. If char is not given (for example in an interactive call) it
  4482. will be prompted for."
  4483. (interactive)
  4484. (let ((eal org-emphasis-alist) e det
  4485. (erc org-emphasis-regexp-components)
  4486. (prompt "")
  4487. (string "") beg end move tag c s)
  4488. (if (org-region-active-p)
  4489. (setq beg (region-beginning) end (region-end)
  4490. string (buffer-substring beg end))
  4491. (setq move t))
  4492. (while (setq e (pop eal))
  4493. (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
  4494. c (aref tag 0))
  4495. (push (cons c (string-to-char (car e))) det)
  4496. (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
  4497. (substring tag 1)))))
  4498. (setq det (nreverse det))
  4499. (unless char
  4500. (message "%s" (concat "Emphasis marker or tag:" prompt))
  4501. (setq char (read-char-exclusive)))
  4502. (setq char (or (cdr (assoc char det)) char))
  4503. (if (equal char ?\ )
  4504. (setq s "" move nil)
  4505. (unless (assoc (char-to-string char) org-emphasis-alist)
  4506. (error "No such emphasis marker: \"%c\"" char))
  4507. (setq s (char-to-string char)))
  4508. (while (and (> (length string) 1)
  4509. (equal (substring string 0 1) (substring string -1))
  4510. (assoc (substring string 0 1) org-emphasis-alist))
  4511. (setq string (substring string 1 -1)))
  4512. (setq string (concat s string s))
  4513. (if beg (delete-region beg end))
  4514. (unless (or (bolp)
  4515. (string-match (concat "[" (nth 0 erc) "\n]")
  4516. (char-to-string (char-before (point)))))
  4517. (insert " "))
  4518. (unless (or (eobp)
  4519. (string-match (concat "[" (nth 1 erc) "\n]")
  4520. (char-to-string (char-after (point)))))
  4521. (insert " ") (backward-char 1))
  4522. (insert string)
  4523. (and move (backward-char 1))))
  4524. (defconst org-nonsticky-props
  4525. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
  4526. (defsubst org-rear-nonsticky-at (pos)
  4527. (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
  4528. (defun org-activate-plain-links (limit)
  4529. "Run through the buffer and add overlays to links."
  4530. (catch 'exit
  4531. (let (f)
  4532. (if (re-search-forward org-plain-link-re limit t)
  4533. (progn
  4534. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4535. (setq f (get-text-property (match-beginning 0) 'face))
  4536. (if (or (eq f 'org-tag)
  4537. (and (listp f) (memq 'org-tag f)))
  4538. nil
  4539. (add-text-properties (match-beginning 0) (match-end 0)
  4540. (list 'mouse-face 'highlight
  4541. 'face 'org-link
  4542. 'keymap org-mouse-map))
  4543. (org-rear-nonsticky-at (match-end 0)))
  4544. t)))))
  4545. (defun org-activate-code (limit)
  4546. (if (re-search-forward "^[ \t]*\\(: .*\n?\\)" limit t)
  4547. (progn
  4548. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4549. (remove-text-properties (match-beginning 0) (match-end 0)
  4550. '(display t invisible t intangible t))
  4551. t)))
  4552. (defcustom org-src-fontify-natively nil
  4553. "When non-nil, fontify code in code blocks."
  4554. :type 'boolean
  4555. :group 'org-appearance
  4556. :group 'org-babel)
  4557. (defun org-fontify-meta-lines-and-blocks (limit)
  4558. "Fontify #+ lines and blocks, in the correct ways."
  4559. (let ((case-fold-search t))
  4560. (if (re-search-forward
  4561. "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
  4562. limit t)
  4563. (let ((beg (match-beginning 0))
  4564. (block-start (match-end 0))
  4565. (block-end nil)
  4566. (lang (match-string 7))
  4567. (beg1 (line-beginning-position 2))
  4568. (dc1 (downcase (match-string 2)))
  4569. (dc3 (downcase (match-string 3)))
  4570. end end1 quoting block-type ovl)
  4571. (cond
  4572. ((member dc1 '("html:" "ascii:" "latex:" "docbook:"))
  4573. ;; a single line of backend-specific content
  4574. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4575. (remove-text-properties (match-beginning 0) (match-end 0)
  4576. '(display t invisible t intangible t))
  4577. (add-text-properties (match-beginning 1) (match-end 3)
  4578. '(font-lock-fontified t face org-meta-line))
  4579. (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
  4580. '(font-lock-fontified t face org-block))
  4581. ; for backend-specific code
  4582. t)
  4583. ((and (match-end 4) (equal dc3 "begin"))
  4584. ;; Truly a block
  4585. (setq block-type (downcase (match-string 5))
  4586. quoting (member block-type org-protecting-blocks))
  4587. (when (re-search-forward
  4588. (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
  4589. nil t) ;; on purpose, we look further than LIMIT
  4590. (setq end (match-end 0) end1 (1- (match-beginning 0)))
  4591. (setq block-end (match-beginning 0))
  4592. (when quoting
  4593. (remove-text-properties beg end
  4594. '(display t invisible t intangible t)))
  4595. (add-text-properties
  4596. beg end
  4597. '(font-lock-fontified t font-lock-multiline t))
  4598. (add-text-properties beg beg1 '(face org-meta-line))
  4599. (add-text-properties end1 (+ end 1) '(face org-meta-line))
  4600. ; for end_src
  4601. (cond
  4602. ((and lang org-src-fontify-natively)
  4603. (org-src-font-lock-fontify-block lang block-start block-end)
  4604. ;; remove old background overlays
  4605. (mapc (lambda (ov)
  4606. (if (eq (overlay-get ov 'face) 'org-block-background)
  4607. (delete-overlay ov)))
  4608. (overlays-at (/ (+ beg1 block-end) 2)))
  4609. ;; add a background overlay
  4610. (setq ovl (make-overlay beg1 block-end))
  4611. (overlay-put ovl 'face 'org-block-background)
  4612. (overlay-put ovl 'evaporate t)) ;; make it go away when empty
  4613. (quoting
  4614. (add-text-properties beg1 (+ end1 1) '(face org-block)))
  4615. ; end of source block
  4616. ((not org-fontify-quote-and-verse-blocks))
  4617. ((string= block-type "quote")
  4618. (add-text-properties beg1 (1+ end1) '(face org-quote)))
  4619. ((string= block-type "verse")
  4620. (add-text-properties beg1 (1+ end1) '(face org-verse))))
  4621. (add-text-properties beg beg1 '(face org-block-begin-line))
  4622. (add-text-properties (1+ end) (1+ end1) '(face org-block-end-line))
  4623. t))
  4624. ((member dc1 '("title:" "author:" "email:" "date:"))
  4625. (add-text-properties
  4626. beg (match-end 3)
  4627. (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
  4628. '(font-lock-fontified t invisible t)
  4629. '(font-lock-fontified t face org-document-info-keyword)))
  4630. (add-text-properties
  4631. (match-beginning 6) (match-end 6)
  4632. (if (string-equal dc1 "title:")
  4633. '(font-lock-fontified t face org-document-title)
  4634. '(font-lock-fontified t face org-document-info))))
  4635. ((not (member (char-after beg) '(?\ ?\t)))
  4636. ;; just any other in-buffer setting, but not indented
  4637. (add-text-properties
  4638. beg (1+ (match-end 0))
  4639. '(font-lock-fontified t face org-meta-line))
  4640. t)
  4641. ((or (member dc1 '("begin:" "end:" "caption:" "label:"
  4642. "orgtbl:" "tblfm:" "tblname:" "result:"
  4643. "results:" "source:" "srcname:" "call:"))
  4644. (and (match-end 4) (equal dc3 "attr")))
  4645. (add-text-properties
  4646. beg (match-end 0)
  4647. '(font-lock-fontified t face org-meta-line))
  4648. t)
  4649. ((member dc3 '(" " ""))
  4650. (add-text-properties
  4651. beg (match-end 0)
  4652. '(font-lock-fontified t face font-lock-comment-face)))
  4653. (t nil))))))
  4654. (defun org-activate-angle-links (limit)
  4655. "Run through the buffer and add overlays to links."
  4656. (if (re-search-forward org-angle-link-re limit t)
  4657. (progn
  4658. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4659. (add-text-properties (match-beginning 0) (match-end 0)
  4660. (list 'mouse-face 'highlight
  4661. 'keymap org-mouse-map))
  4662. (org-rear-nonsticky-at (match-end 0))
  4663. t)))
  4664. (defun org-activate-footnote-links (limit)
  4665. "Run through the buffer and add overlays to links."
  4666. (if (re-search-forward "\\(^\\|[^][]\\)\\(\\[\\([0-9]+\\]\\|fn:[^ \t\r\n:]+?[]:]\\)\\)"
  4667. limit t)
  4668. (progn
  4669. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4670. (add-text-properties (match-beginning 2) (match-end 2)
  4671. (list 'mouse-face 'highlight
  4672. 'keymap org-mouse-map
  4673. 'help-echo
  4674. (if (= (point-at-bol) (match-beginning 2))
  4675. "Footnote definition"
  4676. "Footnote reference")
  4677. ))
  4678. (org-rear-nonsticky-at (match-end 2))
  4679. t)))
  4680. (defun org-activate-bracket-links (limit)
  4681. "Run through the buffer and add overlays to bracketed links."
  4682. (if (re-search-forward org-bracket-link-regexp limit t)
  4683. (let* ((help (concat "LINK: "
  4684. (org-match-string-no-properties 1)))
  4685. ;; FIXME: above we should remove the escapes.
  4686. ;; but that requires another match, protecting match data,
  4687. ;; a lot of overhead for font-lock.
  4688. (ip (org-maybe-intangible
  4689. (list 'invisible 'org-link
  4690. 'keymap org-mouse-map 'mouse-face 'highlight
  4691. 'font-lock-multiline t 'help-echo help)))
  4692. (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
  4693. 'font-lock-multiline t 'help-echo help)))
  4694. ;; We need to remove the invisible property here. Table narrowing
  4695. ;; may have made some of this invisible.
  4696. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4697. (remove-text-properties (match-beginning 0) (match-end 0)
  4698. '(invisible nil))
  4699. (if (match-end 3)
  4700. (progn
  4701. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  4702. (org-rear-nonsticky-at (match-beginning 3))
  4703. (add-text-properties (match-beginning 3) (match-end 3) vp)
  4704. (org-rear-nonsticky-at (match-end 3))
  4705. (add-text-properties (match-end 3) (match-end 0) ip)
  4706. (org-rear-nonsticky-at (match-end 0)))
  4707. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  4708. (org-rear-nonsticky-at (match-beginning 1))
  4709. (add-text-properties (match-beginning 1) (match-end 1) vp)
  4710. (org-rear-nonsticky-at (match-end 1))
  4711. (add-text-properties (match-end 1) (match-end 0) ip)
  4712. (org-rear-nonsticky-at (match-end 0)))
  4713. t)))
  4714. (defun org-activate-dates (limit)
  4715. "Run through the buffer and add overlays to dates."
  4716. (if (re-search-forward org-tsr-regexp-both limit t)
  4717. (progn
  4718. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4719. (add-text-properties (match-beginning 0) (match-end 0)
  4720. (list 'mouse-face 'highlight
  4721. 'keymap org-mouse-map))
  4722. (org-rear-nonsticky-at (match-end 0))
  4723. (when org-display-custom-times
  4724. (if (match-end 3)
  4725. (org-display-custom-time (match-beginning 3) (match-end 3)))
  4726. (org-display-custom-time (match-beginning 1) (match-end 1)))
  4727. t)))
  4728. (defvar org-target-link-regexp nil
  4729. "Regular expression matching radio targets in plain text.")
  4730. (make-variable-buffer-local 'org-target-link-regexp)
  4731. (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
  4732. "Regular expression matching a link target.")
  4733. (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
  4734. "Regular expression matching a radio target.")
  4735. (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
  4736. "Regular expression matching any target.")
  4737. (defun org-activate-target-links (limit)
  4738. "Run through the buffer and add overlays to target matches."
  4739. (when org-target-link-regexp
  4740. (let ((case-fold-search t))
  4741. (if (re-search-forward org-target-link-regexp limit t)
  4742. (progn
  4743. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4744. (add-text-properties (match-beginning 0) (match-end 0)
  4745. (list 'mouse-face 'highlight
  4746. 'keymap org-mouse-map
  4747. 'help-echo "Radio target link"
  4748. 'org-linked-text t))
  4749. (org-rear-nonsticky-at (match-end 0))
  4750. t)))))
  4751. (defun org-update-radio-target-regexp ()
  4752. "Find all radio targets in this file and update the regular expression."
  4753. (interactive)
  4754. (when (memq 'radio org-activate-links)
  4755. (setq org-target-link-regexp
  4756. (org-make-target-link-regexp (org-all-targets 'radio)))
  4757. (org-restart-font-lock)))
  4758. (defun org-hide-wide-columns (limit)
  4759. (let (s e)
  4760. (setq s (text-property-any (point) (or limit (point-max))
  4761. 'org-cwidth t))
  4762. (when s
  4763. (setq e (next-single-property-change s 'org-cwidth))
  4764. (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
  4765. (goto-char e)
  4766. t)))
  4767. (defvar org-latex-and-specials-regexp nil
  4768. "Regular expression for highlighting export special stuff.")
  4769. (defvar org-match-substring-regexp)
  4770. (defvar org-match-substring-with-braces-regexp)
  4771. ;; This should be with the exporter code, but we also use if for font-locking
  4772. (defconst org-export-html-special-string-regexps
  4773. '(("\\\\-" . "&shy;")
  4774. ("---\\([^-]\\)" . "&mdash;\\1")
  4775. ("--\\([^-]\\)" . "&ndash;\\1")
  4776. ("\\.\\.\\." . "&hellip;"))
  4777. "Regular expressions for special string conversion.")
  4778. (defun org-compute-latex-and-specials-regexp ()
  4779. "Compute regular expression for stuff treated specially by exporters."
  4780. (if (not org-highlight-latex-fragments-and-specials)
  4781. (org-set-local 'org-latex-and-specials-regexp nil)
  4782. (require 'org-exp)
  4783. (let*
  4784. ((matchers (plist-get org-format-latex-options :matchers))
  4785. (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
  4786. org-latex-regexps)))
  4787. (org-export-allow-BIND nil)
  4788. (options (org-combine-plists (org-default-export-plist)
  4789. (org-infile-export-plist)))
  4790. (org-export-with-sub-superscripts (plist-get options :sub-superscript))
  4791. (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
  4792. (org-export-with-TeX-macros (plist-get options :TeX-macros))
  4793. (org-export-html-expand (plist-get options :expand-quoted-html))
  4794. (org-export-with-special-strings (plist-get options :special-strings))
  4795. (re-sub
  4796. (cond
  4797. ((equal org-export-with-sub-superscripts '{})
  4798. (list org-match-substring-with-braces-regexp))
  4799. (org-export-with-sub-superscripts
  4800. (list org-match-substring-regexp))
  4801. (t nil)))
  4802. (re-latex
  4803. (if org-export-with-LaTeX-fragments
  4804. (mapcar (lambda (x) (nth 1 x)) latexs)))
  4805. (re-macros
  4806. (if org-export-with-TeX-macros
  4807. (list (concat "\\\\"
  4808. (regexp-opt
  4809. (append
  4810. (delq nil
  4811. (mapcar 'car-safe
  4812. (append org-entities-user
  4813. org-entities)))
  4814. (if (boundp 'org-latex-entities)
  4815. (mapcar (lambda (x)
  4816. (or (car-safe x) x))
  4817. org-latex-entities)
  4818. nil))
  4819. 'words))) ; FIXME
  4820. ))
  4821. ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
  4822. (re-special (if org-export-with-special-strings
  4823. (mapcar (lambda (x) (car x))
  4824. org-export-html-special-string-regexps)))
  4825. (re-rest
  4826. (delq nil
  4827. (list
  4828. (if org-export-html-expand "@<[^>\n]+>")
  4829. ))))
  4830. (org-set-local
  4831. 'org-latex-and-specials-regexp
  4832. (mapconcat 'identity (append re-latex re-sub re-macros re-special
  4833. re-rest) "\\|")))))
  4834. (defun org-do-latex-and-special-faces (limit)
  4835. "Run through the buffer and add overlays to links."
  4836. (when org-latex-and-specials-regexp
  4837. (let (rtn d)
  4838. (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
  4839. limit t))
  4840. (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
  4841. 'face))
  4842. '(org-code org-verbatim underline)))
  4843. (progn
  4844. (setq rtn t
  4845. d (cond ((member (char-after (1+ (match-beginning 0)))
  4846. '(?_ ?^)) 1)
  4847. (t 0)))
  4848. (font-lock-prepend-text-property
  4849. (+ d (match-beginning 0)) (match-end 0)
  4850. 'face 'org-latex-and-export-specials)
  4851. (add-text-properties (+ d (match-beginning 0)) (match-end 0)
  4852. '(font-lock-multiline t)))))
  4853. rtn)))
  4854. (defun org-restart-font-lock ()
  4855. "Restart `font-lock-mode', to force refontification."
  4856. (when (and (boundp 'font-lock-mode) font-lock-mode)
  4857. (font-lock-mode -1)
  4858. (font-lock-mode 1)))
  4859. (defun org-all-targets (&optional radio)
  4860. "Return a list of all targets in this file.
  4861. With optional argument RADIO, only find radio targets."
  4862. (let ((re (if radio org-radio-target-regexp org-target-regexp))
  4863. rtn)
  4864. (save-excursion
  4865. (goto-char (point-min))
  4866. (while (re-search-forward re nil t)
  4867. (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
  4868. rtn)))
  4869. (defun org-make-target-link-regexp (targets)
  4870. "Make regular expression matching all strings in TARGETS.
  4871. The regular expression finds the targets also if there is a line break
  4872. between words."
  4873. (and targets
  4874. (concat
  4875. "\\<\\("
  4876. (mapconcat
  4877. (lambda (x)
  4878. (setq x (regexp-quote x))
  4879. (while (string-match " +" x)
  4880. (setq x (replace-match "\\s-+" t t x)))
  4881. x)
  4882. targets
  4883. "\\|")
  4884. "\\)\\>")))
  4885. (defun org-activate-tags (limit)
  4886. (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
  4887. (progn
  4888. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  4889. (add-text-properties (match-beginning 1) (match-end 1)
  4890. (list 'mouse-face 'highlight
  4891. 'keymap org-mouse-map))
  4892. (org-rear-nonsticky-at (match-end 1))
  4893. t)))
  4894. (defun org-outline-level ()
  4895. "Compute the outline level of the heading at point.
  4896. This function assumes that the cursor is at the beginning of a line matched
  4897. by `outline-regexp'. Otherwise it returns garbage.
  4898. If this is called at a normal headline, the level is the number of stars.
  4899. Use `org-reduced-level' to remove the effect of `org-odd-levels'."
  4900. (save-excursion
  4901. (looking-at outline-regexp)
  4902. (1- (- (match-end 0) (match-beginning 0)))))
  4903. (defvar org-font-lock-keywords nil)
  4904. (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
  4905. "Regular expression matching a property line.")
  4906. (defvar org-font-lock-hook nil
  4907. "Functions to be called for special font lock stuff.")
  4908. (defvar org-font-lock-set-keywords-hook nil
  4909. "Functions that can manipulate `org-font-lock-extra-keywords'.
  4910. This is calles after `org-font-lock-extra-keywords' is defined, but before
  4911. it is installed to be used by font lock. This can be useful if something
  4912. needs to be inserted at a specific position in the font-lock sequence.")
  4913. (defun org-font-lock-hook (limit)
  4914. (run-hook-with-args 'org-font-lock-hook limit))
  4915. (defun org-set-font-lock-defaults ()
  4916. (let* ((em org-fontify-emphasized-text)
  4917. (lk org-activate-links)
  4918. (org-font-lock-extra-keywords
  4919. (list
  4920. ;; Call the hook
  4921. '(org-font-lock-hook)
  4922. ;; Headlines
  4923. `(,(if org-fontify-whole-heading-line
  4924. "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
  4925. "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
  4926. (1 (org-get-level-face 1))
  4927. (2 (org-get-level-face 2))
  4928. (3 (org-get-level-face 3)))
  4929. ;; Table lines
  4930. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  4931. (1 'org-table t))
  4932. ;; Table internals
  4933. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  4934. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  4935. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  4936. '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
  4937. ;; Drawers
  4938. (list org-drawer-regexp '(0 'org-special-keyword t))
  4939. (list "^[ \t]*:END:" '(0 'org-special-keyword t))
  4940. ;; Properties
  4941. (list org-property-re
  4942. '(1 'org-special-keyword t)
  4943. '(3 'org-property-value t))
  4944. ;; Links
  4945. (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  4946. (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  4947. (if (memq 'plain lk) '(org-activate-plain-links))
  4948. (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
  4949. (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
  4950. (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  4951. (if (memq 'footnote lk) '(org-activate-footnote-links
  4952. (2 'org-footnote t)))
  4953. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  4954. '(org-hide-wide-columns (0 nil append))
  4955. ;; TODO lines
  4956. (list (concat "^\\*+[ \t]+" org-todo-regexp "\\([ \t]\\|$\\)")
  4957. '(1 (org-get-todo-face 1) t))
  4958. ;; DONE
  4959. (if org-fontify-done-headline
  4960. (list (concat "^[*]+ +\\<\\("
  4961. (mapconcat 'regexp-quote org-done-keywords "\\|")
  4962. "\\)\\(.*\\)")
  4963. '(2 'org-headline-done t))
  4964. nil)
  4965. ;; Priorities
  4966. '(org-font-lock-add-priority-faces)
  4967. ;; Tags
  4968. '(org-font-lock-add-tag-faces)
  4969. ;; Special keywords
  4970. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  4971. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  4972. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  4973. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  4974. ;; Emphasis
  4975. (if em
  4976. (if (featurep 'xemacs)
  4977. '(org-do-emphasis-faces (0 nil append))
  4978. '(org-do-emphasis-faces)))
  4979. ;; Checkboxes
  4980. '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
  4981. 1 'org-checkbox prepend)
  4982. (if (cdr (assq 'checkbox org-list-automatic-rules))
  4983. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  4984. (0 (org-get-checkbox-statistics-face) t)))
  4985. ;; Description list items
  4986. '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
  4987. 1 'bold prepend)
  4988. ;; ARCHIVEd headings
  4989. (list (concat "^\\*+ \\(.*:" org-archive-tag ":.*\\)")
  4990. '(1 'org-archived prepend))
  4991. ;; Specials
  4992. '(org-do-latex-and-special-faces)
  4993. '(org-fontify-entities)
  4994. '(org-raise-scripts)
  4995. ;; Code
  4996. '(org-activate-code (1 'org-code t))
  4997. ;; COMMENT
  4998. (list (concat "^\\*+[ \t]+\\<\\(" org-comment-string
  4999. "\\|" org-quote-string "\\)\\>")
  5000. '(1 'org-special-keyword t))
  5001. '("^#.*" (0 'font-lock-comment-face t))
  5002. ;; Blocks and meta lines
  5003. '(org-fontify-meta-lines-and-blocks)
  5004. )))
  5005. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  5006. (run-hooks 'org-font-lock-set-keywords-hook)
  5007. ;; Now set the full font-lock-keywords
  5008. (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
  5009. (org-set-local 'font-lock-defaults
  5010. '(org-font-lock-keywords t nil nil backward-paragraph))
  5011. (kill-local-variable 'font-lock-keywords) nil))
  5012. (defun org-toggle-pretty-entities ()
  5013. "Toggle the composition display of entities as UTF8 characters."
  5014. (interactive)
  5015. (org-set-local 'org-pretty-entities (not org-pretty-entities))
  5016. (org-restart-font-lock)
  5017. (if org-pretty-entities
  5018. (message "Entities are displayed as UTF8 characers")
  5019. (save-restriction
  5020. (widen)
  5021. (org-decompose-region (point-min) (point-max))
  5022. (message "Entities are displayed plain"))))
  5023. (defun org-fontify-entities (limit)
  5024. "Find an entity to fontify."
  5025. (let (ee)
  5026. (when org-pretty-entities
  5027. (catch 'match
  5028. (while (re-search-forward
  5029. "\\\\\\([a-zA-Z][a-zA-Z0-9]*\\)\\($\\|[^[:alnum:]\n]\\)"
  5030. limit t)
  5031. (if (and (not (org-in-indented-comment-line))
  5032. (setq ee (org-entity-get (match-string 1)))
  5033. (= (length (nth 6 ee)) 1))
  5034. (progn
  5035. (add-text-properties
  5036. (match-beginning 0) (match-end 1)
  5037. (list 'font-lock-fontified t))
  5038. (compose-region (match-beginning 0) (match-end 1)
  5039. (nth 6 ee) nil)
  5040. (backward-char 1)
  5041. (throw 'match t))))
  5042. nil))))
  5043. (defun org-fontify-like-in-org-mode (s &optional odd-levels)
  5044. "Fontify string S like in Org-mode."
  5045. (with-temp-buffer
  5046. (insert s)
  5047. (let ((org-odd-levels-only odd-levels))
  5048. (org-mode)
  5049. (font-lock-fontify-buffer)
  5050. (buffer-string))))
  5051. (defvar org-m nil)
  5052. (defvar org-l nil)
  5053. (defvar org-f nil)
  5054. (defun org-get-level-face (n)
  5055. "Get the right face for match N in font-lock matching of headlines."
  5056. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  5057. (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  5058. (if org-cycle-level-faces
  5059. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  5060. (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
  5061. (cond
  5062. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  5063. ((eq n 2) org-f)
  5064. (t (if org-level-color-stars-only nil org-f))))
  5065. (defun org-get-todo-face (kwd)
  5066. "Get the right face for a TODO keyword KWD.
  5067. If KWD is a number, get the corresponding match group."
  5068. (if (numberp kwd) (setq kwd (match-string kwd)))
  5069. (or (org-face-from-face-or-color
  5070. 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
  5071. (and (member kwd org-done-keywords) 'org-done)
  5072. 'org-todo))
  5073. (defun org-face-from-face-or-color (context inherit face-or-color)
  5074. "Create a face list that inherits INHERIT, but sets the foreground color.
  5075. When FACE-OR-COLOR is not a string, just return it."
  5076. (if (stringp face-or-color)
  5077. (list :inherit inherit
  5078. (cdr (assoc context org-faces-easy-properties))
  5079. face-or-color)
  5080. face-or-color))
  5081. (defun org-font-lock-add-tag-faces (limit)
  5082. "Add the special tag faces."
  5083. (when (and org-tag-faces org-tags-special-faces-re)
  5084. (while (re-search-forward org-tags-special-faces-re limit t)
  5085. (add-text-properties (match-beginning 1) (match-end 1)
  5086. (list 'face (org-get-tag-face 1)
  5087. 'font-lock-fontified t))
  5088. (backward-char 1))))
  5089. (defun org-font-lock-add-priority-faces (limit)
  5090. "Add the special priority faces."
  5091. (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
  5092. (add-text-properties
  5093. (match-beginning 0) (match-end 0)
  5094. (list 'face (or (org-face-from-face-or-color
  5095. 'priority 'org-special-keyword
  5096. (cdr (assoc (char-after (match-beginning 1))
  5097. org-priority-faces)))
  5098. 'org-special-keyword)
  5099. 'font-lock-fontified t))))
  5100. (defun org-get-tag-face (kwd)
  5101. "Get the right face for a TODO keyword KWD.
  5102. If KWD is a number, get the corresponding match group."
  5103. (if (numberp kwd) (setq kwd (match-string kwd)))
  5104. (or (org-face-from-face-or-color
  5105. 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
  5106. 'org-tag))
  5107. (defun org-unfontify-region (beg end &optional maybe_loudly)
  5108. "Remove fontification and activation overlays from links."
  5109. (font-lock-default-unfontify-region beg end)
  5110. (let* ((buffer-undo-list t)
  5111. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  5112. (inhibit-modification-hooks t)
  5113. deactivate-mark buffer-file-name buffer-file-truename)
  5114. (org-decompose-region beg end)
  5115. (remove-text-properties
  5116. beg end
  5117. (if org-indent-mode
  5118. ;; also remove line-prefix and wrap-prefix properties
  5119. '(mouse-face t keymap t org-linked-text t
  5120. invisible t intangible t
  5121. line-prefix t wrap-prefix t
  5122. org-no-flyspell t org-emphasis t)
  5123. '(mouse-face t keymap t org-linked-text t
  5124. invisible t intangible t
  5125. org-no-flyspell t org-emphasis t)))
  5126. (org-remove-font-lock-display-properties beg end)))
  5127. (defconst org-script-display '(((raise -0.3) (height 0.7))
  5128. ((raise 0.3) (height 0.7))
  5129. ((raise -0.5))
  5130. ((raise 0.5)))
  5131. "Display properties for showing superscripts and subscripts.")
  5132. (defun org-remove-font-lock-display-properties (beg end)
  5133. "Remove specific display properties that have been added by font lock.
  5134. The will remove the raise properties that are used to show superscripts
  5135. and subscripts."
  5136. (let (next prop)
  5137. (while (< beg end)
  5138. (setq next (next-single-property-change beg 'display nil end)
  5139. prop (get-text-property beg 'display))
  5140. (if (member prop org-script-display)
  5141. (put-text-property beg next 'display nil))
  5142. (setq beg next))))
  5143. (defun org-raise-scripts (limit)
  5144. "Add raise properties to sub/superscripts."
  5145. (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
  5146. (if (re-search-forward
  5147. (if (eq org-use-sub-superscripts t)
  5148. org-match-substring-regexp
  5149. org-match-substring-with-braces-regexp)
  5150. limit t)
  5151. (let* ((pos (point)) table-p comment-p
  5152. (mpos (match-beginning 3))
  5153. (emph-p (get-text-property mpos 'org-emphasis))
  5154. (link-p (get-text-property mpos 'mouse-face))
  5155. (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
  5156. (goto-char (point-at-bol))
  5157. (setq table-p (org-looking-at-p org-table-dataline-regexp)
  5158. comment-p (org-looking-at-p "[ \t]*#"))
  5159. (goto-char pos)
  5160. ;; FIXME: Should we go back one character here, for a_b^c
  5161. ;; (goto-char (1- pos)) ;????????????????????
  5162. (if (or comment-p emph-p link-p keyw-p)
  5163. t
  5164. (put-text-property (match-beginning 3) (match-end 0)
  5165. 'display
  5166. (if (equal (char-after (match-beginning 2)) ?^)
  5167. (nth (if table-p 3 1) org-script-display)
  5168. (nth (if table-p 2 0) org-script-display)))
  5169. (add-text-properties (match-beginning 2) (match-end 2)
  5170. (list 'invisible t
  5171. 'org-dwidth t 'org-dwidth-n 1))
  5172. (if (and (eq (char-after (match-beginning 3)) ?{)
  5173. (eq (char-before (match-end 3)) ?}))
  5174. (progn
  5175. (add-text-properties
  5176. (match-beginning 3) (1+ (match-beginning 3))
  5177. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
  5178. (add-text-properties
  5179. (1- (match-end 3)) (match-end 3)
  5180. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
  5181. t)))))
  5182. ;;;; Visibility cycling, including org-goto and indirect buffer
  5183. ;;; Cycling
  5184. (defvar org-cycle-global-status nil)
  5185. (make-variable-buffer-local 'org-cycle-global-status)
  5186. (defvar org-cycle-subtree-status nil)
  5187. (make-variable-buffer-local 'org-cycle-subtree-status)
  5188. ;;;###autoload
  5189. (defvar org-inlinetask-min-level)
  5190. (defun org-cycle (&optional arg)
  5191. "TAB-action and visibility cycling for Org-mode.
  5192. This is the command invoked in Org-mode by the TAB key. Its main purpose
  5193. is outline visibility cycling, but it also invokes other actions
  5194. in special contexts.
  5195. - When this function is called with a prefix argument, rotate the entire
  5196. buffer through 3 states (global cycling)
  5197. 1. OVERVIEW: Show only top-level headlines.
  5198. 2. CONTENTS: Show all headlines of all levels, but no body text.
  5199. 3. SHOW ALL: Show everything.
  5200. When called with two `C-u C-u' prefixes, switch to the startup visibility,
  5201. determined by the variable `org-startup-folded', and by any VISIBILITY
  5202. properties in the buffer.
  5203. When called with three `C-u C-u C-u' prefixed, show the entire buffer,
  5204. including any drawers.
  5205. - When inside a table, re-align the table and move to the next field.
  5206. - When point is at the beginning of a headline, rotate the subtree started
  5207. by this line through 3 different states (local cycling)
  5208. 1. FOLDED: Only the main headline is shown.
  5209. 2. CHILDREN: The main headline and the direct children are shown.
  5210. From this state, you can move to one of the children
  5211. and zoom in further.
  5212. 3. SUBTREE: Show the entire subtree, including body text.
  5213. If there is no subtree, switch directly from CHILDREN to FOLDED.
  5214. - When point is at the beginning of an empty headline and the variable
  5215. `org-cycle-level-after-item/entry-creation' is set, cycle the level
  5216. of the headline by demoting and promoting it to likely levels. This
  5217. speeds up creation document structure by pressing TAB once or several
  5218. times right after creating a new headline.
  5219. - When there is a numeric prefix, go up to a heading with level ARG, do
  5220. a `show-subtree' and return to the previous cursor position. If ARG
  5221. is negative, go up that many levels.
  5222. - When point is not at the beginning of a headline, execute the global
  5223. binding for TAB, which is re-indenting the line. See the option
  5224. `org-cycle-emulate-tab' for details.
  5225. - Special case: if point is at the beginning of the buffer and there is
  5226. no headline in line 1, this function will act as if called with prefix arg
  5227. (C-u TAB, same as S-TAB) also when called without prefix arg.
  5228. But only if also the variable `org-cycle-global-at-bob' is t."
  5229. (interactive "P")
  5230. (org-load-modules-maybe)
  5231. (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
  5232. (and org-cycle-level-after-item/entry-creation
  5233. (or (org-cycle-level)
  5234. (org-cycle-item-indentation))))
  5235. (let* ((limit-level
  5236. (or org-cycle-max-level
  5237. (and (boundp 'org-inlinetask-min-level)
  5238. org-inlinetask-min-level
  5239. (1- org-inlinetask-min-level))))
  5240. (nstars (and limit-level
  5241. (if org-odd-levels-only
  5242. (and limit-level (1- (* limit-level 2)))
  5243. limit-level)))
  5244. (outline-regexp
  5245. (if (not (org-mode-p))
  5246. outline-regexp
  5247. (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
  5248. (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
  5249. (not (looking-at outline-regexp))))
  5250. (org-cycle-hook
  5251. (if bob-special
  5252. (delq 'org-optimize-window-after-visibility-change
  5253. (copy-sequence org-cycle-hook))
  5254. org-cycle-hook))
  5255. (pos (point)))
  5256. (if (or bob-special (equal arg '(4)))
  5257. ;; special case: use global cycling
  5258. (setq arg t))
  5259. (cond
  5260. ((equal arg '(16))
  5261. (setq last-command 'dummy)
  5262. (org-set-startup-visibility)
  5263. (message "Startup visibility, plus VISIBILITY properties"))
  5264. ((equal arg '(64))
  5265. (show-all)
  5266. (message "Entire buffer visible, including drawers"))
  5267. ;; Table: enter it or move to the next field.
  5268. ((org-at-table-p 'any)
  5269. (if (org-at-table.el-p)
  5270. (message "Use C-c ' to edit table.el tables")
  5271. (if arg (org-table-edit-field t)
  5272. (org-table-justify-field-maybe)
  5273. (call-interactively 'org-table-next-field))))
  5274. ((run-hook-with-args-until-success
  5275. 'org-tab-after-check-for-table-hook))
  5276. ;; Global cycling: delegate to `org-cycle-internal-global'.
  5277. ((eq arg t) (org-cycle-internal-global))
  5278. ;; Drawers: delegate to `org-flag-drawer'.
  5279. ((and org-drawers org-drawer-regexp
  5280. (save-excursion
  5281. (beginning-of-line 1)
  5282. (looking-at org-drawer-regexp)))
  5283. (org-flag-drawer ; toggle block visibility
  5284. (not (get-char-property (match-end 0) 'invisible))))
  5285. ;; Show-subtree, ARG levels up from here.
  5286. ((integerp arg)
  5287. (save-excursion
  5288. (org-back-to-heading)
  5289. (outline-up-heading (if (< arg 0) (- arg)
  5290. (- (funcall outline-level) arg)))
  5291. (org-show-subtree)))
  5292. ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
  5293. ((and (featurep 'org-inlinetask)
  5294. (org-inlinetask-at-task-p)
  5295. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5296. (org-inlinetask-toggle-visibility))
  5297. ;; At an item/headline: delegate to `org-cycle-internal-local'.
  5298. ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
  5299. (save-excursion (beginning-of-line 1)
  5300. (looking-at outline-regexp)))
  5301. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5302. (org-cycle-internal-local))
  5303. ;; From there: TAB emulation and template completion.
  5304. (buffer-read-only (org-back-to-heading))
  5305. ((run-hook-with-args-until-success
  5306. 'org-tab-after-check-for-cycling-hook))
  5307. ((org-try-structure-completion))
  5308. ((org-try-cdlatex-tab))
  5309. ((run-hook-with-args-until-success
  5310. 'org-tab-before-tab-emulation-hook))
  5311. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  5312. (or (not (bolp))
  5313. (not (looking-at outline-regexp))))
  5314. (call-interactively (global-key-binding "\t")))
  5315. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  5316. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  5317. (or (and (eq org-cycle-emulate-tab 'white)
  5318. (= (match-end 0) (point-at-eol)))
  5319. (and (eq org-cycle-emulate-tab 'whitestart)
  5320. (>= (match-end 0) pos))))
  5321. t
  5322. (eq org-cycle-emulate-tab t))
  5323. (call-interactively (global-key-binding "\t")))
  5324. (t (save-excursion
  5325. (org-back-to-heading)
  5326. (org-cycle)))))))
  5327. (defun org-cycle-internal-global ()
  5328. "Do the global cycling action."
  5329. (cond
  5330. ((and (eq last-command this-command)
  5331. (eq org-cycle-global-status 'overview))
  5332. ;; We just created the overview - now do table of contents
  5333. ;; This can be slow in very large buffers, so indicate action
  5334. (run-hook-with-args 'org-pre-cycle-hook 'contents)
  5335. (message "CONTENTS...")
  5336. (org-content)
  5337. (message "CONTENTS...done")
  5338. (setq org-cycle-global-status 'contents)
  5339. (run-hook-with-args 'org-cycle-hook 'contents))
  5340. ((and (eq last-command this-command)
  5341. (eq org-cycle-global-status 'contents))
  5342. ;; We just showed the table of contents - now show everything
  5343. (run-hook-with-args 'org-pre-cycle-hook 'all)
  5344. (show-all)
  5345. (message "SHOW ALL")
  5346. (setq org-cycle-global-status 'all)
  5347. (run-hook-with-args 'org-cycle-hook 'all))
  5348. (t
  5349. ;; Default action: go to overview
  5350. (run-hook-with-args 'org-pre-cycle-hook 'overview)
  5351. (org-overview)
  5352. (message "OVERVIEW")
  5353. (setq org-cycle-global-status 'overview)
  5354. (run-hook-with-args 'org-cycle-hook 'overview))))
  5355. (defun org-cycle-internal-local ()
  5356. "Do the local cycling action."
  5357. (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
  5358. ;; First, determine end of headline (EOH), end of subtree or item
  5359. ;; (EOS), and if item or heading has children (HAS-CHILDREN).
  5360. (save-excursion
  5361. (if (org-at-item-p)
  5362. (progn
  5363. (beginning-of-line)
  5364. (setq struct (org-list-struct))
  5365. (setq eoh (point-at-eol))
  5366. (setq eos (org-list-get-item-end-before-blank (point) struct))
  5367. (setq has-children (org-list-has-child-p (point) struct)))
  5368. (org-back-to-heading)
  5369. (setq eoh (save-excursion (outline-end-of-heading) (point)))
  5370. (setq eos (save-excursion
  5371. (org-end-of-subtree t)
  5372. (unless (eobp)
  5373. (skip-chars-forward " \t\n"))
  5374. (if (eobp) (point) (1- (point)))))
  5375. (setq has-children
  5376. (or (save-excursion
  5377. (let ((level (funcall outline-level)))
  5378. (outline-next-heading)
  5379. (and (org-at-heading-p t)
  5380. (> (funcall outline-level) level))))
  5381. (save-excursion
  5382. (org-list-search-forward (org-item-beginning-re) eos t)))))
  5383. ;; Determine end invisible part of buffer (EOL)
  5384. (beginning-of-line 2)
  5385. ;; XEmacs doesn't have `next-single-char-property-change'
  5386. (if (featurep 'xemacs)
  5387. (while (and (not (eobp)) ;; this is like `next-line'
  5388. (get-char-property (1- (point)) 'invisible))
  5389. (beginning-of-line 2))
  5390. (while (and (not (eobp)) ;; this is like `next-line'
  5391. (get-char-property (1- (point)) 'invisible))
  5392. (goto-char (next-single-char-property-change (point) 'invisible))
  5393. (and (eolp) (beginning-of-line 2))))
  5394. (setq eol (point)))
  5395. ;; Find out what to do next and set `this-command'
  5396. (cond
  5397. ((= eos eoh)
  5398. ;; Nothing is hidden behind this heading
  5399. (run-hook-with-args 'org-pre-cycle-hook 'empty)
  5400. (message "EMPTY ENTRY")
  5401. (setq org-cycle-subtree-status nil)
  5402. (save-excursion
  5403. (goto-char eos)
  5404. (outline-next-heading)
  5405. (if (outline-invisible-p) (org-flag-heading nil))))
  5406. ((and (or (>= eol eos)
  5407. (not (string-match "\\S-" (buffer-substring eol eos))))
  5408. (or has-children
  5409. (not (setq children-skipped
  5410. org-cycle-skip-children-state-if-no-children))))
  5411. ;; Entire subtree is hidden in one line: children view
  5412. (run-hook-with-args 'org-pre-cycle-hook 'children)
  5413. (if (org-at-item-p)
  5414. (org-list-set-item-visibility (point-at-bol) struct 'children)
  5415. (org-show-entry)
  5416. (show-children)
  5417. ;; Fold every list in subtree to top-level items.
  5418. (when (eq org-cycle-include-plain-lists 'integrate)
  5419. (save-excursion
  5420. (org-back-to-heading)
  5421. (while (org-list-search-forward (org-item-beginning-re) eos t)
  5422. (beginning-of-line 1)
  5423. (let* ((struct (org-list-struct))
  5424. (prevs (org-list-prevs-alist struct))
  5425. (end (org-list-get-bottom-point struct)))
  5426. (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
  5427. (org-list-get-all-items (point) struct prevs))
  5428. (goto-char end))))))
  5429. (message "CHILDREN")
  5430. (save-excursion
  5431. (goto-char eos)
  5432. (outline-next-heading)
  5433. (if (outline-invisible-p) (org-flag-heading nil)))
  5434. (setq org-cycle-subtree-status 'children)
  5435. (run-hook-with-args 'org-cycle-hook 'children))
  5436. ((or children-skipped
  5437. (and (eq last-command this-command)
  5438. (eq org-cycle-subtree-status 'children)))
  5439. ;; We just showed the children, or no children are there,
  5440. ;; now show everything.
  5441. (run-hook-with-args 'org-pre-cycle-hook 'subtree)
  5442. (outline-flag-region eoh eos nil)
  5443. (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
  5444. (setq org-cycle-subtree-status 'subtree)
  5445. (run-hook-with-args 'org-cycle-hook 'subtree))
  5446. (t
  5447. ;; Default action: hide the subtree.
  5448. (run-hook-with-args 'org-pre-cycle-hook 'folded)
  5449. (outline-flag-region eoh eos t)
  5450. (message "FOLDED")
  5451. (setq org-cycle-subtree-status 'folded)
  5452. (run-hook-with-args 'org-cycle-hook 'folded)))))
  5453. ;;;###autoload
  5454. (defun org-global-cycle (&optional arg)
  5455. "Cycle the global visibility. For details see `org-cycle'.
  5456. With \\[universal-argument] prefix arg, switch to startup visibility.
  5457. With a numeric prefix, show all headlines up to that level."
  5458. (interactive "P")
  5459. (let ((org-cycle-include-plain-lists
  5460. (if (org-mode-p) org-cycle-include-plain-lists nil)))
  5461. (cond
  5462. ((integerp arg)
  5463. (show-all)
  5464. (hide-sublevels arg)
  5465. (setq org-cycle-global-status 'contents))
  5466. ((equal arg '(4))
  5467. (org-set-startup-visibility)
  5468. (message "Startup visibility, plus VISIBILITY properties."))
  5469. (t
  5470. (org-cycle '(4))))))
  5471. (defun org-set-startup-visibility ()
  5472. "Set the visibility required by startup options and properties."
  5473. (cond
  5474. ((eq org-startup-folded t)
  5475. (org-cycle '(4)))
  5476. ((eq org-startup-folded 'content)
  5477. (let ((this-command 'org-cycle) (last-command 'org-cycle))
  5478. (org-cycle '(4)) (org-cycle '(4)))))
  5479. (unless (eq org-startup-folded 'showeverything)
  5480. (if org-hide-block-startup (org-hide-block-all))
  5481. (org-set-visibility-according-to-property 'no-cleanup)
  5482. (org-cycle-hide-archived-subtrees 'all)
  5483. (org-cycle-hide-drawers 'all)
  5484. (org-cycle-show-empty-lines t)))
  5485. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  5486. "Switch subtree visibilities according to :VISIBILITY: property."
  5487. (interactive)
  5488. (let (org-show-entry-below state)
  5489. (save-excursion
  5490. (goto-char (point-min))
  5491. (while (re-search-forward
  5492. "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
  5493. nil t)
  5494. (setq state (match-string 1))
  5495. (save-excursion
  5496. (org-back-to-heading t)
  5497. (hide-subtree)
  5498. (org-reveal)
  5499. (cond
  5500. ((equal state '("fold" "folded"))
  5501. (hide-subtree))
  5502. ((equal state "children")
  5503. (org-show-hidden-entry)
  5504. (show-children))
  5505. ((equal state "content")
  5506. (save-excursion
  5507. (save-restriction
  5508. (org-narrow-to-subtree)
  5509. (org-content))))
  5510. ((member state '("all" "showall"))
  5511. (show-subtree)))))
  5512. (unless no-cleanup
  5513. (org-cycle-hide-archived-subtrees 'all)
  5514. (org-cycle-hide-drawers 'all)
  5515. (org-cycle-show-empty-lines 'all)))))
  5516. (defun org-overview ()
  5517. "Switch to overview mode, showing only top-level headlines.
  5518. Really, this shows all headlines with level equal or greater than the level
  5519. of the first headline in the buffer. This is important, because if the
  5520. first headline is not level one, then (hide-sublevels 1) gives confusing
  5521. results."
  5522. (interactive)
  5523. (let ((level (save-excursion
  5524. (goto-char (point-min))
  5525. (if (re-search-forward (concat "^" outline-regexp) nil t)
  5526. (progn
  5527. (goto-char (match-beginning 0))
  5528. (funcall outline-level))))))
  5529. (and level (hide-sublevels level))))
  5530. (defun org-content (&optional arg)
  5531. "Show all headlines in the buffer, like a table of contents.
  5532. With numerical argument N, show content up to level N."
  5533. (interactive "P")
  5534. (save-excursion
  5535. ;; Visit all headings and show their offspring
  5536. (and (integerp arg) (org-overview))
  5537. (goto-char (point-max))
  5538. (catch 'exit
  5539. (while (and (progn (condition-case nil
  5540. (outline-previous-visible-heading 1)
  5541. (error (goto-char (point-min))))
  5542. t)
  5543. (looking-at outline-regexp))
  5544. (if (integerp arg)
  5545. (show-children (1- arg))
  5546. (show-branches))
  5547. (if (bobp) (throw 'exit nil))))))
  5548. (defun org-optimize-window-after-visibility-change (state)
  5549. "Adjust the window after a change in outline visibility.
  5550. This function is the default value of the hook `org-cycle-hook'."
  5551. (when (get-buffer-window (current-buffer))
  5552. (cond
  5553. ((eq state 'content) nil)
  5554. ((eq state 'all) nil)
  5555. ((eq state 'folded) nil)
  5556. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  5557. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  5558. (defun org-remove-empty-overlays-at (pos)
  5559. "Remove outline overlays that do not contain non-white stuff."
  5560. (mapc
  5561. (lambda (o)
  5562. (and (eq 'outline (overlay-get o 'invisible))
  5563. (not (string-match "\\S-" (buffer-substring (overlay-start o)
  5564. (overlay-end o))))
  5565. (delete-overlay o)))
  5566. (overlays-at pos)))
  5567. (defun org-clean-visibility-after-subtree-move ()
  5568. "Fix visibility issues after moving a subtree."
  5569. ;; First, find a reasonable region to look at:
  5570. ;; Start two siblings above, end three below
  5571. (let* ((beg (save-excursion
  5572. (and (org-get-last-sibling)
  5573. (org-get-last-sibling))
  5574. (point)))
  5575. (end (save-excursion
  5576. (and (org-get-next-sibling)
  5577. (org-get-next-sibling)
  5578. (org-get-next-sibling))
  5579. (if (org-at-heading-p)
  5580. (point-at-eol)
  5581. (point))))
  5582. (level (looking-at "\\*+"))
  5583. (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
  5584. (save-excursion
  5585. (save-restriction
  5586. (narrow-to-region beg end)
  5587. (when re
  5588. ;; Properly fold already folded siblings
  5589. (goto-char (point-min))
  5590. (while (re-search-forward re nil t)
  5591. (if (and (not (outline-invisible-p))
  5592. (save-excursion
  5593. (goto-char (point-at-eol)) (outline-invisible-p)))
  5594. (hide-entry))))
  5595. (org-cycle-show-empty-lines 'overview)
  5596. (org-cycle-hide-drawers 'overview)))))
  5597. (defun org-cycle-show-empty-lines (state)
  5598. "Show empty lines above all visible headlines.
  5599. The region to be covered depends on STATE when called through
  5600. `org-cycle-hook'. Lisp program can use t for STATE to get the
  5601. entire buffer covered. Note that an empty line is only shown if there
  5602. are at least `org-cycle-separator-lines' empty lines before the headline."
  5603. (when (not (= org-cycle-separator-lines 0))
  5604. (save-excursion
  5605. (let* ((n (abs org-cycle-separator-lines))
  5606. (re (cond
  5607. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  5608. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  5609. (t (let ((ns (number-to-string (- n 2))))
  5610. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  5611. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  5612. beg end b e)
  5613. (cond
  5614. ((memq state '(overview contents t))
  5615. (setq beg (point-min) end (point-max)))
  5616. ((memq state '(children folded))
  5617. (setq beg (point) end (progn (org-end-of-subtree t t)
  5618. (beginning-of-line 2)
  5619. (point)))))
  5620. (when beg
  5621. (goto-char beg)
  5622. (while (re-search-forward re end t)
  5623. (unless (get-char-property (match-end 1) 'invisible)
  5624. (setq e (match-end 1))
  5625. (if (< org-cycle-separator-lines 0)
  5626. (setq b (save-excursion
  5627. (goto-char (match-beginning 0))
  5628. (org-back-over-empty-lines)
  5629. (if (save-excursion
  5630. (goto-char (max (point-min) (1- (point))))
  5631. (org-on-heading-p))
  5632. (1- (point))
  5633. (point))))
  5634. (setq b (match-beginning 1)))
  5635. (outline-flag-region b e nil)))))))
  5636. ;; Never hide empty lines at the end of the file.
  5637. (save-excursion
  5638. (goto-char (point-max))
  5639. (outline-previous-heading)
  5640. (outline-end-of-heading)
  5641. (if (and (looking-at "[ \t\n]+")
  5642. (= (match-end 0) (point-max)))
  5643. (outline-flag-region (point) (match-end 0) nil))))
  5644. (defun org-show-empty-lines-in-parent ()
  5645. "Move to the parent and re-show empty lines before visible headlines."
  5646. (save-excursion
  5647. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  5648. (org-cycle-show-empty-lines context))))
  5649. (defun org-files-list ()
  5650. "Return `org-agenda-files' list, plus all open org-mode files.
  5651. This is useful for operations that need to scan all of a user's
  5652. open and agenda-wise Org files."
  5653. (let ((files (mapcar 'expand-file-name (org-agenda-files))))
  5654. (dolist (buf (buffer-list))
  5655. (with-current-buffer buf
  5656. (if (and (org-mode-p) (buffer-file-name))
  5657. (let ((file (expand-file-name (buffer-file-name))))
  5658. (unless (member file files)
  5659. (push file files))))))
  5660. files))
  5661. (defsubst org-entry-beginning-position ()
  5662. "Return the beginning position of the current entry."
  5663. (save-excursion (outline-back-to-heading t) (point)))
  5664. (defsubst org-entry-end-position ()
  5665. "Return the end position of the current entry."
  5666. (save-excursion (outline-next-heading) (point)))
  5667. (defun org-cycle-hide-drawers (state)
  5668. "Re-hide all drawers after a visibility state change."
  5669. (when (and (org-mode-p)
  5670. (not (memq state '(overview folded contents))))
  5671. (save-excursion
  5672. (let* ((globalp (memq state '(contents all)))
  5673. (beg (if globalp (point-min) (point)))
  5674. (end (if globalp (point-max)
  5675. (if (eq state 'children)
  5676. (save-excursion (outline-next-heading) (point))
  5677. (org-end-of-subtree t)))))
  5678. (goto-char beg)
  5679. (while (re-search-forward org-drawer-regexp end t)
  5680. (org-flag-drawer t))))))
  5681. (defun org-flag-drawer (flag)
  5682. (save-excursion
  5683. (beginning-of-line 1)
  5684. (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
  5685. (let ((b (match-end 0))
  5686. (outline-regexp org-outline-regexp))
  5687. (if (re-search-forward
  5688. "^[ \t]*:END:"
  5689. (save-excursion (outline-next-heading) (point)) t)
  5690. (outline-flag-region b (point-at-eol) flag)
  5691. (error ":END: line missing at position %s" b))))))
  5692. (defun org-subtree-end-visible-p ()
  5693. "Is the end of the current subtree visible?"
  5694. (pos-visible-in-window-p
  5695. (save-excursion (org-end-of-subtree t) (point))))
  5696. (defun org-first-headline-recenter (&optional N)
  5697. "Move cursor to the first headline and recenter the headline.
  5698. Optional argument N means put the headline into the Nth line of the window."
  5699. (goto-char (point-min))
  5700. (when (re-search-forward (concat "^\\(" outline-regexp "\\)") nil t)
  5701. (beginning-of-line)
  5702. (recenter (prefix-numeric-value N))))
  5703. ;;; Saving and restoring visibility
  5704. (defun org-outline-overlay-data (&optional use-markers)
  5705. "Return a list of the locations of all outline overlays.
  5706. These are overlays with the `invisible' property value `outline'.
  5707. The return value is a list of cons cells, with start and stop
  5708. positions for each overlay.
  5709. If USE-MARKERS is set, return the positions as markers."
  5710. (let (beg end)
  5711. (save-excursion
  5712. (save-restriction
  5713. (widen)
  5714. (delq nil
  5715. (mapcar (lambda (o)
  5716. (when (eq (overlay-get o 'invisible) 'outline)
  5717. (setq beg (overlay-start o)
  5718. end (overlay-end o))
  5719. (and beg end (> end beg)
  5720. (if use-markers
  5721. (cons (move-marker (make-marker) beg)
  5722. (move-marker (make-marker) end))
  5723. (cons beg end)))))
  5724. (overlays-in (point-min) (point-max))))))))
  5725. (defun org-set-outline-overlay-data (data)
  5726. "Create visibility overlays for all positions in DATA.
  5727. DATA should have been made by `org-outline-overlay-data'."
  5728. (let (o)
  5729. (save-excursion
  5730. (save-restriction
  5731. (widen)
  5732. (show-all)
  5733. (mapc (lambda (c)
  5734. (setq o (make-overlay (car c) (cdr c)))
  5735. (overlay-put o 'invisible 'outline))
  5736. data)))))
  5737. ;;; Folding of blocks
  5738. (defconst org-block-regexp
  5739. "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
  5740. "Regular expression for hiding blocks.")
  5741. (defvar org-hide-block-overlays nil
  5742. "Overlays hiding blocks.")
  5743. (make-variable-buffer-local 'org-hide-block-overlays)
  5744. (defun org-block-map (function &optional start end)
  5745. "Call FUNCTION at the head of all source blocks in the current buffer.
  5746. Optional arguments START and END can be used to limit the range."
  5747. (let ((start (or start (point-min)))
  5748. (end (or end (point-max))))
  5749. (save-excursion
  5750. (goto-char start)
  5751. (while (and (< (point) end) (re-search-forward org-block-regexp end t))
  5752. (save-excursion
  5753. (save-match-data
  5754. (goto-char (match-beginning 0))
  5755. (funcall function)))))))
  5756. (defun org-hide-block-toggle-all ()
  5757. "Toggle the visibility of all blocks in the current buffer."
  5758. (org-block-map #'org-hide-block-toggle))
  5759. (defun org-hide-block-all ()
  5760. "Fold all blocks in the current buffer."
  5761. (interactive)
  5762. (org-show-block-all)
  5763. (org-block-map #'org-hide-block-toggle-maybe))
  5764. (defun org-show-block-all ()
  5765. "Unfold all blocks in the current buffer."
  5766. (interactive)
  5767. (mapc 'delete-overlay org-hide-block-overlays)
  5768. (setq org-hide-block-overlays nil))
  5769. (defun org-hide-block-toggle-maybe ()
  5770. "Toggle visibility of block at point."
  5771. (interactive)
  5772. (let ((case-fold-search t))
  5773. (if (save-excursion
  5774. (beginning-of-line 1)
  5775. (looking-at org-block-regexp))
  5776. (progn (org-hide-block-toggle)
  5777. t) ;; to signal that we took action
  5778. nil))) ;; to signal that we did not
  5779. (defun org-hide-block-toggle (&optional force)
  5780. "Toggle the visibility of the current block."
  5781. (interactive)
  5782. (save-excursion
  5783. (beginning-of-line)
  5784. (if (re-search-forward org-block-regexp nil t)
  5785. (let ((start (- (match-beginning 4) 1)) ;; beginning of body
  5786. (end (match-end 0)) ;; end of entire body
  5787. ov)
  5788. (if (memq t (mapcar (lambda (overlay)
  5789. (eq (overlay-get overlay 'invisible)
  5790. 'org-hide-block))
  5791. (overlays-at start)))
  5792. (if (or (not force) (eq force 'off))
  5793. (mapc (lambda (ov)
  5794. (when (member ov org-hide-block-overlays)
  5795. (setq org-hide-block-overlays
  5796. (delq ov org-hide-block-overlays)))
  5797. (when (eq (overlay-get ov 'invisible)
  5798. 'org-hide-block)
  5799. (delete-overlay ov)))
  5800. (overlays-at start)))
  5801. (setq ov (make-overlay start end))
  5802. (overlay-put ov 'invisible 'org-hide-block)
  5803. ;; make the block accessible to isearch
  5804. (overlay-put
  5805. ov 'isearch-open-invisible
  5806. (lambda (ov)
  5807. (when (member ov org-hide-block-overlays)
  5808. (setq org-hide-block-overlays
  5809. (delq ov org-hide-block-overlays)))
  5810. (when (eq (overlay-get ov 'invisible)
  5811. 'org-hide-block)
  5812. (delete-overlay ov))))
  5813. (push ov org-hide-block-overlays)))
  5814. (error "Not looking at a source block"))))
  5815. ;; org-tab-after-check-for-cycling-hook
  5816. (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
  5817. ;; Remove overlays when changing major mode
  5818. (add-hook 'org-mode-hook
  5819. (lambda () (org-add-hook 'change-major-mode-hook
  5820. 'org-show-block-all 'append 'local)))
  5821. ;;; Org-goto
  5822. (defvar org-goto-window-configuration nil)
  5823. (defvar org-goto-marker nil)
  5824. (defvar org-goto-map
  5825. (let ((map (make-sparse-keymap)))
  5826. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
  5827. (while (setq cmd (pop cmds))
  5828. (substitute-key-definition cmd cmd map global-map)))
  5829. (suppress-keymap map)
  5830. (org-defkey map "\C-m" 'org-goto-ret)
  5831. (org-defkey map [(return)] 'org-goto-ret)
  5832. (org-defkey map [(left)] 'org-goto-left)
  5833. (org-defkey map [(right)] 'org-goto-right)
  5834. (org-defkey map [(control ?g)] 'org-goto-quit)
  5835. (org-defkey map "\C-i" 'org-cycle)
  5836. (org-defkey map [(tab)] 'org-cycle)
  5837. (org-defkey map [(down)] 'outline-next-visible-heading)
  5838. (org-defkey map [(up)] 'outline-previous-visible-heading)
  5839. (if org-goto-auto-isearch
  5840. (if (fboundp 'define-key-after)
  5841. (define-key-after map [t] 'org-goto-local-auto-isearch)
  5842. nil)
  5843. (org-defkey map "q" 'org-goto-quit)
  5844. (org-defkey map "n" 'outline-next-visible-heading)
  5845. (org-defkey map "p" 'outline-previous-visible-heading)
  5846. (org-defkey map "f" 'outline-forward-same-level)
  5847. (org-defkey map "b" 'outline-backward-same-level)
  5848. (org-defkey map "u" 'outline-up-heading))
  5849. (org-defkey map "/" 'org-occur)
  5850. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  5851. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  5852. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  5853. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  5854. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  5855. map))
  5856. (defconst org-goto-help
  5857. "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
  5858. RET=jump to location [Q]uit and return to previous location
  5859. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  5860. (defvar org-goto-start-pos) ; dynamically scoped parameter
  5861. ;; FIXME: Docstring does not mention both interfaces
  5862. (defun org-goto (&optional alternative-interface)
  5863. "Look up a different location in the current file, keeping current visibility.
  5864. When you want look-up or go to a different location in a document, the
  5865. fastest way is often to fold the entire buffer and then dive into the tree.
  5866. This method has the disadvantage, that the previous location will be folded,
  5867. which may not be what you want.
  5868. This command works around this by showing a copy of the current buffer
  5869. in an indirect buffer, in overview mode. You can dive into the tree in
  5870. that copy, use org-occur and incremental search to find a location.
  5871. When pressing RET or `Q', the command returns to the original buffer in
  5872. which the visibility is still unchanged. After RET is will also jump to
  5873. the location selected in the indirect buffer and expose the
  5874. the headline hierarchy above."
  5875. (interactive "P")
  5876. (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
  5877. (org-refile-use-outline-path t)
  5878. (org-refile-target-verify-function nil)
  5879. (interface
  5880. (if (not alternative-interface)
  5881. org-goto-interface
  5882. (if (eq org-goto-interface 'outline)
  5883. 'outline-path-completion
  5884. 'outline)))
  5885. (org-goto-start-pos (point))
  5886. (selected-point
  5887. (if (eq interface 'outline)
  5888. (car (org-get-location (current-buffer) org-goto-help))
  5889. (let ((pa (org-refile-get-location "Goto")))
  5890. (org-refile-check-position pa)
  5891. (nth 3 pa)))))
  5892. (if selected-point
  5893. (progn
  5894. (org-mark-ring-push org-goto-start-pos)
  5895. (goto-char selected-point)
  5896. (if (or (outline-invisible-p) (org-invisible-p2))
  5897. (org-show-context 'org-goto)))
  5898. (message "Quit"))))
  5899. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  5900. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  5901. (defvar org-goto-local-auto-isearch-map) ; defined below
  5902. (defun org-get-location (buf help)
  5903. "Let the user select a location in the Org-mode buffer BUF.
  5904. This function uses a recursive edit. It returns the selected position
  5905. or nil."
  5906. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  5907. (isearch-hide-immediately nil)
  5908. (isearch-search-fun-function
  5909. (lambda () 'org-goto-local-search-headings))
  5910. (org-goto-selected-point org-goto-exit-command)
  5911. (pop-up-frames nil)
  5912. (special-display-buffer-names nil)
  5913. (special-display-regexps nil)
  5914. (special-display-function nil))
  5915. (save-excursion
  5916. (save-window-excursion
  5917. (delete-other-windows)
  5918. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  5919. (switch-to-buffer
  5920. (condition-case nil
  5921. (make-indirect-buffer (current-buffer) "*org-goto*")
  5922. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  5923. (with-output-to-temp-buffer "*Help*"
  5924. (princ help))
  5925. (org-fit-window-to-buffer (get-buffer-window "*Help*"))
  5926. (setq buffer-read-only nil)
  5927. (let ((org-startup-truncated t)
  5928. (org-startup-folded nil)
  5929. (org-startup-align-all-tables nil))
  5930. (org-mode)
  5931. (org-overview))
  5932. (setq buffer-read-only t)
  5933. (if (and (boundp 'org-goto-start-pos)
  5934. (integer-or-marker-p org-goto-start-pos))
  5935. (let ((org-show-hierarchy-above t)
  5936. (org-show-siblings t)
  5937. (org-show-following-heading t))
  5938. (goto-char org-goto-start-pos)
  5939. (and (outline-invisible-p) (org-show-context)))
  5940. (goto-char (point-min)))
  5941. (let (org-special-ctrl-a/e) (org-beginning-of-line))
  5942. (message "Select location and press RET")
  5943. (use-local-map org-goto-map)
  5944. (recursive-edit)
  5945. ))
  5946. (kill-buffer "*org-goto*")
  5947. (cons org-goto-selected-point org-goto-exit-command)))
  5948. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  5949. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  5950. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  5951. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
  5952. (defun org-goto-local-search-headings (string bound noerror)
  5953. "Search and make sure that any matches are in headlines."
  5954. (catch 'return
  5955. (while (if isearch-forward
  5956. (search-forward string bound noerror)
  5957. (search-backward string bound noerror))
  5958. (when (let ((context (mapcar 'car (save-match-data (org-context)))))
  5959. (and (member :headline context)
  5960. (not (member :tags context))))
  5961. (throw 'return (point))))))
  5962. (defun org-goto-local-auto-isearch ()
  5963. "Start isearch."
  5964. (interactive)
  5965. (goto-char (point-min))
  5966. (let ((keys (this-command-keys)))
  5967. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  5968. (isearch-mode t)
  5969. (isearch-process-search-char (string-to-char keys)))))
  5970. (defun org-goto-ret (&optional arg)
  5971. "Finish `org-goto' by going to the new location."
  5972. (interactive "P")
  5973. (setq org-goto-selected-point (point)
  5974. org-goto-exit-command 'return)
  5975. (throw 'exit nil))
  5976. (defun org-goto-left ()
  5977. "Finish `org-goto' by going to the new location."
  5978. (interactive)
  5979. (if (org-on-heading-p)
  5980. (progn
  5981. (beginning-of-line 1)
  5982. (setq org-goto-selected-point (point)
  5983. org-goto-exit-command 'left)
  5984. (throw 'exit nil))
  5985. (error "Not on a heading")))
  5986. (defun org-goto-right ()
  5987. "Finish `org-goto' by going to the new location."
  5988. (interactive)
  5989. (if (org-on-heading-p)
  5990. (progn
  5991. (setq org-goto-selected-point (point)
  5992. org-goto-exit-command 'right)
  5993. (throw 'exit nil))
  5994. (error "Not on a heading")))
  5995. (defun org-goto-quit ()
  5996. "Finish `org-goto' without cursor motion."
  5997. (interactive)
  5998. (setq org-goto-selected-point nil)
  5999. (setq org-goto-exit-command 'quit)
  6000. (throw 'exit nil))
  6001. ;;; Indirect buffer display of subtrees
  6002. (defvar org-indirect-dedicated-frame nil
  6003. "This is the frame being used for indirect tree display.")
  6004. (defvar org-last-indirect-buffer nil)
  6005. (defun org-tree-to-indirect-buffer (&optional arg)
  6006. "Create indirect buffer and narrow it to current subtree.
  6007. With numerical prefix ARG, go up to this level and then take that tree.
  6008. If ARG is negative, go up that many levels.
  6009. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  6010. indirect buffer previously made with this command, to avoid proliferation of
  6011. indirect buffers. However, when you call the command with a \
  6012. \\[universal-argument] prefix, or
  6013. when `org-indirect-buffer-display' is `new-frame', the last buffer
  6014. is kept so that you can work with several indirect buffers at the same time.
  6015. If `org-indirect-buffer-display' is `dedicated-frame', the \
  6016. \\[universal-argument] prefix also
  6017. requests that a new frame be made for the new buffer, so that the dedicated
  6018. frame is not changed."
  6019. (interactive "P")
  6020. (let ((cbuf (current-buffer))
  6021. (cwin (selected-window))
  6022. (pos (point))
  6023. beg end level heading ibuf)
  6024. (save-excursion
  6025. (org-back-to-heading t)
  6026. (when (numberp arg)
  6027. (setq level (org-outline-level))
  6028. (if (< arg 0) (setq arg (+ level arg)))
  6029. (while (> (setq level (org-outline-level)) arg)
  6030. (outline-up-heading 1 t)))
  6031. (setq beg (point)
  6032. heading (org-get-heading))
  6033. (org-end-of-subtree t t)
  6034. (if (org-on-heading-p) (backward-char 1))
  6035. (setq end (point)))
  6036. (if (and (buffer-live-p org-last-indirect-buffer)
  6037. (not (eq org-indirect-buffer-display 'new-frame))
  6038. (not arg))
  6039. (kill-buffer org-last-indirect-buffer))
  6040. (setq ibuf (org-get-indirect-buffer cbuf)
  6041. org-last-indirect-buffer ibuf)
  6042. (cond
  6043. ((or (eq org-indirect-buffer-display 'new-frame)
  6044. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  6045. (select-frame (make-frame))
  6046. (delete-other-windows)
  6047. (switch-to-buffer ibuf)
  6048. (org-set-frame-title heading))
  6049. ((eq org-indirect-buffer-display 'dedicated-frame)
  6050. (raise-frame
  6051. (select-frame (or (and org-indirect-dedicated-frame
  6052. (frame-live-p org-indirect-dedicated-frame)
  6053. org-indirect-dedicated-frame)
  6054. (setq org-indirect-dedicated-frame (make-frame)))))
  6055. (delete-other-windows)
  6056. (switch-to-buffer ibuf)
  6057. (org-set-frame-title (concat "Indirect: " heading)))
  6058. ((eq org-indirect-buffer-display 'current-window)
  6059. (switch-to-buffer ibuf))
  6060. ((eq org-indirect-buffer-display 'other-window)
  6061. (pop-to-buffer ibuf))
  6062. (t (error "Invalid value")))
  6063. (if (featurep 'xemacs)
  6064. (save-excursion (org-mode) (turn-on-font-lock)))
  6065. (narrow-to-region beg end)
  6066. (show-all)
  6067. (goto-char pos)
  6068. (and (window-live-p cwin) (select-window cwin))))
  6069. (defun org-get-indirect-buffer (&optional buffer)
  6070. (setq buffer (or buffer (current-buffer)))
  6071. (let ((n 1) (base (buffer-name buffer)) bname)
  6072. (while (buffer-live-p
  6073. (get-buffer (setq bname (concat base "-" (number-to-string n)))))
  6074. (setq n (1+ n)))
  6075. (condition-case nil
  6076. (make-indirect-buffer buffer bname 'clone)
  6077. (error (make-indirect-buffer buffer bname)))))
  6078. (defun org-set-frame-title (title)
  6079. "Set the title of the current frame to the string TITLE."
  6080. ;; FIXME: how to name a single frame in XEmacs???
  6081. (unless (featurep 'xemacs)
  6082. (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
  6083. ;;;; Structure editing
  6084. ;;; Inserting headlines
  6085. (defun org-previous-line-empty-p ()
  6086. (save-excursion
  6087. (and (not (bobp))
  6088. (or (beginning-of-line 0) t)
  6089. (save-match-data
  6090. (looking-at "[ \t]*$")))))
  6091. (defun org-insert-heading (&optional force-heading invisible-ok)
  6092. "Insert a new heading or item with same depth at point.
  6093. If point is in a plain list and FORCE-HEADING is nil, create a new list item.
  6094. If point is at the beginning of a headline, insert a sibling before the
  6095. current headline. If point is not at the beginning, split the line,
  6096. create the new headline with the text in the current line after point
  6097. \(but see also the variable `org-M-RET-may-split-line').
  6098. When INVISIBLE-OK is set, stop at invisible headlines when going back.
  6099. This is important for non-interactive uses of the command."
  6100. (interactive "P")
  6101. (if (or (= (buffer-size) 0)
  6102. (and (not (save-excursion
  6103. (and (ignore-errors (org-back-to-heading invisible-ok))
  6104. (org-on-heading-p))))
  6105. (not (org-in-item-p))))
  6106. (progn
  6107. (insert "\n* ")
  6108. (run-hooks 'org-insert-heading-hook))
  6109. (when (or force-heading (not (org-insert-item)))
  6110. (let* ((empty-line-p nil)
  6111. (level nil)
  6112. (on-heading (org-on-heading-p))
  6113. (head (save-excursion
  6114. (condition-case nil
  6115. (progn
  6116. (org-back-to-heading invisible-ok)
  6117. (when (and (not on-heading)
  6118. (featurep 'org-inlinetask)
  6119. (integerp org-inlinetask-min-level)
  6120. (>= (length (match-string 0))
  6121. org-inlinetask-min-level))
  6122. ;; Find a heading level before the inline task
  6123. (while (and (setq level (org-up-heading-safe))
  6124. (>= level org-inlinetask-min-level)))
  6125. (if (org-on-heading-p)
  6126. (org-back-to-heading invisible-ok)
  6127. (error "This should not happen")))
  6128. (setq empty-line-p (org-previous-line-empty-p))
  6129. (match-string 0))
  6130. (error "*"))))
  6131. (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
  6132. (blank (if (eq blank-a 'auto) empty-line-p blank-a))
  6133. pos hide-previous previous-pos)
  6134. (cond
  6135. ((and (org-on-heading-p) (bolp)
  6136. (or (bobp)
  6137. (save-excursion (backward-char 1) (not (outline-invisible-p)))))
  6138. ;; insert before the current line
  6139. (open-line (if blank 2 1)))
  6140. ((and (bolp)
  6141. (not org-insert-heading-respect-content)
  6142. (or (bobp)
  6143. (save-excursion
  6144. (backward-char 1) (not (outline-invisible-p)))))
  6145. ;; insert right here
  6146. nil)
  6147. (t
  6148. ;; somewhere in the line
  6149. (save-excursion
  6150. (setq previous-pos (point-at-bol))
  6151. (end-of-line)
  6152. (setq hide-previous (outline-invisible-p)))
  6153. (and org-insert-heading-respect-content (org-show-subtree))
  6154. (let ((split
  6155. (and (org-get-alist-option org-M-RET-may-split-line 'headline)
  6156. (save-excursion
  6157. (let ((p (point)))
  6158. (goto-char (point-at-bol))
  6159. (and (looking-at org-complex-heading-regexp)
  6160. (> p (match-beginning 4)))))))
  6161. tags pos)
  6162. (cond
  6163. (org-insert-heading-respect-content
  6164. (org-end-of-subtree nil t)
  6165. (when (featurep 'org-inlinetask)
  6166. (while (and (not (eobp))
  6167. (looking-at "\\(\\*+\\)[ \t]+")
  6168. (>= (length (match-string 1))
  6169. org-inlinetask-min-level))
  6170. (org-end-of-subtree nil t)))
  6171. (or (bolp) (newline))
  6172. (or (org-previous-line-empty-p)
  6173. (and blank (newline)))
  6174. (open-line 1))
  6175. ((org-on-heading-p)
  6176. (when hide-previous
  6177. (show-children)
  6178. (org-show-entry))
  6179. (looking-at ".*?\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?[ \t]*$")
  6180. (setq tags (and (match-end 2) (match-string 2)))
  6181. (and (match-end 1)
  6182. (delete-region (match-beginning 1) (match-end 1)))
  6183. (setq pos (point-at-bol))
  6184. (or split (end-of-line 1))
  6185. (delete-horizontal-space)
  6186. (if (string-match "\\`\\*+\\'"
  6187. (buffer-substring (point-at-bol) (point)))
  6188. (insert " "))
  6189. (newline (if blank 2 1))
  6190. (when tags
  6191. (save-excursion
  6192. (goto-char pos)
  6193. (end-of-line 1)
  6194. (insert " " tags)
  6195. (org-set-tags nil 'align))))
  6196. (t
  6197. (or split (end-of-line 1))
  6198. (newline (if blank 2 1)))))))
  6199. (insert head) (just-one-space)
  6200. (setq pos (point))
  6201. (end-of-line 1)
  6202. (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
  6203. (when (and org-insert-heading-respect-content hide-previous)
  6204. (save-excursion
  6205. (goto-char previous-pos)
  6206. (hide-subtree)))
  6207. (run-hooks 'org-insert-heading-hook)))))
  6208. (defun org-get-heading (&optional no-tags)
  6209. "Return the heading of the current entry, without the stars."
  6210. (save-excursion
  6211. (org-back-to-heading t)
  6212. (if (looking-at
  6213. (if no-tags
  6214. (org-re "\\*+[ \t]+\\([^\n\r]*?\\)\\([ \t]+:[[:alnum:]:_@#%]+:[ \t]*\\)?$")
  6215. "\\*+[ \t]+\\([^\r\n]*\\)"))
  6216. (match-string 1) "")))
  6217. (defun org-heading-components ()
  6218. "Return the components of the current heading.
  6219. This is a list with the following elements:
  6220. - the level as an integer
  6221. - the reduced level, different if `org-odd-levels-only' is set.
  6222. - the TODO keyword, or nil
  6223. - the priority character, like ?A, or nil if no priority is given
  6224. - the headline text itself, or the tags string if no headline text
  6225. - the tags string, or nil."
  6226. (save-excursion
  6227. (org-back-to-heading t)
  6228. (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
  6229. (list (length (match-string 1))
  6230. (org-reduced-level (length (match-string 1)))
  6231. (org-match-string-no-properties 2)
  6232. (and (match-end 3) (aref (match-string 3) 2))
  6233. (org-match-string-no-properties 4)
  6234. (org-match-string-no-properties 5)))))
  6235. (defun org-get-entry ()
  6236. "Get the entry text, after heading, entire subtree."
  6237. (save-excursion
  6238. (org-back-to-heading t)
  6239. (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
  6240. (defun org-insert-heading-after-current ()
  6241. "Insert a new heading with same level as current, after current subtree."
  6242. (interactive)
  6243. (org-back-to-heading)
  6244. (org-insert-heading)
  6245. (org-move-subtree-down)
  6246. (end-of-line 1))
  6247. (defun org-insert-heading-respect-content ()
  6248. (interactive)
  6249. (let ((org-insert-heading-respect-content t))
  6250. (org-insert-heading t)))
  6251. (defun org-insert-todo-heading-respect-content (&optional force-state)
  6252. (interactive "P")
  6253. (let ((org-insert-heading-respect-content t))
  6254. (org-insert-todo-heading force-state t)))
  6255. (defun org-insert-todo-heading (arg &optional force-heading)
  6256. "Insert a new heading with the same level and TODO state as current heading.
  6257. If the heading has no TODO state, or if the state is DONE, use the first
  6258. state (TODO by default). Also with prefix arg, force first state."
  6259. (interactive "P")
  6260. (when (or force-heading (not (org-insert-item 'checkbox)))
  6261. (org-insert-heading force-heading)
  6262. (save-excursion
  6263. (org-back-to-heading)
  6264. (outline-previous-heading)
  6265. (looking-at org-todo-line-regexp))
  6266. (let*
  6267. ((new-mark-x
  6268. (if (or arg
  6269. (not (match-beginning 2))
  6270. (member (match-string 2) org-done-keywords))
  6271. (car org-todo-keywords-1)
  6272. (match-string 2)))
  6273. (new-mark
  6274. (or
  6275. (run-hook-with-args-until-success
  6276. 'org-todo-get-default-hook new-mark-x nil)
  6277. new-mark-x)))
  6278. (beginning-of-line 1)
  6279. (and (looking-at "\\*+ ") (goto-char (match-end 0))
  6280. (if org-treat-insert-todo-heading-as-state-change
  6281. (org-todo new-mark)
  6282. (insert new-mark " "))))
  6283. (when org-provide-todo-statistics
  6284. (org-update-parent-todo-statistics))))
  6285. (defun org-insert-subheading (arg)
  6286. "Insert a new subheading and demote it.
  6287. Works for outline headings and for plain lists alike."
  6288. (interactive "P")
  6289. (org-insert-heading arg)
  6290. (cond
  6291. ((org-on-heading-p) (org-do-demote))
  6292. ((org-at-item-p) (org-indent-item))))
  6293. (defun org-insert-todo-subheading (arg)
  6294. "Insert a new subheading with TODO keyword or checkbox and demote it.
  6295. Works for outline headings and for plain lists alike."
  6296. (interactive "P")
  6297. (org-insert-todo-heading arg)
  6298. (cond
  6299. ((org-on-heading-p) (org-do-demote))
  6300. ((org-at-item-p) (org-indent-item))))
  6301. ;;; Promotion and Demotion
  6302. (defvar org-after-demote-entry-hook nil
  6303. "Hook run after an entry has been demoted.
  6304. The cursor will be at the beginning of the entry.
  6305. When a subtree is being demoted, the hook will be called for each node.")
  6306. (defvar org-after-promote-entry-hook nil
  6307. "Hook run after an entry has been promoted.
  6308. The cursor will be at the beginning of the entry.
  6309. When a subtree is being promoted, the hook will be called for each node.")
  6310. (defun org-promote-subtree ()
  6311. "Promote the entire subtree.
  6312. See also `org-promote'."
  6313. (interactive)
  6314. (save-excursion
  6315. (org-with-limited-levels (org-map-tree 'org-promote)))
  6316. (org-fix-position-after-promote))
  6317. (defun org-demote-subtree ()
  6318. "Demote the entire subtree. See `org-demote'.
  6319. See also `org-promote'."
  6320. (interactive)
  6321. (save-excursion
  6322. (org-with-limited-levels (org-map-tree 'org-demote)))
  6323. (org-fix-position-after-promote))
  6324. (defun org-do-promote ()
  6325. "Promote the current heading higher up the tree.
  6326. If the region is active in `transient-mark-mode', promote all headings
  6327. in the region."
  6328. (interactive)
  6329. (save-excursion
  6330. (if (org-region-active-p)
  6331. (org-map-region 'org-promote (region-beginning) (region-end))
  6332. (org-promote)))
  6333. (org-fix-position-after-promote))
  6334. (defun org-do-demote ()
  6335. "Demote the current heading lower down the tree.
  6336. If the region is active in `transient-mark-mode', demote all headings
  6337. in the region."
  6338. (interactive)
  6339. (save-excursion
  6340. (if (org-region-active-p)
  6341. (org-map-region 'org-demote (region-beginning) (region-end))
  6342. (org-demote)))
  6343. (org-fix-position-after-promote))
  6344. (defun org-fix-position-after-promote ()
  6345. "Make sure that after pro/demotion cursor position is right."
  6346. (let ((pos (point)))
  6347. (when (save-excursion
  6348. (beginning-of-line 1)
  6349. (looking-at org-todo-line-regexp)
  6350. (or (equal pos (match-end 1)) (equal pos (match-end 2))))
  6351. (cond ((eobp) (insert " "))
  6352. ((eolp) (insert " "))
  6353. ((equal (char-after) ?\ ) (forward-char 1))))))
  6354. (defun org-current-level ()
  6355. "Return the level of the current entry, or nil if before the first headline.
  6356. The level is the number of stars at the beginning of the headline."
  6357. (save-excursion
  6358. (org-with-limited-levels
  6359. (ignore-errors
  6360. (org-back-to-heading t)
  6361. (funcall outline-level)))))
  6362. (defun org-get-previous-line-level ()
  6363. "Return the outline depth of the last headline before the current line.
  6364. Returns 0 for the first headline in the buffer, and nil if before the
  6365. first headline."
  6366. (let ((current-level (org-current-level))
  6367. (prev-level (when (> (line-number-at-pos) 1)
  6368. (save-excursion
  6369. (beginning-of-line 0)
  6370. (org-current-level)))))
  6371. (cond ((null current-level) nil) ; Before first headline
  6372. ((null prev-level) 0) ; At first headline
  6373. (prev-level))))
  6374. (defun org-reduced-level (l)
  6375. "Compute the effective level of a heading.
  6376. This takes into account the setting of `org-odd-levels-only'."
  6377. (if org-odd-levels-only (1+ (floor (/ l 2))) l))
  6378. (defun org-level-increment ()
  6379. "Return the number of stars that will be added or removed at a
  6380. time to headlines when structure editing, based on the value of
  6381. `org-odd-levels-only'."
  6382. (if org-odd-levels-only 2 1))
  6383. (defun org-get-valid-level (level &optional change)
  6384. "Rectify a level change under the influence of `org-odd-levels-only'
  6385. LEVEL is a current level, CHANGE is by how much the level should be
  6386. modified. Even if CHANGE is nil, LEVEL may be returned modified because
  6387. even level numbers will become the next higher odd number."
  6388. (if org-odd-levels-only
  6389. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  6390. ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
  6391. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  6392. (max 1 (+ level (or change 0)))))
  6393. (if (boundp 'define-obsolete-function-alias)
  6394. (if (or (featurep 'xemacs) (< emacs-major-version 23))
  6395. (define-obsolete-function-alias 'org-get-legal-level
  6396. 'org-get-valid-level)
  6397. (define-obsolete-function-alias 'org-get-legal-level
  6398. 'org-get-valid-level "23.1")))
  6399. (defun org-promote ()
  6400. "Promote the current heading higher up the tree.
  6401. If the region is active in `transient-mark-mode', promote all headings
  6402. in the region."
  6403. (org-back-to-heading t)
  6404. (let* ((level (save-match-data (funcall outline-level)))
  6405. (after-change-functions (remove 'flyspell-after-change-function
  6406. after-change-functions))
  6407. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  6408. (diff (abs (- level (length up-head) -1))))
  6409. (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
  6410. (replace-match up-head nil t)
  6411. ;; Fixup tag positioning
  6412. (and org-auto-align-tags (org-set-tags nil t))
  6413. (if org-adapt-indentation (org-fixup-indentation (- diff)))
  6414. (run-hooks 'org-after-promote-entry-hook)))
  6415. (defun org-demote ()
  6416. "Demote the current heading lower down the tree.
  6417. If the region is active in `transient-mark-mode', demote all headings
  6418. in the region."
  6419. (org-back-to-heading t)
  6420. (let* ((level (save-match-data (funcall outline-level)))
  6421. (after-change-functions (remove 'flyspell-after-change-function
  6422. after-change-functions))
  6423. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  6424. (diff (abs (- level (length down-head) -1))))
  6425. (replace-match down-head nil t)
  6426. ;; Fixup tag positioning
  6427. (and org-auto-align-tags (org-set-tags nil t))
  6428. (if org-adapt-indentation (org-fixup-indentation diff))
  6429. (run-hooks 'org-after-demote-entry-hook)))
  6430. (defun org-cycle-level ()
  6431. "Cycle the level of an empty headline through possible states.
  6432. This goes first to child, then to parent, level, then up the hierarchy.
  6433. After top level, it switches back to sibling level."
  6434. (interactive)
  6435. (let ((org-adapt-indentation nil))
  6436. (when (org-point-at-end-of-empty-headline)
  6437. (setq this-command 'org-cycle-level) ; Only needed for caching
  6438. (let ((cur-level (org-current-level))
  6439. (prev-level (org-get-previous-line-level)))
  6440. (cond
  6441. ;; If first headline in file, promote to top-level.
  6442. ((= prev-level 0)
  6443. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6444. do (org-do-promote)))
  6445. ;; If same level as prev, demote one.
  6446. ((= prev-level cur-level)
  6447. (org-do-demote))
  6448. ;; If parent is top-level, promote to top level if not already.
  6449. ((= prev-level 1)
  6450. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6451. do (org-do-promote)))
  6452. ;; If top-level, return to prev-level.
  6453. ((= cur-level 1)
  6454. (loop repeat (/ (- prev-level 1) (org-level-increment))
  6455. do (org-do-demote)))
  6456. ;; If less than prev-level, promote one.
  6457. ((< cur-level prev-level)
  6458. (org-do-promote))
  6459. ;; If deeper than prev-level, promote until higher than
  6460. ;; prev-level.
  6461. ((> cur-level prev-level)
  6462. (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
  6463. do (org-do-promote))))
  6464. t))))
  6465. (defun org-map-tree (fun)
  6466. "Call FUN for every heading underneath the current one."
  6467. (org-back-to-heading)
  6468. (let ((level (funcall outline-level)))
  6469. (save-excursion
  6470. (funcall fun)
  6471. (while (and (progn
  6472. (outline-next-heading)
  6473. (> (funcall outline-level) level))
  6474. (not (eobp)))
  6475. (funcall fun)))))
  6476. (defun org-map-region (fun beg end)
  6477. "Call FUN for every heading between BEG and END."
  6478. (let ((org-ignore-region t))
  6479. (save-excursion
  6480. (setq end (copy-marker end))
  6481. (goto-char beg)
  6482. (if (and (re-search-forward (concat "^" outline-regexp) nil t)
  6483. (< (point) end))
  6484. (funcall fun))
  6485. (while (and (progn
  6486. (outline-next-heading)
  6487. (< (point) end))
  6488. (not (eobp)))
  6489. (funcall fun)))))
  6490. (defun org-fixup-indentation (diff)
  6491. "Change the indentation in the current entry by DIFF.
  6492. However, if any line in the current entry has no indentation, or if it
  6493. would end up with no indentation after the change, nothing at all is done."
  6494. (save-excursion
  6495. (let ((end (save-excursion (outline-next-heading)
  6496. (point-marker)))
  6497. (prohibit (if (> diff 0)
  6498. "^\\S-"
  6499. (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
  6500. col)
  6501. (unless (save-excursion (end-of-line 1)
  6502. (re-search-forward prohibit end t))
  6503. (while (and (< (point) end)
  6504. (re-search-forward "^[ \t]+" end t))
  6505. (goto-char (match-end 0))
  6506. (setq col (current-column))
  6507. (if (< diff 0) (replace-match ""))
  6508. (org-indent-to-column (+ diff col))))
  6509. (move-marker end nil))))
  6510. (defun org-convert-to-odd-levels ()
  6511. "Convert an org-mode file with all levels allowed to one with odd levels.
  6512. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  6513. level 5 etc."
  6514. (interactive)
  6515. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  6516. (let ((outline-regexp org-outline-regexp)
  6517. (outline-level 'org-outline-level)
  6518. (org-odd-levels-only nil) n)
  6519. (save-excursion
  6520. (goto-char (point-min))
  6521. (while (re-search-forward "^\\*\\*+ " nil t)
  6522. (setq n (- (length (match-string 0)) 2))
  6523. (while (>= (setq n (1- n)) 0)
  6524. (org-demote))
  6525. (end-of-line 1))))))
  6526. (defun org-convert-to-oddeven-levels ()
  6527. "Convert an org-mode file with only odd levels to one with odd/even levels.
  6528. This promotes level 3 to level 2, level 5 to level 3 etc. If the
  6529. file contains a section with an even level, conversion would
  6530. destroy the structure of the file. An error is signaled in this
  6531. case."
  6532. (interactive)
  6533. (goto-char (point-min))
  6534. ;; First check if there are no even levels
  6535. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  6536. (org-show-context t)
  6537. (error "Not all levels are odd in this file. Conversion not possible"))
  6538. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  6539. (let ((outline-regexp org-outline-regexp)
  6540. (outline-level 'org-outline-level)
  6541. (org-odd-levels-only nil) n)
  6542. (save-excursion
  6543. (goto-char (point-min))
  6544. (while (re-search-forward "^\\*\\*+ " nil t)
  6545. (setq n (/ (1- (length (match-string 0))) 2))
  6546. (while (>= (setq n (1- n)) 0)
  6547. (org-promote))
  6548. (end-of-line 1))))))
  6549. (defun org-tr-level (n)
  6550. "Make N odd if required."
  6551. (if org-odd-levels-only (1+ (/ n 2)) n))
  6552. ;;; Vertical tree motion, cutting and pasting of subtrees
  6553. (defun org-move-subtree-up (&optional arg)
  6554. "Move the current subtree up past ARG headlines of the same level."
  6555. (interactive "p")
  6556. (org-move-subtree-down (- (prefix-numeric-value arg))))
  6557. (defun org-move-subtree-down (&optional arg)
  6558. "Move the current subtree down past ARG headlines of the same level."
  6559. (interactive "p")
  6560. (setq arg (prefix-numeric-value arg))
  6561. (let ((movfunc (if (> arg 0) 'org-get-next-sibling
  6562. 'org-get-last-sibling))
  6563. (ins-point (make-marker))
  6564. (cnt (abs arg))
  6565. (col (current-column))
  6566. beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
  6567. ;; Select the tree
  6568. (org-back-to-heading)
  6569. (setq beg0 (point))
  6570. (save-excursion
  6571. (setq ne-beg (org-back-over-empty-lines))
  6572. (setq beg (point)))
  6573. (save-match-data
  6574. (save-excursion (outline-end-of-heading)
  6575. (setq folded (outline-invisible-p)))
  6576. (outline-end-of-subtree))
  6577. (outline-next-heading)
  6578. (setq ne-end (org-back-over-empty-lines))
  6579. (setq end (point))
  6580. (goto-char beg0)
  6581. (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
  6582. ;; include less whitespace
  6583. (save-excursion
  6584. (goto-char beg)
  6585. (forward-line (- ne-beg ne-end))
  6586. (setq beg (point))))
  6587. ;; Find insertion point, with error handling
  6588. (while (> cnt 0)
  6589. (or (and (funcall movfunc) (looking-at outline-regexp))
  6590. (progn (goto-char beg0)
  6591. (error "Cannot move past superior level or buffer limit")))
  6592. (setq cnt (1- cnt)))
  6593. (if (> arg 0)
  6594. ;; Moving forward - still need to move over subtree
  6595. (progn (org-end-of-subtree t t)
  6596. (save-excursion
  6597. (org-back-over-empty-lines)
  6598. (or (bolp) (newline)))))
  6599. (setq ne-ins (org-back-over-empty-lines))
  6600. (move-marker ins-point (point))
  6601. (setq txt (buffer-substring beg end))
  6602. (org-save-markers-in-region beg end)
  6603. (delete-region beg end)
  6604. (org-remove-empty-overlays-at beg)
  6605. (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
  6606. (or (bobp) (outline-flag-region (1- (point)) (point) nil))
  6607. (and (not (bolp)) (looking-at "\n") (forward-char 1))
  6608. (let ((bbb (point)))
  6609. (insert-before-markers txt)
  6610. (org-reinstall-markers-in-region bbb)
  6611. (move-marker ins-point bbb))
  6612. (or (bolp) (insert "\n"))
  6613. (setq ins-end (point))
  6614. (goto-char ins-point)
  6615. (org-skip-whitespace)
  6616. (when (and (< arg 0)
  6617. (org-first-sibling-p)
  6618. (> ne-ins ne-beg))
  6619. ;; Move whitespace back to beginning
  6620. (save-excursion
  6621. (goto-char ins-end)
  6622. (let ((kill-whole-line t))
  6623. (kill-line (- ne-ins ne-beg)) (point)))
  6624. (insert (make-string (- ne-ins ne-beg) ?\n)))
  6625. (move-marker ins-point nil)
  6626. (if folded
  6627. (hide-subtree)
  6628. (org-show-entry)
  6629. (show-children)
  6630. (org-cycle-hide-drawers 'children))
  6631. (org-clean-visibility-after-subtree-move)
  6632. ;; move back to the initial column we were at
  6633. (move-to-column col)))
  6634. (defvar org-subtree-clip ""
  6635. "Clipboard for cut and paste of subtrees.
  6636. This is actually only a copy of the kill, because we use the normal kill
  6637. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  6638. (defvar org-subtree-clip-folded nil
  6639. "Was the last copied subtree folded?
  6640. This is used to fold the tree back after pasting.")
  6641. (defun org-cut-subtree (&optional n)
  6642. "Cut the current subtree into the clipboard.
  6643. With prefix arg N, cut this many sequential subtrees.
  6644. This is a short-hand for marking the subtree and then cutting it."
  6645. (interactive "p")
  6646. (org-copy-subtree n 'cut))
  6647. (defun org-copy-subtree (&optional n cut force-store-markers)
  6648. "Cut the current subtree into the clipboard.
  6649. With prefix arg N, cut this many sequential subtrees.
  6650. This is a short-hand for marking the subtree and then copying it.
  6651. If CUT is non-nil, actually cut the subtree.
  6652. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  6653. of some markers in the region, even if CUT is non-nil. This is
  6654. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  6655. (interactive "p")
  6656. (let (beg end folded (beg0 (point)))
  6657. (if (interactive-p)
  6658. (org-back-to-heading nil) ; take what looks like a subtree
  6659. (org-back-to-heading t)) ; take what is really there
  6660. (org-back-over-empty-lines)
  6661. (setq beg (point))
  6662. (skip-chars-forward " \t\r\n")
  6663. (save-match-data
  6664. (save-excursion (outline-end-of-heading)
  6665. (setq folded (outline-invisible-p)))
  6666. (condition-case nil
  6667. (org-forward-same-level (1- n) t)
  6668. (error nil))
  6669. (org-end-of-subtree t t))
  6670. (org-back-over-empty-lines)
  6671. (setq end (point))
  6672. (goto-char beg0)
  6673. (when (> end beg)
  6674. (setq org-subtree-clip-folded folded)
  6675. (when (or cut force-store-markers)
  6676. (org-save-markers-in-region beg end))
  6677. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  6678. (setq org-subtree-clip (current-kill 0))
  6679. (message "%s: Subtree(s) with %d characters"
  6680. (if cut "Cut" "Copied")
  6681. (length org-subtree-clip)))))
  6682. (defun org-paste-subtree (&optional level tree for-yank)
  6683. "Paste the clipboard as a subtree, with modification of headline level.
  6684. The entire subtree is promoted or demoted in order to match a new headline
  6685. level.
  6686. If the cursor is at the beginning of a headline, the same level as
  6687. that headline is used to paste the tree
  6688. If not, the new level is derived from the *visible* headings
  6689. before and after the insertion point, and taken to be the inferior headline
  6690. level of the two. So if the previous visible heading is level 3 and the
  6691. next is level 4 (or vice versa), level 4 will be used for insertion.
  6692. This makes sure that the subtree remains an independent subtree and does
  6693. not swallow low level entries.
  6694. You can also force a different level, either by using a numeric prefix
  6695. argument, or by inserting the heading marker by hand. For example, if the
  6696. cursor is after \"*****\", then the tree will be shifted to level 5.
  6697. If optional TREE is given, use this text instead of the kill ring.
  6698. When FOR-YANK is set, this is called by `org-yank'. In this case, do not
  6699. move back over whitespace before inserting, and move point to the end of
  6700. the inserted text when done."
  6701. (interactive "P")
  6702. (setq tree (or tree (and kill-ring (current-kill 0))))
  6703. (unless (org-kill-is-subtree-p tree)
  6704. (error "%s"
  6705. (substitute-command-keys
  6706. "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
  6707. (let* ((visp (not (outline-invisible-p)))
  6708. (txt tree)
  6709. (^re (concat "^\\(" outline-regexp "\\)"))
  6710. (re (concat "\\(" outline-regexp "\\)"))
  6711. (^re_ (concat "\\(\\*+\\)[ \t]*"))
  6712. (old-level (if (string-match ^re txt)
  6713. (- (match-end 0) (match-beginning 0) 1)
  6714. -1))
  6715. (force-level (cond (level (prefix-numeric-value level))
  6716. ((and (looking-at "[ \t]*$")
  6717. (string-match
  6718. ^re_ (buffer-substring
  6719. (point-at-bol) (point))))
  6720. (- (match-end 1) (match-beginning 1)))
  6721. ((and (bolp)
  6722. (looking-at org-outline-regexp))
  6723. (- (match-end 0) (point) 1))
  6724. (t nil)))
  6725. (previous-level (save-excursion
  6726. (condition-case nil
  6727. (progn
  6728. (outline-previous-visible-heading 1)
  6729. (if (looking-at re)
  6730. (- (match-end 0) (match-beginning 0) 1)
  6731. 1))
  6732. (error 1))))
  6733. (next-level (save-excursion
  6734. (condition-case nil
  6735. (progn
  6736. (or (looking-at outline-regexp)
  6737. (outline-next-visible-heading 1))
  6738. (if (looking-at re)
  6739. (- (match-end 0) (match-beginning 0) 1)
  6740. 1))
  6741. (error 1))))
  6742. (new-level (or force-level (max previous-level next-level)))
  6743. (shift (if (or (= old-level -1)
  6744. (= new-level -1)
  6745. (= old-level new-level))
  6746. 0
  6747. (- new-level old-level)))
  6748. (delta (if (> shift 0) -1 1))
  6749. (func (if (> shift 0) 'org-demote 'org-promote))
  6750. (org-odd-levels-only nil)
  6751. beg end newend)
  6752. ;; Remove the forced level indicator
  6753. (if force-level
  6754. (delete-region (point-at-bol) (point)))
  6755. ;; Paste
  6756. (beginning-of-line 1)
  6757. (unless for-yank (org-back-over-empty-lines))
  6758. (setq beg (point))
  6759. (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
  6760. (insert-before-markers txt)
  6761. (unless (string-match "\n\\'" txt) (insert "\n"))
  6762. (setq newend (point))
  6763. (org-reinstall-markers-in-region beg)
  6764. (setq end (point))
  6765. (goto-char beg)
  6766. (skip-chars-forward " \t\n\r")
  6767. (setq beg (point))
  6768. (if (and (outline-invisible-p) visp)
  6769. (save-excursion (outline-show-heading)))
  6770. ;; Shift if necessary
  6771. (unless (= shift 0)
  6772. (save-restriction
  6773. (narrow-to-region beg end)
  6774. (while (not (= shift 0))
  6775. (org-map-region func (point-min) (point-max))
  6776. (setq shift (+ delta shift)))
  6777. (goto-char (point-min))
  6778. (setq newend (point-max))))
  6779. (when (or (interactive-p) for-yank)
  6780. (message "Clipboard pasted as level %d subtree" new-level))
  6781. (if (and (not for-yank) ; in this case, org-yank will decide about folding
  6782. kill-ring
  6783. (eq org-subtree-clip (current-kill 0))
  6784. org-subtree-clip-folded)
  6785. ;; The tree was folded before it was killed/copied
  6786. (hide-subtree))
  6787. (and for-yank (goto-char newend))))
  6788. (defun org-kill-is-subtree-p (&optional txt)
  6789. "Check if the current kill is an outline subtree, or a set of trees.
  6790. Returns nil if kill does not start with a headline, or if the first
  6791. headline level is not the largest headline level in the tree.
  6792. So this will actually accept several entries of equal levels as well,
  6793. which is OK for `org-paste-subtree'.
  6794. If optional TXT is given, check this string instead of the current kill."
  6795. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  6796. (start-level (and kill
  6797. (string-match (concat "\\`\\([ \t\n\r]*?\n\\)?\\("
  6798. org-outline-regexp "\\)")
  6799. kill)
  6800. (- (match-end 2) (match-beginning 2) 1)))
  6801. (re (concat "^" org-outline-regexp))
  6802. (start (1+ (or (match-beginning 2) -1))))
  6803. (if (not start-level)
  6804. (progn
  6805. nil) ;; does not even start with a heading
  6806. (catch 'exit
  6807. (while (setq start (string-match re kill (1+ start)))
  6808. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  6809. (throw 'exit nil)))
  6810. t))))
  6811. (defvar org-markers-to-move nil
  6812. "Markers that should be moved with a cut-and-paste operation.
  6813. Those markers are stored together with their positions relative to
  6814. the start of the region.")
  6815. (defun org-save-markers-in-region (beg end)
  6816. "Check markers in region.
  6817. If these markers are between BEG and END, record their position relative
  6818. to BEG, so that after moving the block of text, we can put the markers back
  6819. into place.
  6820. This function gets called just before an entry or tree gets cut from the
  6821. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  6822. called immediately, to move the markers with the entries."
  6823. (setq org-markers-to-move nil)
  6824. (when (featurep 'org-clock)
  6825. (org-clock-save-markers-for-cut-and-paste beg end))
  6826. (when (featurep 'org-agenda)
  6827. (org-agenda-save-markers-for-cut-and-paste beg end)))
  6828. (defun org-check-and-save-marker (marker beg end)
  6829. "Check if MARKER is between BEG and END.
  6830. If yes, remember the marker and the distance to BEG."
  6831. (when (and (marker-buffer marker)
  6832. (equal (marker-buffer marker) (current-buffer)))
  6833. (if (and (>= marker beg) (< marker end))
  6834. (push (cons marker (- marker beg)) org-markers-to-move))))
  6835. (defun org-reinstall-markers-in-region (beg)
  6836. "Move all remembered markers to their position relative to BEG."
  6837. (mapc (lambda (x)
  6838. (move-marker (car x) (+ beg (cdr x))))
  6839. org-markers-to-move)
  6840. (setq org-markers-to-move nil))
  6841. (defun org-narrow-to-subtree ()
  6842. "Narrow buffer to the current subtree."
  6843. (interactive)
  6844. (save-excursion
  6845. (save-match-data
  6846. (org-with-limited-levels
  6847. (narrow-to-region
  6848. (progn (org-back-to-heading t) (point))
  6849. (progn (org-end-of-subtree t t)
  6850. (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
  6851. (point)))))))
  6852. (defun org-narrow-to-block ()
  6853. "Narrow buffer to the current block."
  6854. (interactive)
  6855. (let ((bstart "^[ \t]*#\\+begin")
  6856. (bend "[ \t]*#\\+end")
  6857. (case-fold-search t) ;; allow #+BEGIN
  6858. b_start b_end)
  6859. (if (org-in-regexps-block-p bstart bend)
  6860. (progn
  6861. (save-excursion (re-search-backward bstart nil t)
  6862. (setq b_start (match-beginning 0)))
  6863. (save-excursion (re-search-forward bend nil t)
  6864. (setq b_end (match-end 0)))
  6865. (narrow-to-region b_start b_end))
  6866. (error "Not in a block"))))
  6867. (eval-when-compile
  6868. (defvar org-property-drawer-re))
  6869. (defvar org-property-start-re) ;; defined below
  6870. (defun org-clone-subtree-with-time-shift (n &optional shift)
  6871. "Clone the task (subtree) at point N times.
  6872. The clones will be inserted as siblings.
  6873. In interactive use, the user will be prompted for the number of
  6874. clones to be produced, and for a time SHIFT, which may be a
  6875. repeater as used in time stamps, for example `+3d'.
  6876. When a valid repeater is given and the entry contains any time
  6877. stamps, the clones will become a sequence in time, with time
  6878. stamps in the subtree shifted for each clone produced. If SHIFT
  6879. is nil or the empty string, time stamps will be left alone. The
  6880. ID property of the original subtree is removed.
  6881. If the original subtree did contain time stamps with a repeater,
  6882. the following will happen:
  6883. - the repeater will be removed in each clone
  6884. - an additional clone will be produced, with the current, unshifted
  6885. date(s) in the entry.
  6886. - the original entry will be placed *after* all the clones, with
  6887. repeater intact.
  6888. - the start days in the repeater in the original entry will be shifted
  6889. to past the last clone.
  6890. I this way you can spell out a number of instances of a repeating task,
  6891. and still retain the repeater to cover future instances of the task."
  6892. (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
  6893. (let (beg end template task idprop
  6894. shift-n shift-what doshift nmin nmax (n-no-remove -1))
  6895. (if (not (and (integerp n) (> n 0)))
  6896. (error "Invalid number of replications %s" n))
  6897. (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
  6898. (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([dwmy]\\)[ \t]*\\'"
  6899. shift)))
  6900. (error "Invalid shift specification %s" shift))
  6901. (when doshift
  6902. (setq shift-n (string-to-number (match-string 1 shift))
  6903. shift-what (cdr (assoc (match-string 2 shift)
  6904. '(("d" . day) ("w" . week)
  6905. ("m" . month) ("y" . year))))))
  6906. (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
  6907. (setq nmin 1 nmax n)
  6908. (org-back-to-heading t)
  6909. (setq beg (point))
  6910. (setq idprop (org-entry-get nil "ID"))
  6911. (org-end-of-subtree t t)
  6912. (or (bolp) (insert "\n"))
  6913. (setq end (point))
  6914. (setq template (buffer-substring beg end))
  6915. (when (and doshift
  6916. (string-match "<[^<>\n]+ \\+[0-9]+[dwmy][^<>\n]*>" template))
  6917. (delete-region beg end)
  6918. (setq end beg)
  6919. (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
  6920. (goto-char end)
  6921. (loop for n from nmin to nmax do
  6922. ;; prepare clone
  6923. (with-temp-buffer
  6924. (insert template)
  6925. (org-mode)
  6926. (goto-char (point-min))
  6927. (and idprop (if org-clone-delete-id
  6928. (org-entry-delete nil "ID")
  6929. (org-id-get-create t)))
  6930. (while (re-search-forward org-property-start-re nil t)
  6931. (org-remove-empty-drawer-at "PROPERTIES" (point)))
  6932. (goto-char (point-min))
  6933. (when doshift
  6934. (while (re-search-forward org-ts-regexp-both nil t)
  6935. (org-timestamp-change (* n shift-n) shift-what))
  6936. (unless (= n n-no-remove)
  6937. (goto-char (point-min))
  6938. (while (re-search-forward org-ts-regexp nil t)
  6939. (save-excursion
  6940. (goto-char (match-beginning 0))
  6941. (if (looking-at "<[^<>\n]+\\( +\\+[0-9]+[dwmy]\\)")
  6942. (delete-region (match-beginning 1) (match-end 1)))))))
  6943. (setq task (buffer-string)))
  6944. (insert task))
  6945. (goto-char beg)))
  6946. ;;; Outline Sorting
  6947. (defun org-sort (with-case)
  6948. "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
  6949. Optional argument WITH-CASE means sort case-sensitively.
  6950. With a double prefix argument, also remove duplicate entries."
  6951. (interactive "P")
  6952. (cond
  6953. ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
  6954. ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
  6955. (t
  6956. (org-call-with-arg 'org-sort-entries with-case))))
  6957. (defun org-sort-remove-invisible (s)
  6958. (remove-text-properties 0 (length s) org-rm-props s)
  6959. (while (string-match org-bracket-link-regexp s)
  6960. (setq s (replace-match (if (match-end 2)
  6961. (match-string 3 s)
  6962. (match-string 1 s)) t t s)))
  6963. s)
  6964. (defvar org-priority-regexp) ; defined later in the file
  6965. (defvar org-after-sorting-entries-or-items-hook nil
  6966. "Hook that is run after a bunch of entries or items have been sorted.
  6967. When children are sorted, the cursor is in the parent line when this
  6968. hook gets called. When a region or a plain list is sorted, the cursor
  6969. will be in the first entry of the sorted region/list.")
  6970. (defun org-sort-entries
  6971. (&optional with-case sorting-type getkey-func compare-func property)
  6972. "Sort entries on a certain level of an outline tree.
  6973. If there is an active region, the entries in the region are sorted.
  6974. Else, if the cursor is before the first entry, sort the top-level items.
  6975. Else, the children of the entry at point are sorted.
  6976. Sorting can be alphabetically, numerically, by date/time as given by
  6977. a time stamp, by a property or by priority.
  6978. The command prompts for the sorting type unless it has been given to the
  6979. function through the SORTING-TYPE argument, which needs to be a character,
  6980. \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
  6981. precise meaning of each character:
  6982. n Numerically, by converting the beginning of the entry/item to a number.
  6983. a Alphabetically, ignoring the TODO keyword and the priority, if any.
  6984. t By date/time, either the first active time stamp in the entry, or, if
  6985. none exist, by the first inactive one.
  6986. s By the scheduled date/time.
  6987. d By deadline date/time.
  6988. c By creation time, which is assumed to be the first inactive time stamp
  6989. at the beginning of a line.
  6990. p By priority according to the cookie.
  6991. r By the value of a property.
  6992. Capital letters will reverse the sort order.
  6993. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  6994. called with point at the beginning of the record. It must return either
  6995. a string or a number that should serve as the sorting key for that record.
  6996. Comparing entries ignores case by default. However, with an optional argument
  6997. WITH-CASE, the sorting considers case as well."
  6998. (interactive "P")
  6999. (let ((case-func (if with-case 'identity 'downcase))
  7000. start beg end stars re re2
  7001. txt what tmp)
  7002. ;; Find beginning and end of region to sort
  7003. (cond
  7004. ((org-region-active-p)
  7005. ;; we will sort the region
  7006. (setq end (region-end)
  7007. what "region")
  7008. (goto-char (region-beginning))
  7009. (if (not (org-on-heading-p)) (outline-next-heading))
  7010. (setq start (point)))
  7011. ((or (org-on-heading-p)
  7012. (condition-case nil (progn (org-back-to-heading) t) (error nil)))
  7013. ;; we will sort the children of the current headline
  7014. (org-back-to-heading)
  7015. (setq start (point)
  7016. end (progn (org-end-of-subtree t t)
  7017. (or (bolp) (insert "\n"))
  7018. (org-back-over-empty-lines)
  7019. (point))
  7020. what "children")
  7021. (goto-char start)
  7022. (show-subtree)
  7023. (outline-next-heading))
  7024. (t
  7025. ;; we will sort the top-level entries in this file
  7026. (goto-char (point-min))
  7027. (or (org-on-heading-p) (outline-next-heading))
  7028. (setq start (point))
  7029. (goto-char (point-max))
  7030. (beginning-of-line 1)
  7031. (when (looking-at ".*?\\S-")
  7032. ;; File ends in a non-white line
  7033. (end-of-line 1)
  7034. (insert "\n"))
  7035. (setq end (point-max))
  7036. (setq what "top-level")
  7037. (goto-char start)
  7038. (show-all)))
  7039. (setq beg (point))
  7040. (if (>= beg end) (error "Nothing to sort"))
  7041. (looking-at "\\(\\*+\\)")
  7042. (setq stars (match-string 1)
  7043. re (concat "^" (regexp-quote stars) " +")
  7044. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
  7045. txt (buffer-substring beg end))
  7046. (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
  7047. (if (and (not (equal stars "*")) (string-match re2 txt))
  7048. (error "Region to sort contains a level above the first entry"))
  7049. (unless sorting-type
  7050. (message
  7051. "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
  7052. [t]ime [s]cheduled [d]eadline [c]reated
  7053. A/N/T/S/D/C/P/O/F means reversed:"
  7054. what)
  7055. (setq sorting-type (read-char-exclusive))
  7056. (and (= (downcase sorting-type) ?f)
  7057. (setq getkey-func
  7058. (org-icompleting-read "Sort using function: "
  7059. obarray 'fboundp t nil nil))
  7060. (setq getkey-func (intern getkey-func)))
  7061. (and (= (downcase sorting-type) ?r)
  7062. (setq property
  7063. (org-icompleting-read "Property: "
  7064. (mapcar 'list (org-buffer-property-keys t))
  7065. nil t))))
  7066. (message "Sorting entries...")
  7067. (save-restriction
  7068. (narrow-to-region start end)
  7069. (let ((dcst (downcase sorting-type))
  7070. (case-fold-search nil)
  7071. (now (current-time)))
  7072. (sort-subr
  7073. (/= dcst sorting-type)
  7074. ;; This function moves to the beginning character of the "record" to
  7075. ;; be sorted.
  7076. (lambda nil
  7077. (if (re-search-forward re nil t)
  7078. (goto-char (match-beginning 0))
  7079. (goto-char (point-max))))
  7080. ;; This function moves to the last character of the "record" being
  7081. ;; sorted.
  7082. (lambda nil
  7083. (save-match-data
  7084. (condition-case nil
  7085. (outline-forward-same-level 1)
  7086. (error
  7087. (goto-char (point-max))))))
  7088. ;; This function returns the value that gets sorted against.
  7089. (lambda nil
  7090. (cond
  7091. ((= dcst ?n)
  7092. (if (looking-at org-complex-heading-regexp)
  7093. (string-to-number (match-string 4))
  7094. nil))
  7095. ((= dcst ?a)
  7096. (if (looking-at org-complex-heading-regexp)
  7097. (funcall case-func (match-string 4))
  7098. nil))
  7099. ((= dcst ?t)
  7100. (let ((end (save-excursion (outline-next-heading) (point))))
  7101. (if (or (re-search-forward org-ts-regexp end t)
  7102. (re-search-forward org-ts-regexp-both end t))
  7103. (org-time-string-to-seconds (match-string 0))
  7104. (org-float-time now))))
  7105. ((= dcst ?c)
  7106. (let ((end (save-excursion (outline-next-heading) (point))))
  7107. (if (re-search-forward
  7108. (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
  7109. end t)
  7110. (org-time-string-to-seconds (match-string 0))
  7111. (org-float-time now))))
  7112. ((= dcst ?s)
  7113. (let ((end (save-excursion (outline-next-heading) (point))))
  7114. (if (re-search-forward org-scheduled-time-regexp end t)
  7115. (org-time-string-to-seconds (match-string 1))
  7116. (org-float-time now))))
  7117. ((= dcst ?d)
  7118. (let ((end (save-excursion (outline-next-heading) (point))))
  7119. (if (re-search-forward org-deadline-time-regexp end t)
  7120. (org-time-string-to-seconds (match-string 1))
  7121. (org-float-time now))))
  7122. ((= dcst ?p)
  7123. (if (re-search-forward org-priority-regexp (point-at-eol) t)
  7124. (string-to-char (match-string 2))
  7125. org-default-priority))
  7126. ((= dcst ?r)
  7127. (or (org-entry-get nil property) ""))
  7128. ((= dcst ?o)
  7129. (if (looking-at org-complex-heading-regexp)
  7130. (- 9999 (length (member (match-string 2)
  7131. org-todo-keywords-1)))))
  7132. ((= dcst ?f)
  7133. (if getkey-func
  7134. (progn
  7135. (setq tmp (funcall getkey-func))
  7136. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  7137. tmp)
  7138. (error "Invalid key function `%s'" getkey-func)))
  7139. (t (error "Invalid sorting type `%c'" sorting-type))))
  7140. nil
  7141. (cond
  7142. ((= dcst ?a) 'string<)
  7143. ((= dcst ?f) compare-func)
  7144. ((member dcst '(?p ?t ?s ?d ?c)) '<)
  7145. (t nil)))))
  7146. (run-hooks 'org-after-sorting-entries-or-items-hook)
  7147. (message "Sorting entries...done")))
  7148. (defun org-do-sort (table what &optional with-case sorting-type)
  7149. "Sort TABLE of WHAT according to SORTING-TYPE.
  7150. The user will be prompted for the SORTING-TYPE if the call to this
  7151. function does not specify it. WHAT is only for the prompt, to indicate
  7152. what is being sorted. The sorting key will be extracted from
  7153. the car of the elements of the table.
  7154. If WITH-CASE is non-nil, the sorting will be case-sensitive."
  7155. (unless sorting-type
  7156. (message
  7157. "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
  7158. what)
  7159. (setq sorting-type (read-char-exclusive)))
  7160. (let ((dcst (downcase sorting-type))
  7161. extractfun comparefun)
  7162. ;; Define the appropriate functions
  7163. (cond
  7164. ((= dcst ?n)
  7165. (setq extractfun 'string-to-number
  7166. comparefun (if (= dcst sorting-type) '< '>)))
  7167. ((= dcst ?a)
  7168. (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
  7169. (lambda(x) (downcase (org-sort-remove-invisible x))))
  7170. comparefun (if (= dcst sorting-type)
  7171. 'string<
  7172. (lambda (a b) (and (not (string< a b))
  7173. (not (string= a b)))))))
  7174. ((= dcst ?t)
  7175. (setq extractfun
  7176. (lambda (x)
  7177. (if (or (string-match org-ts-regexp x)
  7178. (string-match org-ts-regexp-both x))
  7179. (org-float-time
  7180. (org-time-string-to-time (match-string 0 x)))
  7181. 0))
  7182. comparefun (if (= dcst sorting-type) '< '>)))
  7183. (t (error "Invalid sorting type `%c'" sorting-type)))
  7184. (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
  7185. table)
  7186. (lambda (a b) (funcall comparefun (car a) (car b))))))
  7187. ;;; The orgstruct minor mode
  7188. ;; Define a minor mode which can be used in other modes in order to
  7189. ;; integrate the org-mode structure editing commands.
  7190. ;; This is really a hack, because the org-mode structure commands use
  7191. ;; keys which normally belong to the major mode. Here is how it
  7192. ;; works: The minor mode defines all the keys necessary to operate the
  7193. ;; structure commands, but wraps the commands into a function which
  7194. ;; tests if the cursor is currently at a headline or a plain list
  7195. ;; item. If that is the case, the structure command is used,
  7196. ;; temporarily setting many Org-mode variables like regular
  7197. ;; expressions for filling etc. However, when any of those keys is
  7198. ;; used at a different location, function uses `key-binding' to look
  7199. ;; up if the key has an associated command in another currently active
  7200. ;; keymap (minor modes, major mode, global), and executes that
  7201. ;; command. There might be problems if any of the keys is otherwise
  7202. ;; used as a prefix key.
  7203. ;; Another challenge is that the key binding for TAB can be tab or \C-i,
  7204. ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
  7205. ;; addresses this by checking explicitly for both bindings.
  7206. (defvar orgstruct-mode-map (make-sparse-keymap)
  7207. "Keymap for the minor `orgstruct-mode'.")
  7208. (defvar org-local-vars nil
  7209. "List of local variables, for use by `orgstruct-mode'.")
  7210. ;;;###autoload
  7211. (define-minor-mode orgstruct-mode
  7212. "Toggle the minor mode `orgstruct-mode'.
  7213. This mode is for using Org-mode structure commands in other
  7214. modes. The following keys behave as if Org-mode were active, if
  7215. the cursor is on a headline, or on a plain list item (both as
  7216. defined by Org-mode).
  7217. M-up Move entry/item up
  7218. M-down Move entry/item down
  7219. M-left Promote
  7220. M-right Demote
  7221. M-S-up Move entry/item up
  7222. M-S-down Move entry/item down
  7223. M-S-left Promote subtree
  7224. M-S-right Demote subtree
  7225. M-q Fill paragraph and items like in Org-mode
  7226. C-c ^ Sort entries
  7227. C-c - Cycle list bullet
  7228. TAB Cycle item visibility
  7229. M-RET Insert new heading/item
  7230. S-M-RET Insert new TODO heading / Checkbox item
  7231. C-c C-c Set tags / toggle checkbox"
  7232. nil " OrgStruct" nil
  7233. (org-load-modules-maybe)
  7234. (and (orgstruct-setup) (defun orgstruct-setup () nil)))
  7235. ;;;###autoload
  7236. (defun turn-on-orgstruct ()
  7237. "Unconditionally turn on `orgstruct-mode'."
  7238. (orgstruct-mode 1))
  7239. (defun orgstruct++-mode (&optional arg)
  7240. "Toggle `orgstruct-mode', the enhanced version of it.
  7241. In addition to setting orgstruct-mode, this also exports all indentation
  7242. and autofilling variables from org-mode into the buffer. It will also
  7243. recognize item context in multiline items.
  7244. Note that turning off orgstruct-mode will *not* remove the
  7245. indentation/paragraph settings. This can only be done by refreshing the
  7246. major mode, for example with \\[normal-mode]."
  7247. (interactive "P")
  7248. (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
  7249. (if (< arg 1)
  7250. (orgstruct-mode -1)
  7251. (orgstruct-mode 1)
  7252. (let (var val)
  7253. (mapc
  7254. (lambda (x)
  7255. (when (string-match
  7256. "^\\(paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
  7257. (symbol-name (car x)))
  7258. (setq var (car x) val (nth 1 x))
  7259. (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
  7260. org-local-vars)
  7261. (org-set-local 'orgstruct-is-++ t))))
  7262. (defvar orgstruct-is-++ nil
  7263. "Is `orgstruct-mode' in ++ version in the current-buffer?")
  7264. (make-variable-buffer-local 'orgstruct-is-++)
  7265. ;;;###autoload
  7266. (defun turn-on-orgstruct++ ()
  7267. "Unconditionally turn on `orgstruct++-mode'."
  7268. (orgstruct++-mode 1))
  7269. (defun orgstruct-error ()
  7270. "Error when there is no default binding for a structure key."
  7271. (interactive)
  7272. (error "This key has no function outside structure elements"))
  7273. (defun orgstruct-setup ()
  7274. "Setup orgstruct keymaps."
  7275. (let ((nfunc 0)
  7276. (bindings
  7277. (list
  7278. '([(meta up)] org-metaup)
  7279. '([(meta down)] org-metadown)
  7280. '([(meta left)] org-metaleft)
  7281. '([(meta right)] org-metaright)
  7282. '([(meta shift up)] org-shiftmetaup)
  7283. '([(meta shift down)] org-shiftmetadown)
  7284. '([(meta shift left)] org-shiftmetaleft)
  7285. '([(meta shift right)] org-shiftmetaright)
  7286. '([?\e (up)] org-metaup)
  7287. '([?\e (down)] org-metadown)
  7288. '([?\e (left)] org-metaleft)
  7289. '([?\e (right)] org-metaright)
  7290. '([?\e (shift up)] org-shiftmetaup)
  7291. '([?\e (shift down)] org-shiftmetadown)
  7292. '([?\e (shift left)] org-shiftmetaleft)
  7293. '([?\e (shift right)] org-shiftmetaright)
  7294. '([(shift up)] org-shiftup)
  7295. '([(shift down)] org-shiftdown)
  7296. '([(shift left)] org-shiftleft)
  7297. '([(shift right)] org-shiftright)
  7298. '("\C-c\C-c" org-ctrl-c-ctrl-c)
  7299. '("\M-q" fill-paragraph)
  7300. '("\C-c^" org-sort)
  7301. '("\C-c-" org-cycle-list-bullet)))
  7302. elt key fun cmd)
  7303. (while (setq elt (pop bindings))
  7304. (setq nfunc (1+ nfunc))
  7305. (setq key (org-key (car elt))
  7306. fun (nth 1 elt)
  7307. cmd (orgstruct-make-binding fun nfunc key))
  7308. (org-defkey orgstruct-mode-map key cmd))
  7309. ;; Special treatment needed for TAB and RET
  7310. (org-defkey orgstruct-mode-map [(tab)]
  7311. (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
  7312. (org-defkey orgstruct-mode-map "\C-i"
  7313. (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
  7314. (org-defkey orgstruct-mode-map "\M-\C-m"
  7315. (orgstruct-make-binding 'org-insert-heading 105
  7316. "\M-\C-m" [(meta return)]))
  7317. (org-defkey orgstruct-mode-map [(meta return)]
  7318. (orgstruct-make-binding 'org-insert-heading 106
  7319. [(meta return)] "\M-\C-m"))
  7320. (org-defkey orgstruct-mode-map [(shift meta return)]
  7321. (orgstruct-make-binding 'org-insert-todo-heading 107
  7322. [(meta return)] "\M-\C-m"))
  7323. (org-defkey orgstruct-mode-map "\e\C-m"
  7324. (orgstruct-make-binding 'org-insert-heading 108
  7325. "\e\C-m" [?\e (return)]))
  7326. (org-defkey orgstruct-mode-map [?\e (return)]
  7327. (orgstruct-make-binding 'org-insert-heading 109
  7328. [?\e (return)] "\e\C-m"))
  7329. (org-defkey orgstruct-mode-map [?\e (shift return)]
  7330. (orgstruct-make-binding 'org-insert-todo-heading 110
  7331. [?\e (return)] "\e\C-m"))
  7332. (unless org-local-vars
  7333. (setq org-local-vars (org-get-local-variables)))
  7334. t))
  7335. (defun orgstruct-make-binding (fun n &rest keys)
  7336. "Create a function for binding in the structure minor mode.
  7337. FUN is the command to call inside a table. N is used to create a unique
  7338. command name. KEYS are keys that should be checked in for a command
  7339. to execute outside of tables."
  7340. (eval
  7341. (list 'defun
  7342. (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
  7343. '(arg)
  7344. (concat "In Structure, run `" (symbol-name fun) "'.\n"
  7345. "Outside of structure, run the binding of `"
  7346. (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
  7347. "'.")
  7348. '(interactive "p")
  7349. (list 'if
  7350. `(org-context-p 'headline 'item
  7351. (and orgstruct-is-++
  7352. ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
  7353. 'item-body))
  7354. (list 'org-run-like-in-org-mode (list 'quote fun))
  7355. (list 'let '(orgstruct-mode)
  7356. (list 'call-interactively
  7357. (append '(or)
  7358. (mapcar (lambda (k)
  7359. (list 'key-binding k))
  7360. keys)
  7361. '('orgstruct-error))))))))
  7362. (defun org-context-p (&rest contexts)
  7363. "Check if local context is any of CONTEXTS.
  7364. Possible values in the list of contexts are `table', `headline', and `item'."
  7365. (let ((pos (point)))
  7366. (goto-char (point-at-bol))
  7367. (prog1 (or (and (memq 'table contexts)
  7368. (looking-at "[ \t]*|"))
  7369. (and (memq 'headline contexts)
  7370. ;;????????? (looking-at "\\*+"))
  7371. (looking-at outline-regexp))
  7372. (and (memq 'item contexts)
  7373. (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
  7374. (and (memq 'item-body contexts)
  7375. (org-in-item-p)))
  7376. (goto-char pos))))
  7377. (defun org-get-local-variables ()
  7378. "Return a list of all local variables in an org-mode buffer."
  7379. (let (varlist)
  7380. (with-current-buffer (get-buffer-create "*Org tmp*")
  7381. (erase-buffer)
  7382. (org-mode)
  7383. (setq varlist (buffer-local-variables)))
  7384. (kill-buffer "*Org tmp*")
  7385. (delq nil
  7386. (mapcar
  7387. (lambda (x)
  7388. (setq x
  7389. (if (symbolp x)
  7390. (list x)
  7391. (list (car x) (list 'quote (cdr x)))))
  7392. (if (string-match
  7393. "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
  7394. (symbol-name (car x)))
  7395. x nil))
  7396. varlist))))
  7397. (defun org-clone-local-variables (from-buffer &optional regexp)
  7398. "Clone local variables from FROM-BUFFER.
  7399. Optional argument REGEXP selects variables to clone."
  7400. (mapc
  7401. (lambda (pair)
  7402. (and (symbolp (car pair))
  7403. (or (null regexp)
  7404. (string-match regexp (symbol-name (car pair))))
  7405. (set (make-local-variable (car pair))
  7406. (cdr pair))))
  7407. (buffer-local-variables from-buffer)))
  7408. ;;;###autoload
  7409. (defun org-run-like-in-org-mode (cmd)
  7410. "Run a command, pretending that the current buffer is in Org-mode.
  7411. This will temporarily bind local variables that are typically bound in
  7412. Org-mode to the values they have in Org-mode, and then interactively
  7413. call CMD."
  7414. (org-load-modules-maybe)
  7415. (unless org-local-vars
  7416. (setq org-local-vars (org-get-local-variables)))
  7417. (eval (list 'let org-local-vars
  7418. (list 'call-interactively (list 'quote cmd)))))
  7419. ;;;; Archiving
  7420. (defun org-get-category (&optional pos force-refresh)
  7421. "Get the category applying to position POS."
  7422. (if force-refresh (org-refresh-category-properties))
  7423. (let ((pos (or pos (point))))
  7424. (or (get-text-property pos 'org-category)
  7425. (progn (org-refresh-category-properties)
  7426. (get-text-property pos 'org-category)))))
  7427. (defun org-refresh-category-properties ()
  7428. "Refresh category text properties in the buffer."
  7429. (let ((def-cat (cond
  7430. ((null org-category)
  7431. (if buffer-file-name
  7432. (file-name-sans-extension
  7433. (file-name-nondirectory buffer-file-name))
  7434. "???"))
  7435. ((symbolp org-category) (symbol-name org-category))
  7436. (t org-category)))
  7437. beg end cat pos optionp)
  7438. (org-unmodified
  7439. (save-excursion
  7440. (save-restriction
  7441. (widen)
  7442. (goto-char (point-min))
  7443. (put-text-property (point) (point-max) 'org-category def-cat)
  7444. (while (re-search-forward
  7445. "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
  7446. (setq pos (match-end 0)
  7447. optionp (equal (char-after (match-beginning 0)) ?#)
  7448. cat (org-trim (match-string 2)))
  7449. (if optionp
  7450. (setq beg (point-at-bol) end (point-max))
  7451. (org-back-to-heading t)
  7452. (setq beg (point) end (org-end-of-subtree t t)))
  7453. (put-text-property beg end 'org-category cat)
  7454. (goto-char pos)))))))
  7455. ;;;; Link Stuff
  7456. ;;; Link abbreviations
  7457. (defun org-link-expand-abbrev (link)
  7458. "Apply replacements as defined in `org-link-abbrev-alist."
  7459. (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
  7460. (let* ((key (match-string 1 link))
  7461. (as (or (assoc key org-link-abbrev-alist-local)
  7462. (assoc key org-link-abbrev-alist)))
  7463. (tag (and (match-end 2) (match-string 3 link)))
  7464. rpl)
  7465. (if (not as)
  7466. link
  7467. (setq rpl (cdr as))
  7468. (cond
  7469. ((symbolp rpl) (funcall rpl tag))
  7470. ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
  7471. ((string-match "%h" rpl)
  7472. (replace-match (url-hexify-string (or tag "")) t t rpl))
  7473. (t (concat rpl tag)))))
  7474. link))
  7475. ;;; Storing and inserting links
  7476. (defvar org-insert-link-history nil
  7477. "Minibuffer history for links inserted with `org-insert-link'.")
  7478. (defvar org-stored-links nil
  7479. "Contains the links stored with `org-store-link'.")
  7480. (defvar org-store-link-plist nil
  7481. "Plist with info about the most recently link created with `org-store-link'.")
  7482. (defvar org-link-protocols nil
  7483. "Link protocols added to Org-mode using `org-add-link-type'.")
  7484. (defvar org-store-link-functions nil
  7485. "List of functions that are called to create and store a link.
  7486. Each function will be called in turn until one returns a non-nil
  7487. value. Each function should check if it is responsible for creating
  7488. this link (for example by looking at the major mode).
  7489. If not, it must exit and return nil.
  7490. If yes, it should return a non-nil value after a calling
  7491. `org-store-link-props' with a list of properties and values.
  7492. Special properties are:
  7493. :type The link prefix, like \"http\". This must be given.
  7494. :link The link, like \"http://www.astro.uva.nl/~dominik\".
  7495. This is obligatory as well.
  7496. :description Optional default description for the second pair
  7497. of brackets in an Org-mode link. The user can still change
  7498. this when inserting this link into an Org-mode buffer.
  7499. In addition to these, any additional properties can be specified
  7500. and then used in remember templates.")
  7501. (defun org-add-link-type (type &optional follow export)
  7502. "Add TYPE to the list of `org-link-types'.
  7503. Re-compute all regular expressions depending on `org-link-types'
  7504. FOLLOW and EXPORT are two functions.
  7505. FOLLOW should take the link path as the single argument and do whatever
  7506. is necessary to follow the link, for example find a file or display
  7507. a mail message.
  7508. EXPORT should format the link path for export to one of the export formats.
  7509. It should be a function accepting three arguments:
  7510. path the path of the link, the text after the prefix (like \"http:\")
  7511. desc the description of the link, if any, or a description added by
  7512. org-export-normalize-links if there is none
  7513. format the export format, a symbol like `html' or `latex' or `ascii'..
  7514. The function may use the FORMAT information to return different values
  7515. depending on the format. The return value will be put literally into
  7516. the exported file. If the return value is nil, this means Org should
  7517. do what it normally does with links which do not have EXPORT defined.
  7518. Org-mode has a built-in default for exporting links. If you are happy with
  7519. this default, there is no need to define an export function for the link
  7520. type. For a simple example of an export function, see `org-bbdb.el'."
  7521. (add-to-list 'org-link-types type t)
  7522. (org-make-link-regexps)
  7523. (if (assoc type org-link-protocols)
  7524. (setcdr (assoc type org-link-protocols) (list follow export))
  7525. (push (list type follow export) org-link-protocols)))
  7526. (defvar org-agenda-buffer-name)
  7527. ;;;###autoload
  7528. (defun org-store-link (arg)
  7529. "\\<org-mode-map>Store an org-link to the current location.
  7530. This link is added to `org-stored-links' and can later be inserted
  7531. into an org-buffer with \\[org-insert-link].
  7532. For some link types, a prefix arg is interpreted:
  7533. For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
  7534. For file links, arg negates `org-context-in-file-links'."
  7535. (interactive "P")
  7536. (org-load-modules-maybe)
  7537. (setq org-store-link-plist nil) ; reset
  7538. (org-with-limited-levels
  7539. (let (link cpltxt desc description search txt custom-id agenda-link)
  7540. (cond
  7541. ((run-hook-with-args-until-success 'org-store-link-functions)
  7542. (setq link (plist-get org-store-link-plist :link)
  7543. desc (or (plist-get org-store-link-plist :description) link)))
  7544. ((equal (buffer-name) "*Org Edit Src Example*")
  7545. (let (label gc)
  7546. (while (or (not label)
  7547. (save-excursion
  7548. (save-restriction
  7549. (widen)
  7550. (goto-char (point-min))
  7551. (re-search-forward
  7552. (regexp-quote (format org-coderef-label-format label))
  7553. nil t))))
  7554. (when label (message "Label exists already") (sit-for 2))
  7555. (setq label (read-string "Code line label: " label)))
  7556. (end-of-line 1)
  7557. (setq link (format org-coderef-label-format label))
  7558. (setq gc (- 79 (length link)))
  7559. (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
  7560. (insert link)
  7561. (setq link (concat "(" label ")") desc nil)))
  7562. ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
  7563. ;; We are in the agenda, link to referenced location
  7564. (let ((m (or (get-text-property (point) 'org-hd-marker)
  7565. (get-text-property (point) 'org-marker))))
  7566. (when m
  7567. (org-with-point-at m
  7568. (setq agenda-link
  7569. (if (interactive-p)
  7570. (call-interactively 'org-store-link)
  7571. (org-store-link nil)))))))
  7572. ((eq major-mode 'calendar-mode)
  7573. (let ((cd (calendar-cursor-to-date)))
  7574. (setq link
  7575. (format-time-string
  7576. (car org-time-stamp-formats)
  7577. (apply 'encode-time
  7578. (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
  7579. nil nil nil))))
  7580. (org-store-link-props :type "calendar" :date cd)))
  7581. ((eq major-mode 'w3-mode)
  7582. (setq cpltxt (if (and (buffer-name)
  7583. (not (string-match "Untitled" (buffer-name))))
  7584. (buffer-name)
  7585. (url-view-url t))
  7586. link (org-make-link (url-view-url t)))
  7587. (org-store-link-props :type "w3" :url (url-view-url t)))
  7588. ((eq major-mode 'w3m-mode)
  7589. (setq cpltxt (or w3m-current-title w3m-current-url)
  7590. link (org-make-link w3m-current-url))
  7591. (org-store-link-props :type "w3m" :url (url-view-url t)))
  7592. ((setq search (run-hook-with-args-until-success
  7593. 'org-create-file-search-functions))
  7594. (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
  7595. "::" search))
  7596. (setq cpltxt (or description link)))
  7597. ((eq major-mode 'image-mode)
  7598. (setq cpltxt (concat "file:"
  7599. (abbreviate-file-name buffer-file-name))
  7600. link (org-make-link cpltxt))
  7601. (org-store-link-props :type "image" :file buffer-file-name))
  7602. ((eq major-mode 'dired-mode)
  7603. ;; link to the file in the current line
  7604. (let ((file (dired-get-filename nil t)))
  7605. (setq file (if file
  7606. (abbreviate-file-name
  7607. (expand-file-name (dired-get-filename nil t)))
  7608. ;; otherwise, no file so use current directory.
  7609. default-directory))
  7610. (setq cpltxt (concat "file:" file)
  7611. link (org-make-link cpltxt))))
  7612. ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
  7613. (setq custom-id (org-entry-get nil "CUSTOM_ID"))
  7614. (cond
  7615. ((org-in-regexp "<<\\(.*?\\)>>")
  7616. (setq cpltxt
  7617. (concat "file:"
  7618. (abbreviate-file-name
  7619. (buffer-file-name (buffer-base-buffer)))
  7620. "::" (match-string 1))
  7621. link (org-make-link cpltxt)))
  7622. ((and (featurep 'org-id)
  7623. (or (eq org-link-to-org-use-id t)
  7624. (and (eq org-link-to-org-use-id 'create-if-interactive)
  7625. (interactive-p))
  7626. (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
  7627. (interactive-p)
  7628. (not custom-id))
  7629. (and org-link-to-org-use-id
  7630. (org-entry-get nil "ID"))))
  7631. ;; We can make a link using the ID.
  7632. (setq link (condition-case nil
  7633. (prog1 (org-id-store-link)
  7634. (setq desc (plist-get org-store-link-plist
  7635. :description)))
  7636. (error
  7637. ;; probably before first headline, link to file only
  7638. (concat "file:"
  7639. (abbreviate-file-name
  7640. (buffer-file-name (buffer-base-buffer))))))))
  7641. (t
  7642. ;; Just link to current headline
  7643. (setq cpltxt (concat "file:"
  7644. (abbreviate-file-name
  7645. (buffer-file-name (buffer-base-buffer)))))
  7646. ;; Add a context search string
  7647. (when (org-xor org-context-in-file-links arg)
  7648. (setq txt (cond
  7649. ((org-on-heading-p) nil)
  7650. ((org-region-active-p)
  7651. (buffer-substring (region-beginning) (region-end)))
  7652. (t nil)))
  7653. (when (or (null txt) (string-match "\\S-" txt))
  7654. (setq cpltxt
  7655. (concat cpltxt "::"
  7656. (condition-case nil
  7657. (org-make-org-heading-search-string txt)
  7658. (error "")))
  7659. desc (or (nth 4 (ignore-errors
  7660. (org-heading-components))) "NONE"))))
  7661. (if (string-match "::\\'" cpltxt)
  7662. (setq cpltxt (substring cpltxt 0 -2)))
  7663. (setq link (org-make-link cpltxt)))))
  7664. ((buffer-file-name (buffer-base-buffer))
  7665. ;; Just link to this file here.
  7666. (setq cpltxt (concat "file:"
  7667. (abbreviate-file-name
  7668. (buffer-file-name (buffer-base-buffer)))))
  7669. ;; Add a context string
  7670. (when (org-xor org-context-in-file-links arg)
  7671. (setq txt (if (org-region-active-p)
  7672. (buffer-substring (region-beginning) (region-end))
  7673. (buffer-substring (point-at-bol) (point-at-eol))))
  7674. ;; Only use search option if there is some text.
  7675. (when (string-match "\\S-" txt)
  7676. (setq cpltxt
  7677. (concat cpltxt "::" (org-make-org-heading-search-string txt))
  7678. desc "NONE")))
  7679. (setq link (org-make-link cpltxt)))
  7680. ((interactive-p)
  7681. (error "Cannot link to a buffer which is not visiting a file"))
  7682. (t (setq link nil)))
  7683. (if (consp link) (setq cpltxt (car link) link (cdr link)))
  7684. (setq link (or link cpltxt)
  7685. desc (or desc cpltxt))
  7686. (if (equal desc "NONE") (setq desc nil))
  7687. (if (and (or (interactive-p) executing-kbd-macro) link)
  7688. (progn
  7689. (setq org-stored-links
  7690. (cons (list link desc) org-stored-links))
  7691. (message "Stored: %s" (or desc link))
  7692. (when custom-id
  7693. (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
  7694. "::#" custom-id))
  7695. (setq org-stored-links
  7696. (cons (list link desc) org-stored-links))))
  7697. (or agenda-link (and link (org-make-link-string link desc)))))))
  7698. (defun org-store-link-props (&rest plist)
  7699. "Store link properties, extract names and addresses."
  7700. (let (x adr)
  7701. (when (setq x (plist-get plist :from))
  7702. (setq adr (mail-extract-address-components x))
  7703. (setq plist (plist-put plist :fromname (car adr)))
  7704. (setq plist (plist-put plist :fromaddress (nth 1 adr))))
  7705. (when (setq x (plist-get plist :to))
  7706. (setq adr (mail-extract-address-components x))
  7707. (setq plist (plist-put plist :toname (car adr)))
  7708. (setq plist (plist-put plist :toaddress (nth 1 adr)))))
  7709. (let ((from (plist-get plist :from))
  7710. (to (plist-get plist :to)))
  7711. (when (and from to org-from-is-user-regexp)
  7712. (setq plist
  7713. (plist-put plist :fromto
  7714. (if (string-match org-from-is-user-regexp from)
  7715. (concat "to %t")
  7716. (concat "from %f"))))))
  7717. (setq org-store-link-plist plist))
  7718. (defun org-add-link-props (&rest plist)
  7719. "Add these properties to the link property list."
  7720. (let (key value)
  7721. (while plist
  7722. (setq key (pop plist) value (pop plist))
  7723. (setq org-store-link-plist
  7724. (plist-put org-store-link-plist key value)))))
  7725. (defun org-email-link-description (&optional fmt)
  7726. "Return the description part of an email link.
  7727. This takes information from `org-store-link-plist' and formats it
  7728. according to FMT (default from `org-email-link-description-format')."
  7729. (setq fmt (or fmt org-email-link-description-format))
  7730. (let* ((p org-store-link-plist)
  7731. (to (plist-get p :toaddress))
  7732. (from (plist-get p :fromaddress))
  7733. (table
  7734. (list
  7735. (cons "%c" (plist-get p :fromto))
  7736. (cons "%F" (plist-get p :from))
  7737. (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
  7738. (cons "%T" (plist-get p :to))
  7739. (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
  7740. (cons "%s" (plist-get p :subject))
  7741. (cons "%d" (plist-get p :date))
  7742. (cons "%m" (plist-get p :message-id)))))
  7743. (when (string-match "%c" fmt)
  7744. ;; Check if the user wrote this message
  7745. (if (and org-from-is-user-regexp from to
  7746. (save-match-data (string-match org-from-is-user-regexp from)))
  7747. (setq fmt (replace-match "to %t" t t fmt))
  7748. (setq fmt (replace-match "from %f" t t fmt))))
  7749. (org-replace-escapes fmt table)))
  7750. (defun org-make-org-heading-search-string (&optional string heading)
  7751. "Make search string for STRING or current headline."
  7752. (interactive)
  7753. (let ((s (or string (org-get-heading)))
  7754. (lines org-context-in-file-links))
  7755. (unless (and string (not heading))
  7756. ;; We are using a headline, clean up garbage in there.
  7757. (if (string-match org-todo-regexp s)
  7758. (setq s (replace-match "" t t s)))
  7759. (if (string-match (org-re ":[[:alnum:]_@#%:]+:[ \t]*$") s)
  7760. (setq s (replace-match "" t t s)))
  7761. (setq s (org-trim s))
  7762. (if (string-match (concat "^\\(" org-quote-string "\\|"
  7763. org-comment-string "\\)") s)
  7764. (setq s (replace-match "" t t s)))
  7765. (while (string-match org-ts-regexp s)
  7766. (setq s (replace-match "" t t s))))
  7767. (or string (setq s (concat "*" s))) ; Add * for headlines
  7768. (when (and string (integerp lines) (> lines 0))
  7769. (let ((slines (org-split-string s "\n")))
  7770. (when (< lines (length slines))
  7771. (setq s (mapconcat
  7772. 'identity
  7773. (reverse (nthcdr (- (length slines) lines)
  7774. (reverse slines))) "\n")))))
  7775. (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
  7776. (defun org-make-link (&rest strings)
  7777. "Concatenate STRINGS."
  7778. (apply 'concat strings))
  7779. (defun org-make-link-string (link &optional description)
  7780. "Make a link with brackets, consisting of LINK and DESCRIPTION."
  7781. (unless (string-match "\\S-" link)
  7782. (error "Empty link"))
  7783. (when (and description
  7784. (stringp description)
  7785. (not (string-match "\\S-" description)))
  7786. (setq description nil))
  7787. (when (stringp description)
  7788. ;; Remove brackets from the description, they are fatal.
  7789. (while (string-match "\\[" description)
  7790. (setq description (replace-match "{" t t description)))
  7791. (while (string-match "\\]" description)
  7792. (setq description (replace-match "}" t t description))))
  7793. (when (equal (org-link-escape link) description)
  7794. ;; No description needed, it is identical
  7795. (setq description nil))
  7796. (when (and (not description)
  7797. (not (equal link (org-link-escape link))))
  7798. (setq description (org-extract-attributes link)))
  7799. (setq link (if (string-match org-link-types-re link)
  7800. (concat (match-string 1 link)
  7801. (org-link-escape (substring link (match-end 1))))
  7802. (org-link-escape link)))
  7803. (concat "[[" link "]"
  7804. (if description (concat "[" description "]") "")
  7805. "]"))
  7806. (defconst org-link-escape-chars
  7807. '(?\ ?\[ ?\] ?\; ?\= ?\+)
  7808. "List of characters that should be escaped in link.
  7809. This is the list that is used for internal purposes.")
  7810. (defvar org-url-encoding-use-url-hexify nil)
  7811. (defconst org-link-escape-chars-browser
  7812. '(?\ )
  7813. "List of escapes for characters that are problematic in links.
  7814. This is the list that is used before handing over to the browser.")
  7815. (defun org-link-escape (text &optional table merge)
  7816. "Return percent escaped representation of TEXT.
  7817. TEXT is a string with the text to escape.
  7818. Optional argument TABLE is a list with characters that should be
  7819. escaped. When nil, `org-link-escape-chars' is used.
  7820. If optional argument MERGE is set, merge TABLE into
  7821. `org-link-escape-chars'."
  7822. (if (and org-url-encoding-use-url-hexify (not table))
  7823. (url-hexify-string text)
  7824. (cond
  7825. ((and table merge)
  7826. (mapc (lambda (defchr)
  7827. (unless (member defchr table)
  7828. (setq table (cons defchr table)))) org-link-escape-chars))
  7829. ((null table)
  7830. (setq table org-link-escape-chars)))
  7831. (mapconcat
  7832. (lambda (char)
  7833. (if (or (member char table)
  7834. (< char 32) (= char 37) (> char 126))
  7835. (mapconcat (lambda (sequence-element)
  7836. (format "%%%.2X" sequence-element))
  7837. (or (encode-coding-char char 'utf-8)
  7838. (error "Unable to percent escape character: %s"
  7839. (char-to-string char))) "")
  7840. (char-to-string char))) text "")))
  7841. (defun org-link-unescape (str)
  7842. "Unhex hexified unicode strings as returned from the JavaScript function
  7843. encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
  7844. (unless (and (null str) (string= "" str))
  7845. (let ((pos 0) (case-fold-search t) unhexed)
  7846. (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
  7847. (setq unhexed (org-link-unescape-compound (match-string 0 str)))
  7848. (setq str (replace-match unhexed t t str))
  7849. (setq pos (+ pos (length unhexed))))))
  7850. str)
  7851. (defun org-link-unescape-compound (hex)
  7852. "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
  7853. Note: this function also decodes single byte encodings like
  7854. `%E1' (\"á\") if not followed by another `%[A-F0-9]{2}' group."
  7855. (save-match-data
  7856. (let* ((bytes (cdr (split-string hex "%")))
  7857. (ret "")
  7858. (eat 0)
  7859. (sum 0))
  7860. (while bytes
  7861. (let* ((val (string-to-number (pop bytes) 16))
  7862. (shift-xor
  7863. (if (= 0 eat)
  7864. (cond
  7865. ((>= val 252) (cons 6 252))
  7866. ((>= val 248) (cons 5 248))
  7867. ((>= val 240) (cons 4 240))
  7868. ((>= val 224) (cons 3 224))
  7869. ((>= val 192) (cons 2 192))
  7870. (t (cons 0 0)))
  7871. (cons 6 128))))
  7872. (if (>= val 192) (setq eat (car shift-xor)))
  7873. (setq val (logxor val (cdr shift-xor)))
  7874. (setq sum (+ (lsh sum (car shift-xor)) val))
  7875. (if (> eat 0) (setq eat (- eat 1)))
  7876. (cond
  7877. ((= 0 eat) ;multi byte
  7878. (setq ret (concat ret (org-char-to-string sum)))
  7879. (setq sum 0))
  7880. ((not bytes) ; single byte(s)
  7881. (setq ret (org-link-unescape-single-byte-sequence hex))))
  7882. )) ;; end (while bytes
  7883. ret )))
  7884. (defun org-link-unescape-single-byte-sequence (hex)
  7885. "Unhexify hex-encoded single byte character sequences."
  7886. (mapconcat (lambda (byte)
  7887. (char-to-string (string-to-number byte 16)))
  7888. (cdr (split-string hex "%")) ""))
  7889. (defun org-xor (a b)
  7890. "Exclusive or."
  7891. (if a (not b) b))
  7892. (defun org-fixup-message-id-for-http (s)
  7893. "Replace special characters in a message id, so it can be used in an http query."
  7894. (when (string-match "%" s)
  7895. (setq s (mapconcat (lambda (c)
  7896. (if (eq c ?%)
  7897. "%25"
  7898. (char-to-string c)))
  7899. s "")))
  7900. (while (string-match "<" s)
  7901. (setq s (replace-match "%3C" t t s)))
  7902. (while (string-match ">" s)
  7903. (setq s (replace-match "%3E" t t s)))
  7904. (while (string-match "@" s)
  7905. (setq s (replace-match "%40" t t s)))
  7906. s)
  7907. ;;;###autoload
  7908. (defun org-insert-link-global ()
  7909. "Insert a link like Org-mode does.
  7910. This command can be called in any mode to insert a link in Org-mode syntax."
  7911. (interactive)
  7912. (org-load-modules-maybe)
  7913. (org-run-like-in-org-mode 'org-insert-link))
  7914. (defun org-insert-link (&optional complete-file link-location)
  7915. "Insert a link. At the prompt, enter the link.
  7916. Completion can be used to insert any of the link protocol prefixes like
  7917. http or ftp in use.
  7918. The history can be used to select a link previously stored with
  7919. `org-store-link'. When the empty string is entered (i.e. if you just
  7920. press RET at the prompt), the link defaults to the most recently
  7921. stored link. As SPC triggers completion in the minibuffer, you need to
  7922. use M-SPC or C-q SPC to force the insertion of a space character.
  7923. You will also be prompted for a description, and if one is given, it will
  7924. be displayed in the buffer instead of the link.
  7925. If there is already a link at point, this command will allow you to edit link
  7926. and description parts.
  7927. With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
  7928. be selected using completion. The path to the file will be relative to the
  7929. current directory if the file is in the current directory or a subdirectory.
  7930. Otherwise, the link will be the absolute path as completed in the minibuffer
  7931. \(i.e. normally ~/path/to/file). You can configure this behavior using the
  7932. option `org-link-file-path-type'.
  7933. With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
  7934. the current directory or below.
  7935. With three \\[universal-argument] prefixes, negate the meaning of
  7936. `org-keep-stored-link-after-insertion'.
  7937. If `org-make-link-description-function' is non-nil, this function will be
  7938. called with the link target, and the result will be the default
  7939. link description.
  7940. If the LINK-LOCATION parameter is non-nil, this value will be
  7941. used as the link location instead of reading one interactively."
  7942. (interactive "P")
  7943. (let* ((wcf (current-window-configuration))
  7944. (region (if (org-region-active-p)
  7945. (buffer-substring (region-beginning) (region-end))))
  7946. (remove (and region (list (region-beginning) (region-end))))
  7947. (desc region)
  7948. tmphist ; byte-compile incorrectly complains about this
  7949. (link link-location)
  7950. entry file all-prefixes)
  7951. (cond
  7952. (link-location) ; specified by arg, just use it.
  7953. ((org-in-regexp org-bracket-link-regexp 1)
  7954. ;; We do have a link at point, and we are going to edit it.
  7955. (setq remove (list (match-beginning 0) (match-end 0)))
  7956. (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
  7957. (setq link (read-string "Link: "
  7958. (org-link-unescape
  7959. (org-match-string-no-properties 1)))))
  7960. ((or (org-in-regexp org-angle-link-re)
  7961. (org-in-regexp org-plain-link-re))
  7962. ;; Convert to bracket link
  7963. (setq remove (list (match-beginning 0) (match-end 0))
  7964. link (read-string "Link: "
  7965. (org-remove-angle-brackets (match-string 0)))))
  7966. ((member complete-file '((4) (16)))
  7967. ;; Completing read for file names.
  7968. (setq link (org-file-complete-link complete-file)))
  7969. (t
  7970. ;; Read link, with completion for stored links.
  7971. (with-output-to-temp-buffer "*Org Links*"
  7972. (princ "Insert a link.
  7973. Use TAB to complete link prefixes, then RET for type-specific completion support\n")
  7974. (when org-stored-links
  7975. (princ "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
  7976. (princ (mapconcat
  7977. (lambda (x)
  7978. (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
  7979. (reverse org-stored-links) "\n"))))
  7980. (let ((cw (selected-window)))
  7981. (select-window (get-buffer-window "*Org Links*" 'visible))
  7982. (setq truncate-lines t)
  7983. (unless (pos-visible-in-window-p (point-max))
  7984. (org-fit-window-to-buffer))
  7985. (and (window-live-p cw) (select-window cw)))
  7986. ;; Fake a link history, containing the stored links.
  7987. (setq tmphist (append (mapcar 'car org-stored-links)
  7988. org-insert-link-history))
  7989. (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
  7990. (mapcar 'car org-link-abbrev-alist)
  7991. org-link-types))
  7992. (unwind-protect
  7993. (progn
  7994. (setq link
  7995. (let ((org-completion-use-ido nil)
  7996. (org-completion-use-iswitchb nil))
  7997. (org-completing-read
  7998. "Link: "
  7999. (append
  8000. (mapcar (lambda (x) (list (concat x ":")))
  8001. all-prefixes)
  8002. (mapcar 'car org-stored-links))
  8003. nil nil nil
  8004. 'tmphist
  8005. (car (car org-stored-links)))))
  8006. (if (not (string-match "\\S-" link))
  8007. (error "No link selected"))
  8008. (if (or (member link all-prefixes)
  8009. (and (equal ":" (substring link -1))
  8010. (member (substring link 0 -1) all-prefixes)
  8011. (setq link (substring link 0 -1))))
  8012. (setq link (org-link-try-special-completion link))))
  8013. (set-window-configuration wcf)
  8014. (kill-buffer "*Org Links*"))
  8015. (setq entry (assoc link org-stored-links))
  8016. (or entry (push link org-insert-link-history))
  8017. (if (funcall (if (equal complete-file '(64)) 'not 'identity)
  8018. (not org-keep-stored-link-after-insertion))
  8019. (setq org-stored-links (delq (assoc link org-stored-links)
  8020. org-stored-links)))
  8021. (setq desc (or desc (nth 1 entry)))))
  8022. (if (string-match org-plain-link-re link)
  8023. ;; URL-like link, normalize the use of angular brackets.
  8024. (setq link (org-make-link (org-remove-angle-brackets link))))
  8025. ;; Check if we are linking to the current file with a search option
  8026. ;; If yes, simplify the link by using only the search option.
  8027. (when (and buffer-file-name
  8028. (string-match "^file:\\(.+?\\)::\\([^>]+\\)" link))
  8029. (let* ((path (match-string 1 link))
  8030. (case-fold-search nil)
  8031. (search (match-string 2 link)))
  8032. (save-match-data
  8033. (if (equal (file-truename buffer-file-name) (file-truename path))
  8034. ;; We are linking to this same file, with a search option
  8035. (setq link search)))))
  8036. ;; Check if we can/should use a relative path. If yes, simplify the link
  8037. (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
  8038. (let* ((type (match-string 1 link))
  8039. (path (match-string 2 link))
  8040. (origpath path)
  8041. (case-fold-search nil))
  8042. (cond
  8043. ((or (eq org-link-file-path-type 'absolute)
  8044. (equal complete-file '(16)))
  8045. (setq path (abbreviate-file-name (expand-file-name path))))
  8046. ((eq org-link-file-path-type 'noabbrev)
  8047. (setq path (expand-file-name path)))
  8048. ((eq org-link-file-path-type 'relative)
  8049. (setq path (file-relative-name path)))
  8050. (t
  8051. (save-match-data
  8052. (if (string-match (concat "^" (regexp-quote
  8053. (expand-file-name
  8054. (file-name-as-directory
  8055. default-directory))))
  8056. (expand-file-name path))
  8057. ;; We are linking a file with relative path name.
  8058. (setq path (substring (expand-file-name path)
  8059. (match-end 0)))
  8060. (setq path (abbreviate-file-name (expand-file-name path)))))))
  8061. (setq link (concat type path))
  8062. (if (equal desc origpath)
  8063. (setq desc path))))
  8064. (if org-make-link-description-function
  8065. (setq desc (funcall org-make-link-description-function link desc)))
  8066. (setq desc (read-string "Description: " desc))
  8067. (unless (string-match "\\S-" desc) (setq desc nil))
  8068. (if remove (apply 'delete-region remove))
  8069. (insert (org-make-link-string link desc))))
  8070. (defun org-link-try-special-completion (type)
  8071. "If there is completion support for link type TYPE, offer it."
  8072. (let ((fun (intern (concat "org-" type "-complete-link"))))
  8073. (if (functionp fun)
  8074. (funcall fun)
  8075. (read-string "Link (no completion support): " (concat type ":")))))
  8076. (defun org-file-complete-link (&optional arg)
  8077. "Create a file link using completion."
  8078. (let (file link)
  8079. (setq file (read-file-name "File: "))
  8080. (let ((pwd (file-name-as-directory (expand-file-name ".")))
  8081. (pwd1 (file-name-as-directory (abbreviate-file-name
  8082. (expand-file-name ".")))))
  8083. (cond
  8084. ((equal arg '(16))
  8085. (setq link (org-make-link
  8086. "file:"
  8087. (abbreviate-file-name (expand-file-name file)))))
  8088. ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
  8089. (setq link (org-make-link "file:" (match-string 1 file))))
  8090. ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
  8091. (expand-file-name file))
  8092. (setq link (org-make-link
  8093. "file:" (match-string 1 (expand-file-name file)))))
  8094. (t (setq link (org-make-link "file:" file)))))
  8095. link))
  8096. (defun org-completing-read (&rest args)
  8097. "Completing-read with SPACE being a normal character."
  8098. (let ((minibuffer-local-completion-map
  8099. (copy-keymap minibuffer-local-completion-map)))
  8100. (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
  8101. (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
  8102. (apply 'org-icompleting-read args)))
  8103. (defun org-completing-read-no-i (&rest args)
  8104. (let (org-completion-use-ido org-completion-use-iswitchb)
  8105. (apply 'org-completing-read args)))
  8106. (defun org-iswitchb-completing-read (prompt choices &rest args)
  8107. "Use iswitch as a completing-read replacement to choose from choices.
  8108. PROMPT is a string to prompt with. CHOICES is a list of strings to choose
  8109. from."
  8110. (let* ((iswitchb-use-virtual-buffers nil)
  8111. (iswitchb-make-buflist-hook
  8112. (lambda ()
  8113. (setq iswitchb-temp-buflist choices))))
  8114. (iswitchb-read-buffer prompt)))
  8115. (defun org-icompleting-read (&rest args)
  8116. "Completing-read using `ido-mode' or `iswitchb' speedups if available."
  8117. (org-without-partial-completion
  8118. (if (and org-completion-use-ido
  8119. (fboundp 'ido-completing-read)
  8120. (boundp 'ido-mode) ido-mode
  8121. (listp (second args)))
  8122. (let ((ido-enter-matching-directory nil))
  8123. (apply 'ido-completing-read (concat (car args))
  8124. (if (consp (car (nth 1 args)))
  8125. (mapcar 'car (nth 1 args))
  8126. (nth 1 args))
  8127. (cddr args)))
  8128. (if (and org-completion-use-iswitchb
  8129. (boundp 'iswitchb-mode) iswitchb-mode
  8130. (listp (second args)))
  8131. (apply 'org-iswitchb-completing-read (concat (car args))
  8132. (if (consp (car (nth 1 args)))
  8133. (mapcar 'car (nth 1 args))
  8134. (nth 1 args))
  8135. (cddr args))
  8136. (apply 'completing-read args)))))
  8137. (defun org-extract-attributes (s)
  8138. "Extract the attributes cookie from a string and set as text property."
  8139. (let (a attr (start 0) key value)
  8140. (save-match-data
  8141. (when (string-match "{{\\([^}]+\\)}}$" s)
  8142. (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
  8143. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
  8144. (setq key (match-string 1 a) value (match-string 2 a)
  8145. start (match-end 0)
  8146. attr (plist-put attr (intern key) value))))
  8147. (org-add-props s nil 'org-attr attr))
  8148. s))
  8149. (defun org-extract-attributes-from-string (tag)
  8150. (let (key value attr)
  8151. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"\\s-?" tag)
  8152. (setq key (match-string 1 tag) value (match-string 2 tag)
  8153. tag (replace-match "" t t tag)
  8154. attr (plist-put attr (intern key) value)))
  8155. (cons tag attr)))
  8156. (defun org-attributes-to-string (plist)
  8157. "Format a property list into an HTML attribute list."
  8158. (let ((s "") key value)
  8159. (while plist
  8160. (setq key (pop plist) value (pop plist))
  8161. (and value
  8162. (setq s (concat s " " (symbol-name key) "=\"" value "\""))))
  8163. s))
  8164. ;;; Opening/following a link
  8165. (defvar org-link-search-failed nil)
  8166. (defvar org-open-link-functions nil
  8167. "Hook for functions finding a plain text link.
  8168. These functions must take a single argument, the link content.
  8169. They will be called for links that look like [[link text][description]]
  8170. when LINK TEXT does not have a protocol like \"http:\" and does not look
  8171. like a filename (e.g. \"./blue.png\").
  8172. These functions will be called *before* Org attempts to resolve the
  8173. link by doing text searches in the current buffer - so if you want a
  8174. link \"[[target]]\" to still find \"<<target>>\", your function should
  8175. handle this as a special case.
  8176. When the function does handle the link, it must return a non-nil value.
  8177. If it decides that it is not responsible for this link, it must return
  8178. nil to indicate that that Org-mode can continue with other options
  8179. like exact and fuzzy text search.")
  8180. (defun org-next-link ()
  8181. "Move forward to the next link.
  8182. If the link is in hidden text, expose it."
  8183. (interactive)
  8184. (when (and org-link-search-failed (eq this-command last-command))
  8185. (goto-char (point-min))
  8186. (message "Link search wrapped back to beginning of buffer"))
  8187. (setq org-link-search-failed nil)
  8188. (let* ((pos (point))
  8189. (ct (org-context))
  8190. (a (assoc :link ct)))
  8191. (if a (goto-char (nth 2 a)))
  8192. (if (re-search-forward org-any-link-re nil t)
  8193. (progn
  8194. (goto-char (match-beginning 0))
  8195. (if (outline-invisible-p) (org-show-context)))
  8196. (goto-char pos)
  8197. (setq org-link-search-failed t)
  8198. (error "No further link found"))))
  8199. (defun org-previous-link ()
  8200. "Move backward to the previous link.
  8201. If the link is in hidden text, expose it."
  8202. (interactive)
  8203. (when (and org-link-search-failed (eq this-command last-command))
  8204. (goto-char (point-max))
  8205. (message "Link search wrapped back to end of buffer"))
  8206. (setq org-link-search-failed nil)
  8207. (let* ((pos (point))
  8208. (ct (org-context))
  8209. (a (assoc :link ct)))
  8210. (if a (goto-char (nth 1 a)))
  8211. (if (re-search-backward org-any-link-re nil t)
  8212. (progn
  8213. (goto-char (match-beginning 0))
  8214. (if (outline-invisible-p) (org-show-context)))
  8215. (goto-char pos)
  8216. (setq org-link-search-failed t)
  8217. (error "No further link found"))))
  8218. (defun org-translate-link (s)
  8219. "Translate a link string if a translation function has been defined."
  8220. (if (and org-link-translation-function
  8221. (fboundp org-link-translation-function)
  8222. (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
  8223. (progn
  8224. (setq s (funcall org-link-translation-function
  8225. (match-string 1) (match-string 2)))
  8226. (concat (car s) ":" (cdr s)))
  8227. s))
  8228. (defun org-translate-link-from-planner (type path)
  8229. "Translate a link from Emacs Planner syntax so that Org can follow it.
  8230. This is still an experimental function, your mileage may vary."
  8231. (cond
  8232. ((member type '("http" "https" "news" "ftp"))
  8233. ;; standard Internet links are the same.
  8234. nil)
  8235. ((and (equal type "irc") (string-match "^//" path))
  8236. ;; Planner has two / at the beginning of an irc link, we have 1.
  8237. ;; We should have zero, actually....
  8238. (setq path (substring path 1)))
  8239. ((and (equal type "lisp") (string-match "^/" path))
  8240. ;; Planner has a slash, we do not.
  8241. (setq type "elisp" path (substring path 1)))
  8242. ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
  8243. ;; A typical message link. Planner has the id after the final slash,
  8244. ;; we separate it with a hash mark
  8245. (setq path (concat (match-string 1 path) "#"
  8246. (org-remove-angle-brackets (match-string 2 path)))))
  8247. )
  8248. (cons type path))
  8249. (defun org-find-file-at-mouse (ev)
  8250. "Open file link or URL at mouse."
  8251. (interactive "e")
  8252. (mouse-set-point ev)
  8253. (org-open-at-point 'in-emacs))
  8254. (defun org-open-at-mouse (ev)
  8255. "Open file link or URL at mouse."
  8256. (interactive "e")
  8257. (mouse-set-point ev)
  8258. (if (eq major-mode 'org-agenda-mode)
  8259. (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
  8260. (org-open-at-point))
  8261. (defvar org-window-config-before-follow-link nil
  8262. "The window configuration before following a link.
  8263. This is saved in case the need arises to restore it.")
  8264. (defvar org-open-link-marker (make-marker)
  8265. "Marker pointing to the location where `org-open-at-point; was called.")
  8266. ;;;###autoload
  8267. (defun org-open-at-point-global ()
  8268. "Follow a link like Org-mode does.
  8269. This command can be called in any mode to follow a link that has
  8270. Org-mode syntax."
  8271. (interactive)
  8272. (org-run-like-in-org-mode 'org-open-at-point))
  8273. ;;;###autoload
  8274. (defun org-open-link-from-string (s &optional arg reference-buffer)
  8275. "Open a link in the string S, as if it was in Org-mode."
  8276. (interactive "sLink: \nP")
  8277. (let ((reference-buffer (or reference-buffer (current-buffer))))
  8278. (with-temp-buffer
  8279. (let ((org-inhibit-startup t))
  8280. (org-mode)
  8281. (insert s)
  8282. (goto-char (point-min))
  8283. (when reference-buffer
  8284. (setq org-link-abbrev-alist-local
  8285. (with-current-buffer reference-buffer
  8286. org-link-abbrev-alist-local)))
  8287. (org-open-at-point arg reference-buffer)))))
  8288. (defvar org-open-at-point-functions nil
  8289. "Hook that is run when following a link at point.
  8290. Functions in this hook must return t if they identify and follow
  8291. a link at point. If they don't find anything interesting at point,
  8292. they must return nil.")
  8293. (defun org-open-at-point (&optional arg reference-buffer)
  8294. "Open link at or after point.
  8295. If there is no link at point, this function will search forward up to
  8296. the end of the current line.
  8297. Normally, files will be opened by an appropriate application. If the
  8298. optional prefix argument ARG is non-nil, Emacs will visit the file.
  8299. With a double prefix argument, try to open outside of Emacs, in the
  8300. application the system uses for this file type."
  8301. (interactive "P")
  8302. ;; if in a code block, then open the block's results
  8303. (unless (call-interactively #'org-babel-open-src-block-result)
  8304. (org-load-modules-maybe)
  8305. (move-marker org-open-link-marker (point))
  8306. (setq org-window-config-before-follow-link (current-window-configuration))
  8307. (org-remove-occur-highlights nil nil t)
  8308. (cond
  8309. ((and (org-on-heading-p)
  8310. (not (org-in-regexp
  8311. (concat org-plain-link-re "\\|"
  8312. org-bracket-link-regexp "\\|"
  8313. org-angle-link-re "\\|"
  8314. "[ \t]:[^ \t\n]+:[ \t]*$")))
  8315. (not (get-text-property (point) 'org-linked-text)))
  8316. (or (org-offer-links-in-entry arg)
  8317. (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
  8318. ((run-hook-with-args-until-success 'org-open-at-point-functions))
  8319. ((org-at-timestamp-p t) (org-follow-timestamp-link))
  8320. ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
  8321. (not (org-in-regexp org-bracket-link-regexp)))
  8322. (org-footnote-action))
  8323. (t
  8324. (let (type path link line search (pos (point)))
  8325. (catch 'match
  8326. (save-excursion
  8327. (skip-chars-forward "^]\n\r")
  8328. (when (org-in-regexp org-bracket-link-regexp 1)
  8329. (setq link (org-extract-attributes
  8330. (org-link-unescape (org-match-string-no-properties 1))))
  8331. (while (string-match " *\n *" link)
  8332. (setq link (replace-match " " t t link)))
  8333. (setq link (org-link-expand-abbrev link))
  8334. (cond
  8335. ((or (file-name-absolute-p link)
  8336. (string-match "^\\.\\.?/" link))
  8337. (setq type "file" path link))
  8338. ((string-match org-link-re-with-space3 link)
  8339. (setq type (match-string 1 link) path (match-string 2 link)))
  8340. (t (setq type "thisfile" path link)))
  8341. (throw 'match t)))
  8342. (when (get-text-property (point) 'org-linked-text)
  8343. (setq type "thisfile"
  8344. pos (if (get-text-property (1+ (point)) 'org-linked-text)
  8345. (1+ (point)) (point))
  8346. path (buffer-substring
  8347. (or (previous-single-property-change pos 'org-linked-text)
  8348. (point-min))
  8349. (or (next-single-property-change pos 'org-linked-text)
  8350. (point-max))))
  8351. (throw 'match t))
  8352. (save-excursion
  8353. (when (or (org-in-regexp org-angle-link-re)
  8354. (org-in-regexp org-plain-link-re))
  8355. (setq type (match-string 1) path (match-string 2))
  8356. (throw 'match t)))
  8357. (save-excursion
  8358. (when (org-in-regexp (org-re "\\(:[[:alnum:]_@#%:]+\\):[ \t]*$"))
  8359. (setq type "tags"
  8360. path (match-string 1))
  8361. (while (string-match ":" path)
  8362. (setq path (replace-match "+" t t path)))
  8363. (throw 'match t)))
  8364. (when (org-in-regexp "<\\([^><\n]+\\)>")
  8365. (setq type "tree-match"
  8366. path (match-string 1))
  8367. (throw 'match t)))
  8368. (unless path
  8369. (error "No link found"))
  8370. ;; switch back to reference buffer
  8371. ;; needed when if called in a temporary buffer through
  8372. ;; org-open-link-from-string
  8373. (with-current-buffer (or reference-buffer (current-buffer))
  8374. ;; Remove any trailing spaces in path
  8375. (if (string-match " +\\'" path)
  8376. (setq path (replace-match "" t t path)))
  8377. (if (and org-link-translation-function
  8378. (fboundp org-link-translation-function))
  8379. ;; Check if we need to translate the link
  8380. (let ((tmp (funcall org-link-translation-function type path)))
  8381. (setq type (car tmp) path (cdr tmp))))
  8382. (cond
  8383. ((assoc type org-link-protocols)
  8384. (funcall (nth 1 (assoc type org-link-protocols)) path))
  8385. ((equal type "mailto")
  8386. (let ((cmd (car org-link-mailto-program))
  8387. (args (cdr org-link-mailto-program)) args1
  8388. (address path) (subject "") a)
  8389. (if (string-match "\\(.*\\)::\\(.*\\)" path)
  8390. (setq address (match-string 1 path)
  8391. subject (org-link-escape (match-string 2 path))))
  8392. (while args
  8393. (cond
  8394. ((not (stringp (car args))) (push (pop args) args1))
  8395. (t (setq a (pop args))
  8396. (if (string-match "%a" a)
  8397. (setq a (replace-match address t t a)))
  8398. (if (string-match "%s" a)
  8399. (setq a (replace-match subject t t a)))
  8400. (push a args1))))
  8401. (apply cmd (nreverse args1))))
  8402. ((member type '("http" "https" "ftp" "news"))
  8403. (browse-url (concat type ":" (org-link-escape
  8404. path org-link-escape-chars-browser))))
  8405. ((string= type "doi")
  8406. (browse-url (concat "http://dx.doi.org/"
  8407. (org-link-escape
  8408. path org-link-escape-chars-browser))))
  8409. ((member type '("message"))
  8410. (browse-url (concat type ":" path)))
  8411. ((string= type "tags")
  8412. (org-tags-view arg path))
  8413. ((string= type "tree-match")
  8414. (org-occur (concat "\\[" (regexp-quote path) "\\]")))
  8415. ((string= type "file")
  8416. (if (string-match "::\\([0-9]+\\)\\'" path)
  8417. (setq line (string-to-number (match-string 1 path))
  8418. path (substring path 0 (match-beginning 0)))
  8419. (if (string-match "::\\(.+\\)\\'" path)
  8420. (setq search (match-string 1 path)
  8421. path (substring path 0 (match-beginning 0)))))
  8422. (if (string-match "[*?{]" (file-name-nondirectory path))
  8423. (dired path)
  8424. (org-open-file path arg line search)))
  8425. ((string= type "shell")
  8426. (let ((cmd path))
  8427. (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
  8428. (string-match org-confirm-shell-link-not-regexp cmd))
  8429. (not org-confirm-shell-link-function)
  8430. (funcall org-confirm-shell-link-function
  8431. (format "Execute \"%s\" in shell? "
  8432. (org-add-props cmd nil
  8433. 'face 'org-warning))))
  8434. (progn
  8435. (message "Executing %s" cmd)
  8436. (shell-command cmd))
  8437. (error "Abort"))))
  8438. ((string= type "elisp")
  8439. (let ((cmd path))
  8440. (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
  8441. (string-match org-confirm-elisp-link-not-regexp cmd))
  8442. (not org-confirm-elisp-link-function)
  8443. (funcall org-confirm-elisp-link-function
  8444. (format "Execute \"%s\" as elisp? "
  8445. (org-add-props cmd nil
  8446. 'face 'org-warning))))
  8447. (message "%s => %s" cmd
  8448. (if (equal (string-to-char cmd) ?\()
  8449. (eval (read cmd))
  8450. (call-interactively (read cmd))))
  8451. (error "Abort"))))
  8452. ((and (string= type "thisfile")
  8453. (run-hook-with-args-until-success
  8454. 'org-open-link-functions path)))
  8455. ((string= type "thisfile")
  8456. (if arg
  8457. (switch-to-buffer-other-window
  8458. (org-get-buffer-for-internal-link (current-buffer)))
  8459. (org-mark-ring-push))
  8460. (let ((cmd `(org-link-search
  8461. ,path
  8462. ,(cond ((equal arg '(4)) ''occur)
  8463. ((equal arg '(16)) ''org-occur)
  8464. (t nil))
  8465. ,pos)))
  8466. (condition-case nil (eval cmd)
  8467. (error (progn (widen) (eval cmd))))))
  8468. (t
  8469. (browse-url-at-point)))))))
  8470. (move-marker org-open-link-marker nil)
  8471. (run-hook-with-args 'org-follow-link-hook)))
  8472. (defun org-offer-links-in-entry (&optional nth zero)
  8473. "Offer links in the current entry and follow the selected link.
  8474. If there is only one link, follow it immediately as well.
  8475. If NTH is an integer, immediately pick the NTH link found.
  8476. If ZERO is a string, check also this string for a link, and if
  8477. there is one, offer it as link number zero."
  8478. (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
  8479. "\\(" org-angle-link-re "\\)\\|"
  8480. "\\(" org-plain-link-re "\\)"))
  8481. (cnt ?0)
  8482. (in-emacs (if (integerp nth) nil nth))
  8483. have-zero end links link c)
  8484. (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
  8485. (push (match-string 0 zero) links)
  8486. (setq cnt (1- cnt) have-zero t))
  8487. (save-excursion
  8488. (org-back-to-heading t)
  8489. (setq end (save-excursion (outline-next-heading) (point)))
  8490. (while (re-search-forward re end t)
  8491. (push (match-string 0) links))
  8492. (setq links (org-uniquify (reverse links))))
  8493. (cond
  8494. ((null links)
  8495. (message "No links"))
  8496. ((equal (length links) 1)
  8497. (setq link (list (car links))))
  8498. ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
  8499. (setq link (nth (if have-zero nth (1- nth)) links)))
  8500. (t ; we have to select a link
  8501. (save-excursion
  8502. (save-window-excursion
  8503. (delete-other-windows)
  8504. (with-output-to-temp-buffer "*Select Link*"
  8505. (mapc (lambda (l)
  8506. (if (not (string-match org-bracket-link-regexp l))
  8507. (princ (format "[%c] %s\n" (incf cnt)
  8508. (org-remove-angle-brackets l)))
  8509. (if (match-end 3)
  8510. (princ (format "[%c] %s (%s)\n" (incf cnt)
  8511. (match-string 3 l) (match-string 1 l)))
  8512. (princ (format "[%c] %s\n" (incf cnt)
  8513. (match-string 1 l))))))
  8514. links))
  8515. (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
  8516. (message "Select link to open, RET to open all:")
  8517. (setq c (read-char-exclusive))
  8518. (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
  8519. (when (equal c ?q) (error "Abort"))
  8520. (if (equal c ?\C-m)
  8521. (setq link links)
  8522. (setq nth (- c ?0))
  8523. (if have-zero (setq nth (1+ nth)))
  8524. (unless (and (integerp nth) (>= (length links) nth))
  8525. (error "Invalid link selection"))
  8526. (setq link (list (nth (1- nth) links))))))
  8527. (if link
  8528. (let ((buf (current-buffer)))
  8529. (dolist (l link)
  8530. (org-open-link-from-string l in-emacs buf))
  8531. t)
  8532. nil)))
  8533. ;; Add special file links that specify the way of opening
  8534. (org-add-link-type "file+sys" 'org-open-file-with-system)
  8535. (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
  8536. (defun org-open-file-with-system (path)
  8537. "Open file at PATH using the system way of opening it."
  8538. (org-open-file path 'system))
  8539. (defun org-open-file-with-emacs (path)
  8540. "Open file at PATH in Emacs."
  8541. (org-open-file path 'emacs))
  8542. (defun org-remove-file-link-modifiers ()
  8543. "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
  8544. (goto-char (point-min))
  8545. (while (re-search-forward "\\<file\\+\\(sys\\|emacs\\):" nil t)
  8546. (org-if-unprotected
  8547. (replace-match "file:" t t))))
  8548. (eval-after-load "org-exp"
  8549. '(add-hook 'org-export-preprocess-before-normalizing-links-hook
  8550. 'org-remove-file-link-modifiers))
  8551. ;;;; Time estimates
  8552. (defun org-get-effort (&optional pom)
  8553. "Get the effort estimate for the current entry."
  8554. (org-entry-get pom org-effort-property))
  8555. ;;; File search
  8556. (defvar org-create-file-search-functions nil
  8557. "List of functions to construct the right search string for a file link.
  8558. These functions are called in turn with point at the location to
  8559. which the link should point.
  8560. A function in the hook should first test if it would like to
  8561. handle this file type, for example by checking the `major-mode'
  8562. or the file extension. If it decides not to handle this file, it
  8563. should just return nil to give other functions a chance. If it
  8564. does handle the file, it must return the search string to be used
  8565. when following the link. The search string will be part of the
  8566. file link, given after a double colon, and `org-open-at-point'
  8567. will automatically search for it. If special measures must be
  8568. taken to make the search successful, another function should be
  8569. added to the companion hook `org-execute-file-search-functions',
  8570. which see.
  8571. A function in this hook may also use `setq' to set the variable
  8572. `description' to provide a suggestion for the descriptive text to
  8573. be used for this link when it gets inserted into an Org-mode
  8574. buffer with \\[org-insert-link].")
  8575. (defvar org-execute-file-search-functions nil
  8576. "List of functions to execute a file search triggered by a link.
  8577. Functions added to this hook must accept a single argument, the
  8578. search string that was part of the file link, the part after the
  8579. double colon. The function must first check if it would like to
  8580. handle this search, for example by checking the `major-mode' or
  8581. the file extension. If it decides not to handle this search, it
  8582. should just return nil to give other functions a chance. If it
  8583. does handle the search, it must return a non-nil value to keep
  8584. other functions from trying.
  8585. Each function can access the current prefix argument through the
  8586. variable `current-prefix-argument'. Note that a single prefix is
  8587. used to force opening a link in Emacs, so it may be good to only
  8588. use a numeric or double prefix to guide the search function.
  8589. In case this is needed, a function in this hook can also restore
  8590. the window configuration before `org-open-at-point' was called using:
  8591. (set-window-configuration org-window-config-before-follow-link)")
  8592. (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
  8593. (defun org-link-search (s &optional type avoid-pos)
  8594. "Search for a link search option.
  8595. If S is surrounded by forward slashes, it is interpreted as a
  8596. regular expression. In org-mode files, this will create an `org-occur'
  8597. sparse tree. In ordinary files, `occur' will be used to list matches.
  8598. If the current buffer is in `dired-mode', grep will be used to search
  8599. in all files. If AVOID-POS is given, ignore matches near that position."
  8600. (let ((case-fold-search t)
  8601. (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
  8602. (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
  8603. (append '(("") (" ") ("\t") ("\n"))
  8604. org-emphasis-alist)
  8605. "\\|") "\\)"))
  8606. (pos (point))
  8607. (pre nil) (post nil)
  8608. words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
  8609. (cond
  8610. ;; First check if there are any special search functions
  8611. ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
  8612. ;; Now try the builtin stuff
  8613. ((and (equal (string-to-char s0) ?#)
  8614. (> (length s0) 1)
  8615. (save-excursion
  8616. (goto-char (point-min))
  8617. (and
  8618. (re-search-forward
  8619. (concat "^[ \t]*:CUSTOM_ID:[ \t]+" (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
  8620. (setq type 'dedicated
  8621. pos (match-beginning 0))))
  8622. ;; There is an exact target for this
  8623. (goto-char pos)
  8624. (org-back-to-heading t)))
  8625. ((save-excursion
  8626. (goto-char (point-min))
  8627. (and
  8628. (re-search-forward
  8629. (concat "<<" (regexp-quote s0) ">>") nil t)
  8630. (setq type 'dedicated
  8631. pos (match-beginning 0))))
  8632. ;; There is an exact target for this
  8633. (goto-char pos))
  8634. ((and (string-match "^(\\(.*\\))$" s0)
  8635. (save-excursion
  8636. (goto-char (point-min))
  8637. (and
  8638. (re-search-forward
  8639. (concat "[^[]" (regexp-quote
  8640. (format org-coderef-label-format
  8641. (match-string 1 s0))))
  8642. nil t)
  8643. (setq type 'dedicated
  8644. pos (1+ (match-beginning 0))))))
  8645. ;; There is a coderef target for this
  8646. (goto-char pos))
  8647. ((string-match "^/\\(.*\\)/$" s)
  8648. ;; A regular expression
  8649. (cond
  8650. ((org-mode-p)
  8651. (org-occur (match-string 1 s)))
  8652. ;;((eq major-mode 'dired-mode)
  8653. ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
  8654. (t (org-do-occur (match-string 1 s)))))
  8655. ((and (org-mode-p) org-link-search-must-match-exact-headline)
  8656. (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
  8657. (goto-char (point-min))
  8658. (cond
  8659. ((let (case-fold-search)
  8660. (re-search-forward (format org-complex-heading-regexp-format
  8661. (regexp-quote s))
  8662. nil t))
  8663. ;; OK, found a match
  8664. (setq type 'dedicated)
  8665. (goto-char (match-beginning 0)))
  8666. ((and (not org-link-search-inhibit-query)
  8667. (eq org-link-search-must-match-exact-headline 'query-to-create)
  8668. (y-or-n-p "No match - create this as a new heading? "))
  8669. (goto-char (point-max))
  8670. (or (bolp) (newline))
  8671. (insert "* " s "\n")
  8672. (beginning-of-line 0))
  8673. (t
  8674. (goto-char pos)
  8675. (error "No match"))))
  8676. (t
  8677. ;; A normal search string
  8678. (when (equal (string-to-char s) ?*)
  8679. ;; Anchor on headlines, post may include tags.
  8680. (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
  8681. post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
  8682. s (substring s 1)))
  8683. (remove-text-properties
  8684. 0 (length s)
  8685. '(face nil mouse-face nil keymap nil fontified nil) s)
  8686. ;; Make a series of regular expressions to find a match
  8687. (setq words (org-split-string s "[ \n\r\t]+")
  8688. re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
  8689. re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
  8690. "\\)" markers)
  8691. re2a_ (concat "\\(" (mapconcat 'downcase words "[ \t\r\n]+") "\\)[ \t\r\n]")
  8692. re2a (concat "[ \t\r\n]" re2a_)
  8693. re4_ (concat "\\(" (mapconcat 'downcase words "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
  8694. re4 (concat "[^a-zA-Z_]" re4_)
  8695. re1 (concat pre re2 post)
  8696. re3 (concat pre (if pre re4_ re4) post)
  8697. re5 (concat pre ".*" re4)
  8698. re2 (concat pre re2)
  8699. re2a (concat pre (if pre re2a_ re2a))
  8700. re4 (concat pre (if pre re4_ re4))
  8701. reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
  8702. "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
  8703. re5 "\\)"
  8704. ))
  8705. (cond
  8706. ((eq type 'org-occur) (org-occur reall))
  8707. ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
  8708. (t (goto-char (point-min))
  8709. (setq type 'fuzzy)
  8710. (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
  8711. (org-search-not-self 1 re1 nil t)
  8712. (org-search-not-self 1 re2 nil t)
  8713. (org-search-not-self 1 re2a nil t)
  8714. (org-search-not-self 1 re3 nil t)
  8715. (org-search-not-self 1 re4 nil t)
  8716. (org-search-not-self 1 re5 nil t)
  8717. )
  8718. (goto-char (match-beginning 1))
  8719. (goto-char pos)
  8720. (error "No match"))))))
  8721. (and (org-mode-p) (org-show-context 'link-search))
  8722. type))
  8723. (defun org-search-not-self (group &rest args)
  8724. "Execute `re-search-forward', but only accept matches that do not
  8725. enclose the position of `org-open-link-marker'."
  8726. (let ((m org-open-link-marker))
  8727. (catch 'exit
  8728. (while (apply 're-search-forward args)
  8729. (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
  8730. (goto-char (match-end group))
  8731. (if (and (or (not (eq (marker-buffer m) (current-buffer)))
  8732. (> (match-beginning 0) (marker-position m))
  8733. (< (match-end 0) (marker-position m)))
  8734. (save-match-data
  8735. (or (not (org-in-regexp
  8736. org-bracket-link-analytic-regexp 1))
  8737. (not (match-end 4)) ; no description
  8738. (and (<= (match-beginning 4) (point))
  8739. (>= (match-end 4) (point))))))
  8740. (throw 'exit (point))))))))
  8741. (defun org-get-buffer-for-internal-link (buffer)
  8742. "Return a buffer to be used for displaying the link target of internal links."
  8743. (cond
  8744. ((not org-display-internal-link-with-indirect-buffer)
  8745. buffer)
  8746. ((string-match "(Clone)$" (buffer-name buffer))
  8747. (message "Buffer is already a clone, not making another one")
  8748. ;; we also do not modify visibility in this case
  8749. buffer)
  8750. (t ; make a new indirect buffer for displaying the link
  8751. (let* ((bn (buffer-name buffer))
  8752. (ibn (concat bn "(Clone)"))
  8753. (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
  8754. (with-current-buffer ib (org-overview))
  8755. ib))))
  8756. (defun org-do-occur (regexp &optional cleanup)
  8757. "Call the Emacs command `occur'.
  8758. If CLEANUP is non-nil, remove the printout of the regular expression
  8759. in the *Occur* buffer. This is useful if the regex is long and not useful
  8760. to read."
  8761. (occur regexp)
  8762. (when cleanup
  8763. (let ((cwin (selected-window)) win beg end)
  8764. (when (setq win (get-buffer-window "*Occur*"))
  8765. (select-window win))
  8766. (goto-char (point-min))
  8767. (when (re-search-forward "match[a-z]+" nil t)
  8768. (setq beg (match-end 0))
  8769. (if (re-search-forward "^[ \t]*[0-9]+" nil t)
  8770. (setq end (1- (match-beginning 0)))))
  8771. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  8772. (goto-char (point-min))
  8773. (select-window cwin))))
  8774. ;;; The mark ring for links jumps
  8775. (defvar org-mark-ring nil
  8776. "Mark ring for positions before jumps in Org-mode.")
  8777. (defvar org-mark-ring-last-goto nil
  8778. "Last position in the mark ring used to go back.")
  8779. ;; Fill and close the ring
  8780. (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
  8781. (loop for i from 1 to org-mark-ring-length do
  8782. (push (make-marker) org-mark-ring))
  8783. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  8784. org-mark-ring)
  8785. (defun org-mark-ring-push (&optional pos buffer)
  8786. "Put the current position or POS into the mark ring and rotate it."
  8787. (interactive)
  8788. (setq pos (or pos (point)))
  8789. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  8790. (move-marker (car org-mark-ring)
  8791. (or pos (point))
  8792. (or buffer (current-buffer)))
  8793. (message "%s"
  8794. (substitute-command-keys
  8795. "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
  8796. (defun org-mark-ring-goto (&optional n)
  8797. "Jump to the previous position in the mark ring.
  8798. With prefix arg N, jump back that many stored positions. When
  8799. called several times in succession, walk through the entire ring.
  8800. Org-mode commands jumping to a different position in the current file,
  8801. or to another Org-mode file, automatically push the old position
  8802. onto the ring."
  8803. (interactive "p")
  8804. (let (p m)
  8805. (if (eq last-command this-command)
  8806. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  8807. (setq p org-mark-ring))
  8808. (setq org-mark-ring-last-goto p)
  8809. (setq m (car p))
  8810. (switch-to-buffer (marker-buffer m))
  8811. (goto-char m)
  8812. (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
  8813. (defun org-remove-angle-brackets (s)
  8814. (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
  8815. (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
  8816. s)
  8817. (defun org-add-angle-brackets (s)
  8818. (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
  8819. (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
  8820. s)
  8821. (defun org-remove-double-quotes (s)
  8822. (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
  8823. (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
  8824. s)
  8825. ;;; Following specific links
  8826. (defun org-follow-timestamp-link ()
  8827. (cond
  8828. ((org-at-date-range-p t)
  8829. (let ((org-agenda-start-on-weekday)
  8830. (t1 (match-string 1))
  8831. (t2 (match-string 2)))
  8832. (setq t1 (time-to-days (org-time-string-to-time t1))
  8833. t2 (time-to-days (org-time-string-to-time t2)))
  8834. (org-agenda-list nil t1 (1+ (- t2 t1)))))
  8835. ((org-at-timestamp-p t)
  8836. (org-agenda-list nil (time-to-days (org-time-string-to-time
  8837. (substring (match-string 1) 0 10)))
  8838. 1))
  8839. (t (error "This should not happen"))))
  8840. ;;; Following file links
  8841. (defvar org-wait nil)
  8842. (defun org-open-file (path &optional in-emacs line search)
  8843. "Open the file at PATH.
  8844. First, this expands any special file name abbreviations. Then the
  8845. configuration variable `org-file-apps' is checked if it contains an
  8846. entry for this file type, and if yes, the corresponding command is launched.
  8847. If no application is found, Emacs simply visits the file.
  8848. With optional prefix argument IN-EMACS, Emacs will visit the file.
  8849. With a double \\[universal-argument] \\[universal-argument] \
  8850. prefix arg, Org tries to avoid opening in Emacs
  8851. and to use an external application to visit the file.
  8852. Optional LINE specifies a line to go to, optional SEARCH a string
  8853. to search for. If LINE or SEARCH is given, the file will be
  8854. opened in Emacs, unless an entry from org-file-apps that makes
  8855. use of groups in a regexp matches.
  8856. If the file does not exist, an error is thrown."
  8857. (let* ((file (if (equal path "")
  8858. buffer-file-name
  8859. (substitute-in-file-name (expand-file-name path))))
  8860. (file-apps (append org-file-apps (org-default-apps)))
  8861. (apps (org-remove-if
  8862. 'org-file-apps-entry-match-against-dlink-p file-apps))
  8863. (apps-dlink (org-remove-if-not
  8864. 'org-file-apps-entry-match-against-dlink-p file-apps))
  8865. (remp (and (assq 'remote apps) (org-file-remote-p file)))
  8866. (dirp (if remp nil (file-directory-p file)))
  8867. (file (if (and dirp org-open-directory-means-index-dot-org)
  8868. (concat (file-name-as-directory file) "index.org")
  8869. file))
  8870. (a-m-a-p (assq 'auto-mode apps))
  8871. (dfile (downcase file))
  8872. ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
  8873. (link (cond ((and (eq line nil)
  8874. (eq search nil))
  8875. file)
  8876. (line
  8877. (concat file "::" (number-to-string line)))
  8878. (search
  8879. (concat file "::" search))))
  8880. (dlink (downcase link))
  8881. (old-buffer (current-buffer))
  8882. (old-pos (point))
  8883. (old-mode major-mode)
  8884. ext cmd link-match-data)
  8885. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
  8886. (setq ext (match-string 1 dfile))
  8887. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
  8888. (setq ext (match-string 1 dfile))))
  8889. (cond
  8890. ((member in-emacs '((16) system))
  8891. (setq cmd (cdr (assoc 'system apps))))
  8892. (in-emacs (setq cmd 'emacs))
  8893. (t
  8894. (setq cmd (or (and remp (cdr (assoc 'remote apps)))
  8895. (and dirp (cdr (assoc 'directory apps)))
  8896. ; first, try matching against apps-dlink
  8897. ; if we get a match here, store the match data for later
  8898. (let ((match (assoc-default dlink apps-dlink
  8899. 'string-match)))
  8900. (if match
  8901. (progn (setq link-match-data (match-data))
  8902. match)
  8903. (progn (setq in-emacs (or in-emacs line search))
  8904. nil))) ; if we have no match in apps-dlink,
  8905. ; always open the file in emacs if line or search
  8906. ; is given (for backwards compatibility)
  8907. (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
  8908. 'string-match)
  8909. (cdr (assoc ext apps))
  8910. (cdr (assoc t apps))))))
  8911. (when (eq cmd 'system)
  8912. (setq cmd (cdr (assoc 'system apps))))
  8913. (when (eq cmd 'default)
  8914. (setq cmd (cdr (assoc t apps))))
  8915. (when (eq cmd 'mailcap)
  8916. (require 'mailcap)
  8917. (mailcap-parse-mailcaps)
  8918. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  8919. (command (mailcap-mime-info mime-type)))
  8920. (if (stringp command)
  8921. (setq cmd command)
  8922. (setq cmd 'emacs))))
  8923. (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  8924. (not (file-exists-p file))
  8925. (not org-open-non-existing-files))
  8926. (error "No such file: %s" file))
  8927. (cond
  8928. ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
  8929. ;; Remove quotes around the file name - we'll use shell-quote-argument.
  8930. (while (string-match "['\"]%s['\"]" cmd)
  8931. (setq cmd (replace-match "%s" t t cmd)))
  8932. (while (string-match "%s" cmd)
  8933. (setq cmd (replace-match
  8934. (save-match-data
  8935. (shell-quote-argument
  8936. (convert-standard-filename file)))
  8937. t t cmd)))
  8938. ;; Replace "%1", "%2" etc. in command with group matches from regex
  8939. (save-match-data
  8940. (let ((match-index 1)
  8941. (number-of-groups (- (/ (length link-match-data) 2) 1)))
  8942. (set-match-data link-match-data)
  8943. (while (<= match-index number-of-groups)
  8944. (let ((regex (concat "%" (number-to-string match-index)))
  8945. (replace-with (match-string match-index dlink)))
  8946. (while (string-match regex cmd)
  8947. (setq cmd (replace-match replace-with t t cmd))))
  8948. (setq match-index (+ match-index 1)))))
  8949. (save-window-excursion
  8950. (start-process-shell-command cmd nil cmd)
  8951. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
  8952. ))
  8953. ((or (stringp cmd)
  8954. (eq cmd 'emacs))
  8955. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  8956. (widen)
  8957. (if line (org-goto-line line)
  8958. (if search (org-link-search search))))
  8959. ((consp cmd)
  8960. (let ((file (convert-standard-filename file)))
  8961. (save-match-data
  8962. (set-match-data link-match-data)
  8963. (eval cmd))))
  8964. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  8965. (and (org-mode-p) (eq old-mode 'org-mode)
  8966. (or (not (equal old-buffer (current-buffer)))
  8967. (not (equal old-pos (point))))
  8968. (org-mark-ring-push old-pos old-buffer))))
  8969. (defun org-file-apps-entry-match-against-dlink-p (entry)
  8970. "This function returns non-nil if `entry' uses a regular
  8971. expression which should be matched against the whole link by
  8972. org-open-file.
  8973. It assumes that is the case when the entry uses a regular
  8974. expression which has at least one grouping construct and the
  8975. action is either a lisp form or a command string containing
  8976. '%1', i.e. using at least one subexpression match as a
  8977. parameter."
  8978. (let ((selector (car entry))
  8979. (action (cdr entry)))
  8980. (if (stringp selector)
  8981. (and (> (regexp-opt-depth selector) 0)
  8982. (or (and (stringp action)
  8983. (string-match "%[0-9]" action))
  8984. (consp action)))
  8985. nil)))
  8986. (defun org-default-apps ()
  8987. "Return the default applications for this operating system."
  8988. (cond
  8989. ((eq system-type 'darwin)
  8990. org-file-apps-defaults-macosx)
  8991. ((eq system-type 'windows-nt)
  8992. org-file-apps-defaults-windowsnt)
  8993. (t org-file-apps-defaults-gnu)))
  8994. (defun org-apps-regexp-alist (list &optional add-auto-mode)
  8995. "Convert extensions to regular expressions in the cars of LIST.
  8996. Also, weed out any non-string entries, because the return value is used
  8997. only for regexp matching.
  8998. When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
  8999. point to the symbol `emacs', indicating that the file should
  9000. be opened in Emacs."
  9001. (append
  9002. (delq nil
  9003. (mapcar (lambda (x)
  9004. (if (not (stringp (car x)))
  9005. nil
  9006. (if (string-match "\\W" (car x))
  9007. x
  9008. (cons (concat "\\." (car x) "\\'") (cdr x)))))
  9009. list))
  9010. (if add-auto-mode
  9011. (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
  9012. (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
  9013. (defun org-file-remote-p (file)
  9014. "Test whether FILE specifies a location on a remote system.
  9015. Return non-nil if the location is indeed remote.
  9016. For example, the filename \"/user@host:/foo\" specifies a location
  9017. on the system \"/user@host:\"."
  9018. (cond ((fboundp 'file-remote-p)
  9019. (file-remote-p file))
  9020. ((fboundp 'tramp-handle-file-remote-p)
  9021. (tramp-handle-file-remote-p file))
  9022. ((and (boundp 'ange-ftp-name-format)
  9023. (string-match (car ange-ftp-name-format) file))
  9024. t)
  9025. (t nil)))
  9026. ;;;; Refiling
  9027. (defun org-get-org-file ()
  9028. "Read a filename, with default directory `org-directory'."
  9029. (let ((default (or org-default-notes-file remember-data-file)))
  9030. (read-file-name (format "File name [%s]: " default)
  9031. (file-name-as-directory org-directory)
  9032. default)))
  9033. (defun org-notes-order-reversed-p ()
  9034. "Check if the current file should receive notes in reversed order."
  9035. (cond
  9036. ((not org-reverse-note-order) nil)
  9037. ((eq t org-reverse-note-order) t)
  9038. ((not (listp org-reverse-note-order)) nil)
  9039. (t (catch 'exit
  9040. (let ((all org-reverse-note-order)
  9041. entry)
  9042. (while (setq entry (pop all))
  9043. (if (string-match (car entry) buffer-file-name)
  9044. (throw 'exit (cdr entry))))
  9045. nil)))))
  9046. (defvar org-refile-target-table nil
  9047. "The list of refile targets, created by `org-refile'.")
  9048. (defvar org-agenda-new-buffers nil
  9049. "Buffers created to visit agenda files.")
  9050. (defvar org-refile-cache nil
  9051. "Cache for refile targets.")
  9052. (defvar org-refile-markers nil
  9053. "All the markers used for caching refile locations.")
  9054. (defun org-refile-marker (pos)
  9055. "Get a new refile marker, but only if caching is in use."
  9056. (if (not org-refile-use-cache)
  9057. pos
  9058. (let ((m (make-marker)))
  9059. (move-marker m pos)
  9060. (push m org-refile-markers)
  9061. m)))
  9062. (defun org-refile-cache-clear ()
  9063. "Clear the refile cache and disable all the markers."
  9064. (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
  9065. (setq org-refile-markers nil)
  9066. (setq org-refile-cache nil)
  9067. (message "Refile cache has been cleared"))
  9068. (defun org-refile-cache-check-set (set)
  9069. "Check if all the markers in the cache still have live buffers."
  9070. (let (marker)
  9071. (catch 'exit
  9072. (while (and set (setq marker (nth 3 (pop set))))
  9073. ;; if org-refile-use-outline-path is 'file, marker may be nil
  9074. (when (and marker (null (marker-buffer marker)))
  9075. (message "not found") (sit-for 3)
  9076. (throw 'exit nil)))
  9077. t)))
  9078. (defun org-refile-cache-put (set &rest identifiers)
  9079. "Push the refile targets SET into the cache, under IDENTIFIERS."
  9080. (let* ((key (sha1 (prin1-to-string identifiers)))
  9081. (entry (assoc key org-refile-cache)))
  9082. (if entry
  9083. (setcdr entry set)
  9084. (push (cons key set) org-refile-cache))))
  9085. (defun org-refile-cache-get (&rest identifiers)
  9086. "Retrieve the cached value for refile targets given by IDENTIFIERS."
  9087. (cond
  9088. ((not org-refile-cache) nil)
  9089. ((not org-refile-use-cache) (org-refile-cache-clear) nil)
  9090. (t
  9091. (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
  9092. org-refile-cache))))
  9093. (and set (org-refile-cache-check-set set) set)))))
  9094. (defun org-refile-get-targets (&optional default-buffer)
  9095. "Produce a table with refile targets."
  9096. (let ((case-fold-search nil)
  9097. ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
  9098. (entries (or org-refile-targets '((nil . (:level . 1)))))
  9099. targets tgs txt re files f desc descre fast-path-p level pos0)
  9100. (message "Getting targets...")
  9101. (with-current-buffer (or default-buffer (current-buffer))
  9102. (while (setq entry (pop entries))
  9103. (setq files (car entry) desc (cdr entry))
  9104. (setq fast-path-p nil)
  9105. (cond
  9106. ((null files) (setq files (list (current-buffer))))
  9107. ((eq files 'org-agenda-files)
  9108. (setq files (org-agenda-files 'unrestricted)))
  9109. ((and (symbolp files) (fboundp files))
  9110. (setq files (funcall files)))
  9111. ((and (symbolp files) (boundp files))
  9112. (setq files (symbol-value files))))
  9113. (if (stringp files) (setq files (list files)))
  9114. (cond
  9115. ((eq (car desc) :tag)
  9116. (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
  9117. ((eq (car desc) :todo)
  9118. (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
  9119. ((eq (car desc) :regexp)
  9120. (setq descre (cdr desc)))
  9121. ((eq (car desc) :level)
  9122. (setq descre (concat "^\\*\\{" (number-to-string
  9123. (if org-odd-levels-only
  9124. (1- (* 2 (cdr desc)))
  9125. (cdr desc)))
  9126. "\\}[ \t]")))
  9127. ((eq (car desc) :maxlevel)
  9128. (setq fast-path-p t)
  9129. (setq descre (concat "^\\*\\{1," (number-to-string
  9130. (if org-odd-levels-only
  9131. (1- (* 2 (cdr desc)))
  9132. (cdr desc)))
  9133. "\\}[ \t]")))
  9134. (t (error "Bad refiling target description %s" desc)))
  9135. (while (setq f (pop files))
  9136. (with-current-buffer
  9137. (if (bufferp f) f (org-get-agenda-file-buffer f))
  9138. (or
  9139. (setq tgs (org-refile-cache-get (buffer-file-name) descre))
  9140. (progn
  9141. (if (bufferp f) (setq f (buffer-file-name
  9142. (buffer-base-buffer f))))
  9143. (setq f (and f (expand-file-name f)))
  9144. (if (eq org-refile-use-outline-path 'file)
  9145. (push (list (file-name-nondirectory f) f nil nil) tgs))
  9146. (save-excursion
  9147. (save-restriction
  9148. (widen)
  9149. (goto-char (point-min))
  9150. (while (re-search-forward descre nil t)
  9151. (goto-char (setq pos0 (point-at-bol)))
  9152. (catch 'next
  9153. (when org-refile-target-verify-function
  9154. (save-match-data
  9155. (or (funcall org-refile-target-verify-function)
  9156. (throw 'next t))))
  9157. (when (looking-at org-complex-heading-regexp)
  9158. (setq level (org-reduced-level
  9159. (- (match-end 1) (match-beginning 1)))
  9160. txt (org-link-display-format (match-string 4))
  9161. txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
  9162. re (format org-complex-heading-regexp-format
  9163. (regexp-quote (match-string 4))))
  9164. (when org-refile-use-outline-path
  9165. (setq txt (mapconcat
  9166. 'org-protect-slash
  9167. (append
  9168. (if (eq org-refile-use-outline-path
  9169. 'file)
  9170. (list (file-name-nondirectory
  9171. (buffer-file-name
  9172. (buffer-base-buffer))))
  9173. (if (eq org-refile-use-outline-path
  9174. 'full-file-path)
  9175. (list (buffer-file-name
  9176. (buffer-base-buffer)))))
  9177. (org-get-outline-path fast-path-p
  9178. level txt)
  9179. (list txt))
  9180. "/")))
  9181. (push (list txt f re (org-refile-marker (point)))
  9182. tgs)))
  9183. (when (= (point) pos0)
  9184. ;; verification function has not moved point
  9185. (goto-char (point-at-eol))))))))
  9186. (when org-refile-use-cache
  9187. (org-refile-cache-put tgs (buffer-file-name) descre))
  9188. (setq targets (append tgs targets))
  9189. ))))
  9190. (message "Getting targets...done")
  9191. (nreverse targets)))
  9192. (defun org-protect-slash (s)
  9193. (while (string-match "/" s)
  9194. (setq s (replace-match "\\" t t s)))
  9195. s)
  9196. (defvar org-olpa (make-vector 20 nil))
  9197. (defun org-get-outline-path (&optional fastp level heading)
  9198. "Return the outline path to the current entry, as a list.
  9199. The parameters FASTP, LEVEL, and HEADING are for use by a scanner
  9200. routine which makes outline path derivations for an entire file,
  9201. avoiding backtracing. Refile target collection makes use of that."
  9202. (if fastp
  9203. (progn
  9204. (if (> level 19)
  9205. (error "Outline path failure, more than 19 levels"))
  9206. (loop for i from level upto 19 do
  9207. (aset org-olpa i nil))
  9208. (prog1
  9209. (delq nil (append org-olpa nil))
  9210. (aset org-olpa level heading)))
  9211. (let (rtn case-fold-search)
  9212. (save-excursion
  9213. (save-restriction
  9214. (widen)
  9215. (while (org-up-heading-safe)
  9216. (when (looking-at org-complex-heading-regexp)
  9217. (push (org-match-string-no-properties 4) rtn)))
  9218. rtn)))))
  9219. (defun org-format-outline-path (path &optional width prefix)
  9220. "Format the outline path PATH for display.
  9221. Width is the maximum number of characters that is available.
  9222. Prefix is a prefix to be included in the returned string,
  9223. such as the file name."
  9224. (setq width (or width 79))
  9225. (if prefix (setq width (- width (length prefix))))
  9226. (if (not path)
  9227. (or prefix "")
  9228. (let* ((nsteps (length path))
  9229. (total-width (+ nsteps (apply '+ (mapcar 'length path))))
  9230. (maxwidth (if (<= total-width width)
  9231. 10000 ;; everything fits
  9232. ;; we need to shorten the level headings
  9233. (/ (- width nsteps) nsteps)))
  9234. (org-odd-levels-only nil)
  9235. (n 0)
  9236. (total (1+ (length prefix))))
  9237. (setq maxwidth (max maxwidth 10))
  9238. (concat prefix
  9239. (mapconcat
  9240. (lambda (h)
  9241. (setq n (1+ n))
  9242. (if (and (= n nsteps) (< maxwidth 10000))
  9243. (setq maxwidth (- total-width total)))
  9244. (if (< (length h) maxwidth)
  9245. (progn (setq total (+ total (length h) 1)) h)
  9246. (setq h (substring h 0 (- maxwidth 2))
  9247. total (+ total maxwidth 1))
  9248. (if (string-match "[ \t]+\\'" h)
  9249. (setq h (substring h 0 (match-beginning 0))))
  9250. (setq h (concat h "..")))
  9251. (org-add-props h nil 'face
  9252. (nth (% (1- n) org-n-level-faces)
  9253. org-level-faces))
  9254. h)
  9255. path "/")))))
  9256. (defun org-display-outline-path (&optional file current)
  9257. "Display the current outline path in the echo area."
  9258. (interactive "P")
  9259. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  9260. (case-fold-search nil)
  9261. (path (and (org-mode-p) (org-get-outline-path))))
  9262. (if current (setq path (append path
  9263. (save-excursion
  9264. (org-back-to-heading t)
  9265. (if (looking-at org-complex-heading-regexp)
  9266. (list (match-string 4)))))))
  9267. (message "%s"
  9268. (org-format-outline-path
  9269. path
  9270. (1- (frame-width))
  9271. (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
  9272. (defvar org-refile-history nil
  9273. "History for refiling operations.")
  9274. (defvar org-after-refile-insert-hook nil
  9275. "Hook run after `org-refile' has inserted its stuff at the new location.
  9276. Note that this is still *before* the stuff will be removed from
  9277. the *old* location.")
  9278. (defvar org-capture-last-stored-marker)
  9279. (defun org-refile (&optional goto default-buffer rfloc)
  9280. "Move the entry at point to another heading.
  9281. The list of target headings is compiled using the information in
  9282. `org-refile-targets', which see. This list is created before each use
  9283. and will therefore always be up-to-date.
  9284. At the target location, the entry is filed as a subitem of the target heading.
  9285. Depending on `org-reverse-note-order', the new subitem will either be the
  9286. first or the last subitem.
  9287. If there is an active region, all entries in that region will be moved.
  9288. However, the region must fulfill the requirement that the first heading
  9289. is the first one sets the top-level of the moved text - at most siblings
  9290. below it are allowed.
  9291. With prefix arg GOTO, the command will only visit the target location,
  9292. not actually move anything.
  9293. With a double prefix arg \\[universal-argument] \\[universal-argument], \
  9294. go to the location where the last refiling
  9295. operation has put the subtree.
  9296. With a prefix argument of `2', refile to the running clock.
  9297. RFLOC can be a refile location obtained in a different way.
  9298. See also `org-refile-use-outline-path' and `org-completion-use-ido'.
  9299. If you are using target caching (see `org-refile-use-cache'),
  9300. You have to clear the target cache in order to find new targets.
  9301. This can be done with a 0 prefix: `C-0 C-c C-w'"
  9302. (interactive "P")
  9303. (if (member goto '(0 (64)))
  9304. (org-refile-cache-clear)
  9305. (let* ((cbuf (current-buffer))
  9306. (regionp (org-region-active-p))
  9307. (region-start (and regionp (region-beginning)))
  9308. (region-end (and regionp (region-end)))
  9309. (region-length (and regionp (- region-end region-start)))
  9310. (filename (buffer-file-name (buffer-base-buffer cbuf)))
  9311. pos it nbuf file re level reversed)
  9312. (setq last-command nil)
  9313. (when regionp
  9314. (goto-char region-start)
  9315. (or (bolp) (goto-char (point-at-bol)))
  9316. (setq region-start (point))
  9317. (unless (org-kill-is-subtree-p
  9318. (buffer-substring region-start region-end))
  9319. (error "The region is not a (sequence of) subtree(s)")))
  9320. (if (equal goto '(16))
  9321. (org-refile-goto-last-stored)
  9322. (when (or
  9323. (and (equal goto 2)
  9324. org-clock-hd-marker (marker-buffer org-clock-hd-marker)
  9325. (prog1
  9326. (setq it (list (or org-clock-heading "running clock")
  9327. (buffer-file-name
  9328. (marker-buffer org-clock-hd-marker))
  9329. ""
  9330. (marker-position org-clock-hd-marker)))
  9331. (setq goto nil)))
  9332. (setq it (or rfloc
  9333. (save-excursion
  9334. (org-refile-get-location
  9335. (if goto "Goto" "Refile to") default-buffer
  9336. org-refile-allow-creating-parent-nodes)))))
  9337. (setq file (nth 1 it)
  9338. re (nth 2 it)
  9339. pos (nth 3 it))
  9340. (if (and (not goto)
  9341. pos
  9342. (equal (buffer-file-name) file)
  9343. (if regionp
  9344. (and (>= pos region-start)
  9345. (<= pos region-end))
  9346. (and (>= pos (point))
  9347. (< pos (save-excursion
  9348. (org-end-of-subtree t t))))))
  9349. (error "Cannot refile to position inside the tree or region"))
  9350. (setq nbuf (or (find-buffer-visiting file)
  9351. (find-file-noselect file)))
  9352. (if goto
  9353. (progn
  9354. (switch-to-buffer nbuf)
  9355. (goto-char pos)
  9356. (org-show-context 'org-goto))
  9357. (if regionp
  9358. (progn
  9359. (org-kill-new (buffer-substring region-start region-end))
  9360. (org-save-markers-in-region region-start region-end))
  9361. (org-copy-subtree 1 nil t))
  9362. (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
  9363. (find-file-noselect file)))
  9364. (setq reversed (org-notes-order-reversed-p))
  9365. (save-excursion
  9366. (save-restriction
  9367. (widen)
  9368. (if pos
  9369. (progn
  9370. (goto-char pos)
  9371. (looking-at outline-regexp)
  9372. (setq level (org-get-valid-level (funcall outline-level) 1))
  9373. (goto-char
  9374. (if reversed
  9375. (or (outline-next-heading) (point-max))
  9376. (or (save-excursion (org-get-next-sibling))
  9377. (org-end-of-subtree t t)
  9378. (point-max)))))
  9379. (setq level 1)
  9380. (if (not reversed)
  9381. (goto-char (point-max))
  9382. (goto-char (point-min))
  9383. (or (outline-next-heading) (goto-char (point-max)))))
  9384. (if (not (bolp)) (newline))
  9385. (org-paste-subtree level)
  9386. (when org-log-refile
  9387. (org-add-log-setup 'refile nil nil 'findpos
  9388. org-log-refile)
  9389. (unless (eq org-log-refile 'note)
  9390. (save-excursion (org-add-log-note))))
  9391. (and org-auto-align-tags (org-set-tags nil t))
  9392. (bookmark-set "org-refile-last-stored")
  9393. ;; If we are refiling for capture, make sure that the
  9394. ;; last-capture pointers point here
  9395. (when (org-bound-and-true-p org-refile-for-capture)
  9396. (bookmark-set "org-capture-last-stored-marker")
  9397. (move-marker org-capture-last-stored-marker (point)))
  9398. (if (fboundp 'deactivate-mark) (deactivate-mark))
  9399. (run-hooks 'org-after-refile-insert-hook))))
  9400. (if regionp
  9401. (delete-region (point) (+ (point) region-length))
  9402. (org-cut-subtree))
  9403. (when (featurep 'org-inlinetask)
  9404. (org-inlinetask-remove-END-maybe))
  9405. (setq org-markers-to-move nil)
  9406. (message "Refiled to \"%s\" in file %s" (car it) file)))))))
  9407. (defun org-refile-goto-last-stored ()
  9408. "Go to the location where the last refile was stored."
  9409. (interactive)
  9410. (bookmark-jump "org-refile-last-stored")
  9411. (message "This is the location of the last refile"))
  9412. (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
  9413. "Prompt the user for a refile location, using PROMPT.
  9414. PROMPT should not be suffixed with a colon and a space, because
  9415. this function appends the default value from
  9416. `org-refile-history' automatically, if that is not empty."
  9417. (let ((org-refile-targets org-refile-targets)
  9418. (org-refile-use-outline-path org-refile-use-outline-path))
  9419. (setq org-refile-target-table (org-refile-get-targets default-buffer)))
  9420. (unless org-refile-target-table
  9421. (error "No refile targets"))
  9422. (let* ((prompt (concat prompt
  9423. (and (car org-refile-history)
  9424. (concat " (default " (car org-refile-history) ")"))
  9425. ": "))
  9426. (cbuf (current-buffer))
  9427. (partial-completion-mode nil)
  9428. (cfn (buffer-file-name (buffer-base-buffer cbuf)))
  9429. (cfunc (if (and org-refile-use-outline-path
  9430. org-outline-path-complete-in-steps)
  9431. 'org-olpath-completing-read
  9432. 'org-icompleting-read))
  9433. (extra (if org-refile-use-outline-path "/" ""))
  9434. (filename (and cfn (expand-file-name cfn)))
  9435. (tbl (mapcar
  9436. (lambda (x)
  9437. (if (and (not (member org-refile-use-outline-path
  9438. '(file full-file-path)))
  9439. (not (equal filename (nth 1 x))))
  9440. (cons (concat (car x) extra " ("
  9441. (file-name-nondirectory (nth 1 x)) ")")
  9442. (cdr x))
  9443. (cons (concat (car x) extra) (cdr x))))
  9444. org-refile-target-table))
  9445. (completion-ignore-case t)
  9446. pa answ parent-target child parent old-hist)
  9447. (setq old-hist org-refile-history)
  9448. (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
  9449. nil 'org-refile-history (car org-refile-history)))
  9450. (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
  9451. (org-refile-check-position pa)
  9452. (if pa
  9453. (progn
  9454. (when (or (not org-refile-history)
  9455. (not (eq old-hist org-refile-history))
  9456. (not (equal (car pa) (car org-refile-history))))
  9457. (setq org-refile-history
  9458. (cons (car pa) (if (assoc (car org-refile-history) tbl)
  9459. org-refile-history
  9460. (cdr org-refile-history))))
  9461. (if (equal (car org-refile-history) (nth 1 org-refile-history))
  9462. (pop org-refile-history)))
  9463. pa)
  9464. (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
  9465. (progn
  9466. (setq parent (match-string 1 answ)
  9467. child (match-string 2 answ))
  9468. (setq parent-target (or (assoc parent tbl)
  9469. (assoc (concat parent "/") tbl)))
  9470. (when (and parent-target
  9471. (or (eq new-nodes t)
  9472. (and (eq new-nodes 'confirm)
  9473. (y-or-n-p (format "Create new node \"%s\"? "
  9474. child)))))
  9475. (org-refile-new-child parent-target child)))
  9476. (error "Invalid target location")))))
  9477. (defun org-refile-check-position (refile-pointer)
  9478. "Check if the refile pointer matches the readline to which it points."
  9479. (let* ((file (nth 1 refile-pointer))
  9480. (re (nth 2 refile-pointer))
  9481. (pos (nth 3 refile-pointer))
  9482. buffer)
  9483. (when (org-string-nw-p re)
  9484. (setq buffer (if (markerp pos)
  9485. (marker-buffer pos)
  9486. (or (find-buffer-visiting file)
  9487. (find-file-noselect file))))
  9488. (with-current-buffer buffer
  9489. (save-excursion
  9490. (save-restriction
  9491. (widen)
  9492. (goto-char pos)
  9493. (beginning-of-line 1)
  9494. (unless (org-looking-at-p re)
  9495. (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
  9496. (defun org-refile-new-child (parent-target child)
  9497. "Use refile target PARENT-TARGET to add new CHILD below it."
  9498. (unless parent-target
  9499. (error "Cannot find parent for new node"))
  9500. (let ((file (nth 1 parent-target))
  9501. (pos (nth 3 parent-target))
  9502. level)
  9503. (with-current-buffer (or (find-buffer-visiting file)
  9504. (find-file-noselect file))
  9505. (save-excursion
  9506. (save-restriction
  9507. (widen)
  9508. (if pos
  9509. (goto-char pos)
  9510. (goto-char (point-max))
  9511. (if (not (bolp)) (newline)))
  9512. (when (looking-at outline-regexp)
  9513. (setq level (funcall outline-level))
  9514. (org-end-of-subtree t t))
  9515. (org-back-over-empty-lines)
  9516. (insert "\n" (make-string
  9517. (if pos (org-get-valid-level level 1) 1) ?*)
  9518. " " child "\n")
  9519. (beginning-of-line 0)
  9520. (list (concat (car parent-target) "/" child) file "" (point)))))))
  9521. (defun org-olpath-completing-read (prompt collection &rest args)
  9522. "Read an outline path like a file name."
  9523. (let ((thetable collection)
  9524. (org-completion-use-ido nil) ; does not work with ido.
  9525. (org-completion-use-iswitchb nil)) ; or iswitchb
  9526. (apply
  9527. 'org-icompleting-read prompt
  9528. (lambda (string predicate &optional flag)
  9529. (let (rtn r f (l (length string)))
  9530. (cond
  9531. ((eq flag nil)
  9532. ;; try completion
  9533. (try-completion string thetable))
  9534. ((eq flag t)
  9535. ;; all-completions
  9536. (setq rtn (all-completions string thetable predicate))
  9537. (mapcar
  9538. (lambda (x)
  9539. (setq r (substring x l))
  9540. (if (string-match " ([^)]*)$" x)
  9541. (setq f (match-string 0 x))
  9542. (setq f ""))
  9543. (if (string-match "/" r)
  9544. (concat string (substring r 0 (match-end 0)) f)
  9545. x))
  9546. rtn))
  9547. ((eq flag 'lambda)
  9548. ;; exact match?
  9549. (assoc string thetable)))
  9550. ))
  9551. args)))
  9552. ;;;; Dynamic blocks
  9553. (defun org-find-dblock (name)
  9554. "Find the first dynamic block with name NAME in the buffer.
  9555. If not found, stay at current position and return nil."
  9556. (let (pos)
  9557. (save-excursion
  9558. (goto-char (point-min))
  9559. (setq pos (and (re-search-forward (concat "^#\\+BEGIN:[ \t]+" name "\\>")
  9560. nil t)
  9561. (match-beginning 0))))
  9562. (if pos (goto-char pos))
  9563. pos))
  9564. (defconst org-dblock-start-re
  9565. "^[ \t]*#\\+BEGIN:[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  9566. "Matches the start line of a dynamic block, with parameters.")
  9567. (defconst org-dblock-end-re "^[ \t]*#\\+END\\([: \t\r\n]\\|$\\)"
  9568. "Matches the end of a dynamic block.")
  9569. (defun org-create-dblock (plist)
  9570. "Create a dynamic block section, with parameters taken from PLIST.
  9571. PLIST must contain a :name entry which is used as name of the block."
  9572. (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
  9573. (end-of-line 1)
  9574. (newline))
  9575. (let ((col (current-column))
  9576. (name (plist-get plist :name)))
  9577. (insert "#+BEGIN: " name)
  9578. (while plist
  9579. (if (eq (car plist) :name)
  9580. (setq plist (cddr plist))
  9581. (insert " " (prin1-to-string (pop plist)))))
  9582. (insert "\n\n" (make-string col ?\ ) "#+END:\n")
  9583. (beginning-of-line -2)))
  9584. (defun org-prepare-dblock ()
  9585. "Prepare dynamic block for refresh.
  9586. This empties the block, puts the cursor at the insert position and returns
  9587. the property list including an extra property :name with the block name."
  9588. (unless (looking-at org-dblock-start-re)
  9589. (error "Not at a dynamic block"))
  9590. (let* ((begdel (1+ (match-end 0)))
  9591. (name (org-no-properties (match-string 1)))
  9592. (params (append (list :name name)
  9593. (read (concat "(" (match-string 3) ")")))))
  9594. (save-excursion
  9595. (beginning-of-line 1)
  9596. (skip-chars-forward " \t")
  9597. (setq params (plist-put params :indentation-column (current-column))))
  9598. (unless (re-search-forward org-dblock-end-re nil t)
  9599. (error "Dynamic block not terminated"))
  9600. (setq params
  9601. (append params
  9602. (list :content (buffer-substring
  9603. begdel (match-beginning 0)))))
  9604. (delete-region begdel (match-beginning 0))
  9605. (goto-char begdel)
  9606. (open-line 1)
  9607. params))
  9608. (defun org-map-dblocks (&optional command)
  9609. "Apply COMMAND to all dynamic blocks in the current buffer.
  9610. If COMMAND is not given, use `org-update-dblock'."
  9611. (let ((cmd (or command 'org-update-dblock)))
  9612. (save-excursion
  9613. (goto-char (point-min))
  9614. (while (re-search-forward org-dblock-start-re nil t)
  9615. (goto-char (match-beginning 0))
  9616. (save-excursion
  9617. (condition-case nil
  9618. (funcall cmd)
  9619. (error (message "Error during update of dynamic block"))))
  9620. (unless (re-search-forward org-dblock-end-re nil t)
  9621. (error "Dynamic block not terminated"))))))
  9622. (defun org-dblock-update (&optional arg)
  9623. "User command for updating dynamic blocks.
  9624. Update the dynamic block at point. With prefix ARG, update all dynamic
  9625. blocks in the buffer."
  9626. (interactive "P")
  9627. (if arg
  9628. (org-update-all-dblocks)
  9629. (or (looking-at org-dblock-start-re)
  9630. (org-beginning-of-dblock))
  9631. (org-update-dblock)))
  9632. (defun org-update-dblock ()
  9633. "Update the dynamic block at point.
  9634. This means to empty the block, parse for parameters and then call
  9635. the correct writing function."
  9636. (interactive)
  9637. (save-window-excursion
  9638. (let* ((pos (point))
  9639. (line (org-current-line))
  9640. (params (org-prepare-dblock))
  9641. (name (plist-get params :name))
  9642. (indent (plist-get params :indentation-column))
  9643. (cmd (intern (concat "org-dblock-write:" name))))
  9644. (message "Updating dynamic block `%s' at line %d..." name line)
  9645. (funcall cmd params)
  9646. (message "Updating dynamic block `%s' at line %d...done" name line)
  9647. (goto-char pos)
  9648. (when (and indent (> indent 0))
  9649. (setq indent (make-string indent ?\ ))
  9650. (save-excursion
  9651. (org-beginning-of-dblock)
  9652. (forward-line 1)
  9653. (while (not (looking-at org-dblock-end-re))
  9654. (insert indent)
  9655. (beginning-of-line 2))
  9656. (when (looking-at org-dblock-end-re)
  9657. (and (looking-at "[ \t]+")
  9658. (replace-match ""))
  9659. (insert indent)))))))
  9660. (defun org-beginning-of-dblock ()
  9661. "Find the beginning of the dynamic block at point.
  9662. Error if there is no such block at point."
  9663. (let ((pos (point))
  9664. beg)
  9665. (end-of-line 1)
  9666. (if (and (re-search-backward org-dblock-start-re nil t)
  9667. (setq beg (match-beginning 0))
  9668. (re-search-forward org-dblock-end-re nil t)
  9669. (> (match-end 0) pos))
  9670. (goto-char beg)
  9671. (goto-char pos)
  9672. (error "Not in a dynamic block"))))
  9673. (defun org-update-all-dblocks ()
  9674. "Update all dynamic blocks in the buffer.
  9675. This function can be used in a hook."
  9676. (interactive)
  9677. (when (org-mode-p)
  9678. (org-map-dblocks 'org-update-dblock)))
  9679. ;;;; Completion
  9680. (defconst org-additional-option-like-keywords
  9681. '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
  9682. "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
  9683. "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
  9684. "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
  9685. "BEGIN:" "END:"
  9686. "ORGTBL" "TBLFM:" "TBLNAME:"
  9687. "BEGIN_EXAMPLE" "END_EXAMPLE"
  9688. "BEGIN_QUOTE" "END_QUOTE"
  9689. "BEGIN_VERSE" "END_VERSE"
  9690. "BEGIN_CENTER" "END_CENTER"
  9691. "BEGIN_SRC" "END_SRC"
  9692. "BEGIN_RESULT" "END_RESULT"
  9693. "SOURCE:" "SRCNAME:" "FUNCTION:"
  9694. "RESULTS:"
  9695. "HEADER:" "HEADERS:"
  9696. "BABEL:"
  9697. "CATEGORY:" "COLUMNS:" "PROPERTY:"
  9698. "CAPTION:" "LABEL:"
  9699. "SETUPFILE:"
  9700. "INCLUDE:"
  9701. "BIND:"
  9702. "MACRO:"))
  9703. (defcustom org-structure-template-alist
  9704. '(
  9705. ("s" "#+begin_src ?\n\n#+end_src"
  9706. "<src lang=\"?\">\n\n</src>")
  9707. ("e" "#+begin_example\n?\n#+end_example"
  9708. "<example>\n?\n</example>")
  9709. ("q" "#+begin_quote\n?\n#+end_quote"
  9710. "<quote>\n?\n</quote>")
  9711. ("v" "#+begin_verse\n?\n#+end_verse"
  9712. "<verse>\n?\n/verse>")
  9713. ("c" "#+begin_center\n?\n#+end_center"
  9714. "<center>\n?\n/center>")
  9715. ("l" "#+begin_latex\n?\n#+end_latex"
  9716. "<literal style=\"latex\">\n?\n</literal>")
  9717. ("L" "#+latex: "
  9718. "<literal style=\"latex\">?</literal>")
  9719. ("h" "#+begin_html\n?\n#+end_html"
  9720. "<literal style=\"html\">\n?\n</literal>")
  9721. ("H" "#+html: "
  9722. "<literal style=\"html\">?</literal>")
  9723. ("a" "#+begin_ascii\n?\n#+end_ascii")
  9724. ("A" "#+ascii: ")
  9725. ("i" "#+index: ?"
  9726. "#+index: ?")
  9727. ("I" "#+include %file ?"
  9728. "<include file=%file markup=\"?\">")
  9729. )
  9730. "Structure completion elements.
  9731. This is a list of abbreviation keys and values. The value gets inserted
  9732. if you type `<' followed by the key and then press the completion key,
  9733. usually `M-TAB'. %file will be replaced by a file name after prompting
  9734. for the file using completion. The cursor will be placed at the position
  9735. of the `?` in the template.
  9736. There are two templates for each key, the first uses the original Org syntax,
  9737. the second uses Emacs Muse-like syntax tags. These Muse-like tags become
  9738. the default when the /org-mtags.el/ module has been loaded. See also the
  9739. variable `org-mtags-prefer-muse-templates'.
  9740. This is an experimental feature, it is undecided if it is going to stay in."
  9741. :group 'org-completion
  9742. :type '(repeat
  9743. (string :tag "Key")
  9744. (string :tag "Template")
  9745. (string :tag "Muse Template")))
  9746. (defun org-try-structure-completion ()
  9747. "Try to complete a structure template before point.
  9748. This looks for strings like \"<e\" on an otherwise empty line and
  9749. expands them."
  9750. (let ((l (buffer-substring (point-at-bol) (point)))
  9751. a)
  9752. (when (and (looking-at "[ \t]*$")
  9753. (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
  9754. (setq a (assoc (match-string 1 l) org-structure-template-alist)))
  9755. (org-complete-expand-structure-template (+ -1 (point-at-bol)
  9756. (match-beginning 1)) a)
  9757. t)))
  9758. (defun org-complete-expand-structure-template (start cell)
  9759. "Expand a structure template."
  9760. (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
  9761. (rpl (nth (if musep 2 1) cell))
  9762. (ind ""))
  9763. (delete-region start (point))
  9764. (when (string-match "\\`#\\+" rpl)
  9765. (cond
  9766. ((bolp))
  9767. ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
  9768. (setq ind (buffer-substring (point-at-bol) (point))))
  9769. (t (newline))))
  9770. (setq start (point))
  9771. (if (string-match "%file" rpl)
  9772. (setq rpl (replace-match
  9773. (concat
  9774. "\""
  9775. (save-match-data
  9776. (abbreviate-file-name (read-file-name "Include file: ")))
  9777. "\"")
  9778. t t rpl)))
  9779. (setq rpl (mapconcat 'identity (split-string rpl "\n")
  9780. (concat "\n" ind)))
  9781. (insert rpl)
  9782. (if (re-search-backward "\\?" start t) (delete-char 1))))
  9783. ;;;; TODO, DEADLINE, Comments
  9784. (defun org-toggle-comment ()
  9785. "Change the COMMENT state of an entry."
  9786. (interactive)
  9787. (save-excursion
  9788. (org-back-to-heading)
  9789. (let (case-fold-search)
  9790. (if (looking-at (concat outline-regexp
  9791. "\\( *\\<" org-comment-string "\\>[ \t]*\\)"))
  9792. (replace-match "" t t nil 1)
  9793. (if (looking-at outline-regexp)
  9794. (progn
  9795. (goto-char (match-end 0))
  9796. (insert org-comment-string " ")))))))
  9797. (defvar org-last-todo-state-is-todo nil
  9798. "This is non-nil when the last TODO state change led to a TODO state.
  9799. If the last change removed the TODO tag or switched to DONE, then
  9800. this is nil.")
  9801. (defvar org-setting-tags nil) ; dynamically skipped
  9802. (defvar org-todo-setup-filter-hook nil
  9803. "Hook for functions that pre-filter todo specs.
  9804. Each function takes a todo spec and returns either nil or the spec
  9805. transformed into canonical form." )
  9806. (defvar org-todo-get-default-hook nil
  9807. "Hook for functions that get a default item for todo.
  9808. Each function takes arguments (NEW-MARK OLD-MARK) and returns either
  9809. nil or a string to be used for the todo mark." )
  9810. (defvar org-agenda-headline-snapshot-before-repeat)
  9811. (defun org-todo (&optional arg)
  9812. "Change the TODO state of an item.
  9813. The state of an item is given by a keyword at the start of the heading,
  9814. like
  9815. *** TODO Write paper
  9816. *** DONE Call mom
  9817. The different keywords are specified in the variable `org-todo-keywords'.
  9818. By default the available states are \"TODO\" and \"DONE\".
  9819. So for this example: when the item starts with TODO, it is changed to DONE.
  9820. When it starts with DONE, the DONE is removed. And when neither TODO nor
  9821. DONE are present, add TODO at the beginning of the heading.
  9822. With \\[universal-argument] prefix arg, use completion to determine the new \
  9823. state.
  9824. With numeric prefix arg, switch to that state.
  9825. With a double \\[universal-argument] prefix, switch to the next set of TODO \
  9826. keywords (nextset).
  9827. With a triple \\[universal-argument] prefix, circumvent any state blocking.
  9828. For calling through lisp, arg is also interpreted in the following way:
  9829. 'none -> empty state
  9830. \"\"(empty string) -> switch to empty state
  9831. 'done -> switch to DONE
  9832. 'nextset -> switch to the next set of keywords
  9833. 'previousset -> switch to the previous set of keywords
  9834. \"WAITING\" -> switch to the specified keyword, but only if it
  9835. really is a member of `org-todo-keywords'."
  9836. (interactive "P")
  9837. (if (equal arg '(16)) (setq arg 'nextset))
  9838. (let ((org-blocker-hook org-blocker-hook)
  9839. (case-fold-search nil))
  9840. (when (equal arg '(64))
  9841. (setq arg nil org-blocker-hook nil))
  9842. (when (and org-blocker-hook
  9843. (or org-inhibit-blocking
  9844. (org-entry-get nil "NOBLOCKING")))
  9845. (setq org-blocker-hook nil))
  9846. (save-excursion
  9847. (catch 'exit
  9848. (org-back-to-heading t)
  9849. (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
  9850. (or (looking-at (concat " +" org-todo-regexp "\\( +\\|$\\)"))
  9851. (looking-at " *"))
  9852. (let* ((match-data (match-data))
  9853. (startpos (point-at-bol))
  9854. (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
  9855. (org-log-done org-log-done)
  9856. (org-log-repeat org-log-repeat)
  9857. (org-todo-log-states org-todo-log-states)
  9858. (this (match-string 1))
  9859. (hl-pos (match-beginning 0))
  9860. (head (org-get-todo-sequence-head this))
  9861. (ass (assoc head org-todo-kwd-alist))
  9862. (interpret (nth 1 ass))
  9863. (done-word (nth 3 ass))
  9864. (final-done-word (nth 4 ass))
  9865. (last-state (or this ""))
  9866. (completion-ignore-case t)
  9867. (member (member this org-todo-keywords-1))
  9868. (tail (cdr member))
  9869. (state (cond
  9870. ((and org-todo-key-trigger
  9871. (or (and (equal arg '(4))
  9872. (eq org-use-fast-todo-selection 'prefix))
  9873. (and (not arg) org-use-fast-todo-selection
  9874. (not (eq org-use-fast-todo-selection
  9875. 'prefix)))))
  9876. ;; Use fast selection
  9877. (org-fast-todo-selection))
  9878. ((and (equal arg '(4))
  9879. (or (not org-use-fast-todo-selection)
  9880. (not org-todo-key-trigger)))
  9881. ;; Read a state with completion
  9882. (org-icompleting-read
  9883. "State: " (mapcar (lambda(x) (list x))
  9884. org-todo-keywords-1)
  9885. nil t))
  9886. ((eq arg 'right)
  9887. (if this
  9888. (if tail (car tail) nil)
  9889. (car org-todo-keywords-1)))
  9890. ((eq arg 'left)
  9891. (if (equal member org-todo-keywords-1)
  9892. nil
  9893. (if this
  9894. (nth (- (length org-todo-keywords-1)
  9895. (length tail) 2)
  9896. org-todo-keywords-1)
  9897. (org-last org-todo-keywords-1))))
  9898. ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
  9899. (setq arg nil))) ; hack to fall back to cycling
  9900. (arg
  9901. ;; user or caller requests a specific state
  9902. (cond
  9903. ((equal arg "") nil)
  9904. ((eq arg 'none) nil)
  9905. ((eq arg 'done) (or done-word (car org-done-keywords)))
  9906. ((eq arg 'nextset)
  9907. (or (car (cdr (member head org-todo-heads)))
  9908. (car org-todo-heads)))
  9909. ((eq arg 'previousset)
  9910. (let ((org-todo-heads (reverse org-todo-heads)))
  9911. (or (car (cdr (member head org-todo-heads)))
  9912. (car org-todo-heads))))
  9913. ((car (member arg org-todo-keywords-1)))
  9914. ((stringp arg)
  9915. (error "State `%s' not valid in this file" arg))
  9916. ((nth (1- (prefix-numeric-value arg))
  9917. org-todo-keywords-1))))
  9918. ((null member) (or head (car org-todo-keywords-1)))
  9919. ((equal this final-done-word) nil) ;; -> make empty
  9920. ((null tail) nil) ;; -> first entry
  9921. ((memq interpret '(type priority))
  9922. (if (eq this-command last-command)
  9923. (car tail)
  9924. (if (> (length tail) 0)
  9925. (or done-word (car org-done-keywords))
  9926. nil)))
  9927. (t
  9928. (car tail))))
  9929. (state (or
  9930. (run-hook-with-args-until-success
  9931. 'org-todo-get-default-hook state last-state)
  9932. state))
  9933. (next (if state (concat " " state " ") " "))
  9934. (change-plist (list :type 'todo-state-change :from this :to state
  9935. :position startpos))
  9936. dolog now-done-p)
  9937. (when org-blocker-hook
  9938. (setq org-last-todo-state-is-todo
  9939. (not (member this org-done-keywords)))
  9940. (unless (save-excursion
  9941. (save-match-data
  9942. (org-with-wide-buffer
  9943. (run-hook-with-args-until-failure
  9944. 'org-blocker-hook change-plist))))
  9945. (if (interactive-p)
  9946. (error "TODO state change from %s to %s blocked" this state)
  9947. ;; fail silently
  9948. (message "TODO state change from %s to %s blocked" this state)
  9949. (throw 'exit nil))))
  9950. (store-match-data match-data)
  9951. (replace-match next t t)
  9952. (unless (pos-visible-in-window-p hl-pos)
  9953. (message "TODO state changed to %s" (org-trim next)))
  9954. (unless head
  9955. (setq head (org-get-todo-sequence-head state)
  9956. ass (assoc head org-todo-kwd-alist)
  9957. interpret (nth 1 ass)
  9958. done-word (nth 3 ass)
  9959. final-done-word (nth 4 ass)))
  9960. (when (memq arg '(nextset previousset))
  9961. (message "Keyword-Set %d/%d: %s"
  9962. (- (length org-todo-sets) -1
  9963. (length (memq (assoc state org-todo-sets) org-todo-sets)))
  9964. (length org-todo-sets)
  9965. (mapconcat 'identity (assoc state org-todo-sets) " ")))
  9966. (setq org-last-todo-state-is-todo
  9967. (not (member state org-done-keywords)))
  9968. (setq now-done-p (and (member state org-done-keywords)
  9969. (not (member this org-done-keywords))))
  9970. (and logging (org-local-logging logging))
  9971. (when (and (or org-todo-log-states org-log-done)
  9972. (not (eq org-inhibit-logging t))
  9973. (not (memq arg '(nextset previousset))))
  9974. ;; we need to look at recording a time and note
  9975. (setq dolog (or (nth 1 (assoc state org-todo-log-states))
  9976. (nth 2 (assoc this org-todo-log-states))))
  9977. (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
  9978. (setq dolog 'time))
  9979. (when (and state
  9980. (member state org-not-done-keywords)
  9981. (not (member this org-not-done-keywords)))
  9982. ;; This is now a todo state and was not one before
  9983. ;; If there was a CLOSED time stamp, get rid of it.
  9984. (org-add-planning-info nil nil 'closed))
  9985. (when (and now-done-p org-log-done)
  9986. ;; It is now done, and it was not done before
  9987. (org-add-planning-info 'closed (org-current-time))
  9988. (if (and (not dolog) (eq 'note org-log-done))
  9989. (org-add-log-setup 'done state this 'findpos 'note)))
  9990. (when (and state dolog)
  9991. ;; This is a non-nil state, and we need to log it
  9992. (org-add-log-setup 'state state this 'findpos dolog)))
  9993. ;; Fixup tag positioning
  9994. (org-todo-trigger-tag-changes state)
  9995. (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
  9996. (when org-provide-todo-statistics
  9997. (org-update-parent-todo-statistics))
  9998. (run-hooks 'org-after-todo-state-change-hook)
  9999. (if (and arg (not (member state org-done-keywords)))
  10000. (setq head (org-get-todo-sequence-head state)))
  10001. (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
  10002. ;; Do we need to trigger a repeat?
  10003. (when now-done-p
  10004. (when (boundp 'org-agenda-headline-snapshot-before-repeat)
  10005. ;; This is for the agenda, take a snapshot of the headline.
  10006. (save-match-data
  10007. (setq org-agenda-headline-snapshot-before-repeat
  10008. (org-get-heading))))
  10009. (org-auto-repeat-maybe state))
  10010. ;; Fixup cursor location if close to the keyword
  10011. (if (and (outline-on-heading-p)
  10012. (not (bolp))
  10013. (save-excursion (beginning-of-line 1)
  10014. (looking-at org-todo-line-regexp))
  10015. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  10016. (progn
  10017. (goto-char (or (match-end 2) (match-end 1)))
  10018. (and (looking-at " ") (just-one-space))))
  10019. (when org-trigger-hook
  10020. (save-excursion
  10021. (run-hook-with-args 'org-trigger-hook change-plist))))))))
  10022. (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
  10023. "Block turning an entry into a TODO, using the hierarchy.
  10024. This checks whether the current task should be blocked from state
  10025. changes. Such blocking occurs when:
  10026. 1. The task has children which are not all in a completed state.
  10027. 2. A task has a parent with the property :ORDERED:, and there
  10028. are siblings prior to the current task with incomplete
  10029. status.
  10030. 3. The parent of the task is blocked because it has siblings that should
  10031. be done first, or is child of a block grandparent TODO entry."
  10032. (if (not org-enforce-todo-dependencies)
  10033. t ; if locally turned off don't block
  10034. (catch 'dont-block
  10035. ;; If this is not a todo state change, or if this entry is already DONE,
  10036. ;; do not block
  10037. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  10038. (member (plist-get change-plist :from)
  10039. (cons 'done org-done-keywords))
  10040. (member (plist-get change-plist :to)
  10041. (cons 'todo org-not-done-keywords))
  10042. (not (plist-get change-plist :to)))
  10043. (throw 'dont-block t))
  10044. ;; If this task has children, and any are undone, it's blocked
  10045. (save-excursion
  10046. (org-back-to-heading t)
  10047. (let ((this-level (funcall outline-level)))
  10048. (outline-next-heading)
  10049. (let ((child-level (funcall outline-level)))
  10050. (while (and (not (eobp))
  10051. (> child-level this-level))
  10052. ;; this todo has children, check whether they are all
  10053. ;; completed
  10054. (if (and (not (org-entry-is-done-p))
  10055. (org-entry-is-todo-p))
  10056. (throw 'dont-block nil))
  10057. (outline-next-heading)
  10058. (setq child-level (funcall outline-level))))))
  10059. ;; Otherwise, if the task's parent has the :ORDERED: property, and
  10060. ;; any previous siblings are undone, it's blocked
  10061. (save-excursion
  10062. (org-back-to-heading t)
  10063. (let* ((pos (point))
  10064. (parent-pos (and (org-up-heading-safe) (point))))
  10065. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  10066. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  10067. (forward-line 1)
  10068. (re-search-forward org-not-done-heading-regexp pos t))
  10069. (throw 'dont-block nil)) ; block, there is an older sibling not done.
  10070. ;; Search further up the hierarchy, to see if an anchestor is blocked
  10071. (while t
  10072. (goto-char parent-pos)
  10073. (if (not (looking-at org-not-done-heading-regexp))
  10074. (throw 'dont-block t)) ; do not block, parent is not a TODO
  10075. (setq pos (point))
  10076. (setq parent-pos (and (org-up-heading-safe) (point)))
  10077. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  10078. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  10079. (forward-line 1)
  10080. (re-search-forward org-not-done-heading-regexp pos t))
  10081. (throw 'dont-block nil)))))))) ; block, older sibling not done.
  10082. (defcustom org-track-ordered-property-with-tag nil
  10083. "Should the ORDERED property also be shown as a tag?
  10084. The ORDERED property decides if an entry should require subtasks to be
  10085. completed in sequence. Since a property is not very visible, setting
  10086. this option means that toggling the ORDERED property with the command
  10087. `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
  10088. not relevant for the behavior, but it makes things more visible.
  10089. Note that toggling the tag with tags commands will not change the property
  10090. and therefore not influence behavior!
  10091. This can be t, meaning the tag ORDERED should be used, It can also be a
  10092. string to select a different tag for this task."
  10093. :group 'org-todo
  10094. :type '(choice
  10095. (const :tag "No tracking" nil)
  10096. (const :tag "Track with ORDERED tag" t)
  10097. (string :tag "Use other tag")))
  10098. (defun org-toggle-ordered-property ()
  10099. "Toggle the ORDERED property of the current entry.
  10100. For better visibility, you can track the value of this property with a tag.
  10101. See variable `org-track-ordered-property-with-tag'."
  10102. (interactive)
  10103. (let* ((t1 org-track-ordered-property-with-tag)
  10104. (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
  10105. (save-excursion
  10106. (org-back-to-heading)
  10107. (if (org-entry-get nil "ORDERED")
  10108. (progn
  10109. (org-delete-property "ORDERED")
  10110. (and tag (org-toggle-tag tag 'off))
  10111. (message "Subtasks can be completed in arbitrary order"))
  10112. (org-entry-put nil "ORDERED" "t")
  10113. (and tag (org-toggle-tag tag 'on))
  10114. (message "Subtasks must be completed in sequence")))))
  10115. (defvar org-blocked-by-checkboxes) ; dynamically scoped
  10116. (defun org-block-todo-from-checkboxes (change-plist)
  10117. "Block turning an entry into a TODO, using checkboxes.
  10118. This checks whether the current task should be blocked from state
  10119. changes because there are unchecked boxes in this entry."
  10120. (if (not org-enforce-todo-checkbox-dependencies)
  10121. t ; if locally turned off don't block
  10122. (catch 'dont-block
  10123. ;; If this is not a todo state change, or if this entry is already DONE,
  10124. ;; do not block
  10125. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  10126. (member (plist-get change-plist :from)
  10127. (cons 'done org-done-keywords))
  10128. (member (plist-get change-plist :to)
  10129. (cons 'todo org-not-done-keywords))
  10130. (not (plist-get change-plist :to)))
  10131. (throw 'dont-block t))
  10132. ;; If this task has checkboxes that are not checked, it's blocked
  10133. (save-excursion
  10134. (org-back-to-heading t)
  10135. (let ((beg (point)) end)
  10136. (outline-next-heading)
  10137. (setq end (point))
  10138. (goto-char beg)
  10139. (if (re-search-forward "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\)[ \t]+\\[[- ]\\]"
  10140. end t)
  10141. (progn
  10142. (if (boundp 'org-blocked-by-checkboxes)
  10143. (setq org-blocked-by-checkboxes t))
  10144. (throw 'dont-block nil)))))
  10145. t))) ; do not block
  10146. (defun org-entry-blocked-p ()
  10147. "Is the current entry blocked?"
  10148. (if (org-entry-get nil "NOBLOCKING")
  10149. nil ;; Never block this entry
  10150. (not
  10151. (run-hook-with-args-until-failure
  10152. 'org-blocker-hook
  10153. (list :type 'todo-state-change
  10154. :position (point)
  10155. :from 'todo
  10156. :to 'done)))))
  10157. (defun org-update-statistics-cookies (all)
  10158. "Update the statistics cookie, either from TODO or from checkboxes.
  10159. This should be called with the cursor in a line with a statistics cookie."
  10160. (interactive "P")
  10161. (if all
  10162. (progn
  10163. (org-update-checkbox-count 'all)
  10164. (org-map-entries 'org-update-parent-todo-statistics))
  10165. (if (not (org-on-heading-p))
  10166. (org-update-checkbox-count)
  10167. (let ((pos (move-marker (make-marker) (point)))
  10168. end l1 l2)
  10169. (ignore-errors (org-back-to-heading t))
  10170. (if (not (org-on-heading-p))
  10171. (org-update-checkbox-count)
  10172. (setq l1 (org-outline-level))
  10173. (setq end (save-excursion
  10174. (outline-next-heading)
  10175. (if (org-on-heading-p) (setq l2 (org-outline-level)))
  10176. (point)))
  10177. (if (and (save-excursion
  10178. (re-search-forward
  10179. "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
  10180. (not (save-excursion (re-search-forward
  10181. ":COOKIE_DATA:.*\\<todo\\>" end t))))
  10182. (org-update-checkbox-count)
  10183. (if (and l2 (> l2 l1))
  10184. (progn
  10185. (goto-char end)
  10186. (org-update-parent-todo-statistics))
  10187. (goto-char pos)
  10188. (beginning-of-line 1)
  10189. (while (re-search-forward
  10190. "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
  10191. (point-at-eol) t)
  10192. (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
  10193. (goto-char pos)
  10194. (move-marker pos nil)))))
  10195. (defvar org-entry-property-inherited-from) ;; defined below
  10196. (defun org-update-parent-todo-statistics ()
  10197. "Update any statistics cookie in the parent of the current headline.
  10198. When `org-hierarchical-todo-statistics' is nil, statistics will cover
  10199. the entire subtree and this will travel up the hierarchy and update
  10200. statistics everywhere."
  10201. (interactive)
  10202. (let* ((lim 0) prop
  10203. (recursive (or (not org-hierarchical-todo-statistics)
  10204. (string-match
  10205. "\\<recursive\\>"
  10206. (or (setq prop (org-entry-get
  10207. nil "COOKIE_DATA" 'inherit)) ""))))
  10208. (lim (or (and prop (marker-position
  10209. org-entry-property-inherited-from))
  10210. lim))
  10211. (first t)
  10212. (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  10213. level ltoggle l1 new ndel
  10214. (cnt-all 0) (cnt-done 0) is-percent kwd
  10215. checkbox-beg ov ovs ove cookie-present)
  10216. (catch 'exit
  10217. (save-excursion
  10218. (beginning-of-line 1)
  10219. (if (org-at-heading-p)
  10220. (setq ltoggle (funcall outline-level))
  10221. (error "This should not happen"))
  10222. (while (and (setq level (org-up-heading-safe))
  10223. (or recursive first)
  10224. (>= (point) lim))
  10225. (setq first nil cookie-present nil)
  10226. (unless (and level
  10227. (not (string-match
  10228. "\\<checkbox\\>"
  10229. (downcase
  10230. (or (org-entry-get
  10231. nil "COOKIE_DATA")
  10232. "")))))
  10233. (throw 'exit nil))
  10234. (while (re-search-forward box-re (point-at-eol) t)
  10235. (setq cnt-all 0 cnt-done 0 cookie-present t)
  10236. (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
  10237. (save-match-data
  10238. (unless (outline-next-heading) (throw 'exit nil))
  10239. (while (and (looking-at org-complex-heading-regexp)
  10240. (> (setq l1 (length (match-string 1))) level))
  10241. (setq kwd (and (or recursive (= l1 ltoggle))
  10242. (match-string 2)))
  10243. (if (or (eq org-provide-todo-statistics 'all-headlines)
  10244. (and (listp org-provide-todo-statistics)
  10245. (or (member kwd org-provide-todo-statistics)
  10246. (member kwd org-done-keywords))))
  10247. (setq cnt-all (1+ cnt-all))
  10248. (if (eq org-provide-todo-statistics t)
  10249. (and kwd (setq cnt-all (1+ cnt-all)))))
  10250. (and (member kwd org-done-keywords)
  10251. (setq cnt-done (1+ cnt-done)))
  10252. (outline-next-heading)))
  10253. (setq new
  10254. (if is-percent
  10255. (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
  10256. (format "[%d/%d]" cnt-done cnt-all))
  10257. ndel (- (match-end 0) checkbox-beg))
  10258. ;; handle overlays when updating cookie from column view
  10259. (when (setq ov (car (overlays-at checkbox-beg)))
  10260. (setq ovs (overlay-start ov) ove (overlay-end ov))
  10261. (delete-overlay ov))
  10262. (goto-char checkbox-beg)
  10263. (insert new)
  10264. (delete-region (point) (+ (point) ndel))
  10265. (when ov (move-overlay ov ovs ove)))
  10266. (when cookie-present
  10267. (run-hook-with-args 'org-after-todo-statistics-hook
  10268. cnt-done (- cnt-all cnt-done))))))
  10269. (run-hooks 'org-todo-statistics-hook)))
  10270. (defvar org-after-todo-statistics-hook nil
  10271. "Hook that is called after a TODO statistics cookie has been updated.
  10272. Each function is called with two arguments: the number of not-done entries
  10273. and the number of done entries.
  10274. For example, the following function, when added to this hook, will switch
  10275. an entry to DONE when all children are done, and back to TODO when new
  10276. entries are set to a TODO status. Note that this hook is only called
  10277. when there is a statistics cookie in the headline!
  10278. (defun org-summary-todo (n-done n-not-done)
  10279. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  10280. (let (org-log-done org-log-states) ; turn off logging
  10281. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
  10282. ")
  10283. (defvar org-todo-statistics-hook nil
  10284. "Hook that is run whenever Org thinks TODO statistics should be updated.
  10285. This hook runs even if there is no statistics cookie present, in which case
  10286. `org-after-todo-statistics-hook' would not run.")
  10287. (defun org-todo-trigger-tag-changes (state)
  10288. "Apply the changes defined in `org-todo-state-tags-triggers'."
  10289. (let ((l org-todo-state-tags-triggers)
  10290. changes)
  10291. (when (or (not state) (equal state ""))
  10292. (setq changes (append changes (cdr (assoc "" l)))))
  10293. (when (and (stringp state) (> (length state) 0))
  10294. (setq changes (append changes (cdr (assoc state l)))))
  10295. (when (member state org-not-done-keywords)
  10296. (setq changes (append changes (cdr (assoc 'todo l)))))
  10297. (when (member state org-done-keywords)
  10298. (setq changes (append changes (cdr (assoc 'done l)))))
  10299. (dolist (c changes)
  10300. (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
  10301. (defun org-local-logging (value)
  10302. "Get logging settings from a property VALUE."
  10303. (let* (words w a)
  10304. ;; directly set the variables, they are already local.
  10305. (setq org-log-done nil
  10306. org-log-repeat nil
  10307. org-todo-log-states nil)
  10308. (setq words (org-split-string value))
  10309. (while (setq w (pop words))
  10310. (cond
  10311. ((setq a (assoc w org-startup-options))
  10312. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  10313. (set (nth 1 a) (nth 2 a))))
  10314. ((setq a (org-extract-log-state-settings w))
  10315. (and (member (car a) org-todo-keywords-1)
  10316. (push a org-todo-log-states)))))))
  10317. (defun org-get-todo-sequence-head (kwd)
  10318. "Return the head of the TODO sequence to which KWD belongs.
  10319. If KWD is not set, check if there is a text property remembering the
  10320. right sequence."
  10321. (let (p)
  10322. (cond
  10323. ((not kwd)
  10324. (or (get-text-property (point-at-bol) 'org-todo-head)
  10325. (progn
  10326. (setq p (next-single-property-change (point-at-bol) 'org-todo-head
  10327. nil (point-at-eol)))
  10328. (get-text-property p 'org-todo-head))))
  10329. ((not (member kwd org-todo-keywords-1))
  10330. (car org-todo-keywords-1))
  10331. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  10332. (defun org-fast-todo-selection ()
  10333. "Fast TODO keyword selection with single keys.
  10334. Returns the new TODO keyword, or nil if no state change should occur."
  10335. (let* ((fulltable org-todo-key-alist)
  10336. (done-keywords org-done-keywords) ;; needed for the faces.
  10337. (maxlen (apply 'max (mapcar
  10338. (lambda (x)
  10339. (if (stringp (car x)) (string-width (car x)) 0))
  10340. fulltable)))
  10341. (expert nil)
  10342. (fwidth (+ maxlen 3 1 3))
  10343. (ncol (/ (- (window-width) 4) fwidth))
  10344. tg cnt e c tbl
  10345. groups ingroup)
  10346. (save-excursion
  10347. (save-window-excursion
  10348. (if expert
  10349. (set-buffer (get-buffer-create " *Org todo*"))
  10350. (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
  10351. (erase-buffer)
  10352. (org-set-local 'org-done-keywords done-keywords)
  10353. (setq tbl fulltable cnt 0)
  10354. (while (setq e (pop tbl))
  10355. (cond
  10356. ((equal e '(:startgroup))
  10357. (push '() groups) (setq ingroup t)
  10358. (when (not (= cnt 0))
  10359. (setq cnt 0)
  10360. (insert "\n"))
  10361. (insert "{ "))
  10362. ((equal e '(:endgroup))
  10363. (setq ingroup nil cnt 0)
  10364. (insert "}\n"))
  10365. ((equal e '(:newline))
  10366. (when (not (= cnt 0))
  10367. (setq cnt 0)
  10368. (insert "\n")
  10369. (setq e (car tbl))
  10370. (while (equal (car tbl) '(:newline))
  10371. (insert "\n")
  10372. (setq tbl (cdr tbl)))))
  10373. (t
  10374. (setq tg (car e) c (cdr e))
  10375. (if ingroup (push tg (car groups)))
  10376. (setq tg (org-add-props tg nil 'face
  10377. (org-get-todo-face tg)))
  10378. (if (and (= cnt 0) (not ingroup)) (insert " "))
  10379. (insert "[" c "] " tg (make-string
  10380. (- fwidth 4 (length tg)) ?\ ))
  10381. (when (= (setq cnt (1+ cnt)) ncol)
  10382. (insert "\n")
  10383. (if ingroup (insert " "))
  10384. (setq cnt 0)))))
  10385. (insert "\n")
  10386. (goto-char (point-min))
  10387. (if (not expert) (org-fit-window-to-buffer))
  10388. (message "[a-z..]:Set [SPC]:clear")
  10389. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  10390. (cond
  10391. ((or (= c ?\C-g)
  10392. (and (= c ?q) (not (rassoc c fulltable))))
  10393. (setq quit-flag t))
  10394. ((= c ?\ ) nil)
  10395. ((setq e (rassoc c fulltable) tg (car e))
  10396. tg)
  10397. (t (setq quit-flag t)))))))
  10398. (defun org-entry-is-todo-p ()
  10399. (member (org-get-todo-state) org-not-done-keywords))
  10400. (defun org-entry-is-done-p ()
  10401. (member (org-get-todo-state) org-done-keywords))
  10402. (defun org-get-todo-state ()
  10403. (save-excursion
  10404. (org-back-to-heading t)
  10405. (and (looking-at org-todo-line-regexp)
  10406. (match-end 2)
  10407. (match-string 2))))
  10408. (defun org-at-date-range-p (&optional inactive-ok)
  10409. "Is the cursor inside a date range?"
  10410. (interactive)
  10411. (save-excursion
  10412. (catch 'exit
  10413. (let ((pos (point)))
  10414. (skip-chars-backward "^[<\r\n")
  10415. (skip-chars-backward "<[")
  10416. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  10417. (>= (match-end 0) pos)
  10418. (throw 'exit t))
  10419. (skip-chars-backward "^<[\r\n")
  10420. (skip-chars-backward "<[")
  10421. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  10422. (>= (match-end 0) pos)
  10423. (throw 'exit t)))
  10424. nil)))
  10425. (defun org-get-repeat (&optional tagline)
  10426. "Check if there is a deadline/schedule with repeater in this entry."
  10427. (save-match-data
  10428. (save-excursion
  10429. (org-back-to-heading t)
  10430. (and (re-search-forward (if tagline
  10431. (concat tagline "\\s-*" org-repeat-re)
  10432. org-repeat-re)
  10433. (org-entry-end-position) t)
  10434. (match-string-no-properties 1)))))
  10435. (defvar org-last-changed-timestamp)
  10436. (defvar org-last-inserted-timestamp)
  10437. (defvar org-log-post-message)
  10438. (defvar org-log-note-purpose)
  10439. (defvar org-log-note-how)
  10440. (defvar org-log-note-extra)
  10441. (defun org-auto-repeat-maybe (done-word)
  10442. "Check if the current headline contains a repeated deadline/schedule.
  10443. If yes, set TODO state back to what it was and change the base date
  10444. of repeating deadline/scheduled time stamps to new date.
  10445. This function is run automatically after each state change to a DONE state."
  10446. ;; last-state is dynamically scoped into this function
  10447. (let* ((repeat (org-get-repeat))
  10448. (aa (assoc last-state org-todo-kwd-alist))
  10449. (interpret (nth 1 aa))
  10450. (head (nth 2 aa))
  10451. (whata '(("d" . day) ("m" . month) ("y" . year)))
  10452. (msg "Entry repeats: ")
  10453. (org-log-done nil)
  10454. (org-todo-log-states nil)
  10455. re type n what ts time to-state)
  10456. (when repeat
  10457. (if (eq org-log-repeat t) (setq org-log-repeat 'state))
  10458. (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
  10459. org-todo-repeat-to-state))
  10460. (unless (and to-state (member to-state org-todo-keywords-1))
  10461. (setq to-state (if (eq interpret 'type) last-state head)))
  10462. (org-todo to-state)
  10463. (when (or org-log-repeat (org-entry-get nil "CLOCK"))
  10464. (org-entry-put nil "LAST_REPEAT" (format-time-string
  10465. (org-time-stamp-format t t))))
  10466. (when org-log-repeat
  10467. (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
  10468. (memq 'org-add-log-note post-command-hook))
  10469. ;; OK, we are already setup for some record
  10470. (if (eq org-log-repeat 'note)
  10471. ;; make sure we take a note, not only a time stamp
  10472. (setq org-log-note-how 'note))
  10473. ;; Set up for taking a record
  10474. (org-add-log-setup 'state (or done-word (car org-done-keywords))
  10475. last-state
  10476. 'findpos org-log-repeat)))
  10477. (org-back-to-heading t)
  10478. (org-add-planning-info nil nil 'closed)
  10479. (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  10480. org-deadline-time-regexp "\\)\\|\\("
  10481. org-ts-regexp "\\)"))
  10482. (while (re-search-forward
  10483. re (save-excursion (outline-next-heading) (point)) t)
  10484. (setq type (if (match-end 1) org-scheduled-string
  10485. (if (match-end 3) org-deadline-string "Plain:"))
  10486. ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
  10487. (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([dwmy]\\)" ts)
  10488. (setq n (string-to-number (match-string 2 ts))
  10489. what (match-string 3 ts))
  10490. (if (equal what "w") (setq n (* n 7) what "d"))
  10491. ;; Preparation, see if we need to modify the start date for the change
  10492. (when (match-end 1)
  10493. (setq time (save-match-data (org-time-string-to-time ts)))
  10494. (cond
  10495. ((equal (match-string 1 ts) ".")
  10496. ;; Shift starting date to today
  10497. (org-timestamp-change
  10498. (- (time-to-days (current-time)) (time-to-days time))
  10499. 'day))
  10500. ((equal (match-string 1 ts) "+")
  10501. (let ((nshiftmax 10) (nshift 0))
  10502. (while (or (= nshift 0)
  10503. (<= (time-to-days time)
  10504. (time-to-days (current-time))))
  10505. (when (= (incf nshift) nshiftmax)
  10506. (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
  10507. (error "Abort")))
  10508. (org-timestamp-change n (cdr (assoc what whata)))
  10509. (org-at-timestamp-p t)
  10510. (setq ts (match-string 1))
  10511. (setq time (save-match-data (org-time-string-to-time ts)))))
  10512. (org-timestamp-change (- n) (cdr (assoc what whata)))
  10513. ;; rematch, so that we have everything in place for the real shift
  10514. (org-at-timestamp-p t)
  10515. (setq ts (match-string 1))
  10516. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([dwmy]\\)" ts))))
  10517. (org-timestamp-change n (cdr (assoc what whata)))
  10518. (setq msg (concat msg type " " org-last-changed-timestamp " "))))
  10519. (setq org-log-post-message msg)
  10520. (message "%s" msg))))
  10521. (defun org-show-todo-tree (arg)
  10522. "Make a compact tree which shows all headlines marked with TODO.
  10523. The tree will show the lines where the regexp matches, and all higher
  10524. headlines above the match.
  10525. With a \\[universal-argument] prefix, prompt for a regexp to match.
  10526. With a numeric prefix N, construct a sparse tree for the Nth element
  10527. of `org-todo-keywords-1'."
  10528. (interactive "P")
  10529. (let ((case-fold-search nil)
  10530. (kwd-re
  10531. (cond ((null arg) org-not-done-regexp)
  10532. ((equal arg '(4))
  10533. (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
  10534. (mapcar 'list org-todo-keywords-1))))
  10535. (concat "\\("
  10536. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  10537. "\\)\\>")))
  10538. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  10539. (regexp-quote (nth (1- (prefix-numeric-value arg))
  10540. org-todo-keywords-1)))
  10541. (t (error "Invalid prefix argument: %s" arg)))))
  10542. (message "%d TODO entries found"
  10543. (org-occur (concat "^" outline-regexp " *" kwd-re )))))
  10544. (defun org-deadline (&optional remove time)
  10545. "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
  10546. With argument REMOVE, remove any deadline from the item.
  10547. When TIME is set, it should be an internal time specification, and the
  10548. scheduling will use the corresponding date."
  10549. (interactive "P")
  10550. (let* ((old-date (org-entry-get nil "DEADLINE"))
  10551. (repeater (and old-date
  10552. (string-match
  10553. "\\([.+]+[0-9]+[dwmy]\\(?:[/ ][-+]?[0-9]+[dwmy]\\)?\\) ?"
  10554. old-date)
  10555. (match-string 1 old-date))))
  10556. (if remove
  10557. (progn
  10558. (when (and old-date org-log-redeadline)
  10559. (org-add-log-setup 'deldeadline nil old-date 'findpos
  10560. org-log-redeadline))
  10561. (org-remove-timestamp-with-keyword org-deadline-string)
  10562. (message "Item no longer has a deadline."))
  10563. (org-add-planning-info 'deadline time 'closed)
  10564. (when (and old-date org-log-redeadline
  10565. (not (equal old-date
  10566. (substring org-last-inserted-timestamp 1 -1))))
  10567. (org-add-log-setup 'redeadline nil old-date 'findpos
  10568. org-log-redeadline))
  10569. (when repeater
  10570. (save-excursion
  10571. (org-back-to-heading t)
  10572. (when (re-search-forward (concat org-deadline-string " "
  10573. org-last-inserted-timestamp)
  10574. (save-excursion
  10575. (outline-next-heading) (point)) t)
  10576. (goto-char (1- (match-end 0)))
  10577. (insert " " repeater)
  10578. (setq org-last-inserted-timestamp
  10579. (concat (substring org-last-inserted-timestamp 0 -1)
  10580. " " repeater
  10581. (substring org-last-inserted-timestamp -1))))))
  10582. (message "Deadline on %s" org-last-inserted-timestamp))))
  10583. (defun org-schedule (&optional remove time)
  10584. "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
  10585. With argument REMOVE, remove any scheduling date from the item.
  10586. When TIME is set, it should be an internal time specification, and the
  10587. scheduling will use the corresponding date."
  10588. (interactive "P")
  10589. (let* ((old-date (org-entry-get nil "SCHEDULED"))
  10590. (repeater (and old-date
  10591. (string-match
  10592. "\\([.+]+[0-9]+[dwmy]\\(?:[/ ][-+]?[0-9]+[dwmy]\\)?\\) ?"
  10593. old-date)
  10594. (match-string 1 old-date))))
  10595. (if remove
  10596. (progn
  10597. (when (and old-date org-log-reschedule)
  10598. (org-add-log-setup 'delschedule nil old-date 'findpos
  10599. org-log-reschedule))
  10600. (org-remove-timestamp-with-keyword org-scheduled-string)
  10601. (message "Item is no longer scheduled."))
  10602. (org-add-planning-info 'scheduled time 'closed)
  10603. (when (and old-date org-log-reschedule
  10604. (not (equal old-date
  10605. (substring org-last-inserted-timestamp 1 -1))))
  10606. (org-add-log-setup 'reschedule nil old-date 'findpos
  10607. org-log-reschedule))
  10608. (when repeater
  10609. (save-excursion
  10610. (org-back-to-heading t)
  10611. (when (re-search-forward (concat org-scheduled-string " "
  10612. org-last-inserted-timestamp)
  10613. (save-excursion
  10614. (outline-next-heading) (point)) t)
  10615. (goto-char (1- (match-end 0)))
  10616. (insert " " repeater)
  10617. (setq org-last-inserted-timestamp
  10618. (concat (substring org-last-inserted-timestamp 0 -1)
  10619. " " repeater
  10620. (substring org-last-inserted-timestamp -1))))))
  10621. (message "Scheduled to %s" org-last-inserted-timestamp))))
  10622. (defun org-get-scheduled-time (pom &optional inherit)
  10623. "Get the scheduled time as a time tuple, of a format suitable
  10624. for calling org-schedule with, or if there is no scheduling,
  10625. returns nil."
  10626. (let ((time (org-entry-get pom "SCHEDULED" inherit)))
  10627. (when time
  10628. (apply 'encode-time (org-parse-time-string time)))))
  10629. (defun org-get-deadline-time (pom &optional inherit)
  10630. "Get the deadline as a time tuple, of a format suitable for
  10631. calling org-deadline with, or if there is no scheduling, returns
  10632. nil."
  10633. (let ((time (org-entry-get pom "DEADLINE" inherit)))
  10634. (when time
  10635. (apply 'encode-time (org-parse-time-string time)))))
  10636. (defun org-remove-timestamp-with-keyword (keyword)
  10637. "Remove all time stamps with KEYWORD in the current entry."
  10638. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  10639. beg)
  10640. (save-excursion
  10641. (org-back-to-heading t)
  10642. (setq beg (point))
  10643. (outline-next-heading)
  10644. (while (re-search-backward re beg t)
  10645. (replace-match "")
  10646. (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
  10647. (equal (char-before) ?\ ))
  10648. (backward-delete-char 1)
  10649. (if (string-match "^[ \t]*$" (buffer-substring
  10650. (point-at-bol) (point-at-eol)))
  10651. (delete-region (point-at-bol)
  10652. (min (point-max) (1+ (point-at-eol))))))))))
  10653. (defun org-add-planning-info (what &optional time &rest remove)
  10654. "Insert new timestamp with keyword in the line directly after the headline.
  10655. WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
  10656. If non is given, the user is prompted for a date.
  10657. REMOVE indicates what kind of entries to remove. An old WHAT entry will also
  10658. be removed."
  10659. (interactive)
  10660. (let (org-time-was-given org-end-time-was-given ts
  10661. end default-time default-input)
  10662. (catch 'exit
  10663. (when (and (not time) (memq what '(scheduled deadline)))
  10664. ;; Try to get a default date/time from existing timestamp
  10665. (save-excursion
  10666. (org-back-to-heading t)
  10667. (setq end (save-excursion (outline-next-heading) (point)))
  10668. (when (re-search-forward (if (eq what 'scheduled)
  10669. org-scheduled-time-regexp
  10670. org-deadline-time-regexp)
  10671. end t)
  10672. (setq ts (match-string 1)
  10673. default-time
  10674. (apply 'encode-time (org-parse-time-string ts))
  10675. default-input (and ts (org-get-compact-tod ts))))))
  10676. (when what
  10677. ;; If necessary, get the time from the user
  10678. (setq time (or time (org-read-date nil 'to-time nil nil
  10679. default-time default-input))))
  10680. (when (and org-insert-labeled-timestamps-at-point
  10681. (member what '(scheduled deadline)))
  10682. (insert
  10683. (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
  10684. (org-insert-time-stamp time org-time-was-given
  10685. nil nil nil (list org-end-time-was-given))
  10686. (setq what nil))
  10687. (save-excursion
  10688. (save-restriction
  10689. (let (col list elt ts buffer-invisibility-spec)
  10690. (org-back-to-heading t)
  10691. (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"))
  10692. (goto-char (match-end 1))
  10693. (setq col (current-column))
  10694. (goto-char (match-end 0))
  10695. (if (eobp) (insert "\n") (forward-char 1))
  10696. (when (and (not what)
  10697. (not (looking-at
  10698. (concat "[ \t]*"
  10699. org-keyword-time-not-clock-regexp))))
  10700. ;; Nothing to add, nothing to remove...... :-)
  10701. (throw 'exit nil))
  10702. (if (and (not (looking-at outline-regexp))
  10703. (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
  10704. "[^\r\n]*"))
  10705. (not (equal (match-string 1) org-clock-string)))
  10706. (narrow-to-region (match-beginning 0) (match-end 0))
  10707. (insert-before-markers "\n")
  10708. (backward-char 1)
  10709. (narrow-to-region (point) (point))
  10710. (and org-adapt-indentation (org-indent-to-column col)))
  10711. ;; Check if we have to remove something.
  10712. (setq list (cons what remove))
  10713. (while list
  10714. (setq elt (pop list))
  10715. (goto-char (point-min))
  10716. (when (or (and (eq elt 'scheduled)
  10717. (re-search-forward org-scheduled-time-regexp nil t))
  10718. (and (eq elt 'deadline)
  10719. (re-search-forward org-deadline-time-regexp nil t))
  10720. (and (eq elt 'closed)
  10721. (re-search-forward org-closed-time-regexp nil t)))
  10722. (replace-match "")
  10723. (if (looking-at "--+<[^>]+>") (replace-match ""))
  10724. (skip-chars-backward " ")
  10725. (if (looking-at " +") (replace-match ""))))
  10726. (goto-char (point-max))
  10727. (and org-adapt-indentation (bolp) (org-indent-to-column col))
  10728. (when what
  10729. (insert
  10730. (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
  10731. (cond ((eq what 'scheduled) org-scheduled-string)
  10732. ((eq what 'deadline) org-deadline-string)
  10733. ((eq what 'closed) org-closed-string))
  10734. " ")
  10735. (setq ts (org-insert-time-stamp
  10736. time
  10737. (or org-time-was-given
  10738. (and (eq what 'closed) org-log-done-with-time))
  10739. (eq what 'closed)
  10740. nil nil (list org-end-time-was-given)))
  10741. (end-of-line 1))
  10742. (goto-char (point-min))
  10743. (widen)
  10744. (if (and (looking-at "[ \t]*\n")
  10745. (equal (char-before) ?\n))
  10746. (delete-region (1- (point)) (point-at-eol)))
  10747. ts))))))
  10748. (defvar org-log-note-marker (make-marker))
  10749. (defvar org-log-note-purpose nil)
  10750. (defvar org-log-note-state nil)
  10751. (defvar org-log-note-previous-state nil)
  10752. (defvar org-log-note-how nil)
  10753. (defvar org-log-note-extra nil)
  10754. (defvar org-log-note-window-configuration nil)
  10755. (defvar org-log-note-return-to (make-marker))
  10756. (defvar org-log-post-message nil
  10757. "Message to be displayed after a log note has been stored.
  10758. The auto-repeater uses this.")
  10759. (defun org-add-note ()
  10760. "Add a note to the current entry.
  10761. This is done in the same way as adding a state change note."
  10762. (interactive)
  10763. (org-add-log-setup 'note nil nil 'findpos nil))
  10764. (defvar org-property-end-re)
  10765. (defun org-add-log-setup (&optional purpose state prev-state
  10766. findpos how extra)
  10767. "Set up the post command hook to take a note.
  10768. If this is about to TODO state change, the new state is expected in STATE.
  10769. When FINDPOS is non-nil, find the correct position for the note in
  10770. the current entry. If not, assume that it can be inserted at point.
  10771. HOW is an indicator what kind of note should be created.
  10772. EXTRA is additional text that will be inserted into the notes buffer."
  10773. (let* ((org-log-into-drawer (org-log-into-drawer))
  10774. (drawer (cond ((stringp org-log-into-drawer)
  10775. org-log-into-drawer)
  10776. (org-log-into-drawer "LOGBOOK")
  10777. (t nil))))
  10778. (save-restriction
  10779. (save-excursion
  10780. (when findpos
  10781. (org-back-to-heading t)
  10782. (narrow-to-region (point) (save-excursion
  10783. (outline-next-heading) (point)))
  10784. (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"
  10785. "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
  10786. "[^\r\n]*\\)?"))
  10787. (goto-char (match-end 0))
  10788. (cond
  10789. (drawer
  10790. (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
  10791. nil t)
  10792. (progn
  10793. (goto-char (match-end 0))
  10794. (or org-log-states-order-reversed
  10795. (and (re-search-forward org-property-end-re nil t)
  10796. (goto-char (1- (match-beginning 0))))))
  10797. (insert "\n:" drawer ":\n:END:")
  10798. (beginning-of-line 0)
  10799. (org-indent-line-function)
  10800. (beginning-of-line 2)
  10801. (org-indent-line-function)
  10802. (end-of-line 0)))
  10803. ((and org-log-state-notes-insert-after-drawers
  10804. (save-excursion
  10805. (forward-line) (looking-at org-drawer-regexp)))
  10806. (forward-line)
  10807. (while (looking-at org-drawer-regexp)
  10808. (goto-char (match-end 0))
  10809. (re-search-forward org-property-end-re (point-max) t)
  10810. (forward-line))
  10811. (forward-line -1)))
  10812. (unless org-log-states-order-reversed
  10813. (and (= (char-after) ?\n) (forward-char 1))
  10814. (org-skip-over-state-notes)
  10815. (skip-chars-backward " \t\n\r")))
  10816. (move-marker org-log-note-marker (point))
  10817. (setq org-log-note-purpose purpose
  10818. org-log-note-state state
  10819. org-log-note-previous-state prev-state
  10820. org-log-note-how how
  10821. org-log-note-extra extra)
  10822. (add-hook 'post-command-hook 'org-add-log-note 'append)))))
  10823. (defun org-skip-over-state-notes ()
  10824. "Skip past the list of State notes in an entry."
  10825. (if (looking-at "\n[ \t]*- State") (forward-char 1))
  10826. (when (ignore-errors (goto-char (org-in-item-p)))
  10827. (let* ((struct (org-list-struct))
  10828. (prevs (org-list-prevs-alist struct)))
  10829. (while (looking-at "[ \t]*- State")
  10830. (goto-char (or (org-list-get-next-item (point) struct prevs)
  10831. (org-list-get-item-end (point) struct)))))))
  10832. (defun org-add-log-note (&optional purpose)
  10833. "Pop up a window for taking a note, and add this note later at point."
  10834. (remove-hook 'post-command-hook 'org-add-log-note)
  10835. (setq org-log-note-window-configuration (current-window-configuration))
  10836. (delete-other-windows)
  10837. (move-marker org-log-note-return-to (point))
  10838. (switch-to-buffer (marker-buffer org-log-note-marker))
  10839. (goto-char org-log-note-marker)
  10840. (org-switch-to-buffer-other-window "*Org Note*")
  10841. (erase-buffer)
  10842. (if (memq org-log-note-how '(time state))
  10843. (let (current-prefix-arg) (org-store-log-note))
  10844. (let ((org-inhibit-startup t)) (org-mode))
  10845. (insert (format "# Insert note for %s.
  10846. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  10847. (cond
  10848. ((eq org-log-note-purpose 'clock-out) "stopped clock")
  10849. ((eq org-log-note-purpose 'done) "closed todo item")
  10850. ((eq org-log-note-purpose 'state)
  10851. (format "state change from \"%s\" to \"%s\""
  10852. (or org-log-note-previous-state "")
  10853. (or org-log-note-state "")))
  10854. ((eq org-log-note-purpose 'reschedule)
  10855. "rescheduling")
  10856. ((eq org-log-note-purpose 'delschedule)
  10857. "no longer scheduled")
  10858. ((eq org-log-note-purpose 'redeadline)
  10859. "changing deadline")
  10860. ((eq org-log-note-purpose 'deldeadline)
  10861. "removing deadline")
  10862. ((eq org-log-note-purpose 'refile)
  10863. "refiling")
  10864. ((eq org-log-note-purpose 'note)
  10865. "this entry")
  10866. (t (error "This should not happen")))))
  10867. (if org-log-note-extra (insert org-log-note-extra))
  10868. (org-set-local 'org-finish-function 'org-store-log-note)))
  10869. (defvar org-note-abort nil) ; dynamically scoped
  10870. (defun org-store-log-note ()
  10871. "Finish taking a log note, and insert it to where it belongs."
  10872. (let ((txt (buffer-string))
  10873. (note (cdr (assq org-log-note-purpose org-log-note-headings)))
  10874. lines ind bul)
  10875. (kill-buffer (current-buffer))
  10876. (while (string-match "\\`#.*\n[ \t\n]*" txt)
  10877. (setq txt (replace-match "" t t txt)))
  10878. (if (string-match "\\s-+\\'" txt)
  10879. (setq txt (replace-match "" t t txt)))
  10880. (setq lines (org-split-string txt "\n"))
  10881. (when (and note (string-match "\\S-" note))
  10882. (setq note
  10883. (org-replace-escapes
  10884. note
  10885. (list (cons "%u" (user-login-name))
  10886. (cons "%U" user-full-name)
  10887. (cons "%t" (format-time-string
  10888. (org-time-stamp-format 'long 'inactive)
  10889. (current-time)))
  10890. (cons "%T" (format-time-string
  10891. (org-time-stamp-format 'long nil)
  10892. (current-time)))
  10893. (cons "%s" (if org-log-note-state
  10894. (concat "\"" org-log-note-state "\"")
  10895. ""))
  10896. (cons "%S" (if org-log-note-previous-state
  10897. (concat "\"" org-log-note-previous-state "\"")
  10898. "\"\"")))))
  10899. (if lines (setq note (concat note " \\\\")))
  10900. (push note lines))
  10901. (when (or current-prefix-arg org-note-abort)
  10902. (when org-log-into-drawer
  10903. (org-remove-empty-drawer-at
  10904. (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
  10905. org-log-note-marker))
  10906. (setq lines nil))
  10907. (when lines
  10908. (with-current-buffer (marker-buffer org-log-note-marker)
  10909. (save-excursion
  10910. (goto-char org-log-note-marker)
  10911. (move-marker org-log-note-marker nil)
  10912. (end-of-line 1)
  10913. (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
  10914. (setq ind (save-excursion
  10915. (if (ignore-errors (goto-char (org-in-item-p)))
  10916. (let ((struct (org-list-struct)))
  10917. (org-list-get-ind
  10918. (org-list-get-top-point struct) struct))
  10919. (skip-chars-backward " \r\t\n")
  10920. (cond
  10921. ((and (org-at-heading-p)
  10922. org-adapt-indentation)
  10923. (1+ (org-current-level)))
  10924. ((org-at-heading-p) 0)
  10925. (t (org-get-indentation))))))
  10926. (setq bul (org-list-bullet-string "-"))
  10927. (org-indent-line-to ind)
  10928. (insert bul (pop lines))
  10929. (let ((ind-body (+ (length bul) ind)))
  10930. (while lines
  10931. (insert "\n")
  10932. (org-indent-line-to ind-body)
  10933. (insert (pop lines))))
  10934. (message "Note stored")
  10935. (org-back-to-heading t)
  10936. (org-cycle-hide-drawers 'children)))))
  10937. (set-window-configuration org-log-note-window-configuration)
  10938. (with-current-buffer (marker-buffer org-log-note-return-to)
  10939. (goto-char org-log-note-return-to))
  10940. (move-marker org-log-note-return-to nil)
  10941. (and org-log-post-message (message "%s" org-log-post-message)))
  10942. (defun org-remove-empty-drawer-at (drawer pos)
  10943. "Remove an empty drawer DRAWER at position POS.
  10944. POS may also be a marker."
  10945. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  10946. (save-excursion
  10947. (save-restriction
  10948. (widen)
  10949. (goto-char pos)
  10950. (if (org-in-regexp
  10951. (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
  10952. (replace-match ""))))))
  10953. (defun org-sparse-tree (&optional arg)
  10954. "Create a sparse tree, prompt for the details.
  10955. This command can create sparse trees. You first need to select the type
  10956. of match used to create the tree:
  10957. t Show all TODO entries.
  10958. T Show entries with a specific TODO keyword.
  10959. m Show entries selected by a tags/property match.
  10960. p Enter a property name and its value (both with completion on existing
  10961. names/values) and show entries with that property.
  10962. r Show entries matching a regular expression (`/' can be used as well)
  10963. d Show deadlines due within `org-deadline-warning-days'.
  10964. b Show deadlines and scheduled items before a date.
  10965. a Show deadlines and scheduled items after a date."
  10966. (interactive "P")
  10967. (let (ans kwd value)
  10968. (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
  10969. (setq ans (read-char-exclusive))
  10970. (cond
  10971. ((equal ans ?d)
  10972. (call-interactively 'org-check-deadlines))
  10973. ((equal ans ?b)
  10974. (call-interactively 'org-check-before-date))
  10975. ((equal ans ?a)
  10976. (call-interactively 'org-check-after-date))
  10977. ((equal ans ?t)
  10978. (org-show-todo-tree nil))
  10979. ((equal ans ?T)
  10980. (org-show-todo-tree '(4)))
  10981. ((member ans '(?T ?m))
  10982. (call-interactively 'org-match-sparse-tree))
  10983. ((member ans '(?p ?P))
  10984. (setq kwd (org-icompleting-read "Property: "
  10985. (mapcar 'list (org-buffer-property-keys))))
  10986. (setq value (org-icompleting-read "Value: "
  10987. (mapcar 'list (org-property-values kwd))))
  10988. (unless (string-match "\\`{.*}\\'" value)
  10989. (setq value (concat "\"" value "\"")))
  10990. (org-match-sparse-tree arg (concat kwd "=" value)))
  10991. ((member ans '(?r ?R ?/))
  10992. (call-interactively 'org-occur))
  10993. (t (error "No such sparse tree command \"%c\"" ans)))))
  10994. (defvar org-occur-highlights nil
  10995. "List of overlays used for occur matches.")
  10996. (make-variable-buffer-local 'org-occur-highlights)
  10997. (defvar org-occur-parameters nil
  10998. "Parameters of the active org-occur calls.
  10999. This is a list, each call to org-occur pushes as cons cell,
  11000. containing the regular expression and the callback, onto the list.
  11001. The list can contain several entries if `org-occur' has been called
  11002. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  11003. will only contain one set of parameters. When the highlights are
  11004. removed (for example with `C-c C-c', or with the next edit (depending
  11005. on `org-remove-highlights-with-change'), this variable is emptied
  11006. as well.")
  11007. (make-variable-buffer-local 'org-occur-parameters)
  11008. (defun org-occur (regexp &optional keep-previous callback)
  11009. "Make a compact tree which shows all matches of REGEXP.
  11010. The tree will show the lines where the regexp matches, and all higher
  11011. headlines above the match. It will also show the heading after the match,
  11012. to make sure editing the matching entry is easy.
  11013. If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
  11014. call to `org-occur' will be kept, to allow stacking of calls to this
  11015. command.
  11016. If CALLBACK is non-nil, it is a function which is called to confirm
  11017. that the match should indeed be shown."
  11018. (interactive "sRegexp: \nP")
  11019. (when (equal regexp "")
  11020. (error "Regexp cannot be empty"))
  11021. (unless keep-previous
  11022. (org-remove-occur-highlights nil nil t))
  11023. (push (cons regexp callback) org-occur-parameters)
  11024. (let ((cnt 0))
  11025. (save-excursion
  11026. (goto-char (point-min))
  11027. (if (or (not keep-previous) ; do not want to keep
  11028. (not org-occur-highlights)) ; no previous matches
  11029. ;; hide everything
  11030. (org-overview))
  11031. (while (re-search-forward regexp nil t)
  11032. (when (or (not callback)
  11033. (save-match-data (funcall callback)))
  11034. (setq cnt (1+ cnt))
  11035. (when org-highlight-sparse-tree-matches
  11036. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  11037. (org-show-context 'occur-tree))))
  11038. (when org-remove-highlights-with-change
  11039. (org-add-hook 'before-change-functions 'org-remove-occur-highlights
  11040. nil 'local))
  11041. (unless org-sparse-tree-open-archived-trees
  11042. (org-hide-archived-subtrees (point-min) (point-max)))
  11043. (run-hooks 'org-occur-hook)
  11044. (if (interactive-p)
  11045. (message "%d match(es) for regexp %s" cnt regexp))
  11046. cnt))
  11047. (defun org-occur-next-match (&optional n reset)
  11048. "Function for `next-error-function' to find sparse tree matches.
  11049. N is the number of matches to move, when negative move backwards.
  11050. RESET is entirely ignored - this function always goes back to the
  11051. starting point when no match is found."
  11052. (let* ((limit (if (< n 0) (point-min) (point-max)))
  11053. (search-func (if (< n 0)
  11054. 'previous-single-char-property-change
  11055. 'next-single-char-property-change))
  11056. (n (abs n))
  11057. (pos (point))
  11058. p1)
  11059. (catch 'exit
  11060. (while (setq p1 (funcall search-func (point) 'org-type))
  11061. (when (equal p1 limit)
  11062. (goto-char pos)
  11063. (error "No more matches"))
  11064. (when (equal (get-char-property p1 'org-type) 'org-occur)
  11065. (setq n (1- n))
  11066. (when (= n 0)
  11067. (goto-char p1)
  11068. (throw 'exit (point))))
  11069. (goto-char p1))
  11070. (goto-char p1)
  11071. (error "No more matches"))))
  11072. (defun org-show-context (&optional key)
  11073. "Make sure point and context are visible.
  11074. How much context is shown depends upon the variables
  11075. `org-show-hierarchy-above', `org-show-following-heading'. and
  11076. `org-show-siblings'."
  11077. (let ((heading-p (org-on-heading-p t))
  11078. (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
  11079. (following-p (org-get-alist-option org-show-following-heading key))
  11080. (entry-p (org-get-alist-option org-show-entry-below key))
  11081. (siblings-p (org-get-alist-option org-show-siblings key)))
  11082. (catch 'exit
  11083. ;; Show heading or entry text
  11084. (if (and heading-p (not entry-p))
  11085. (org-flag-heading nil) ; only show the heading
  11086. (and (or entry-p (outline-invisible-p) (org-invisible-p2))
  11087. (org-show-hidden-entry))) ; show entire entry
  11088. (when following-p
  11089. ;; Show next sibling, or heading below text
  11090. (save-excursion
  11091. (and (if heading-p (org-goto-sibling) (outline-next-heading))
  11092. (org-flag-heading nil))))
  11093. (when siblings-p (org-show-siblings))
  11094. (when hierarchy-p
  11095. ;; show all higher headings, possibly with siblings
  11096. (save-excursion
  11097. (while (and (condition-case nil
  11098. (progn (org-up-heading-all 1) t)
  11099. (error nil))
  11100. (not (bobp)))
  11101. (org-flag-heading nil)
  11102. (when siblings-p (org-show-siblings))))))))
  11103. (defvar org-reveal-start-hook nil
  11104. "Hook run before revealing a location.")
  11105. (defun org-reveal (&optional siblings)
  11106. "Show current entry, hierarchy above it, and the following headline.
  11107. This can be used to show a consistent set of context around locations
  11108. exposed with `org-show-hierarchy-above' or `org-show-following-heading'
  11109. not t for the search context.
  11110. With optional argument SIBLINGS, on each level of the hierarchy all
  11111. siblings are shown. This repairs the tree structure to what it would
  11112. look like when opened with hierarchical calls to `org-cycle'.
  11113. With double optional argument \\[universal-argument] \\[universal-argument], \
  11114. go to the parent and show the
  11115. entire tree."
  11116. (interactive "P")
  11117. (run-hooks 'org-reveal-start-hook)
  11118. (let ((org-show-hierarchy-above t)
  11119. (org-show-following-heading t)
  11120. (org-show-siblings (if siblings t org-show-siblings)))
  11121. (org-show-context nil))
  11122. (when (equal siblings '(16))
  11123. (save-excursion
  11124. (when (org-up-heading-safe)
  11125. (org-show-subtree)
  11126. (run-hook-with-args 'org-cycle-hook 'subtree)))))
  11127. (defun org-highlight-new-match (beg end)
  11128. "Highlight from BEG to END and mark the highlight is an occur headline."
  11129. (let ((ov (make-overlay beg end)))
  11130. (overlay-put ov 'face 'secondary-selection)
  11131. (overlay-put ov 'org-type 'org-occur)
  11132. (push ov org-occur-highlights)))
  11133. (defun org-remove-occur-highlights (&optional beg end noremove)
  11134. "Remove the occur highlights from the buffer.
  11135. BEG and END are ignored. If NOREMOVE is nil, remove this function
  11136. from the `before-change-functions' in the current buffer."
  11137. (interactive)
  11138. (unless org-inhibit-highlight-removal
  11139. (mapc 'delete-overlay org-occur-highlights)
  11140. (setq org-occur-highlights nil)
  11141. (setq org-occur-parameters nil)
  11142. (unless noremove
  11143. (remove-hook 'before-change-functions
  11144. 'org-remove-occur-highlights 'local))))
  11145. ;;;; Priorities
  11146. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
  11147. "Regular expression matching the priority indicator.")
  11148. (defvar org-remove-priority-next-time nil)
  11149. (defun org-priority-up ()
  11150. "Increase the priority of the current item."
  11151. (interactive)
  11152. (org-priority 'up))
  11153. (defun org-priority-down ()
  11154. "Decrease the priority of the current item."
  11155. (interactive)
  11156. (org-priority 'down))
  11157. (defun org-priority (&optional action)
  11158. "Change the priority of an item by ARG.
  11159. ACTION can be `set', `up', `down', or a character."
  11160. (interactive)
  11161. (unless org-enable-priority-commands
  11162. (error "Priority commands are disabled"))
  11163. (setq action (or action 'set))
  11164. (let (current new news have remove)
  11165. (save-excursion
  11166. (org-back-to-heading t)
  11167. (if (looking-at org-priority-regexp)
  11168. (setq current (string-to-char (match-string 2))
  11169. have t)
  11170. (setq current org-default-priority))
  11171. (cond
  11172. ((eq action 'remove)
  11173. (setq remove t new ?\ ))
  11174. ((or (eq action 'set)
  11175. (if (featurep 'xemacs) (characterp action) (integerp action)))
  11176. (if (not (eq action 'set))
  11177. (setq new action)
  11178. (message "Priority %c-%c, SPC to remove: "
  11179. org-highest-priority org-lowest-priority)
  11180. (save-match-data
  11181. (setq new (read-char-exclusive))))
  11182. (if (and (= (upcase org-highest-priority) org-highest-priority)
  11183. (= (upcase org-lowest-priority) org-lowest-priority))
  11184. (setq new (upcase new)))
  11185. (cond ((equal new ?\ ) (setq remove t))
  11186. ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
  11187. (error "Priority must be between `%c' and `%c'"
  11188. org-highest-priority org-lowest-priority))))
  11189. ((eq action 'up)
  11190. (if (and (not have) (eq last-command this-command))
  11191. (setq new org-lowest-priority)
  11192. (setq new (if (and org-priority-start-cycle-with-default (not have))
  11193. org-default-priority (1- current)))))
  11194. ((eq action 'down)
  11195. (if (and (not have) (eq last-command this-command))
  11196. (setq new org-highest-priority)
  11197. (setq new (if (and org-priority-start-cycle-with-default (not have))
  11198. org-default-priority (1+ current)))))
  11199. (t (error "Invalid action")))
  11200. (if (or (< (upcase new) org-highest-priority)
  11201. (> (upcase new) org-lowest-priority))
  11202. (setq remove t))
  11203. (setq news (format "%c" new))
  11204. (if have
  11205. (if remove
  11206. (replace-match "" t t nil 1)
  11207. (replace-match news t t nil 2))
  11208. (if remove
  11209. (error "No priority cookie found in line")
  11210. (let ((case-fold-search nil))
  11211. (looking-at org-todo-line-regexp))
  11212. (if (match-end 2)
  11213. (progn
  11214. (goto-char (match-end 2))
  11215. (insert " [#" news "]"))
  11216. (goto-char (match-beginning 3))
  11217. (insert "[#" news "] "))))
  11218. (org-preserve-lc (org-set-tags nil 'align)))
  11219. (if remove
  11220. (message "Priority removed")
  11221. (message "Priority of current item set to %s" news))))
  11222. (defun org-get-priority (s)
  11223. "Find priority cookie and return priority."
  11224. (if (functionp org-get-priority-function)
  11225. (funcall org-get-priority-function)
  11226. (save-match-data
  11227. (if (not (string-match org-priority-regexp s))
  11228. (* 1000 (- org-lowest-priority org-default-priority))
  11229. (* 1000 (- org-lowest-priority
  11230. (string-to-char (match-string 2 s))))))))
  11231. ;;;; Tags
  11232. (defvar org-agenda-archives-mode)
  11233. (defvar org-map-continue-from nil
  11234. "Position from where mapping should continue.
  11235. Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
  11236. (defvar org-scanner-tags nil
  11237. "The current tag list while the tags scanner is running.")
  11238. (defvar org-trust-scanner-tags nil
  11239. "Should `org-get-tags-at' use the tags for the scanner.
  11240. This is for internal dynamical scoping only.
  11241. When this is non-nil, the function `org-get-tags-at' will return the value
  11242. of `org-scanner-tags' instead of building the list by itself. This
  11243. can lead to large speed-ups when the tags scanner is used in a file with
  11244. many entries, and when the list of tags is retrieved, for example to
  11245. obtain a list of properties. Building the tags list for each entry in such
  11246. a file becomes an N^2 operation - but with this variable set, it scales
  11247. as N.")
  11248. (defun org-scan-tags (action matcher &optional todo-only)
  11249. "Scan headline tags with inheritance and produce output ACTION.
  11250. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  11251. or `agenda' to produce an entry list for an agenda view. It can also be
  11252. a Lisp form or a function that should be called at each matched headline, in
  11253. this case the return value is a list of all return values from these calls.
  11254. MATCHER is a Lisp form to be evaluated, testing if a given set of tags
  11255. qualifies a headline for inclusion. When TODO-ONLY is non-nil,
  11256. only lines with a TODO keyword are included in the output."
  11257. (require 'org-agenda)
  11258. (let* ((re (concat "^" outline-regexp " *\\(\\<\\("
  11259. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  11260. (org-re
  11261. "\\>\\)\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
  11262. (props (list 'face 'default
  11263. 'done-face 'org-agenda-done
  11264. 'undone-face 'default
  11265. 'mouse-face 'highlight
  11266. 'org-not-done-regexp org-not-done-regexp
  11267. 'org-todo-regexp org-todo-regexp
  11268. 'help-echo
  11269. (format "mouse-2 or RET jump to org file %s"
  11270. (abbreviate-file-name
  11271. (or (buffer-file-name (buffer-base-buffer))
  11272. (buffer-name (buffer-base-buffer)))))))
  11273. (case-fold-search nil)
  11274. (org-map-continue-from nil)
  11275. lspos tags tags-list
  11276. (tags-alist (list (cons 0 org-file-tags)))
  11277. (llast 0) rtn rtn1 level category i txt
  11278. todo marker entry priority)
  11279. (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
  11280. (setq action (list 'lambda nil action)))
  11281. (save-excursion
  11282. (goto-char (point-min))
  11283. (when (eq action 'sparse-tree)
  11284. (org-overview)
  11285. (org-remove-occur-highlights))
  11286. (while (re-search-forward re nil t)
  11287. (catch :skip
  11288. (setq todo (if (match-end 1) (org-match-string-no-properties 2))
  11289. tags (if (match-end 4) (org-match-string-no-properties 4)))
  11290. (goto-char (setq lspos (match-beginning 0)))
  11291. (setq level (org-reduced-level (funcall outline-level))
  11292. category (org-get-category))
  11293. (setq i llast llast level)
  11294. ;; remove tag lists from same and sublevels
  11295. (while (>= i level)
  11296. (when (setq entry (assoc i tags-alist))
  11297. (setq tags-alist (delete entry tags-alist)))
  11298. (setq i (1- i)))
  11299. ;; add the next tags
  11300. (when tags
  11301. (setq tags (org-split-string tags ":")
  11302. tags-alist
  11303. (cons (cons level tags) tags-alist)))
  11304. ;; compile tags for current headline
  11305. (setq tags-list
  11306. (if org-use-tag-inheritance
  11307. (apply 'append (mapcar 'cdr (reverse tags-alist)))
  11308. tags)
  11309. org-scanner-tags tags-list)
  11310. (when org-use-tag-inheritance
  11311. (setcdr (car tags-alist)
  11312. (mapcar (lambda (x)
  11313. (setq x (copy-sequence x))
  11314. (org-add-prop-inherited x))
  11315. (cdar tags-alist))))
  11316. (when (and tags org-use-tag-inheritance
  11317. (or (not (eq t org-use-tag-inheritance))
  11318. org-tags-exclude-from-inheritance))
  11319. ;; selective inheritance, remove uninherited ones
  11320. (setcdr (car tags-alist)
  11321. (org-remove-uninherited-tags (cdar tags-alist))))
  11322. (when (and
  11323. ;; eval matcher only when the todo condition is OK
  11324. (and (or (not todo-only) (member todo org-not-done-keywords))
  11325. (let ((case-fold-search t)) (eval matcher)))
  11326. ;; Call the skipper, but return t if it does not skip,
  11327. ;; so that the `and' form continues evaluating
  11328. (progn
  11329. (unless (eq action 'sparse-tree) (org-agenda-skip))
  11330. t)
  11331. ;; Check if timestamps are deselecting this entry
  11332. (or (not todo-only)
  11333. (and (member todo org-not-done-keywords)
  11334. (or (not org-agenda-tags-todo-honor-ignore-options)
  11335. (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
  11336. ;; Extra check for the archive tag
  11337. ;; FIXME: Does the skipper already do this????
  11338. (or
  11339. (not (member org-archive-tag tags-list))
  11340. ;; we have an archive tag, should we use this anyway?
  11341. (or (not org-agenda-skip-archived-trees)
  11342. (and (eq action 'agenda) org-agenda-archives-mode))))
  11343. ;; select this headline
  11344. (cond
  11345. ((eq action 'sparse-tree)
  11346. (and org-highlight-sparse-tree-matches
  11347. (org-get-heading) (match-end 0)
  11348. (org-highlight-new-match
  11349. (match-beginning 0) (match-beginning 1)))
  11350. (org-show-context 'tags-tree))
  11351. ((eq action 'agenda)
  11352. (setq txt (org-format-agenda-item
  11353. ""
  11354. (concat
  11355. (if (eq org-tags-match-list-sublevels 'indented)
  11356. (make-string (1- level) ?.) "")
  11357. (org-get-heading))
  11358. category
  11359. tags-list
  11360. )
  11361. priority (org-get-priority txt))
  11362. (goto-char lspos)
  11363. (setq marker (org-agenda-new-marker))
  11364. (org-add-props txt props
  11365. 'org-marker marker 'org-hd-marker marker 'org-category category
  11366. 'todo-state todo
  11367. 'priority priority 'type "tagsmatch")
  11368. (push txt rtn))
  11369. ((functionp action)
  11370. (setq org-map-continue-from nil)
  11371. (save-excursion
  11372. (setq rtn1 (funcall action))
  11373. (push rtn1 rtn)))
  11374. (t (error "Invalid action")))
  11375. ;; if we are to skip sublevels, jump to end of subtree
  11376. (unless org-tags-match-list-sublevels
  11377. (org-end-of-subtree t)
  11378. (backward-char 1))))
  11379. ;; Get the correct position from where to continue
  11380. (if org-map-continue-from
  11381. (goto-char org-map-continue-from)
  11382. (and (= (point) lspos) (end-of-line 1)))))
  11383. (when (and (eq action 'sparse-tree)
  11384. (not org-sparse-tree-open-archived-trees))
  11385. (org-hide-archived-subtrees (point-min) (point-max)))
  11386. (nreverse rtn)))
  11387. (defun org-remove-uninherited-tags (tags)
  11388. "Remove all tags that are not inherited from the list TAGS."
  11389. (cond
  11390. ((eq org-use-tag-inheritance t)
  11391. (if org-tags-exclude-from-inheritance
  11392. (org-delete-all org-tags-exclude-from-inheritance tags)
  11393. tags))
  11394. ((not org-use-tag-inheritance) nil)
  11395. ((stringp org-use-tag-inheritance)
  11396. (delq nil (mapcar
  11397. (lambda (x)
  11398. (if (and (string-match org-use-tag-inheritance x)
  11399. (not (member x org-tags-exclude-from-inheritance)))
  11400. x nil))
  11401. tags)))
  11402. ((listp org-use-tag-inheritance)
  11403. (delq nil (mapcar
  11404. (lambda (x)
  11405. (if (member x org-use-tag-inheritance) x nil))
  11406. tags)))))
  11407. (defvar todo-only) ;; dynamically scoped
  11408. (defun org-match-sparse-tree (&optional todo-only match)
  11409. "Create a sparse tree according to tags string MATCH.
  11410. MATCH can contain positive and negative selection of tags, like
  11411. \"+WORK+URGENT-WITHBOSS\".
  11412. If optional argument TODO-ONLY is non-nil, only select lines that are
  11413. also TODO lines."
  11414. (interactive "P")
  11415. (org-prepare-agenda-buffers (list (current-buffer)))
  11416. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
  11417. (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
  11418. (defvar org-cached-props nil)
  11419. (defun org-cached-entry-get (pom property)
  11420. (if (or (eq t org-use-property-inheritance)
  11421. (and (stringp org-use-property-inheritance)
  11422. (string-match org-use-property-inheritance property))
  11423. (and (listp org-use-property-inheritance)
  11424. (member property org-use-property-inheritance)))
  11425. ;; Caching is not possible, check it directly
  11426. (org-entry-get pom property 'inherit)
  11427. ;; Get all properties, so that we can do complicated checks easily
  11428. (cdr (assoc property (or org-cached-props
  11429. (setq org-cached-props
  11430. (org-entry-properties pom)))))))
  11431. (defun org-global-tags-completion-table (&optional files)
  11432. "Return the list of all tags in all agenda buffer/files.
  11433. Optional FILES argument is a list of files to which can be used
  11434. instead of the agenda files."
  11435. (save-excursion
  11436. (org-uniquify
  11437. (delq nil
  11438. (apply 'append
  11439. (mapcar
  11440. (lambda (file)
  11441. (set-buffer (find-file-noselect file))
  11442. (append (org-get-buffer-tags)
  11443. (mapcar (lambda (x) (if (stringp (car-safe x))
  11444. (list (car-safe x)) nil))
  11445. org-tag-alist)))
  11446. (if (and files (car files))
  11447. files
  11448. (org-agenda-files))))))))
  11449. (defun org-make-tags-matcher (match)
  11450. "Create the TAGS/TODO matcher form for the selection string MATCH."
  11451. ;; todo-only is scoped dynamically into this function, and the function
  11452. ;; may change it if the matcher asks for it.
  11453. (unless match
  11454. ;; Get a new match request, with completion
  11455. (let ((org-last-tags-completion-table
  11456. (org-global-tags-completion-table)))
  11457. (setq match (org-completing-read-no-i
  11458. "Match: " 'org-tags-completion-function nil nil nil
  11459. 'org-tags-history))))
  11460. ;; Parse the string and create a lisp form
  11461. (let ((match0 match)
  11462. (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
  11463. minus tag mm
  11464. tagsmatch todomatch tagsmatcher todomatcher kwd matcher
  11465. orterms term orlist re-p str-p level-p level-op time-p
  11466. prop-p pn pv po gv rest)
  11467. (if (string-match "/+" match)
  11468. ;; match contains also a todo-matching request
  11469. (progn
  11470. (setq tagsmatch (substring match 0 (match-beginning 0))
  11471. todomatch (substring match (match-end 0)))
  11472. (if (string-match "^!" todomatch)
  11473. (setq todo-only t todomatch (substring todomatch 1)))
  11474. (if (string-match "^\\s-*$" todomatch)
  11475. (setq todomatch nil)))
  11476. ;; only matching tags
  11477. (setq tagsmatch match todomatch nil))
  11478. ;; Make the tags matcher
  11479. (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
  11480. (setq tagsmatcher t)
  11481. (setq orterms (org-split-string tagsmatch "|") orlist nil)
  11482. (while (setq term (pop orterms))
  11483. (while (and (equal (substring term -1) "\\") orterms)
  11484. (setq term (concat term "|" (pop orterms)))) ; repair bad split
  11485. (while (string-match re term)
  11486. (setq rest (substring term (match-end 0))
  11487. minus (and (match-end 1)
  11488. (equal (match-string 1 term) "-"))
  11489. tag (save-match-data (replace-regexp-in-string
  11490. "\\\\-" "-"
  11491. (match-string 2 term)))
  11492. re-p (equal (string-to-char tag) ?{)
  11493. level-p (match-end 4)
  11494. prop-p (match-end 5)
  11495. mm (cond
  11496. (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
  11497. (level-p
  11498. (setq level-op (org-op-to-function (match-string 3 term)))
  11499. `(,level-op level ,(string-to-number
  11500. (match-string 4 term))))
  11501. (prop-p
  11502. (setq pn (match-string 5 term)
  11503. po (match-string 6 term)
  11504. pv (match-string 7 term)
  11505. re-p (equal (string-to-char pv) ?{)
  11506. str-p (equal (string-to-char pv) ?\")
  11507. time-p (save-match-data
  11508. (string-match "^\"[[<].*[]>]\"$" pv))
  11509. pv (if (or re-p str-p) (substring pv 1 -1) pv))
  11510. (if time-p (setq pv (org-matcher-time pv)))
  11511. (setq po (org-op-to-function po (if time-p 'time str-p)))
  11512. (cond
  11513. ((equal pn "CATEGORY")
  11514. (setq gv '(get-text-property (point) 'org-category)))
  11515. ((equal pn "TODO")
  11516. (setq gv 'todo))
  11517. (t
  11518. (setq gv `(org-cached-entry-get nil ,pn))))
  11519. (if re-p
  11520. (if (eq po 'org<>)
  11521. `(not (string-match ,pv (or ,gv "")))
  11522. `(string-match ,pv (or ,gv "")))
  11523. (if str-p
  11524. `(,po (or ,gv "") ,pv)
  11525. `(,po (string-to-number (or ,gv ""))
  11526. ,(string-to-number pv) ))))
  11527. (t `(member ,tag tags-list)))
  11528. mm (if minus (list 'not mm) mm)
  11529. term rest)
  11530. (push mm tagsmatcher))
  11531. (push (if (> (length tagsmatcher) 1)
  11532. (cons 'and tagsmatcher)
  11533. (car tagsmatcher))
  11534. orlist)
  11535. (setq tagsmatcher nil))
  11536. (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
  11537. (setq tagsmatcher
  11538. (list 'progn '(setq org-cached-props nil) tagsmatcher)))
  11539. ;; Make the todo matcher
  11540. (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
  11541. (setq todomatcher t)
  11542. (setq orterms (org-split-string todomatch "|") orlist nil)
  11543. (while (setq term (pop orterms))
  11544. (while (string-match re term)
  11545. (setq minus (and (match-end 1)
  11546. (equal (match-string 1 term) "-"))
  11547. kwd (match-string 2 term)
  11548. re-p (equal (string-to-char kwd) ?{)
  11549. term (substring term (match-end 0))
  11550. mm (if re-p
  11551. `(string-match ,(substring kwd 1 -1) todo)
  11552. (list 'equal 'todo kwd))
  11553. mm (if minus (list 'not mm) mm))
  11554. (push mm todomatcher))
  11555. (push (if (> (length todomatcher) 1)
  11556. (cons 'and todomatcher)
  11557. (car todomatcher))
  11558. orlist)
  11559. (setq todomatcher nil))
  11560. (setq todomatcher (if (> (length orlist) 1)
  11561. (cons 'or orlist) (car orlist))))
  11562. ;; Return the string and lisp forms of the matcher
  11563. (setq matcher (if todomatcher
  11564. (list 'and tagsmatcher todomatcher)
  11565. tagsmatcher))
  11566. (cons match0 matcher)))
  11567. (defun org-op-to-function (op &optional stringp)
  11568. "Turn an operator into the appropriate function."
  11569. (setq op
  11570. (cond
  11571. ((equal op "<" ) '(< string< org-time<))
  11572. ((equal op ">" ) '(> org-string> org-time>))
  11573. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  11574. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  11575. ((member op '("=" "==")) '(= string= org-time=))
  11576. ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
  11577. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  11578. (defun org<> (a b) (not (= a b)))
  11579. (defun org-string<= (a b) (or (string= a b) (string< a b)))
  11580. (defun org-string>= (a b) (not (string< a b)))
  11581. (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
  11582. (defun org-string<> (a b) (not (string= a b)))
  11583. (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
  11584. (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
  11585. (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
  11586. (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
  11587. (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
  11588. (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
  11589. (defun org-2ft (s)
  11590. "Convert S to a floating point time.
  11591. If S is already a number, just return it. If it is a string, parse
  11592. it as a time string and apply `float-time' to it. If S is nil, just return 0."
  11593. (cond
  11594. ((numberp s) s)
  11595. ((stringp s)
  11596. (condition-case nil
  11597. (float-time (apply 'encode-time (org-parse-time-string s)))
  11598. (error 0.)))
  11599. (t 0.)))
  11600. (defun org-time-today ()
  11601. "Time in seconds today at 0:00.
  11602. Returns the float number of seconds since the beginning of the
  11603. epoch to the beginning of today (00:00)."
  11604. (float-time (apply 'encode-time
  11605. (append '(0 0 0) (nthcdr 3 (decode-time))))))
  11606. (defun org-matcher-time (s)
  11607. "Interpret a time comparison value."
  11608. (save-match-data
  11609. (cond
  11610. ((string= s "<now>") (float-time))
  11611. ((string= s "<today>") (org-time-today))
  11612. ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
  11613. ((string= s "<yesterday>") (- (org-time-today) 86400.0))
  11614. ((string-match "^<\\([-+][0-9]+\\)\\([dwmy]\\)>$" s)
  11615. (+ (org-time-today)
  11616. (* (string-to-number (match-string 1 s))
  11617. (cdr (assoc (match-string 2 s)
  11618. '(("d" . 86400.0) ("w" . 604800.0)
  11619. ("m" . 2678400.0) ("y" . 31557600.0)))))))
  11620. (t (org-2ft s)))))
  11621. (defun org-match-any-p (re list)
  11622. "Does re match any element of list?"
  11623. (setq list (mapcar (lambda (x) (string-match re x)) list))
  11624. (delq nil list))
  11625. (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
  11626. (defvar org-tags-overlay (make-overlay 1 1))
  11627. (org-detach-overlay org-tags-overlay)
  11628. (defun org-get-local-tags-at (&optional pos)
  11629. "Get a list of tags defined in the current headline."
  11630. (org-get-tags-at pos 'local))
  11631. (defun org-get-local-tags ()
  11632. "Get a list of tags defined in the current headline."
  11633. (org-get-tags-at nil 'local))
  11634. (defun org-get-tags-at (&optional pos local)
  11635. "Get a list of all headline tags applicable at POS.
  11636. POS defaults to point. If tags are inherited, the list contains
  11637. the targets in the same sequence as the headlines appear, i.e.
  11638. the tags of the current headline come last.
  11639. When LOCAL is non-nil, only return tags from the current headline,
  11640. ignore inherited ones."
  11641. (interactive)
  11642. (if (and org-trust-scanner-tags
  11643. (or (not pos) (equal pos (point)))
  11644. (not local))
  11645. org-scanner-tags
  11646. (let (tags ltags lastpos parent)
  11647. (save-excursion
  11648. (save-restriction
  11649. (widen)
  11650. (goto-char (or pos (point)))
  11651. (save-match-data
  11652. (catch 'done
  11653. (condition-case nil
  11654. (progn
  11655. (org-back-to-heading t)
  11656. (while (not (equal lastpos (point)))
  11657. (setq lastpos (point))
  11658. (when (looking-at
  11659. (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
  11660. (setq ltags (org-split-string
  11661. (org-match-string-no-properties 1) ":"))
  11662. (when parent
  11663. (setq ltags (mapcar 'org-add-prop-inherited ltags)))
  11664. (setq tags (append
  11665. (if parent
  11666. (org-remove-uninherited-tags ltags)
  11667. ltags)
  11668. tags)))
  11669. (or org-use-tag-inheritance (throw 'done t))
  11670. (if local (throw 'done t))
  11671. (or (org-up-heading-safe) (error nil))
  11672. (setq parent t)))
  11673. (error nil)))))
  11674. (if local
  11675. tags
  11676. (append (org-remove-uninherited-tags org-file-tags) tags))))))
  11677. (defun org-add-prop-inherited (s)
  11678. (add-text-properties 0 (length s) '(inherited t) s)
  11679. s)
  11680. (defun org-toggle-tag (tag &optional onoff)
  11681. "Toggle the tag TAG for the current line.
  11682. If ONOFF is `on' or `off', don't toggle but set to this state."
  11683. (let (res current)
  11684. (save-excursion
  11685. (org-back-to-heading t)
  11686. (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
  11687. (point-at-eol) t)
  11688. (progn
  11689. (setq current (match-string 1))
  11690. (replace-match ""))
  11691. (setq current ""))
  11692. (setq current (nreverse (org-split-string current ":")))
  11693. (cond
  11694. ((eq onoff 'on)
  11695. (setq res t)
  11696. (or (member tag current) (push tag current)))
  11697. ((eq onoff 'off)
  11698. (or (not (member tag current)) (setq current (delete tag current))))
  11699. (t (if (member tag current)
  11700. (setq current (delete tag current))
  11701. (setq res t)
  11702. (push tag current))))
  11703. (end-of-line 1)
  11704. (if current
  11705. (progn
  11706. (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
  11707. (org-set-tags nil t))
  11708. (delete-horizontal-space))
  11709. (run-hooks 'org-after-tags-change-hook))
  11710. res))
  11711. (defun org-align-tags-here (to-col)
  11712. ;; Assumes that this is a headline
  11713. (let ((pos (point)) (col (current-column)) ncol tags-l p)
  11714. (beginning-of-line 1)
  11715. (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  11716. (< pos (match-beginning 2)))
  11717. (progn
  11718. (setq tags-l (- (match-end 2) (match-beginning 2)))
  11719. (goto-char (match-beginning 1))
  11720. (insert " ")
  11721. (delete-region (point) (1+ (match-beginning 2)))
  11722. (setq ncol (max (1+ (current-column))
  11723. (1+ col)
  11724. (if (> to-col 0)
  11725. to-col
  11726. (- (abs to-col) tags-l))))
  11727. (setq p (point))
  11728. (insert (make-string (- ncol (current-column)) ?\ ))
  11729. (setq ncol (current-column))
  11730. (when indent-tabs-mode (tabify p (point-at-eol)))
  11731. (org-move-to-column (min ncol col) t))
  11732. (goto-char pos))))
  11733. (defun org-set-tags-command (&optional arg just-align)
  11734. "Call the set-tags command for the current entry."
  11735. (interactive "P")
  11736. (if (org-on-heading-p)
  11737. (org-set-tags arg just-align)
  11738. (save-excursion
  11739. (org-back-to-heading t)
  11740. (org-set-tags arg just-align))))
  11741. (defun org-set-tags-to (data)
  11742. "Set the tags of the current entry to DATA, replacing the current tags.
  11743. DATA may be a tags string like :aa:bb:cc:, or a list of tags.
  11744. If DATA is nil or the empty string, any tags will be removed."
  11745. (interactive "sTags: ")
  11746. (setq data
  11747. (cond
  11748. ((eq data nil) "")
  11749. ((equal data "") "")
  11750. ((stringp data)
  11751. (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
  11752. ":"))
  11753. ((listp data)
  11754. (concat ":" (mapconcat 'identity data ":") ":"))
  11755. (t nil)))
  11756. (when data
  11757. (save-excursion
  11758. (org-back-to-heading t)
  11759. (when (looking-at org-complex-heading-regexp)
  11760. (if (match-end 5)
  11761. (progn
  11762. (goto-char (match-beginning 5))
  11763. (insert data)
  11764. (delete-region (point) (point-at-eol))
  11765. (org-set-tags nil 'align))
  11766. (goto-char (point-at-eol))
  11767. (insert " " data)
  11768. (org-set-tags nil 'align)))
  11769. (beginning-of-line 1)
  11770. (if (looking-at ".*?\\([ \t]+\\)$")
  11771. (delete-region (match-beginning 1) (match-end 1))))))
  11772. (defun org-align-all-tags ()
  11773. "Align the tags i all headings."
  11774. (interactive)
  11775. (save-excursion
  11776. (or (ignore-errors (org-back-to-heading t))
  11777. (outline-next-heading))
  11778. (if (org-on-heading-p)
  11779. (org-set-tags t)
  11780. (message "No headings"))))
  11781. (defvar org-indent-indentation-per-level)
  11782. (defun org-set-tags (&optional arg just-align)
  11783. "Set the tags for the current headline.
  11784. With prefix ARG, realign all tags in headings in the current buffer."
  11785. (interactive "P")
  11786. (let* ((re (concat "^" outline-regexp))
  11787. (current (org-get-tags-string))
  11788. (col (current-column))
  11789. (org-setting-tags t)
  11790. table current-tags inherited-tags ; computed below when needed
  11791. tags p0 c0 c1 rpl di tc level)
  11792. (if arg
  11793. (save-excursion
  11794. (goto-char (point-min))
  11795. (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
  11796. (while (re-search-forward re nil t)
  11797. (org-set-tags nil t)
  11798. (end-of-line 1)))
  11799. (message "All tags realigned to column %d" org-tags-column))
  11800. (if just-align
  11801. (setq tags current)
  11802. ;; Get a new set of tags from the user
  11803. (save-excursion
  11804. (setq table (append org-tag-persistent-alist
  11805. (or org-tag-alist (org-get-buffer-tags))
  11806. (and
  11807. org-complete-tags-always-offer-all-agenda-tags
  11808. (org-global-tags-completion-table
  11809. (org-agenda-files))))
  11810. org-last-tags-completion-table table
  11811. current-tags (org-split-string current ":")
  11812. inherited-tags (nreverse
  11813. (nthcdr (length current-tags)
  11814. (nreverse (org-get-tags-at))))
  11815. tags
  11816. (if (or (eq t org-use-fast-tag-selection)
  11817. (and org-use-fast-tag-selection
  11818. (delq nil (mapcar 'cdr table))))
  11819. (org-fast-tag-selection
  11820. current-tags inherited-tags table
  11821. (if org-fast-tag-selection-include-todo
  11822. org-todo-key-alist))
  11823. (let ((org-add-colon-after-tag-completion t))
  11824. (org-trim
  11825. (org-without-partial-completion
  11826. (org-icompleting-read "Tags: "
  11827. 'org-tags-completion-function
  11828. nil nil current 'org-tags-history)))))))
  11829. (while (string-match "[-+&]+" tags)
  11830. ;; No boolean logic, just a list
  11831. (setq tags (replace-match ":" t t tags))))
  11832. (setq tags (replace-regexp-in-string "[,]" ":" tags))
  11833. (if org-tags-sort-function
  11834. (setq tags (mapconcat 'identity
  11835. (sort (org-split-string
  11836. tags (org-re "[^[:alnum:]_@#%]+"))
  11837. org-tags-sort-function) ":")))
  11838. (if (string-match "\\`[\t ]*\\'" tags)
  11839. (setq tags "")
  11840. (unless (string-match ":$" tags) (setq tags (concat tags ":")))
  11841. (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
  11842. ;; Insert new tags at the correct column
  11843. (beginning-of-line 1)
  11844. (setq level (or (and (looking-at org-outline-regexp)
  11845. (- (match-end 0) (point) 1))
  11846. 1))
  11847. (cond
  11848. ((and (equal current "") (equal tags "")))
  11849. ((re-search-forward
  11850. (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
  11851. (point-at-eol) t)
  11852. (if (equal tags "")
  11853. (setq rpl "")
  11854. (goto-char (match-beginning 0))
  11855. (setq c0 (current-column)
  11856. ;; compute offset for the case of org-indent-mode active
  11857. di (if org-indent-mode
  11858. (* (1- org-indent-indentation-per-level) (1- level))
  11859. 0)
  11860. p0 (if (equal (char-before) ?*) (1+ (point)) (point))
  11861. tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
  11862. c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
  11863. rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
  11864. (replace-match rpl t t)
  11865. (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
  11866. tags)
  11867. (t (error "Tags alignment failed")))
  11868. (org-move-to-column col)
  11869. (unless just-align
  11870. (run-hooks 'org-after-tags-change-hook)))))
  11871. (defun org-change-tag-in-region (beg end tag off)
  11872. "Add or remove TAG for each entry in the region.
  11873. This works in the agenda, and also in an org-mode buffer."
  11874. (interactive
  11875. (list (region-beginning) (region-end)
  11876. (let ((org-last-tags-completion-table
  11877. (if (org-mode-p)
  11878. (org-get-buffer-tags)
  11879. (org-global-tags-completion-table))))
  11880. (org-icompleting-read
  11881. "Tag: " 'org-tags-completion-function nil nil nil
  11882. 'org-tags-history))
  11883. (progn
  11884. (message "[s]et or [r]emove? ")
  11885. (equal (read-char-exclusive) ?r))))
  11886. (if (fboundp 'deactivate-mark) (deactivate-mark))
  11887. (let ((agendap (equal major-mode 'org-agenda-mode))
  11888. l1 l2 m buf pos newhead (cnt 0))
  11889. (goto-char end)
  11890. (setq l2 (1- (org-current-line)))
  11891. (goto-char beg)
  11892. (setq l1 (org-current-line))
  11893. (loop for l from l1 to l2 do
  11894. (org-goto-line l)
  11895. (setq m (get-text-property (point) 'org-hd-marker))
  11896. (when (or (and (org-mode-p) (org-on-heading-p))
  11897. (and agendap m))
  11898. (setq buf (if agendap (marker-buffer m) (current-buffer))
  11899. pos (if agendap m (point)))
  11900. (with-current-buffer buf
  11901. (save-excursion
  11902. (save-restriction
  11903. (goto-char pos)
  11904. (setq cnt (1+ cnt))
  11905. (org-toggle-tag tag (if off 'off 'on))
  11906. (setq newhead (org-get-heading)))))
  11907. (and agendap (org-agenda-change-all-lines newhead m))))
  11908. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  11909. (defun org-tags-completion-function (string predicate &optional flag)
  11910. (let (s1 s2 rtn (ctable org-last-tags-completion-table)
  11911. (confirm (lambda (x) (stringp (car x)))))
  11912. (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
  11913. (setq s1 (match-string 1 string)
  11914. s2 (match-string 2 string))
  11915. (setq s1 "" s2 string))
  11916. (cond
  11917. ((eq flag nil)
  11918. ;; try completion
  11919. (setq rtn (try-completion s2 ctable confirm))
  11920. (if (stringp rtn)
  11921. (setq rtn
  11922. (concat s1 s2 (substring rtn (length s2))
  11923. (if (and org-add-colon-after-tag-completion
  11924. (assoc rtn ctable))
  11925. ":" ""))))
  11926. rtn)
  11927. ((eq flag t)
  11928. ;; all-completions
  11929. (all-completions s2 ctable confirm)
  11930. )
  11931. ((eq flag 'lambda)
  11932. ;; exact match?
  11933. (assoc s2 ctable)))
  11934. ))
  11935. (defun org-fast-tag-insert (kwd tags face &optional end)
  11936. "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
  11937. (insert (format "%-12s" (concat kwd ":"))
  11938. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  11939. (or end "")))
  11940. (defun org-fast-tag-show-exit (flag)
  11941. (save-excursion
  11942. (org-goto-line 3)
  11943. (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
  11944. (replace-match ""))
  11945. (when flag
  11946. (end-of-line 1)
  11947. (org-move-to-column (- (window-width) 19) t)
  11948. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  11949. (defun org-set-current-tags-overlay (current prefix)
  11950. (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
  11951. (if (featurep 'xemacs)
  11952. (org-overlay-display org-tags-overlay (concat prefix s)
  11953. 'secondary-selection)
  11954. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  11955. (org-overlay-display org-tags-overlay (concat prefix s)))))
  11956. (defvar org-last-tag-selection-key nil)
  11957. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  11958. "Fast tag selection with single keys.
  11959. CURRENT is the current list of tags in the headline, INHERITED is the
  11960. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  11961. possibly with grouping information. TODO-TABLE is a similar table with
  11962. TODO keywords, should these have keys assigned to them.
  11963. If the keys are nil, a-z are automatically assigned.
  11964. Returns the new tags string, or nil to not change the current settings."
  11965. (let* ((fulltable (append table todo-table))
  11966. (maxlen (apply 'max (mapcar
  11967. (lambda (x)
  11968. (if (stringp (car x)) (string-width (car x)) 0))
  11969. fulltable)))
  11970. (buf (current-buffer))
  11971. (expert (eq org-fast-tag-selection-single-key 'expert))
  11972. (buffer-tags nil)
  11973. (fwidth (+ maxlen 3 1 3))
  11974. (ncol (/ (- (window-width) 4) fwidth))
  11975. (i-face 'org-done)
  11976. (c-face 'org-todo)
  11977. tg cnt e c char c1 c2 ntable tbl rtn
  11978. ov-start ov-end ov-prefix
  11979. (exit-after-next org-fast-tag-selection-single-key)
  11980. (done-keywords org-done-keywords)
  11981. groups ingroup)
  11982. (save-excursion
  11983. (beginning-of-line 1)
  11984. (if (looking-at
  11985. (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  11986. (setq ov-start (match-beginning 1)
  11987. ov-end (match-end 1)
  11988. ov-prefix "")
  11989. (setq ov-start (1- (point-at-eol))
  11990. ov-end (1+ ov-start))
  11991. (skip-chars-forward "^\n\r")
  11992. (setq ov-prefix
  11993. (concat
  11994. (buffer-substring (1- (point)) (point))
  11995. (if (> (current-column) org-tags-column)
  11996. " "
  11997. (make-string (- org-tags-column (current-column)) ?\ ))))))
  11998. (move-overlay org-tags-overlay ov-start ov-end)
  11999. (save-window-excursion
  12000. (if expert
  12001. (set-buffer (get-buffer-create " *Org tags*"))
  12002. (delete-other-windows)
  12003. (split-window-vertically)
  12004. (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
  12005. (erase-buffer)
  12006. (org-set-local 'org-done-keywords done-keywords)
  12007. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  12008. (org-fast-tag-insert "Current" current c-face "\n\n")
  12009. (org-fast-tag-show-exit exit-after-next)
  12010. (org-set-current-tags-overlay current ov-prefix)
  12011. (setq tbl fulltable char ?a cnt 0)
  12012. (while (setq e (pop tbl))
  12013. (cond
  12014. ((equal (car e) :startgroup)
  12015. (push '() groups) (setq ingroup t)
  12016. (when (not (= cnt 0))
  12017. (setq cnt 0)
  12018. (insert "\n"))
  12019. (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
  12020. ((equal (car e) :endgroup)
  12021. (setq ingroup nil cnt 0)
  12022. (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
  12023. ((equal e '(:newline))
  12024. (when (not (= cnt 0))
  12025. (setq cnt 0)
  12026. (insert "\n")
  12027. (setq e (car tbl))
  12028. (while (equal (car tbl) '(:newline))
  12029. (insert "\n")
  12030. (setq tbl (cdr tbl)))))
  12031. (t
  12032. (setq tg (copy-sequence (car e)) c2 nil)
  12033. (if (cdr e)
  12034. (setq c (cdr e))
  12035. ;; automatically assign a character.
  12036. (setq c1 (string-to-char
  12037. (downcase (substring
  12038. tg (if (= (string-to-char tg) ?@) 1 0)))))
  12039. (if (or (rassoc c1 ntable) (rassoc c1 table))
  12040. (while (or (rassoc char ntable) (rassoc char table))
  12041. (setq char (1+ char)))
  12042. (setq c2 c1))
  12043. (setq c (or c2 char)))
  12044. (if ingroup (push tg (car groups)))
  12045. (setq tg (org-add-props tg nil 'face
  12046. (cond
  12047. ((not (assoc tg table))
  12048. (org-get-todo-face tg))
  12049. ((member tg current) c-face)
  12050. ((member tg inherited) i-face)
  12051. (t nil))))
  12052. (if (and (= cnt 0) (not ingroup)) (insert " "))
  12053. (insert "[" c "] " tg (make-string
  12054. (- fwidth 4 (length tg)) ?\ ))
  12055. (push (cons tg c) ntable)
  12056. (when (= (setq cnt (1+ cnt)) ncol)
  12057. (insert "\n")
  12058. (if ingroup (insert " "))
  12059. (setq cnt 0)))))
  12060. (setq ntable (nreverse ntable))
  12061. (insert "\n")
  12062. (goto-char (point-min))
  12063. (if (not expert) (org-fit-window-to-buffer))
  12064. (setq rtn
  12065. (catch 'exit
  12066. (while t
  12067. (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
  12068. (if (not groups) "no " "")
  12069. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  12070. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  12071. (setq org-last-tag-selection-key c)
  12072. (cond
  12073. ((= c ?\r) (throw 'exit t))
  12074. ((= c ?!)
  12075. (setq groups (not groups))
  12076. (goto-char (point-min))
  12077. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  12078. ((= c ?\C-c)
  12079. (if (not expert)
  12080. (org-fast-tag-show-exit
  12081. (setq exit-after-next (not exit-after-next)))
  12082. (setq expert nil)
  12083. (delete-other-windows)
  12084. (set-window-buffer (split-window-vertically) " *Org tags*")
  12085. (org-switch-to-buffer-other-window " *Org tags*")
  12086. (org-fit-window-to-buffer)))
  12087. ((or (= c ?\C-g)
  12088. (and (= c ?q) (not (rassoc c ntable))))
  12089. (org-detach-overlay org-tags-overlay)
  12090. (setq quit-flag t))
  12091. ((= c ?\ )
  12092. (setq current nil)
  12093. (if exit-after-next (setq exit-after-next 'now)))
  12094. ((= c ?\t)
  12095. (condition-case nil
  12096. (setq tg (org-icompleting-read
  12097. "Tag: "
  12098. (or buffer-tags
  12099. (with-current-buffer buf
  12100. (org-get-buffer-tags)))))
  12101. (quit (setq tg "")))
  12102. (when (string-match "\\S-" tg)
  12103. (add-to-list 'buffer-tags (list tg))
  12104. (if (member tg current)
  12105. (setq current (delete tg current))
  12106. (push tg current)))
  12107. (if exit-after-next (setq exit-after-next 'now)))
  12108. ((setq e (rassoc c todo-table) tg (car e))
  12109. (with-current-buffer buf
  12110. (save-excursion (org-todo tg)))
  12111. (if exit-after-next (setq exit-after-next 'now)))
  12112. ((setq e (rassoc c ntable) tg (car e))
  12113. (if (member tg current)
  12114. (setq current (delete tg current))
  12115. (loop for g in groups do
  12116. (if (member tg g)
  12117. (mapc (lambda (x)
  12118. (setq current (delete x current)))
  12119. g)))
  12120. (push tg current))
  12121. (if exit-after-next (setq exit-after-next 'now))))
  12122. ;; Create a sorted list
  12123. (setq current
  12124. (sort current
  12125. (lambda (a b)
  12126. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  12127. (if (eq exit-after-next 'now) (throw 'exit t))
  12128. (goto-char (point-min))
  12129. (beginning-of-line 2)
  12130. (delete-region (point) (point-at-eol))
  12131. (org-fast-tag-insert "Current" current c-face)
  12132. (org-set-current-tags-overlay current ov-prefix)
  12133. (while (re-search-forward
  12134. (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
  12135. (setq tg (match-string 1))
  12136. (add-text-properties
  12137. (match-beginning 1) (match-end 1)
  12138. (list 'face
  12139. (cond
  12140. ((member tg current) c-face)
  12141. ((member tg inherited) i-face)
  12142. (t (get-text-property (match-beginning 1) 'face))))))
  12143. (goto-char (point-min)))))
  12144. (org-detach-overlay org-tags-overlay)
  12145. (if rtn
  12146. (mapconcat 'identity current ":")
  12147. nil))))
  12148. (defun org-get-tags-string ()
  12149. "Get the TAGS string in the current headline."
  12150. (unless (org-on-heading-p t)
  12151. (error "Not on a heading"))
  12152. (save-excursion
  12153. (beginning-of-line 1)
  12154. (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12155. (org-match-string-no-properties 1)
  12156. "")))
  12157. (defun org-get-tags ()
  12158. "Get the list of tags specified in the current headline."
  12159. (org-split-string (org-get-tags-string) ":"))
  12160. (defun org-get-buffer-tags ()
  12161. "Get a table of all tags used in the buffer, for completion."
  12162. (let (tags)
  12163. (save-excursion
  12164. (goto-char (point-min))
  12165. (while (re-search-forward
  12166. (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
  12167. (when (equal (char-after (point-at-bol 0)) ?*)
  12168. (mapc (lambda (x) (add-to-list 'tags x))
  12169. (org-split-string (org-match-string-no-properties 1) ":")))))
  12170. (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
  12171. (mapcar 'list tags)))
  12172. ;;;; The mapping API
  12173. ;;;###autoload
  12174. (defun org-map-entries (func &optional match scope &rest skip)
  12175. "Call FUNC at each headline selected by MATCH in SCOPE.
  12176. FUNC is a function or a lisp form. The function will be called without
  12177. arguments, with the cursor positioned at the beginning of the headline.
  12178. The return values of all calls to the function will be collected and
  12179. returned as a list.
  12180. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  12181. does not need to preserve point. After evaluation, the cursor will be
  12182. moved to the end of the line (presumably of the headline of the
  12183. processed entry) and search continues from there. Under some
  12184. circumstances, this may not produce the wanted results. For example,
  12185. if you have removed (e.g. archived) the current (sub)tree it could
  12186. mean that the next entry will be skipped entirely. In such cases, you
  12187. can specify the position from where search should continue by making
  12188. FUNC set the variable `org-map-continue-from' to the desired buffer
  12189. position.
  12190. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  12191. Only headlines that are matched by this query will be considered during
  12192. the iteration. When MATCH is nil or t, all headlines will be
  12193. visited by the iteration.
  12194. SCOPE determines the scope of this command. It can be any of:
  12195. nil The current buffer, respecting the restriction if any
  12196. tree The subtree started with the entry at point
  12197. file The current buffer, without restriction
  12198. file-with-archives
  12199. The current buffer, and any archives associated with it
  12200. agenda All agenda files
  12201. agenda-with-archives
  12202. All agenda files with any archive files associated with them
  12203. \(file1 file2 ...)
  12204. If this is a list, all files in the list will be scanned
  12205. The remaining args are treated as settings for the skipping facilities of
  12206. the scanner. The following items can be given here:
  12207. archive skip trees with the archive tag.
  12208. comment skip trees with the COMMENT keyword
  12209. function or Emacs Lisp form:
  12210. will be used as value for `org-agenda-skip-function', so whenever
  12211. the function returns t, FUNC will not be called for that
  12212. entry and search will continue from the point where the
  12213. function leaves it.
  12214. If your function needs to retrieve the tags including inherited tags
  12215. at the *current* entry, you can use the value of the variable
  12216. `org-scanner-tags' which will be much faster than getting the value
  12217. with `org-get-tags-at'. If your function gets properties with
  12218. `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
  12219. to t around the call to `org-entry-properties' to get the same speedup.
  12220. Note that if your function moves around to retrieve tags and properties at
  12221. a *different* entry, you cannot use these techniques."
  12222. (let* ((org-agenda-archives-mode nil) ; just to make sure
  12223. (org-agenda-skip-archived-trees (memq 'archive skip))
  12224. (org-agenda-skip-comment-trees (memq 'comment skip))
  12225. (org-agenda-skip-function
  12226. (car (org-delete-all '(comment archive) skip)))
  12227. (org-tags-match-list-sublevels t)
  12228. matcher file res
  12229. org-todo-keywords-for-agenda
  12230. org-done-keywords-for-agenda
  12231. org-todo-keyword-alist-for-agenda
  12232. org-drawers-for-agenda
  12233. org-tag-alist-for-agenda)
  12234. (cond
  12235. ((eq match t) (setq matcher t))
  12236. ((eq match nil) (setq matcher t))
  12237. (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
  12238. (save-excursion
  12239. (save-restriction
  12240. (when (eq scope 'tree)
  12241. (org-back-to-heading t)
  12242. (org-narrow-to-subtree)
  12243. (setq scope nil))
  12244. (if (not scope)
  12245. (progn
  12246. (org-prepare-agenda-buffers
  12247. (list (buffer-file-name (current-buffer))))
  12248. (setq res (org-scan-tags func matcher)))
  12249. ;; Get the right scope
  12250. (cond
  12251. ((and scope (listp scope) (symbolp (car scope)))
  12252. (setq scope (eval scope)))
  12253. ((eq scope 'agenda)
  12254. (setq scope (org-agenda-files t)))
  12255. ((eq scope 'agenda-with-archives)
  12256. (setq scope (org-agenda-files t))
  12257. (setq scope (org-add-archive-files scope)))
  12258. ((eq scope 'file)
  12259. (setq scope (list (buffer-file-name))))
  12260. ((eq scope 'file-with-archives)
  12261. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  12262. (org-prepare-agenda-buffers scope)
  12263. (while (setq file (pop scope))
  12264. (with-current-buffer (org-find-base-buffer-visiting file)
  12265. (save-excursion
  12266. (save-restriction
  12267. (widen)
  12268. (goto-char (point-min))
  12269. (setq res (append res (org-scan-tags func matcher))))))))))
  12270. res))
  12271. ;;;; Properties
  12272. ;;; Setting and retrieving properties
  12273. (defconst org-special-properties
  12274. '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
  12275. "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
  12276. "The special properties valid in Org-mode.
  12277. These are properties that are not defined in the property drawer,
  12278. but in some other way.")
  12279. (defconst org-default-properties
  12280. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
  12281. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  12282. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  12283. "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
  12284. "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
  12285. "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
  12286. "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
  12287. "Some properties that are used by Org-mode for various purposes.
  12288. Being in this list makes sure that they are offered for completion.")
  12289. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  12290. "Regular expression matching the first line of a property drawer.")
  12291. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  12292. "Regular expression matching the last line of a property drawer.")
  12293. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  12294. "Regular expression matching the first line of a property drawer.")
  12295. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  12296. "Regular expression matching the first line of a property drawer.")
  12297. (defconst org-property-drawer-re
  12298. (concat "\\(" org-property-start-re "\\)[^\000]*\\("
  12299. org-property-end-re "\\)\n?")
  12300. "Matches an entire property drawer.")
  12301. (defconst org-clock-drawer-re
  12302. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
  12303. org-property-end-re "\\)\n?")
  12304. "Matches an entire clock drawer.")
  12305. (defun org-property-action ()
  12306. "Do an action on properties."
  12307. (interactive)
  12308. (let (c)
  12309. (org-at-property-p)
  12310. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  12311. (setq c (read-char-exclusive))
  12312. (cond
  12313. ((equal c ?s)
  12314. (call-interactively 'org-set-property))
  12315. ((equal c ?d)
  12316. (call-interactively 'org-delete-property))
  12317. ((equal c ?D)
  12318. (call-interactively 'org-delete-property-globally))
  12319. ((equal c ?c)
  12320. (call-interactively 'org-compute-property-at-point))
  12321. (t (error "No such property action %c" c)))))
  12322. (defun org-set-effort (&optional value)
  12323. "Set the effort property of the current entry.
  12324. With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
  12325. allowed value."
  12326. (interactive "P")
  12327. (if (equal value 0) (setq value 10))
  12328. (let* ((completion-ignore-case t)
  12329. (prop org-effort-property)
  12330. (cur (org-entry-get nil prop))
  12331. (allowed (org-property-get-allowed-values nil prop 'table))
  12332. (existing (mapcar 'list (org-property-values prop)))
  12333. rpl
  12334. (val (cond
  12335. ((stringp value) value)
  12336. ((and allowed (integerp value))
  12337. (or (car (nth (1- value) allowed))
  12338. (car (org-last allowed))))
  12339. (allowed
  12340. (message "Select 1-9,0, [RET%s]: %s"
  12341. (if cur (concat "=" cur) "")
  12342. (mapconcat 'car allowed " "))
  12343. (setq rpl (read-char-exclusive))
  12344. (if (equal rpl ?\r)
  12345. cur
  12346. (setq rpl (- rpl ?0))
  12347. (if (equal rpl 0) (setq rpl 10))
  12348. (if (and (> rpl 0) (<= rpl (length allowed)))
  12349. (car (nth (1- rpl) allowed))
  12350. (org-completing-read "Effort: " allowed nil))))
  12351. (t
  12352. (let (org-completion-use-ido org-completion-use-iswitchb)
  12353. (org-completing-read
  12354. (concat "Effort " (if (and cur (string-match "\\S-" cur))
  12355. (concat "[" cur "]") "")
  12356. ": ")
  12357. existing nil nil "" nil cur))))))
  12358. (unless (equal (org-entry-get nil prop) val)
  12359. (org-entry-put nil prop val))
  12360. (message "%s is now %s" prop val)))
  12361. (defun org-at-property-p ()
  12362. "Is cursor inside a property drawer?"
  12363. (save-excursion
  12364. (beginning-of-line 1)
  12365. (when (looking-at (org-re "^[ \t]*\\(:\\([[:alpha:]][[:alnum:]_-]*\\):\\)[ \t]*\\(.*\\)"))
  12366. (save-match-data ;; Used by calling procedures
  12367. (let ((p (point))
  12368. (range (unless (org-before-first-heading-p)
  12369. (org-get-property-block))))
  12370. (and range (<= (car range) p) (< p (cdr range))))))))
  12371. (defun org-get-property-block (&optional beg end force)
  12372. "Return the (beg . end) range of the body of the property drawer.
  12373. BEG and END can be beginning and end of subtree, if not given
  12374. they will be found.
  12375. If the drawer does not exist and FORCE is non-nil, create the drawer."
  12376. (catch 'exit
  12377. (save-excursion
  12378. (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
  12379. (end (or end (progn (outline-next-heading) (point)))))
  12380. (goto-char beg)
  12381. (if (re-search-forward org-property-start-re end t)
  12382. (setq beg (1+ (match-end 0)))
  12383. (if force
  12384. (save-excursion
  12385. (org-insert-property-drawer)
  12386. (setq end (progn (outline-next-heading) (point))))
  12387. (throw 'exit nil))
  12388. (goto-char beg)
  12389. (if (re-search-forward org-property-start-re end t)
  12390. (setq beg (1+ (match-end 0)))))
  12391. (if (re-search-forward org-property-end-re end t)
  12392. (setq end (match-beginning 0))
  12393. (or force (throw 'exit nil))
  12394. (goto-char beg)
  12395. (setq end beg)
  12396. (org-indent-line-function)
  12397. (insert ":END:\n"))
  12398. (cons beg end)))))
  12399. (defun org-entry-properties (&optional pom which specific)
  12400. "Get all properties of the entry at point-or-marker POM.
  12401. This includes the TODO keyword, the tags, time strings for deadline,
  12402. scheduled, and clocking, and any additional properties defined in the
  12403. entry. The return value is an alist, keys may occur multiple times
  12404. if the property key was used several times.
  12405. POM may also be nil, in which case the current entry is used.
  12406. If WHICH is nil or `all', get all properties. If WHICH is
  12407. `special' or `standard', only get that subclass. If WHICH
  12408. is a string only get exactly this property. SPECIFIC can be a string, the
  12409. specific property we are interested in. Specifying it can speed
  12410. things up because then unnecessary parsing is avoided."
  12411. (setq which (or which 'all))
  12412. (org-with-point-at pom
  12413. (let ((clockstr (substring org-clock-string 0 -1))
  12414. (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
  12415. (case-fold-search nil)
  12416. beg end range props sum-props key key1 value string clocksum)
  12417. (save-excursion
  12418. (when (condition-case nil
  12419. (and (org-mode-p) (org-back-to-heading t))
  12420. (error nil))
  12421. (setq beg (point))
  12422. (setq sum-props (get-text-property (point) 'org-summaries))
  12423. (setq clocksum (get-text-property (point) :org-clock-minutes))
  12424. (outline-next-heading)
  12425. (setq end (point))
  12426. (when (memq which '(all special))
  12427. ;; Get the special properties, like TODO and tags
  12428. (goto-char beg)
  12429. (when (and (or (not specific) (string= specific "TODO"))
  12430. (looking-at org-todo-line-regexp) (match-end 2))
  12431. (push (cons "TODO" (org-match-string-no-properties 2)) props))
  12432. (when (and (or (not specific) (string= specific "PRIORITY"))
  12433. (looking-at org-priority-regexp))
  12434. (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
  12435. (when (or (not specific) (string= specific "FILE"))
  12436. (push (cons "FILE" buffer-file-name) props))
  12437. (when (and (or (not specific) (string= specific "TAGS"))
  12438. (setq value (org-get-tags-string))
  12439. (string-match "\\S-" value))
  12440. (push (cons "TAGS" value) props))
  12441. (when (and (or (not specific) (string= specific "ALLTAGS"))
  12442. (setq value (org-get-tags-at)))
  12443. (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
  12444. ":"))
  12445. props))
  12446. (when (or (not specific) (string= specific "BLOCKED"))
  12447. (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
  12448. (when (or (not specific)
  12449. (member specific
  12450. '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
  12451. "TIMESTAMP" "TIMESTAMP_IA")))
  12452. (catch 'match
  12453. (while (re-search-forward org-maybe-keyword-time-regexp end t)
  12454. (setq key (if (match-end 1)
  12455. (substring (org-match-string-no-properties 1)
  12456. 0 -1))
  12457. string (if (equal key clockstr)
  12458. (org-no-properties
  12459. (org-trim
  12460. (buffer-substring
  12461. (match-beginning 3) (goto-char
  12462. (point-at-eol)))))
  12463. (substring (org-match-string-no-properties 3)
  12464. 1 -1)))
  12465. ;; Get the correct property name from the key. This is
  12466. ;; necessary if the user has configured time keywords.
  12467. (setq key1 (concat key ":"))
  12468. (cond
  12469. ((not key)
  12470. (setq key
  12471. (if (= (char-after (match-beginning 3)) ?\[)
  12472. "TIMESTAMP_IA" "TIMESTAMP")))
  12473. ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
  12474. ((equal key1 org-deadline-string) (setq key "DEADLINE"))
  12475. ((equal key1 org-closed-string) (setq key "CLOSED"))
  12476. ((equal key1 org-clock-string) (setq key "CLOCK")))
  12477. (if (and specific (equal key specific) (not (equal key "CLOCK")))
  12478. (progn
  12479. (push (cons key string) props)
  12480. ;; no need to search further if match is found
  12481. (throw 'match t))
  12482. (when (or (equal key "CLOCK") (not (assoc key props)))
  12483. (push (cons key string) props))))))
  12484. )
  12485. (when (memq which '(all standard))
  12486. ;; Get the standard properties, like :PROP: ...
  12487. (setq range (org-get-property-block beg end))
  12488. (when range
  12489. (goto-char (car range))
  12490. (while (re-search-forward
  12491. (org-re "^[ \t]*:\\([[:alpha:]][[:alnum:]_-]*\\):[ \t]*\\(\\S-.*\\)?")
  12492. (cdr range) t)
  12493. (setq key (org-match-string-no-properties 1)
  12494. value (org-trim (or (org-match-string-no-properties 2) "")))
  12495. (unless (member key excluded)
  12496. (push (cons key (or value "")) props)))))
  12497. (if clocksum
  12498. (push (cons "CLOCKSUM"
  12499. (org-columns-number-to-string (/ (float clocksum) 60.)
  12500. 'add_times))
  12501. props))
  12502. (unless (assoc "CATEGORY" props)
  12503. (push (cons "CATEGORY" (org-get-category)) props))
  12504. (append sum-props (nreverse props)))))))
  12505. (defun org-entry-get (pom property &optional inherit literal-nil)
  12506. "Get value of PROPERTY for entry at point-or-marker POM.
  12507. If INHERIT is non-nil and the entry does not have the property,
  12508. then also check higher levels of the hierarchy.
  12509. If INHERIT is the symbol `selective', use inheritance only if the setting
  12510. in `org-use-property-inheritance' selects PROPERTY for inheritance.
  12511. If the property is present but empty, the return value is the empty string.
  12512. If the property is not present at all, nil is returned.
  12513. If LITERAL-NIL is set, return the string value \"nil\" as a string,
  12514. do not interpret it as the list atom nil. This is used for inheritance
  12515. when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
  12516. (org-with-point-at pom
  12517. (if (and inherit (if (eq inherit 'selective)
  12518. (org-property-inherit-p property)
  12519. t))
  12520. (org-entry-get-with-inheritance property literal-nil)
  12521. (if (member property org-special-properties)
  12522. ;; We need a special property. Use `org-entry-properties' to
  12523. ;; retrieve it, but specify the wanted property
  12524. (cdr (assoc property (org-entry-properties nil 'special property)))
  12525. (let ((range (unless (org-before-first-heading-p)
  12526. (org-get-property-block))))
  12527. (if (and range
  12528. (goto-char (car range))
  12529. (re-search-forward
  12530. (org-re-property property)
  12531. (cdr range) t))
  12532. ;; Found the property, return it.
  12533. (if (match-end 1)
  12534. (if literal-nil
  12535. (org-match-string-no-properties 1)
  12536. (org-not-nil (org-match-string-no-properties 1)))
  12537. "")))))))
  12538. (defun org-property-or-variable-value (var &optional inherit)
  12539. "Check if there is a property fixing the value of VAR.
  12540. If yes, return this value. If not, return the current value of the variable."
  12541. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  12542. (if (and prop (stringp prop) (string-match "\\S-" prop))
  12543. (read prop)
  12544. (symbol-value var))))
  12545. (defun org-entry-delete (pom property)
  12546. "Delete the property PROPERTY from entry at point-or-marker POM."
  12547. (org-with-point-at pom
  12548. (if (member property org-special-properties)
  12549. nil ; cannot delete these properties.
  12550. (let ((range (org-get-property-block)))
  12551. (if (and range
  12552. (goto-char (car range))
  12553. (re-search-forward
  12554. (org-re-property property)
  12555. (cdr range) t))
  12556. (progn
  12557. (delete-region (match-beginning 0) (1+ (point-at-eol)))
  12558. t)
  12559. nil)))))
  12560. ;; Multi-values properties are properties that contain multiple values
  12561. ;; These values are assumed to be single words, separated by whitespace.
  12562. (defun org-entry-add-to-multivalued-property (pom property value)
  12563. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  12564. (let* ((old (org-entry-get pom property))
  12565. (values (and old (org-split-string old "[ \t]"))))
  12566. (setq value (org-entry-protect-space value))
  12567. (unless (member value values)
  12568. (setq values (cons value values))
  12569. (org-entry-put pom property
  12570. (mapconcat 'identity values " ")))))
  12571. (defun org-entry-remove-from-multivalued-property (pom property value)
  12572. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  12573. (let* ((old (org-entry-get pom property))
  12574. (values (and old (org-split-string old "[ \t]"))))
  12575. (setq value (org-entry-protect-space value))
  12576. (when (member value values)
  12577. (setq values (delete value values))
  12578. (org-entry-put pom property
  12579. (mapconcat 'identity values " ")))))
  12580. (defun org-entry-member-in-multivalued-property (pom property value)
  12581. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  12582. (let* ((old (org-entry-get pom property))
  12583. (values (and old (org-split-string old "[ \t]"))))
  12584. (setq value (org-entry-protect-space value))
  12585. (member value values)))
  12586. (defun org-entry-get-multivalued-property (pom property)
  12587. "Return a list of values in a multivalued property."
  12588. (let* ((value (org-entry-get pom property))
  12589. (values (and value (org-split-string value "[ \t]"))))
  12590. (mapcar 'org-entry-restore-space values)))
  12591. (defun org-entry-put-multivalued-property (pom property &rest values)
  12592. "Set multivalued PROPERTY at point-or-marker POM to VALUES.
  12593. VALUES should be a list of strings. Spaces will be protected."
  12594. (org-entry-put pom property
  12595. (mapconcat 'org-entry-protect-space values " "))
  12596. (let* ((value (org-entry-get pom property))
  12597. (values (and value (org-split-string value "[ \t]"))))
  12598. (mapcar 'org-entry-restore-space values)))
  12599. (defun org-entry-protect-space (s)
  12600. "Protect spaces and newline in string S."
  12601. (while (string-match " " s)
  12602. (setq s (replace-match "%20" t t s)))
  12603. (while (string-match "\n" s)
  12604. (setq s (replace-match "%0A" t t s)))
  12605. s)
  12606. (defun org-entry-restore-space (s)
  12607. "Restore spaces and newline in string S."
  12608. (while (string-match "%20" s)
  12609. (setq s (replace-match " " t t s)))
  12610. (while (string-match "%0A" s)
  12611. (setq s (replace-match "\n" t t s)))
  12612. s)
  12613. (defvar org-entry-property-inherited-from (make-marker)
  12614. "Marker pointing to the entry from where a property was inherited.
  12615. Each call to `org-entry-get-with-inheritance' will set this marker to the
  12616. location of the entry where the inheritance search matched. If there was
  12617. no match, the marker will point nowhere.
  12618. Note that also `org-entry-get' calls this function, if the INHERIT flag
  12619. is set.")
  12620. (defun org-entry-get-with-inheritance (property &optional literal-nil)
  12621. "Get entry property, and search higher levels if not present.
  12622. The search will stop at the first ancestor which has the property defined.
  12623. If the value found is \"nil\", return nil to show that the property
  12624. should be considered as undefined (this is the meaning of nil here).
  12625. However, if LITERAL-NIL is set, return the string value \"nil\" instead."
  12626. (move-marker org-entry-property-inherited-from nil)
  12627. (let (tmp)
  12628. (unless (org-before-first-heading-p)
  12629. (save-excursion
  12630. (save-restriction
  12631. (widen)
  12632. (catch 'ex
  12633. (while t
  12634. (when (setq tmp (org-entry-get nil property nil 'literal-nil))
  12635. (org-back-to-heading t)
  12636. (move-marker org-entry-property-inherited-from (point))
  12637. (throw 'ex tmp))
  12638. (or (org-up-heading-safe) (throw 'ex nil)))))))
  12639. (setq tmp (or tmp
  12640. (cdr (assoc property org-file-properties))
  12641. (cdr (assoc property org-global-properties))
  12642. (cdr (assoc property org-global-properties-fixed))))
  12643. (if literal-nil tmp (org-not-nil tmp))))
  12644. (defvar org-property-changed-functions nil
  12645. "Hook called when the value of a property has changed.
  12646. Each hook function should accept two arguments, the name of the property
  12647. and the new value.")
  12648. (defun org-entry-put (pom property value)
  12649. "Set PROPERTY to VALUE for entry at point-or-marker POM."
  12650. (org-with-point-at pom
  12651. (org-back-to-heading t)
  12652. (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
  12653. range)
  12654. (cond
  12655. ((equal property "TODO")
  12656. (when (and (stringp value) (string-match "\\S-" value)
  12657. (not (member value org-todo-keywords-1)))
  12658. (error "\"%s\" is not a valid TODO state" value))
  12659. (if (or (not value)
  12660. (not (string-match "\\S-" value)))
  12661. (setq value 'none))
  12662. (org-todo value)
  12663. (org-set-tags nil 'align))
  12664. ((equal property "PRIORITY")
  12665. (org-priority (if (and value (stringp value) (string-match "\\S-" value))
  12666. (string-to-char value) ?\ ))
  12667. (org-set-tags nil 'align))
  12668. ((equal property "SCHEDULED")
  12669. (if (re-search-forward org-scheduled-time-regexp end t)
  12670. (cond
  12671. ((eq value 'earlier) (org-timestamp-change -1 'day))
  12672. ((eq value 'later) (org-timestamp-change 1 'day))
  12673. (t (call-interactively 'org-schedule)))
  12674. (call-interactively 'org-schedule)))
  12675. ((equal property "DEADLINE")
  12676. (if (re-search-forward org-deadline-time-regexp end t)
  12677. (cond
  12678. ((eq value 'earlier) (org-timestamp-change -1 'day))
  12679. ((eq value 'later) (org-timestamp-change 1 'day))
  12680. (t (call-interactively 'org-deadline)))
  12681. (call-interactively 'org-deadline)))
  12682. ((member property org-special-properties)
  12683. (error "The %s property can not yet be set with `org-entry-put'"
  12684. property))
  12685. (t ; a non-special property
  12686. (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
  12687. (setq range (org-get-property-block beg end 'force))
  12688. (goto-char (car range))
  12689. (if (re-search-forward
  12690. (org-re-property property) (cdr range) t)
  12691. (progn
  12692. (delete-region (match-beginning 1) (match-end 1))
  12693. (goto-char (match-beginning 1)))
  12694. (goto-char (cdr range))
  12695. (insert "\n")
  12696. (backward-char 1)
  12697. (org-indent-line-function)
  12698. (insert ":" property ":"))
  12699. (and value (insert " " value))
  12700. (org-indent-line-function)))))
  12701. (run-hook-with-args 'org-property-changed-functions property value)))
  12702. (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
  12703. "Get all property keys in the current buffer.
  12704. With INCLUDE-SPECIALS, also list the special properties that reflect things
  12705. like tags and TODO state.
  12706. With INCLUDE-DEFAULTS, also include properties that has special meaning
  12707. internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
  12708. and others.
  12709. With INCLUDE-COLUMNS, also include property names given in COLUMN
  12710. formats in the current buffer."
  12711. (let (rtn range cfmt s p)
  12712. (save-excursion
  12713. (save-restriction
  12714. (widen)
  12715. (goto-char (point-min))
  12716. (while (re-search-forward org-property-start-re nil t)
  12717. (setq range (org-get-property-block))
  12718. (goto-char (car range))
  12719. (while (re-search-forward
  12720. (org-re "^[ \t]*:\\([-[:alnum:]_]+\\):")
  12721. (cdr range) t)
  12722. (add-to-list 'rtn (org-match-string-no-properties 1)))
  12723. (outline-next-heading))))
  12724. (when include-specials
  12725. (setq rtn (append org-special-properties rtn)))
  12726. (when include-defaults
  12727. (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
  12728. (add-to-list 'rtn org-effort-property))
  12729. (when include-columns
  12730. (save-excursion
  12731. (save-restriction
  12732. (widen)
  12733. (goto-char (point-min))
  12734. (while (re-search-forward
  12735. "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
  12736. nil t)
  12737. (setq cfmt (match-string 2) s 0)
  12738. (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
  12739. cfmt s)
  12740. (setq s (match-end 0)
  12741. p (match-string 1 cfmt))
  12742. (unless (or (equal p "ITEM")
  12743. (member p org-special-properties))
  12744. (add-to-list 'rtn (match-string 1 cfmt))))))))
  12745. (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
  12746. (defsubst org-re-property (property)
  12747. "Return a regexp matching PROPERTY.
  12748. Match group 1 will be set to the value "
  12749. (concat "^[ \t]*:" (regexp-quote property) ":[ \t]*\\(\\S-.*\\)"))
  12750. (defun org-property-values (key)
  12751. "Return a list of all values of property KEY in the current buffer."
  12752. (save-excursion
  12753. (save-restriction
  12754. (widen)
  12755. (goto-char (point-min))
  12756. (let ((re (org-re-property key))
  12757. values)
  12758. (while (re-search-forward re nil t)
  12759. (add-to-list 'values (org-trim (match-string 1))))
  12760. (delete "" values)))))
  12761. (defun org-insert-property-drawer ()
  12762. "Insert a property drawer into the current entry."
  12763. (interactive)
  12764. (org-back-to-heading t)
  12765. (looking-at outline-regexp)
  12766. (let ((indent (if org-adapt-indentation
  12767. (- (match-end 0)(match-beginning 0))
  12768. 0))
  12769. (beg (point))
  12770. (re (concat "^[ \t]*" org-keyword-time-regexp))
  12771. end hiddenp)
  12772. (outline-next-heading)
  12773. (setq end (point))
  12774. (goto-char beg)
  12775. (while (re-search-forward re end t))
  12776. (setq hiddenp (outline-invisible-p))
  12777. (end-of-line 1)
  12778. (and (equal (char-after) ?\n) (forward-char 1))
  12779. (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
  12780. (if (member (match-string 1) '("CLOCK:" ":END:"))
  12781. ;; just skip this line
  12782. (beginning-of-line 2)
  12783. ;; Drawer start, find the end
  12784. (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
  12785. (beginning-of-line 1)))
  12786. (org-skip-over-state-notes)
  12787. (skip-chars-backward " \t\n\r")
  12788. (if (eq (char-before) ?*) (forward-char 1))
  12789. (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
  12790. (beginning-of-line 0)
  12791. (org-indent-to-column indent)
  12792. (beginning-of-line 2)
  12793. (org-indent-to-column indent)
  12794. (beginning-of-line 0)
  12795. (if hiddenp
  12796. (save-excursion
  12797. (org-back-to-heading t)
  12798. (hide-entry))
  12799. (org-flag-drawer t))))
  12800. (defvar org-property-set-functions-alist nil
  12801. "Property set function alist.
  12802. Each entry should have the following format:
  12803. (PROPERTY . READ-FUNCTION)
  12804. The read function will be called with the same argument as
  12805. `org-completing-read'.")
  12806. (defun org-set-property-function (property)
  12807. "Get the function that should be used to set PROPERTY.
  12808. This is computed according to `org-property-set-functions-alist'."
  12809. (or (cdr (assoc property org-property-set-functions-alist))
  12810. 'org-completing-read))
  12811. (defun org-read-property-value (property)
  12812. "Read PROPERTY value from user."
  12813. (let* ((completion-ignore-case t)
  12814. (allowed (org-property-get-allowed-values nil property 'table))
  12815. (cur (org-entry-get nil property))
  12816. (prompt (concat property " value"
  12817. (if (and cur (string-match "\\S-" cur))
  12818. (concat " [" cur "]") "") ": "))
  12819. (set-function (org-set-property-function property))
  12820. (val (if allowed
  12821. (funcall set-function prompt allowed nil
  12822. (not (get-text-property 0 'org-unrestricted
  12823. (caar allowed))))
  12824. (let (org-completion-use-ido org-completion-use-iswitchb)
  12825. (funcall set-function prompt
  12826. (mapcar 'list (org-property-values property))
  12827. nil nil "" nil cur)))))
  12828. (if (equal val "")
  12829. cur
  12830. val)))
  12831. (defun org-read-property-name ()
  12832. "Read a property name."
  12833. (let* ((completion-ignore-case t)
  12834. (keys (org-buffer-property-keys nil t t))
  12835. (property (org-icompleting-read "Property: " (mapcar 'list keys))))
  12836. (if (member property keys)
  12837. property
  12838. (or (cdr (assoc (downcase property)
  12839. (mapcar (lambda (x) (cons (downcase x) x))
  12840. keys)))
  12841. property))))
  12842. (defun org-set-property (property value)
  12843. "In the current entry, set PROPERTY to VALUE.
  12844. When called interactively, this will prompt for a property name, offering
  12845. completion on existing and default properties. And then it will prompt
  12846. for a value, offering completion either on allowed values (via an inherited
  12847. xxx_ALL property) or on existing values in other instances of this property
  12848. in the current file."
  12849. (interactive (list nil nil))
  12850. (let* ((property (or property (org-read-property-name)))
  12851. (value (or value (org-read-property-value property))))
  12852. (unless (equal (org-entry-get nil property) value)
  12853. (org-entry-put nil property value))))
  12854. (defun org-delete-property (property)
  12855. "In the current entry, delete PROPERTY."
  12856. (interactive
  12857. (let* ((completion-ignore-case t)
  12858. (prop (org-icompleting-read "Property: "
  12859. (org-entry-properties nil 'standard))))
  12860. (list prop)))
  12861. (message "Property %s %s" property
  12862. (if (org-entry-delete nil property)
  12863. "deleted"
  12864. "was not present in the entry")))
  12865. (defun org-delete-property-globally (property)
  12866. "Remove PROPERTY globally, from all entries."
  12867. (interactive
  12868. (let* ((completion-ignore-case t)
  12869. (prop (org-icompleting-read
  12870. "Globally remove property: "
  12871. (mapcar 'list (org-buffer-property-keys)))))
  12872. (list prop)))
  12873. (save-excursion
  12874. (save-restriction
  12875. (widen)
  12876. (goto-char (point-min))
  12877. (let ((cnt 0))
  12878. (while (re-search-forward
  12879. (org-re-property property)
  12880. nil t)
  12881. (setq cnt (1+ cnt))
  12882. (replace-match ""))
  12883. (message "Property \"%s\" removed from %d entries" property cnt)))))
  12884. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  12885. (defun org-compute-property-at-point ()
  12886. "Compute the property at point.
  12887. This looks for an enclosing column format, extracts the operator and
  12888. then applies it to the property in the column format's scope."
  12889. (interactive)
  12890. (unless (org-at-property-p)
  12891. (error "Not at a property"))
  12892. (let ((prop (org-match-string-no-properties 2)))
  12893. (org-columns-get-format-and-top-level)
  12894. (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
  12895. (error "No operator defined for property %s" prop))
  12896. (org-columns-compute prop)))
  12897. (defvar org-property-allowed-value-functions nil
  12898. "Hook for functions supplying allowed values for a specific property.
  12899. The functions must take a single argument, the name of the property, and
  12900. return a flat list of allowed values. If \":ETC\" is one of
  12901. the values, this means that these values are intended as defaults for
  12902. completion, but that other values should be allowed too.
  12903. The functions must return nil if they are not responsible for this
  12904. property.")
  12905. (defun org-property-get-allowed-values (pom property &optional table)
  12906. "Get allowed values for the property PROPERTY.
  12907. When TABLE is non-nil, return an alist that can directly be used for
  12908. completion."
  12909. (let (vals)
  12910. (cond
  12911. ((equal property "TODO")
  12912. (setq vals (org-with-point-at pom
  12913. (append org-todo-keywords-1 '("")))))
  12914. ((equal property "PRIORITY")
  12915. (let ((n org-lowest-priority))
  12916. (while (>= n org-highest-priority)
  12917. (push (char-to-string n) vals)
  12918. (setq n (1- n)))))
  12919. ((member property org-special-properties))
  12920. ((setq vals (run-hook-with-args-until-success
  12921. 'org-property-allowed-value-functions property)))
  12922. (t
  12923. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  12924. (when (and vals (string-match "\\S-" vals))
  12925. (setq vals (car (read-from-string (concat "(" vals ")"))))
  12926. (setq vals (mapcar (lambda (x)
  12927. (cond ((stringp x) x)
  12928. ((numberp x) (number-to-string x))
  12929. ((symbolp x) (symbol-name x))
  12930. (t "???")))
  12931. vals)))))
  12932. (when (member ":ETC" vals)
  12933. (setq vals (remove ":ETC" vals))
  12934. (org-add-props (car vals) '(org-unrestricted t)))
  12935. (if table (mapcar 'list vals) vals)))
  12936. (defun org-property-previous-allowed-value (&optional previous)
  12937. "Switch to the next allowed value for this property."
  12938. (interactive)
  12939. (org-property-next-allowed-value t))
  12940. (defun org-property-next-allowed-value (&optional previous)
  12941. "Switch to the next allowed value for this property."
  12942. (interactive)
  12943. (unless (org-at-property-p)
  12944. (error "Not at a property"))
  12945. (let* ((key (match-string 2))
  12946. (value (match-string 3))
  12947. (allowed (or (org-property-get-allowed-values (point) key)
  12948. (and (member value '("[ ]" "[-]" "[X]"))
  12949. '("[ ]" "[X]"))))
  12950. nval)
  12951. (unless allowed
  12952. (error "Allowed values for this property have not been defined"))
  12953. (if previous (setq allowed (reverse allowed)))
  12954. (if (member value allowed)
  12955. (setq nval (car (cdr (member value allowed)))))
  12956. (setq nval (or nval (car allowed)))
  12957. (if (equal nval value)
  12958. (error "Only one allowed value for this property"))
  12959. (org-at-property-p)
  12960. (replace-match (concat " :" key ": " nval) t t)
  12961. (org-indent-line-function)
  12962. (beginning-of-line 1)
  12963. (skip-chars-forward " \t")
  12964. (run-hook-with-args 'org-property-changed-functions key nval)))
  12965. (defun org-find-olp (path &optional this-buffer)
  12966. "Return a marker pointing to the entry at outline path OLP.
  12967. If anything goes wrong, throw an error.
  12968. You can wrap this call to catch the error like this:
  12969. (condition-case msg
  12970. (org-mobile-locate-entry (match-string 4))
  12971. (error (nth 1 msg)))
  12972. The return value will then be either a string with the error message,
  12973. or a marker if everything is OK.
  12974. If THIS-BUFFER is set, the outline path does not contain a file,
  12975. only headings."
  12976. (let* ((file (if this-buffer buffer-file-name (pop path)))
  12977. (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
  12978. (level 1)
  12979. (lmin 1)
  12980. (lmax 1)
  12981. limit re end found pos heading cnt flevel)
  12982. (unless buffer (error "File not found :%s" file))
  12983. (with-current-buffer buffer
  12984. (save-excursion
  12985. (save-restriction
  12986. (widen)
  12987. (setq limit (point-max))
  12988. (goto-char (point-min))
  12989. (while (setq heading (pop path))
  12990. (setq re (format org-complex-heading-regexp-format
  12991. (regexp-quote heading)))
  12992. (setq cnt 0 pos (point))
  12993. (while (re-search-forward re end t)
  12994. (setq level (- (match-end 1) (match-beginning 1)))
  12995. (if (and (>= level lmin) (<= level lmax))
  12996. (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
  12997. (when (= cnt 0) (error "Heading not found on level %d: %s"
  12998. lmax heading))
  12999. (when (> cnt 1) (error "Heading not unique on level %d: %s"
  13000. lmax heading))
  13001. (goto-char found)
  13002. (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
  13003. (setq end (save-excursion (org-end-of-subtree t t))))
  13004. (when (org-on-heading-p)
  13005. (move-marker (make-marker) (point))))))))
  13006. (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
  13007. "Find node HEADING in BUFFER.
  13008. Return a marker to the heading if it was found, or nil if not.
  13009. If POS-ONLY is set, return just the position instead of a marker.
  13010. The heading text must match exact, but it may have a TODO keyword,
  13011. a priority cookie and tags in the standard locations."
  13012. (with-current-buffer (or buffer (current-buffer))
  13013. (save-excursion
  13014. (save-restriction
  13015. (widen)
  13016. (goto-char (point-min))
  13017. (let (case-fold-search)
  13018. (if (re-search-forward
  13019. (format org-complex-heading-regexp-format
  13020. (regexp-quote heading)) nil t)
  13021. (if pos-only
  13022. (match-beginning 0)
  13023. (move-marker (make-marker) (match-beginning 0)))))))))
  13024. (defun org-find-exact-heading-in-directory (heading &optional dir)
  13025. "Find Org node headline HEADING in all .org files in directory DIR.
  13026. When the target headline is found, return a marker to this location."
  13027. (let ((files (directory-files (or dir default-directory)
  13028. nil "\\`[^.#].*\\.org\\'"))
  13029. file visiting m buffer)
  13030. (catch 'found
  13031. (while (setq file (pop files))
  13032. (message "trying %s" file)
  13033. (setq visiting (org-find-base-buffer-visiting file))
  13034. (setq buffer (or visiting (find-file-noselect file)))
  13035. (setq m (org-find-exact-headline-in-buffer
  13036. heading buffer))
  13037. (when (and (not m) (not visiting)) (kill-buffer buffer))
  13038. (and m (throw 'found m))))))
  13039. (defun org-find-entry-with-id (ident)
  13040. "Locate the entry that contains the ID property with exact value IDENT.
  13041. IDENT can be a string, a symbol or a number, this function will search for
  13042. the string representation of it.
  13043. Return the position where this entry starts, or nil if there is no such entry."
  13044. (interactive "sID: ")
  13045. (let ((id (cond
  13046. ((stringp ident) ident)
  13047. ((symbol-name ident) (symbol-name ident))
  13048. ((numberp ident) (number-to-string ident))
  13049. (t (error "IDENT %s must be a string, symbol or number" ident))))
  13050. (case-fold-search nil))
  13051. (save-excursion
  13052. (save-restriction
  13053. (widen)
  13054. (goto-char (point-min))
  13055. (when (re-search-forward
  13056. (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
  13057. nil t)
  13058. (org-back-to-heading t)
  13059. (point))))))
  13060. ;;;; Timestamps
  13061. (defvar org-last-changed-timestamp nil)
  13062. (defvar org-last-inserted-timestamp nil
  13063. "The last time stamp inserted with `org-insert-time-stamp'.")
  13064. (defvar org-time-was-given) ; dynamically scoped parameter
  13065. (defvar org-end-time-was-given) ; dynamically scoped parameter
  13066. (defvar org-ts-what) ; dynamically scoped parameter
  13067. (defun org-time-stamp (arg &optional inactive)
  13068. "Prompt for a date/time and insert a time stamp.
  13069. If the user specifies a time like HH:MM, or if this command is called
  13070. with a prefix argument, the time stamp will contain date and time.
  13071. Otherwise, only the date will be included. All parts of a date not
  13072. specified by the user will be filled in from the current date/time.
  13073. So if you press just return without typing anything, the time stamp
  13074. will represent the current date/time. If there is already a timestamp
  13075. at the cursor, it will be modified."
  13076. (interactive "P")
  13077. (let* ((ts nil)
  13078. (default-time
  13079. ;; Default time is either today, or, when entering a range,
  13080. ;; the range start.
  13081. (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
  13082. (save-excursion
  13083. (re-search-backward
  13084. (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
  13085. (- (point) 20) t)))
  13086. (apply 'encode-time (org-parse-time-string (match-string 1)))
  13087. (current-time)))
  13088. (default-input (and ts (org-get-compact-tod ts)))
  13089. org-time-was-given org-end-time-was-given time)
  13090. (cond
  13091. ((and (org-at-timestamp-p t)
  13092. (memq last-command '(org-time-stamp org-time-stamp-inactive))
  13093. (memq this-command '(org-time-stamp org-time-stamp-inactive)))
  13094. (insert "--")
  13095. (setq time (let ((this-command this-command))
  13096. (org-read-date arg 'totime nil nil
  13097. default-time default-input)))
  13098. (org-insert-time-stamp time (or org-time-was-given arg) inactive))
  13099. ((org-at-timestamp-p t)
  13100. (setq time (let ((this-command this-command))
  13101. (org-read-date arg 'totime nil nil default-time default-input)))
  13102. (when (org-at-timestamp-p t) ; just to get the match data
  13103. ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
  13104. (replace-match "")
  13105. (setq org-last-changed-timestamp
  13106. (org-insert-time-stamp
  13107. time (or org-time-was-given arg)
  13108. inactive nil nil (list org-end-time-was-given))))
  13109. (message "Timestamp updated"))
  13110. (t
  13111. (setq time (let ((this-command this-command))
  13112. (org-read-date arg 'totime nil nil default-time default-input)))
  13113. (org-insert-time-stamp time (or org-time-was-given arg) inactive
  13114. nil nil (list org-end-time-was-given))))))
  13115. ;; FIXME: can we use this for something else, like computing time differences?
  13116. (defun org-get-compact-tod (s)
  13117. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  13118. (let* ((t1 (match-string 1 s))
  13119. (h1 (string-to-number (match-string 2 s)))
  13120. (m1 (string-to-number (match-string 3 s)))
  13121. (t2 (and (match-end 4) (match-string 5 s)))
  13122. (h2 (and t2 (string-to-number (match-string 6 s))))
  13123. (m2 (and t2 (string-to-number (match-string 7 s))))
  13124. dh dm)
  13125. (if (not t2)
  13126. t1
  13127. (setq dh (- h2 h1) dm (- m2 m1))
  13128. (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  13129. (concat t1 "+" (number-to-string dh)
  13130. (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
  13131. (defun org-time-stamp-inactive (&optional arg)
  13132. "Insert an inactive time stamp.
  13133. An inactive time stamp is enclosed in square brackets instead of angle
  13134. brackets. It is inactive in the sense that it does not trigger agenda entries,
  13135. does not link to the calendar and cannot be changed with the S-cursor keys.
  13136. So these are more for recording a certain time/date."
  13137. (interactive "P")
  13138. (org-time-stamp arg 'inactive))
  13139. (defvar org-date-ovl (make-overlay 1 1))
  13140. (overlay-put org-date-ovl 'face 'org-warning)
  13141. (org-detach-overlay org-date-ovl)
  13142. (defvar org-ans1) ; dynamically scoped parameter
  13143. (defvar org-ans2) ; dynamically scoped parameter
  13144. (defvar org-plain-time-of-day-regexp) ; defined below
  13145. (defvar org-overriding-default-time nil) ; dynamically scoped
  13146. (defvar org-read-date-overlay nil)
  13147. (defvar org-dcst nil) ; dynamically scoped
  13148. (defvar org-read-date-history nil)
  13149. (defvar org-read-date-final-answer nil)
  13150. (defvar org-read-date-analyze-futurep nil)
  13151. (defvar org-read-date-analyze-forced-year nil)
  13152. (defun org-read-date (&optional with-time to-time from-string prompt
  13153. default-time default-input)
  13154. "Read a date, possibly a time, and make things smooth for the user.
  13155. The prompt will suggest to enter an ISO date, but you can also enter anything
  13156. which will at least partially be understood by `parse-time-string'.
  13157. Unrecognized parts of the date will default to the current day, month, year,
  13158. hour and minute. If this command is called to replace a timestamp at point,
  13159. of to enter the second timestamp of a range, the default time is taken
  13160. from the existing stamp. Furthermore, the command prefers the future,
  13161. so if you are giving a date where the year is not given, and the day-month
  13162. combination is already past in the current year, it will assume you
  13163. mean next year. For details, see the manual. A few examples:
  13164. 3-2-5 --> 2003-02-05
  13165. feb 15 --> currentyear-02-15
  13166. 2/15 --> currentyear-02-15
  13167. sep 12 9 --> 2009-09-12
  13168. 12:45 --> today 12:45
  13169. 22 sept 0:34 --> currentyear-09-22 0:34
  13170. 12 --> currentyear-currentmonth-12
  13171. Fri --> nearest Friday (today or later)
  13172. etc.
  13173. Furthermore you can specify a relative date by giving, as the *first* thing
  13174. in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
  13175. change in days weeks, months, years.
  13176. With a single plus or minus, the date is relative to today. With a double
  13177. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  13178. +4d --> four days from today
  13179. +4 --> same as above
  13180. +2w --> two weeks from today
  13181. ++5 --> five days from default date
  13182. The function understands only English month and weekday abbreviations,
  13183. but this can be configured with the variables `parse-time-months' and
  13184. `parse-time-weekdays'.
  13185. While prompting, a calendar is popped up - you can also select the
  13186. date with the mouse (button 1). The calendar shows a period of three
  13187. months. To scroll it to other months, use the keys `>' and `<'.
  13188. If you don't like the calendar, turn it off with
  13189. \(setq org-read-date-popup-calendar nil)
  13190. With optional argument TO-TIME, the date will immediately be converted
  13191. to an internal time.
  13192. With an optional argument WITH-TIME, the prompt will suggest to also
  13193. insert a time. Note that when WITH-TIME is not set, you can still
  13194. enter a time, and this function will inform the calling routine about
  13195. this change. The calling routine may then choose to change the format
  13196. used to insert the time stamp into the buffer to include the time.
  13197. With optional argument FROM-STRING, read from this string instead from
  13198. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  13199. the time/date that is used for everything that is not specified by the
  13200. user."
  13201. (require 'parse-time)
  13202. (let* ((org-time-stamp-rounding-minutes
  13203. (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
  13204. (org-dcst org-display-custom-times)
  13205. (ct (org-current-time))
  13206. (def (or org-overriding-default-time default-time ct))
  13207. (defdecode (decode-time def))
  13208. (dummy (progn
  13209. (when (< (nth 2 defdecode) org-extend-today-until)
  13210. (setcar (nthcdr 2 defdecode) -1)
  13211. (setcar (nthcdr 1 defdecode) 59)
  13212. (setq def (apply 'encode-time defdecode)
  13213. defdecode (decode-time def)))))
  13214. (calendar-frame-setup nil)
  13215. (calendar-setup nil)
  13216. (calendar-move-hook nil)
  13217. (calendar-view-diary-initially-flag nil)
  13218. (calendar-view-holidays-initially-flag nil)
  13219. (timestr (format-time-string
  13220. (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
  13221. (prompt (concat (if prompt (concat prompt " ") "")
  13222. (format "Date+time [%s]: " timestr)))
  13223. ans (org-ans0 "") org-ans1 org-ans2 final)
  13224. (cond
  13225. (from-string (setq ans from-string))
  13226. (org-read-date-popup-calendar
  13227. (save-excursion
  13228. (save-window-excursion
  13229. (calendar)
  13230. (unwind-protect
  13231. (progn
  13232. (calendar-forward-day (- (time-to-days def)
  13233. (calendar-absolute-from-gregorian
  13234. (calendar-current-date))))
  13235. (org-eval-in-calendar nil t)
  13236. (let* ((old-map (current-local-map))
  13237. (map (copy-keymap calendar-mode-map))
  13238. (minibuffer-local-map (copy-keymap minibuffer-local-map)))
  13239. (org-defkey map (kbd "RET") 'org-calendar-select)
  13240. (org-defkey map [mouse-1] 'org-calendar-select-mouse)
  13241. (org-defkey map [mouse-2] 'org-calendar-select-mouse)
  13242. (org-defkey minibuffer-local-map [(meta shift left)]
  13243. (lambda () (interactive)
  13244. (org-eval-in-calendar '(calendar-backward-month 1))))
  13245. (org-defkey minibuffer-local-map [(meta shift right)]
  13246. (lambda () (interactive)
  13247. (org-eval-in-calendar '(calendar-forward-month 1))))
  13248. (org-defkey minibuffer-local-map [(meta shift up)]
  13249. (lambda () (interactive)
  13250. (org-eval-in-calendar '(calendar-backward-year 1))))
  13251. (org-defkey minibuffer-local-map [(meta shift down)]
  13252. (lambda () (interactive)
  13253. (org-eval-in-calendar '(calendar-forward-year 1))))
  13254. (org-defkey minibuffer-local-map [?\e (shift left)]
  13255. (lambda () (interactive)
  13256. (org-eval-in-calendar '(calendar-backward-month 1))))
  13257. (org-defkey minibuffer-local-map [?\e (shift right)]
  13258. (lambda () (interactive)
  13259. (org-eval-in-calendar '(calendar-forward-month 1))))
  13260. (org-defkey minibuffer-local-map [?\e (shift up)]
  13261. (lambda () (interactive)
  13262. (org-eval-in-calendar '(calendar-backward-year 1))))
  13263. (org-defkey minibuffer-local-map [?\e (shift down)]
  13264. (lambda () (interactive)
  13265. (org-eval-in-calendar '(calendar-forward-year 1))))
  13266. (org-defkey minibuffer-local-map [(shift up)]
  13267. (lambda () (interactive)
  13268. (org-eval-in-calendar '(calendar-backward-week 1))))
  13269. (org-defkey minibuffer-local-map [(shift down)]
  13270. (lambda () (interactive)
  13271. (org-eval-in-calendar '(calendar-forward-week 1))))
  13272. (org-defkey minibuffer-local-map [(shift left)]
  13273. (lambda () (interactive)
  13274. (org-eval-in-calendar '(calendar-backward-day 1))))
  13275. (org-defkey minibuffer-local-map [(shift right)]
  13276. (lambda () (interactive)
  13277. (org-eval-in-calendar '(calendar-forward-day 1))))
  13278. (org-defkey minibuffer-local-map ">"
  13279. (lambda () (interactive)
  13280. (org-eval-in-calendar '(scroll-calendar-left 1))))
  13281. (org-defkey minibuffer-local-map "<"
  13282. (lambda () (interactive)
  13283. (org-eval-in-calendar '(scroll-calendar-right 1))))
  13284. (org-defkey minibuffer-local-map "\C-v"
  13285. (lambda () (interactive)
  13286. (org-eval-in-calendar
  13287. '(calendar-scroll-left-three-months 1))))
  13288. (org-defkey minibuffer-local-map "\M-v"
  13289. (lambda () (interactive)
  13290. (org-eval-in-calendar
  13291. '(calendar-scroll-right-three-months 1))))
  13292. (run-hooks 'org-read-date-minibuffer-setup-hook)
  13293. (unwind-protect
  13294. (progn
  13295. (use-local-map map)
  13296. (add-hook 'post-command-hook 'org-read-date-display)
  13297. (setq org-ans0 (read-string prompt default-input
  13298. 'org-read-date-history nil))
  13299. ;; org-ans0: from prompt
  13300. ;; org-ans1: from mouse click
  13301. ;; org-ans2: from calendar motion
  13302. (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
  13303. (remove-hook 'post-command-hook 'org-read-date-display)
  13304. (use-local-map old-map)
  13305. (when org-read-date-overlay
  13306. (delete-overlay org-read-date-overlay)
  13307. (setq org-read-date-overlay nil)))))
  13308. (bury-buffer "*Calendar*")))))
  13309. (t ; Naked prompt only
  13310. (unwind-protect
  13311. (setq ans (read-string prompt default-input
  13312. 'org-read-date-history timestr))
  13313. (when org-read-date-overlay
  13314. (delete-overlay org-read-date-overlay)
  13315. (setq org-read-date-overlay nil)))))
  13316. (setq final (org-read-date-analyze ans def defdecode))
  13317. (when org-read-date-analyze-forced-year
  13318. (message "Year was forced into %s"
  13319. (if org-read-date-force-compatible-dates
  13320. "compatible range (1970-2037)"
  13321. "range representable on this machine"))
  13322. (ding))
  13323. ;; One round trip to get rid of 34th of August and stuff like that....
  13324. (setq final (decode-time (apply 'encode-time final)))
  13325. (setq org-read-date-final-answer ans)
  13326. (if to-time
  13327. (apply 'encode-time final)
  13328. (if (and (boundp 'org-time-was-given) org-time-was-given)
  13329. (format "%04d-%02d-%02d %02d:%02d"
  13330. (nth 5 final) (nth 4 final) (nth 3 final)
  13331. (nth 2 final) (nth 1 final))
  13332. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  13333. (defvar def)
  13334. (defvar defdecode)
  13335. (defvar with-time)
  13336. (defun org-read-date-display ()
  13337. "Display the current date prompt interpretation in the minibuffer."
  13338. (when org-read-date-display-live
  13339. (when org-read-date-overlay
  13340. (delete-overlay org-read-date-overlay))
  13341. (let ((p (point)))
  13342. (end-of-line 1)
  13343. (while (not (equal (buffer-substring
  13344. (max (point-min) (- (point) 4)) (point))
  13345. " "))
  13346. (insert " "))
  13347. (goto-char p))
  13348. (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
  13349. " " (or org-ans1 org-ans2)))
  13350. (org-end-time-was-given nil)
  13351. (f (org-read-date-analyze ans def defdecode))
  13352. (fmts (if org-dcst
  13353. org-time-stamp-custom-formats
  13354. org-time-stamp-formats))
  13355. (fmt (if (or with-time
  13356. (and (boundp 'org-time-was-given) org-time-was-given))
  13357. (cdr fmts)
  13358. (car fmts)))
  13359. (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
  13360. (when (and org-end-time-was-given
  13361. (string-match org-plain-time-of-day-regexp txt))
  13362. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  13363. org-end-time-was-given
  13364. (substring txt (match-end 0)))))
  13365. (when org-read-date-analyze-futurep
  13366. (setq txt (concat txt " (=>F)")))
  13367. (setq org-read-date-overlay
  13368. (make-overlay (1- (point-at-eol)) (point-at-eol)))
  13369. (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
  13370. (defun org-read-date-analyze (ans def defdecode)
  13371. "Analyze the combined answer of the date prompt."
  13372. ;; FIXME: cleanup and comment
  13373. (let ((nowdecode (decode-time (current-time)))
  13374. delta deltan deltaw deltadef year month day
  13375. hour minute second wday pm h2 m2 tl wday1
  13376. iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
  13377. (setq org-read-date-analyze-futurep nil
  13378. org-read-date-analyze-forced-year nil)
  13379. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  13380. (setq ans "+0"))
  13381. (when (setq delta (org-read-date-get-relative ans (current-time) def))
  13382. (setq ans (replace-match "" t t ans)
  13383. deltan (car delta)
  13384. deltaw (nth 1 delta)
  13385. deltadef (nth 2 delta)))
  13386. ;; Check if there is an iso week date in there
  13387. ;; If yes, store the info and postpone interpreting it until the rest
  13388. ;; of the parsing is done
  13389. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  13390. (setq iso-year (if (match-end 1)
  13391. (org-small-year-to-year
  13392. (string-to-number (match-string 1 ans))))
  13393. iso-weekday (if (match-end 3)
  13394. (string-to-number (match-string 3 ans)))
  13395. iso-week (string-to-number (match-string 2 ans)))
  13396. (setq ans (replace-match "" t t ans)))
  13397. ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
  13398. (when (string-match
  13399. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  13400. (setq year (if (match-end 2)
  13401. (string-to-number (match-string 2 ans))
  13402. (progn (setq kill-year t)
  13403. (string-to-number (format-time-string "%Y"))))
  13404. month (string-to-number (match-string 3 ans))
  13405. day (string-to-number (match-string 4 ans)))
  13406. (if (< year 100) (setq year (+ 2000 year)))
  13407. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  13408. t nil ans)))
  13409. ;; Help matching dottet european dates
  13410. (when (string-match
  13411. "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
  13412. (setq year (if (match-end 3)
  13413. (string-to-number (match-string 3 ans))
  13414. (progn (setq kill-year t)
  13415. (string-to-number (format-time-string "%Y"))))
  13416. day (string-to-number (match-string 1 ans))
  13417. month (string-to-number (match-string 2 ans))
  13418. ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  13419. t nil ans)))
  13420. ;; Help matching american dates, like 5/30 or 5/30/7
  13421. (when (string-match
  13422. "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
  13423. (setq year (if (match-end 4)
  13424. (string-to-number (match-string 4 ans))
  13425. (progn (setq kill-year t)
  13426. (string-to-number (format-time-string "%Y"))))
  13427. month (string-to-number (match-string 1 ans))
  13428. day (string-to-number (match-string 2 ans)))
  13429. (if (< year 100) (setq year (+ 2000 year)))
  13430. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  13431. t nil ans)))
  13432. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  13433. ;; If there is a time with am/pm, and *no* time without it, we convert
  13434. ;; so that matching will be successful.
  13435. (loop for i from 1 to 2 do ; twice, for end time as well
  13436. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  13437. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  13438. (setq hour (string-to-number (match-string 1 ans))
  13439. minute (if (match-end 3)
  13440. (string-to-number (match-string 3 ans))
  13441. 0)
  13442. pm (equal ?p
  13443. (string-to-char (downcase (match-string 4 ans)))))
  13444. (if (and (= hour 12) (not pm))
  13445. (setq hour 0)
  13446. (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
  13447. (setq ans (replace-match (format "%02d:%02d" hour minute)
  13448. t t ans))))
  13449. ;; Check if a time range is given as a duration
  13450. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  13451. (setq hour (string-to-number (match-string 1 ans))
  13452. h2 (+ hour (string-to-number (match-string 3 ans)))
  13453. minute (string-to-number (match-string 2 ans))
  13454. m2 (+ minute (if (match-end 5) (string-to-number
  13455. (match-string 5 ans))0)))
  13456. (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  13457. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  13458. t t ans)))
  13459. ;; Check if there is a time range
  13460. (when (boundp 'org-end-time-was-given)
  13461. (setq org-time-was-given nil)
  13462. (when (and (string-match org-plain-time-of-day-regexp ans)
  13463. (match-end 8))
  13464. (setq org-end-time-was-given (match-string 8 ans))
  13465. (setq ans (concat (substring ans 0 (match-beginning 7))
  13466. (substring ans (match-end 7))))))
  13467. (setq tl (parse-time-string ans)
  13468. day (or (nth 3 tl) (nth 3 defdecode))
  13469. month (or (nth 4 tl)
  13470. (if (and org-read-date-prefer-future
  13471. (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
  13472. (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
  13473. (nth 4 defdecode)))
  13474. year (or (and (not kill-year) (nth 5 tl))
  13475. (if (and org-read-date-prefer-future
  13476. (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
  13477. (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
  13478. (nth 5 defdecode)))
  13479. hour (or (nth 2 tl) (nth 2 defdecode))
  13480. minute (or (nth 1 tl) (nth 1 defdecode))
  13481. second (or (nth 0 tl) 0)
  13482. wday (nth 6 tl))
  13483. (when (and (eq org-read-date-prefer-future 'time)
  13484. (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
  13485. (equal day (nth 3 nowdecode))
  13486. (equal month (nth 4 nowdecode))
  13487. (equal year (nth 5 nowdecode))
  13488. (nth 2 tl)
  13489. (or (< (nth 2 tl) (nth 2 nowdecode))
  13490. (and (= (nth 2 tl) (nth 2 nowdecode))
  13491. (nth 1 tl)
  13492. (< (nth 1 tl) (nth 1 nowdecode)))))
  13493. (setq day (1+ day)
  13494. futurep t))
  13495. ;; Special date definitions below
  13496. (cond
  13497. (iso-week
  13498. ;; There was an iso week
  13499. (require 'cal-iso)
  13500. (setq futurep nil)
  13501. (setq year (or iso-year year)
  13502. day (or iso-weekday wday 1)
  13503. wday nil ; to make sure that the trigger below does not match
  13504. iso-date (calendar-gregorian-from-absolute
  13505. (calendar-absolute-from-iso
  13506. (list iso-week day year))))
  13507. ; FIXME: Should we also push ISO weeks into the future?
  13508. ; (when (and org-read-date-prefer-future
  13509. ; (not iso-year)
  13510. ; (< (calendar-absolute-from-gregorian iso-date)
  13511. ; (time-to-days (current-time))))
  13512. ; (setq year (1+ year)
  13513. ; iso-date (calendar-gregorian-from-absolute
  13514. ; (calendar-absolute-from-iso
  13515. ; (list iso-week day year)))))
  13516. (setq month (car iso-date)
  13517. year (nth 2 iso-date)
  13518. day (nth 1 iso-date)))
  13519. (deltan
  13520. (setq futurep nil)
  13521. (unless deltadef
  13522. (let ((now (decode-time (current-time))))
  13523. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  13524. (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
  13525. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  13526. ((equal deltaw "m") (setq month (+ month deltan)))
  13527. ((equal deltaw "y") (setq year (+ year deltan)))))
  13528. ((and wday (not (nth 3 tl)))
  13529. (setq futurep nil)
  13530. ;; Weekday was given, but no day, so pick that day in the week
  13531. ;; on or after the derived date.
  13532. (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
  13533. (unless (equal wday wday1)
  13534. (setq day (+ day (% (- wday wday1 -7) 7))))))
  13535. (if (and (boundp 'org-time-was-given)
  13536. (nth 2 tl))
  13537. (setq org-time-was-given t))
  13538. (if (< year 100) (setq year (+ 2000 year)))
  13539. ;; Check of the date is representable
  13540. (if org-read-date-force-compatible-dates
  13541. (progn
  13542. (if (< year 1970)
  13543. (setq year 1970 org-read-date-analyze-forced-year t))
  13544. (if (> year 2037)
  13545. (setq year 2037 org-read-date-analyze-forced-year t)))
  13546. (condition-case nil
  13547. (encode-time second minute hour day month year)
  13548. (error
  13549. (setq year (nth 5 defdecode))
  13550. (setq org-read-date-analyze-forced-year t))))
  13551. (setq org-read-date-analyze-futurep futurep)
  13552. (list second minute hour day month year)))
  13553. (defvar parse-time-weekdays)
  13554. (defun org-read-date-get-relative (s today default)
  13555. "Check string S for special relative date string.
  13556. TODAY and DEFAULT are internal times, for today and for a default.
  13557. Return shift list (N what def-flag)
  13558. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  13559. N is the number of WHATs to shift.
  13560. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  13561. the DEFAULT date rather than TODAY."
  13562. (when (and
  13563. (string-match
  13564. (concat
  13565. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  13566. "\\([0-9]+\\)?"
  13567. "\\([dwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  13568. "\\([ \t]\\|$\\)") s)
  13569. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  13570. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  13571. (string-to-char (substring (match-string 1 s) -1))
  13572. ?+))
  13573. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  13574. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  13575. (what (if (match-end 3) (match-string 3 s) "d"))
  13576. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  13577. (date (if rel default today))
  13578. (wday (nth 6 (decode-time date)))
  13579. delta)
  13580. (if wday1
  13581. (progn
  13582. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  13583. (if (= dir ?-) (setq delta (- delta 7)))
  13584. (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  13585. (list delta "d" rel))
  13586. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  13587. (defun org-order-calendar-date-args (arg1 arg2 arg3)
  13588. "Turn a user-specified date into the internal representation.
  13589. The internal representation needed by the calendar is (month day year).
  13590. This is a wrapper to handle the brain-dead convention in calendar that
  13591. user function argument order change dependent on argument order."
  13592. (if (boundp 'calendar-date-style)
  13593. (cond
  13594. ((eq calendar-date-style 'american)
  13595. (list arg1 arg2 arg3))
  13596. ((eq calendar-date-style 'european)
  13597. (list arg2 arg1 arg3))
  13598. ((eq calendar-date-style 'iso)
  13599. (list arg2 arg3 arg1)))
  13600. (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
  13601. (if (org-bound-and-true-p european-calendar-style)
  13602. (list arg2 arg1 arg3)
  13603. (list arg1 arg2 arg3)))))
  13604. (defun org-eval-in-calendar (form &optional keepdate)
  13605. "Eval FORM in the calendar window and return to current window.
  13606. Also, store the cursor date in variable org-ans2."
  13607. (let ((sf (selected-frame))
  13608. (sw (selected-window)))
  13609. (select-window (get-buffer-window "*Calendar*" t))
  13610. (eval form)
  13611. (when (and (not keepdate) (calendar-cursor-to-date))
  13612. (let* ((date (calendar-cursor-to-date))
  13613. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  13614. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  13615. (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  13616. (select-window sw)
  13617. (org-select-frame-set-input-focus sf)))
  13618. (defun org-calendar-select ()
  13619. "Return to `org-read-date' with the date currently selected.
  13620. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  13621. (interactive)
  13622. (when (calendar-cursor-to-date)
  13623. (let* ((date (calendar-cursor-to-date))
  13624. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  13625. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  13626. (if (active-minibuffer-window) (exit-minibuffer))))
  13627. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  13628. "Insert a date stamp for the date given by the internal TIME.
  13629. WITH-HM means use the stamp format that includes the time of the day.
  13630. INACTIVE means use square brackets instead of angular ones, so that the
  13631. stamp will not contribute to the agenda.
  13632. PRE and POST are optional strings to be inserted before and after the
  13633. stamp.
  13634. The command returns the inserted time stamp."
  13635. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  13636. stamp)
  13637. (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  13638. (insert-before-markers (or pre ""))
  13639. (when (listp extra)
  13640. (setq extra (car extra))
  13641. (if (and (stringp extra)
  13642. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  13643. (setq extra (format "-%02d:%02d"
  13644. (string-to-number (match-string 1 extra))
  13645. (string-to-number (match-string 2 extra))))
  13646. (setq extra nil)))
  13647. (when extra
  13648. (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
  13649. (insert-before-markers (setq stamp (format-time-string fmt time)))
  13650. (insert-before-markers (or post ""))
  13651. (setq org-last-inserted-timestamp stamp)))
  13652. (defun org-toggle-time-stamp-overlays ()
  13653. "Toggle the use of custom time stamp formats."
  13654. (interactive)
  13655. (setq org-display-custom-times (not org-display-custom-times))
  13656. (unless org-display-custom-times
  13657. (let ((p (point-min)) (bmp (buffer-modified-p)))
  13658. (while (setq p (next-single-property-change p 'display))
  13659. (if (and (get-text-property p 'display)
  13660. (eq (get-text-property p 'face) 'org-date))
  13661. (remove-text-properties
  13662. p (setq p (next-single-property-change p 'display))
  13663. '(display t))))
  13664. (set-buffer-modified-p bmp)))
  13665. (if (featurep 'xemacs)
  13666. (remove-text-properties (point-min) (point-max) '(end-glyph t)))
  13667. (org-restart-font-lock)
  13668. (setq org-table-may-need-update t)
  13669. (if org-display-custom-times
  13670. (message "Time stamps are overlayed with custom format")
  13671. (message "Time stamp overlays removed")))
  13672. (defun org-display-custom-time (beg end)
  13673. "Overlay modified time stamp format over timestamp between BEG and END."
  13674. (let* ((ts (buffer-substring beg end))
  13675. t1 w1 with-hm tf time str w2 (off 0))
  13676. (save-match-data
  13677. (setq t1 (org-parse-time-string ts t))
  13678. (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
  13679. (setq off (- (match-end 0) (match-beginning 0)))))
  13680. (setq end (- end off))
  13681. (setq w1 (- end beg)
  13682. with-hm (and (nth 1 t1) (nth 2 t1))
  13683. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  13684. time (org-fix-decoded-time t1)
  13685. str (org-add-props
  13686. (format-time-string
  13687. (substring tf 1 -1) (apply 'encode-time time))
  13688. nil 'mouse-face 'highlight)
  13689. w2 (length str))
  13690. (if (not (= w2 w1))
  13691. (add-text-properties (1+ beg) (+ 2 beg)
  13692. (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
  13693. (if (featurep 'xemacs)
  13694. (progn
  13695. (put-text-property beg end 'invisible t)
  13696. (put-text-property beg end 'end-glyph (make-glyph str)))
  13697. (put-text-property beg end 'display str))))
  13698. (defun org-translate-time (string)
  13699. "Translate all timestamps in STRING to custom format.
  13700. But do this only if the variable `org-display-custom-times' is set."
  13701. (when org-display-custom-times
  13702. (save-match-data
  13703. (let* ((start 0)
  13704. (re org-ts-regexp-both)
  13705. t1 with-hm inactive tf time str beg end)
  13706. (while (setq start (string-match re string start))
  13707. (setq beg (match-beginning 0)
  13708. end (match-end 0)
  13709. t1 (save-match-data
  13710. (org-parse-time-string (substring string beg end) t))
  13711. with-hm (and (nth 1 t1) (nth 2 t1))
  13712. inactive (equal (substring string beg (1+ beg)) "[")
  13713. tf (funcall (if with-hm 'cdr 'car)
  13714. org-time-stamp-custom-formats)
  13715. time (org-fix-decoded-time t1)
  13716. str (format-time-string
  13717. (concat
  13718. (if inactive "[" "<") (substring tf 1 -1)
  13719. (if inactive "]" ">"))
  13720. (apply 'encode-time time))
  13721. string (replace-match str t t string)
  13722. start (+ start (length str)))))))
  13723. string)
  13724. (defun org-fix-decoded-time (time)
  13725. "Set 0 instead of nil for the first 6 elements of time.
  13726. Don't touch the rest."
  13727. (let ((n 0))
  13728. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  13729. (defun org-days-to-time (timestamp-string)
  13730. "Difference between TIMESTAMP-STRING and now in days."
  13731. (- (time-to-days (org-time-string-to-time timestamp-string))
  13732. (time-to-days (current-time))))
  13733. (defun org-deadline-close (timestamp-string &optional ndays)
  13734. "Is the time in TIMESTAMP-STRING close to the current date?"
  13735. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  13736. (and (< (org-days-to-time timestamp-string) ndays)
  13737. (not (org-entry-is-done-p))))
  13738. (defun org-get-wdays (ts)
  13739. "Get the deadline lead time appropriate for timestring TS."
  13740. (cond
  13741. ((<= org-deadline-warning-days 0)
  13742. ;; 0 or negative, enforce this value no matter what
  13743. (- org-deadline-warning-days))
  13744. ((string-match "-\\([0-9]+\\)\\([dwmy]\\)\\(\\'\\|>\\| \\)" ts)
  13745. ;; lead time is specified.
  13746. (floor (* (string-to-number (match-string 1 ts))
  13747. (cdr (assoc (match-string 2 ts)
  13748. '(("d" . 1) ("w" . 7)
  13749. ("m" . 30.4) ("y" . 365.25)))))))
  13750. ;; go for the default.
  13751. (t org-deadline-warning-days)))
  13752. (defun org-calendar-select-mouse (ev)
  13753. "Return to `org-read-date' with the date currently selected.
  13754. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  13755. (interactive "e")
  13756. (mouse-set-point ev)
  13757. (when (calendar-cursor-to-date)
  13758. (let* ((date (calendar-cursor-to-date))
  13759. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  13760. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  13761. (if (active-minibuffer-window) (exit-minibuffer))))
  13762. (defun org-check-deadlines (ndays)
  13763. "Check if there are any deadlines due or past due.
  13764. A deadline is considered due if it happens within `org-deadline-warning-days'
  13765. days from today's date. If the deadline appears in an entry marked DONE,
  13766. it is not shown. The prefix arg NDAYS can be used to test that many
  13767. days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
  13768. (interactive "P")
  13769. (let* ((org-warn-days
  13770. (cond
  13771. ((equal ndays '(4)) 100000)
  13772. (ndays (prefix-numeric-value ndays))
  13773. (t (abs org-deadline-warning-days))))
  13774. (case-fold-search nil)
  13775. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  13776. (callback
  13777. (lambda () (org-deadline-close (match-string 1) org-warn-days))))
  13778. (message "%d deadlines past-due or due within %d days"
  13779. (org-occur regexp nil callback)
  13780. org-warn-days)))
  13781. (defun org-check-before-date (date)
  13782. "Check if there are deadlines or scheduled entries before DATE."
  13783. (interactive (list (org-read-date)))
  13784. (let ((case-fold-search nil)
  13785. (regexp (concat "\\<\\(" org-deadline-string
  13786. "\\|" org-scheduled-string
  13787. "\\) *<\\([^>]+\\)>"))
  13788. (callback
  13789. (lambda () (time-less-p
  13790. (org-time-string-to-time (match-string 2))
  13791. (org-time-string-to-time date)))))
  13792. (message "%d entries before %s"
  13793. (org-occur regexp nil callback) date)))
  13794. (defun org-check-after-date (date)
  13795. "Check if there are deadlines or scheduled entries after DATE."
  13796. (interactive (list (org-read-date)))
  13797. (let ((case-fold-search nil)
  13798. (regexp (concat "\\<\\(" org-deadline-string
  13799. "\\|" org-scheduled-string
  13800. "\\) *<\\([^>]+\\)>"))
  13801. (callback
  13802. (lambda () (not
  13803. (time-less-p
  13804. (org-time-string-to-time (match-string 2))
  13805. (org-time-string-to-time date))))))
  13806. (message "%d entries after %s"
  13807. (org-occur regexp nil callback) date)))
  13808. (defun org-evaluate-time-range (&optional to-buffer)
  13809. "Evaluate a time range by computing the difference between start and end.
  13810. Normally the result is just printed in the echo area, but with prefix arg
  13811. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  13812. If the time range is actually in a table, the result is inserted into the
  13813. next column.
  13814. For time difference computation, a year is assumed to be exactly 365
  13815. days in order to avoid rounding problems."
  13816. (interactive "P")
  13817. (or
  13818. (org-clock-update-time-maybe)
  13819. (save-excursion
  13820. (unless (org-at-date-range-p t)
  13821. (goto-char (point-at-bol))
  13822. (re-search-forward org-tr-regexp-both (point-at-eol) t))
  13823. (if (not (org-at-date-range-p t))
  13824. (error "Not at a time-stamp range, and none found in current line")))
  13825. (let* ((ts1 (match-string 1))
  13826. (ts2 (match-string 2))
  13827. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  13828. (match-end (match-end 0))
  13829. (time1 (org-time-string-to-time ts1))
  13830. (time2 (org-time-string-to-time ts2))
  13831. (t1 (org-float-time time1))
  13832. (t2 (org-float-time time2))
  13833. (diff (abs (- t2 t1)))
  13834. (negative (< (- t2 t1) 0))
  13835. ;; (ys (floor (* 365 24 60 60)))
  13836. (ds (* 24 60 60))
  13837. (hs (* 60 60))
  13838. (fy "%dy %dd %02d:%02d")
  13839. (fy1 "%dy %dd")
  13840. (fd "%dd %02d:%02d")
  13841. (fd1 "%dd")
  13842. (fh "%02d:%02d")
  13843. y d h m align)
  13844. (if havetime
  13845. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  13846. y 0
  13847. d (floor (/ diff ds)) diff (mod diff ds)
  13848. h (floor (/ diff hs)) diff (mod diff hs)
  13849. m (floor (/ diff 60)))
  13850. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  13851. y 0
  13852. d (floor (+ (/ diff ds) 0.5))
  13853. h 0 m 0))
  13854. (if (not to-buffer)
  13855. (message "%s" (org-make-tdiff-string y d h m))
  13856. (if (org-at-table-p)
  13857. (progn
  13858. (goto-char match-end)
  13859. (setq align t)
  13860. (and (looking-at " *|") (goto-char (match-end 0))))
  13861. (goto-char match-end))
  13862. (if (looking-at
  13863. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  13864. (replace-match ""))
  13865. (if negative (insert " -"))
  13866. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  13867. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  13868. (insert " " (format fh h m))))
  13869. (if align (org-table-align))
  13870. (message "Time difference inserted")))))
  13871. (defun org-make-tdiff-string (y d h m)
  13872. (let ((fmt "")
  13873. (l nil))
  13874. (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
  13875. l (push y l)))
  13876. (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
  13877. l (push d l)))
  13878. (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
  13879. l (push h l)))
  13880. (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
  13881. l (push m l)))
  13882. (apply 'format fmt (nreverse l))))
  13883. (defun org-time-string-to-time (s)
  13884. (apply 'encode-time (org-parse-time-string s)))
  13885. (defun org-time-string-to-seconds (s)
  13886. (org-float-time (org-time-string-to-time s)))
  13887. (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
  13888. "Convert a time stamp to an absolute day number.
  13889. If there is a specifier for a cyclic time stamp, get the closest date to
  13890. DAYNR.
  13891. PREFER and SHOW-ALL are passed through to `org-closest-date'.
  13892. The variable date is bound by the calendar when this is called."
  13893. (cond
  13894. ((and daynr (string-match "\\`%%\\((.*)\\)" s))
  13895. (if (org-diary-sexp-entry (match-string 1 s) "" date)
  13896. daynr
  13897. (+ daynr 1000)))
  13898. ((and daynr (string-match "\\+[0-9]+[dwmy]" s))
  13899. (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
  13900. (time-to-days (current-time))) (match-string 0 s)
  13901. prefer show-all))
  13902. (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
  13903. (defun org-days-to-iso-week (days)
  13904. "Return the iso week number."
  13905. (require 'cal-iso)
  13906. (car (calendar-iso-from-absolute days)))
  13907. (defun org-small-year-to-year (year)
  13908. "Convert 2-digit years into 4-digit years.
  13909. 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
  13910. The year 2000 cannot be abbreviated. Any year larger than 99
  13911. is returned unchanged."
  13912. (if (< year 38)
  13913. (setq year (+ 2000 year))
  13914. (if (< year 100)
  13915. (setq year (+ 1900 year))))
  13916. year)
  13917. (defun org-time-from-absolute (d)
  13918. "Return the time corresponding to date D.
  13919. D may be an absolute day number, or a calendar-type list (month day year)."
  13920. (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  13921. (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  13922. (defun org-calendar-holiday ()
  13923. "List of holidays, for Diary display in Org-mode."
  13924. (require 'holidays)
  13925. (let ((hl (funcall
  13926. (if (fboundp 'calendar-check-holidays)
  13927. 'calendar-check-holidays 'check-calendar-holidays) date)))
  13928. (if hl (mapconcat 'identity hl "; "))))
  13929. (defun org-diary-sexp-entry (sexp entry date)
  13930. "Process a SEXP diary ENTRY for DATE."
  13931. (require 'diary-lib)
  13932. (let ((result (if calendar-debug-sexp
  13933. (let ((stack-trace-on-error t))
  13934. (eval (car (read-from-string sexp))))
  13935. (condition-case nil
  13936. (eval (car (read-from-string sexp)))
  13937. (error
  13938. (beep)
  13939. (message "Bad sexp at line %d in %s: %s"
  13940. (org-current-line)
  13941. (buffer-file-name) sexp)
  13942. (sleep-for 2))))))
  13943. (cond ((stringp result) (split-string result "; "))
  13944. ((and (consp result)
  13945. (not (consp (cdr result)))
  13946. (stringp (cdr result))) (cdr result))
  13947. ((and (consp result)
  13948. (stringp (car result))) result)
  13949. (result entry)
  13950. (t nil))))
  13951. (defun org-diary-to-ical-string (frombuf)
  13952. "Get iCalendar entries from diary entries in buffer FROMBUF.
  13953. This uses the icalendar.el library."
  13954. (let* ((tmpdir (if (featurep 'xemacs)
  13955. (temp-directory)
  13956. temporary-file-directory))
  13957. (tmpfile (make-temp-name
  13958. (expand-file-name "orgics" tmpdir)))
  13959. buf rtn b e)
  13960. (with-current-buffer frombuf
  13961. (icalendar-export-region (point-min) (point-max) tmpfile)
  13962. (setq buf (find-buffer-visiting tmpfile))
  13963. (set-buffer buf)
  13964. (goto-char (point-min))
  13965. (if (re-search-forward "^BEGIN:VEVENT" nil t)
  13966. (setq b (match-beginning 0)))
  13967. (goto-char (point-max))
  13968. (if (re-search-backward "^END:VEVENT" nil t)
  13969. (setq e (match-end 0)))
  13970. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  13971. (kill-buffer buf)
  13972. (delete-file tmpfile)
  13973. rtn))
  13974. (defun org-closest-date (start current change prefer show-all)
  13975. "Find the date closest to CURRENT that is consistent with START and CHANGE.
  13976. When PREFER is `past', return a date that is either CURRENT or past.
  13977. When PREFER is `future', return a date that is either CURRENT or future.
  13978. When SHOW-ALL is nil, only return the current occurrence of a time stamp."
  13979. ;; Make the proper lists from the dates
  13980. (catch 'exit
  13981. (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
  13982. dn dw sday cday n1 n2 n0
  13983. d m y y1 y2 date1 date2 nmonths nm ny m2)
  13984. (setq start (org-date-to-gregorian start)
  13985. current (org-date-to-gregorian
  13986. (if show-all
  13987. current
  13988. (time-to-days (current-time))))
  13989. sday (calendar-absolute-from-gregorian start)
  13990. cday (calendar-absolute-from-gregorian current))
  13991. (if (<= cday sday) (throw 'exit sday))
  13992. (if (string-match "\\(\\+[0-9]+\\)\\([dwmy]\\)" change)
  13993. (setq dn (string-to-number (match-string 1 change))
  13994. dw (cdr (assoc (match-string 2 change) a1)))
  13995. (error "Invalid change specifier: %s" change))
  13996. (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
  13997. (cond
  13998. ((eq dw 'day)
  13999. (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
  14000. n2 (+ n1 dn)))
  14001. ((eq dw 'year)
  14002. (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
  14003. (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
  14004. (setq date1 (list m d y1)
  14005. n1 (calendar-absolute-from-gregorian date1)
  14006. date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
  14007. n2 (calendar-absolute-from-gregorian date2)))
  14008. ((eq dw 'month)
  14009. ;; approx number of month between the two dates
  14010. (setq nmonths (floor (/ (- cday sday) 30.436875)))
  14011. ;; How often does dn fit in there?
  14012. (setq d (nth 1 start) m (car start) y (nth 2 start)
  14013. nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
  14014. m (+ m nm)
  14015. ny (floor (/ m 12))
  14016. y (+ y ny)
  14017. m (- m (* ny 12)))
  14018. (while (> m 12) (setq m (- m 12) y (1+ y)))
  14019. (setq n1 (calendar-absolute-from-gregorian (list m d y)))
  14020. (setq m2 (+ m dn) y2 y)
  14021. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  14022. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
  14023. (while (<= n2 cday)
  14024. (setq n1 n2 m m2 y y2)
  14025. (setq m2 (+ m dn) y2 y)
  14026. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  14027. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
  14028. ;; Make sure n1 is the earlier date
  14029. (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
  14030. (if show-all
  14031. (cond
  14032. ((eq prefer 'past) (if (= cday n2) n2 n1))
  14033. ((eq prefer 'future) (if (= cday n1) n1 n2))
  14034. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
  14035. (cond
  14036. ((eq prefer 'past) (if (= cday n2) n2 n1))
  14037. ((eq prefer 'future) (if (= cday n1) n1 n2))
  14038. (t (if (= cday n1) n1 n2)))))))
  14039. (defun org-date-to-gregorian (date)
  14040. "Turn any specification of DATE into a Gregorian date for the calendar."
  14041. (cond ((integerp date) (calendar-gregorian-from-absolute date))
  14042. ((and (listp date) (= (length date) 3)) date)
  14043. ((stringp date)
  14044. (setq date (org-parse-time-string date))
  14045. (list (nth 4 date) (nth 3 date) (nth 5 date)))
  14046. ((listp date)
  14047. (list (nth 4 date) (nth 3 date) (nth 5 date)))))
  14048. (defun org-parse-time-string (s &optional nodefault)
  14049. "Parse the standard Org-mode time string.
  14050. This should be a lot faster than the normal `parse-time-string'.
  14051. If time is not given, defaults to 0:00. However, with optional NODEFAULT,
  14052. hour and minute fields will be nil if not given."
  14053. (if (string-match org-ts-regexp0 s)
  14054. (list 0
  14055. (if (or (match-beginning 8) (not nodefault))
  14056. (string-to-number (or (match-string 8 s) "0")))
  14057. (if (or (match-beginning 7) (not nodefault))
  14058. (string-to-number (or (match-string 7 s) "0")))
  14059. (string-to-number (match-string 4 s))
  14060. (string-to-number (match-string 3 s))
  14061. (string-to-number (match-string 2 s))
  14062. nil nil nil)
  14063. (error "Not a standard Org-mode time string: %s" s)))
  14064. (defun org-timestamp-up (&optional arg)
  14065. "Increase the date item at the cursor by one.
  14066. If the cursor is on the year, change the year. If it is on the month or
  14067. the day, change that.
  14068. With prefix ARG, change by that many units."
  14069. (interactive "p")
  14070. (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
  14071. (defun org-timestamp-down (&optional arg)
  14072. "Decrease the date item at the cursor by one.
  14073. If the cursor is on the year, change the year. If it is on the month or
  14074. the day, change that.
  14075. With prefix ARG, change by that many units."
  14076. (interactive "p")
  14077. (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
  14078. (defun org-timestamp-up-day (&optional arg)
  14079. "Increase the date in the time stamp by one day.
  14080. With prefix ARG, change that many days."
  14081. (interactive "p")
  14082. (if (and (not (org-at-timestamp-p t))
  14083. (org-on-heading-p))
  14084. (org-todo 'up)
  14085. (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
  14086. (defun org-timestamp-down-day (&optional arg)
  14087. "Decrease the date in the time stamp by one day.
  14088. With prefix ARG, change that many days."
  14089. (interactive "p")
  14090. (if (and (not (org-at-timestamp-p t))
  14091. (org-on-heading-p))
  14092. (org-todo 'down)
  14093. (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
  14094. (defun org-at-timestamp-p (&optional inactive-ok)
  14095. "Determine if the cursor is in or at a timestamp."
  14096. (interactive)
  14097. (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
  14098. (pos (point))
  14099. (ans (or (looking-at tsr)
  14100. (save-excursion
  14101. (skip-chars-backward "^[<\n\r\t")
  14102. (if (> (point) (point-min)) (backward-char 1))
  14103. (and (looking-at tsr)
  14104. (> (- (match-end 0) pos) -1))))))
  14105. (and ans
  14106. (boundp 'org-ts-what)
  14107. (setq org-ts-what
  14108. (cond
  14109. ((= pos (match-beginning 0)) 'bracket)
  14110. ((= pos (1- (match-end 0))) 'bracket)
  14111. ((org-pos-in-match-range pos 2) 'year)
  14112. ((org-pos-in-match-range pos 3) 'month)
  14113. ((org-pos-in-match-range pos 7) 'hour)
  14114. ((org-pos-in-match-range pos 8) 'minute)
  14115. ((or (org-pos-in-match-range pos 4)
  14116. (org-pos-in-match-range pos 5)) 'day)
  14117. ((and (> pos (or (match-end 8) (match-end 5)))
  14118. (< pos (match-end 0)))
  14119. (- pos (or (match-end 8) (match-end 5))))
  14120. (t 'day))))
  14121. ans))
  14122. (defun org-toggle-timestamp-type ()
  14123. "Toggle the type (<active> or [inactive]) of a time stamp."
  14124. (interactive)
  14125. (when (org-at-timestamp-p t)
  14126. (let ((beg (match-beginning 0)) (end (match-end 0))
  14127. (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
  14128. (save-excursion
  14129. (goto-char beg)
  14130. (while (re-search-forward "[][<>]" end t)
  14131. (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
  14132. t t)))
  14133. (message "Timestamp is now %sactive"
  14134. (if (equal (char-after beg) ?<) "" "in")))))
  14135. (defun org-timestamp-change (n &optional what updown)
  14136. "Change the date in the time stamp at point.
  14137. The date will be changed by N times WHAT. WHAT can be `day', `month',
  14138. `year', `minute', `second'. If WHAT is not given, the cursor position
  14139. in the timestamp determines what will be changed."
  14140. (let ((pos (point))
  14141. with-hm inactive
  14142. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  14143. org-ts-what
  14144. extra rem
  14145. ts time time0)
  14146. (if (not (org-at-timestamp-p t))
  14147. (error "Not at a timestamp"))
  14148. (if (and (not what) (eq org-ts-what 'bracket))
  14149. (org-toggle-timestamp-type)
  14150. (if (and (not what) (not (eq org-ts-what 'day))
  14151. org-display-custom-times
  14152. (get-text-property (point) 'display)
  14153. (not (get-text-property (1- (point)) 'display)))
  14154. (setq org-ts-what 'day))
  14155. (setq org-ts-what (or what org-ts-what)
  14156. inactive (= (char-after (match-beginning 0)) ?\[)
  14157. ts (match-string 0))
  14158. (replace-match "")
  14159. (if (string-match
  14160. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?[-+][0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)*\\)[]>]"
  14161. ts)
  14162. (setq extra (match-string 1 ts)))
  14163. (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  14164. (setq with-hm t))
  14165. (setq time0 (org-parse-time-string ts))
  14166. (when (and updown
  14167. (eq org-ts-what 'minute)
  14168. (not current-prefix-arg))
  14169. ;; This looks like s-up and s-down. Change by one rounding step.
  14170. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  14171. (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
  14172. (setcar (cdr time0) (+ (nth 1 time0)
  14173. (if (> n 0) (- rem) (- dm rem))))))
  14174. (setq time
  14175. (encode-time (or (car time0) 0)
  14176. (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
  14177. (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
  14178. (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
  14179. (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
  14180. (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
  14181. (nthcdr 6 time0)))
  14182. (when (and (member org-ts-what '(hour minute))
  14183. extra
  14184. (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
  14185. (setq extra (org-modify-ts-extra
  14186. extra
  14187. (if (eq org-ts-what 'hour) 2 5)
  14188. n dm)))
  14189. (when (integerp org-ts-what)
  14190. (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
  14191. (if (eq what 'calendar)
  14192. (let ((cal-date (org-get-date-from-calendar)))
  14193. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  14194. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  14195. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  14196. (setcar time0 (or (car time0) 0))
  14197. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  14198. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  14199. (setq time (apply 'encode-time time0))))
  14200. (setq org-last-changed-timestamp
  14201. (org-insert-time-stamp time with-hm inactive nil nil extra))
  14202. (org-clock-update-time-maybe)
  14203. (goto-char pos)
  14204. ;; Try to recenter the calendar window, if any
  14205. (if (and org-calendar-follow-timestamp-change
  14206. (get-buffer-window "*Calendar*" t)
  14207. (memq org-ts-what '(day month year)))
  14208. (org-recenter-calendar (time-to-days time))))))
  14209. (defun org-modify-ts-extra (s pos n dm)
  14210. "Change the different parts of the lead-time and repeat fields in timestamp."
  14211. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  14212. ng h m new rem)
  14213. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  14214. (cond
  14215. ((or (org-pos-in-match-range pos 2)
  14216. (org-pos-in-match-range pos 3))
  14217. (setq m (string-to-number (match-string 3 s))
  14218. h (string-to-number (match-string 2 s)))
  14219. (if (org-pos-in-match-range pos 2)
  14220. (setq h (+ h n))
  14221. (setq n (* dm (org-no-warnings (signum n))))
  14222. (when (not (= 0 (setq rem (% m dm))))
  14223. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  14224. (setq m (+ m n)))
  14225. (if (< m 0) (setq m (+ m 60) h (1- h)))
  14226. (if (> m 59) (setq m (- m 60) h (1+ h)))
  14227. (setq h (min 24 (max 0 h)))
  14228. (setq ng 1 new (format "-%02d:%02d" h m)))
  14229. ((org-pos-in-match-range pos 6)
  14230. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  14231. ((org-pos-in-match-range pos 5)
  14232. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  14233. ((org-pos-in-match-range pos 9)
  14234. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  14235. ((org-pos-in-match-range pos 8)
  14236. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  14237. (when ng
  14238. (setq s (concat
  14239. (substring s 0 (match-beginning ng))
  14240. new
  14241. (substring s (match-end ng))))))
  14242. s))
  14243. (defun org-recenter-calendar (date)
  14244. "If the calendar is visible, recenter it to DATE."
  14245. (let* ((win (selected-window))
  14246. (cwin (get-buffer-window "*Calendar*" t))
  14247. (calendar-move-hook nil))
  14248. (when cwin
  14249. (select-window cwin)
  14250. (calendar-goto-date (if (listp date) date
  14251. (calendar-gregorian-from-absolute date)))
  14252. (select-window win))))
  14253. (defun org-goto-calendar (&optional arg)
  14254. "Go to the Emacs calendar at the current date.
  14255. If there is a time stamp in the current line, go to that date.
  14256. A prefix ARG can be used to force the current date."
  14257. (interactive "P")
  14258. (let ((tsr org-ts-regexp) diff
  14259. (calendar-move-hook nil)
  14260. (calendar-view-holidays-initially-flag nil)
  14261. (calendar-view-diary-initially-flag nil))
  14262. (if (or (org-at-timestamp-p)
  14263. (save-excursion
  14264. (beginning-of-line 1)
  14265. (looking-at (concat ".*" tsr))))
  14266. (let ((d1 (time-to-days (current-time)))
  14267. (d2 (time-to-days
  14268. (org-time-string-to-time (match-string 1)))))
  14269. (setq diff (- d2 d1))))
  14270. (calendar)
  14271. (calendar-goto-today)
  14272. (if (and diff (not arg)) (calendar-forward-day diff))))
  14273. (defun org-get-date-from-calendar ()
  14274. "Return a list (month day year) of date at point in calendar."
  14275. (with-current-buffer "*Calendar*"
  14276. (save-match-data
  14277. (calendar-cursor-to-date))))
  14278. (defun org-date-from-calendar ()
  14279. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  14280. If there is already a time stamp at the cursor position, update it."
  14281. (interactive)
  14282. (if (org-at-timestamp-p t)
  14283. (org-timestamp-change 0 'calendar)
  14284. (let ((cal-date (org-get-date-from-calendar)))
  14285. (org-insert-time-stamp
  14286. (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  14287. (defun org-minutes-to-hh:mm-string (m)
  14288. "Compute H:MM from a number of minutes."
  14289. (let ((h (/ m 60)))
  14290. (setq m (- m (* 60 h)))
  14291. (format org-time-clocksum-format h m)))
  14292. (defun org-hh:mm-string-to-minutes (s)
  14293. "Convert a string H:MM to a number of minutes.
  14294. If the string is just a number, interpret it as minutes.
  14295. In fact, the first hh:mm or number in the string will be taken,
  14296. there can be extra stuff in the string.
  14297. If no number is found, the return value is 0."
  14298. (cond
  14299. ((integerp s) s)
  14300. ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  14301. (+ (* (string-to-number (match-string 1 s)) 60)
  14302. (string-to-number (match-string 2 s))))
  14303. ((string-match "\\([0-9]+\\)" s)
  14304. (string-to-number (match-string 1 s)))
  14305. (t 0)))
  14306. (defcustom org-effort-durations
  14307. `(("h" . 60)
  14308. ("d" . ,(* 60 8))
  14309. ("w" . ,(* 60 8 5))
  14310. ("m" . ,(* 60 8 5 4))
  14311. ("y" . ,(* 60 8 5 40)))
  14312. "Conversion factor to minutes for an effort modifier.
  14313. Each entry has the form (MODIFIER . MINUTES).
  14314. In an effort string, a number followed by MODIFIER is multiplied
  14315. by the specified number of MINUTES to obtain an effort in
  14316. minutes.
  14317. For example, if the value of this variable is ((\"hours\" . 60)), then an
  14318. effort string \"2hours\" is equivalent to 120 minutes."
  14319. :group 'org-agenda
  14320. :type '(alist :key-type (string :tag "Modifier")
  14321. :value-type (number :tag "Minutes")))
  14322. (defun org-duration-string-to-minutes (s)
  14323. "Convert a duration string S to minutes.
  14324. A bare number is interpreted as minutes, modifiers can be set by
  14325. customizing `org-effort-durations' (which see).
  14326. Entries containing a colon are interpreted as H:MM by
  14327. `org-hh:mm-string-to-minutes'."
  14328. (let ((result 0)
  14329. (re (concat "\\([0-9]+\\) *\\("
  14330. (regexp-opt (mapcar 'car org-effort-durations))
  14331. "\\)")))
  14332. (while (string-match re s)
  14333. (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
  14334. (string-to-number (match-string 1 s))))
  14335. (setq s (replace-match "" nil t s)))
  14336. (incf result (org-hh:mm-string-to-minutes s))
  14337. result))
  14338. ;;;; Files
  14339. (defun org-save-all-org-buffers ()
  14340. "Save all Org-mode buffers without user confirmation."
  14341. (interactive)
  14342. (message "Saving all Org-mode buffers...")
  14343. (save-some-buffers t 'org-mode-p)
  14344. (when (featurep 'org-id) (org-id-locations-save))
  14345. (message "Saving all Org-mode buffers... done"))
  14346. (defun org-revert-all-org-buffers ()
  14347. "Revert all Org-mode buffers.
  14348. Prompt for confirmation when there are unsaved changes.
  14349. Be sure you know what you are doing before letting this function
  14350. overwrite your changes.
  14351. This function is useful in a setup where one tracks org files
  14352. with a version control system, to revert on one machine after pulling
  14353. changes from another. I believe the procedure must be like this:
  14354. 1. M-x org-save-all-org-buffers
  14355. 2. Pull changes from the other machine, resolve conflicts
  14356. 3. M-x org-revert-all-org-buffers"
  14357. (interactive)
  14358. (unless (yes-or-no-p "Revert all Org buffers from their files? ")
  14359. (error "Abort"))
  14360. (save-excursion
  14361. (save-window-excursion
  14362. (mapc
  14363. (lambda (b)
  14364. (when (and (with-current-buffer b (org-mode-p))
  14365. (with-current-buffer b buffer-file-name))
  14366. (switch-to-buffer b)
  14367. (revert-buffer t 'no-confirm)))
  14368. (buffer-list))
  14369. (when (and (featurep 'org-id) org-id-track-globally)
  14370. (org-id-locations-load)))))
  14371. ;;;; Agenda files
  14372. ;;;###autoload
  14373. (defun org-switchb (&optional arg)
  14374. "Switch between Org buffers.
  14375. With a prefix argument, restrict available to files.
  14376. With two prefix arguments, restrict available buffers to agenda files.
  14377. Defaults to `iswitchb' for buffer name completion.
  14378. Set `org-completion-use-ido' to make it use ido instead."
  14379. (interactive "P")
  14380. (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  14381. ((equal arg '(16)) (org-buffer-list 'agenda))
  14382. (t (org-buffer-list))))
  14383. (org-completion-use-iswitchb org-completion-use-iswitchb)
  14384. (org-completion-use-ido org-completion-use-ido))
  14385. (unless (or org-completion-use-ido org-completion-use-iswitchb)
  14386. (setq org-completion-use-iswitchb t))
  14387. (switch-to-buffer
  14388. (org-icompleting-read "Org buffer: "
  14389. (mapcar 'list (mapcar 'buffer-name blist))
  14390. nil t))))
  14391. ;;; Define some older names previously used for this functionality
  14392. ;;;###autoload
  14393. (defalias 'org-ido-switchb 'org-switchb)
  14394. ;;;###autoload
  14395. (defalias 'org-iswitchb 'org-switchb)
  14396. (defun org-buffer-list (&optional predicate exclude-tmp)
  14397. "Return a list of Org buffers.
  14398. PREDICATE can be `export', `files' or `agenda'.
  14399. export restrict the list to Export buffers.
  14400. files restrict the list to buffers visiting Org files.
  14401. agenda restrict the list to buffers visiting agenda files.
  14402. If EXCLUDE-TMP is non-nil, ignore temporary buffers."
  14403. (let* ((bfn nil)
  14404. (agenda-files (and (eq predicate 'agenda)
  14405. (mapcar 'file-truename (org-agenda-files t))))
  14406. (filter
  14407. (cond
  14408. ((eq predicate 'files)
  14409. (lambda (b) (with-current-buffer b (org-mode-p))))
  14410. ((eq predicate 'export)
  14411. (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
  14412. ((eq predicate 'agenda)
  14413. (lambda (b)
  14414. (with-current-buffer b
  14415. (and (org-mode-p)
  14416. (setq bfn (buffer-file-name b))
  14417. (member (file-truename bfn) agenda-files)))))
  14418. (t (lambda (b) (with-current-buffer b
  14419. (or (org-mode-p)
  14420. (string-match "\*Org .*Export"
  14421. (buffer-name b)))))))))
  14422. (delq nil
  14423. (mapcar
  14424. (lambda(b)
  14425. (if (and (funcall filter b)
  14426. (or (not exclude-tmp)
  14427. (not (string-match "tmp" (buffer-name b)))))
  14428. b
  14429. nil))
  14430. (buffer-list)))))
  14431. (defun org-agenda-files (&optional unrestricted archives)
  14432. "Get the list of agenda files.
  14433. Optional UNRESTRICTED means return the full list even if a restriction
  14434. is currently in place.
  14435. When ARCHIVES is t, include all archive files that are really being
  14436. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  14437. `org-agenda-archives-mode' is t."
  14438. (let ((files
  14439. (cond
  14440. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  14441. ((stringp org-agenda-files) (org-read-agenda-file-list))
  14442. ((listp org-agenda-files) org-agenda-files)
  14443. (t (error "Invalid value of `org-agenda-files'")))))
  14444. (setq files (apply 'append
  14445. (mapcar (lambda (f)
  14446. (if (file-directory-p f)
  14447. (directory-files
  14448. f t org-agenda-file-regexp)
  14449. (list f)))
  14450. files)))
  14451. (when org-agenda-skip-unavailable-files
  14452. (setq files (delq nil
  14453. (mapcar (function
  14454. (lambda (file)
  14455. (and (file-readable-p file) file)))
  14456. files))))
  14457. (when (or (eq archives t)
  14458. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  14459. (setq files (org-add-archive-files files)))
  14460. files))
  14461. (defun org-agenda-file-p (&optional file)
  14462. "Return non-nil, if FILE is an agenda file.
  14463. If FILE is omitted, use the file associated with the current
  14464. buffer."
  14465. (member (or file (buffer-file-name))
  14466. (org-agenda-files t)))
  14467. (defun org-edit-agenda-file-list ()
  14468. "Edit the list of agenda files.
  14469. Depending on setup, this either uses customize to edit the variable
  14470. `org-agenda-files', or it visits the file that is holding the list. In the
  14471. latter case, the buffer is set up in a way that saving it automatically kills
  14472. the buffer and restores the previous window configuration."
  14473. (interactive)
  14474. (if (stringp org-agenda-files)
  14475. (let ((cw (current-window-configuration)))
  14476. (find-file org-agenda-files)
  14477. (org-set-local 'org-window-configuration cw)
  14478. (org-add-hook 'after-save-hook
  14479. (lambda ()
  14480. (set-window-configuration
  14481. (prog1 org-window-configuration
  14482. (kill-buffer (current-buffer))))
  14483. (org-install-agenda-files-menu)
  14484. (message "New agenda file list installed"))
  14485. nil 'local)
  14486. (message "%s" (substitute-command-keys
  14487. "Edit list and finish with \\[save-buffer]")))
  14488. (customize-variable 'org-agenda-files)))
  14489. (defun org-store-new-agenda-file-list (list)
  14490. "Set new value for the agenda file list and save it correctly."
  14491. (if (stringp org-agenda-files)
  14492. (let ((fe (org-read-agenda-file-list t)) b u)
  14493. (while (setq b (find-buffer-visiting org-agenda-files))
  14494. (kill-buffer b))
  14495. (with-temp-file org-agenda-files
  14496. (insert
  14497. (mapconcat
  14498. (lambda (f) ;; Keep un-expanded entries.
  14499. (if (setq u (assoc f fe))
  14500. (cdr u)
  14501. f))
  14502. list "\n")
  14503. "\n")))
  14504. (let ((org-mode-hook nil) (org-inhibit-startup t)
  14505. (org-insert-mode-line-in-empty-file nil))
  14506. (setq org-agenda-files list)
  14507. (customize-save-variable 'org-agenda-files org-agenda-files))))
  14508. (defun org-read-agenda-file-list (&optional pair-with-expansion)
  14509. "Read the list of agenda files from a file.
  14510. If PAIR-WITH-EXPANSION is t return pairs with un-expanded
  14511. filenames, used by `org-store-new-agenda-file-list' to write back
  14512. un-expanded file names."
  14513. (when (file-directory-p org-agenda-files)
  14514. (error "`org-agenda-files' cannot be a single directory"))
  14515. (when (stringp org-agenda-files)
  14516. (with-temp-buffer
  14517. (insert-file-contents org-agenda-files)
  14518. (mapcar
  14519. (lambda (f)
  14520. (let ((e (expand-file-name (substitute-in-file-name f)
  14521. org-directory)))
  14522. (if pair-with-expansion
  14523. (cons e f)
  14524. e)))
  14525. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
  14526. ;;;###autoload
  14527. (defun org-cycle-agenda-files ()
  14528. "Cycle through the files in `org-agenda-files'.
  14529. If the current buffer visits an agenda file, find the next one in the list.
  14530. If the current buffer does not, find the first agenda file."
  14531. (interactive)
  14532. (let* ((fs (org-agenda-files t))
  14533. (files (append fs (list (car fs))))
  14534. (tcf (if buffer-file-name (file-truename buffer-file-name)))
  14535. file)
  14536. (unless files (error "No agenda files"))
  14537. (catch 'exit
  14538. (while (setq file (pop files))
  14539. (if (equal (file-truename file) tcf)
  14540. (when (car files)
  14541. (find-file (car files))
  14542. (throw 'exit t))))
  14543. (find-file (car fs)))
  14544. (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
  14545. (defun org-agenda-file-to-front (&optional to-end)
  14546. "Move/add the current file to the top of the agenda file list.
  14547. If the file is not present in the list, it is added to the front. If it is
  14548. present, it is moved there. With optional argument TO-END, add/move to the
  14549. end of the list."
  14550. (interactive "P")
  14551. (let ((org-agenda-skip-unavailable-files nil)
  14552. (file-alist (mapcar (lambda (x)
  14553. (cons (file-truename x) x))
  14554. (org-agenda-files t)))
  14555. (ctf (file-truename buffer-file-name))
  14556. x had)
  14557. (setq x (assoc ctf file-alist) had x)
  14558. (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  14559. (if to-end
  14560. (setq file-alist (append (delq x file-alist) (list x)))
  14561. (setq file-alist (cons x (delq x file-alist))))
  14562. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  14563. (org-install-agenda-files-menu)
  14564. (message "File %s to %s of agenda file list"
  14565. (if had "moved" "added") (if to-end "end" "front"))))
  14566. (defun org-remove-file (&optional file)
  14567. "Remove current file from the list of files in variable `org-agenda-files'.
  14568. These are the files which are being checked for agenda entries.
  14569. Optional argument FILE means use this file instead of the current."
  14570. (interactive)
  14571. (let* ((org-agenda-skip-unavailable-files nil)
  14572. (file (or file buffer-file-name))
  14573. (true-file (file-truename file))
  14574. (afile (abbreviate-file-name file))
  14575. (files (delq nil (mapcar
  14576. (lambda (x)
  14577. (if (equal true-file
  14578. (file-truename x))
  14579. nil x))
  14580. (org-agenda-files t)))))
  14581. (if (not (= (length files) (length (org-agenda-files t))))
  14582. (progn
  14583. (org-store-new-agenda-file-list files)
  14584. (org-install-agenda-files-menu)
  14585. (message "Removed file: %s" afile))
  14586. (message "File was not in list: %s (not removed)" afile))))
  14587. (defun org-file-menu-entry (file)
  14588. (vector file (list 'find-file file) t))
  14589. (defun org-check-agenda-file (file)
  14590. "Make sure FILE exists. If not, ask user what to do."
  14591. (when (not (file-exists-p file))
  14592. (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
  14593. (abbreviate-file-name file))
  14594. (let ((r (downcase (read-char-exclusive))))
  14595. (cond
  14596. ((equal r ?r)
  14597. (org-remove-file file)
  14598. (throw 'nextfile t))
  14599. (t (error "Abort"))))))
  14600. (defun org-get-agenda-file-buffer (file)
  14601. "Get a buffer visiting FILE. If the buffer needs to be created, add
  14602. it to the list of buffers which might be released later."
  14603. (let ((buf (org-find-base-buffer-visiting file)))
  14604. (if buf
  14605. buf ; just return it
  14606. ;; Make a new buffer and remember it
  14607. (setq buf (find-file-noselect file))
  14608. (if buf (push buf org-agenda-new-buffers))
  14609. buf)))
  14610. (defun org-release-buffers (blist)
  14611. "Release all buffers in list, asking the user for confirmation when needed.
  14612. When a buffer is unmodified, it is just killed. When modified, it is saved
  14613. \(if the user agrees) and then killed."
  14614. (let (buf file)
  14615. (while (setq buf (pop blist))
  14616. (setq file (buffer-file-name buf))
  14617. (when (and (buffer-modified-p buf)
  14618. file
  14619. (y-or-n-p (format "Save file %s? " file)))
  14620. (with-current-buffer buf (save-buffer)))
  14621. (kill-buffer buf))))
  14622. (defun org-prepare-agenda-buffers (files)
  14623. "Create buffers for all agenda files, protect archived trees and comments."
  14624. (interactive)
  14625. (let ((pa '(:org-archived t))
  14626. (pc '(:org-comment t))
  14627. (pall '(:org-archived t :org-comment t))
  14628. (inhibit-read-only t)
  14629. (rea (concat ":" org-archive-tag ":"))
  14630. bmp file re)
  14631. (save-excursion
  14632. (save-restriction
  14633. (while (setq file (pop files))
  14634. (catch 'nextfile
  14635. (if (bufferp file)
  14636. (set-buffer file)
  14637. (org-check-agenda-file file)
  14638. (set-buffer (org-get-agenda-file-buffer file)))
  14639. (widen)
  14640. (setq bmp (buffer-modified-p))
  14641. (org-refresh-category-properties)
  14642. (setq org-todo-keywords-for-agenda
  14643. (append org-todo-keywords-for-agenda org-todo-keywords-1))
  14644. (setq org-done-keywords-for-agenda
  14645. (append org-done-keywords-for-agenda org-done-keywords))
  14646. (setq org-todo-keyword-alist-for-agenda
  14647. (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
  14648. (setq org-drawers-for-agenda
  14649. (append org-drawers-for-agenda org-drawers))
  14650. (setq org-tag-alist-for-agenda
  14651. (append org-tag-alist-for-agenda org-tag-alist))
  14652. (save-excursion
  14653. (remove-text-properties (point-min) (point-max) pall)
  14654. (when org-agenda-skip-archived-trees
  14655. (goto-char (point-min))
  14656. (while (re-search-forward rea nil t)
  14657. (if (org-on-heading-p t)
  14658. (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
  14659. (goto-char (point-min))
  14660. (setq re (concat "^\\*+ +" org-comment-string "\\>"))
  14661. (while (re-search-forward re nil t)
  14662. (add-text-properties
  14663. (match-beginning 0) (org-end-of-subtree t) pc)))
  14664. (set-buffer-modified-p bmp)))))
  14665. (setq org-todo-keywords-for-agenda
  14666. (org-uniquify org-todo-keywords-for-agenda))
  14667. (setq org-todo-keyword-alist-for-agenda
  14668. (org-uniquify org-todo-keyword-alist-for-agenda)
  14669. org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
  14670. ;;;; Embedded LaTeX
  14671. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  14672. "Keymap for the minor `org-cdlatex-mode'.")
  14673. (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
  14674. (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
  14675. (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
  14676. (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
  14677. (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
  14678. (defvar org-cdlatex-texmathp-advice-is-done nil
  14679. "Flag remembering if we have applied the advice to texmathp already.")
  14680. (define-minor-mode org-cdlatex-mode
  14681. "Toggle the minor `org-cdlatex-mode'.
  14682. This mode supports entering LaTeX environment and math in LaTeX fragments
  14683. in Org-mode.
  14684. \\{org-cdlatex-mode-map}"
  14685. nil " OCDL" nil
  14686. (when org-cdlatex-mode (require 'cdlatex))
  14687. (unless org-cdlatex-texmathp-advice-is-done
  14688. (setq org-cdlatex-texmathp-advice-is-done t)
  14689. (defadvice texmathp (around org-math-always-on activate)
  14690. "Always return t in org-mode buffers.
  14691. This is because we want to insert math symbols without dollars even outside
  14692. the LaTeX math segments. If Orgmode thinks that point is actually inside
  14693. an embedded LaTeX fragment, let texmathp do its job.
  14694. \\[org-cdlatex-mode-map]"
  14695. (interactive)
  14696. (let (p)
  14697. (cond
  14698. ((not (org-mode-p)) ad-do-it)
  14699. ((eq this-command 'cdlatex-math-symbol)
  14700. (setq ad-return-value t
  14701. texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
  14702. (t
  14703. (let ((p (org-inside-LaTeX-fragment-p)))
  14704. (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
  14705. (setq ad-return-value t
  14706. texmathp-why '("Org-mode embedded math" . 0))
  14707. (if p ad-do-it)))))))))
  14708. (defun turn-on-org-cdlatex ()
  14709. "Unconditionally turn on `org-cdlatex-mode'."
  14710. (org-cdlatex-mode 1))
  14711. (defun org-inside-LaTeX-fragment-p ()
  14712. "Test if point is inside a LaTeX fragment.
  14713. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  14714. sequence appearing also before point.
  14715. Even though the matchers for math are configurable, this function assumes
  14716. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  14717. delimiters are skipped when they have been removed by customization.
  14718. The return value is nil, or a cons cell with the delimiter and
  14719. and the position of this delimiter.
  14720. This function does a reasonably good job, but can locally be fooled by
  14721. for example currency specifications. For example it will assume being in
  14722. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  14723. fragments that are properly closed, but during editing, we have to live
  14724. with the uncertainty caused by missing closing delimiters. This function
  14725. looks only before point, not after."
  14726. (catch 'exit
  14727. (let ((pos (point))
  14728. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  14729. (lim (progn
  14730. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
  14731. (point)))
  14732. dd-on str (start 0) m re)
  14733. (goto-char pos)
  14734. (when dodollar
  14735. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  14736. re (nth 1 (assoc "$" org-latex-regexps)))
  14737. (while (string-match re str start)
  14738. (cond
  14739. ((= (match-end 0) (length str))
  14740. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  14741. ((= (match-end 0) (- (length str) 5))
  14742. (throw 'exit nil))
  14743. (t (setq start (match-end 0))))))
  14744. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  14745. (goto-char pos)
  14746. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  14747. (and (match-beginning 2) (throw 'exit nil))
  14748. ;; count $$
  14749. (while (re-search-backward "\\$\\$" lim t)
  14750. (setq dd-on (not dd-on)))
  14751. (goto-char pos)
  14752. (if dd-on (cons "$$" m))))))
  14753. (defun org-inside-latex-macro-p ()
  14754. "Is point inside a LaTeX macro or its arguments?"
  14755. (save-match-data
  14756. (org-in-regexp
  14757. "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
  14758. (defun org-try-cdlatex-tab ()
  14759. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  14760. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  14761. - inside a LaTeX fragment, or
  14762. - after the first word in a line, where an abbreviation expansion could
  14763. insert a LaTeX environment."
  14764. (when org-cdlatex-mode
  14765. (cond
  14766. ((save-excursion
  14767. (skip-chars-backward "a-zA-Z0-9*")
  14768. (skip-chars-backward " \t")
  14769. (bolp))
  14770. (cdlatex-tab) t)
  14771. ((org-inside-LaTeX-fragment-p)
  14772. (cdlatex-tab) t)
  14773. (t nil))))
  14774. (defun org-cdlatex-underscore-caret (&optional arg)
  14775. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  14776. Revert to the normal definition outside of these fragments."
  14777. (interactive "P")
  14778. (if (org-inside-LaTeX-fragment-p)
  14779. (call-interactively 'cdlatex-sub-superscript)
  14780. (let (org-cdlatex-mode)
  14781. (call-interactively (key-binding (vector last-input-event))))))
  14782. (defun org-cdlatex-math-modify (&optional arg)
  14783. "Execute `cdlatex-math-modify' in LaTeX fragments.
  14784. Revert to the normal definition outside of these fragments."
  14785. (interactive "P")
  14786. (if (org-inside-LaTeX-fragment-p)
  14787. (call-interactively 'cdlatex-math-modify)
  14788. (let (org-cdlatex-mode)
  14789. (call-interactively (key-binding (vector last-input-event))))))
  14790. (defvar org-latex-fragment-image-overlays nil
  14791. "List of overlays carrying the images of latex fragments.")
  14792. (make-variable-buffer-local 'org-latex-fragment-image-overlays)
  14793. (defun org-remove-latex-fragment-image-overlays ()
  14794. "Remove all overlays with LaTeX fragment images in current buffer."
  14795. (mapc 'delete-overlay org-latex-fragment-image-overlays)
  14796. (setq org-latex-fragment-image-overlays nil))
  14797. (defun org-preview-latex-fragment (&optional subtree)
  14798. "Preview the LaTeX fragment at point, or all locally or globally.
  14799. If the cursor is in a LaTeX fragment, create the image and overlay
  14800. it over the source code. If there is no fragment at point, display
  14801. all fragments in the current text, from one headline to the next. With
  14802. prefix SUBTREE, display all fragments in the current subtree. With a
  14803. double prefix arg \\[universal-argument] \\[universal-argument], or when \
  14804. the cursor is before the first headline,
  14805. display all fragments in the buffer.
  14806. The images can be removed again with \\[org-ctrl-c-ctrl-c]."
  14807. (interactive "P")
  14808. (org-remove-latex-fragment-image-overlays)
  14809. (save-excursion
  14810. (save-restriction
  14811. (let (beg end at msg)
  14812. (cond
  14813. ((or (equal subtree '(16))
  14814. (not (save-excursion
  14815. (re-search-backward (concat "^" outline-regexp) nil t))))
  14816. (setq beg (point-min) end (point-max)
  14817. msg "Creating images for buffer...%s"))
  14818. ((equal subtree '(4))
  14819. (org-back-to-heading)
  14820. (setq beg (point) end (org-end-of-subtree t)
  14821. msg "Creating images for subtree...%s"))
  14822. (t
  14823. (if (setq at (org-inside-LaTeX-fragment-p))
  14824. (goto-char (max (point-min) (- (cdr at) 2)))
  14825. (org-back-to-heading))
  14826. (setq beg (point) end (progn (outline-next-heading) (point))
  14827. msg (if at "Creating image...%s"
  14828. "Creating images for entry...%s"))))
  14829. (message msg "")
  14830. (narrow-to-region beg end)
  14831. (goto-char beg)
  14832. (org-format-latex
  14833. (concat "ltxpng/" (file-name-sans-extension
  14834. (file-name-nondirectory
  14835. buffer-file-name)))
  14836. default-directory 'overlays msg at 'forbuffer 'dvipng)
  14837. (message msg "done. Use `C-c C-c' to remove images.")))))
  14838. (defvar org-latex-regexps
  14839. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  14840. ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
  14841. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  14842. ("$1" "\\([^$]\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  14843. ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  14844. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  14845. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
  14846. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
  14847. "Regular expressions for matching embedded LaTeX.")
  14848. (defvar org-export-have-math nil) ;; dynamic scoping
  14849. (defun org-format-latex (prefix &optional dir overlays msg at
  14850. forbuffer processing-type)
  14851. "Replace LaTeX fragments with links to an image, and produce images.
  14852. Some of the options can be changed using the variable
  14853. `org-format-latex-options'."
  14854. (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  14855. (let* ((prefixnodir (file-name-nondirectory prefix))
  14856. (absprefix (expand-file-name prefix dir))
  14857. (todir (file-name-directory absprefix))
  14858. (opt org-format-latex-options)
  14859. (matchers (plist-get opt :matchers))
  14860. (re-list org-latex-regexps)
  14861. (org-format-latex-header-extra
  14862. (plist-get (org-infile-export-plist) :latex-header-extra))
  14863. (cnt 0) txt hash link beg end re e checkdir
  14864. executables-checked string
  14865. m n block linkfile movefile ov)
  14866. ;; Check the different regular expressions
  14867. (while (setq e (pop re-list))
  14868. (setq m (car e) re (nth 1 e) n (nth 2 e)
  14869. block (if (nth 3 e) "\n\n" ""))
  14870. (when (member m matchers)
  14871. (goto-char (point-min))
  14872. (while (re-search-forward re nil t)
  14873. (when (and (or (not at) (equal (cdr at) (match-beginning n)))
  14874. (not (get-text-property (match-beginning n)
  14875. 'org-protected))
  14876. (or (not overlays)
  14877. (not (eq (get-char-property (match-beginning n)
  14878. 'org-overlay-type)
  14879. 'org-latex-overlay))))
  14880. (setq org-export-have-math t)
  14881. (cond
  14882. ((eq processing-type 'verbatim)
  14883. ;; Leave the text verbatim, just protect it
  14884. (add-text-properties (match-beginning n) (match-end n)
  14885. '(org-protected t)))
  14886. ((eq processing-type 'mathjax)
  14887. ;; Prepare for MathJax processing
  14888. (setq string (match-string n))
  14889. (if (member m '("$" "$1"))
  14890. (save-excursion
  14891. (delete-region (match-beginning n) (match-end n))
  14892. (goto-char (match-beginning n))
  14893. (insert (org-add-props (concat "\\(" (substring string 1 -1)
  14894. "\\)")
  14895. '(org-protected t))))
  14896. (add-text-properties (match-beginning n) (match-end n)
  14897. '(org-protected t))))
  14898. ((or (eq processing-type 'dvipng) t)
  14899. ;; Process to an image
  14900. (setq txt (match-string n)
  14901. beg (match-beginning n) end (match-end n)
  14902. cnt (1+ cnt))
  14903. (let (print-length print-level) ; make sure full list is printed
  14904. (setq hash (sha1 (prin1-to-string
  14905. (list org-format-latex-header
  14906. org-format-latex-header-extra
  14907. org-export-latex-default-packages-alist
  14908. org-export-latex-packages-alist
  14909. org-format-latex-options
  14910. forbuffer txt)))
  14911. linkfile (format "%s_%s.png" prefix hash)
  14912. movefile (format "%s_%s.png" absprefix hash)))
  14913. (setq link (concat block "[[file:" linkfile "]]" block))
  14914. (if msg (message msg cnt))
  14915. (goto-char beg)
  14916. (unless checkdir ; make sure the directory exists
  14917. (setq checkdir t)
  14918. (or (file-directory-p todir) (make-directory todir t)))
  14919. (unless executables-checked
  14920. (org-check-external-command
  14921. "latex" "needed to convert LaTeX fragments to images")
  14922. (org-check-external-command
  14923. "dvipng" "needed to convert LaTeX fragments to images")
  14924. (setq executables-checked t))
  14925. (unless (file-exists-p movefile)
  14926. (org-create-formula-image
  14927. txt movefile opt forbuffer))
  14928. (if overlays
  14929. (progn
  14930. (mapc (lambda (o)
  14931. (if (eq (overlay-get o 'org-overlay-type)
  14932. 'org-latex-overlay)
  14933. (delete-overlay o)))
  14934. (overlays-in beg end))
  14935. (setq ov (make-overlay beg end))
  14936. (overlay-put ov 'org-overlay-type 'org-latex-overlay)
  14937. (if (featurep 'xemacs)
  14938. (progn
  14939. (overlay-put ov 'invisible t)
  14940. (overlay-put
  14941. ov 'end-glyph
  14942. (make-glyph (vector 'png :file movefile))))
  14943. (overlay-put
  14944. ov 'display
  14945. (list 'image :type 'png :file movefile :ascent 'center)))
  14946. (push ov org-latex-fragment-image-overlays)
  14947. (goto-char end))
  14948. (delete-region beg end)
  14949. (insert (org-add-props link
  14950. (list 'org-latex-src
  14951. (replace-regexp-in-string
  14952. "\"" "" txt)))))))))))))
  14953. ;; This function borrows from Ganesh Swami's latex2png.el
  14954. (defun org-create-formula-image (string tofile options buffer)
  14955. "This calls dvipng."
  14956. (require 'org-latex)
  14957. (let* ((tmpdir (if (featurep 'xemacs)
  14958. (temp-directory)
  14959. temporary-file-directory))
  14960. (texfilebase (make-temp-name
  14961. (expand-file-name "orgtex" tmpdir)))
  14962. (texfile (concat texfilebase ".tex"))
  14963. (dvifile (concat texfilebase ".dvi"))
  14964. (pngfile (concat texfilebase ".png"))
  14965. (fnh (if (featurep 'xemacs)
  14966. (font-height (get-face-font 'default))
  14967. (face-attribute 'default :height nil)))
  14968. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  14969. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  14970. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  14971. "Black"))
  14972. (bg (or (plist-get options (if buffer :background :html-background))
  14973. "Transparent")))
  14974. (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
  14975. (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
  14976. (with-temp-file texfile
  14977. (insert (org-splice-latex-header
  14978. org-format-latex-header
  14979. org-export-latex-default-packages-alist
  14980. org-export-latex-packages-alist t
  14981. org-format-latex-header-extra))
  14982. (insert "\n\\begin{document}\n" string "\n\\end{document}\n")
  14983. (require 'org-latex)
  14984. (org-export-latex-fix-inputenc))
  14985. (let ((dir default-directory))
  14986. (condition-case nil
  14987. (progn
  14988. (cd tmpdir)
  14989. (call-process "latex" nil nil nil texfile))
  14990. (error nil))
  14991. (cd dir))
  14992. (if (not (file-exists-p dvifile))
  14993. (progn (message "Failed to create dvi file from %s" texfile) nil)
  14994. (condition-case nil
  14995. (call-process "dvipng" nil nil nil
  14996. "-fg" fg "-bg" bg
  14997. "-D" dpi
  14998. ;;"-x" scale "-y" scale
  14999. "-T" "tight"
  15000. "-o" pngfile
  15001. dvifile)
  15002. (error nil))
  15003. (if (not (file-exists-p pngfile))
  15004. (if org-format-latex-signal-error
  15005. (error "Failed to create png file from %s" texfile)
  15006. (message "Failed to create png file from %s" texfile)
  15007. nil)
  15008. ;; Use the requested file name and clean up
  15009. (copy-file pngfile tofile 'replace)
  15010. (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
  15011. (delete-file (concat texfilebase e)))
  15012. pngfile))))
  15013. (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
  15014. "Fill a LaTeX header template TPL.
  15015. In the template, the following place holders will be recognized:
  15016. [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
  15017. [NO-DEFAULT-PACKAGES] do not include DEF-PKG
  15018. [PACKAGES] \\usepackage statements for PKG
  15019. [NO-PACKAGES] do not include PKG
  15020. [EXTRA] the string EXTRA
  15021. [NO-EXTRA] do not include EXTRA
  15022. For backward compatibility, if both the positive and the negative place
  15023. holder is missing, the positive one (without the \"NO-\") will be
  15024. assumed to be present at the end of the template.
  15025. DEF-PKG and PKG are assumed to be alists of options/packagename lists.
  15026. EXTRA is a string.
  15027. SNIPPETS-P indicates if this is run to create snippet images for HTML."
  15028. (let (rpl (end ""))
  15029. (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
  15030. (setq rpl (if (or (match-end 1) (not def-pkg))
  15031. "" (org-latex-packages-to-string def-pkg snippets-p t))
  15032. tpl (replace-match rpl t t tpl))
  15033. (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
  15034. (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
  15035. (setq rpl (if (or (match-end 1) (not pkg))
  15036. "" (org-latex-packages-to-string pkg snippets-p t))
  15037. tpl (replace-match rpl t t tpl))
  15038. (if pkg (setq end
  15039. (concat end "\n"
  15040. (org-latex-packages-to-string pkg snippets-p)))))
  15041. (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
  15042. (setq rpl (if (or (match-end 1) (not extra))
  15043. "" (concat extra "\n"))
  15044. tpl (replace-match rpl t t tpl))
  15045. (if (and extra (string-match "\\S-" extra))
  15046. (setq end (concat end "\n" extra))))
  15047. (if (string-match "\\S-" end)
  15048. (concat tpl "\n" end)
  15049. tpl)))
  15050. (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
  15051. "Turn an alist of packages into a string with the \\usepackage macros."
  15052. (setq pkg (mapconcat (lambda(p)
  15053. (cond
  15054. ((stringp p) p)
  15055. ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
  15056. (format "%% Package %s omitted" (cadr p)))
  15057. ((equal "" (car p))
  15058. (format "\\usepackage{%s}" (cadr p)))
  15059. (t
  15060. (format "\\usepackage[%s]{%s}"
  15061. (car p) (cadr p)))))
  15062. pkg
  15063. "\n"))
  15064. (if newline (concat pkg "\n") pkg))
  15065. (defun org-dvipng-color (attr)
  15066. "Return an rgb color specification for dvipng."
  15067. (apply 'format "rgb %s %s %s"
  15068. (mapcar 'org-normalize-color
  15069. (color-values (face-attribute 'default attr nil)))))
  15070. (defun org-normalize-color (value)
  15071. "Return string to be used as color value for an RGB component."
  15072. (format "%g" (/ value 65535.0)))
  15073. ;; Image display
  15074. (defvar org-inline-image-overlays nil)
  15075. (make-variable-buffer-local 'org-inline-image-overlays)
  15076. (defun org-toggle-inline-images (&optional include-linked)
  15077. "Toggle the display of inline images.
  15078. INCLUDE-LINKED is passed to `org-display-inline-images'."
  15079. (interactive "P")
  15080. (if org-inline-image-overlays
  15081. (progn
  15082. (org-remove-inline-images)
  15083. (message "Inline image display turned off"))
  15084. (org-display-inline-images include-linked)
  15085. (if org-inline-image-overlays
  15086. (message "%d images displayed inline"
  15087. (length org-inline-image-overlays))
  15088. (message "No images to display inline"))))
  15089. (defun org-display-inline-images (&optional include-linked refresh beg end)
  15090. "Display inline images.
  15091. Normally only links without a description part are inlined, because this
  15092. is how it will work for export. When INCLUDE-LINKED is set, also links
  15093. with a description part will be inlined. This can be nice for a quick
  15094. look at those images, but it does not reflect what exported files will look
  15095. like.
  15096. When REFRESH is set, refresh existing images between BEG and END.
  15097. This will create new image displays only if necessary.
  15098. BEG and END default to the buffer boundaries."
  15099. (interactive "P")
  15100. (unless refresh
  15101. (org-remove-inline-images)
  15102. (if (fboundp 'clear-image-cache) (clear-image-cache)))
  15103. (save-excursion
  15104. (save-restriction
  15105. (widen)
  15106. (setq beg (or beg (point-min)) end (or end (point-max)))
  15107. (goto-char (point-min))
  15108. (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([^]\n]+?"
  15109. (substring (org-image-file-name-regexp) 0 -2)
  15110. "\\)\\]" (if include-linked "" "\\]")))
  15111. old file ov img)
  15112. (while (re-search-forward re end t)
  15113. (setq old (get-char-property-and-overlay (match-beginning 1)
  15114. 'org-image-overlay))
  15115. (setq file (expand-file-name
  15116. (concat (or (match-string 3) "") (match-string 4))))
  15117. (when (file-exists-p file)
  15118. (if (and (car-safe old) refresh)
  15119. (image-refresh (overlay-get (cdr old) 'display))
  15120. (setq img (save-match-data (create-image file)))
  15121. (when img
  15122. (setq ov (make-overlay (match-beginning 0) (match-end 0)))
  15123. (overlay-put ov 'display img)
  15124. (overlay-put ov 'face 'default)
  15125. (overlay-put ov 'org-image-overlay t)
  15126. (overlay-put ov 'modification-hooks
  15127. (list 'org-display-inline-modification-hook))
  15128. (push ov org-inline-image-overlays)))))))))
  15129. (defun org-display-inline-modification-hook (ov after beg end &optional len)
  15130. "Remove inline-display overlay if a corresponding region is modified."
  15131. (let ((inhibit-modification-hooks t))
  15132. (when (and ov after)
  15133. (delete ov org-inline-image-overlays)
  15134. (delete-overlay ov))))
  15135. (defun org-remove-inline-images ()
  15136. "Remove inline display of images."
  15137. (interactive)
  15138. (mapc 'delete-overlay org-inline-image-overlays)
  15139. (setq org-inline-image-overlays nil))
  15140. ;;;; Key bindings
  15141. ;; Make `C-c C-x' a prefix key
  15142. (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
  15143. ;; TAB key with modifiers
  15144. (org-defkey org-mode-map "\C-i" 'org-cycle)
  15145. (org-defkey org-mode-map [(tab)] 'org-cycle)
  15146. (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
  15147. (org-defkey org-mode-map [(meta tab)] 'pcomplete)
  15148. (org-defkey org-mode-map "\M-\t" 'pcomplete)
  15149. (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
  15150. ;; The following line is necessary under Suse GNU/Linux
  15151. (unless (featurep 'xemacs)
  15152. (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
  15153. (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
  15154. (define-key org-mode-map [backtab] 'org-shifttab)
  15155. (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
  15156. (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
  15157. (org-defkey org-mode-map [(meta return)] 'org-meta-return)
  15158. ;; Cursor keys with modifiers
  15159. (org-defkey org-mode-map [(meta left)] 'org-metaleft)
  15160. (org-defkey org-mode-map [(meta right)] 'org-metaright)
  15161. (org-defkey org-mode-map [(meta up)] 'org-metaup)
  15162. (org-defkey org-mode-map [(meta down)] 'org-metadown)
  15163. (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
  15164. (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
  15165. (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
  15166. (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
  15167. (org-defkey org-mode-map [(shift up)] 'org-shiftup)
  15168. (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
  15169. (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
  15170. (org-defkey org-mode-map [(shift right)] 'org-shiftright)
  15171. (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
  15172. (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
  15173. ;; Babel keys
  15174. (define-key org-mode-map org-babel-key-prefix org-babel-map)
  15175. (mapc (lambda (pair)
  15176. (define-key org-babel-map (car pair) (cdr pair)))
  15177. org-babel-key-bindings)
  15178. ;;; Extra keys for tty access.
  15179. ;; We only set them when really needed because otherwise the
  15180. ;; menus don't show the simple keys
  15181. (when (or org-use-extra-keys
  15182. (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
  15183. (not window-system))
  15184. (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
  15185. (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
  15186. (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
  15187. (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
  15188. (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
  15189. (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
  15190. (org-defkey org-mode-map [?\e (right)] 'org-metaright)
  15191. (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
  15192. (org-defkey org-mode-map [?\e (up)] 'org-metaup)
  15193. (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
  15194. (org-defkey org-mode-map [?\e (down)] 'org-metadown)
  15195. (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
  15196. (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
  15197. (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
  15198. (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
  15199. (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
  15200. (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
  15201. (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
  15202. (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
  15203. (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
  15204. (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
  15205. (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
  15206. (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
  15207. (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
  15208. (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
  15209. (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
  15210. (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
  15211. (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
  15212. ;; All the other keys
  15213. (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
  15214. (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
  15215. (if (boundp 'narrow-map)
  15216. (org-defkey narrow-map "s" 'org-narrow-to-subtree)
  15217. (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
  15218. (if (boundp 'narrow-map)
  15219. (org-defkey narrow-map "b" 'org-narrow-to-block)
  15220. (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
  15221. (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
  15222. (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
  15223. (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
  15224. (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
  15225. (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
  15226. (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
  15227. (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
  15228. (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
  15229. (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
  15230. (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
  15231. (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
  15232. (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
  15233. (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
  15234. (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
  15235. (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
  15236. (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
  15237. (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
  15238. (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
  15239. (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
  15240. (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
  15241. (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
  15242. (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
  15243. (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
  15244. (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
  15245. (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
  15246. (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
  15247. (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
  15248. (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
  15249. (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
  15250. (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
  15251. (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
  15252. (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
  15253. (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
  15254. (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
  15255. (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
  15256. (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
  15257. (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
  15258. (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
  15259. (org-defkey org-mode-map "\C-c]" 'org-remove-file)
  15260. (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
  15261. (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  15262. (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
  15263. (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
  15264. (org-defkey org-mode-map "\C-c^" 'org-sort)
  15265. (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
  15266. (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
  15267. (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
  15268. (org-defkey org-mode-map "\C-m" 'org-return)
  15269. (org-defkey org-mode-map "\C-j" 'org-return-indent)
  15270. (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
  15271. (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
  15272. (org-defkey org-mode-map "\C-c+" 'org-table-sum)
  15273. (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
  15274. (org-defkey org-mode-map "\C-c'" 'org-edit-special)
  15275. (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
  15276. (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
  15277. (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
  15278. (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
  15279. (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
  15280. (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
  15281. (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
  15282. (org-defkey org-mode-map "\C-c\C-e" 'org-export)
  15283. (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
  15284. (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
  15285. (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
  15286. (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  15287. (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  15288. (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
  15289. (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
  15290. ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
  15291. (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
  15292. (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
  15293. (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
  15294. (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
  15295. (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
  15296. (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
  15297. (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
  15298. (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  15299. (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
  15300. (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
  15301. (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
  15302. (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
  15303. (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
  15304. (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
  15305. (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
  15306. (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
  15307. (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
  15308. (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
  15309. (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
  15310. (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
  15311. (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
  15312. (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
  15313. (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
  15314. (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
  15315. (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
  15316. (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
  15317. (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
  15318. (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
  15319. (define-key org-mode-map "\C-c\C-x!" 'org-reload)
  15320. (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
  15321. (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
  15322. (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
  15323. (when (featurep 'xemacs)
  15324. (org-defkey org-mode-map 'button3 'popup-mode-menu))
  15325. (defconst org-speed-commands-default
  15326. '(
  15327. ("Outline Navigation")
  15328. ("n" . (org-speed-move-safe 'outline-next-visible-heading))
  15329. ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
  15330. ("f" . (org-speed-move-safe 'org-forward-same-level))
  15331. ("b" . (org-speed-move-safe 'org-backward-same-level))
  15332. ("u" . (org-speed-move-safe 'outline-up-heading))
  15333. ("j" . org-goto)
  15334. ("g" . (org-refile t))
  15335. ("Outline Visibility")
  15336. ("c" . org-cycle)
  15337. ("C" . org-shifttab)
  15338. (" " . org-display-outline-path)
  15339. ("Outline Structure Editing")
  15340. ("U" . org-shiftmetaup)
  15341. ("D" . org-shiftmetadown)
  15342. ("r" . org-metaright)
  15343. ("l" . org-metaleft)
  15344. ("R" . org-shiftmetaright)
  15345. ("L" . org-shiftmetaleft)
  15346. ("i" . (progn (forward-char 1) (call-interactively
  15347. 'org-insert-heading-respect-content)))
  15348. ("^" . org-sort)
  15349. ("w" . org-refile)
  15350. ("a" . org-archive-subtree-default-with-confirmation)
  15351. ("." . org-mark-subtree)
  15352. ("Clock Commands")
  15353. ("I" . org-clock-in)
  15354. ("O" . org-clock-out)
  15355. ("Meta Data Editing")
  15356. ("t" . org-todo)
  15357. ("0" . (org-priority ?\ ))
  15358. ("1" . (org-priority ?A))
  15359. ("2" . (org-priority ?B))
  15360. ("3" . (org-priority ?C))
  15361. (";" . org-set-tags-command)
  15362. ("e" . org-set-effort)
  15363. ("Agenda Views etc")
  15364. ("v" . org-agenda)
  15365. ("/" . org-sparse-tree)
  15366. ("Misc")
  15367. ("o" . org-open-at-point)
  15368. ("?" . org-speed-command-help)
  15369. ("<" . (org-agenda-set-restriction-lock 'subtree))
  15370. (">" . (org-agenda-remove-restriction-lock))
  15371. )
  15372. "The default speed commands.")
  15373. (defun org-print-speed-command (e)
  15374. (if (> (length (car e)) 1)
  15375. (progn
  15376. (princ "\n")
  15377. (princ (car e))
  15378. (princ "\n")
  15379. (princ (make-string (length (car e)) ?-))
  15380. (princ "\n"))
  15381. (princ (car e))
  15382. (princ " ")
  15383. (if (symbolp (cdr e))
  15384. (princ (symbol-name (cdr e)))
  15385. (prin1 (cdr e)))
  15386. (princ "\n")))
  15387. (defun org-speed-command-help ()
  15388. "Show the available speed commands."
  15389. (interactive)
  15390. (if (not org-use-speed-commands)
  15391. (error "Speed commands are not activated, customize `org-use-speed-commands'")
  15392. (with-output-to-temp-buffer "*Help*"
  15393. (princ "User-defined Speed commands\n===========================\n")
  15394. (mapc 'org-print-speed-command org-speed-commands-user)
  15395. (princ "\n")
  15396. (princ "Built-in Speed commands\n=======================\n")
  15397. (mapc 'org-print-speed-command org-speed-commands-default))
  15398. (with-current-buffer "*Help*"
  15399. (setq truncate-lines t))))
  15400. (defun org-speed-move-safe (cmd)
  15401. "Execute CMD, but make sure that the cursor always ends up in a headline.
  15402. If not, return to the original position and throw an error."
  15403. (interactive)
  15404. (let ((pos (point)))
  15405. (call-interactively cmd)
  15406. (unless (and (bolp) (org-on-heading-p))
  15407. (goto-char pos)
  15408. (error "Boundary reached while executing %s" cmd))))
  15409. (defvar org-self-insert-command-undo-counter 0)
  15410. (defvar org-table-auto-blank-field) ; defined in org-table.el
  15411. (defvar org-speed-command nil)
  15412. (defun org-speed-command-default-hook (keys)
  15413. "Hook for activating single-letter speed commands.
  15414. `org-speed-commands-default' specifies a minimal command set. Use
  15415. `org-speed-commands-user' for further customization."
  15416. (when (or (and (bolp) (looking-at outline-regexp))
  15417. (and (functionp org-use-speed-commands)
  15418. (funcall org-use-speed-commands)))
  15419. (cdr (assoc keys (append org-speed-commands-user
  15420. org-speed-commands-default)))))
  15421. (defun org-babel-speed-command-hook (keys)
  15422. "Hook for activating single-letter code block commands."
  15423. (when (and (bolp) (looking-at org-babel-src-block-regexp))
  15424. (cdr (assoc keys org-babel-key-bindings))))
  15425. (defcustom org-speed-command-hook
  15426. '(org-speed-command-default-hook org-babel-speed-command-hook)
  15427. "Hook for activating speed commands at strategic locations.
  15428. Hook functions are called in sequence until a valid handler is
  15429. found.
  15430. Each hook takes a single argument, a user-pressed command key
  15431. which is also a `self-insert-command' from the global map.
  15432. Within the hook, examine the cursor position and the command key
  15433. and return nil or a valid handler as appropriate. Handler could
  15434. be one of an interactive command, a function, or a form.
  15435. Set `org-use-speed-commands' to non-nil value to enable this
  15436. hook. The default setting is `org-speed-command-default-hook'."
  15437. :group 'org-structure
  15438. :type 'hook)
  15439. (defun org-self-insert-command (N)
  15440. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  15441. If the cursor is in a table looking at whitespace, the whitespace is
  15442. overwritten, and the table is not marked as requiring realignment."
  15443. (interactive "p")
  15444. (cond
  15445. ((and org-use-speed-commands
  15446. (setq org-speed-command
  15447. (run-hook-with-args-until-success
  15448. 'org-speed-command-hook (this-command-keys))))
  15449. (cond
  15450. ((commandp org-speed-command)
  15451. (setq this-command org-speed-command)
  15452. (call-interactively org-speed-command))
  15453. ((functionp org-speed-command)
  15454. (funcall org-speed-command))
  15455. ((and org-speed-command (listp org-speed-command))
  15456. (eval org-speed-command))
  15457. (t (let (org-use-speed-commands)
  15458. (call-interactively 'org-self-insert-command)))))
  15459. ((and
  15460. (org-table-p)
  15461. (progn
  15462. ;; check if we blank the field, and if that triggers align
  15463. (and (featurep 'org-table) org-table-auto-blank-field
  15464. (member last-command
  15465. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
  15466. (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
  15467. ;; got extra space, this field does not determine column width
  15468. (let (org-table-may-need-update) (org-table-blank-field))
  15469. ;; no extra space, this field may determine column width
  15470. (org-table-blank-field)))
  15471. t)
  15472. (eq N 1)
  15473. (looking-at "[^|\n]* |"))
  15474. (let (org-table-may-need-update)
  15475. (goto-char (1- (match-end 0)))
  15476. (delete-backward-char 1)
  15477. (goto-char (match-beginning 0))
  15478. (self-insert-command N)))
  15479. (t
  15480. (setq org-table-may-need-update t)
  15481. (self-insert-command N)
  15482. (org-fix-tags-on-the-fly)
  15483. (if org-self-insert-cluster-for-undo
  15484. (if (not (eq last-command 'org-self-insert-command))
  15485. (setq org-self-insert-command-undo-counter 1)
  15486. (if (>= org-self-insert-command-undo-counter 20)
  15487. (setq org-self-insert-command-undo-counter 1)
  15488. (and (> org-self-insert-command-undo-counter 0)
  15489. buffer-undo-list
  15490. (not (cadr buffer-undo-list)) ; remove nil entry
  15491. (setcdr buffer-undo-list (cddr buffer-undo-list)))
  15492. (setq org-self-insert-command-undo-counter
  15493. (1+ org-self-insert-command-undo-counter))))))))
  15494. (defun org-fix-tags-on-the-fly ()
  15495. (when (and (equal (char-after (point-at-bol)) ?*)
  15496. (org-on-heading-p))
  15497. (org-align-tags-here org-tags-column)))
  15498. (defun org-delete-backward-char (N)
  15499. "Like `delete-backward-char', insert whitespace at field end in tables.
  15500. When deleting backwards, in tables this function will insert whitespace in
  15501. front of the next \"|\" separator, to keep the table aligned. The table will
  15502. still be marked for re-alignment if the field did fill the entire column,
  15503. because, in this case the deletion might narrow the column."
  15504. (interactive "p")
  15505. (if (and (org-table-p)
  15506. (eq N 1)
  15507. (string-match "|" (buffer-substring (point-at-bol) (point)))
  15508. (looking-at ".*?|"))
  15509. (let ((pos (point))
  15510. (noalign (looking-at "[^|\n\r]* |"))
  15511. (c org-table-may-need-update))
  15512. (backward-delete-char N)
  15513. (if (not overwrite-mode)
  15514. (progn
  15515. (skip-chars-forward "^|")
  15516. (insert " ")
  15517. (goto-char (1- pos))))
  15518. ;; noalign: if there were two spaces at the end, this field
  15519. ;; does not determine the width of the column.
  15520. (if noalign (setq org-table-may-need-update c)))
  15521. (backward-delete-char N)
  15522. (org-fix-tags-on-the-fly)))
  15523. (defun org-delete-char (N)
  15524. "Like `delete-char', but insert whitespace at field end in tables.
  15525. When deleting characters, in tables this function will insert whitespace in
  15526. front of the next \"|\" separator, to keep the table aligned. The table will
  15527. still be marked for re-alignment if the field did fill the entire column,
  15528. because, in this case the deletion might narrow the column."
  15529. (interactive "p")
  15530. (if (and (org-table-p)
  15531. (not (bolp))
  15532. (not (= (char-after) ?|))
  15533. (eq N 1))
  15534. (if (looking-at ".*?|")
  15535. (let ((pos (point))
  15536. (noalign (looking-at "[^|\n\r]* |"))
  15537. (c org-table-may-need-update))
  15538. (replace-match (concat
  15539. (substring (match-string 0) 1 -1)
  15540. " |"))
  15541. (goto-char pos)
  15542. ;; noalign: if there were two spaces at the end, this field
  15543. ;; does not determine the width of the column.
  15544. (if noalign (setq org-table-may-need-update c)))
  15545. (delete-char N))
  15546. (delete-char N)
  15547. (org-fix-tags-on-the-fly)))
  15548. ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
  15549. (put 'org-self-insert-command 'delete-selection t)
  15550. (put 'orgtbl-self-insert-command 'delete-selection t)
  15551. (put 'org-delete-char 'delete-selection 'supersede)
  15552. (put 'org-delete-backward-char 'delete-selection 'supersede)
  15553. (put 'org-yank 'delete-selection 'yank)
  15554. ;; Make `flyspell-mode' delay after some commands
  15555. (put 'org-self-insert-command 'flyspell-delayed t)
  15556. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  15557. (put 'org-delete-char 'flyspell-delayed t)
  15558. (put 'org-delete-backward-char 'flyspell-delayed t)
  15559. ;; Make pabbrev-mode expand after org-mode commands
  15560. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  15561. (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
  15562. ;; How to do this: Measure non-white length of current string
  15563. ;; If equal to column width, we should realign.
  15564. (defun org-remap (map &rest commands)
  15565. "In MAP, remap the functions given in COMMANDS.
  15566. COMMANDS is a list of alternating OLDDEF NEWDEF command names."
  15567. (let (new old)
  15568. (while commands
  15569. (setq old (pop commands) new (pop commands))
  15570. (if (fboundp 'command-remapping)
  15571. (org-defkey map (vector 'remap old) new)
  15572. (substitute-key-definition old new map global-map)))))
  15573. (when (eq org-enable-table-editor 'optimized)
  15574. ;; If the user wants maximum table support, we need to hijack
  15575. ;; some standard editing functions
  15576. (org-remap org-mode-map
  15577. 'self-insert-command 'org-self-insert-command
  15578. 'delete-char 'org-delete-char
  15579. 'delete-backward-char 'org-delete-backward-char)
  15580. (org-defkey org-mode-map "|" 'org-force-self-insert))
  15581. (defvar org-ctrl-c-ctrl-c-hook nil
  15582. "Hook for functions attaching themselves to `C-c C-c'.
  15583. This can be used to add additional functionality to the C-c C-c key which
  15584. executes context-dependent commands.
  15585. Each function will be called with no arguments. The function must check
  15586. if the context is appropriate for it to act. If yes, it should do its
  15587. thing and then return a non-nil value. If the context is wrong,
  15588. just do nothing and return nil.")
  15589. (defvar org-tab-first-hook nil
  15590. "Hook for functions to attach themselves to TAB.
  15591. See `org-ctrl-c-ctrl-c-hook' for more information.
  15592. This hook runs as the first action when TAB is pressed, even before
  15593. `org-cycle' messes around with the `outline-regexp' to cater for
  15594. inline tasks and plain list item folding.
  15595. If any function in this hook returns t, any other actions that
  15596. would have been caused by TAB (such as table field motion or visibility
  15597. cycling) will not occur.")
  15598. (defvar org-tab-after-check-for-table-hook nil
  15599. "Hook for functions to attach themselves to TAB.
  15600. See `org-ctrl-c-ctrl-c-hook' for more information.
  15601. This hook runs after it has been established that the cursor is not in a
  15602. table, but before checking if the cursor is in a headline or if global cycling
  15603. should be done.
  15604. If any function in this hook returns t, not other actions like visibility
  15605. cycling will be done.")
  15606. (defvar org-tab-after-check-for-cycling-hook nil
  15607. "Hook for functions to attach themselves to TAB.
  15608. See `org-ctrl-c-ctrl-c-hook' for more information.
  15609. This hook runs after it has been established that not table field motion and
  15610. not visibility should be done because of current context. This is probably
  15611. the place where a package like yasnippets can hook in.")
  15612. (defvar org-tab-before-tab-emulation-hook nil
  15613. "Hook for functions to attach themselves to TAB.
  15614. See `org-ctrl-c-ctrl-c-hook' for more information.
  15615. This hook runs after every other options for TAB have been exhausted, but
  15616. before indentation and \t insertion takes place.")
  15617. (defvar org-metaleft-hook nil
  15618. "Hook for functions attaching themselves to `M-left'.
  15619. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15620. (defvar org-metaright-hook nil
  15621. "Hook for functions attaching themselves to `M-right'.
  15622. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15623. (defvar org-metaup-hook nil
  15624. "Hook for functions attaching themselves to `M-up'.
  15625. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15626. (defvar org-metadown-hook nil
  15627. "Hook for functions attaching themselves to `M-down'.
  15628. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15629. (defvar org-shiftmetaleft-hook nil
  15630. "Hook for functions attaching themselves to `M-S-left'.
  15631. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15632. (defvar org-shiftmetaright-hook nil
  15633. "Hook for functions attaching themselves to `M-S-right'.
  15634. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15635. (defvar org-shiftmetaup-hook nil
  15636. "Hook for functions attaching themselves to `M-S-up'.
  15637. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15638. (defvar org-shiftmetadown-hook nil
  15639. "Hook for functions attaching themselves to `M-S-down'.
  15640. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15641. (defvar org-metareturn-hook nil
  15642. "Hook for functions attaching themselves to `M-RET'.
  15643. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15644. (defvar org-shiftup-hook nil
  15645. "Hook for functions attaching themselves to `S-up'.
  15646. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15647. (defvar org-shiftup-final-hook nil
  15648. "Hook for functions attaching themselves to `S-up'.
  15649. This one runs after all other options except shift-select have been excluded.
  15650. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15651. (defvar org-shiftdown-hook nil
  15652. "Hook for functions attaching themselves to `S-down'.
  15653. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15654. (defvar org-shiftdown-final-hook nil
  15655. "Hook for functions attaching themselves to `S-down'.
  15656. This one runs after all other options except shift-select have been excluded.
  15657. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15658. (defvar org-shiftleft-hook nil
  15659. "Hook for functions attaching themselves to `S-left'.
  15660. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15661. (defvar org-shiftleft-final-hook nil
  15662. "Hook for functions attaching themselves to `S-left'.
  15663. This one runs after all other options except shift-select have been excluded.
  15664. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15665. (defvar org-shiftright-hook nil
  15666. "Hook for functions attaching themselves to `S-right'.
  15667. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15668. (defvar org-shiftright-final-hook nil
  15669. "Hook for functions attaching themselves to `S-right'.
  15670. This one runs after all other options except shift-select have been excluded.
  15671. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15672. (defun org-modifier-cursor-error ()
  15673. "Throw an error, a modified cursor command was applied in wrong context."
  15674. (error "This command is active in special context like tables, headlines or items"))
  15675. (defun org-shiftselect-error ()
  15676. "Throw an error because Shift-Cursor command was applied in wrong context."
  15677. (if (and (boundp 'shift-select-mode) shift-select-mode)
  15678. (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
  15679. (error "This command works only in special context like headlines or timestamps")))
  15680. (defun org-call-for-shift-select (cmd)
  15681. (let ((this-command-keys-shift-translated t))
  15682. (call-interactively cmd)))
  15683. (defun org-shifttab (&optional arg)
  15684. "Global visibility cycling or move to previous table field.
  15685. Calls `org-cycle' with argument t, or `org-table-previous-field', depending
  15686. on context.
  15687. See the individual commands for more information."
  15688. (interactive "P")
  15689. (cond
  15690. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  15691. ((integerp arg)
  15692. (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
  15693. (message "Content view to level: %d" arg)
  15694. (org-content (prefix-numeric-value arg2))
  15695. (setq org-cycle-global-status 'overview)))
  15696. (t (call-interactively 'org-global-cycle))))
  15697. (defun org-shiftmetaleft ()
  15698. "Promote subtree or delete table column.
  15699. Calls `org-promote-subtree', `org-outdent-item',
  15700. or `org-table-delete-column', depending on context.
  15701. See the individual commands for more information."
  15702. (interactive)
  15703. (cond
  15704. ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
  15705. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  15706. ((org-on-heading-p) (call-interactively 'org-promote-subtree))
  15707. ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
  15708. (t (org-modifier-cursor-error))))
  15709. (defun org-shiftmetaright ()
  15710. "Demote subtree or insert table column.
  15711. Calls `org-demote-subtree', `org-indent-item',
  15712. or `org-table-insert-column', depending on context.
  15713. See the individual commands for more information."
  15714. (interactive)
  15715. (cond
  15716. ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
  15717. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  15718. ((org-on-heading-p) (call-interactively 'org-demote-subtree))
  15719. ((org-at-item-p) (call-interactively 'org-indent-item-tree))
  15720. (t (org-modifier-cursor-error))))
  15721. (defun org-shiftmetaup (&optional arg)
  15722. "Move subtree up or kill table row.
  15723. Calls `org-move-subtree-up' or `org-table-kill-row' or
  15724. `org-move-item-up' depending on context. See the individual commands
  15725. for more information."
  15726. (interactive "P")
  15727. (cond
  15728. ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
  15729. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  15730. ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
  15731. ((org-at-item-p) (call-interactively 'org-move-item-up))
  15732. (t (org-modifier-cursor-error))))
  15733. (defun org-shiftmetadown (&optional arg)
  15734. "Move subtree down or insert table row.
  15735. Calls `org-move-subtree-down' or `org-table-insert-row' or
  15736. `org-move-item-down', depending on context. See the individual
  15737. commands for more information."
  15738. (interactive "P")
  15739. (cond
  15740. ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
  15741. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  15742. ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
  15743. ((org-at-item-p) (call-interactively 'org-move-item-down))
  15744. (t (org-modifier-cursor-error))))
  15745. (defsubst org-hidden-tree-error ()
  15746. (error
  15747. "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
  15748. (defun org-metaleft (&optional arg)
  15749. "Promote heading or move table column to left.
  15750. Calls `org-do-promote' or `org-table-move-column', depending on context.
  15751. With no specific context, calls the Emacs default `backward-word'.
  15752. See the individual commands for more information."
  15753. (interactive "P")
  15754. (cond
  15755. ((run-hook-with-args-until-success 'org-metaleft-hook))
  15756. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  15757. ((org-with-limited-levels
  15758. (or (org-on-heading-p)
  15759. (and (org-region-active-p)
  15760. (save-excursion
  15761. (goto-char (region-beginning))
  15762. (org-on-heading-p)))))
  15763. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  15764. (call-interactively 'org-do-promote))
  15765. ;; At an inline task.
  15766. ((org-on-heading-p)
  15767. (call-interactively 'org-inlinetask-promote))
  15768. ((or (org-at-item-p)
  15769. (and (org-region-active-p)
  15770. (save-excursion
  15771. (goto-char (region-beginning))
  15772. (org-at-item-p))))
  15773. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  15774. (call-interactively 'org-outdent-item))
  15775. (t (call-interactively 'backward-word))))
  15776. (defun org-metaright (&optional arg)
  15777. "Demote subtree or move table column to right.
  15778. Calls `org-do-demote' or `org-table-move-column', depending on context.
  15779. With no specific context, calls the Emacs default `forward-word'.
  15780. See the individual commands for more information."
  15781. (interactive "P")
  15782. (cond
  15783. ((run-hook-with-args-until-success 'org-metaright-hook))
  15784. ((org-at-table-p) (call-interactively 'org-table-move-column))
  15785. ((org-with-limited-levels
  15786. (or (org-on-heading-p)
  15787. (and (org-region-active-p)
  15788. (save-excursion
  15789. (goto-char (region-beginning))
  15790. (org-on-heading-p)))))
  15791. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  15792. (call-interactively 'org-do-demote))
  15793. ;; At an inline task.
  15794. ((org-on-heading-p)
  15795. (call-interactively 'org-inlinetask-demote))
  15796. ((or (org-at-item-p)
  15797. (and (org-region-active-p)
  15798. (save-excursion
  15799. (goto-char (region-beginning))
  15800. (org-at-item-p))))
  15801. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  15802. (call-interactively 'org-indent-item))
  15803. (t (call-interactively 'forward-word))))
  15804. (defun org-check-for-hidden (what)
  15805. "Check if there are hidden headlines/items in the current visual line.
  15806. WHAT can be either `headlines' or `items'. If the current line is
  15807. an outline or item heading and it has a folded subtree below it,
  15808. this function returns t, nil otherwise."
  15809. (let ((re (cond
  15810. ((eq what 'headlines) (concat "^" org-outline-regexp))
  15811. ((eq what 'items) (org-item-beginning-re))
  15812. (t (error "This should not happen"))))
  15813. beg end)
  15814. (save-excursion
  15815. (catch 'exit
  15816. (unless (org-region-active-p)
  15817. (setq beg (point-at-bol))
  15818. (beginning-of-line 2)
  15819. (while (and (not (eobp)) ;; this is like `next-line'
  15820. (get-char-property (1- (point)) 'invisible))
  15821. (beginning-of-line 2))
  15822. (setq end (point))
  15823. (goto-char beg)
  15824. (goto-char (point-at-eol))
  15825. (setq end (max end (point)))
  15826. (while (re-search-forward re end t)
  15827. (if (get-char-property (match-beginning 0) 'invisible)
  15828. (throw 'exit t))))
  15829. nil))))
  15830. (defun org-metaup (&optional arg)
  15831. "Move subtree up or move table row up.
  15832. Calls `org-move-subtree-up' or `org-table-move-row' or
  15833. `org-move-item-up', depending on context. See the individual commands
  15834. for more information."
  15835. (interactive "P")
  15836. (cond
  15837. ((run-hook-with-args-until-success 'org-metaup-hook))
  15838. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  15839. ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
  15840. ((org-at-item-p) (call-interactively 'org-move-item-up))
  15841. (t (transpose-lines 1) (beginning-of-line -1))))
  15842. (defun org-metadown (&optional arg)
  15843. "Move subtree down or move table row down.
  15844. Calls `org-move-subtree-down' or `org-table-move-row' or
  15845. `org-move-item-down', depending on context. See the individual
  15846. commands for more information."
  15847. (interactive "P")
  15848. (cond
  15849. ((run-hook-with-args-until-success 'org-metadown-hook))
  15850. ((org-at-table-p) (call-interactively 'org-table-move-row))
  15851. ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
  15852. ((org-at-item-p) (call-interactively 'org-move-item-down))
  15853. (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
  15854. (defun org-shiftup (&optional arg)
  15855. "Increase item in timestamp or increase priority of current headline.
  15856. Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
  15857. depending on context. See the individual commands for more information."
  15858. (interactive "P")
  15859. (cond
  15860. ((run-hook-with-args-until-success 'org-shiftup-hook))
  15861. ((and org-support-shift-select (org-region-active-p))
  15862. (org-call-for-shift-select 'previous-line))
  15863. ((org-at-timestamp-p t)
  15864. (call-interactively (if org-edit-timestamp-down-means-later
  15865. 'org-timestamp-down 'org-timestamp-up)))
  15866. ((and (not (eq org-support-shift-select 'always))
  15867. org-enable-priority-commands
  15868. (org-on-heading-p))
  15869. (call-interactively 'org-priority-up))
  15870. ((and (not org-support-shift-select) (org-at-item-p))
  15871. (call-interactively 'org-previous-item))
  15872. ((org-clocktable-try-shift 'up arg))
  15873. ((run-hook-with-args-until-success 'org-shiftup-final-hook))
  15874. (org-support-shift-select
  15875. (org-call-for-shift-select 'previous-line))
  15876. (t (org-shiftselect-error))))
  15877. (defun org-shiftdown (&optional arg)
  15878. "Decrease item in timestamp or decrease priority of current headline.
  15879. Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
  15880. depending on context. See the individual commands for more information."
  15881. (interactive "P")
  15882. (cond
  15883. ((run-hook-with-args-until-success 'org-shiftdown-hook))
  15884. ((and org-support-shift-select (org-region-active-p))
  15885. (org-call-for-shift-select 'next-line))
  15886. ((org-at-timestamp-p t)
  15887. (call-interactively (if org-edit-timestamp-down-means-later
  15888. 'org-timestamp-up 'org-timestamp-down)))
  15889. ((and (not (eq org-support-shift-select 'always))
  15890. org-enable-priority-commands
  15891. (org-on-heading-p))
  15892. (call-interactively 'org-priority-down))
  15893. ((and (not org-support-shift-select) (org-at-item-p))
  15894. (call-interactively 'org-next-item))
  15895. ((org-clocktable-try-shift 'down arg))
  15896. ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
  15897. (org-support-shift-select
  15898. (org-call-for-shift-select 'next-line))
  15899. (t (org-shiftselect-error))))
  15900. (defun org-shiftright (&optional arg)
  15901. "Cycle the thing at point or in the current line, depending on context.
  15902. Depending on context, this does one of the following:
  15903. - switch a timestamp at point one day into the future
  15904. - on a headline, switch to the next TODO keyword.
  15905. - on an item, switch entire list to the next bullet type
  15906. - on a property line, switch to the next allowed value
  15907. - on a clocktable definition line, move time block into the future"
  15908. (interactive "P")
  15909. (cond
  15910. ((run-hook-with-args-until-success 'org-shiftright-hook))
  15911. ((and org-support-shift-select (org-region-active-p))
  15912. (org-call-for-shift-select 'forward-char))
  15913. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
  15914. ((and (not (eq org-support-shift-select 'always))
  15915. (org-on-heading-p))
  15916. (let ((org-inhibit-logging
  15917. (not org-treat-S-cursor-todo-selection-as-state-change))
  15918. (org-inhibit-blocking
  15919. (not org-treat-S-cursor-todo-selection-as-state-change)))
  15920. (org-call-with-arg 'org-todo 'right)))
  15921. ((or (and org-support-shift-select
  15922. (not (eq org-support-shift-select 'always))
  15923. (org-at-item-bullet-p))
  15924. (and (not org-support-shift-select) (org-at-item-p)))
  15925. (org-call-with-arg 'org-cycle-list-bullet nil))
  15926. ((and (not (eq org-support-shift-select 'always))
  15927. (org-at-property-p))
  15928. (call-interactively 'org-property-next-allowed-value))
  15929. ((org-clocktable-try-shift 'right arg))
  15930. ((run-hook-with-args-until-success 'org-shiftright-final-hook))
  15931. (org-support-shift-select
  15932. (org-call-for-shift-select 'forward-char))
  15933. (t (org-shiftselect-error))))
  15934. (defun org-shiftleft (&optional arg)
  15935. "Cycle the thing at point or in the current line, depending on context.
  15936. Depending on context, this does one of the following:
  15937. - switch a timestamp at point one day into the past
  15938. - on a headline, switch to the previous TODO keyword.
  15939. - on an item, switch entire list to the previous bullet type
  15940. - on a property line, switch to the previous allowed value
  15941. - on a clocktable definition line, move time block into the past"
  15942. (interactive "P")
  15943. (cond
  15944. ((run-hook-with-args-until-success 'org-shiftleft-hook))
  15945. ((and org-support-shift-select (org-region-active-p))
  15946. (org-call-for-shift-select 'backward-char))
  15947. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
  15948. ((and (not (eq org-support-shift-select 'always))
  15949. (org-on-heading-p))
  15950. (let ((org-inhibit-logging
  15951. (not org-treat-S-cursor-todo-selection-as-state-change))
  15952. (org-inhibit-blocking
  15953. (not org-treat-S-cursor-todo-selection-as-state-change)))
  15954. (org-call-with-arg 'org-todo 'left)))
  15955. ((or (and org-support-shift-select
  15956. (not (eq org-support-shift-select 'always))
  15957. (org-at-item-bullet-p))
  15958. (and (not org-support-shift-select) (org-at-item-p)))
  15959. (org-call-with-arg 'org-cycle-list-bullet 'previous))
  15960. ((and (not (eq org-support-shift-select 'always))
  15961. (org-at-property-p))
  15962. (call-interactively 'org-property-previous-allowed-value))
  15963. ((org-clocktable-try-shift 'left arg))
  15964. ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
  15965. (org-support-shift-select
  15966. (org-call-for-shift-select 'backward-char))
  15967. (t (org-shiftselect-error))))
  15968. (defun org-shiftcontrolright ()
  15969. "Switch to next TODO set."
  15970. (interactive)
  15971. (cond
  15972. ((and org-support-shift-select (org-region-active-p))
  15973. (org-call-for-shift-select 'forward-word))
  15974. ((and (not (eq org-support-shift-select 'always))
  15975. (org-on-heading-p))
  15976. (org-call-with-arg 'org-todo 'nextset))
  15977. (org-support-shift-select
  15978. (org-call-for-shift-select 'forward-word))
  15979. (t (org-shiftselect-error))))
  15980. (defun org-shiftcontrolleft ()
  15981. "Switch to previous TODO set."
  15982. (interactive)
  15983. (cond
  15984. ((and org-support-shift-select (org-region-active-p))
  15985. (org-call-for-shift-select 'backward-word))
  15986. ((and (not (eq org-support-shift-select 'always))
  15987. (org-on-heading-p))
  15988. (org-call-with-arg 'org-todo 'previousset))
  15989. (org-support-shift-select
  15990. (org-call-for-shift-select 'backward-word))
  15991. (t (org-shiftselect-error))))
  15992. (defun org-ctrl-c-ret ()
  15993. "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
  15994. (interactive)
  15995. (cond
  15996. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  15997. (t (call-interactively 'org-insert-heading))))
  15998. (defun org-copy-special ()
  15999. "Copy region in table or copy current subtree.
  16000. Calls `org-table-copy' or `org-copy-subtree', depending on context.
  16001. See the individual commands for more information."
  16002. (interactive)
  16003. (call-interactively
  16004. (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
  16005. (defun org-cut-special ()
  16006. "Cut region in table or cut current subtree.
  16007. Calls `org-table-copy' or `org-cut-subtree', depending on context.
  16008. See the individual commands for more information."
  16009. (interactive)
  16010. (call-interactively
  16011. (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
  16012. (defun org-paste-special (arg)
  16013. "Paste rectangular region into table, or past subtree relative to level.
  16014. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  16015. See the individual commands for more information."
  16016. (interactive "P")
  16017. (if (org-at-table-p)
  16018. (org-table-paste-rectangle)
  16019. (org-paste-subtree arg)))
  16020. (defun org-edit-special (&optional arg)
  16021. "Call a special editor for the stuff at point.
  16022. When at a table, call the formula editor with `org-table-edit-formulas'.
  16023. When at the first line of an src example, call `org-edit-src-code'.
  16024. When in an #+include line, visit the include file. Otherwise call
  16025. `ffap' to visit the file at point."
  16026. (interactive)
  16027. ;; possibly prep session before editing source
  16028. (when arg
  16029. (let* ((info (org-babel-get-src-block-info))
  16030. (lang (nth 0 info))
  16031. (params (nth 2 info))
  16032. (session (cdr (assoc :session params))))
  16033. (when (and info session) ;; we are in a source-code block with a session
  16034. (funcall
  16035. (intern (concat "org-babel-prep-session:" lang)) session params))))
  16036. (cond ;; proceed with `org-edit-special'
  16037. ((save-excursion
  16038. (beginning-of-line 1)
  16039. (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
  16040. (find-file (org-trim (match-string 1))))
  16041. ((org-edit-src-code))
  16042. ((org-edit-fixed-width-region))
  16043. ((org-at-table.el-p)
  16044. (org-edit-src-code))
  16045. ((or (org-at-table-p)
  16046. (save-excursion
  16047. (beginning-of-line 1)
  16048. (looking-at "[ \t]*#\\+TBLFM:")))
  16049. (call-interactively 'org-table-edit-formulas))
  16050. (t (call-interactively 'ffap))))
  16051. (defun org-ctrl-c-ctrl-c (&optional arg)
  16052. "Set tags in headline, or update according to changed information at point.
  16053. This command does many different things, depending on context:
  16054. - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
  16055. this is what we do.
  16056. - If the cursor is on a statistics cookie, update it.
  16057. - If the cursor is in a headline, prompt for tags and insert them
  16058. into the current line, aligned to `org-tags-column'. When called
  16059. with prefix arg, realign all tags in the current buffer.
  16060. - If the cursor is in one of the special #+KEYWORD lines, this
  16061. triggers scanning the buffer for these lines and updating the
  16062. information.
  16063. - If the cursor is inside a table, realign the table. This command
  16064. works even if the automatic table editor has been turned off.
  16065. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  16066. the entire table.
  16067. - If the cursor is at a footnote reference or definition, jump to
  16068. the corresponding definition or references, respectively.
  16069. - If the cursor is a the beginning of a dynamic block, update it.
  16070. - If the current buffer is a capture buffer, close note and file it.
  16071. - If the cursor is on a <<<target>>>, update radio targets and
  16072. corresponding links in this buffer.
  16073. - If the cursor is on a numbered item in a plain list, renumber the
  16074. ordered list.
  16075. - If the cursor is on a checkbox, toggle it.
  16076. - If the cursor is on a code block, evaluate it. The variable
  16077. `org-confirm-babel-evaluate' can be used to control prompting
  16078. before code block evaluation, by default every code block
  16079. evaluation requires confirmation. Code block evaluation can be
  16080. inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
  16081. (interactive "P")
  16082. (let ((org-enable-table-editor t))
  16083. (cond
  16084. ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
  16085. org-occur-highlights
  16086. org-latex-fragment-image-overlays)
  16087. (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
  16088. (org-remove-occur-highlights)
  16089. (org-remove-latex-fragment-image-overlays)
  16090. (message "Temporary highlights/overlays removed from current buffer"))
  16091. ((and (local-variable-p 'org-finish-function (current-buffer))
  16092. (fboundp org-finish-function))
  16093. (funcall org-finish-function))
  16094. ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
  16095. ((or (looking-at org-property-start-re)
  16096. (org-at-property-p))
  16097. (call-interactively 'org-property-action))
  16098. ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
  16099. ((and (org-in-regexp "\\[\\([0-9]*%\\|[0-9]*/[0-9]*\\)\\]")
  16100. (or (org-on-heading-p) (org-at-item-p)))
  16101. (call-interactively 'org-update-statistics-cookies))
  16102. ((org-on-heading-p) (call-interactively 'org-set-tags))
  16103. ((org-at-table.el-p)
  16104. (message "Use C-c ' to edit table.el tables"))
  16105. ((org-at-table-p)
  16106. (org-table-maybe-eval-formula)
  16107. (if arg
  16108. (call-interactively 'org-table-recalculate)
  16109. (org-table-maybe-recalculate-line))
  16110. (call-interactively 'org-table-align)
  16111. (orgtbl-send-table 'maybe))
  16112. ((or (org-footnote-at-reference-p)
  16113. (org-footnote-at-definition-p))
  16114. (call-interactively 'org-footnote-action))
  16115. ((org-at-item-checkbox-p)
  16116. ;; Cursor at a checkbox: repair list and update checkboxes. Send
  16117. ;; list only if at top item.
  16118. (let* ((cbox (match-string 1))
  16119. (struct (org-list-struct))
  16120. (old-struct (copy-tree struct))
  16121. (parents (org-list-parents-alist struct))
  16122. (prevs (org-list-prevs-alist struct))
  16123. (orderedp (org-entry-get nil "ORDERED"))
  16124. (firstp (= (org-list-get-top-point struct) (point-at-bol)))
  16125. block-item)
  16126. ;; Use a light version of `org-toggle-checkbox' to avoid
  16127. ;; computing list structure twice.
  16128. (org-list-set-checkbox (point-at-bol) struct
  16129. (cond
  16130. ((equal arg '(16)) "[-]")
  16131. ((equal arg '(4)) nil)
  16132. ((equal "[X]" cbox) "[ ]")
  16133. (t "[X]")))
  16134. (org-list-struct-fix-ind struct parents)
  16135. (org-list-struct-fix-bul struct prevs)
  16136. (setq block-item
  16137. (org-list-struct-fix-box struct parents prevs orderedp))
  16138. (when block-item
  16139. (message
  16140. "Checkboxes were removed due to unchecked box at line %d"
  16141. (org-current-line block-item)))
  16142. (org-list-struct-apply-struct struct old-struct)
  16143. (org-update-checkbox-count-maybe)
  16144. (when firstp (org-list-send-list 'maybe))))
  16145. ((org-at-item-p)
  16146. ;; Cursor at an item: repair list. Do checkbox related actions
  16147. ;; only if function was called with an argument. Send list only
  16148. ;; if at top item.
  16149. (let* ((struct (org-list-struct))
  16150. (old-struct (copy-tree struct))
  16151. (parents (org-list-parents-alist struct))
  16152. (prevs (org-list-prevs-alist struct))
  16153. (firstp (= (org-list-get-top-point struct) (point-at-bol))))
  16154. (org-list-struct-fix-ind struct parents)
  16155. (org-list-struct-fix-bul struct prevs)
  16156. (when arg
  16157. (org-list-set-checkbox (point-at-bol) struct "[ ]")
  16158. (org-list-struct-fix-box struct parents prevs))
  16159. (org-list-struct-apply-struct struct old-struct)
  16160. (when arg (org-update-checkbox-count-maybe))
  16161. (when firstp (org-list-send-list 'maybe))))
  16162. ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
  16163. ;; Dynamic block
  16164. (beginning-of-line 1)
  16165. (save-excursion (org-update-dblock)))
  16166. ((save-excursion
  16167. (beginning-of-line 1)
  16168. (looking-at "[ \t]*#\\+\\([A-Z]+\\)"))
  16169. (cond
  16170. ((equal (match-string 1) "TBLFM")
  16171. ;; Recalculate the table before this line
  16172. (save-excursion
  16173. (beginning-of-line 1)
  16174. (skip-chars-backward " \r\n\t")
  16175. (if (org-at-table-p)
  16176. (org-call-with-arg 'org-table-recalculate (or arg t)))))
  16177. (t
  16178. (let ((org-inhibit-startup-visibility-stuff t)
  16179. (org-startup-align-all-tables nil))
  16180. (org-save-outline-visibility 'use-markers (org-mode-restart)))
  16181. (message "Local setup has been refreshed"))))
  16182. ((org-clock-update-time-maybe))
  16183. (t (error "C-c C-c can do nothing useful at this location")))))
  16184. (defun org-mode-restart ()
  16185. "Restart Org-mode, to scan again for special lines.
  16186. Also updates the keyword regular expressions."
  16187. (interactive)
  16188. (org-mode)
  16189. (message "Org-mode restarted"))
  16190. (defun org-kill-note-or-show-branches ()
  16191. "If this is a Note buffer, abort storing the note. Else call `show-branches'."
  16192. (interactive)
  16193. (if (not org-finish-function)
  16194. (progn
  16195. (hide-subtree)
  16196. (call-interactively 'show-branches))
  16197. (let ((org-note-abort t))
  16198. (funcall org-finish-function))))
  16199. (defun org-return (&optional indent)
  16200. "Goto next table row or insert a newline.
  16201. Calls `org-table-next-row' or `newline', depending on context.
  16202. See the individual commands for more information."
  16203. (interactive)
  16204. (cond
  16205. ((bobp) (if indent (newline-and-indent) (newline)))
  16206. ((org-at-table-p)
  16207. (org-table-justify-field-maybe)
  16208. (call-interactively 'org-table-next-row))
  16209. ;; when `newline-and-indent' is called within a list, make sure
  16210. ;; text moved stays inside the item.
  16211. ((and (org-in-item-p) indent)
  16212. (if (and (org-at-item-p) (>= (point) (match-end 0)))
  16213. (progn
  16214. (newline)
  16215. (org-indent-line-to (length (match-string 0))))
  16216. (let ((ind (org-get-indentation)))
  16217. (newline)
  16218. (if (org-looking-back org-list-end-re)
  16219. (org-indent-line-function)
  16220. (org-indent-line-to ind)))))
  16221. ((and org-return-follows-link
  16222. (eq (get-text-property (point) 'face) 'org-link))
  16223. (call-interactively 'org-open-at-point))
  16224. ((and (org-at-heading-p)
  16225. (looking-at
  16226. (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
  16227. (org-show-entry)
  16228. (end-of-line 1)
  16229. (newline))
  16230. (t (if indent (newline-and-indent) (newline)))))
  16231. (defun org-return-indent ()
  16232. "Goto next table row or insert a newline and indent.
  16233. Calls `org-table-next-row' or `newline-and-indent', depending on
  16234. context. See the individual commands for more information."
  16235. (interactive)
  16236. (org-return t))
  16237. (defun org-ctrl-c-star ()
  16238. "Compute table, or change heading status of lines.
  16239. Calls `org-table-recalculate' or `org-toggle-heading',
  16240. depending on context."
  16241. (interactive)
  16242. (cond
  16243. ((org-at-table-p)
  16244. (call-interactively 'org-table-recalculate))
  16245. (t
  16246. ;; Convert all lines in region to list items
  16247. (call-interactively 'org-toggle-heading))))
  16248. (defun org-ctrl-c-minus ()
  16249. "Insert separator line in table or modify bullet status of line.
  16250. Also turns a plain line or a region of lines into list items.
  16251. Calls `org-table-insert-hline', `org-toggle-item', or
  16252. `org-cycle-list-bullet', depending on context."
  16253. (interactive)
  16254. (cond
  16255. ((org-at-table-p)
  16256. (call-interactively 'org-table-insert-hline))
  16257. ((org-region-active-p)
  16258. (call-interactively 'org-toggle-item))
  16259. ((org-in-item-p)
  16260. (call-interactively 'org-cycle-list-bullet))
  16261. (t
  16262. (call-interactively 'org-toggle-item))))
  16263. (defun org-toggle-item (arg)
  16264. "Convert headings or normal lines to items, items to normal lines.
  16265. If there is no active region, only the current line is considered.
  16266. If the first non blank line in the region is an headline, convert
  16267. all headlines to items.
  16268. If it is an item, convert all items to normal lines.
  16269. If it is normal text, change region into an item. With a prefix
  16270. argument ARG, change each line in region into an item."
  16271. (interactive "P")
  16272. (let (l2 l beg end)
  16273. (if (org-region-active-p)
  16274. (setq beg (region-beginning) end (region-end))
  16275. (setq beg (point-at-bol)
  16276. end (min (1+ (point-at-eol)) (point-max))))
  16277. (org-with-limited-levels
  16278. (save-excursion
  16279. (goto-char end)
  16280. (setq l2 (org-current-line))
  16281. (goto-char beg)
  16282. (beginning-of-line 1)
  16283. ;; Ignore blank lines at beginning of region
  16284. (skip-chars-forward " \t\r\n")
  16285. (beginning-of-line 1)
  16286. (setq l (1- (org-current-line)))
  16287. (cond
  16288. ;; Case 1. Start at an item: de-itemize.
  16289. ((org-at-item-p)
  16290. (while (< (setq l (1+ l)) l2)
  16291. (when (org-at-item-p)
  16292. (skip-chars-forward " \t")
  16293. (delete-region (point) (match-end 0)))
  16294. (beginning-of-line 2)))
  16295. ;; Case 2. Start an an heading: convert to items.
  16296. ((org-on-heading-p)
  16297. (let* ((bul (org-list-bullet-string "-"))
  16298. (len (length bul))
  16299. (ind 0) (level 0))
  16300. (while (< (setq l (1+ l)) l2)
  16301. (cond
  16302. ((looking-at outline-regexp)
  16303. (let* ((lvl (org-reduced-level
  16304. (- (length (match-string 0)) 2)))
  16305. (s (concat (make-string (* len lvl) ? ) bul)))
  16306. (replace-match s t t)
  16307. (setq ind (length s) level lvl)))
  16308. ;; Ignore blank lines and inline tasks.
  16309. ((looking-at "^[ \t]*$"))
  16310. ((looking-at "^\\*+ "))
  16311. ;; Ensure normal text belongs to the new item.
  16312. (t (org-indent-line-to (+ (max (- (org-get-indentation) level 2) 0)
  16313. ind))))
  16314. (beginning-of-line 2))))
  16315. ;; Case 3. Normal line with ARG: turn each of them into items
  16316. ;; unless they are already one.
  16317. (arg
  16318. (while (< (setq l (1+ l)) l2)
  16319. (unless (or (org-on-heading-p) (org-at-item-p))
  16320. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  16321. (replace-match
  16322. (concat "\\1" (org-list-bullet-string "-") "\\2"))))
  16323. (beginning-of-line 2)))
  16324. ;; Case 4. Normal line without ARG: make the first line of
  16325. ;; region an item, and shift indentation of others
  16326. ;; lines to set them as item's body.
  16327. (t (let* ((bul (org-list-bullet-string "-"))
  16328. (bul-len (length bul))
  16329. (ref-ind (org-get-indentation)))
  16330. (skip-chars-forward " \t")
  16331. (insert bul)
  16332. (beginning-of-line 2)
  16333. (while (and (< (setq l (1+ l)) l2) (< (point) end))
  16334. ;; Ensure that lines less indented than first one
  16335. ;; still get included in item body.
  16336. (org-indent-line-to (+ (max ref-ind (org-get-indentation))
  16337. bul-len))
  16338. (beginning-of-line 2)))))))))
  16339. (defun org-toggle-heading (&optional nstars)
  16340. "Convert headings to normal text, or items or text to headings.
  16341. If there is no active region, only the current line is considered.
  16342. If the first non blank line is an headline, remove the stars from
  16343. all headlines in the region.
  16344. If it is a plain list item, turn all plain list items into headings.
  16345. If it is a normal line, turn each and every normal line (i.e. not
  16346. an heading or an item) in the region into a heading.
  16347. When converting a line into a heading, the number of stars is chosen
  16348. such that the lines become children of the current entry. However,
  16349. when a prefix argument is given, its value determines the number of
  16350. stars to add."
  16351. (interactive "P")
  16352. (let (l2 l itemp beg end)
  16353. (if (org-region-active-p)
  16354. (setq beg (region-beginning) end (copy-marker (region-end)))
  16355. (setq beg (point-at-bol)
  16356. end (min (1+ (point-at-eol)) (point-max))))
  16357. ;; Ensure inline tasks don't count as headings.
  16358. (org-with-limited-levels
  16359. (save-excursion
  16360. (goto-char end)
  16361. (setq l2 (org-current-line))
  16362. (goto-char beg)
  16363. (beginning-of-line 1)
  16364. ;; Ignore blank lines at beginning of region
  16365. (skip-chars-forward " \t\r\n")
  16366. (beginning-of-line 1)
  16367. (setq l (1- (org-current-line)))
  16368. (cond
  16369. ;; Case 1. Started at an heading: de-star headings.
  16370. ((org-on-heading-p)
  16371. (while (< (setq l (1+ l)) l2)
  16372. (when (org-on-heading-p t)
  16373. (looking-at outline-regexp) (replace-match ""))
  16374. (beginning-of-line 2)))
  16375. ;; Case 2. Started at an item: change items into headlines.
  16376. ((org-at-item-p)
  16377. (let ((stars (make-string
  16378. (if nstars
  16379. (prefix-numeric-value current-prefix-arg)
  16380. (or (org-current-level) 0))
  16381. ?*)))
  16382. (while (< (point) end)
  16383. (when (org-at-item-p)
  16384. ;; Pay attention to cases when region ends before list.
  16385. (let* ((struct (org-list-struct))
  16386. (list-end (min (org-list-get-bottom-point struct) end)))
  16387. (save-restriction
  16388. (narrow-to-region (point) list-end)
  16389. (insert
  16390. (org-list-to-subtree
  16391. (org-list-parse-list t)
  16392. '(:istart (concat stars (funcall get-stars depth))
  16393. :icount (concat stars
  16394. (funcall get-stars depth))))))))
  16395. (beginning-of-line 2))))
  16396. ;; Case 3. Started at normal text: make every line an heading,
  16397. ;; skipping headlines and items.
  16398. (t (let* ((stars (make-string
  16399. (if nstars
  16400. (prefix-numeric-value current-prefix-arg)
  16401. (or (org-current-level) 0))
  16402. ?*))
  16403. (add-stars (cond (nstars "")
  16404. ((equal stars "") "*")
  16405. (org-odd-levels-only "**")
  16406. (t "*")))
  16407. (rpl (concat stars add-stars " ")))
  16408. (while (< (setq l (1+ l)) l2)
  16409. (unless (or (org-on-heading-p) (org-at-item-p))
  16410. (when (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  16411. (replace-match (concat rpl (match-string 2)))))
  16412. (beginning-of-line 2)))))))))
  16413. (defun org-meta-return (&optional arg)
  16414. "Insert a new heading or wrap a region in a table.
  16415. Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
  16416. See the individual commands for more information."
  16417. (interactive "P")
  16418. (cond
  16419. ((run-hook-with-args-until-success 'org-metareturn-hook))
  16420. ((org-at-table-p)
  16421. (call-interactively 'org-table-wrap-region))
  16422. (t (call-interactively 'org-insert-heading))))
  16423. ;;; Menu entries
  16424. ;; Define the Org-mode menus
  16425. (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
  16426. '("Tbl"
  16427. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  16428. ["Next Field" org-cycle (org-at-table-p)]
  16429. ["Previous Field" org-shifttab (org-at-table-p)]
  16430. ["Next Row" org-return (org-at-table-p)]
  16431. "--"
  16432. ["Blank Field" org-table-blank-field (org-at-table-p)]
  16433. ["Edit Field" org-table-edit-field (org-at-table-p)]
  16434. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  16435. "--"
  16436. ("Column"
  16437. ["Move Column Left" org-metaleft (org-at-table-p)]
  16438. ["Move Column Right" org-metaright (org-at-table-p)]
  16439. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  16440. ["Insert Column" org-shiftmetaright (org-at-table-p)])
  16441. ("Row"
  16442. ["Move Row Up" org-metaup (org-at-table-p)]
  16443. ["Move Row Down" org-metadown (org-at-table-p)]
  16444. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  16445. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  16446. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  16447. "--"
  16448. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  16449. ("Rectangle"
  16450. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  16451. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  16452. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  16453. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  16454. "--"
  16455. ("Calculate"
  16456. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  16457. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  16458. ["Edit Formulas" org-edit-special (org-at-table-p)]
  16459. "--"
  16460. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  16461. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  16462. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  16463. "--"
  16464. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  16465. "--"
  16466. ["Sum Column/Rectangle" org-table-sum
  16467. (or (org-at-table-p) (org-region-active-p))]
  16468. ["Which Column?" org-table-current-column (org-at-table-p)])
  16469. ["Debug Formulas"
  16470. org-table-toggle-formula-debugger
  16471. :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
  16472. ["Show Col/Row Numbers"
  16473. org-table-toggle-coordinate-overlays
  16474. :style toggle
  16475. :selected (org-bound-and-true-p org-table-overlay-coordinates)]
  16476. "--"
  16477. ["Create" org-table-create (and (not (org-at-table-p))
  16478. org-enable-table-editor)]
  16479. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  16480. ["Import from File" org-table-import (not (org-at-table-p))]
  16481. ["Export to File" org-table-export (org-at-table-p)]
  16482. "--"
  16483. ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
  16484. (easy-menu-define org-org-menu org-mode-map "Org menu"
  16485. '("Org"
  16486. ("Show/Hide"
  16487. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  16488. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  16489. ["Sparse Tree..." org-sparse-tree t]
  16490. ["Reveal Context" org-reveal t]
  16491. ["Show All" show-all t]
  16492. "--"
  16493. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  16494. "--"
  16495. ["New Heading" org-insert-heading t]
  16496. ("Navigate Headings"
  16497. ["Up" outline-up-heading t]
  16498. ["Next" outline-next-visible-heading t]
  16499. ["Previous" outline-previous-visible-heading t]
  16500. ["Next Same Level" outline-forward-same-level t]
  16501. ["Previous Same Level" outline-backward-same-level t]
  16502. "--"
  16503. ["Jump" org-goto t])
  16504. ("Edit Structure"
  16505. ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
  16506. ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
  16507. "--"
  16508. ["Copy Subtree" org-copy-special (not (org-at-table-p))]
  16509. ["Cut Subtree" org-cut-special (not (org-at-table-p))]
  16510. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  16511. "--"
  16512. ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
  16513. "--"
  16514. ["Promote Heading" org-metaleft (not (org-at-table-p))]
  16515. ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
  16516. ["Demote Heading" org-metaright (not (org-at-table-p))]
  16517. ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
  16518. "--"
  16519. ["Sort Region/Children" org-sort (not (org-at-table-p))]
  16520. "--"
  16521. ["Convert to odd levels" org-convert-to-odd-levels t]
  16522. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  16523. ("Editing"
  16524. ["Emphasis..." org-emphasize t]
  16525. ["Edit Source Example" org-edit-special t]
  16526. "--"
  16527. ["Footnote new/jump" org-footnote-action t]
  16528. ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
  16529. ("Archive"
  16530. ["Archive (default method)" org-archive-subtree-default t]
  16531. "--"
  16532. ["Move Subtree to Archive file" org-advertized-archive-subtree t]
  16533. ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
  16534. ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
  16535. )
  16536. "--"
  16537. ("Hyperlinks"
  16538. ["Store Link (Global)" org-store-link t]
  16539. ["Find existing link to here" org-occur-link-in-agenda-files t]
  16540. ["Insert Link" org-insert-link t]
  16541. ["Follow Link" org-open-at-point t]
  16542. "--"
  16543. ["Next link" org-next-link t]
  16544. ["Previous link" org-previous-link t]
  16545. "--"
  16546. ["Descriptive Links"
  16547. (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
  16548. :style radio
  16549. :selected (member '(org-link) buffer-invisibility-spec)]
  16550. ["Literal Links"
  16551. (progn
  16552. (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
  16553. :style radio
  16554. :selected (not (member '(org-link) buffer-invisibility-spec))])
  16555. "--"
  16556. ("TODO Lists"
  16557. ["TODO/DONE/-" org-todo t]
  16558. ("Select keyword"
  16559. ["Next keyword" org-shiftright (org-on-heading-p)]
  16560. ["Previous keyword" org-shiftleft (org-on-heading-p)]
  16561. ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
  16562. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
  16563. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
  16564. ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
  16565. ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
  16566. "--"
  16567. ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
  16568. :selected org-enforce-todo-dependencies :style toggle :active t]
  16569. "Settings for tree at point"
  16570. ["Do Children sequentially" org-toggle-ordered-property :style radio
  16571. :selected (org-entry-get nil "ORDERED")
  16572. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  16573. ["Do Children parallel" org-toggle-ordered-property :style radio
  16574. :selected (not (org-entry-get nil "ORDERED"))
  16575. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  16576. "--"
  16577. ["Set Priority" org-priority t]
  16578. ["Priority Up" org-shiftup t]
  16579. ["Priority Down" org-shiftdown t]
  16580. "--"
  16581. ["Get news from all feeds" org-feed-update-all t]
  16582. ["Go to the inbox of a feed..." org-feed-goto-inbox t]
  16583. ["Customize feeds" (customize-variable 'org-feed-alist) t])
  16584. ("TAGS and Properties"
  16585. ["Set Tags" org-set-tags-command t]
  16586. ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
  16587. "--"
  16588. ["Set property" org-set-property t]
  16589. ["Column view of properties" org-columns t]
  16590. ["Insert Column View DBlock" org-insert-columns-dblock t])
  16591. ("Dates and Scheduling"
  16592. ["Timestamp" org-time-stamp t]
  16593. ["Timestamp (inactive)" org-time-stamp-inactive t]
  16594. ("Change Date"
  16595. ["1 Day Later" org-shiftright t]
  16596. ["1 Day Earlier" org-shiftleft t]
  16597. ["1 ... Later" org-shiftup t]
  16598. ["1 ... Earlier" org-shiftdown t])
  16599. ["Compute Time Range" org-evaluate-time-range t]
  16600. ["Schedule Item" org-schedule t]
  16601. ["Deadline" org-deadline t]
  16602. "--"
  16603. ["Custom time format" org-toggle-time-stamp-overlays
  16604. :style radio :selected org-display-custom-times]
  16605. "--"
  16606. ["Goto Calendar" org-goto-calendar t]
  16607. ["Date from Calendar" org-date-from-calendar t]
  16608. "--"
  16609. ["Start/Restart Timer" org-timer-start t]
  16610. ["Pause/Continue Timer" org-timer-pause-or-continue t]
  16611. ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
  16612. ["Insert Timer String" org-timer t]
  16613. ["Insert Timer Item" org-timer-item t])
  16614. ("Logging work"
  16615. ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
  16616. ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
  16617. ["Clock out" org-clock-out t]
  16618. ["Clock cancel" org-clock-cancel t]
  16619. "--"
  16620. ["Mark as default task" org-clock-mark-default-task t]
  16621. ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
  16622. ["Goto running clock" org-clock-goto t]
  16623. "--"
  16624. ["Display times" org-clock-display t]
  16625. ["Create clock table" org-clock-report t]
  16626. "--"
  16627. ["Record DONE time"
  16628. (progn (setq org-log-done (not org-log-done))
  16629. (message "Switching to %s will %s record a timestamp"
  16630. (car org-done-keywords)
  16631. (if org-log-done "automatically" "not")))
  16632. :style toggle :selected org-log-done])
  16633. "--"
  16634. ["Agenda Command..." org-agenda t]
  16635. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  16636. ("File List for Agenda")
  16637. ("Special views current file"
  16638. ["TODO Tree" org-show-todo-tree t]
  16639. ["Check Deadlines" org-check-deadlines t]
  16640. ["Timeline" org-timeline t]
  16641. ["Tags/Property tree" org-match-sparse-tree t])
  16642. "--"
  16643. ["Export/Publish..." org-export t]
  16644. ("LaTeX"
  16645. ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
  16646. :selected org-cdlatex-mode]
  16647. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  16648. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  16649. ["Modify math symbol" org-cdlatex-math-modify
  16650. (org-inside-LaTeX-fragment-p)]
  16651. ["Insert citation" org-reftex-citation t]
  16652. "--"
  16653. ["Template for BEAMER" org-insert-beamer-options-template t])
  16654. "--"
  16655. ("MobileOrg"
  16656. ["Push Files and Views" org-mobile-push t]
  16657. ["Get Captured and Flagged" org-mobile-pull t]
  16658. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  16659. "--"
  16660. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  16661. "--"
  16662. ("Documentation"
  16663. ["Show Version" org-version t]
  16664. ["Info Documentation" org-info t])
  16665. ("Customize"
  16666. ["Browse Org Group" org-customize t]
  16667. "--"
  16668. ["Expand This Menu" org-create-customize-menu
  16669. (fboundp 'customize-menu-create)])
  16670. ["Send bug report" org-submit-bug-report t]
  16671. "--"
  16672. ("Refresh/Reload"
  16673. ["Refresh setup current buffer" org-mode-restart t]
  16674. ["Reload Org (after update)" org-reload t]
  16675. ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
  16676. ))
  16677. (defun org-info (&optional node)
  16678. "Read documentation for Org-mode in the info system.
  16679. With optional NODE, go directly to that node."
  16680. (interactive)
  16681. (info (format "(org)%s" (or node ""))))
  16682. ;;;###autoload
  16683. (defun org-submit-bug-report ()
  16684. "Submit a bug report on Org-mode via mail.
  16685. Don't hesitate to report any problems or inaccurate documentation.
  16686. If you don't have setup sending mail from (X)Emacs, please copy the
  16687. output buffer into your mail program, as it gives us important
  16688. information about your Org-mode version and configuration."
  16689. (interactive)
  16690. (require 'reporter)
  16691. (org-load-modules-maybe)
  16692. (org-require-autoloaded-modules)
  16693. (let ((reporter-prompt-for-summary-p "Bug report subject: "))
  16694. (reporter-submit-bug-report
  16695. "emacs-orgmode@gnu.org"
  16696. (org-version)
  16697. (let (list)
  16698. (save-window-excursion
  16699. (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
  16700. (delete-other-windows)
  16701. (erase-buffer)
  16702. (insert "You are about to submit a bug report to the Org-mode mailing list.
  16703. We would like to add your full Org-mode and Outline configuration to the
  16704. bug report. This greatly simplifies the work of the maintainer and
  16705. other experts on the mailing list.
  16706. HOWEVER, some variables you have customized may contain private
  16707. information. The names of customers, colleagues, or friends, might
  16708. appear in the form of file names, tags, todo states, or search strings.
  16709. If you answer yes to the prompt, you might want to check and remove
  16710. such private information before sending the email.")
  16711. (add-text-properties (point-min) (point-max) '(face org-warning))
  16712. (when (yes-or-no-p "Include your Org-mode configuration ")
  16713. (mapatoms
  16714. (lambda (v)
  16715. (and (boundp v)
  16716. (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
  16717. (or (and (symbol-value v)
  16718. (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
  16719. (and
  16720. (get v 'custom-type) (get v 'standard-value)
  16721. (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
  16722. (push v list)))))
  16723. (kill-buffer (get-buffer "*Warn about privacy*"))
  16724. list))
  16725. nil nil
  16726. "Remember to cover the basics, that is, what you expected to happen and
  16727. what in fact did happen. You don't know how to make a good report? See
  16728. http://orgmode.org/manual/Feedback.html#Feedback
  16729. Your bug report will be posted to the Org-mode mailing list.
  16730. ------------------------------------------------------------------------")
  16731. (save-excursion
  16732. (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
  16733. (replace-match "\\1Bug: \\3 [\\2]")))))
  16734. (defun org-install-agenda-files-menu ()
  16735. (let ((bl (buffer-list)))
  16736. (save-excursion
  16737. (while bl
  16738. (set-buffer (pop bl))
  16739. (if (org-mode-p) (setq bl nil)))
  16740. (when (org-mode-p)
  16741. (easy-menu-change
  16742. '("Org") "File List for Agenda"
  16743. (append
  16744. (list
  16745. ["Edit File List" (org-edit-agenda-file-list) t]
  16746. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  16747. ["Remove Current File from List" org-remove-file t]
  16748. ["Cycle through agenda files" org-cycle-agenda-files t]
  16749. ["Occur in all agenda files" org-occur-in-agenda-files t]
  16750. "--")
  16751. (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
  16752. ;;;; Documentation
  16753. ;;;###autoload
  16754. (defun org-require-autoloaded-modules ()
  16755. (interactive)
  16756. (mapc 'require
  16757. '(org-agenda org-archive org-ascii org-attach org-clock org-colview
  16758. org-docbook org-exp org-html org-icalendar
  16759. org-id org-latex
  16760. org-publish org-remember org-table
  16761. org-timer org-xoxo)))
  16762. ;;;###autoload
  16763. (defun org-reload (&optional uncompiled)
  16764. "Reload all org lisp files.
  16765. With prefix arg UNCOMPILED, load the uncompiled versions."
  16766. (interactive "P")
  16767. (require 'find-func)
  16768. (let* ((file-re "^\\(org\\|orgtbl\\)\\(\\.el\\|-.*\\.el\\)")
  16769. (dir-org (file-name-directory (org-find-library-name "org")))
  16770. (dir-org-contrib (ignore-errors
  16771. (file-name-directory
  16772. (org-find-library-name "org-contribdir"))))
  16773. (babel-files
  16774. (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
  16775. (append (list nil "comint" "eval" "exp" "keys"
  16776. "lob" "ref" "table" "tangle")
  16777. (delq nil
  16778. (mapcar
  16779. (lambda (lang)
  16780. (when (cdr lang) (symbol-name (car lang))))
  16781. org-babel-load-languages)))))
  16782. (files
  16783. (append (directory-files dir-org t file-re)
  16784. babel-files
  16785. (and dir-org-contrib
  16786. (directory-files dir-org-contrib t file-re))))
  16787. (remove-re (concat (if (featurep 'xemacs)
  16788. "org-colview" "org-colview-xemacs")
  16789. "\\'")))
  16790. (setq files (mapcar 'file-name-sans-extension files))
  16791. (setq files (mapcar
  16792. (lambda (x) (if (string-match remove-re x) nil x))
  16793. files))
  16794. (setq files (delq nil files))
  16795. (mapc
  16796. (lambda (f)
  16797. (when (featurep (intern (file-name-nondirectory f)))
  16798. (if (and (not uncompiled)
  16799. (file-exists-p (concat f ".elc")))
  16800. (load (concat f ".elc") nil nil t)
  16801. (load (concat f ".el") nil nil t))))
  16802. files))
  16803. (org-version))
  16804. ;;;###autoload
  16805. (defun org-customize ()
  16806. "Call the customize function with org as argument."
  16807. (interactive)
  16808. (org-load-modules-maybe)
  16809. (org-require-autoloaded-modules)
  16810. (customize-browse 'org))
  16811. (defun org-create-customize-menu ()
  16812. "Create a full customization menu for Org-mode, insert it into the menu."
  16813. (interactive)
  16814. (org-load-modules-maybe)
  16815. (org-require-autoloaded-modules)
  16816. (if (fboundp 'customize-menu-create)
  16817. (progn
  16818. (easy-menu-change
  16819. '("Org") "Customize"
  16820. `(["Browse Org group" org-customize t]
  16821. "--"
  16822. ,(customize-menu-create 'org)
  16823. ["Set" Custom-set t]
  16824. ["Save" Custom-save t]
  16825. ["Reset to Current" Custom-reset-current t]
  16826. ["Reset to Saved" Custom-reset-saved t]
  16827. ["Reset to Standard Settings" Custom-reset-standard t]))
  16828. (message "\"Org\"-menu now contains full customization menu"))
  16829. (error "Cannot expand menu (outdated version of cus-edit.el)")))
  16830. ;;;; Miscellaneous stuff
  16831. ;;; Generally useful functions
  16832. (defun org-get-at-bol (property)
  16833. "Get text property PROPERTY at beginning of line."
  16834. (get-text-property (point-at-bol) property))
  16835. (defun org-find-text-property-in-string (prop s)
  16836. "Return the first non-nil value of property PROP in string S."
  16837. (or (get-text-property 0 prop s)
  16838. (get-text-property (or (next-single-property-change 0 prop s) 0)
  16839. prop s)))
  16840. (defun org-display-warning (message) ;; Copied from Emacs-Muse
  16841. "Display the given MESSAGE as a warning."
  16842. (if (fboundp 'display-warning)
  16843. (display-warning 'org message
  16844. (if (featurep 'xemacs) 'warning :warning))
  16845. (let ((buf (get-buffer-create "*Org warnings*")))
  16846. (with-current-buffer buf
  16847. (goto-char (point-max))
  16848. (insert "Warning (Org): " message)
  16849. (unless (bolp)
  16850. (newline)))
  16851. (display-buffer buf)
  16852. (sit-for 0))))
  16853. (defun org-eval (form)
  16854. "Eval FORM and return result."
  16855. (condition-case error
  16856. (eval form)
  16857. (error (format "%%![Error: %s]" error))))
  16858. (defun org-in-commented-line ()
  16859. "Is point in a line starting with `#'?"
  16860. (equal (char-after (point-at-bol)) ?#))
  16861. (defun org-in-indented-comment-line ()
  16862. "Is point in a line starting with `#' after some white space?"
  16863. (save-excursion
  16864. (save-match-data
  16865. (goto-char (point-at-bol))
  16866. (looking-at "[ \t]*#"))))
  16867. (defun org-in-verbatim-emphasis ()
  16868. (save-match-data
  16869. (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
  16870. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  16871. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  16872. (if (and marker (marker-buffer marker)
  16873. (buffer-live-p (marker-buffer marker)))
  16874. (progn
  16875. (switch-to-buffer (marker-buffer marker))
  16876. (if (or (> marker (point-max)) (< marker (point-min)))
  16877. (widen))
  16878. (goto-char marker)
  16879. (org-show-context 'org-goto))
  16880. (if bookmark
  16881. (bookmark-jump bookmark)
  16882. (error "Cannot find location"))))
  16883. (defun org-quote-csv-field (s)
  16884. "Quote field for inclusion in CSV material."
  16885. (if (string-match "[\",]" s)
  16886. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  16887. s))
  16888. (defun org-force-self-insert (N)
  16889. "Needed to enforce self-insert under remapping."
  16890. (interactive "p")
  16891. (self-insert-command N))
  16892. (defun org-string-width (s)
  16893. "Compute width of string, ignoring invisible characters.
  16894. This ignores character with invisibility property `org-link', and also
  16895. characters with property `org-cwidth', because these will become invisible
  16896. upon the next fontification round."
  16897. (let (b l)
  16898. (when (or (eq t buffer-invisibility-spec)
  16899. (assq 'org-link buffer-invisibility-spec))
  16900. (while (setq b (text-property-any 0 (length s)
  16901. 'invisible 'org-link s))
  16902. (setq s (concat (substring s 0 b)
  16903. (substring s (or (next-single-property-change
  16904. b 'invisible s) (length s)))))))
  16905. (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
  16906. (setq s (concat (substring s 0 b)
  16907. (substring s (or (next-single-property-change
  16908. b 'org-cwidth s) (length s))))))
  16909. (setq l (string-width s) b -1)
  16910. (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
  16911. (setq l (- l (get-text-property b 'org-dwidth-n s))))
  16912. l))
  16913. (defun org-shorten-string (s maxlength)
  16914. "Shorten string S so tht it is no longer than MAXLENGTH characters.
  16915. If the string is shorter or has length MAXLENGTH, just return the
  16916. original string. If it is longer, the functions finds a space in the
  16917. string, breaks this string off at that locations and adds three dots
  16918. as ellipsis. Including the ellipsis, the string will not be longer
  16919. than MAXLENGTH. If finding a good breaking point in the string does
  16920. not work, the string is just chopped off in the middle of a word
  16921. if necessary."
  16922. (if (<= (length s) maxlength)
  16923. s
  16924. (let* ((n (max (- maxlength 4) 1))
  16925. (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
  16926. (if (string-match re s)
  16927. (concat (match-string 1 s) "...")
  16928. (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
  16929. (defun org-get-indentation (&optional line)
  16930. "Get the indentation of the current line, interpreting tabs.
  16931. When LINE is given, assume it represents a line and compute its indentation."
  16932. (if line
  16933. (if (string-match "^ *" (org-remove-tabs line))
  16934. (match-end 0))
  16935. (save-excursion
  16936. (beginning-of-line 1)
  16937. (skip-chars-forward " \t")
  16938. (current-column))))
  16939. (defun org-get-string-indentation (s)
  16940. "What indentation has S due to SPACE and TAB at the beginning of the string?"
  16941. (let ((n -1) (i 0) (w tab-width) c)
  16942. (catch 'exit
  16943. (while (< (setq n (1+ n)) (length s))
  16944. (setq c (aref s n))
  16945. (cond ((= c ?\ ) (setq i (1+ i)))
  16946. ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
  16947. (t (throw 'exit t)))))
  16948. i))
  16949. (defun org-remove-tabs (s &optional width)
  16950. "Replace tabulators in S with spaces.
  16951. Assumes that s is a single line, starting in column 0."
  16952. (setq width (or width tab-width))
  16953. (while (string-match "\t" s)
  16954. (setq s (replace-match
  16955. (make-string
  16956. (- (* width (/ (+ (match-beginning 0) width) width))
  16957. (match-beginning 0)) ?\ )
  16958. t t s)))
  16959. s)
  16960. (defun org-fix-indentation (line ind)
  16961. "Fix indentation in LINE.
  16962. IND is a cons cell with target and minimum indentation.
  16963. If the current indentation in LINE is smaller than the minimum,
  16964. leave it alone. If it is larger than ind, set it to the target."
  16965. (let* ((l (org-remove-tabs line))
  16966. (i (org-get-indentation l))
  16967. (i1 (car ind)) (i2 (cdr ind)))
  16968. (if (>= i i2) (setq l (substring line i2)))
  16969. (if (> i1 0)
  16970. (concat (make-string i1 ?\ ) l)
  16971. l)))
  16972. (defun org-remove-indentation (code &optional n)
  16973. "Remove the maximum common indentation from the lines in CODE.
  16974. N may optionally be the number of spaces to remove."
  16975. (with-temp-buffer
  16976. (insert code)
  16977. (org-do-remove-indentation n)
  16978. (buffer-string)))
  16979. (defun org-do-remove-indentation (&optional n)
  16980. "Remove the maximum common indentation from the buffer."
  16981. (untabify (point-min) (point-max))
  16982. (let ((min 10000) re)
  16983. (if n
  16984. (setq min n)
  16985. (goto-char (point-min))
  16986. (while (re-search-forward "^ *[^ \n]" nil t)
  16987. (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
  16988. (unless (or (= min 0) (= min 10000))
  16989. (setq re (format "^ \\{%d\\}" min))
  16990. (goto-char (point-min))
  16991. (while (re-search-forward re nil t)
  16992. (replace-match "")
  16993. (end-of-line 1))
  16994. min)))
  16995. (defun org-fill-template (template alist)
  16996. "Find each %key of ALIST in TEMPLATE and replace it."
  16997. (let ((case-fold-search nil)
  16998. entry key value)
  16999. (setq alist (sort (copy-sequence alist)
  17000. (lambda (a b) (< (length (car a)) (length (car b))))))
  17001. (while (setq entry (pop alist))
  17002. (setq template
  17003. (replace-regexp-in-string
  17004. (concat "%" (regexp-quote (car entry)))
  17005. (cdr entry) template t t)))
  17006. template))
  17007. (defun org-base-buffer (buffer)
  17008. "Return the base buffer of BUFFER, if it has one. Else return the buffer."
  17009. (if (not buffer)
  17010. buffer
  17011. (or (buffer-base-buffer buffer)
  17012. buffer)))
  17013. (defun org-trim (s)
  17014. "Remove whitespace at beginning and end of string."
  17015. (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
  17016. (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
  17017. s)
  17018. (defun org-wrap (string &optional width lines)
  17019. "Wrap string to either a number of lines, or a width in characters.
  17020. If WIDTH is non-nil, the string is wrapped to that width, however many lines
  17021. that costs. If there is a word longer than WIDTH, the text is actually
  17022. wrapped to the length of that word.
  17023. IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
  17024. many lines, whatever width that takes.
  17025. The return value is a list of lines, without newlines at the end."
  17026. (let* ((words (org-split-string string "[ \t\n]+"))
  17027. (maxword (apply 'max (mapcar 'org-string-width words)))
  17028. w ll)
  17029. (cond (width
  17030. (org-do-wrap words (max maxword width)))
  17031. (lines
  17032. (setq w maxword)
  17033. (setq ll (org-do-wrap words maxword))
  17034. (if (<= (length ll) lines)
  17035. ll
  17036. (setq ll words)
  17037. (while (> (length ll) lines)
  17038. (setq w (1+ w))
  17039. (setq ll (org-do-wrap words w)))
  17040. ll))
  17041. (t (error "Cannot wrap this")))))
  17042. (defun org-do-wrap (words width)
  17043. "Create lines of maximum width WIDTH (in characters) from word list WORDS."
  17044. (let (lines line)
  17045. (while words
  17046. (setq line (pop words))
  17047. (while (and words (< (+ (length line) (length (car words))) width))
  17048. (setq line (concat line " " (pop words))))
  17049. (setq lines (push line lines)))
  17050. (nreverse lines)))
  17051. (defun org-split-string (string &optional separators)
  17052. "Splits STRING into substrings at SEPARATORS.
  17053. No empty strings are returned if there are matches at the beginning
  17054. and end of string."
  17055. (let ((rexp (or separators "[ \f\t\n\r\v]+"))
  17056. (start 0)
  17057. notfirst
  17058. (list nil))
  17059. (while (and (string-match rexp string
  17060. (if (and notfirst
  17061. (= start (match-beginning 0))
  17062. (< start (length string)))
  17063. (1+ start) start))
  17064. (< (match-beginning 0) (length string)))
  17065. (setq notfirst t)
  17066. (or (eq (match-beginning 0) 0)
  17067. (and (eq (match-beginning 0) (match-end 0))
  17068. (eq (match-beginning 0) start))
  17069. (setq list
  17070. (cons (substring string start (match-beginning 0))
  17071. list)))
  17072. (setq start (match-end 0)))
  17073. (or (eq start (length string))
  17074. (setq list
  17075. (cons (substring string start)
  17076. list)))
  17077. (nreverse list)))
  17078. (defun org-quote-vert (s)
  17079. "Replace \"|\" with \"\\vert\"."
  17080. (while (string-match "|" s)
  17081. (setq s (replace-match "\\vert" t t s)))
  17082. s)
  17083. (defun org-uuidgen-p (s)
  17084. "Is S an ID created by UUIDGEN?"
  17085. (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
  17086. (defun org-context ()
  17087. "Return a list of contexts of the current cursor position.
  17088. If several contexts apply, all are returned.
  17089. Each context entry is a list with a symbol naming the context, and
  17090. two positions indicating start and end of the context. Possible
  17091. contexts are:
  17092. :headline anywhere in a headline
  17093. :headline-stars on the leading stars in a headline
  17094. :todo-keyword on a TODO keyword (including DONE) in a headline
  17095. :tags on the TAGS in a headline
  17096. :priority on the priority cookie in a headline
  17097. :item on the first line of a plain list item
  17098. :item-bullet on the bullet/number of a plain list item
  17099. :checkbox on the checkbox in a plain list item
  17100. :table in an org-mode table
  17101. :table-special on a special filed in a table
  17102. :table-table in a table.el table
  17103. :link on a hyperlink
  17104. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
  17105. :target on a <<target>>
  17106. :radio-target on a <<<radio-target>>>
  17107. :latex-fragment on a LaTeX fragment
  17108. :latex-preview on a LaTeX fragment with overlayed preview image
  17109. This function expects the position to be visible because it uses font-lock
  17110. faces as a help to recognize the following contexts: :table-special, :link,
  17111. and :keyword."
  17112. (let* ((f (get-text-property (point) 'face))
  17113. (faces (if (listp f) f (list f)))
  17114. (p (point)) clist o)
  17115. ;; First the large context
  17116. (cond
  17117. ((org-on-heading-p t)
  17118. (push (list :headline (point-at-bol) (point-at-eol)) clist)
  17119. (when (progn
  17120. (beginning-of-line 1)
  17121. (looking-at org-todo-line-tags-regexp))
  17122. (push (org-point-in-group p 1 :headline-stars) clist)
  17123. (push (org-point-in-group p 2 :todo-keyword) clist)
  17124. (push (org-point-in-group p 4 :tags) clist))
  17125. (goto-char p)
  17126. (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
  17127. (if (looking-at "\\[#[A-Z0-9]\\]")
  17128. (push (org-point-in-group p 0 :priority) clist)))
  17129. ((org-at-item-p)
  17130. (push (org-point-in-group p 2 :item-bullet) clist)
  17131. (push (list :item (point-at-bol)
  17132. (save-excursion (org-end-of-item) (point)))
  17133. clist)
  17134. (and (org-at-item-checkbox-p)
  17135. (push (org-point-in-group p 0 :checkbox) clist)))
  17136. ((org-at-table-p)
  17137. (push (list :table (org-table-begin) (org-table-end)) clist)
  17138. (if (memq 'org-formula faces)
  17139. (push (list :table-special
  17140. (previous-single-property-change p 'face)
  17141. (next-single-property-change p 'face)) clist)))
  17142. ((org-at-table-p 'any)
  17143. (push (list :table-table) clist)))
  17144. (goto-char p)
  17145. ;; Now the small context
  17146. (cond
  17147. ((org-at-timestamp-p)
  17148. (push (org-point-in-group p 0 :timestamp) clist))
  17149. ((memq 'org-link faces)
  17150. (push (list :link
  17151. (previous-single-property-change p 'face)
  17152. (next-single-property-change p 'face)) clist))
  17153. ((memq 'org-special-keyword faces)
  17154. (push (list :keyword
  17155. (previous-single-property-change p 'face)
  17156. (next-single-property-change p 'face)) clist))
  17157. ((org-on-target-p)
  17158. (push (org-point-in-group p 0 :target) clist)
  17159. (goto-char (1- (match-beginning 0)))
  17160. (if (looking-at org-radio-target-regexp)
  17161. (push (org-point-in-group p 0 :radio-target) clist))
  17162. (goto-char p))
  17163. ((setq o (car (delq nil
  17164. (mapcar
  17165. (lambda (x)
  17166. (if (memq x org-latex-fragment-image-overlays) x))
  17167. (overlays-at (point))))))
  17168. (push (list :latex-fragment
  17169. (overlay-start o) (overlay-end o)) clist)
  17170. (push (list :latex-preview
  17171. (overlay-start o) (overlay-end o)) clist))
  17172. ((org-inside-LaTeX-fragment-p)
  17173. ;; FIXME: positions wrong.
  17174. (push (list :latex-fragment (point) (point)) clist)))
  17175. (setq clist (nreverse (delq nil clist)))
  17176. clist))
  17177. ;; FIXME: Compare with at-regexp-p Do we need both?
  17178. (defun org-in-regexp (re &optional nlines visually)
  17179. "Check if point is inside a match of regexp.
  17180. Normally only the current line is checked, but you can include NLINES extra
  17181. lines both before and after point into the search.
  17182. If VISUALLY is set, require that the cursor is not after the match but
  17183. really on, so that the block visually is on the match."
  17184. (catch 'exit
  17185. (let ((pos (point))
  17186. (eol (point-at-eol (+ 1 (or nlines 0))))
  17187. (inc (if visually 1 0)))
  17188. (save-excursion
  17189. (beginning-of-line (- 1 (or nlines 0)))
  17190. (while (re-search-forward re eol t)
  17191. (if (and (<= (match-beginning 0) pos)
  17192. (>= (+ inc (match-end 0)) pos))
  17193. (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
  17194. (defun org-at-regexp-p (regexp)
  17195. "Is point inside a match of REGEXP in the current line?"
  17196. (catch 'exit
  17197. (save-excursion
  17198. (let ((pos (point)) (end (point-at-eol)))
  17199. (beginning-of-line 1)
  17200. (while (re-search-forward regexp end t)
  17201. (if (and (<= (match-beginning 0) pos)
  17202. (>= (match-end 0) pos))
  17203. (throw 'exit t)))
  17204. nil))))
  17205. (defun org-in-regexps-block-p (start-re end-re &optional bound)
  17206. "Return t if the current point is between matches of START-RE and END-RE.
  17207. This will also return t if point is on one of the two matches or
  17208. in an unfinished block. END-RE can be a string or a form
  17209. returning a string.
  17210. An optional third argument bounds the search for START-RE. It
  17211. defaults to previous heading or `point-min'."
  17212. (let ((pos (point))
  17213. (limit (or bound (save-excursion (outline-previous-heading)))))
  17214. (save-excursion
  17215. ;; we're on a block when point is on start-re...
  17216. (or (org-at-regexp-p start-re)
  17217. ;; ... or start-re can be found above...
  17218. (and (re-search-backward start-re limit t)
  17219. ;; ... but no end-re between start-re and point.
  17220. (not (re-search-forward (eval end-re) pos t)))))))
  17221. (defun org-occur-in-agenda-files (regexp &optional nlines)
  17222. "Call `multi-occur' with buffers for all agenda files."
  17223. (interactive "sOrg-files matching: \np")
  17224. (let* ((files (org-agenda-files))
  17225. (tnames (mapcar 'file-truename files))
  17226. (extra org-agenda-text-search-extra-files)
  17227. f)
  17228. (when (eq (car extra) 'agenda-archives)
  17229. (setq extra (cdr extra))
  17230. (setq files (org-add-archive-files files)))
  17231. (while (setq f (pop extra))
  17232. (unless (member (file-truename f) tnames)
  17233. (add-to-list 'files f 'append)
  17234. (add-to-list 'tnames (file-truename f) 'append)))
  17235. (multi-occur
  17236. (mapcar (lambda (x)
  17237. (with-current-buffer
  17238. (or (get-file-buffer x) (find-file-noselect x))
  17239. (widen)
  17240. (current-buffer)))
  17241. files)
  17242. regexp)))
  17243. (if (boundp 'occur-mode-find-occurrence-hook)
  17244. ;; Emacs 23
  17245. (add-hook 'occur-mode-find-occurrence-hook
  17246. (lambda ()
  17247. (when (org-mode-p)
  17248. (org-reveal))))
  17249. ;; Emacs 22
  17250. (defadvice occur-mode-goto-occurrence
  17251. (after org-occur-reveal activate)
  17252. (and (org-mode-p) (org-reveal)))
  17253. (defadvice occur-mode-goto-occurrence-other-window
  17254. (after org-occur-reveal activate)
  17255. (and (org-mode-p) (org-reveal)))
  17256. (defadvice occur-mode-display-occurrence
  17257. (after org-occur-reveal activate)
  17258. (when (org-mode-p)
  17259. (let ((pos (occur-mode-find-occurrence)))
  17260. (with-current-buffer (marker-buffer pos)
  17261. (save-excursion
  17262. (goto-char pos)
  17263. (org-reveal)))))))
  17264. (defun org-occur-link-in-agenda-files ()
  17265. "Create a link and search for it in the agendas.
  17266. The link is not stored in `org-stored-links', it is just created
  17267. for the search purpose."
  17268. (interactive)
  17269. (let ((link (condition-case nil
  17270. (org-store-link nil)
  17271. (error "Unable to create a link to here"))))
  17272. (org-occur-in-agenda-files (regexp-quote link))))
  17273. (defun org-uniquify (list)
  17274. "Remove duplicate elements from LIST."
  17275. (let (res)
  17276. (mapc (lambda (x) (add-to-list 'res x 'append)) list)
  17277. res))
  17278. (defun org-delete-all (elts list)
  17279. "Remove all elements in ELTS from LIST."
  17280. (while elts
  17281. (setq list (delete (pop elts) list)))
  17282. list)
  17283. (defun org-count (cl-item cl-seq)
  17284. "Count the number of occurrences of ITEM in SEQ.
  17285. Taken from `count' in cl-seq.el with all keyword arguments removed."
  17286. (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
  17287. (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
  17288. (while (< cl-start cl-end)
  17289. (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
  17290. (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
  17291. (setq cl-start (1+ cl-start)))
  17292. cl-count))
  17293. (defun org-remove-if (predicate seq)
  17294. "Remove everything from SEQ that fulfills PREDICATE."
  17295. (let (res e)
  17296. (while seq
  17297. (setq e (pop seq))
  17298. (if (not (funcall predicate e)) (push e res)))
  17299. (nreverse res)))
  17300. (defun org-remove-if-not (predicate seq)
  17301. "Remove everything from SEQ that does not fulfill PREDICATE."
  17302. (let (res e)
  17303. (while seq
  17304. (setq e (pop seq))
  17305. (if (funcall predicate e) (push e res)))
  17306. (nreverse res)))
  17307. (defun org-back-over-empty-lines ()
  17308. "Move backwards over whitespace, to the beginning of the first empty line.
  17309. Returns the number of empty lines passed."
  17310. (let ((pos (point)))
  17311. (if (cdr (assoc 'heading org-blank-before-new-entry))
  17312. (skip-chars-backward " \t\n\r")
  17313. (forward-line -1))
  17314. (beginning-of-line 2)
  17315. (goto-char (min (point) pos))
  17316. (count-lines (point) pos)))
  17317. (defun org-skip-whitespace ()
  17318. (skip-chars-forward " \t\n\r"))
  17319. (defun org-point-in-group (point group &optional context)
  17320. "Check if POINT is in match-group GROUP.
  17321. If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
  17322. match. If the match group does not exist or point is not inside it,
  17323. return nil."
  17324. (and (match-beginning group)
  17325. (>= point (match-beginning group))
  17326. (<= point (match-end group))
  17327. (if context
  17328. (list context (match-beginning group) (match-end group))
  17329. t)))
  17330. (defun org-switch-to-buffer-other-window (&rest args)
  17331. "Switch to buffer in a second window on the current frame.
  17332. In particular, do not allow pop-up frames.
  17333. Returns the newly created buffer."
  17334. (let (pop-up-frames special-display-buffer-names special-display-regexps
  17335. special-display-function)
  17336. (apply 'switch-to-buffer-other-window args)))
  17337. (defun org-combine-plists (&rest plists)
  17338. "Create a single property list from all plists in PLISTS.
  17339. The process starts by copying the first list, and then setting properties
  17340. from the other lists. Settings in the last list are the most significant
  17341. ones and overrule settings in the other lists."
  17342. (let ((rtn (copy-sequence (pop plists)))
  17343. p v ls)
  17344. (while plists
  17345. (setq ls (pop plists))
  17346. (while ls
  17347. (setq p (pop ls) v (pop ls))
  17348. (setq rtn (plist-put rtn p v))))
  17349. rtn))
  17350. (defun org-move-line-down (arg)
  17351. "Move the current line down. With prefix argument, move it past ARG lines."
  17352. (interactive "p")
  17353. (let ((col (current-column))
  17354. beg end pos)
  17355. (beginning-of-line 1) (setq beg (point))
  17356. (beginning-of-line 2) (setq end (point))
  17357. (beginning-of-line (+ 1 arg))
  17358. (setq pos (move-marker (make-marker) (point)))
  17359. (insert (delete-and-extract-region beg end))
  17360. (goto-char pos)
  17361. (org-move-to-column col)))
  17362. (defun org-move-line-up (arg)
  17363. "Move the current line up. With prefix argument, move it past ARG lines."
  17364. (interactive "p")
  17365. (let ((col (current-column))
  17366. beg end pos)
  17367. (beginning-of-line 1) (setq beg (point))
  17368. (beginning-of-line 2) (setq end (point))
  17369. (beginning-of-line (- arg))
  17370. (setq pos (move-marker (make-marker) (point)))
  17371. (insert (delete-and-extract-region beg end))
  17372. (goto-char pos)
  17373. (org-move-to-column col)))
  17374. (defun org-replace-escapes (string table)
  17375. "Replace %-escapes in STRING with values in TABLE.
  17376. TABLE is an association list with keys like \"%a\" and string values.
  17377. The sequences in STRING may contain normal field width and padding information,
  17378. for example \"%-5s\". Replacements happen in the sequence given by TABLE,
  17379. so values can contain further %-escapes if they are define later in TABLE."
  17380. (let ((tbl (copy-alist table))
  17381. (case-fold-search nil)
  17382. (pchg 0)
  17383. e re rpl)
  17384. (while (setq e (pop tbl))
  17385. (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
  17386. (when (and (cdr e) (string-match re (cdr e)))
  17387. (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
  17388. (safe "SREF"))
  17389. (add-text-properties 0 3 (list 'sref sref) safe)
  17390. (setcdr e (replace-match safe t t (cdr e)))))
  17391. (while (string-match re string)
  17392. (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
  17393. (cdr e)))
  17394. (setq string (replace-match rpl t t string))))
  17395. (while (setq pchg (next-property-change pchg string))
  17396. (let ((sref (get-text-property pchg 'sref string)))
  17397. (when (and sref (string-match "SREF" string pchg))
  17398. (setq string (replace-match sref t t string)))))
  17399. string))
  17400. (defun org-sublist (list start end)
  17401. "Return a section of LIST, from START to END.
  17402. Counting starts at 1."
  17403. (let (rtn (c start))
  17404. (setq list (nthcdr (1- start) list))
  17405. (while (and list (<= c end))
  17406. (push (pop list) rtn)
  17407. (setq c (1+ c)))
  17408. (nreverse rtn)))
  17409. (defun org-find-base-buffer-visiting (file)
  17410. "Like `find-buffer-visiting' but always return the base buffer and
  17411. not an indirect buffer."
  17412. (let ((buf (or (get-file-buffer file)
  17413. (find-buffer-visiting file))))
  17414. (if buf
  17415. (or (buffer-base-buffer buf) buf)
  17416. nil)))
  17417. (defun org-image-file-name-regexp (&optional extensions)
  17418. "Return regexp matching the file names of images.
  17419. If EXTENSIONS is given, only match these."
  17420. (if (and (not extensions) (fboundp 'image-file-name-regexp))
  17421. (image-file-name-regexp)
  17422. (let ((image-file-name-extensions
  17423. (or extensions
  17424. '("png" "jpeg" "jpg" "gif" "tiff" "tif"
  17425. "xbm" "xpm" "pbm" "pgm" "ppm"))))
  17426. (concat "\\."
  17427. (regexp-opt (nconc (mapcar 'upcase
  17428. image-file-name-extensions)
  17429. image-file-name-extensions)
  17430. t)
  17431. "\\'"))))
  17432. (defun org-file-image-p (file &optional extensions)
  17433. "Return non-nil if FILE is an image."
  17434. (save-match-data
  17435. (string-match (org-image-file-name-regexp extensions) file)))
  17436. (defun org-get-cursor-date ()
  17437. "Return the date at cursor in as a time.
  17438. This works in the calendar and in the agenda, anywhere else it just
  17439. returns the current time."
  17440. (let (date day defd)
  17441. (cond
  17442. ((eq major-mode 'calendar-mode)
  17443. (setq date (calendar-cursor-to-date)
  17444. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  17445. ((eq major-mode 'org-agenda-mode)
  17446. (setq day (get-text-property (point) 'day))
  17447. (if day
  17448. (setq date (calendar-gregorian-from-absolute day)
  17449. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  17450. (nth 2 date))))))
  17451. (or defd (current-time))))
  17452. (defvar org-agenda-action-marker (make-marker)
  17453. "Marker pointing to the entry for the next agenda action.")
  17454. (defun org-mark-entry-for-agenda-action ()
  17455. "Mark the current entry as target of an agenda action.
  17456. Agenda actions are actions executed from the agenda with the key `k',
  17457. which make use of the date at the cursor."
  17458. (interactive)
  17459. (move-marker org-agenda-action-marker
  17460. (save-excursion (org-back-to-heading t) (point))
  17461. (current-buffer))
  17462. (message
  17463. "Entry marked for action; press `k' at desired date in agenda or calendar"))
  17464. (defun org-mark-subtree ()
  17465. "Mark the current subtree.
  17466. This puts point at the start of the current subtree, and mark at the end.
  17467. If point is in an inline task, mark that task instead."
  17468. (interactive)
  17469. (let ((inline-task-p
  17470. (and (featurep 'org-inlinetask)
  17471. (org-inlinetask-in-task-p)))
  17472. (beg))
  17473. ;; Get beginning of subtree
  17474. (cond
  17475. (inline-task-p (org-inlinetask-goto-beginning))
  17476. ((org-at-heading-p) (beginning-of-line))
  17477. (t (org-with-limited-levels (outline-previous-visible-heading 1))))
  17478. (setq beg (point))
  17479. ;; Get end of it
  17480. (if inline-task-p
  17481. (org-inlinetask-goto-end)
  17482. (org-end-of-subtree))
  17483. ;; Mark zone
  17484. (push-mark (point) nil t)
  17485. (goto-char beg)))
  17486. ;;; Paragraph filling stuff.
  17487. ;; We want this to be just right, so use the full arsenal.
  17488. (defun org-indent-line-function ()
  17489. "Indent line depending on context."
  17490. (interactive)
  17491. (let* ((pos (point))
  17492. (itemp (org-at-item-p))
  17493. (case-fold-search t)
  17494. (org-drawer-regexp (or org-drawer-regexp "\000"))
  17495. (inline-task-p (and (featurep 'org-inlinetask)
  17496. (org-inlinetask-in-task-p)))
  17497. (inline-re (and inline-task-p
  17498. (org-inlinetask-outline-regexp)))
  17499. column)
  17500. (beginning-of-line 1)
  17501. (cond
  17502. ;; Comments
  17503. ((looking-at "# ") (setq column 0))
  17504. ;; Headings
  17505. ((looking-at "\\*+ ") (setq column 0))
  17506. ;; Included files
  17507. ((looking-at "#\\+include:") (setq column 0))
  17508. ;; Footnote definition
  17509. ((looking-at org-footnote-definition-re) (setq column 0))
  17510. ;; Literal examples
  17511. ((looking-at "[ \t]*:[ \t]")
  17512. (setq column (org-get-indentation))) ; do nothing
  17513. ;; Lists
  17514. ((ignore-errors (goto-char (org-in-item-p)))
  17515. (setq column (if itemp
  17516. (org-get-indentation)
  17517. (org-list-item-body-column (point))))
  17518. (goto-char pos))
  17519. ;; Drawers
  17520. ((and (looking-at "[ \t]*:END:")
  17521. (save-excursion (re-search-backward org-drawer-regexp nil t)))
  17522. (save-excursion
  17523. (goto-char (1- (match-beginning 1)))
  17524. (setq column (current-column))))
  17525. ;; Special blocks
  17526. ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
  17527. (save-excursion
  17528. (re-search-backward
  17529. (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
  17530. (setq column (org-get-indentation (match-string 0))))
  17531. ((and (not (looking-at "[ \t]*#\\+begin_"))
  17532. (org-in-regexps-block-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
  17533. (save-excursion
  17534. (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
  17535. (setq column
  17536. (if (equal (downcase (match-string 1)) "src")
  17537. ;; src blocks: let `org-edit-src-exit' handle them
  17538. (org-get-indentation)
  17539. (org-get-indentation (match-string 0)))))
  17540. ;; This line has nothing special, look at the previous relevant
  17541. ;; line to compute indentation
  17542. (t
  17543. (beginning-of-line 0)
  17544. (while (and (not (bobp))
  17545. (not (looking-at org-drawer-regexp))
  17546. ;; When point started in an inline task, do not move
  17547. ;; above task starting line.
  17548. (not (and inline-task-p (looking-at inline-re)))
  17549. ;; Skip drawers, blocks, empty lines, verbatim,
  17550. ;; comments, tables, footnotes definitions, lists,
  17551. ;; inline tasks.
  17552. (or (and (looking-at "[ \t]*:END:")
  17553. (re-search-backward org-drawer-regexp nil t))
  17554. (and (looking-at "[ \t]*#\\+end_")
  17555. (re-search-backward "[ \t]*#\\+begin_"nil t))
  17556. (looking-at "[ \t]*[\n:#|]")
  17557. (looking-at org-footnote-definition-re)
  17558. (and (ignore-errors (goto-char (org-in-item-p)))
  17559. (goto-char
  17560. (org-list-get-top-point (org-list-struct))))
  17561. (and (not inline-task-p)
  17562. (featurep 'org-inlinetask)
  17563. (org-inlinetask-in-task-p)
  17564. (or (org-inlinetask-goto-beginning) t))))
  17565. (beginning-of-line 0))
  17566. (cond
  17567. ;; There was an heading above.
  17568. ((looking-at "\\*+[ \t]+")
  17569. (if (not org-adapt-indentation)
  17570. (setq column 0)
  17571. (goto-char (match-end 0))
  17572. (setq column (current-column))))
  17573. ;; A drawer had started and is unfinished
  17574. ((looking-at org-drawer-regexp)
  17575. (goto-char (1- (match-beginning 1)))
  17576. (setq column (current-column)))
  17577. ;; Else, nothing noticeable found: get indentation and go on.
  17578. (t (setq column (org-get-indentation))))))
  17579. ;; Now apply indentation and move cursor accordingly
  17580. (goto-char pos)
  17581. (if (<= (current-column) (current-indentation))
  17582. (org-indent-line-to column)
  17583. (save-excursion (org-indent-line-to column)))
  17584. ;; Special polishing for properties, see `org-property-format'
  17585. (setq column (current-column))
  17586. (beginning-of-line 1)
  17587. (if (looking-at
  17588. "\\([ \t]+\\)\\(:[-_0-9a-zA-Z]+:\\)[ \t]*\\(\\S-.*\\(\\S-\\|$\\)\\)")
  17589. (replace-match (concat (match-string 1)
  17590. (format org-property-format
  17591. (match-string 2) (match-string 3)))
  17592. t t))
  17593. (org-move-to-column column)))
  17594. (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
  17595. "Variable to store copy of `adaptive-fill-regexp'.
  17596. Since `adaptive-fill-regexp' is set to never match, we need to
  17597. store a backup of its value before entering `org-mode' so that
  17598. the functionality can be provided as a fall-back.")
  17599. (defun org-set-autofill-regexps ()
  17600. (interactive)
  17601. ;; In the paragraph separator we include headlines, because filling
  17602. ;; text in a line directly attached to a headline would otherwise
  17603. ;; fill the headline as well.
  17604. (org-set-local 'comment-start-skip "^#+[ \t]*")
  17605. (org-set-local 'paragraph-separate "\f\\|\\*+ \\|[ ]*$\\|[ \t]*[:|#]")
  17606. ;; The paragraph starter includes hand-formatted lists.
  17607. (org-set-local
  17608. 'paragraph-start
  17609. (concat
  17610. "\f" "\\|"
  17611. "[ ]*$" "\\|"
  17612. "\\*+ " "\\|"
  17613. "[ \t]*#" "\\|"
  17614. (org-item-re) "\\|"
  17615. "[ \t]*[:|]" "\\|"
  17616. "\\$\\$" "\\|"
  17617. "\\\\\\(begin\\|end\\|[][]\\)"))
  17618. ;; Inhibit auto-fill for headers, tables and fixed-width lines.
  17619. ;; But only if the user has not turned off tables or fixed-width regions
  17620. (org-set-local
  17621. 'auto-fill-inhibit-regexp
  17622. (concat "\\*+ \\|#\\+"
  17623. "\\|[ \t]*" org-keyword-time-regexp
  17624. (if (or org-enable-table-editor org-enable-fixed-width-editor)
  17625. (concat
  17626. "\\|[ \t]*["
  17627. (if org-enable-table-editor "|" "")
  17628. (if org-enable-fixed-width-editor ":" "")
  17629. "]"))))
  17630. ;; We use our own fill-paragraph function, to make sure that tables
  17631. ;; and fixed-width regions are not wrapped. That function will pass
  17632. ;; through to `fill-paragraph' when appropriate.
  17633. (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
  17634. ;; Prevent auto-fill from inserting unwanted new items.
  17635. (org-set-local 'fill-nobreak-predicate
  17636. (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
  17637. fill-nobreak-predicate
  17638. (cons 'org-fill-item-nobreak-p fill-nobreak-predicate)))
  17639. ;; Adaptive filling: To get full control, first make sure that
  17640. ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
  17641. (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
  17642. (org-set-local 'org-adaptive-fill-regexp-backup
  17643. adaptive-fill-regexp))
  17644. (org-set-local 'adaptive-fill-regexp "\000")
  17645. (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
  17646. (org-set-local 'adaptive-fill-function
  17647. 'org-adaptive-fill-function)
  17648. (org-set-local
  17649. 'align-mode-rules-list
  17650. '((org-in-buffer-settings
  17651. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  17652. (modes . '(org-mode))))))
  17653. (defun org-fill-item-nobreak-p ()
  17654. "Non-nil when a line break at point would insert a new item."
  17655. (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
  17656. (defun org-fill-paragraph (&optional justify)
  17657. "Re-align a table, pass through to fill-paragraph if no table."
  17658. (let ((table-p (org-at-table-p))
  17659. (table.el-p (org-at-table.el-p))
  17660. (itemp (org-in-item-p)))
  17661. (cond ((and (equal (char-after (point-at-bol)) ?*)
  17662. (save-excursion (goto-char (point-at-bol))
  17663. (looking-at outline-regexp)))
  17664. t) ; skip headlines
  17665. (table.el-p t) ; skip table.el tables
  17666. (table-p (org-table-align) t) ; align Org tables
  17667. (itemp ; align text in items
  17668. (let* ((struct (save-excursion (goto-char itemp)
  17669. (org-list-struct)))
  17670. (parents (org-list-parents-alist struct))
  17671. (children (org-list-get-children itemp struct parents))
  17672. beg end prev next prefix)
  17673. ;; Determine in which part of item point is: before
  17674. ;; first child, after last child, between two
  17675. ;; sub-lists, or simply in item if there's no child.
  17676. (cond
  17677. ((not children)
  17678. (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
  17679. beg itemp
  17680. end (org-list-get-item-end itemp struct)))
  17681. ((< (point) (setq next (car children)))
  17682. (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
  17683. beg itemp
  17684. end next))
  17685. ((> (point) (setq prev (car (last children))))
  17686. (setq beg (org-list-get-item-end prev struct)
  17687. end (org-list-get-item-end itemp struct)
  17688. prefix (save-excursion
  17689. (goto-char beg)
  17690. (skip-chars-forward " \t")
  17691. (make-string (current-column) ?\ ))))
  17692. (t (catch 'exit
  17693. (while (setq next (pop children))
  17694. (if (> (point) next)
  17695. (setq prev next)
  17696. (setq beg (org-list-get-item-end prev struct)
  17697. end next
  17698. prefix (save-excursion
  17699. (goto-char beg)
  17700. (skip-chars-forward " \t")
  17701. (make-string (current-column) ?\ )))
  17702. (throw 'exit nil))))))
  17703. ;; Use `fill-paragraph' with buffer narrowed to item
  17704. ;; without any child, and with our computed PREFIX.
  17705. (flet ((fill-context-prefix (from to &optional flr) prefix))
  17706. (save-restriction
  17707. (narrow-to-region beg end)
  17708. (save-excursion (fill-paragraph justify)))) t))
  17709. ;; Special case where point is not in a list but is on
  17710. ;; a paragraph adjacent to a list: make sure this paragraph
  17711. ;; doesn't get merged with the end of the list by narrowing
  17712. ;; buffer first.
  17713. ((save-excursion (forward-paragraph -1)
  17714. (setq itemp (org-in-item-p)))
  17715. (let ((struct (save-excursion (goto-char itemp)
  17716. (org-list-struct))))
  17717. (save-restriction
  17718. (narrow-to-region (org-list-get-bottom-point struct)
  17719. (save-excursion (forward-paragraph 1)
  17720. (point)))
  17721. (fill-paragraph justify) t)))
  17722. ;; Else simply call `fill-paragraph'.
  17723. (t nil))))
  17724. ;; For reference, this is the default value of adaptive-fill-regexp
  17725. ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
  17726. (defun org-adaptive-fill-function ()
  17727. "Return a fill prefix for org-mode files."
  17728. (let (itemp)
  17729. (save-excursion
  17730. (cond
  17731. ;; Comment line
  17732. ((looking-at "#[ \t]+")
  17733. (match-string-no-properties 0))
  17734. ;; Plain list item
  17735. ((org-at-item-p)
  17736. (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
  17737. ;; Point is in a list after `backward-paragraph': original
  17738. ;; point wasn't in the list, or filling would have been taken
  17739. ;; care of by `org-auto-fill-function', but the list and the
  17740. ;; real paragraph are not separated by a blank line. Thus, move
  17741. ;; point after the list to go back to real paragraph and
  17742. ;; determine fill-prefix.
  17743. ((setq itemp (org-in-item-p))
  17744. (goto-char itemp)
  17745. (let* ((struct (org-list-struct))
  17746. (bottom (org-list-get-bottom-point struct)))
  17747. (goto-char bottom)
  17748. (make-string (org-get-indentation) ?\ )))
  17749. ;; Other text
  17750. ((looking-at org-adaptive-fill-regexp-backup)
  17751. (match-string-no-properties 0))))))
  17752. (defun org-auto-fill-function ()
  17753. "Auto-fill function."
  17754. (let (itemp prefix)
  17755. ;; When in a list, compute an appropriate fill-prefix and make
  17756. ;; sure it will be used by `do-auto-fill'.
  17757. (if (setq itemp (org-in-item-p))
  17758. (progn
  17759. (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
  17760. (flet ((fill-context-prefix (from to &optional flr) prefix))
  17761. (do-auto-fill)))
  17762. ;; Else just use `do-auto-fill'.
  17763. (do-auto-fill))))
  17764. ;;; Other stuff.
  17765. (defun org-toggle-fixed-width-section (arg)
  17766. "Toggle the fixed-width export.
  17767. If there is no active region, the QUOTE keyword at the current headline is
  17768. inserted or removed. When present, it causes the text between this headline
  17769. and the next to be exported as fixed-width text, and unmodified.
  17770. If there is an active region, this command adds or removes a colon as the
  17771. first character of this line. If the first character of a line is a colon,
  17772. this line is also exported in fixed-width font."
  17773. (interactive "P")
  17774. (let* ((cc 0)
  17775. (regionp (org-region-active-p))
  17776. (beg (if regionp (region-beginning) (point)))
  17777. (end (if regionp (region-end)))
  17778. (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
  17779. (case-fold-search nil)
  17780. (re "[ \t]*\\(: \\)")
  17781. off)
  17782. (if regionp
  17783. (save-excursion
  17784. (goto-char beg)
  17785. (setq cc (current-column))
  17786. (beginning-of-line 1)
  17787. (setq off (looking-at re))
  17788. (while (> nlines 0)
  17789. (setq nlines (1- nlines))
  17790. (beginning-of-line 1)
  17791. (cond
  17792. (arg
  17793. (org-move-to-column cc t)
  17794. (insert ": \n")
  17795. (forward-line -1))
  17796. ((and off (looking-at re))
  17797. (replace-match "" t t nil 1))
  17798. ((not off) (org-move-to-column cc t) (insert ": ")))
  17799. (forward-line 1)))
  17800. (save-excursion
  17801. (org-back-to-heading)
  17802. (if (looking-at (concat outline-regexp
  17803. "\\( *\\<" org-quote-string "\\>[ \t]*\\)"))
  17804. (replace-match "" t t nil 1)
  17805. (if (looking-at outline-regexp)
  17806. (progn
  17807. (goto-char (match-end 0))
  17808. (insert org-quote-string " "))))))))
  17809. (defun org-reftex-citation ()
  17810. "Use reftex-citation to insert a citation into the buffer.
  17811. This looks for a line like
  17812. #+BIBLIOGRAPHY: foo plain option:-d
  17813. and derives from it that foo.bib is the bibliography file relevant
  17814. for this document. It then installs the necessary environment for RefTeX
  17815. to work in this buffer and calls `reftex-citation' to insert a citation
  17816. into the buffer.
  17817. Export of such citations to both LaTeX and HTML is handled by the contributed
  17818. package org-exp-bibtex by Taru Karttunen."
  17819. (interactive)
  17820. (let ((reftex-docstruct-symbol 'rds)
  17821. (reftex-cite-format "\\cite{%l}")
  17822. rds bib)
  17823. (save-excursion
  17824. (save-restriction
  17825. (widen)
  17826. (let ((case-fold-search t)
  17827. (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
  17828. (if (not (save-excursion
  17829. (or (re-search-forward re nil t)
  17830. (re-search-backward re nil t))))
  17831. (error "No bibliography defined in file")
  17832. (setq bib (concat (match-string 1) ".bib")
  17833. rds (list (list 'bib bib)))))))
  17834. (call-interactively 'reftex-citation)))
  17835. ;;;; Functions extending outline functionality
  17836. (defun org-beginning-of-line (&optional arg)
  17837. "Go to the beginning of the current line. If that is invisible, continue
  17838. to a visible line beginning. This makes the function of C-a more intuitive.
  17839. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  17840. first attempt, and only move to after the tags when the cursor is already
  17841. beyond the end of the headline."
  17842. (interactive "P")
  17843. (let ((pos (point))
  17844. (special (if (consp org-special-ctrl-a/e)
  17845. (car org-special-ctrl-a/e)
  17846. org-special-ctrl-a/e))
  17847. refpos)
  17848. (if (org-bound-and-true-p line-move-visual)
  17849. (beginning-of-visual-line 1)
  17850. (beginning-of-line 1))
  17851. (if (and arg (fboundp 'move-beginning-of-line))
  17852. (call-interactively 'move-beginning-of-line)
  17853. (if (bobp)
  17854. nil
  17855. (backward-char 1)
  17856. (if (org-truely-invisible-p)
  17857. (while (and (not (bobp)) (org-truely-invisible-p))
  17858. (backward-char 1)
  17859. (beginning-of-line 1))
  17860. (forward-char 1))))
  17861. (when special
  17862. (cond
  17863. ((and (looking-at org-complex-heading-regexp)
  17864. (= (char-after (match-end 1)) ?\ ))
  17865. (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  17866. (point-at-eol)))
  17867. (goto-char
  17868. (if (eq special t)
  17869. (cond ((> pos refpos) refpos)
  17870. ((= pos (point)) refpos)
  17871. (t (point)))
  17872. (cond ((> pos (point)) (point))
  17873. ((not (eq last-command this-command)) (point))
  17874. (t refpos)))))
  17875. ((org-at-item-p)
  17876. (goto-char
  17877. (if (eq special t)
  17878. (cond ((> pos (match-end 0)) (match-end 0))
  17879. ((= pos (point)) (match-end 0))
  17880. (t (point)))
  17881. (cond ((> pos (point)) (point))
  17882. ((not (eq last-command this-command)) (point))
  17883. (t (match-end 0))))))))
  17884. (org-no-warnings
  17885. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  17886. (defun org-end-of-line (&optional arg)
  17887. "Go to the end of the line.
  17888. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  17889. first attempt, and only move to after the tags when the cursor is already
  17890. beyond the end of the headline."
  17891. (interactive "P")
  17892. (let ((special (if (consp org-special-ctrl-a/e)
  17893. (cdr org-special-ctrl-a/e)
  17894. org-special-ctrl-a/e)))
  17895. (if (or (not special)
  17896. (not (org-on-heading-p))
  17897. arg)
  17898. (call-interactively
  17899. (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
  17900. ((fboundp 'move-end-of-line) 'move-end-of-line)
  17901. (t 'end-of-line)))
  17902. (let ((pos (point)))
  17903. (beginning-of-line 1)
  17904. (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
  17905. (if (eq special t)
  17906. (if (or (< pos (match-beginning 1))
  17907. (= pos (match-end 0)))
  17908. (goto-char (match-beginning 1))
  17909. (goto-char (match-end 0)))
  17910. (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
  17911. (goto-char (match-end 0))
  17912. (goto-char (match-beginning 1))))
  17913. (call-interactively (if (fboundp 'move-end-of-line)
  17914. 'move-end-of-line
  17915. 'end-of-line)))))
  17916. (org-no-warnings
  17917. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  17918. (define-key org-mode-map "\C-a" 'org-beginning-of-line)
  17919. (define-key org-mode-map "\C-e" 'org-end-of-line)
  17920. (defun org-backward-sentence (&optional arg)
  17921. "Go to beginning of sentence, or beginning of table field.
  17922. This will call `backward-sentence' or `org-table-beginning-of-field',
  17923. depending on context."
  17924. (interactive "P")
  17925. (cond
  17926. ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
  17927. (t (call-interactively 'backward-sentence))))
  17928. (defun org-forward-sentence (&optional arg)
  17929. "Go to end of sentence, or end of table field.
  17930. This will call `forward-sentence' or `org-table-end-of-field',
  17931. depending on context."
  17932. (interactive "P")
  17933. (cond
  17934. ((org-at-table-p) (call-interactively 'org-table-end-of-field))
  17935. (t (call-interactively 'forward-sentence))))
  17936. (define-key org-mode-map "\M-a" 'org-backward-sentence)
  17937. (define-key org-mode-map "\M-e" 'org-forward-sentence)
  17938. (defun org-kill-line (&optional arg)
  17939. "Kill line, to tags or end of line."
  17940. (interactive "P")
  17941. (cond
  17942. ((or (not org-special-ctrl-k)
  17943. (bolp)
  17944. (not (org-on-heading-p)))
  17945. (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
  17946. org-ctrl-k-protect-subtree)
  17947. (if (or (eq org-ctrl-k-protect-subtree 'error)
  17948. (not (y-or-n-p "Kill hidden subtree along with headline? ")))
  17949. (error "C-k aborted - would kill hidden subtree")))
  17950. (call-interactively 'kill-line))
  17951. ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
  17952. (kill-region (point) (match-beginning 1))
  17953. (org-set-tags nil t))
  17954. (t (kill-region (point) (point-at-eol)))))
  17955. (define-key org-mode-map "\C-k" 'org-kill-line)
  17956. (defun org-yank (&optional arg)
  17957. "Yank. If the kill is a subtree, treat it specially.
  17958. This command will look at the current kill and check if is a single
  17959. subtree, or a series of subtrees[1]. If it passes the test, and if the
  17960. cursor is at the beginning of a line or after the stars of a currently
  17961. empty headline, then the yank is handled specially. How exactly depends
  17962. on the value of the following variables, both set by default.
  17963. org-yank-folded-subtrees
  17964. When set, the subtree(s) will be folded after insertion, but only
  17965. if doing so would now swallow text after the yanked text.
  17966. org-yank-adjusted-subtrees
  17967. When set, the subtree will be promoted or demoted in order to
  17968. fit into the local outline tree structure, which means that the level
  17969. will be adjusted so that it becomes the smaller one of the two
  17970. *visible* surrounding headings.
  17971. Any prefix to this command will cause `yank' to be called directly with
  17972. no special treatment. In particular, a simple \\[universal-argument] prefix \
  17973. will just
  17974. plainly yank the text as it is.
  17975. \[1] The test checks if the first non-white line is a heading
  17976. and if there are no other headings with fewer stars."
  17977. (interactive "P")
  17978. (org-yank-generic 'yank arg))
  17979. (defun org-yank-generic (command arg)
  17980. "Perform some yank-like command.
  17981. This function implements the behavior described in the `org-yank'
  17982. documentation. However, it has been generalized to work for any
  17983. interactive command with similar behavior."
  17984. ;; pretend to be command COMMAND
  17985. (setq this-command command)
  17986. (if arg
  17987. (call-interactively command)
  17988. (let ((subtreep ; is kill a subtree, and the yank position appropriate?
  17989. (and (org-kill-is-subtree-p)
  17990. (or (bolp)
  17991. (and (looking-at "[ \t]*$")
  17992. (string-match
  17993. "\\`\\*+\\'"
  17994. (buffer-substring (point-at-bol) (point)))))))
  17995. swallowp)
  17996. (cond
  17997. ((and subtreep org-yank-folded-subtrees)
  17998. (let ((beg (point))
  17999. end)
  18000. (if (and subtreep org-yank-adjusted-subtrees)
  18001. (org-paste-subtree nil nil 'for-yank)
  18002. (call-interactively command))
  18003. (setq end (point))
  18004. (goto-char beg)
  18005. (when (and (bolp) subtreep
  18006. (not (setq swallowp
  18007. (org-yank-folding-would-swallow-text beg end))))
  18008. (or (looking-at outline-regexp)
  18009. (re-search-forward (concat "^" outline-regexp) end t))
  18010. (while (and (< (point) end) (looking-at outline-regexp))
  18011. (hide-subtree)
  18012. (org-cycle-show-empty-lines 'folded)
  18013. (condition-case nil
  18014. (outline-forward-same-level 1)
  18015. (error (goto-char end)))))
  18016. (when swallowp
  18017. (message
  18018. "Inserted text not folded because that would swallow text"))
  18019. (goto-char end)
  18020. (skip-chars-forward " \t\n\r")
  18021. (beginning-of-line 1)
  18022. (push-mark beg 'nomsg)))
  18023. ((and subtreep org-yank-adjusted-subtrees)
  18024. (let ((beg (point-at-bol)))
  18025. (org-paste-subtree nil nil 'for-yank)
  18026. (push-mark beg 'nomsg)))
  18027. (t
  18028. (call-interactively command))))))
  18029. (defun org-yank-folding-would-swallow-text (beg end)
  18030. "Would hide-subtree at BEG swallow any text after END?"
  18031. (let (level)
  18032. (save-excursion
  18033. (goto-char beg)
  18034. (when (or (looking-at outline-regexp)
  18035. (re-search-forward (concat "^" outline-regexp) end t))
  18036. (setq level (org-outline-level)))
  18037. (goto-char end)
  18038. (skip-chars-forward " \t\r\n\v\f")
  18039. (if (or (eobp)
  18040. (and (bolp) (looking-at org-outline-regexp)
  18041. (<= (org-outline-level) level)))
  18042. nil ; Nothing would be swallowed
  18043. t)))) ; something would swallow
  18044. (define-key org-mode-map "\C-y" 'org-yank)
  18045. (defun org-truely-invisible-p ()
  18046. "Check if point is at a character currently not visible.
  18047. This version does not only check the character property, but also
  18048. `visible-mode'."
  18049. ;; Early versions of noutline don't have `outline-invisible-p'.
  18050. (if (org-bound-and-true-p visible-mode)
  18051. nil
  18052. (outline-invisible-p)))
  18053. (defun org-invisible-p2 ()
  18054. "Check if point is at a character currently not visible."
  18055. (save-excursion
  18056. (if (and (eolp) (not (bobp))) (backward-char 1))
  18057. ;; Early versions of noutline don't have `outline-invisible-p'.
  18058. (outline-invisible-p)))
  18059. (defun org-back-to-heading (&optional invisible-ok)
  18060. "Call `outline-back-to-heading', but provide a better error message."
  18061. (condition-case nil
  18062. (outline-back-to-heading invisible-ok)
  18063. (error (error "Before first headline at position %d in buffer %s"
  18064. (point) (current-buffer)))))
  18065. (defun org-beginning-of-defun ()
  18066. "Go to the beginning of the subtree, i.e. back to the heading."
  18067. (org-back-to-heading))
  18068. (defun org-end-of-defun ()
  18069. "Go to the end of the subtree."
  18070. (org-end-of-subtree nil t))
  18071. (defun org-before-first-heading-p ()
  18072. "Before first heading?"
  18073. (save-excursion
  18074. (end-of-line)
  18075. (null (re-search-backward "^\\*+ " nil t))))
  18076. (defun org-on-heading-p (&optional ignored)
  18077. (outline-on-heading-p t))
  18078. (defun org-at-heading-p (&optional ignored)
  18079. (outline-on-heading-p t))
  18080. (defun org-point-at-end-of-empty-headline ()
  18081. "If point is at the end of an empty headline, return t, else nil.
  18082. If the heading only contains a TODO keyword, it is still still considered
  18083. empty."
  18084. (and (looking-at "[ \t]*$")
  18085. (save-excursion
  18086. (beginning-of-line 1)
  18087. (let ((case-fold-search nil))
  18088. (looking-at (concat "^\\(\\*+\\)[ \t]+\\(" org-todo-regexp
  18089. "\\)?[ \t]*$"))))))
  18090. (defun org-at-heading-or-item-p ()
  18091. (or (org-on-heading-p) (org-at-item-p)))
  18092. (defun org-on-target-p ()
  18093. (or (org-in-regexp org-radio-target-regexp)
  18094. (org-in-regexp org-target-regexp)))
  18095. (defun org-up-heading-all (arg)
  18096. "Move to the heading line of which the present line is a subheading.
  18097. This function considers both visible and invisible heading lines.
  18098. With argument, move up ARG levels."
  18099. (if (fboundp 'outline-up-heading-all)
  18100. (outline-up-heading-all arg) ; emacs 21 version of outline.el
  18101. (outline-up-heading arg t))) ; emacs 22 version of outline.el
  18102. (defun org-up-heading-safe ()
  18103. "Move to the heading line of which the present line is a subheading.
  18104. This version will not throw an error. It will return the level of the
  18105. headline found, or nil if no higher level is found.
  18106. Also, this function will be a lot faster than `outline-up-heading',
  18107. because it relies on stars being the outline starters. This can really
  18108. make a significant difference in outlines with very many siblings."
  18109. (let (start-level re)
  18110. (org-back-to-heading t)
  18111. (setq start-level (funcall outline-level))
  18112. (if (equal start-level 1)
  18113. nil
  18114. (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
  18115. (if (re-search-backward re nil t)
  18116. (funcall outline-level)))))
  18117. (defun org-first-sibling-p ()
  18118. "Is this heading the first child of its parents?"
  18119. (interactive)
  18120. (let ((re (concat "^" outline-regexp))
  18121. level l)
  18122. (unless (org-at-heading-p t)
  18123. (error "Not at a heading"))
  18124. (setq level (funcall outline-level))
  18125. (save-excursion
  18126. (if (not (re-search-backward re nil t))
  18127. t
  18128. (setq l (funcall outline-level))
  18129. (< l level)))))
  18130. (defun org-goto-sibling (&optional previous)
  18131. "Goto the next sibling, even if it is invisible.
  18132. When PREVIOUS is set, go to the previous sibling instead. Returns t
  18133. when a sibling was found. When none is found, return nil and don't
  18134. move point."
  18135. (let ((fun (if previous 're-search-backward 're-search-forward))
  18136. (pos (point))
  18137. (re (concat "^" outline-regexp))
  18138. level l)
  18139. (when (condition-case nil (org-back-to-heading t) (error nil))
  18140. (setq level (funcall outline-level))
  18141. (catch 'exit
  18142. (or previous (forward-char 1))
  18143. (while (funcall fun re nil t)
  18144. (setq l (funcall outline-level))
  18145. (when (< l level) (goto-char pos) (throw 'exit nil))
  18146. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  18147. (goto-char pos)
  18148. nil))))
  18149. (defun org-show-siblings ()
  18150. "Show all siblings of the current headline."
  18151. (save-excursion
  18152. (while (org-goto-sibling) (org-flag-heading nil)))
  18153. (save-excursion
  18154. (while (org-goto-sibling 'previous)
  18155. (org-flag-heading nil))))
  18156. (defun org-goto-first-child ()
  18157. "Goto the first child, even if it is invisible.
  18158. Return t when a child was found. Otherwise don't move point and
  18159. return nil."
  18160. (let (level (pos (point)) (re (concat "^" outline-regexp)))
  18161. (when (condition-case nil (org-back-to-heading t) (error nil))
  18162. (setq level (outline-level))
  18163. (forward-char 1)
  18164. (if (and (re-search-forward re nil t) (> (outline-level) level))
  18165. (progn (goto-char (match-beginning 0)) t)
  18166. (goto-char pos) nil))))
  18167. (defun org-show-hidden-entry ()
  18168. "Show an entry where even the heading is hidden."
  18169. (save-excursion
  18170. (org-show-entry)))
  18171. (defun org-flag-heading (flag &optional entry)
  18172. "Flag the current heading. FLAG non-nil means make invisible.
  18173. When ENTRY is non-nil, show the entire entry."
  18174. (save-excursion
  18175. (org-back-to-heading t)
  18176. ;; Check if we should show the entire entry
  18177. (if entry
  18178. (progn
  18179. (org-show-entry)
  18180. (save-excursion
  18181. (and (outline-next-heading)
  18182. (org-flag-heading nil))))
  18183. (outline-flag-region (max (point-min) (1- (point)))
  18184. (save-excursion (outline-end-of-heading) (point))
  18185. flag))))
  18186. (defun org-get-next-sibling ()
  18187. "Move to next heading of the same level, and return point.
  18188. If there is no such heading, return nil.
  18189. This is like outline-next-sibling, but invisible headings are ok."
  18190. (let ((level (funcall outline-level)))
  18191. (outline-next-heading)
  18192. (while (and (not (eobp)) (> (funcall outline-level) level))
  18193. (outline-next-heading))
  18194. (if (or (eobp) (< (funcall outline-level) level))
  18195. nil
  18196. (point))))
  18197. (defun org-get-last-sibling ()
  18198. "Move to previous heading of the same level, and return point.
  18199. If there is no such heading, return nil."
  18200. (let ((opoint (point))
  18201. (level (funcall outline-level)))
  18202. (outline-previous-heading)
  18203. (when (and (/= (point) opoint) (outline-on-heading-p t))
  18204. (while (and (> (funcall outline-level) level)
  18205. (not (bobp)))
  18206. (outline-previous-heading))
  18207. (if (< (funcall outline-level) level)
  18208. nil
  18209. (point)))))
  18210. (defun org-end-of-subtree (&optional invisible-OK to-heading)
  18211. ;; This contains an exact copy of the original function, but it uses
  18212. ;; `org-back-to-heading', to make it work also in invisible
  18213. ;; trees. And is uses an invisible-OK argument.
  18214. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  18215. ;; Furthermore, when used inside Org, finding the end of a large subtree
  18216. ;; with many children and grandchildren etc, this can be much faster
  18217. ;; than the outline version.
  18218. (org-back-to-heading invisible-OK)
  18219. (let ((first t)
  18220. (level (funcall outline-level)))
  18221. (if (and (org-mode-p) (< level 1000))
  18222. ;; A true heading (not a plain list item), in Org-mode
  18223. ;; This means we can easily find the end by looking
  18224. ;; only for the right number of stars. Using a regexp to do
  18225. ;; this is so much faster than using a Lisp loop.
  18226. (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
  18227. (forward-char 1)
  18228. (and (re-search-forward re nil 'move) (beginning-of-line 1)))
  18229. ;; something else, do it the slow way
  18230. (while (and (not (eobp))
  18231. (or first (> (funcall outline-level) level)))
  18232. (setq first nil)
  18233. (outline-next-heading)))
  18234. (unless to-heading
  18235. (if (memq (preceding-char) '(?\n ?\^M))
  18236. (progn
  18237. ;; Go to end of line before heading
  18238. (forward-char -1)
  18239. (if (memq (preceding-char) '(?\n ?\^M))
  18240. ;; leave blank line before heading
  18241. (forward-char -1))))))
  18242. (point))
  18243. (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
  18244. "Use Org version in org-mode, for dramatic speed-up."
  18245. (if (org-mode-p)
  18246. (progn
  18247. (org-end-of-subtree nil t)
  18248. (unless (eobp) (backward-char 1)))
  18249. ad-do-it))
  18250. (defun org-end-of-meta-data-and-drawers ()
  18251. "Jump to the first text after meta data and drawers in the current entry.
  18252. This will move over empty lines, lines with planning time stamps,
  18253. clocking lines, and drawers."
  18254. (org-back-to-heading t)
  18255. (let ((end (save-excursion (outline-next-heading) (point)))
  18256. (re (concat "[ \t]*$"
  18257. "\\|"
  18258. "\\(" org-drawer-regexp "\\)" ; group 1 are drawers
  18259. "\\|"
  18260. "\\([ \t]*\\(" org-keyword-time-regexp "\\)\\)")))
  18261. (forward-line 1)
  18262. (while (looking-at (concat "[ \t]*\\(" org-keyword-time-regexp "\\)"))
  18263. (if (not (match-end 1))
  18264. ;; empty or planning line
  18265. (forward-line 1)
  18266. ;; a drawer, find the end
  18267. (re-search-forward "^[ \t]*:END:" end 'move)
  18268. (forward-line 1)))
  18269. (point)))
  18270. (defun org-forward-same-level (arg &optional invisible-ok)
  18271. "Move forward to the arg'th subheading at same level as this one.
  18272. Stop at the first and last subheadings of a superior heading.
  18273. Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
  18274. it wil also look at invisible ones."
  18275. (interactive "p")
  18276. (org-back-to-heading invisible-ok)
  18277. (org-on-heading-p)
  18278. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  18279. (re (format "^\\*\\{1,%d\\} " level))
  18280. l)
  18281. (forward-char 1)
  18282. (while (> arg 0)
  18283. (while (and (re-search-forward re nil 'move)
  18284. (setq l (- (match-end 0) (match-beginning 0) 1))
  18285. (= l level)
  18286. (not invisible-ok)
  18287. (progn (backward-char 1) (outline-invisible-p)))
  18288. (if (< l level) (setq arg 1)))
  18289. (setq arg (1- arg)))
  18290. (beginning-of-line 1)))
  18291. (defun org-backward-same-level (arg &optional invisible-ok)
  18292. "Move backward to the arg'th subheading at same level as this one.
  18293. Stop at the first and last subheadings of a superior heading."
  18294. (interactive "p")
  18295. (org-back-to-heading)
  18296. (org-on-heading-p)
  18297. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  18298. (re (format "^\\*\\{1,%d\\} " level))
  18299. l)
  18300. (while (> arg 0)
  18301. (while (and (re-search-backward re nil 'move)
  18302. (setq l (- (match-end 0) (match-beginning 0) 1))
  18303. (= l level)
  18304. (not invisible-ok)
  18305. (outline-invisible-p))
  18306. (if (< l level) (setq arg 1)))
  18307. (setq arg (1- arg)))))
  18308. (defun org-show-subtree ()
  18309. "Show everything after this heading at deeper levels."
  18310. (outline-flag-region
  18311. (point)
  18312. (save-excursion
  18313. (org-end-of-subtree t t))
  18314. nil))
  18315. (defun org-show-entry ()
  18316. "Show the body directly following this heading.
  18317. Show the heading too, if it is currently invisible."
  18318. (interactive)
  18319. (save-excursion
  18320. (condition-case nil
  18321. (progn
  18322. (org-back-to-heading t)
  18323. (outline-flag-region
  18324. (max (point-min) (1- (point)))
  18325. (save-excursion
  18326. (if (re-search-forward
  18327. (concat "[\r\n]\\(" outline-regexp "\\)") nil t)
  18328. (match-beginning 1)
  18329. (point-max)))
  18330. nil)
  18331. (org-cycle-hide-drawers 'children))
  18332. (error nil))))
  18333. (defun org-make-options-regexp (kwds &optional extra)
  18334. "Make a regular expression for keyword lines."
  18335. (concat
  18336. "^"
  18337. "#?[ \t]*\\+\\("
  18338. (mapconcat 'regexp-quote kwds "\\|")
  18339. (if extra (concat "\\|" extra))
  18340. "\\):[ \t]*"
  18341. "\\(.*\\)"))
  18342. ;; Make isearch reveal the necessary context
  18343. (defun org-isearch-end ()
  18344. "Reveal context after isearch exits."
  18345. (when isearch-success ; only if search was successful
  18346. (if (featurep 'xemacs)
  18347. ;; Under XEmacs, the hook is run in the correct place,
  18348. ;; we directly show the context.
  18349. (org-show-context 'isearch)
  18350. ;; In Emacs the hook runs *before* restoring the overlays.
  18351. ;; So we have to use a one-time post-command-hook to do this.
  18352. ;; (Emacs 22 has a special variable, see function `org-mode')
  18353. (unless (and (boundp 'isearch-mode-end-hook-quit)
  18354. isearch-mode-end-hook-quit)
  18355. ;; Only when the isearch was not quitted.
  18356. (org-add-hook 'post-command-hook 'org-isearch-post-command
  18357. 'append 'local)))))
  18358. (defun org-isearch-post-command ()
  18359. "Remove self from hook, and show context."
  18360. (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
  18361. (org-show-context 'isearch))
  18362. ;;;; Integration with and fixes for other packages
  18363. ;;; Imenu support
  18364. (defvar org-imenu-markers nil
  18365. "All markers currently used by Imenu.")
  18366. (make-variable-buffer-local 'org-imenu-markers)
  18367. (defun org-imenu-new-marker (&optional pos)
  18368. "Return a new marker for use by Imenu, and remember the marker."
  18369. (let ((m (make-marker)))
  18370. (move-marker m (or pos (point)))
  18371. (push m org-imenu-markers)
  18372. m))
  18373. (defun org-imenu-get-tree ()
  18374. "Produce the index for Imenu."
  18375. (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
  18376. (setq org-imenu-markers nil)
  18377. (let* ((n org-imenu-depth)
  18378. (re (concat "^" outline-regexp))
  18379. (subs (make-vector (1+ n) nil))
  18380. (last-level 0)
  18381. m level head)
  18382. (save-excursion
  18383. (save-restriction
  18384. (widen)
  18385. (goto-char (point-max))
  18386. (while (re-search-backward re nil t)
  18387. (setq level (org-reduced-level (funcall outline-level)))
  18388. (when (<= level n)
  18389. (looking-at org-complex-heading-regexp)
  18390. (setq head (org-link-display-format
  18391. (org-match-string-no-properties 4))
  18392. m (org-imenu-new-marker))
  18393. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  18394. (if (>= level last-level)
  18395. (push (cons head m) (aref subs level))
  18396. (push (cons head (aref subs (1+ level))) (aref subs level))
  18397. (loop for i from (1+ level) to n do (aset subs i nil)))
  18398. (setq last-level level)))))
  18399. (aref subs 1)))
  18400. (eval-after-load "imenu"
  18401. '(progn
  18402. (add-hook 'imenu-after-jump-hook
  18403. (lambda ()
  18404. (if (org-mode-p)
  18405. (org-show-context 'org-goto))))))
  18406. (defun org-link-display-format (link)
  18407. "Replace a link with either the description, or the link target
  18408. if no description is present"
  18409. (save-match-data
  18410. (if (string-match org-bracket-link-analytic-regexp link)
  18411. (replace-match (if (match-end 5)
  18412. (match-string 5 link)
  18413. (concat (match-string 1 link)
  18414. (match-string 3 link)))
  18415. nil t link)
  18416. link)))
  18417. ;; Speedbar support
  18418. (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
  18419. "Overlay marking the agenda restriction line in speedbar.")
  18420. (overlay-put org-speedbar-restriction-lock-overlay
  18421. 'face 'org-agenda-restriction-lock)
  18422. (overlay-put org-speedbar-restriction-lock-overlay
  18423. 'help-echo "Agendas are currently limited to this item.")
  18424. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  18425. (defun org-speedbar-set-agenda-restriction ()
  18426. "Restrict future agenda commands to the location at point in speedbar.
  18427. To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
  18428. (interactive)
  18429. (require 'org-agenda)
  18430. (let (p m tp np dir txt)
  18431. (cond
  18432. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  18433. 'org-imenu t))
  18434. (setq m (get-text-property p 'org-imenu-marker))
  18435. (with-current-buffer (marker-buffer m)
  18436. (goto-char m)
  18437. (org-agenda-set-restriction-lock 'subtree)))
  18438. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  18439. 'speedbar-function 'speedbar-find-file))
  18440. (setq tp (previous-single-property-change
  18441. (1+ p) 'speedbar-function)
  18442. np (next-single-property-change
  18443. tp 'speedbar-function)
  18444. dir (speedbar-line-directory)
  18445. txt (buffer-substring-no-properties (or tp (point-min))
  18446. (or np (point-max))))
  18447. (with-current-buffer (find-file-noselect
  18448. (let ((default-directory dir))
  18449. (expand-file-name txt)))
  18450. (unless (org-mode-p)
  18451. (error "Cannot restrict to non-Org-mode file"))
  18452. (org-agenda-set-restriction-lock 'file)))
  18453. (t (error "Don't know how to restrict Org-mode's agenda")))
  18454. (move-overlay org-speedbar-restriction-lock-overlay
  18455. (point-at-bol) (point-at-eol))
  18456. (setq current-prefix-arg nil)
  18457. (org-agenda-maybe-redo)))
  18458. (eval-after-load "speedbar"
  18459. '(progn
  18460. (speedbar-add-supported-extension ".org")
  18461. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  18462. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  18463. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  18464. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  18465. (add-hook 'speedbar-visiting-tag-hook
  18466. (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
  18467. ;;; Fixes and Hacks for problems with other packages
  18468. ;; Make flyspell not check words in links, to not mess up our keymap
  18469. (defun org-mode-flyspell-verify ()
  18470. "Don't let flyspell put overlays at active buttons."
  18471. (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
  18472. (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
  18473. (defun org-remove-flyspell-overlays-in (beg end)
  18474. "Remove flyspell overlays in region."
  18475. (and (org-bound-and-true-p flyspell-mode)
  18476. (fboundp 'flyspell-delete-region-overlays)
  18477. (flyspell-delete-region-overlays beg end))
  18478. (add-text-properties beg end '(org-no-flyspell t)))
  18479. ;; Make `bookmark-jump' shows the jump location if it was hidden.
  18480. (eval-after-load "bookmark"
  18481. '(if (boundp 'bookmark-after-jump-hook)
  18482. ;; We can use the hook
  18483. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  18484. ;; Hook not available, use advice
  18485. (defadvice bookmark-jump (after org-make-visible activate)
  18486. "Make the position visible."
  18487. (org-bookmark-jump-unhide))))
  18488. ;; Make sure saveplace shows the location if it was hidden
  18489. (eval-after-load "saveplace"
  18490. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  18491. "Make the position visible."
  18492. (org-bookmark-jump-unhide)))
  18493. ;; Make sure ecb shows the location if it was hidden
  18494. (eval-after-load "ecb"
  18495. '(defadvice ecb-method-clicked (after esf/org-show-context activate)
  18496. "Make hierarchy visible when jumping into location from ECB tree buffer."
  18497. (if (org-mode-p)
  18498. (org-show-context))))
  18499. (defun org-bookmark-jump-unhide ()
  18500. "Unhide the current position, to show the bookmark location."
  18501. (and (org-mode-p)
  18502. (or (outline-invisible-p)
  18503. (save-excursion (goto-char (max (point-min) (1- (point))))
  18504. (outline-invisible-p)))
  18505. (org-show-context 'bookmark-jump)))
  18506. ;; Make session.el ignore our circular variable
  18507. (eval-after-load "session"
  18508. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  18509. ;;;; Experimental code
  18510. (defun org-closed-in-range ()
  18511. "Sparse tree of items closed in a certain time range.
  18512. Still experimental, may disappear in the future."
  18513. (interactive)
  18514. ;; Get the time interval from the user.
  18515. (let* ((time1 (org-float-time
  18516. (org-read-date nil 'to-time nil "Starting date: ")))
  18517. (time2 (org-float-time
  18518. (org-read-date nil 'to-time nil "End date:")))
  18519. ;; callback function
  18520. (callback (lambda ()
  18521. (let ((time
  18522. (org-float-time
  18523. (apply 'encode-time
  18524. (org-parse-time-string
  18525. (match-string 1))))))
  18526. ;; check if time in interval
  18527. (and (>= time time1) (<= time time2))))))
  18528. ;; make tree, check each match with the callback
  18529. (org-occur "CLOSED: +\\[\\(.*?\\)\\]" nil callback)))
  18530. ;;;; Finish up
  18531. (provide 'org)
  18532. (run-hooks 'org-load-hook)
  18533. ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
  18534. ;;; org.el ends here