org.el 619 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609
  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
  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: 6.26trans
  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. ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
  73. ;; the file noutline.el being loaded.
  74. (if (featurep 'xemacs) (condition-case nil (require 'noutline)))
  75. ;; We require noutline, which might be provided in outline.el
  76. (require 'outline) (require 'noutline)
  77. ;; Other stuff we need.
  78. (require 'time-date)
  79. (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
  80. (require 'easymenu)
  81. (require 'org-macs)
  82. (require 'org-compat)
  83. (require 'org-faces)
  84. (require 'org-list)
  85. (require 'org-footnote)
  86. ;;;; Customization variables
  87. ;;; Version
  88. (defconst org-version "6.26trans"
  89. "The version number of the file org.el.")
  90. (defun org-version (&optional here)
  91. "Show the org-mode version in the echo area.
  92. With prefix arg HERE, insert it at point."
  93. (interactive "P")
  94. (let ((version (format "Org-mode version %s" org-version)))
  95. (message version)
  96. (if here
  97. (insert version))))
  98. ;;; Compatibility constants
  99. ;;; The custom variables
  100. (defgroup org nil
  101. "Outline-based notes management and organizer."
  102. :tag "Org"
  103. :group 'outlines
  104. :group 'hypermedia
  105. :group 'calendar)
  106. (defcustom org-load-hook nil
  107. "Hook that is run after org.el has been loaded."
  108. :group 'org
  109. :type 'hook)
  110. (defvar org-modules) ; defined below
  111. (defvar org-modules-loaded nil
  112. "Have the modules been loaded already?")
  113. (defun org-load-modules-maybe (&optional force)
  114. "Load all extensions listed in `org-modules'."
  115. (when (or force (not org-modules-loaded))
  116. (mapc (lambda (ext)
  117. (condition-case nil (require ext)
  118. (error (message "Problems while trying to load feature `%s'" ext))))
  119. org-modules)
  120. (setq org-modules-loaded t)))
  121. (defun org-set-modules (var value)
  122. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  123. (set var value)
  124. (when (featurep 'org)
  125. (org-load-modules-maybe 'force)))
  126. (when (org-bound-and-true-p org-modules)
  127. (let ((a (member 'org-infojs org-modules)))
  128. (and a (setcar a 'org-jsinfo))))
  129. (defcustom org-modules '(org-bbdb org-bibtex org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
  130. "Modules that should always be loaded together with org.el.
  131. If a description starts with <C>, the file is not part of Emacs
  132. and loading it will require that you have downloaded and properly installed
  133. the org-mode distribution.
  134. You can also use this system to load external packages (i.e. neither Org
  135. core modules, not modules from the CONTRIB directory). Just add symbols
  136. to the end of the list. If the package is called org-xyz.el, then you need
  137. to add the symbol `xyz', and the package must have a call to
  138. (provide 'org-xyz)"
  139. :group 'org
  140. :set 'org-set-modules
  141. :type
  142. '(set :greedy t
  143. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  144. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  145. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  146. (const :tag " id: Global IDs for identifying entries" org-id)
  147. (const :tag " info: Links to Info nodes" org-info)
  148. (const :tag " jsinfo: Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
  149. (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
  150. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  151. (const :tag " mac-message: Links to messages in Apple Mail" org-mac-message)
  152. (const :tag " mew Links to Mew folders/messages" org-mew)
  153. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  154. (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
  155. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  156. (const :tag " vm: Links to VM folders/messages" org-vm)
  157. (const :tag " wl: Links to Wanderlust folders/messages" org-wl)
  158. (const :tag " w3m: Special cut/paste from w3m to Org." org-w3m)
  159. (const :tag " mouse: Additional mouse support" org-mouse)
  160. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  161. (const :tag "C annotation-helper: Call Remember directly from Browser (OBSOLETE, use org-protocol)" org-annotation-helper)
  162. (const :tag "C bookmark: Org links to bookmarks" org-bookmark)
  163. (const :tag "C browser-url: Store link, directly from Browser (OBSOLETE, use org-protocol)" org-browser-url)
  164. (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
  165. (const :tag "C collector: Collect properties into tables" org-collector)
  166. (const :tag "C depend: TODO dependencies for Org-mode (PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
  167. (const :tag "C elisp-symbol: Org links to emacs-lisp symbols" org-elisp-symbol)
  168. (const :tag "C eval: Include command output as text" org-eval)
  169. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  170. (const :tag "C expiry: Expiry mechanism for Org entries" org-expiry)
  171. (const :tag "C exp-bibtex: Export citations using BibTeX" org-exp-bibtex)
  172. (const :tag "C exp-blocks: Pre-process blocks for export" org-exp-blocks)
  173. (const :tag "C interactive-query: Interactive modification of tags query (PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
  174. (const :tag "C mairix: Hook mairix search into Org for different MUAs" org-mairix)
  175. (const :tag "C man: Support for links to manpages in Org-mode" org-man)
  176. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  177. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  178. (const :tag "C R: Computation using the R language" org-R)
  179. (const :tag "C registry: A registry for Org links" org-registry)
  180. (const :tag "C org2rem: Convert org appointments into reminders" org2rem)
  181. (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
  182. (const :tag "C special-blocks: Turn blocks into LaTeX envs and HTML divs" org-special-blocks)
  183. (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
  184. (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
  185. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  186. (defcustom org-support-shift-select nil
  187. "Non-nil means, make shift-cursor commands select text when possible.
  188. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
  189. selecting a region, or enlarge thusly regions started in this way.
  190. In Org-mode, in special contexts, these same keys are used for other
  191. purposes, important enough to compete with shift selection. Org tries
  192. to balance these needs by supporting `shift-select-mode' outside these
  193. special contexts, under control of this variable.
  194. The default of this variable is nil, to avoid confusing behavior. Shifted
  195. cursor keys will then execute Org commands in the following contexts:
  196. - on a headline, changing TODO state (left/right) and priority (up/down)
  197. - on a time stamp, changing the time
  198. - in a plain list item, changing the bullet type
  199. - in a property definition line, switching between allowed values
  200. - in the BEGIN line of a clock table (changing the time block).
  201. Outside these contexts, the commands will throw an error.
  202. When this variable is t and the cursor is not in a special context,
  203. Org-mode will support shift-selection for making and enlarging regions.
  204. To make this more effective, the bullet cycling will no longer happen
  205. anywhere in an item line, but only if the cursor is exactly on the bullet.
  206. If you set this variable to the symbol `always', then the keys
  207. will not be special in headlines, property lines, and item lines, to make
  208. shift selection work there as well. If this is what you want, you can
  209. use the following alternative commands: `C-c C-t' and `C-c ,' to
  210. change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
  211. TODO sets, `C-c -' to cycle item bullet types, and properties can be
  212. edited by hand or in column view.
  213. However, when the cursor is on a timestamp, shift-cursor commands
  214. will still edit the time stamp - this is just too good to give up.
  215. XEmacs user should have this variable set to nil, because shift-select-mode
  216. is Emacs 23 only."
  217. :group 'org
  218. :type '(choice
  219. (const :tag "Never" nil)
  220. (const :tag "When outside special context" t)
  221. (const :tag "Everywhere except timestamps" always)))
  222. (defgroup org-startup nil
  223. "Options concerning startup of Org-mode."
  224. :tag "Org Startup"
  225. :group 'org)
  226. (defcustom org-startup-folded t
  227. "Non-nil means, entering Org-mode will switch to OVERVIEW.
  228. This can also be configured on a per-file basis by adding one of
  229. the following lines anywhere in the buffer:
  230. #+STARTUP: fold
  231. #+STARTUP: nofold
  232. #+STARTUP: content"
  233. :group 'org-startup
  234. :type '(choice
  235. (const :tag "nofold: show all" nil)
  236. (const :tag "fold: overview" t)
  237. (const :tag "content: all headlines" content)))
  238. (defcustom org-startup-truncated t
  239. "Non-nil means, entering Org-mode will set `truncate-lines'.
  240. This is useful since some lines containing links can be very long and
  241. uninteresting. Also tables look terrible when wrapped."
  242. :group 'org-startup
  243. :type 'boolean)
  244. (defcustom org-startup-align-all-tables nil
  245. "Non-nil means, align all tables when visiting a file.
  246. This is useful when the column width in tables is forced with <N> cookies
  247. in table fields. Such tables will look correct only after the first re-align.
  248. This can also be configured on a per-file basis by adding one of
  249. the following lines anywhere in the buffer:
  250. #+STARTUP: align
  251. #+STARTUP: noalign"
  252. :group 'org-startup
  253. :type 'boolean)
  254. (defcustom org-insert-mode-line-in-empty-file nil
  255. "Non-nil means insert the first line setting Org-mode in empty files.
  256. When the function `org-mode' is called interactively in an empty file, this
  257. normally means that the file name does not automatically trigger Org-mode.
  258. To ensure that the file will always be in Org-mode in the future, a
  259. line enforcing Org-mode will be inserted into the buffer, if this option
  260. has been set."
  261. :group 'org-startup
  262. :type 'boolean)
  263. (defcustom org-replace-disputed-keys nil
  264. "Non-nil means use alternative key bindings for some keys.
  265. Org-mode uses S-<cursor> keys for changing timestamps and priorities.
  266. These keys are also used by other packages like shift-selection-mode'
  267. \(built into Emacs 23), `CUA-mode' or `windmove.el'.
  268. If you want to use Org-mode together with one of these other modes,
  269. or more generally if you would like to move some Org-mode commands to
  270. other keys, set this variable and configure the keys with the variable
  271. `org-disputed-keys'.
  272. This option is only relevant at load-time of Org-mode, and must be set
  273. *before* org.el is loaded. Changing it requires a restart of Emacs to
  274. become effective."
  275. :group 'org-startup
  276. :type 'boolean)
  277. (defcustom org-use-extra-keys nil
  278. "Non-nil means use extra key sequence definitions for certain
  279. commands. This happens automatically if you run XEmacs or if
  280. window-system is nil. This variable lets you do the same
  281. manually. You must set it before loading org.
  282. Example: on Carbon Emacs 22 running graphically, with an external
  283. keyboard on a Powerbook, the default way of setting M-left might
  284. not work for either Alt or ESC. Setting this variable will make
  285. it work for ESC."
  286. :group 'org-startup
  287. :type 'boolean)
  288. (if (fboundp 'defvaralias)
  289. (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys))
  290. (defcustom org-disputed-keys
  291. '(([(shift up)] . [(meta p)])
  292. ([(shift down)] . [(meta n)])
  293. ([(shift left)] . [(meta -)])
  294. ([(shift right)] . [(meta +)])
  295. ([(control shift right)] . [(meta shift +)])
  296. ([(control shift left)] . [(meta shift -)]))
  297. "Keys for which Org-mode and other modes compete.
  298. This is an alist, cars are the default keys, second element specifies
  299. the alternative to use when `org-replace-disputed-keys' is t.
  300. Keys can be specified in any syntax supported by `define-key'.
  301. The value of this option takes effect only at Org-mode's startup,
  302. therefore you'll have to restart Emacs to apply it after changing."
  303. :group 'org-startup
  304. :type 'alist)
  305. (defun org-key (key)
  306. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  307. Or return the original if not disputed."
  308. (if org-replace-disputed-keys
  309. (let* ((nkey (key-description key))
  310. (x (org-find-if (lambda (x)
  311. (equal (key-description (car x)) nkey))
  312. org-disputed-keys)))
  313. (if x (cdr x) key))
  314. key))
  315. (defun org-find-if (predicate seq)
  316. (catch 'exit
  317. (while seq
  318. (if (funcall predicate (car seq))
  319. (throw 'exit (car seq))
  320. (pop seq)))))
  321. (defun org-defkey (keymap key def)
  322. "Define a key, possibly translated, as returned by `org-key'."
  323. (define-key keymap (org-key key) def))
  324. (defcustom org-ellipsis nil
  325. "The ellipsis to use in the Org-mode outline.
  326. When nil, just use the standard three dots. When a string, use that instead,
  327. When a face, use the standard 3 dots, but with the specified face.
  328. The change affects only Org-mode (which will then use its own display table).
  329. Changing this requires executing `M-x org-mode' in a buffer to become
  330. effective."
  331. :group 'org-startup
  332. :type '(choice (const :tag "Default" nil)
  333. (face :tag "Face" :value org-warning)
  334. (string :tag "String" :value "...#")))
  335. (defvar org-display-table nil
  336. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  337. (defgroup org-keywords nil
  338. "Keywords in Org-mode."
  339. :tag "Org Keywords"
  340. :group 'org)
  341. (defcustom org-deadline-string "DEADLINE:"
  342. "String to mark deadline entries.
  343. A deadline is this string, followed by a time stamp. Should be a word,
  344. terminated by a colon. You can insert a schedule keyword and
  345. a timestamp with \\[org-deadline].
  346. Changes become only effective after restarting Emacs."
  347. :group 'org-keywords
  348. :type 'string)
  349. (defcustom org-scheduled-string "SCHEDULED:"
  350. "String to mark scheduled TODO entries.
  351. A schedule is this string, followed by a time stamp. Should be a word,
  352. terminated by a colon. You can insert a schedule keyword and
  353. a timestamp with \\[org-schedule].
  354. Changes become only effective after restarting Emacs."
  355. :group 'org-keywords
  356. :type 'string)
  357. (defcustom org-closed-string "CLOSED:"
  358. "String used as the prefix for timestamps logging closing a TODO entry."
  359. :group 'org-keywords
  360. :type 'string)
  361. (defcustom org-clock-string "CLOCK:"
  362. "String used as prefix for timestamps clocking work hours on an item."
  363. :group 'org-keywords
  364. :type 'string)
  365. (defcustom org-comment-string "COMMENT"
  366. "Entries starting with this keyword will never be exported.
  367. An entry can be toggled between COMMENT and normal with
  368. \\[org-toggle-comment].
  369. Changes become only effective after restarting Emacs."
  370. :group 'org-keywords
  371. :type 'string)
  372. (defcustom org-quote-string "QUOTE"
  373. "Entries starting with this keyword will be exported in fixed-width font.
  374. Quoting applies only to the text in the entry following the headline, and does
  375. not extend beyond the next headline, even if that is lower level.
  376. An entry can be toggled between QUOTE and normal with
  377. \\[org-toggle-fixed-width-section]."
  378. :group 'org-keywords
  379. :type 'string)
  380. (defconst org-repeat-re
  381. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*\\([.+]?\\+[0-9]+[dwmy]\\)"
  382. "Regular expression for specifying repeated events.
  383. After a match, group 1 contains the repeat expression.")
  384. (defgroup org-structure nil
  385. "Options concerning the general structure of Org-mode files."
  386. :tag "Org Structure"
  387. :group 'org)
  388. (defgroup org-reveal-location nil
  389. "Options about how to make context of a location visible."
  390. :tag "Org Reveal Location"
  391. :group 'org-structure)
  392. (defconst org-context-choice
  393. '(choice
  394. (const :tag "Always" t)
  395. (const :tag "Never" nil)
  396. (repeat :greedy t :tag "Individual contexts"
  397. (cons
  398. (choice :tag "Context"
  399. (const agenda)
  400. (const org-goto)
  401. (const occur-tree)
  402. (const tags-tree)
  403. (const link-search)
  404. (const mark-goto)
  405. (const bookmark-jump)
  406. (const isearch)
  407. (const default))
  408. (boolean))))
  409. "Contexts for the reveal options.")
  410. (defcustom org-show-hierarchy-above '((default . t))
  411. "Non-nil means, show full hierarchy when revealing a location.
  412. Org-mode often shows locations in an org-mode file which might have
  413. been invisible before. When this is set, the hierarchy of headings
  414. above the exposed location is shown.
  415. Turning this off for example for sparse trees makes them very compact.
  416. Instead of t, this can also be an alist specifying this option for different
  417. contexts. Valid contexts are
  418. agenda when exposing an entry from the agenda
  419. org-goto when using the command `org-goto' on key C-c C-j
  420. occur-tree when using the command `org-occur' on key C-c /
  421. tags-tree when constructing a sparse tree based on tags matches
  422. link-search when exposing search matches associated with a link
  423. mark-goto when exposing the jump goal of a mark
  424. bookmark-jump when exposing a bookmark location
  425. isearch when exiting from an incremental search
  426. default default for all contexts not set explicitly"
  427. :group 'org-reveal-location
  428. :type org-context-choice)
  429. (defcustom org-show-following-heading '((default . nil))
  430. "Non-nil means, show following heading when revealing a location.
  431. Org-mode often shows locations in an org-mode file which might have
  432. been invisible before. When this is set, the heading following the
  433. match is shown.
  434. Turning this off for example for sparse trees makes them very compact,
  435. but makes it harder to edit the location of the match. In such a case,
  436. use the command \\[org-reveal] to show more context.
  437. Instead of t, this can also be an alist specifying this option for different
  438. contexts. See `org-show-hierarchy-above' for valid contexts."
  439. :group 'org-reveal-location
  440. :type org-context-choice)
  441. (defcustom org-show-siblings '((default . nil) (isearch t))
  442. "Non-nil means, show all sibling heading when revealing a location.
  443. Org-mode often shows locations in an org-mode file which might have
  444. been invisible before. When this is set, the sibling of the current entry
  445. heading are all made visible. If `org-show-hierarchy-above' is t,
  446. the same happens on each level of the hierarchy above the current entry.
  447. By default this is on for the isearch context, off for all other contexts.
  448. Turning this off for example for sparse trees makes them very compact,
  449. but makes it harder to edit the location of the match. In such a case,
  450. use the command \\[org-reveal] to show more context.
  451. Instead of t, this can also be an alist specifying this option for different
  452. contexts. See `org-show-hierarchy-above' for valid contexts."
  453. :group 'org-reveal-location
  454. :type org-context-choice)
  455. (defcustom org-show-entry-below '((default . nil))
  456. "Non-nil means, show the entry below a headline when revealing a location.
  457. Org-mode often shows locations in an org-mode file which might have
  458. been invisible before. When this is set, the text below the headline that is
  459. exposed is also shown.
  460. By default this is off for all contexts.
  461. Instead of t, this can also be an alist specifying this option for different
  462. contexts. See `org-show-hierarchy-above' for valid contexts."
  463. :group 'org-reveal-location
  464. :type org-context-choice)
  465. (defcustom org-indirect-buffer-display 'other-window
  466. "How should indirect tree buffers be displayed?
  467. This applies to indirect buffers created with the commands
  468. \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
  469. Valid values are:
  470. current-window Display in the current window
  471. other-window Just display in another window.
  472. dedicated-frame Create one new frame, and re-use it each time.
  473. new-frame Make a new frame each time. Note that in this case
  474. previously-made indirect buffers are kept, and you need to
  475. kill these buffers yourself."
  476. :group 'org-structure
  477. :group 'org-agenda-windows
  478. :type '(choice
  479. (const :tag "In current window" current-window)
  480. (const :tag "In current frame, other window" other-window)
  481. (const :tag "Each time a new frame" new-frame)
  482. (const :tag "One dedicated frame" dedicated-frame)))
  483. (defgroup org-cycle nil
  484. "Options concerning visibility cycling in Org-mode."
  485. :tag "Org Cycle"
  486. :group 'org-structure)
  487. (defcustom org-cycle-max-level nil
  488. "Maximum level which should still be subject to visibility cycling.
  489. Levels higher than this will, for cycling, be treated as text, not a headline.
  490. When `org-odd-levels-only' is set, a value of N in this variable actually
  491. means 2N-1 stars as the limiting headline.
  492. When nil, cycle all levels.
  493. Note that the limiting level of cycling is also influenced by
  494. `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
  495. `org-inlinetask-min-level' is, cycling will be limited to levels one less
  496. than its value."
  497. :group 'org-cycle
  498. :type '(choice
  499. (const :tag "No limit" nil)
  500. (integer :tag "Maximum level")))
  501. (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK")
  502. "Names of drawers. Drawers are not opened by cycling on the headline above.
  503. Drawers only open with a TAB on the drawer line itself. A drawer looks like
  504. this:
  505. :DRAWERNAME:
  506. .....
  507. :END:
  508. The drawer \"PROPERTIES\" is special for capturing properties through
  509. the property API.
  510. Drawers can be defined on the per-file basis with a line like:
  511. #+DRAWERS: HIDDEN STATE PROPERTIES"
  512. :group 'org-structure
  513. :group 'org-cycle
  514. :type '(repeat (string :tag "Drawer Name")))
  515. (defcustom org-cycle-global-at-bob nil
  516. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  517. This makes it possible to do global cycling without having to use S-TAB or
  518. C-u TAB. For this special case to work, the first line of the buffer
  519. must not be a headline - it may be empty or some other text. When used in
  520. this way, `org-cycle-hook' is disables temporarily, to make sure the
  521. cursor stays at the beginning of the buffer.
  522. When this option is nil, don't do anything special at the beginning
  523. of the buffer."
  524. :group 'org-cycle
  525. :type 'boolean)
  526. (defcustom org-cycle-emulate-tab t
  527. "Where should `org-cycle' emulate TAB.
  528. nil Never
  529. white Only in completely white lines
  530. whitestart Only at the beginning of lines, before the first non-white char
  531. t Everywhere except in headlines
  532. exc-hl-bol Everywhere except at the start of a headline
  533. If TAB is used in a place where it does not emulate TAB, the current subtree
  534. visibility is cycled."
  535. :group 'org-cycle
  536. :type '(choice (const :tag "Never" nil)
  537. (const :tag "Only in completely white lines" white)
  538. (const :tag "Before first char in a line" whitestart)
  539. (const :tag "Everywhere except in headlines" t)
  540. (const :tag "Everywhere except at bol in headlines" exc-hl-bol)
  541. ))
  542. (defcustom org-cycle-separator-lines 2
  543. "Number of empty lines needed to keep an empty line between collapsed trees.
  544. If you leave an empty line between the end of a subtree and the following
  545. headline, this empty line is hidden when the subtree is folded.
  546. Org-mode will leave (exactly) one empty line visible if the number of
  547. empty lines is equal or larger to the number given in this variable.
  548. So the default 2 means, at least 2 empty lines after the end of a subtree
  549. are needed to produce free space between a collapsed subtree and the
  550. following headline.
  551. Special case: when 0, never leave empty lines in collapsed view."
  552. :group 'org-cycle
  553. :type 'integer)
  554. (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
  555. (defcustom org-pre-cycle-hook nil
  556. "Hook that is run before visibility cycling is happening.
  557. The function(s) in this hook must accept a single argument which indicates
  558. the new state that will be set right after running this hook. The
  559. argument is a symbol. Before a global state change, it can have the values
  560. `overview', `content', or `all'. Before a local state change, it can have
  561. the values `folded', `children', or `subtree'."
  562. :group 'org-cycle
  563. :type 'hook)
  564. (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
  565. org-cycle-hide-drawers
  566. org-cycle-show-empty-lines
  567. org-optimize-window-after-visibility-change)
  568. "Hook that is run after `org-cycle' has changed the buffer visibility.
  569. The function(s) in this hook must accept a single argument which indicates
  570. the new state that was set by the most recent `org-cycle' command. The
  571. argument is a symbol. After a global state change, it can have the values
  572. `overview', `content', or `all'. After a local state change, it can have
  573. the values `folded', `children', or `subtree'."
  574. :group 'org-cycle
  575. :type 'hook)
  576. (defgroup org-edit-structure nil
  577. "Options concerning structure editing in Org-mode."
  578. :tag "Org Edit Structure"
  579. :group 'org-structure)
  580. (defcustom org-odd-levels-only nil
  581. "Non-nil means, skip even levels and only use odd levels for the outline.
  582. This has the effect that two stars are being added/taken away in
  583. promotion/demotion commands. It also influences how levels are
  584. handled by the exporters.
  585. Changing it requires restart of `font-lock-mode' to become effective
  586. for fontification also in regions already fontified.
  587. You may also set this on a per-file basis by adding one of the following
  588. lines to the buffer:
  589. #+STARTUP: odd
  590. #+STARTUP: oddeven"
  591. :group 'org-edit-structure
  592. :group 'org-font-lock
  593. :type 'boolean)
  594. (defcustom org-adapt-indentation t
  595. "Non-nil means, adapt indentation when promoting and demoting.
  596. When this is set and the *entire* text in an entry is indented, the
  597. indentation is increased by one space in a demotion command, and
  598. decreased by one in a promotion command. If any line in the entry
  599. body starts at column 0, indentation is not changed at all."
  600. :group 'org-edit-structure
  601. :type 'boolean)
  602. (defcustom org-special-ctrl-a/e nil
  603. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  604. When t, `C-a' will bring back the cursor to the beginning of the
  605. headline text, i.e. after the stars and after a possible TODO keyword.
  606. In an item, this will be the position after the bullet.
  607. When the cursor is already at that position, another `C-a' will bring
  608. it to the beginning of the line.
  609. `C-e' will jump to the end of the headline, ignoring the presence of tags
  610. in the headline. A second `C-e' will then jump to the true end of the
  611. line, after any tags.
  612. When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
  613. and only a directly following, identical keypress will bring the cursor
  614. to the special positions.
  615. This may also be a cons cell where the behavior for `C-a' and `C-e' is
  616. set separately."
  617. :group 'org-edit-structure
  618. :type '(choice
  619. (const :tag "off" nil)
  620. (const :tag "after stars/bullet and before tags first" t)
  621. (const :tag "true line boundary first" reversed)
  622. (cons :tag "Set C-a and C-e separately"
  623. (choice :tag "Special C-a"
  624. (const :tag "off" nil)
  625. (const :tag "after stars/bullet first" t)
  626. (const :tag "before stars/bullet first" reversed))
  627. (choice :tag "Special C-e"
  628. (const :tag "off" nil)
  629. (const :tag "before tags first" t)
  630. (const :tag "after tags first" reversed)))))
  631. (if (fboundp 'defvaralias)
  632. (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
  633. (defcustom org-special-ctrl-k nil
  634. "Non-nil means `C-k' will behave specially in headlines.
  635. When nil, `C-k' will call the default `kill-line' command.
  636. When t, the following will happen while the cursor is in the headline:
  637. - When the cursor is at the beginning of a headline, kill the entire
  638. line and possible the folded subtree below the line.
  639. - When in the middle of the headline text, kill the headline up to the tags.
  640. - When after the headline text, kill the tags."
  641. :group 'org-edit-structure
  642. :type 'boolean)
  643. (defcustom org-yank-folded-subtrees t
  644. "Non-nil means, when yanking subtrees, fold them.
  645. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  646. it starts with a heading and all other headings in it are either children
  647. or siblings, then fold all the subtrees. However, do this only if no
  648. text after the yank would be swallowed into a folded tree by this action."
  649. :group 'org-edit-structure
  650. :type 'boolean)
  651. (defcustom org-yank-adjusted-subtrees nil
  652. "Non-nil means, when yanking subtrees, adjust the level.
  653. With this setting, `org-paste-subtree' is used to insert the subtree, see
  654. this function for details."
  655. :group 'org-edit-structure
  656. :type 'boolean)
  657. (defcustom org-M-RET-may-split-line '((default . t))
  658. "Non-nil means, M-RET will split the line at the cursor position.
  659. When nil, it will go to the end of the line before making a
  660. new line.
  661. You may also set this option in a different way for different
  662. contexts. Valid contexts are:
  663. headline when creating a new headline
  664. item when creating a new item
  665. table in a table field
  666. default the value to be used for all contexts not explicitly
  667. customized"
  668. :group 'org-structure
  669. :group 'org-table
  670. :type '(choice
  671. (const :tag "Always" t)
  672. (const :tag "Never" nil)
  673. (repeat :greedy t :tag "Individual contexts"
  674. (cons
  675. (choice :tag "Context"
  676. (const headline)
  677. (const item)
  678. (const table)
  679. (const default))
  680. (boolean)))))
  681. (defcustom org-insert-heading-respect-content nil
  682. "Non-nil means, insert new headings after the current subtree.
  683. When nil, the new heading is created directly after the current line.
  684. The commands \\[org-insert-heading-respect-content] and
  685. \\[org-insert-todo-heading-respect-content] turn this variable on
  686. for the duration of the command."
  687. :group 'org-structure
  688. :type 'boolean)
  689. (defcustom org-blank-before-new-entry '((heading . auto)
  690. (plain-list-item . auto))
  691. "Should `org-insert-heading' leave a blank line before new heading/item?
  692. The value is an alist, with `heading' and `plain-list-item' as car,
  693. and a boolean flag as cdr. For plain lists, if the variable
  694. `org-empty-line-terminates-plain-lists' is set, the setting here
  695. is ignored and no empty line is inserted, to keep the list in tact."
  696. :group 'org-edit-structure
  697. :type '(list
  698. (cons (const heading)
  699. (choice (const :tag "Never" nil)
  700. (const :tag "Always" t)
  701. (const :tag "Auto" auto)))
  702. (cons (const plain-list-item)
  703. (choice (const :tag "Never" nil)
  704. (const :tag "Always" t)
  705. (const :tag "Auto" auto)))))
  706. (defcustom org-insert-heading-hook nil
  707. "Hook being run after inserting a new heading."
  708. :group 'org-edit-structure
  709. :type 'hook)
  710. (defcustom org-enable-fixed-width-editor t
  711. "Non-nil means, lines starting with \":\" are treated as fixed-width.
  712. This currently only means, they are never auto-wrapped.
  713. When nil, such lines will be treated like ordinary lines.
  714. See also the QUOTE keyword."
  715. :group 'org-edit-structure
  716. :type 'boolean)
  717. (defcustom org-edit-src-region-extra nil
  718. "Additional regexps to identify regions for editing with `org-edit-src-code'.
  719. For examples see the function `org-edit-src-find-region-and-lang'.
  720. The regular expression identifying the begin marker should end with a newline,
  721. and the regexp marking the end line should start with a newline, to make sure
  722. there are kept outside the narrowed region."
  723. :group 'org-edit-structure
  724. :type '(repeat
  725. (list
  726. (regexp :tag "begin regexp")
  727. (regexp :tag "end regexp")
  728. (choice :tag "language"
  729. (string :tag "specify")
  730. (integer :tag "from match group")
  731. (const :tag "from `lang' element")
  732. (const :tag "from `style' element")))))
  733. (defcustom org-coderef-label-format "(ref:%s)"
  734. "The default coderef format.
  735. This format string will be used to search for coderef labels in literal
  736. examples (EXAMPLE and SRC blocks). The format can be overwritten
  737. an individual literal example with the -f option, like
  738. #+BEGIN_SRC pascal +n -r -l \"((%s))\"
  739. ...
  740. #+END_SRC
  741. If you want to use this for HTML export, make sure that the format does
  742. not introduce special font-locking, and avoid the HTML special
  743. characters `<', `>', and `&'. The reason for this restriction is that
  744. the labels are searched for only after htmlize has done its job."
  745. :group 'org-edit-structure ; FIXME this is not in the right group
  746. :type 'string)
  747. (defcustom org-edit-fixed-width-region-mode 'artist-mode
  748. "The mode that should be used to edit fixed-width regions.
  749. These are the regions where each line starts with a colon."
  750. :group 'org-edit-structure
  751. :type '(choice
  752. (const artist-mode)
  753. (const picture-mode)
  754. (const fundamental-mode)
  755. (function :tag "Other (specify)")))
  756. (defcustom org-edit-src-persistent-message t
  757. "Non-nil means show persistent exit help message while editing src examples.
  758. The message is shown in the header-line, which will be created in the
  759. first line of the window showing the editing buffer.
  760. When nil, the message will only be shown intermittently in the echo area."
  761. :group 'org-edit-structure
  762. :type 'boolean)
  763. (defcustom org-goto-auto-isearch t
  764. "Non-nil means, typing characters in org-goto starts incremental search."
  765. :group 'org-edit-structure
  766. :type 'boolean)
  767. (defgroup org-sparse-trees nil
  768. "Options concerning sparse trees in Org-mode."
  769. :tag "Org Sparse Trees"
  770. :group 'org-structure)
  771. (defcustom org-highlight-sparse-tree-matches t
  772. "Non-nil means, highlight all matches that define a sparse tree.
  773. The highlights will automatically disappear the next time the buffer is
  774. changed by an edit command."
  775. :group 'org-sparse-trees
  776. :type 'boolean)
  777. (defcustom org-remove-highlights-with-change t
  778. "Non-nil means, any change to the buffer will remove temporary highlights.
  779. Such highlights are created by `org-occur' and `org-clock-display'.
  780. When nil, `C-c C-c needs to be used to get rid of the highlights.
  781. The highlights created by `org-preview-latex-fragment' always need
  782. `C-c C-c' to be removed."
  783. :group 'org-sparse-trees
  784. :group 'org-time
  785. :type 'boolean)
  786. (defcustom org-occur-hook '(org-first-headline-recenter)
  787. "Hook that is run after `org-occur' has constructed a sparse tree.
  788. This can be used to recenter the window to show as much of the structure
  789. as possible."
  790. :group 'org-sparse-trees
  791. :type 'hook)
  792. (defgroup org-imenu-and-speedbar nil
  793. "Options concerning imenu and speedbar in Org-mode."
  794. :tag "Org Imenu and Speedbar"
  795. :group 'org-structure)
  796. (defcustom org-imenu-depth 2
  797. "The maximum level for Imenu access to Org-mode headlines.
  798. This also applied for speedbar access."
  799. :group 'org-imenu-and-speedbar
  800. :type 'integer)
  801. (defgroup org-table nil
  802. "Options concerning tables in Org-mode."
  803. :tag "Org Table"
  804. :group 'org)
  805. (defcustom org-enable-table-editor 'optimized
  806. "Non-nil means, lines starting with \"|\" are handled by the table editor.
  807. When nil, such lines will be treated like ordinary lines.
  808. When equal to the symbol `optimized', the table editor will be optimized to
  809. do the following:
  810. - Automatic overwrite mode in front of whitespace in table fields.
  811. This makes the structure of the table stay in tact as long as the edited
  812. field does not exceed the column width.
  813. - Minimize the number of realigns. Normally, the table is aligned each time
  814. TAB or RET are pressed to move to another field. With optimization this
  815. happens only if changes to a field might have changed the column width.
  816. Optimization requires replacing the functions `self-insert-command',
  817. `delete-char', and `backward-delete-char' in Org-mode buffers, with a
  818. slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
  819. very good at guessing when a re-align will be necessary, but you can always
  820. force one with \\[org-ctrl-c-ctrl-c].
  821. If you would like to use the optimized version in Org-mode, but the
  822. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  823. This variable can be used to turn on and off the table editor during a session,
  824. but in order to toggle optimization, a restart is required.
  825. See also the variable `org-table-auto-blank-field'."
  826. :group 'org-table
  827. :type '(choice
  828. (const :tag "off" nil)
  829. (const :tag "on" t)
  830. (const :tag "on, optimized" optimized)))
  831. (defcustom org-self-insert-cluster-for-undo t
  832. "Non-nil means cluster self-insert commands for undo when possible.
  833. If this is set, then, like in the Emacs command loop, 20 consequtive
  834. characters will be undone together.
  835. This is configurable, because there is some impact on typing performance."
  836. :group 'org-table
  837. :type 'boolean)
  838. (defcustom org-table-tab-recognizes-table.el t
  839. "Non-nil means, TAB will automatically notice a table.el table.
  840. When it sees such a table, it moves point into it and - if necessary -
  841. calls `table-recognize-table'."
  842. :group 'org-table-editing
  843. :type 'boolean)
  844. (defgroup org-link nil
  845. "Options concerning links in Org-mode."
  846. :tag "Org Link"
  847. :group 'org)
  848. (defvar org-link-abbrev-alist-local nil
  849. "Buffer-local version of `org-link-abbrev-alist', which see.
  850. The value of this is taken from the #+LINK lines.")
  851. (make-variable-buffer-local 'org-link-abbrev-alist-local)
  852. (defcustom org-link-abbrev-alist nil
  853. "Alist of link abbreviations.
  854. The car of each element is a string, to be replaced at the start of a link.
  855. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  856. links in Org-mode buffers can have an optional tag after a double colon, e.g.
  857. [[linkkey:tag][description]]
  858. The 'linkkey' must be a word word, starting with a letter, followed
  859. by letters, numbers, '-' or '_'.
  860. If REPLACE is a string, the tag will simply be appended to create the link.
  861. If the string contains \"%s\", the tag will be inserted there. Alternatively,
  862. the placeholder \"%h\" will cause a url-encoded version of the tag to
  863. be inserted at that point (see the function `url-hexify-string').
  864. REPLACE may also be a function that will be called with the tag as the
  865. only argument to create the link, which should be returned as a string.
  866. See the manual for examples."
  867. :group 'org-link
  868. :type '(repeat
  869. (cons
  870. (string :tag "Protocol")
  871. (choice
  872. (string :tag "Format")
  873. (function)))))
  874. (defcustom org-descriptive-links t
  875. "Non-nil means, hide link part and only show description of bracket links.
  876. Bracket links are like [[link][description]]. This variable sets the initial
  877. state in new org-mode buffers. The setting can then be toggled on a
  878. per-buffer basis from the Org->Hyperlinks menu."
  879. :group 'org-link
  880. :type 'boolean)
  881. (defcustom org-link-file-path-type 'adaptive
  882. "How the path name in file links should be stored.
  883. Valid values are:
  884. relative Relative to the current directory, i.e. the directory of the file
  885. into which the link is being inserted.
  886. absolute Absolute path, if possible with ~ for home directory.
  887. noabbrev Absolute path, no abbreviation of home directory.
  888. adaptive Use relative path for files in the current directory and sub-
  889. directories of it. For other files, use an absolute path."
  890. :group 'org-link
  891. :type '(choice
  892. (const relative)
  893. (const absolute)
  894. (const noabbrev)
  895. (const adaptive)))
  896. (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
  897. "Types of links that should be activated in Org-mode files.
  898. This is a list of symbols, each leading to the activation of a certain link
  899. type. In principle, it does not hurt to turn on most link types - there may
  900. be a small gain when turning off unused link types. The types are:
  901. bracket The recommended [[link][description]] or [[link]] links with hiding.
  902. angular Links in angular brackets that may contain whitespace like
  903. <bbdb:Carsten Dominik>.
  904. plain Plain links in normal text, no whitespace, like http://google.com.
  905. radio Text that is matched by a radio target, see manual for details.
  906. tag Tag settings in a headline (link to tag search).
  907. date Time stamps (link to calendar).
  908. footnote Footnote labels.
  909. Changing this variable requires a restart of Emacs to become effective."
  910. :group 'org-link
  911. :type '(set :greedy t
  912. (const :tag "Double bracket links (new style)" bracket)
  913. (const :tag "Angular bracket links (old style)" angular)
  914. (const :tag "Plain text links" plain)
  915. (const :tag "Radio target matches" radio)
  916. (const :tag "Tags" tag)
  917. (const :tag "Timestamps" date)
  918. (const :tag "Footnotes" footnote)))
  919. (defcustom org-make-link-description-function nil
  920. "Function to use to generate link descriptions from links. If
  921. nil the link location will be used. This function must take two
  922. parameters; the first is the link and the second the description
  923. org-insert-link has generated, and should return the description
  924. to use."
  925. :group 'org-link
  926. :type 'function)
  927. (defgroup org-link-store nil
  928. "Options concerning storing links in Org-mode."
  929. :tag "Org Store Link"
  930. :group 'org-link)
  931. (defcustom org-email-link-description-format "Email %c: %.30s"
  932. "Format of the description part of a link to an email or usenet message.
  933. The following %-escapes will be replaced by corresponding information:
  934. %F full \"From\" field
  935. %f name, taken from \"From\" field, address if no name
  936. %T full \"To\" field
  937. %t first name in \"To\" field, address if no name
  938. %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
  939. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  940. %s subject
  941. %m message-id.
  942. You may use normal field width specification between the % and the letter.
  943. This is for example useful to limit the length of the subject.
  944. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  945. :group 'org-link-store
  946. :type 'string)
  947. (defcustom org-from-is-user-regexp
  948. (let (r1 r2)
  949. (when (and user-mail-address (not (string= user-mail-address "")))
  950. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  951. (when (and user-full-name (not (string= user-full-name "")))
  952. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  953. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  954. "Regexp matched against the \"From:\" header of an email or usenet message.
  955. It should match if the message is from the user him/herself."
  956. :group 'org-link-store
  957. :type 'regexp)
  958. (defcustom org-link-to-org-use-id 'create-if-interactive-and-no-custom-id
  959. "Non-nil means, storing a link to an Org file will use entry IDs.
  960. Note that before this variable is even considered, org-id must be loaded,
  961. to please customize `org-modules' and turn it on.
  962. The variable can have the following values:
  963. t Create an ID if needed to make a link to the current entry.
  964. create-if-interactive
  965. If `org-store-link' is called directly (interactively, as a user
  966. command), do create an ID to support the link. But when doing the
  967. job for remember, only use the ID if it already exists. The
  968. purpose of this setting is to avoid proliferation of unwanted
  969. IDs, just because you happen to be in an Org file when you
  970. call `org-remember' that automatically and preemptively
  971. creates a link. If you do want to get an ID link in a remember
  972. template to an entry not having an ID, create it first by
  973. explicitly creating a link to it, using `C-c C-l' first.
  974. use-existing
  975. Use existing ID, do not create one.
  976. nil Never use an ID to make a link, instead link using a text search for
  977. the headline text."
  978. :group 'org-link-store
  979. :type '(choice
  980. (const :tag "Create ID to make link" t)
  981. (const :tag "Create if storing link interactively"
  982. create-if-interactive)
  983. (const :tag "Create if storing link interactively and no CUSTOM_ID is present"
  984. create-if-interactive-and-no-custom-id)
  985. (const :tag "Only use existing" use-existing)
  986. (const :tag "Do not use ID to create link" nil)))
  987. (defcustom org-context-in-file-links t
  988. "Non-nil means, file links from `org-store-link' contain context.
  989. A search string will be added to the file name with :: as separator and
  990. used to find the context when the link is activated by the command
  991. `org-open-at-point'.
  992. Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  993. negates this setting for the duration of the command."
  994. :group 'org-link-store
  995. :type 'boolean)
  996. (defcustom org-keep-stored-link-after-insertion nil
  997. "Non-nil means, keep link in list for entire session.
  998. The command `org-store-link' adds a link pointing to the current
  999. location to an internal list. These links accumulate during a session.
  1000. The command `org-insert-link' can be used to insert links into any
  1001. Org-mode file (offering completion for all stored links). When this
  1002. option is nil, every link which has been inserted once using \\[org-insert-link]
  1003. will be removed from the list, to make completing the unused links
  1004. more efficient."
  1005. :group 'org-link-store
  1006. :type 'boolean)
  1007. (defgroup org-link-follow nil
  1008. "Options concerning following links in Org-mode."
  1009. :tag "Org Follow Link"
  1010. :group 'org-link)
  1011. (defcustom org-link-translation-function nil
  1012. "Function to translate links with different syntax to Org syntax.
  1013. This can be used to translate links created for example by the Planner
  1014. or emacs-wiki packages to Org syntax.
  1015. The function must accept two parameters, a TYPE containing the link
  1016. protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
  1017. which is everything after the link protocol. It should return a cons
  1018. with possibly modified values of type and path.
  1019. Org contains a function for this, so if you set this variable to
  1020. `org-translate-link-from-planner', you should be able follow many
  1021. links created by planner."
  1022. :group 'org-link-follow
  1023. :type 'function)
  1024. (defcustom org-follow-link-hook nil
  1025. "Hook that is run after a link has been followed."
  1026. :group 'org-link-follow
  1027. :type 'hook)
  1028. (defcustom org-tab-follows-link nil
  1029. "Non-nil means, on links TAB will follow the link.
  1030. Needs to be set before org.el is loaded.
  1031. This really should not be used, it does not make sense, and the
  1032. implementation is bad."
  1033. :group 'org-link-follow
  1034. :type 'boolean)
  1035. (defcustom org-return-follows-link nil
  1036. "Non-nil means, on links RET will follow the link.
  1037. Needs to be set before org.el is loaded."
  1038. :group 'org-link-follow
  1039. :type 'boolean)
  1040. (defcustom org-mouse-1-follows-link
  1041. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  1042. "Non-nil means, mouse-1 on a link will follow the link.
  1043. A longer mouse click will still set point. Does not work on XEmacs.
  1044. Needs to be set before org.el is loaded."
  1045. :group 'org-link-follow
  1046. :type 'boolean)
  1047. (defcustom org-mark-ring-length 4
  1048. "Number of different positions to be recorded in the ring
  1049. Changing this requires a restart of Emacs to work correctly."
  1050. :group 'org-link-follow
  1051. :type 'integer)
  1052. (defcustom org-link-frame-setup
  1053. '((vm . vm-visit-folder-other-frame)
  1054. (gnus . gnus-other-frame)
  1055. (file . find-file-other-window))
  1056. "Setup the frame configuration for following links.
  1057. When following a link with Emacs, it may often be useful to display
  1058. this link in another window or frame. This variable can be used to
  1059. set this up for the different types of links.
  1060. For VM, use any of
  1061. `vm-visit-folder'
  1062. `vm-visit-folder-other-frame'
  1063. For Gnus, use any of
  1064. `gnus'
  1065. `gnus-other-frame'
  1066. `org-gnus-no-new-news'
  1067. For FILE, use any of
  1068. `find-file'
  1069. `find-file-other-window'
  1070. `find-file-other-frame'
  1071. For the calendar, use the variable `calendar-setup'.
  1072. For BBDB, it is currently only possible to display the matches in
  1073. another window."
  1074. :group 'org-link-follow
  1075. :type '(list
  1076. (cons (const vm)
  1077. (choice
  1078. (const vm-visit-folder)
  1079. (const vm-visit-folder-other-window)
  1080. (const vm-visit-folder-other-frame)))
  1081. (cons (const gnus)
  1082. (choice
  1083. (const gnus)
  1084. (const gnus-other-frame)
  1085. (const org-gnus-no-new-news)))
  1086. (cons (const file)
  1087. (choice
  1088. (const find-file)
  1089. (const find-file-other-window)
  1090. (const find-file-other-frame)))))
  1091. (defcustom org-display-internal-link-with-indirect-buffer nil
  1092. "Non-nil means, use indirect buffer to display infile links.
  1093. Activating internal links (from one location in a file to another location
  1094. in the same file) normally just jumps to the location. When the link is
  1095. activated with a C-u prefix (or with mouse-3), the link is displayed in
  1096. another window. When this option is set, the other window actually displays
  1097. an indirect buffer clone of the current buffer, to avoid any visibility
  1098. changes to the current buffer."
  1099. :group 'org-link-follow
  1100. :type 'boolean)
  1101. (defcustom org-open-non-existing-files nil
  1102. "Non-nil means, `org-open-file' will open non-existing files.
  1103. When nil, an error will be generated."
  1104. :group 'org-link-follow
  1105. :type 'boolean)
  1106. (defcustom org-open-directory-means-index-dot-org nil
  1107. "Non-nil means, a link to a directory really means to index.org.
  1108. When nil, following a directory link will run dired or open a finder/explorer
  1109. window on that directory."
  1110. :group 'org-link-follow
  1111. :type 'boolean)
  1112. (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
  1113. "Function and arguments to call for following mailto links.
  1114. This is a list with the first element being a lisp function, and the
  1115. remaining elements being arguments to the function. In string arguments,
  1116. %a will be replaced by the address, and %s will be replaced by the subject
  1117. if one was given like in <mailto:arthur@galaxy.org::this subject>."
  1118. :group 'org-link-follow
  1119. :type '(choice
  1120. (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
  1121. (const :tag "compose-mail" (compose-mail "%a" "%s"))
  1122. (const :tag "message-mail" (message-mail "%a" "%s"))
  1123. (cons :tag "other" (function) (repeat :tag "argument" sexp))))
  1124. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  1125. "Non-nil means, ask for confirmation before executing shell links.
  1126. Shell links can be dangerous: just think about a link
  1127. [[shell:rm -rf ~/*][Google Search]]
  1128. This link would show up in your Org-mode document as \"Google Search\",
  1129. but really it would remove your entire home directory.
  1130. Therefore we advise against setting this variable to nil.
  1131. Just change it to `y-or-n-p' if you want to confirm with a
  1132. single keystroke rather than having to type \"yes\"."
  1133. :group 'org-link-follow
  1134. :type '(choice
  1135. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1136. (const :tag "with y-or-n (faster)" y-or-n-p)
  1137. (const :tag "no confirmation (dangerous)" nil)))
  1138. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  1139. "Non-nil means, ask for confirmation before executing Emacs Lisp links.
  1140. Elisp links can be dangerous: just think about a link
  1141. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  1142. This link would show up in your Org-mode document as \"Google Search\",
  1143. but really it would remove your entire home directory.
  1144. Therefore we advise against setting this variable to nil.
  1145. Just change it to `y-or-n-p' if you want to confirm with a
  1146. single keystroke rather than having to type \"yes\"."
  1147. :group 'org-link-follow
  1148. :type '(choice
  1149. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1150. (const :tag "with y-or-n (faster)" y-or-n-p)
  1151. (const :tag "no confirmation (dangerous)" nil)))
  1152. (defconst org-file-apps-defaults-gnu
  1153. '((remote . emacs)
  1154. (system . mailcap)
  1155. (t . mailcap))
  1156. "Default file applications on a UNIX or GNU/Linux system.
  1157. See `org-file-apps'.")
  1158. (defconst org-file-apps-defaults-macosx
  1159. '((remote . emacs)
  1160. (t . "open %s")
  1161. (system . "open %s")
  1162. ("ps.gz" . "gv %s")
  1163. ("eps.gz" . "gv %s")
  1164. ("dvi" . "xdvi %s")
  1165. ("fig" . "xfig %s"))
  1166. "Default file applications on a MacOS X system.
  1167. The system \"open\" is known as a default, but we use X11 applications
  1168. for some files for which the OS does not have a good default.
  1169. See `org-file-apps'.")
  1170. (defconst org-file-apps-defaults-windowsnt
  1171. (list
  1172. '(remote . emacs)
  1173. (cons t
  1174. (list (if (featurep 'xemacs)
  1175. 'mswindows-shell-execute
  1176. 'w32-shell-execute)
  1177. "open" 'file))
  1178. (cons 'system
  1179. (list (if (featurep 'xemacs)
  1180. 'mswindows-shell-execute
  1181. 'w32-shell-execute)
  1182. "open" 'file)))
  1183. "Default file applications on a Windows NT system.
  1184. The system \"open\" is used for most files.
  1185. See `org-file-apps'.")
  1186. (defcustom org-file-apps
  1187. '(
  1188. (auto-mode . emacs)
  1189. ("\\.x?html?\\'" . default)
  1190. ("\\.pdf\\'" . default)
  1191. )
  1192. "External applications for opening `file:path' items in a document.
  1193. Org-mode uses system defaults for different file types, but
  1194. you can use this variable to set the application for a given file
  1195. extension. The entries in this list are cons cells where the car identifies
  1196. files and the cdr the corresponding command. Possible values for the
  1197. file identifier are
  1198. \"regex\" Regular expression matched against the file name. For backward
  1199. compatibility, this can also be a string with only alphanumeric
  1200. characters, which is then interpreted as an extension.
  1201. `directory' Matches a directory
  1202. `remote' Matches a remote file, accessible through tramp or efs.
  1203. Remote files most likely should be visited through Emacs
  1204. because external applications cannot handle such paths.
  1205. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1206. so all files Emacs knows how to handle. Using this with
  1207. command `emacs' will open most files in Emacs. Beware that this
  1208. will also open html files inside Emacs, unless you add
  1209. (\"html\" . default) to the list as well.
  1210. t Default for files not matched by any of the other options.
  1211. `system' The system command to open files, like `open' on Windows
  1212. and Mac OS X, and mailcap under GNU/Linux. This is the command
  1213. that will be selected if you call `C-c C-o' with a double
  1214. `C-u C-u' prefix.
  1215. Possible values for the command are:
  1216. `emacs' The file will be visited by the current Emacs process.
  1217. `default' Use the default application for this file type, which is the
  1218. association for t in the list, most likely in the system-specific
  1219. part.
  1220. This can be used to overrule an unwanted setting in the
  1221. system-specific variable.
  1222. `system' Use the system command for opening files, like \"open\".
  1223. This command is specified by the entry whose car is `system'.
  1224. Most likely, the system-specific version of this variable
  1225. does define this command, but you can overrule/replace it
  1226. here.
  1227. string A command to be executed by a shell; %s will be replaced
  1228. by the path to the file.
  1229. sexp A Lisp form which will be evaluated. The file path will
  1230. be available in the Lisp variable `file'.
  1231. For more examples, see the system specific constants
  1232. `org-file-apps-defaults-macosx'
  1233. `org-file-apps-defaults-windowsnt'
  1234. `org-file-apps-defaults-gnu'."
  1235. :group 'org-link-follow
  1236. :type '(repeat
  1237. (cons (choice :value ""
  1238. (string :tag "Extension")
  1239. (const :tag "System command to open files" system)
  1240. (const :tag "Default for unrecognized files" t)
  1241. (const :tag "Remote file" remote)
  1242. (const :tag "Links to a directory" directory)
  1243. (const :tag "Any files that have Emacs modes"
  1244. auto-mode))
  1245. (choice :value ""
  1246. (const :tag "Visit with Emacs" emacs)
  1247. (const :tag "Use default" default)
  1248. (const :tag "Use the system command" system)
  1249. (string :tag "Command")
  1250. (sexp :tag "Lisp form")))))
  1251. (defgroup org-refile nil
  1252. "Options concerning refiling entries in Org-mode."
  1253. :tag "Org Refile"
  1254. :group 'org)
  1255. (defcustom org-directory "~/org"
  1256. "Directory with org files.
  1257. This is just a default location to look for Org files. There is no need
  1258. at all to put your files into this directory. It is only used in the
  1259. following situations:
  1260. 1. When a remember template specifies a target file that is not an
  1261. absolute path. The path will then be interpreted relative to
  1262. `org-directory'
  1263. 2. When a remember note is filed away in an interactive way (when exiting the
  1264. note buffer with `C-1 C-c C-c'. The the user is prompted for an org file,
  1265. with `org-directory' as the default path."
  1266. :group 'org-refile
  1267. :group 'org-remember
  1268. :type 'directory)
  1269. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  1270. "Default target for storing notes.
  1271. Used by the hooks for remember.el. This can be a string, or nil to mean
  1272. the value of `remember-data-file'.
  1273. You can set this on a per-template basis with the variable
  1274. `org-remember-templates'."
  1275. :group 'org-refile
  1276. :group 'org-remember
  1277. :type '(choice
  1278. (const :tag "Default from remember-data-file" nil)
  1279. file))
  1280. (defcustom org-goto-interface 'outline
  1281. "The default interface to be used for `org-goto'.
  1282. Allowed values are:
  1283. outline The interface shows an outline of the relevant file
  1284. and the correct heading is found by moving through
  1285. the outline or by searching with incremental search.
  1286. outline-path-completion Headlines in the current buffer are offered via
  1287. completion. This is the interface also used by
  1288. the refile command."
  1289. :group 'org-refile
  1290. :type '(choice
  1291. (const :tag "Outline" outline)
  1292. (const :tag "Outline-path-completion" outline-path-completion)))
  1293. (defcustom org-goto-max-level 5
  1294. "Maximum level to be considered when running org-goto with refile interface."
  1295. :group 'org-refile
  1296. :type 'integer)
  1297. (defcustom org-reverse-note-order nil
  1298. "Non-nil means, store new notes at the beginning of a file or entry.
  1299. When nil, new notes will be filed to the end of a file or entry.
  1300. This can also be a list with cons cells of regular expressions that
  1301. are matched against file names, and values."
  1302. :group 'org-remember
  1303. :group 'org-refile
  1304. :type '(choice
  1305. (const :tag "Reverse always" t)
  1306. (const :tag "Reverse never" nil)
  1307. (repeat :tag "By file name regexp"
  1308. (cons regexp boolean))))
  1309. (defcustom org-refile-targets nil
  1310. "Targets for refiling entries with \\[org-refile].
  1311. This is list of cons cells. Each cell contains:
  1312. - a specification of the files to be considered, either a list of files,
  1313. or a symbol whose function or variable value will be used to retrieve
  1314. a file name or a list of file names. If you use `org-agenda-files' for
  1315. that, all agenda files will be scanned for targets. Nil means, consider
  1316. headings in the current buffer.
  1317. - A specification of how to find candidate refile targets. This may be
  1318. any of:
  1319. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  1320. This tag has to be present in all target headlines, inheritance will
  1321. not be considered.
  1322. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  1323. todo keyword.
  1324. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  1325. headlines that are refiling targets.
  1326. - a cons cell (:level . N). Any headline of level N is considered a target.
  1327. Note that, when `org-odd-levels-only' is set, level corresponds to
  1328. order in hierarchy, not to the number of stars.
  1329. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  1330. Note that, when `org-odd-levels-only' is set, level corresponds to
  1331. order in hierarchy, not to the number of stars.
  1332. You can set the variable `org-refile-target-verify-function' to a function
  1333. to verify each headline found by the simple critery above.
  1334. When this variable is nil, all top-level headlines in the current buffer
  1335. are used, equivalent to the value `((nil . (:level . 1))'."
  1336. :group 'org-refile
  1337. :type '(repeat
  1338. (cons
  1339. (choice :value org-agenda-files
  1340. (const :tag "All agenda files" org-agenda-files)
  1341. (const :tag "Current buffer" nil)
  1342. (function) (variable) (file))
  1343. (choice :tag "Identify target headline by"
  1344. (cons :tag "Specific tag" (const :value :tag) (string))
  1345. (cons :tag "TODO keyword" (const :value :todo) (string))
  1346. (cons :tag "Regular expression" (const :value :regexp) (regexp))
  1347. (cons :tag "Level number" (const :value :level) (integer))
  1348. (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
  1349. (defcustom org-refile-target-verify-function nil
  1350. "Function to verify if the headline at point should be a refile target.
  1351. The function will be called without arguments, with point at the
  1352. beginning of the headline. It should return t and leave point
  1353. where it is if the headline is a valid target for refiling.
  1354. If the target should not be selected, the function must return nil.
  1355. In addition to this, it may move point to a place from where the search
  1356. should be continued. For example, the function may decide that the entire
  1357. subtree of the current entry should be excluded and move point to the end
  1358. of the subtree."
  1359. :group 'org-refile
  1360. :type 'function)
  1361. (defcustom org-refile-use-outline-path nil
  1362. "Non-nil means, provide refile targets as paths.
  1363. So a level 3 headline will be available as level1/level2/level3.
  1364. When the value is `file', also include the file name (without directory)
  1365. into the path. In this case, you can also stop the completion after
  1366. the file name, to get entries inserted as top level in the file.
  1367. When `full-file-path', include the full file path."
  1368. :group 'org-refile
  1369. :type '(choice
  1370. (const :tag "Not" nil)
  1371. (const :tag "Yes" t)
  1372. (const :tag "Start with file name" file)
  1373. (const :tag "Start with full file path" full-file-path)))
  1374. (defcustom org-outline-path-complete-in-steps t
  1375. "Non-nil means, complete the outline path in hierarchical steps.
  1376. When Org-mode uses the refile interface to select an outline path
  1377. \(see variable `org-refile-use-outline-path'), the completion of
  1378. the path can be done is a single go, or if can be done in steps down
  1379. the headline hierarchy. Going in steps is probably the best if you
  1380. do not use a special completion package like `ido' or `icicles'.
  1381. However, when using these packages, going in one step can be very
  1382. fast, while still showing the whole path to the entry."
  1383. :group 'org-refile
  1384. :type 'boolean)
  1385. (defcustom org-refile-allow-creating-parent-nodes nil
  1386. "Non-nil means, allow to create new nodes as refile targets.
  1387. New nodes are then created by adding \"/new node name\" to the completion
  1388. of an existing node. When the value of this variable is `confirm',
  1389. new node creation must be confirmed by the user (recommended)
  1390. When nil, the completion must match an existing entry.
  1391. Note that, if the new heading is not seen by the criteria
  1392. listed in `org-refile-targets', multiple instances of the same
  1393. heading would be created by trying again to file under the new
  1394. heading."
  1395. :group 'org-refile
  1396. :type '(choice
  1397. (const :tag "Never" nil)
  1398. (const :tag "Always" t)
  1399. (const :tag "Prompt for confirmation" confirm)))
  1400. (defgroup org-todo nil
  1401. "Options concerning TODO items in Org-mode."
  1402. :tag "Org TODO"
  1403. :group 'org)
  1404. (defgroup org-progress nil
  1405. "Options concerning Progress logging in Org-mode."
  1406. :tag "Org Progress"
  1407. :group 'org-time)
  1408. (defvar org-todo-interpretation-widgets
  1409. '(
  1410. (:tag "Sequence (cycling hits every state)" sequence)
  1411. (:tag "Type (cycling directly to DONE)" type))
  1412. "The available interpretation symbols for customizing
  1413. `org-todo-keywords'.
  1414. Interested libraries should add to this list.")
  1415. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  1416. "List of TODO entry keyword sequences and their interpretation.
  1417. \\<org-mode-map>This is a list of sequences.
  1418. Each sequence starts with a symbol, either `sequence' or `type',
  1419. indicating if the keywords should be interpreted as a sequence of
  1420. action steps, or as different types of TODO items. The first
  1421. keywords are states requiring action - these states will select a headline
  1422. for inclusion into the global TODO list Org-mode produces. If one of
  1423. the \"keywords\" is the vertical bat \"|\" the remaining keywords
  1424. signify that no further action is necessary. If \"|\" is not found,
  1425. the last keyword is treated as the only DONE state of the sequence.
  1426. The command \\[org-todo] cycles an entry through these states, and one
  1427. additional state where no keyword is present. For details about this
  1428. cycling, see the manual.
  1429. TODO keywords and interpretation can also be set on a per-file basis with
  1430. the special #+SEQ_TODO and #+TYP_TODO lines.
  1431. Each keyword can optionally specify a character for fast state selection
  1432. \(in combination with the variable `org-use-fast-todo-selection')
  1433. and specifiers for state change logging, using the same syntax
  1434. that is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says
  1435. that the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  1436. indicates to record a time stamp each time this state is selected.
  1437. Each keyword may also specify if a timestamp or a note should be
  1438. recorded when entering or leaving the state, by adding additional
  1439. characters in the parenthesis after the keyword. This looks like this:
  1440. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  1441. record only the time of the state change. With X and Y being either
  1442. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  1443. Y when leaving the state if and only if the *target* state does not
  1444. define X. You may omit any of the fast-selection key or X or /Y,
  1445. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  1446. For backward compatibility, this variable may also be just a list
  1447. of keywords - in this case the interpretation (sequence or type) will be
  1448. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  1449. :group 'org-todo
  1450. :group 'org-keywords
  1451. :type '(choice
  1452. (repeat :tag "Old syntax, just keywords"
  1453. (string :tag "Keyword"))
  1454. (repeat :tag "New syntax"
  1455. (cons
  1456. (choice
  1457. :tag "Interpretation"
  1458. ;;Quick and dirty way to see
  1459. ;;`org-todo-interpretations'. This takes the
  1460. ;;place of item arguments
  1461. :convert-widget
  1462. (lambda (widget)
  1463. (widget-put widget
  1464. :args (mapcar
  1465. #'(lambda (x)
  1466. (widget-convert
  1467. (cons 'const x)))
  1468. org-todo-interpretation-widgets))
  1469. widget))
  1470. (repeat
  1471. (string :tag "Keyword"))))))
  1472. (defvar org-todo-keywords-1 nil
  1473. "All TODO and DONE keywords active in a buffer.")
  1474. (make-variable-buffer-local 'org-todo-keywords-1)
  1475. (defvar org-todo-keywords-for-agenda nil)
  1476. (defvar org-done-keywords-for-agenda nil)
  1477. (defvar org-todo-keyword-alist-for-agenda nil)
  1478. (defvar org-tag-alist-for-agenda nil)
  1479. (defvar org-agenda-contributing-files nil)
  1480. (defvar org-not-done-keywords nil)
  1481. (make-variable-buffer-local 'org-not-done-keywords)
  1482. (defvar org-done-keywords nil)
  1483. (make-variable-buffer-local 'org-done-keywords)
  1484. (defvar org-todo-heads nil)
  1485. (make-variable-buffer-local 'org-todo-heads)
  1486. (defvar org-todo-sets nil)
  1487. (make-variable-buffer-local 'org-todo-sets)
  1488. (defvar org-todo-log-states nil)
  1489. (make-variable-buffer-local 'org-todo-log-states)
  1490. (defvar org-todo-kwd-alist nil)
  1491. (make-variable-buffer-local 'org-todo-kwd-alist)
  1492. (defvar org-todo-key-alist nil)
  1493. (make-variable-buffer-local 'org-todo-key-alist)
  1494. (defvar org-todo-key-trigger nil)
  1495. (make-variable-buffer-local 'org-todo-key-trigger)
  1496. (defcustom org-todo-interpretation 'sequence
  1497. "Controls how TODO keywords are interpreted.
  1498. This variable is in principle obsolete and is only used for
  1499. backward compatibility, if the interpretation of todo keywords is
  1500. not given already in `org-todo-keywords'. See that variable for
  1501. more information."
  1502. :group 'org-todo
  1503. :group 'org-keywords
  1504. :type '(choice (const sequence)
  1505. (const type)))
  1506. (defcustom org-use-fast-todo-selection t
  1507. "Non-nil means, use the fast todo selection scheme with C-c C-t.
  1508. This variable describes if and under what circumstances the cycling
  1509. mechanism for TODO keywords will be replaced by a single-key, direct
  1510. selection scheme.
  1511. When nil, fast selection is never used.
  1512. When the symbol `prefix', it will be used when `org-todo' is called with
  1513. a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
  1514. in an agenda buffer.
  1515. When t, fast selection is used by default. In this case, the prefix
  1516. argument forces cycling instead.
  1517. In all cases, the special interface is only used if access keys have actually
  1518. been assigned by the user, i.e. if keywords in the configuration are followed
  1519. by a letter in parenthesis, like TODO(t)."
  1520. :group 'org-todo
  1521. :type '(choice
  1522. (const :tag "Never" nil)
  1523. (const :tag "By default" t)
  1524. (const :tag "Only with C-u C-c C-t" prefix)))
  1525. (defcustom org-provide-todo-statistics t
  1526. "Non-nil means, update todo statistics after insert and toggle.
  1527. When this is set, todo statistics is updated in the parent of the current
  1528. entry each time a todo state is changed."
  1529. :group 'org-todo
  1530. :type 'boolean)
  1531. (defcustom org-after-todo-state-change-hook nil
  1532. "Hook which is run after the state of a TODO item was changed.
  1533. The new state (a string with a TODO keyword, or nil) is available in the
  1534. Lisp variable `state'."
  1535. :group 'org-todo
  1536. :type 'hook)
  1537. (defvar org-blocker-hook nil
  1538. "Hook for functions that are allowed to block a state change.
  1539. Each function gets as its single argument a property list, see
  1540. `org-trigger-hook' for more information about this list.
  1541. If any of the functions in this hook returns nil, the state change
  1542. is blocked.")
  1543. (defvar org-trigger-hook nil
  1544. "Hook for functions that are triggered by a state change.
  1545. Each function gets as its single argument a property list with at least
  1546. the following elements:
  1547. (:type type-of-change :position pos-at-entry-start
  1548. :from old-state :to new-state)
  1549. Depending on the type, more properties may be present.
  1550. This mechanism is currently implemented for:
  1551. TODO state changes
  1552. ------------------
  1553. :type todo-state-change
  1554. :from previous state (keyword as a string), or nil, or a symbol
  1555. 'todo' or 'done', to indicate the general type of state.
  1556. :to new state, like in :from")
  1557. (defcustom org-enforce-todo-dependencies nil
  1558. "Non-nil means, undone TODO entries will block switching the parent to DONE.
  1559. Also, if a parent has an :ORDERED: property, switching an entry to DONE will
  1560. be blocked if any prior sibling is not yet done.
  1561. Finally, if the parent is blocked because of ordered siblings of its own,
  1562. the child will also be blocked.
  1563. This variable needs to be set before org.el is loaded, and you need to
  1564. restart Emacs after a change to make the change effective. The only way
  1565. to change is while Emacs is running is through the customize interface."
  1566. :set (lambda (var val)
  1567. (set var val)
  1568. (if val
  1569. (add-hook 'org-blocker-hook
  1570. 'org-block-todo-from-children-or-siblings-or-parent)
  1571. (remove-hook 'org-blocker-hook
  1572. 'org-block-todo-from-children-or-siblings-or-parent)))
  1573. :group 'org-todo
  1574. :type 'boolean)
  1575. (defcustom org-enforce-todo-checkbox-dependencies nil
  1576. "Non-nil means, unchecked boxes will block switching the parent to DONE.
  1577. When this is nil, checkboxes have no influence on switching TODO states.
  1578. When non-nil, you first need to check off all check boxes before the TODO
  1579. entry can be switched to DONE.
  1580. This variable needs to be set before org.el is loaded, and you need to
  1581. restart Emacs after a change to make the change effective. The only way
  1582. to change is while Emacs is running is through the customize interface."
  1583. :set (lambda (var val)
  1584. (set var val)
  1585. (if val
  1586. (add-hook 'org-blocker-hook
  1587. 'org-block-todo-from-checkboxes)
  1588. (remove-hook 'org-blocker-hook
  1589. 'org-block-todo-from-checkboxes)))
  1590. :group 'org-todo
  1591. :type 'boolean)
  1592. (defcustom org-todo-state-tags-triggers nil
  1593. "Tag changes that should be triggered by TODO state changes.
  1594. This is a list. Each entry is
  1595. (state-change (tag . flag) .......)
  1596. State-change can be a string with a state, and empty string to indicate the
  1597. state that has no TODO keyword, or it can be one of the symbols `todo'
  1598. or `done', meaning any not-done or done state, respectively."
  1599. :group 'org-todo
  1600. :group 'org-tags
  1601. :type '(repeat
  1602. (cons (choice :tag "When changing to"
  1603. (const :tag "Not-done state" todo)
  1604. (const :tag "Done state" done)
  1605. (string :tag "State"))
  1606. (repeat
  1607. (cons :tag "Tag action"
  1608. (string :tag "Tag")
  1609. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  1610. (defcustom org-log-done nil
  1611. "Information to record when a task moves to the DONE state.
  1612. Possible values are:
  1613. nil Don't add anything, just change the keyword
  1614. time Add a time stamp to the task
  1615. note Prompt a closing note and add it with template `org-log-note-headings'
  1616. This option can also be set with on a per-file-basis with
  1617. #+STARTUP: nologdone
  1618. #+STARTUP: logdone
  1619. #+STARTUP: lognotedone
  1620. You can have local logging settings for a subtree by setting the LOGGING
  1621. property to one or more of these keywords."
  1622. :group 'org-todo
  1623. :group 'org-progress
  1624. :type '(choice
  1625. (const :tag "No logging" nil)
  1626. (const :tag "Record CLOSED timestamp" time)
  1627. (const :tag "Record CLOSED timestamp with closing note." note)))
  1628. ;; Normalize old uses of org-log-done.
  1629. (cond
  1630. ((eq org-log-done t) (setq org-log-done 'time))
  1631. ((and (listp org-log-done) (memq 'done org-log-done))
  1632. (setq org-log-done 'note)))
  1633. (defcustom org-log-note-clock-out nil
  1634. "Non-nil means, record a note when clocking out of an item.
  1635. This can also be configured on a per-file basis by adding one of
  1636. the following lines anywhere in the buffer:
  1637. #+STARTUP: lognoteclock-out
  1638. #+STARTUP: nolognoteclock-out"
  1639. :group 'org-todo
  1640. :group 'org-progress
  1641. :type 'boolean)
  1642. (defcustom org-log-done-with-time t
  1643. "Non-nil means, the CLOSED time stamp will contain date and time.
  1644. When nil, only the date will be recorded."
  1645. :group 'org-progress
  1646. :type 'boolean)
  1647. (defcustom org-log-note-headings
  1648. '((done . "CLOSING NOTE %t")
  1649. (state . "State %-12s from %-12S %t")
  1650. (note . "Note taken on %t")
  1651. (clock-out . ""))
  1652. "Headings for notes added to entries.
  1653. The value is an alist, with the car being a symbol indicating the note
  1654. context, and the cdr is the heading to be used. The heading may also be the
  1655. empty string.
  1656. %t in the heading will be replaced by a time stamp.
  1657. %s will be replaced by the new TODO state, in double quotes.
  1658. %S will be replaced by the old TODO state, in double quotes.
  1659. %u will be replaced by the user name.
  1660. %U will be replaced by the full user name."
  1661. :group 'org-todo
  1662. :group 'org-progress
  1663. :type '(list :greedy t
  1664. (cons (const :tag "Heading when closing an item" done) string)
  1665. (cons (const :tag
  1666. "Heading when changing todo state (todo sequence only)"
  1667. state) string)
  1668. (cons (const :tag "Heading when just taking a note" note) string)
  1669. (cons (const :tag "Heading when clocking out" clock-out) string)))
  1670. (unless (assq 'note org-log-note-headings)
  1671. (push '(note . "%t") org-log-note-headings))
  1672. (defcustom org-log-into-drawer nil
  1673. "Non-nil means, insert state change notes and time stamps into a drawer.
  1674. When nil, state changes notes will be inserted after the headline and
  1675. any scheduling and clock lines, but not inside a drawer.
  1676. The value of this variable should be the name of the drawer to use.
  1677. LOGBOOK is proposed at the default drawer for this purpose, you can
  1678. also set this to a string to define the drawer of your choice.
  1679. A value of t is also allowed, representing \"LOGBOOK\".
  1680. If this variable is set, `org-log-state-notes-insert-after-drawers'
  1681. will be ignored.
  1682. You can set the property LOG_INTO_DRAWER to overrule this setting for
  1683. a subtree."
  1684. :group 'org-todo
  1685. :group 'org-progress
  1686. :type '(choice
  1687. (const :tag "Not into a drawer" nil)
  1688. (const :tag "LOGBOOK" t)
  1689. (string :tag "Other")))
  1690. (if (fboundp 'defvaralias)
  1691. (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer))
  1692. (defun org-log-into-drawer ()
  1693. "Return the value of `org-log-into-drawer', but let properties overrule.
  1694. If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
  1695. used instead of the default value."
  1696. (let ((p (ignore-errors (org-entry-get nil "LOG_INTO_DRAWER" 'inherit))))
  1697. (cond
  1698. ((or (not p) (equal p "nil")) org-log-into-drawer)
  1699. ((equal p "t") "LOGBOOK")
  1700. (t p))))
  1701. (defcustom org-log-state-notes-insert-after-drawers nil
  1702. "Non-nil means, insert state change notes after any drawers in entry.
  1703. Only the drawers that *immediately* follow the headline and the
  1704. deadline/scheduled line are skipped.
  1705. When nil, insert notes right after the heading and perhaps the line
  1706. with deadline/scheduling if present.
  1707. This variable will have no effect if `org-log-into-drawer' is
  1708. set."
  1709. :group 'org-todo
  1710. :group 'org-progress
  1711. :type 'boolean)
  1712. (defcustom org-log-states-order-reversed t
  1713. "Non-nil means, the latest state change note will be directly after heading.
  1714. When nil, the notes will be orderer according to time."
  1715. :group 'org-todo
  1716. :group 'org-progress
  1717. :type 'boolean)
  1718. (defcustom org-log-repeat 'time
  1719. "Non-nil means, record moving through the DONE state when triggering repeat.
  1720. An auto-repeating tasks is immediately switched back to TODO when marked
  1721. done. If you are not logging state changes (by adding \"@\" or \"!\" to
  1722. the TODO keyword definition, or recording a closing note by setting
  1723. `org-log-done', there will be no record of the task moving through DONE.
  1724. This variable forces taking a note anyway. Possible values are:
  1725. nil Don't force a record
  1726. time Record a time stamp
  1727. note Record a note
  1728. This option can also be set with on a per-file-basis with
  1729. #+STARTUP: logrepeat
  1730. #+STARTUP: lognoterepeat
  1731. #+STARTUP: nologrepeat
  1732. You can have local logging settings for a subtree by setting the LOGGING
  1733. property to one or more of these keywords."
  1734. :group 'org-todo
  1735. :group 'org-progress
  1736. :type '(choice
  1737. (const :tag "Don't force a record" nil)
  1738. (const :tag "Force recording the DONE state" time)
  1739. (const :tag "Force recording a note with the DONE state" note)))
  1740. (defgroup org-priorities nil
  1741. "Priorities in Org-mode."
  1742. :tag "Org Priorities"
  1743. :group 'org-todo)
  1744. (defcustom org-highest-priority ?A
  1745. "The highest priority of TODO items. A character like ?A, ?B etc.
  1746. Must have a smaller ASCII number than `org-lowest-priority'."
  1747. :group 'org-priorities
  1748. :type 'character)
  1749. (defcustom org-lowest-priority ?C
  1750. "The lowest priority of TODO items. A character like ?A, ?B etc.
  1751. Must have a larger ASCII number than `org-highest-priority'."
  1752. :group 'org-priorities
  1753. :type 'character)
  1754. (defcustom org-default-priority ?B
  1755. "The default priority of TODO items.
  1756. This is the priority an item get if no explicit priority is given."
  1757. :group 'org-priorities
  1758. :type 'character)
  1759. (defcustom org-priority-start-cycle-with-default t
  1760. "Non-nil means, start with default priority when starting to cycle.
  1761. When this is nil, the first step in the cycle will be (depending on the
  1762. command used) one higher or lower that the default priority."
  1763. :group 'org-priorities
  1764. :type 'boolean)
  1765. (defgroup org-time nil
  1766. "Options concerning time stamps and deadlines in Org-mode."
  1767. :tag "Org Time"
  1768. :group 'org)
  1769. (defcustom org-insert-labeled-timestamps-at-point nil
  1770. "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
  1771. When nil, these labeled time stamps are forces into the second line of an
  1772. entry, just after the headline. When scheduling from the global TODO list,
  1773. the time stamp will always be forced into the second line."
  1774. :group 'org-time
  1775. :type 'boolean)
  1776. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  1777. "Formats for `format-time-string' which are used for time stamps.
  1778. It is not recommended to change this constant.")
  1779. (defcustom org-time-stamp-rounding-minutes '(0 5)
  1780. "Number of minutes to round time stamps to.
  1781. These are two values, the first applies when first creating a time stamp.
  1782. The second applies when changing it with the commands `S-up' and `S-down'.
  1783. When changing the time stamp, this means that it will change in steps
  1784. of N minutes, as given by the second value.
  1785. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  1786. numbers should be factors of 60, so for example 5, 10, 15.
  1787. When this is larger than 1, you can still force an exact time-stamp by using
  1788. a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
  1789. and by using a prefix arg to `S-up/down' to specify the exact number
  1790. of minutes to shift."
  1791. :group 'org-time
  1792. :get '(lambda (var) ; Make sure all entries have 5 elements
  1793. (if (integerp (default-value var))
  1794. (list (default-value var) 5)
  1795. (default-value var)))
  1796. :type '(list
  1797. (integer :tag "when inserting times")
  1798. (integer :tag "when modifying times")))
  1799. ;; Normalize old customizations of this variable.
  1800. (when (integerp org-time-stamp-rounding-minutes)
  1801. (setq org-time-stamp-rounding-minutes
  1802. (list org-time-stamp-rounding-minutes
  1803. org-time-stamp-rounding-minutes)))
  1804. (defcustom org-display-custom-times nil
  1805. "Non-nil means, overlay custom formats over all time stamps.
  1806. The formats are defined through the variable `org-time-stamp-custom-formats'.
  1807. To turn this on on a per-file basis, insert anywhere in the file:
  1808. #+STARTUP: customtime"
  1809. :group 'org-time
  1810. :set 'set-default
  1811. :type 'sexp)
  1812. (make-variable-buffer-local 'org-display-custom-times)
  1813. (defcustom org-time-stamp-custom-formats
  1814. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  1815. "Custom formats for time stamps. See `format-time-string' for the syntax.
  1816. These are overlayed over the default ISO format if the variable
  1817. `org-display-custom-times' is set. Time like %H:%M should be at the
  1818. end of the second format. The custom formats are also honored by export
  1819. commands, if custom time display is turned on at the time of export."
  1820. :group 'org-time
  1821. :type 'sexp)
  1822. (defun org-time-stamp-format (&optional long inactive)
  1823. "Get the right format for a time string."
  1824. (let ((f (if long (cdr org-time-stamp-formats)
  1825. (car org-time-stamp-formats))))
  1826. (if inactive
  1827. (concat "[" (substring f 1 -1) "]")
  1828. f)))
  1829. (defcustom org-time-clocksum-format "%d:%02d"
  1830. "The format string used when creating CLOCKSUM lines, or when
  1831. org-mode generates a time duration."
  1832. :group 'org-time
  1833. :type 'string)
  1834. (defcustom org-deadline-warning-days 14
  1835. "No. of days before expiration during which a deadline becomes active.
  1836. This variable governs the display in sparse trees and in the agenda.
  1837. When 0 or negative, it means use this number (the absolute value of it)
  1838. even if a deadline has a different individual lead time specified.
  1839. Custom commands can set this variable in the options section."
  1840. :group 'org-time
  1841. :group 'org-agenda-daily/weekly
  1842. :type 'integer)
  1843. (defcustom org-read-date-prefer-future t
  1844. "Non-nil means, assume future for incomplete date input from user.
  1845. This affects the following situations:
  1846. 1. The user gives a day, but no month.
  1847. For example, if today is the 15th, and you enter \"3\", Org-mode will
  1848. read this as the third of *next* month. However, if you enter \"17\",
  1849. it will be considered as *this* month.
  1850. 2. The user gives a month but not a year.
  1851. For example, if it is april and you enter \"feb 2\", this will be read
  1852. as feb 2, *next* year. \"May 5\", however, will be this year.
  1853. Currently this does not work for ISO week specifications.
  1854. When this option is nil, the current month and year will always be used
  1855. as defaults."
  1856. :group 'org-time
  1857. :type 'boolean)
  1858. (defcustom org-read-date-display-live t
  1859. "Non-nil means, display current interpretation of date prompt live.
  1860. This display will be in an overlay, in the minibuffer."
  1861. :group 'org-time
  1862. :type 'boolean)
  1863. (defcustom org-read-date-popup-calendar t
  1864. "Non-nil means, pop up a calendar when prompting for a date.
  1865. In the calendar, the date can be selected with mouse-1. However, the
  1866. minibuffer will also be active, and you can simply enter the date as well.
  1867. When nil, only the minibuffer will be available."
  1868. :group 'org-time
  1869. :type 'boolean)
  1870. (if (fboundp 'defvaralias)
  1871. (defvaralias 'org-popup-calendar-for-date-prompt
  1872. 'org-read-date-popup-calendar))
  1873. (defcustom org-read-date-minibuffer-setup-hook nil
  1874. "Hook to be used to set up keys for the date/time interface.
  1875. Add key definitions to `minibuffer-local-map', which will be a temporary
  1876. copy."
  1877. :group 'org-time
  1878. :type 'hook)
  1879. (defcustom org-extend-today-until 0
  1880. "The hour when your day really ends. Must be an integer.
  1881. This has influence for the following applications:
  1882. - When switching the agenda to \"today\". It it is still earlier than
  1883. the time given here, the day recognized as TODAY is actually yesterday.
  1884. - When a date is read from the user and it is still before the time given
  1885. here, the current date and time will be assumed to be yesterday, 23:59.
  1886. Also, timestamps inserted in remember templates follow this rule.
  1887. IMPORTANT: This is a feature whose implementation is and likely will
  1888. remain incomplete. Really, it is only here because past midnight seems to
  1889. be the favorite working time of John Wiegley :-)"
  1890. :group 'org-time
  1891. :type 'integer)
  1892. (defcustom org-edit-timestamp-down-means-later nil
  1893. "Non-nil means, S-down will increase the time in a time stamp.
  1894. When nil, S-up will increase."
  1895. :group 'org-time
  1896. :type 'boolean)
  1897. (defcustom org-calendar-follow-timestamp-change t
  1898. "Non-nil means, make the calendar window follow timestamp changes.
  1899. When a timestamp is modified and the calendar window is visible, it will be
  1900. moved to the new date."
  1901. :group 'org-time
  1902. :type 'boolean)
  1903. (defgroup org-tags nil
  1904. "Options concerning tags in Org-mode."
  1905. :tag "Org Tags"
  1906. :group 'org)
  1907. (defcustom org-tag-alist nil
  1908. "List of tags allowed in Org-mode files.
  1909. When this list is nil, Org-mode will base TAG input on what is already in the
  1910. buffer.
  1911. The value of this variable is an alist, the car of each entry must be a
  1912. keyword as a string, the cdr may be a character that is used to select
  1913. that tag through the fast-tag-selection interface.
  1914. See the manual for details."
  1915. :group 'org-tags
  1916. :type '(repeat
  1917. (choice
  1918. (cons (string :tag "Tag name")
  1919. (character :tag "Access char"))
  1920. (const :tag "Start radio group" (:startgroup))
  1921. (const :tag "End radio group" (:endgroup))
  1922. (const :tag "New line" (:newline)))))
  1923. (defcustom org-tag-persistent-alist nil
  1924. "List of tags that will always appear in all Org-mode files.
  1925. This is in addition to any in buffer settings or customizations
  1926. of `org-tag-alist'.
  1927. When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
  1928. The value of this variable is an alist, the car of each entry must be a
  1929. keyword as a string, the cdr may be a character that is used to select
  1930. that tag through the fast-tag-selection interface.
  1931. See the manual for details.
  1932. To disable these tags on a per-file basis, insert anywhere in the file:
  1933. #+STARTUP: noptag"
  1934. :group 'org-tags
  1935. :type '(repeat
  1936. (choice
  1937. (cons (string :tag "Tag name")
  1938. (character :tag "Access char"))
  1939. (const :tag "Start radio group" (:startgroup))
  1940. (const :tag "End radio group" (:endgroup))
  1941. (const :tag "New line" (:newline)))))
  1942. (defvar org-file-tags nil
  1943. "List of tags that can be inherited by all entries in the file.
  1944. The tags will be inherited if the variable `org-use-tag-inheritance'
  1945. says they should be.
  1946. This variable is populated from #+TAG lines.")
  1947. (defcustom org-use-fast-tag-selection 'auto
  1948. "Non-nil means, use fast tag selection scheme.
  1949. This is a special interface to select and deselect tags with single keys.
  1950. When nil, fast selection is never used.
  1951. When the symbol `auto', fast selection is used if and only if selection
  1952. characters for tags have been configured, either through the variable
  1953. `org-tag-alist' or through a #+TAGS line in the buffer.
  1954. When t, fast selection is always used and selection keys are assigned
  1955. automatically if necessary."
  1956. :group 'org-tags
  1957. :type '(choice
  1958. (const :tag "Always" t)
  1959. (const :tag "Never" nil)
  1960. (const :tag "When selection characters are configured" 'auto)))
  1961. (defcustom org-fast-tag-selection-single-key nil
  1962. "Non-nil means, fast tag selection exits after first change.
  1963. When nil, you have to press RET to exit it.
  1964. During fast tag selection, you can toggle this flag with `C-c'.
  1965. This variable can also have the value `expert'. In this case, the window
  1966. displaying the tags menu is not even shown, until you press C-c again."
  1967. :group 'org-tags
  1968. :type '(choice
  1969. (const :tag "No" nil)
  1970. (const :tag "Yes" t)
  1971. (const :tag "Expert" expert)))
  1972. (defvar org-fast-tag-selection-include-todo nil
  1973. "Non-nil means, fast tags selection interface will also offer TODO states.
  1974. This is an undocumented feature, you should not rely on it.")
  1975. (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
  1976. "The column to which tags should be indented in a headline.
  1977. If this number is positive, it specifies the column. If it is negative,
  1978. it means that the tags should be flushright to that column. For example,
  1979. -80 works well for a normal 80 character screen."
  1980. :group 'org-tags
  1981. :type 'integer)
  1982. (defcustom org-auto-align-tags t
  1983. "Non-nil means, realign tags after pro/demotion of TODO state change.
  1984. These operations change the length of a headline and therefore shift
  1985. the tags around. With this options turned on, after each such operation
  1986. the tags are again aligned to `org-tags-column'."
  1987. :group 'org-tags
  1988. :type 'boolean)
  1989. (defcustom org-use-tag-inheritance t
  1990. "Non-nil means, tags in levels apply also for sublevels.
  1991. When nil, only the tags directly given in a specific line apply there.
  1992. This may also be a list of tags that should be inherited, or a regexp that
  1993. matches tags that should be inherited. Additional control is possible
  1994. with the variable `org-tags-exclude-from-inheritance' which gives an
  1995. explicit list of tags to be excluded from inheritance., even if the value of
  1996. `org-use-tag-inheritance' would select it for inheritance.
  1997. If this option is t, a match early-on in a tree can lead to a large
  1998. number of matches in the subtree when constructing the agenda or creating
  1999. a sparse tree. If you only want to see the first match in a tree during
  2000. a search, check out the variable `org-tags-match-list-sublevels'."
  2001. :group 'org-tags
  2002. :type '(choice
  2003. (const :tag "Not" nil)
  2004. (const :tag "Always" t)
  2005. (repeat :tag "Specific tags" (string :tag "Tag"))
  2006. (regexp :tag "Tags matched by regexp")))
  2007. (defcustom org-tags-exclude-from-inheritance nil
  2008. "List of tags that should never be inherited.
  2009. This is a way to exclude a few tags from inheritance. For way to do
  2010. the opposite, to actively allow inheritance for selected tags,
  2011. see the variable `org-use-tag-inheritance'."
  2012. :group 'org-tags
  2013. :type '(repeat (string :tag "Tag")))
  2014. (defun org-tag-inherit-p (tag)
  2015. "Check if TAG is one that should be inherited."
  2016. (cond
  2017. ((member tag org-tags-exclude-from-inheritance) nil)
  2018. ((eq org-use-tag-inheritance t) t)
  2019. ((not org-use-tag-inheritance) nil)
  2020. ((stringp org-use-tag-inheritance)
  2021. (string-match org-use-tag-inheritance tag))
  2022. ((listp org-use-tag-inheritance)
  2023. (member tag org-use-tag-inheritance))
  2024. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  2025. (defcustom org-tags-match-list-sublevels t
  2026. "Non-nil means list also sublevels of headlines matching a search.
  2027. This variable applies to tags/property searches, and also to stuck
  2028. projects because this search is based on a tags match as well.
  2029. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  2030. the sublevels of a headline matching a tag search often also match
  2031. the same search. Listing all of them can create very long lists.
  2032. Setting this variable to nil causes subtrees of a match to be skipped.
  2033. As a special case, if the tag search is restricted to TODO items, the
  2034. value of this variable is ignored and sublevels are always checked, to
  2035. make sure all corresponding TODO items find their way into the list.
  2036. This variable is semi-obsolete and probably should always be true. It
  2037. is better to limit inheritance to certain tags using the variables
  2038. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  2039. :group 'org-tags
  2040. :type '(choice
  2041. (const :tag "No, don't list them" nil)
  2042. (const :tag "Yes, do list them" t)
  2043. (const :tag "List them, indented with leading dots" indented)))
  2044. (defvar org-tags-history nil
  2045. "History of minibuffer reads for tags.")
  2046. (defvar org-last-tags-completion-table nil
  2047. "The last used completion table for tags.")
  2048. (defvar org-after-tags-change-hook nil
  2049. "Hook that is run after the tags in a line have changed.")
  2050. (defgroup org-properties nil
  2051. "Options concerning properties in Org-mode."
  2052. :tag "Org Properties"
  2053. :group 'org)
  2054. (defcustom org-property-format "%-10s %s"
  2055. "How property key/value pairs should be formatted by `indent-line'.
  2056. When `indent-line' hits a property definition, it will format the line
  2057. according to this format, mainly to make sure that the values are
  2058. lined-up with respect to each other."
  2059. :group 'org-properties
  2060. :type 'string)
  2061. (defcustom org-use-property-inheritance nil
  2062. "Non-nil means, properties apply also for sublevels.
  2063. This setting is chiefly used during property searches. Turning it on can
  2064. cause significant overhead when doing a search, which is why it is not
  2065. on by default.
  2066. When nil, only the properties directly given in the current entry count.
  2067. When t, every property is inherited. The value may also be a list of
  2068. properties that should have inheritance, or a regular expression matching
  2069. properties that should be inherited.
  2070. However, note that some special properties use inheritance under special
  2071. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  2072. and the properties ending in \"_ALL\" when they are used as descriptor
  2073. for valid values of a property.
  2074. Note for programmers:
  2075. When querying an entry with `org-entry-get', you can control if inheritance
  2076. should be used. By default, `org-entry-get' looks only at the local
  2077. properties. You can request inheritance by setting the inherit argument
  2078. to t (to force inheritance) or to `selective' (to respect the setting
  2079. in this variable)."
  2080. :group 'org-properties
  2081. :type '(choice
  2082. (const :tag "Not" nil)
  2083. (const :tag "Always" t)
  2084. (repeat :tag "Specific properties" (string :tag "Property"))
  2085. (regexp :tag "Properties matched by regexp")))
  2086. (defun org-property-inherit-p (property)
  2087. "Check if PROPERTY is one that should be inherited."
  2088. (cond
  2089. ((eq org-use-property-inheritance t) t)
  2090. ((not org-use-property-inheritance) nil)
  2091. ((stringp org-use-property-inheritance)
  2092. (string-match org-use-property-inheritance property))
  2093. ((listp org-use-property-inheritance)
  2094. (member property org-use-property-inheritance))
  2095. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  2096. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  2097. "The default column format, if no other format has been defined.
  2098. This variable can be set on the per-file basis by inserting a line
  2099. #+COLUMNS: %25ITEM ....."
  2100. :group 'org-properties
  2101. :type 'string)
  2102. (defcustom org-columns-ellipses ".."
  2103. "The ellipses to be used when a field in column view is truncated.
  2104. When this is the empty string, as many characters as possible are shown,
  2105. but then there will be no visual indication that the field has been truncated.
  2106. When this is a string of length N, the last N characters of a truncated
  2107. field are replaced by this string. If the column is narrower than the
  2108. ellipses string, only part of the ellipses string will be shown."
  2109. :group 'org-properties
  2110. :type 'string)
  2111. (defcustom org-columns-modify-value-for-display-function nil
  2112. "Function that modifies values for display in column view.
  2113. For example, it can be used to cut out a certain part from a time stamp.
  2114. The function must take 2 arguments:
  2115. column-title The title of the column (*not* the property name)
  2116. value The value that should be modified.
  2117. The function should return the value that should be displayed,
  2118. or nil if the normal value should be used."
  2119. :group 'org-properties
  2120. :type 'function)
  2121. (defcustom org-effort-property "Effort"
  2122. "The property that is being used to keep track of effort estimates.
  2123. Effort estimates given in this property need to have the format H:MM."
  2124. :group 'org-properties
  2125. :group 'org-progress
  2126. :type '(string :tag "Property"))
  2127. (defconst org-global-properties-fixed
  2128. '(("VISIBILITY_ALL" . "folded children content all"))
  2129. "List of property/value pairs that can be inherited by any entry.
  2130. These are fixed values, for the preset properties. The user variable
  2131. that can be used to add to this list is `org-global-properties'.
  2132. The entries in this list are cons cells where the car is a property
  2133. name and cdr is a string with the value. If the value represents
  2134. multiple items like an \"_ALL\" property, separate the items by
  2135. spaces.")
  2136. (defcustom org-global-properties nil
  2137. "List of property/value pairs that can be inherited by any entry.
  2138. This list will be combined with the constant `org-global-properties-fixed'.
  2139. The entries in this list are cons cells where the car is a property
  2140. name and cdr is a string with the value.
  2141. You can set buffer-local values for the same purpose in the variable
  2142. `org-file-properties' this by adding lines like
  2143. #+PROPERTY: NAME VALUE"
  2144. :group 'org-properties
  2145. :type '(repeat
  2146. (cons (string :tag "Property")
  2147. (string :tag "Value"))))
  2148. (defvar org-file-properties nil
  2149. "List of property/value pairs that can be inherited by any entry.
  2150. Valid for the current buffer.
  2151. This variable is populated from #+PROPERTY lines.")
  2152. (make-variable-buffer-local 'org-file-properties)
  2153. (defgroup org-agenda nil
  2154. "Options concerning agenda views in Org-mode."
  2155. :tag "Org Agenda"
  2156. :group 'org)
  2157. (defvar org-category nil
  2158. "Variable used by org files to set a category for agenda display.
  2159. Such files should use a file variable to set it, for example
  2160. # -*- mode: org; org-category: \"ELisp\"
  2161. or contain a special line
  2162. #+CATEGORY: ELisp
  2163. If the file does not specify a category, then file's base name
  2164. is used instead.")
  2165. (make-variable-buffer-local 'org-category)
  2166. (put 'org-category 'safe-local-variable '(lambda (x) (or (symbolp x) (stringp x))))
  2167. (defcustom org-agenda-files nil
  2168. "The files to be used for agenda display.
  2169. Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
  2170. \\[org-remove-file]. You can also use customize to edit the list.
  2171. If an entry is a directory, all files in that directory that are matched by
  2172. `org-agenda-file-regexp' will be part of the file list.
  2173. If the value of the variable is not a list but a single file name, then
  2174. the list of agenda files is actually stored and maintained in that file, one
  2175. agenda file per line."
  2176. :group 'org-agenda
  2177. :type '(choice
  2178. (repeat :tag "List of files and directories" file)
  2179. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  2180. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  2181. "Regular expression to match files for `org-agenda-files'.
  2182. If any element in the list in that variable contains a directory instead
  2183. of a normal file, all files in that directory that are matched by this
  2184. regular expression will be included."
  2185. :group 'org-agenda
  2186. :type 'regexp)
  2187. (defcustom org-agenda-text-search-extra-files nil
  2188. "List of extra files to be searched by text search commands.
  2189. These files will be search in addition to the agenda files by the
  2190. commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
  2191. Note that these files will only be searched for text search commands,
  2192. not for the other agenda views like todo lists, tag searches or the weekly
  2193. agenda. This variable is intended to list notes and possibly archive files
  2194. that should also be searched by these two commands.
  2195. In fact, if the first element in the list is the symbol `agenda-archives',
  2196. than all archive files of all agenda files will be added to the search
  2197. scope."
  2198. :group 'org-agenda
  2199. :type '(set :greedy t
  2200. (const :tag "Agenda Archives" agenda-archives)
  2201. (repeat :inline t (file))))
  2202. (if (fboundp 'defvaralias)
  2203. (defvaralias 'org-agenda-multi-occur-extra-files
  2204. 'org-agenda-text-search-extra-files))
  2205. (defcustom org-agenda-skip-unavailable-files nil
  2206. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  2207. A nil value means to remove them, after a query, from the list."
  2208. :group 'org-agenda
  2209. :type 'boolean)
  2210. (defcustom org-calendar-to-agenda-key [?c]
  2211. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  2212. The command `org-calendar-goto-agenda' will be bound to this key. The
  2213. default is the character `c' because then `c' can be used to switch back and
  2214. forth between agenda and calendar."
  2215. :group 'org-agenda
  2216. :type 'sexp)
  2217. (defcustom org-calendar-agenda-action-key [?k]
  2218. "The key to be installed in `calendar-mode-map' for agenda-action.
  2219. The command `org-agenda-action' will be bound to this key. The
  2220. default is the character `k' because we use the same key in the agenda."
  2221. :group 'org-agenda
  2222. :type 'sexp)
  2223. (eval-after-load "calendar"
  2224. '(progn
  2225. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  2226. 'org-calendar-goto-agenda)
  2227. (org-defkey calendar-mode-map org-calendar-agenda-action-key
  2228. 'org-agenda-action)))
  2229. (defgroup org-latex nil
  2230. "Options for embedding LaTeX code into Org-mode."
  2231. :tag "Org LaTeX"
  2232. :group 'org)
  2233. (defcustom org-format-latex-options
  2234. '(:foreground default :background default :scale 1.0
  2235. :html-foreground "Black" :html-background "Transparent" :html-scale 1.0
  2236. :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
  2237. "Options for creating images from LaTeX fragments.
  2238. This is a property list with the following properties:
  2239. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  2240. `default' means use the foreground of the default face.
  2241. :background the background color, or \"Transparent\".
  2242. `default' means use the background of the default face.
  2243. :scale a scaling factor for the size of the images.
  2244. :html-foreground, :html-background, :html-scale
  2245. the same numbers for HTML export.
  2246. :matchers a list indicating which matchers should be used to
  2247. find LaTeX fragments. Valid members of this list are:
  2248. \"begin\" find environments
  2249. \"$1\" find single characters surrounded by $.$
  2250. \"$\" find math expressions surrounded by $...$
  2251. \"$$\" find math expressions surrounded by $$....$$
  2252. \"\\(\" find math expressions surrounded by \\(...\\)
  2253. \"\\ [\" find math expressions surrounded by \\ [...\\]"
  2254. :group 'org-latex
  2255. :type 'plist)
  2256. (defcustom org-format-latex-header "\\documentclass{article}
  2257. \\usepackage{fullpage} % do not remove
  2258. \\usepackage{amssymb}
  2259. \\usepackage[usenames]{color}
  2260. \\usepackage{amsmath}
  2261. \\usepackage{latexsym}
  2262. \\usepackage[mathscr]{eucal}
  2263. \\pagestyle{empty} % do not remove"
  2264. "The document header used for processing LaTeX fragments."
  2265. :group 'org-latex
  2266. :type 'string)
  2267. (defgroup org-font-lock nil
  2268. "Font-lock settings for highlighting in Org-mode."
  2269. :tag "Org Font Lock"
  2270. :group 'org)
  2271. (defcustom org-level-color-stars-only nil
  2272. "Non-nil means fontify only the stars in each headline.
  2273. When nil, the entire headline is fontified.
  2274. Changing it requires restart of `font-lock-mode' to become effective
  2275. also in regions already fontified."
  2276. :group 'org-font-lock
  2277. :type 'boolean)
  2278. (defcustom org-hide-leading-stars nil
  2279. "Non-nil means, hide the first N-1 stars in a headline.
  2280. This works by using the face `org-hide' for these stars. This
  2281. face is white for a light background, and black for a dark
  2282. background. You may have to customize the face `org-hide' to
  2283. make this work.
  2284. Changing it requires restart of `font-lock-mode' to become effective
  2285. also in regions already fontified.
  2286. You may also set this on a per-file basis by adding one of the following
  2287. lines to the buffer:
  2288. #+STARTUP: hidestars
  2289. #+STARTUP: showstars"
  2290. :group 'org-font-lock
  2291. :type 'boolean)
  2292. (defcustom org-fontify-done-headline nil
  2293. "Non-nil means, change the face of a headline if it is marked DONE.
  2294. Normally, only the TODO/DONE keyword indicates the state of a headline.
  2295. When this is non-nil, the headline after the keyword is set to the
  2296. `org-headline-done' as an additional indication."
  2297. :group 'org-font-lock
  2298. :type 'boolean)
  2299. (defcustom org-fontify-emphasized-text t
  2300. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  2301. Changing this variable requires a restart of Emacs to take effect."
  2302. :group 'org-font-lock
  2303. :type 'boolean)
  2304. (defcustom org-highlight-latex-fragments-and-specials nil
  2305. "Non-nil means, fontify what is treated specially by the exporters."
  2306. :group 'org-font-lock
  2307. :type 'boolean)
  2308. (defcustom org-hide-emphasis-markers nil
  2309. "Non-nil mean font-lock should hide the emphasis marker characters."
  2310. :group 'org-font-lock
  2311. :type 'boolean)
  2312. (defvar org-emph-re nil
  2313. "Regular expression for matching emphasis.")
  2314. (defvar org-verbatim-re nil
  2315. "Regular expression for matching verbatim text.")
  2316. (defvar org-emphasis-regexp-components) ; defined just below
  2317. (defvar org-emphasis-alist) ; defined just below
  2318. (defun org-set-emph-re (var val)
  2319. "Set variable and compute the emphasis regular expression."
  2320. (set var val)
  2321. (when (and (boundp 'org-emphasis-alist)
  2322. (boundp 'org-emphasis-regexp-components)
  2323. org-emphasis-alist org-emphasis-regexp-components)
  2324. (let* ((e org-emphasis-regexp-components)
  2325. (pre (car e))
  2326. (post (nth 1 e))
  2327. (border (nth 2 e))
  2328. (body (nth 3 e))
  2329. (nl (nth 4 e))
  2330. (body1 (concat body "*?"))
  2331. (markers (mapconcat 'car org-emphasis-alist ""))
  2332. (vmarkers (mapconcat
  2333. (lambda (x) (if (eq (nth 4 x) 'verbatim) (car x) ""))
  2334. org-emphasis-alist "")))
  2335. ;; make sure special characters appear at the right position in the class
  2336. (if (string-match "\\^" markers)
  2337. (setq markers (concat (replace-match "" t t markers) "^")))
  2338. (if (string-match "-" markers)
  2339. (setq markers (concat (replace-match "" t t markers) "-")))
  2340. (if (string-match "\\^" vmarkers)
  2341. (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
  2342. (if (string-match "-" vmarkers)
  2343. (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
  2344. (if (> nl 0)
  2345. (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
  2346. (int-to-string nl) "\\}")))
  2347. ;; Make the regexp
  2348. (setq org-emph-re
  2349. (concat "\\([" pre "]\\|^\\)"
  2350. "\\("
  2351. "\\([" markers "]\\)"
  2352. "\\("
  2353. "[^" border "]\\|"
  2354. "[^" border "]"
  2355. body1
  2356. "[^" border "]"
  2357. "\\)"
  2358. "\\3\\)"
  2359. "\\([" post "]\\|$\\)"))
  2360. (setq org-verbatim-re
  2361. (concat "\\([" pre "]\\|^\\)"
  2362. "\\("
  2363. "\\([" vmarkers "]\\)"
  2364. "\\("
  2365. "[^" border "]\\|"
  2366. "[^" border "]"
  2367. body1
  2368. "[^" border "]"
  2369. "\\)"
  2370. "\\3\\)"
  2371. "\\([" post "]\\|$\\)")))))
  2372. (defcustom org-emphasis-regexp-components
  2373. '(" \t('\"{" "- \t.,:!?;'\")}" " \t\r\n,\"'" "." 1)
  2374. "Components used to build the regular expression for emphasis.
  2375. This is a list with 6 entries. Terminology: In an emphasis string
  2376. like \" *strong word* \", we call the initial space PREMATCH, the final
  2377. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  2378. and \"trong wor\" is the body. The different components in this variable
  2379. specify what is allowed/forbidden in each part:
  2380. pre Chars allowed as prematch. Beginning of line will be allowed too.
  2381. post Chars allowed as postmatch. End of line will be allowed too.
  2382. border The chars *forbidden* as border characters.
  2383. body-regexp A regexp like \".\" to match a body character. Don't use
  2384. non-shy groups here, and don't allow newline here.
  2385. newline The maximum number of newlines allowed in an emphasis exp.
  2386. Use customize to modify this, or restart Emacs after changing it."
  2387. :group 'org-font-lock
  2388. :set 'org-set-emph-re
  2389. :type '(list
  2390. (sexp :tag "Allowed chars in pre ")
  2391. (sexp :tag "Allowed chars in post ")
  2392. (sexp :tag "Forbidden chars in border ")
  2393. (sexp :tag "Regexp for body ")
  2394. (integer :tag "number of newlines allowed")
  2395. (option (boolean :tag "Please ignore this button"))))
  2396. (defcustom org-emphasis-alist
  2397. `(("*" bold "<b>" "</b>")
  2398. ("/" italic "<i>" "</i>")
  2399. ("_" underline "<span style=\"text-decoration:underline;\">" "</span>")
  2400. ("=" org-code "<code>" "</code>" verbatim)
  2401. ("~" org-verbatim "<code>" "</code>" verbatim)
  2402. ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))
  2403. "<del>" "</del>")
  2404. )
  2405. "Special syntax for emphasized text.
  2406. Text starting and ending with a special character will be emphasized, for
  2407. example *bold*, _underlined_ and /italic/. This variable sets the marker
  2408. characters, the face to be used by font-lock for highlighting in Org-mode
  2409. Emacs buffers, and the HTML tags to be used for this.
  2410. For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
  2411. Use customize to modify this, or restart Emacs after changing it."
  2412. :group 'org-font-lock
  2413. :set 'org-set-emph-re
  2414. :type '(repeat
  2415. (list
  2416. (string :tag "Marker character")
  2417. (choice
  2418. (face :tag "Font-lock-face")
  2419. (plist :tag "Face property list"))
  2420. (string :tag "HTML start tag")
  2421. (string :tag "HTML end tag")
  2422. (option (const verbatim)))))
  2423. ;;; Miscellaneous options
  2424. (defgroup org-completion nil
  2425. "Completion in Org-mode."
  2426. :tag "Org Completion"
  2427. :group 'org)
  2428. (defcustom org-completion-use-ido nil
  2429. "Non-nil means, use ido completion wherever possible.
  2430. Note that `ido-mode' must be active for this variable to be relevant.
  2431. If you decide to turn this variable on, you might well want to turn off
  2432. `org-outline-path-complete-in-steps'."
  2433. :group 'org-completion
  2434. :type 'boolean)
  2435. (defcustom org-completion-fallback-command 'hippie-expand
  2436. "The expansion command called by \\[org-complete] in normal context.
  2437. Normal means, no org-mode-specific context."
  2438. :group 'org-completion
  2439. :type 'function)
  2440. ;;; Functions and variables from ther packages
  2441. ;; Declared here to avoid compiler warnings
  2442. ;; XEmacs only
  2443. (defvar outline-mode-menu-heading)
  2444. (defvar outline-mode-menu-show)
  2445. (defvar outline-mode-menu-hide)
  2446. (defvar zmacs-regions) ; XEmacs regions
  2447. ;; Emacs only
  2448. (defvar mark-active)
  2449. ;; Various packages
  2450. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  2451. (declare-function calendar-forward-day "cal-move" (arg))
  2452. (declare-function calendar-goto-date "cal-move" (date))
  2453. (declare-function calendar-goto-today "cal-move" ())
  2454. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  2455. (defvar calc-embedded-close-formula)
  2456. (defvar calc-embedded-open-formula)
  2457. (declare-function cdlatex-tab "ext:cdlatex" ())
  2458. (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
  2459. (defvar font-lock-unfontify-region-function)
  2460. (declare-function iswitchb-mode "iswitchb" (&optional arg))
  2461. (declare-function iswitchb-read-buffer (prompt &optional default require-match start matches-set))
  2462. (defvar iswitchb-temp-buflist)
  2463. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  2464. (defvar org-agenda-tags-todo-honor-ignore-options)
  2465. (declare-function org-agenda-skip "org-agenda" ())
  2466. (declare-function org-format-agenda-item "org-agenda"
  2467. (extra txt &optional category tags dotime noprefix remove-re))
  2468. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  2469. (declare-function org-agenda-change-all-lines "org-agenda"
  2470. (newhead hdmarker &optional fixface just-this))
  2471. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  2472. (declare-function org-agenda-maybe-redo "org-agenda" ())
  2473. (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
  2474. (beg end))
  2475. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  2476. (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  2477. "org-agenda" (&optional end))
  2478. (declare-function parse-time-string "parse-time" (string))
  2479. (declare-function remember "remember" (&optional initial))
  2480. (declare-function remember-buffer-desc "remember" ())
  2481. (declare-function remember-finalize "remember" ())
  2482. (defvar remember-save-after-remembering)
  2483. (defvar remember-data-file)
  2484. (defvar remember-register)
  2485. (defvar remember-buffer)
  2486. (defvar remember-handler-functions)
  2487. (defvar remember-annotation-functions)
  2488. (defvar texmathp-why)
  2489. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  2490. (declare-function table--at-cell-p "table" (position &optional object at-column))
  2491. (defvar w3m-current-url)
  2492. (defvar w3m-current-title)
  2493. (defvar org-latex-regexps)
  2494. ;;; Autoload and prepare some org modules
  2495. ;; Some table stuff that needs to be defined here, because it is used
  2496. ;; by the functions setting up org-mode or checking for table context.
  2497. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  2498. "Detects an org-type or table-type table.")
  2499. (defconst org-table-line-regexp "^[ \t]*|"
  2500. "Detects an org-type table line.")
  2501. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  2502. "Detects an org-type table line.")
  2503. (defconst org-table-hline-regexp "^[ \t]*|-"
  2504. "Detects an org-type table hline.")
  2505. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  2506. "Detects a table-type table hline.")
  2507. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  2508. "Searching from within a table (any type) this finds the first line
  2509. outside the table.")
  2510. ;; Autoload the functions in org-table.el that are needed by functions here.
  2511. (eval-and-compile
  2512. (org-autoload "org-table"
  2513. '(org-table-align org-table-begin org-table-blank-field
  2514. org-table-convert org-table-convert-region org-table-copy-down
  2515. org-table-copy-region org-table-create
  2516. org-table-create-or-convert-from-region
  2517. org-table-create-with-table.el org-table-current-dline
  2518. org-table-cut-region org-table-delete-column org-table-edit-field
  2519. org-table-edit-formulas org-table-end org-table-eval-formula
  2520. org-table-export org-table-field-info
  2521. org-table-get-stored-formulas org-table-goto-column
  2522. org-table-hline-and-move org-table-import org-table-insert-column
  2523. org-table-insert-hline org-table-insert-row org-table-iterate
  2524. org-table-justify-field-maybe org-table-kill-row
  2525. org-table-maybe-eval-formula org-table-maybe-recalculate-line
  2526. org-table-move-column org-table-move-column-left
  2527. org-table-move-column-right org-table-move-row
  2528. org-table-move-row-down org-table-move-row-up
  2529. org-table-next-field org-table-next-row org-table-paste-rectangle
  2530. org-table-previous-field org-table-recalculate
  2531. org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
  2532. org-table-toggle-coordinate-overlays
  2533. org-table-toggle-formula-debugger org-table-wrap-region
  2534. orgtbl-mode turn-on-orgtbl org-table-to-lisp)))
  2535. (defun org-at-table-p (&optional table-type)
  2536. "Return t if the cursor is inside an org-type table.
  2537. If TABLE-TYPE is non-nil, also check for table.el-type tables."
  2538. (if org-enable-table-editor
  2539. (save-excursion
  2540. (beginning-of-line 1)
  2541. (looking-at (if table-type org-table-any-line-regexp
  2542. org-table-line-regexp)))
  2543. nil))
  2544. (defsubst org-table-p () (org-at-table-p))
  2545. (defun org-at-table.el-p ()
  2546. "Return t if and only if we are at a table.el table."
  2547. (and (org-at-table-p 'any)
  2548. (save-excursion
  2549. (goto-char (org-table-begin 'any))
  2550. (looking-at org-table1-hline-regexp))))
  2551. (defun org-table-recognize-table.el ()
  2552. "If there is a table.el table nearby, recognize it and move into it."
  2553. (if org-table-tab-recognizes-table.el
  2554. (if (org-at-table.el-p)
  2555. (progn
  2556. (beginning-of-line 1)
  2557. (if (looking-at org-table-dataline-regexp)
  2558. nil
  2559. (if (looking-at org-table1-hline-regexp)
  2560. (progn
  2561. (beginning-of-line 2)
  2562. (if (looking-at org-table-any-border-regexp)
  2563. (beginning-of-line -1)))))
  2564. (if (re-search-forward "|" (org-table-end t) t)
  2565. (progn
  2566. (require 'table)
  2567. (if (table--at-cell-p (point))
  2568. t
  2569. (message "recognizing table.el table...")
  2570. (table-recognize-table)
  2571. (message "recognizing table.el table...done")))
  2572. (error "This should not happen..."))
  2573. t)
  2574. nil)
  2575. nil))
  2576. (defun org-at-table-hline-p ()
  2577. "Return t if the cursor is inside a hline in a table."
  2578. (if org-enable-table-editor
  2579. (save-excursion
  2580. (beginning-of-line 1)
  2581. (looking-at org-table-hline-regexp))
  2582. nil))
  2583. (defvar org-table-clean-did-remove-column nil)
  2584. (defun org-table-map-tables (function)
  2585. "Apply FUNCTION to the start of all tables in the buffer."
  2586. (save-excursion
  2587. (save-restriction
  2588. (widen)
  2589. (goto-char (point-min))
  2590. (while (re-search-forward org-table-any-line-regexp nil t)
  2591. (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
  2592. (beginning-of-line 1)
  2593. (if (looking-at org-table-line-regexp)
  2594. (save-excursion (funcall function)))
  2595. (re-search-forward org-table-any-border-regexp nil 1))))
  2596. (message "Mapping tables: done"))
  2597. ;; Declare and autoload functions from org-exp.el & Co
  2598. (declare-function org-default-export-plist "org-exp")
  2599. (declare-function org-infile-export-plist "org-exp")
  2600. (declare-function org-get-current-options "org-exp")
  2601. (eval-and-compile
  2602. (org-autoload "org-exp"
  2603. '(org-export org-export-visible
  2604. org-insert-export-options-template
  2605. org-table-clean-before-export))
  2606. (org-autoload "org-ascii"
  2607. '(org-export-as-ascii org-export-ascii-preprocess
  2608. org-export-as-ascii-to-buffer org-replace-region-by-ascii
  2609. org-export-region-as-ascii))
  2610. (org-autoload "org-html"
  2611. '(org-export-as-html-and-open
  2612. org-export-as-html-batch org-export-as-html-to-buffer
  2613. org-replace-region-by-html org-export-region-as-html
  2614. org-export-as-html))
  2615. (org-autoload "org-icalendar"
  2616. '(org-export-icalendar-this-file
  2617. org-export-icalendar-all-agenda-files
  2618. org-export-icalendar-combine-agenda-files))
  2619. (org-autoload "org-xoxo" '(org-export-as-xoxo)))
  2620. ;; Declare and autoload functions from org-agenda.el
  2621. (eval-and-compile
  2622. (org-autoload "org-agenda"
  2623. '(org-agenda org-agenda-list org-search-view
  2624. org-todo-list org-tags-view org-agenda-list-stuck-projects
  2625. org-diary org-agenda-to-appt
  2626. org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
  2627. ;; Autoload org-remember
  2628. (eval-and-compile
  2629. (org-autoload "org-remember"
  2630. '(org-remember-insinuate org-remember-annotation
  2631. org-remember-apply-template org-remember org-remember-handler)))
  2632. ;; Autoload org-clock.el
  2633. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock"
  2634. (beg end))
  2635. (declare-function org-clock-update-mode-line "org-clock" ())
  2636. (defvar org-clock-start-time)
  2637. (defvar org-clock-marker (make-marker)
  2638. "Marker recording the last clock-in.")
  2639. (eval-and-compile
  2640. (org-autoload
  2641. "org-clock"
  2642. '(org-clock-in org-clock-out org-clock-cancel
  2643. org-clock-goto org-clock-sum org-clock-display
  2644. org-clock-remove-overlays org-clock-report
  2645. org-clocktable-shift org-dblock-write:clocktable
  2646. org-get-clocktable)))
  2647. (defun org-clock-update-time-maybe ()
  2648. "If this is a CLOCK line, update it and return t.
  2649. Otherwise, return nil."
  2650. (interactive)
  2651. (save-excursion
  2652. (beginning-of-line 1)
  2653. (skip-chars-forward " \t")
  2654. (when (looking-at org-clock-string)
  2655. (let ((re (concat "[ \t]*" org-clock-string
  2656. " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
  2657. "\\([ \t]*=>.*\\)?\\)?"))
  2658. ts te h m s neg)
  2659. (cond
  2660. ((not (looking-at re))
  2661. nil)
  2662. ((not (match-end 2))
  2663. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  2664. (> org-clock-marker (point))
  2665. (<= org-clock-marker (point-at-eol)))
  2666. ;; The clock is running here
  2667. (setq org-clock-start-time
  2668. (apply 'encode-time
  2669. (org-parse-time-string (match-string 1))))
  2670. (org-clock-update-mode-line)))
  2671. (t
  2672. (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
  2673. (end-of-line 1)
  2674. (setq ts (match-string 1)
  2675. te (match-string 3))
  2676. (setq s (- (time-to-seconds
  2677. (apply 'encode-time (org-parse-time-string te)))
  2678. (time-to-seconds
  2679. (apply 'encode-time (org-parse-time-string ts))))
  2680. neg (< s 0)
  2681. s (abs s)
  2682. h (floor (/ s 3600))
  2683. s (- s (* 3600 h))
  2684. m (floor (/ s 60))
  2685. s (- s (* 60 s)))
  2686. (insert " => " (format (if neg "-%d:%02d" "%2d:%02d") h m))
  2687. t))))))
  2688. (defun org-check-running-clock ()
  2689. "Check if the current buffer contains the running clock.
  2690. If yes, offer to stop it and to save the buffer with the changes."
  2691. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  2692. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  2693. (buffer-name))))
  2694. (org-clock-out)
  2695. (when (y-or-n-p "Save changed buffer?")
  2696. (save-buffer))))
  2697. (defun org-clocktable-try-shift (dir n)
  2698. "Check if this line starts a clock table, if yes, shift the time block."
  2699. (when (org-match-line "#\\+BEGIN: clocktable\\>")
  2700. (org-clocktable-shift dir n)))
  2701. ;; Autoload org-timer.el
  2702. (eval-and-compile
  2703. (org-autoload
  2704. "org-timer"
  2705. '(org-timer-start org-timer org-timer-item
  2706. org-timer-change-times-in-region)))
  2707. ;; Autoload org-feed.el
  2708. (eval-and-compile
  2709. (org-autoload
  2710. "org-feed"
  2711. '(org-feed-update org-feed-update-all org-feed-goto-inbox)))
  2712. ;; Autoload archiving code
  2713. ;; The stuff that is needed for cycling and tags has to be defined here.
  2714. (defgroup org-archive nil
  2715. "Options concerning archiving in Org-mode."
  2716. :tag "Org Archive"
  2717. :group 'org-structure)
  2718. (defcustom org-archive-location "%s_archive::"
  2719. "The location where subtrees should be archived.
  2720. The value of this variable is a string, consisting of two parts,
  2721. separated by a double-colon. The first part is a filename and
  2722. the second part is a headline.
  2723. When the filename is omitted, archiving happens in the same file.
  2724. %s in the filename will be replaced by the current file
  2725. name (without the directory part). Archiving to a different file
  2726. is useful to keep archived entries from contributing to the
  2727. Org-mode Agenda.
  2728. The archived entries will be filed as subtrees of the specified
  2729. headline. When the headline is omitted, the subtrees are simply
  2730. filed away at the end of the file, as top-level entries. Also in
  2731. the heading you can use %s to represent the file name, this can be
  2732. useful when using the same archive for a number of different files.
  2733. Here are a few examples:
  2734. \"%s_archive::\"
  2735. If the current file is Projects.org, archive in file
  2736. Projects.org_archive, as top-level trees. This is the default.
  2737. \"::* Archived Tasks\"
  2738. Archive in the current file, under the top-level headline
  2739. \"* Archived Tasks\".
  2740. \"~/org/archive.org::\"
  2741. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  2742. \"~/org/archive.org::From %s\"
  2743. Archive in file ~/org/archive.org (absolute path), und headlines
  2744. \"From FILENAME\" where file name is the current file name.
  2745. \"basement::** Finished Tasks\"
  2746. Archive in file ./basement (relative path), as level 3 trees
  2747. below the level 2 heading \"** Finished Tasks\".
  2748. You may set this option on a per-file basis by adding to the buffer a
  2749. line like
  2750. #+ARCHIVE: basement::** Finished Tasks
  2751. You may also define it locally for a subtree by setting an ARCHIVE property
  2752. in the entry. If such a property is found in an entry, or anywhere up
  2753. the hierarchy, it will be used."
  2754. :group 'org-archive
  2755. :type 'string)
  2756. (defcustom org-archive-tag "ARCHIVE"
  2757. "The tag that marks a subtree as archived.
  2758. An archived subtree does not open during visibility cycling, and does
  2759. not contribute to the agenda listings.
  2760. After changing this, font-lock must be restarted in the relevant buffers to
  2761. get the proper fontification."
  2762. :group 'org-archive
  2763. :group 'org-keywords
  2764. :type 'string)
  2765. (defcustom org-agenda-skip-archived-trees t
  2766. "Non-nil means, the agenda will skip any items located in archived trees.
  2767. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  2768. variable is no longer recommended, you should leave it at the value t.
  2769. Instead, use the key `v' to cycle the archives-mode in the agenda."
  2770. :group 'org-archive
  2771. :group 'org-agenda-skip
  2772. :type 'boolean)
  2773. (defcustom org-columns-skip-arrchived-trees t
  2774. "Non-nil means, irgnore archived trees when creating column view."
  2775. :group 'org-archive
  2776. :group 'org-properties
  2777. :type 'boolean)
  2778. (defcustom org-cycle-open-archived-trees nil
  2779. "Non-nil means, `org-cycle' will open archived trees.
  2780. An archived tree is a tree marked with the tag ARCHIVE.
  2781. When nil, archived trees will stay folded. You can still open them with
  2782. normal outline commands like `show-all', but not with the cycling commands."
  2783. :group 'org-archive
  2784. :group 'org-cycle
  2785. :type 'boolean)
  2786. (defcustom org-sparse-tree-open-archived-trees nil
  2787. "Non-nil means sparse tree construction shows matches in archived trees.
  2788. When nil, matches in these trees are highlighted, but the trees are kept in
  2789. collapsed state."
  2790. :group 'org-archive
  2791. :group 'org-sparse-trees
  2792. :type 'boolean)
  2793. (defun org-cycle-hide-archived-subtrees (state)
  2794. "Re-hide all archived subtrees after a visibility state change."
  2795. (when (and (not org-cycle-open-archived-trees)
  2796. (not (memq state '(overview folded))))
  2797. (save-excursion
  2798. (let* ((globalp (memq state '(contents all)))
  2799. (beg (if globalp (point-min) (point)))
  2800. (end (if globalp (point-max) (org-end-of-subtree t))))
  2801. (org-hide-archived-subtrees beg end)
  2802. (goto-char beg)
  2803. (if (looking-at (concat ".*:" org-archive-tag ":"))
  2804. (message "%s" (substitute-command-keys
  2805. "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
  2806. (defun org-force-cycle-archived ()
  2807. "Cycle subtree even if it is archived."
  2808. (interactive)
  2809. (setq this-command 'org-cycle)
  2810. (let ((org-cycle-open-archived-trees t))
  2811. (call-interactively 'org-cycle)))
  2812. (defun org-hide-archived-subtrees (beg end)
  2813. "Re-hide all archived subtrees after a visibility state change."
  2814. (save-excursion
  2815. (let* ((re (concat ":" org-archive-tag ":")))
  2816. (goto-char beg)
  2817. (while (re-search-forward re end t)
  2818. (and (org-on-heading-p) (hide-subtree))
  2819. (org-end-of-subtree t)))))
  2820. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  2821. (eval-and-compile
  2822. (org-autoload "org-archive"
  2823. '(org-add-archive-files org-archive-subtree
  2824. org-archive-to-archive-sibling org-toggle-archive-tag)))
  2825. ;; Autoload Column View Code
  2826. (declare-function org-columns-number-to-string "org-colview")
  2827. (declare-function org-columns-get-format-and-top-level "org-colview")
  2828. (declare-function org-columns-compute "org-colview")
  2829. (org-autoload (if (featurep 'xemacs) "org-colview-xemacs" "org-colview")
  2830. '(org-columns-number-to-string org-columns-get-format-and-top-level
  2831. org-columns-compute org-agenda-columns org-columns-remove-overlays
  2832. org-columns org-insert-columns-dblock org-dblock-write:columnview))
  2833. ;; Autoload ID code
  2834. (declare-function org-id-store-link "org-id")
  2835. (declare-function org-id-locations-load "org-id")
  2836. (declare-function org-id-locations-save "org-id")
  2837. (defvar org-id-track-globally)
  2838. (org-autoload "org-id"
  2839. '(org-id-get-create org-id-new org-id-copy org-id-get
  2840. org-id-get-with-outline-path-completion
  2841. org-id-get-with-outline-drilling
  2842. org-id-goto org-id-find org-id-store-link))
  2843. ;; Autoload Plotting Code
  2844. (org-autoload "org-plot"
  2845. '(org-plot/gnuplot))
  2846. ;;; Variables for pre-computed regular expressions, all buffer local
  2847. (defvar org-drawer-regexp nil
  2848. "Matches first line of a hidden block.")
  2849. (make-variable-buffer-local 'org-drawer-regexp)
  2850. (defvar org-todo-regexp nil
  2851. "Matches any of the TODO state keywords.")
  2852. (make-variable-buffer-local 'org-todo-regexp)
  2853. (defvar org-not-done-regexp nil
  2854. "Matches any of the TODO state keywords except the last one.")
  2855. (make-variable-buffer-local 'org-not-done-regexp)
  2856. (defvar org-not-done-heading-regexp nil
  2857. "Matches a TODO headline that is not done.")
  2858. (make-variable-buffer-local 'org-not-done-regexp)
  2859. (defvar org-todo-line-regexp nil
  2860. "Matches a headline and puts TODO state into group 2 if present.")
  2861. (make-variable-buffer-local 'org-todo-line-regexp)
  2862. (defvar org-complex-heading-regexp nil
  2863. "Matches a headline and puts everything into groups:
  2864. group 1: the stars
  2865. group 2: The todo keyword, maybe
  2866. group 3: Priority cookie
  2867. group 4: True headline
  2868. group 5: Tags")
  2869. (make-variable-buffer-local 'org-complex-heading-regexp)
  2870. (defvar org-todo-line-tags-regexp nil
  2871. "Matches a headline and puts TODO state into group 2 if present.
  2872. Also put tags into group 4 if tags are present.")
  2873. (make-variable-buffer-local 'org-todo-line-tags-regexp)
  2874. (defvar org-nl-done-regexp nil
  2875. "Matches newline followed by a headline with the DONE keyword.")
  2876. (make-variable-buffer-local 'org-nl-done-regexp)
  2877. (defvar org-looking-at-done-regexp nil
  2878. "Matches the DONE keyword a point.")
  2879. (make-variable-buffer-local 'org-looking-at-done-regexp)
  2880. (defvar org-ds-keyword-length 12
  2881. "Maximum length of the Deadline and SCHEDULED keywords.")
  2882. (make-variable-buffer-local 'org-ds-keyword-length)
  2883. (defvar org-deadline-regexp nil
  2884. "Matches the DEADLINE keyword.")
  2885. (make-variable-buffer-local 'org-deadline-regexp)
  2886. (defvar org-deadline-time-regexp nil
  2887. "Matches the DEADLINE keyword together with a time stamp.")
  2888. (make-variable-buffer-local 'org-deadline-time-regexp)
  2889. (defvar org-deadline-line-regexp nil
  2890. "Matches the DEADLINE keyword and the rest of the line.")
  2891. (make-variable-buffer-local 'org-deadline-line-regexp)
  2892. (defvar org-scheduled-regexp nil
  2893. "Matches the SCHEDULED keyword.")
  2894. (make-variable-buffer-local 'org-scheduled-regexp)
  2895. (defvar org-scheduled-time-regexp nil
  2896. "Matches the SCHEDULED keyword together with a time stamp.")
  2897. (make-variable-buffer-local 'org-scheduled-time-regexp)
  2898. (defvar org-closed-time-regexp nil
  2899. "Matches the CLOSED keyword together with a time stamp.")
  2900. (make-variable-buffer-local 'org-closed-time-regexp)
  2901. (defvar org-keyword-time-regexp nil
  2902. "Matches any of the 4 keywords, together with the time stamp.")
  2903. (make-variable-buffer-local 'org-keyword-time-regexp)
  2904. (defvar org-keyword-time-not-clock-regexp nil
  2905. "Matches any of the 3 keywords, together with the time stamp.")
  2906. (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
  2907. (defvar org-maybe-keyword-time-regexp nil
  2908. "Matches a timestamp, possibly preceeded by a keyword.")
  2909. (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
  2910. (defvar org-planning-or-clock-line-re nil
  2911. "Matches a line with planning or clock info.")
  2912. (make-variable-buffer-local 'org-planning-or-clock-line-re)
  2913. (defconst org-plain-time-of-day-regexp
  2914. (concat
  2915. "\\(\\<[012]?[0-9]"
  2916. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  2917. "\\(--?"
  2918. "\\(\\<[012]?[0-9]"
  2919. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  2920. "\\)?")
  2921. "Regular expression to match a plain time or time range.
  2922. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  2923. groups carry important information:
  2924. 0 the full match
  2925. 1 the first time, range or not
  2926. 8 the second time, if it is a range.")
  2927. (defconst org-plain-time-extension-regexp
  2928. (concat
  2929. "\\(\\<[012]?[0-9]"
  2930. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  2931. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  2932. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  2933. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  2934. groups carry important information:
  2935. 0 the full match
  2936. 7 hours of duration
  2937. 9 minutes of duration")
  2938. (defconst org-stamp-time-of-day-regexp
  2939. (concat
  2940. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  2941. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  2942. "\\(--?"
  2943. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  2944. "Regular expression to match a timestamp time or time range.
  2945. After a match, the following groups carry important information:
  2946. 0 the full match
  2947. 1 date plus weekday, for backreferencing to make sure both times on same day
  2948. 2 the first time, range or not
  2949. 4 the second time, if it is a range.")
  2950. (defconst org-startup-options
  2951. '(("fold" org-startup-folded t)
  2952. ("overview" org-startup-folded t)
  2953. ("nofold" org-startup-folded nil)
  2954. ("showall" org-startup-folded nil)
  2955. ("content" org-startup-folded content)
  2956. ("hidestars" org-hide-leading-stars t)
  2957. ("showstars" org-hide-leading-stars nil)
  2958. ("odd" org-odd-levels-only t)
  2959. ("oddeven" org-odd-levels-only nil)
  2960. ("align" org-startup-align-all-tables t)
  2961. ("noalign" org-startup-align-all-tables nil)
  2962. ("customtime" org-display-custom-times t)
  2963. ("logdone" org-log-done time)
  2964. ("lognotedone" org-log-done note)
  2965. ("nologdone" org-log-done nil)
  2966. ("lognoteclock-out" org-log-note-clock-out t)
  2967. ("nolognoteclock-out" org-log-note-clock-out nil)
  2968. ("logrepeat" org-log-repeat state)
  2969. ("lognoterepeat" org-log-repeat note)
  2970. ("nologrepeat" org-log-repeat nil)
  2971. ("fninline" org-footnote-define-inline t)
  2972. ("nofninline" org-footnote-define-inline nil)
  2973. ("fnlocal" org-footnote-section nil)
  2974. ("fnauto" org-footnote-auto-label t)
  2975. ("fnprompt" org-footnote-auto-label nil)
  2976. ("fnconfirm" org-footnote-auto-label confirm)
  2977. ("fnplain" org-footnote-auto-label plain)
  2978. ("constcgs" constants-unit-system cgs)
  2979. ("constSI" constants-unit-system SI)
  2980. ("noptag" org-tag-persistent-alist nil))
  2981. "Variable associated with STARTUP options for org-mode.
  2982. Each element is a list of three items: The startup options as written
  2983. in the #+STARTUP line, the corresponding variable, and the value to
  2984. set this variable to if the option is found. An optional forth element PUSH
  2985. means to push this value onto the list in the variable.")
  2986. (defun org-set-regexps-and-options ()
  2987. "Precompute regular expressions for current buffer."
  2988. (when (org-mode-p)
  2989. (org-set-local 'org-todo-kwd-alist nil)
  2990. (org-set-local 'org-todo-key-alist nil)
  2991. (org-set-local 'org-todo-key-trigger nil)
  2992. (org-set-local 'org-todo-keywords-1 nil)
  2993. (org-set-local 'org-done-keywords nil)
  2994. (org-set-local 'org-todo-heads nil)
  2995. (org-set-local 'org-todo-sets nil)
  2996. (org-set-local 'org-todo-log-states nil)
  2997. (org-set-local 'org-file-properties nil)
  2998. (org-set-local 'org-file-tags nil)
  2999. (let ((re (org-make-options-regexp
  3000. '("CATEGORY" "TODO" "COLUMNS"
  3001. "STARTUP" "ARCHIVE" "FILETAGS" "TAGS" "LINK" "PRIORITIES"
  3002. "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE")
  3003. "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
  3004. (splitre "[ \t]+")
  3005. kwds kws0 kwsa key log value cat arch tags const links hw dws
  3006. tail sep kws1 prio props ftags drawers
  3007. ext-setup-or-nil setup-contents (start 0))
  3008. (save-excursion
  3009. (save-restriction
  3010. (widen)
  3011. (goto-char (point-min))
  3012. (while (or (and ext-setup-or-nil
  3013. (string-match re ext-setup-or-nil start)
  3014. (setq start (match-end 0)))
  3015. (and (setq ext-setup-or-nil nil start 0)
  3016. (re-search-forward re nil t)))
  3017. (setq key (upcase (match-string 1 ext-setup-or-nil))
  3018. value (org-match-string-no-properties 2 ext-setup-or-nil))
  3019. (cond
  3020. ((equal key "CATEGORY")
  3021. (if (string-match "[ \t]+$" value)
  3022. (setq value (replace-match "" t t value)))
  3023. (setq cat value))
  3024. ((member key '("SEQ_TODO" "TODO"))
  3025. (push (cons 'sequence (org-split-string value splitre)) kwds))
  3026. ((equal key "TYP_TODO")
  3027. (push (cons 'type (org-split-string value splitre)) kwds))
  3028. ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
  3029. ;; general TODO-like setup
  3030. (push (cons (intern (downcase (match-string 1 key)))
  3031. (org-split-string value splitre)) kwds))
  3032. ((equal key "TAGS")
  3033. (setq tags (append tags (if tags '("\\n") nil)
  3034. (org-split-string value splitre))))
  3035. ((equal key "COLUMNS")
  3036. (org-set-local 'org-columns-default-format value))
  3037. ((equal key "LINK")
  3038. (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  3039. (push (cons (match-string 1 value)
  3040. (org-trim (match-string 2 value)))
  3041. links)))
  3042. ((equal key "PRIORITIES")
  3043. (setq prio (org-split-string value " +")))
  3044. ((equal key "PROPERTY")
  3045. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  3046. (push (cons (match-string 1 value) (match-string 2 value))
  3047. props)))
  3048. ((equal key "FILETAGS")
  3049. (when (string-match "\\S-" value)
  3050. (setq ftags
  3051. (append
  3052. ftags
  3053. (apply 'append
  3054. (mapcar (lambda (x) (org-split-string x ":"))
  3055. (org-split-string value)))))))
  3056. ((equal key "DRAWERS")
  3057. (setq drawers (org-split-string value splitre)))
  3058. ((equal key "CONSTANTS")
  3059. (setq const (append const (org-split-string value splitre))))
  3060. ((equal key "STARTUP")
  3061. (let ((opts (org-split-string value splitre))
  3062. l var val)
  3063. (while (setq l (pop opts))
  3064. (when (setq l (assoc l org-startup-options))
  3065. (setq var (nth 1 l) val (nth 2 l))
  3066. (if (not (nth 3 l))
  3067. (set (make-local-variable var) val)
  3068. (if (not (listp (symbol-value var)))
  3069. (set (make-local-variable var) nil))
  3070. (set (make-local-variable var) (symbol-value var))
  3071. (add-to-list var val))))))
  3072. ((equal key "ARCHIVE")
  3073. (string-match " *$" value)
  3074. (setq arch (replace-match "" t t value))
  3075. (remove-text-properties 0 (length arch)
  3076. '(face t fontified t) arch))
  3077. ((equal key "SETUPFILE")
  3078. (setq setup-contents (org-file-contents
  3079. (expand-file-name
  3080. (org-remove-double-quotes value))
  3081. 'noerror))
  3082. (if (not ext-setup-or-nil)
  3083. (setq ext-setup-or-nil setup-contents start 0)
  3084. (setq ext-setup-or-nil
  3085. (concat (substring ext-setup-or-nil 0 start)
  3086. "\n" setup-contents "\n"
  3087. (substring ext-setup-or-nil start)))))
  3088. ))))
  3089. (when cat
  3090. (org-set-local 'org-category (intern cat))
  3091. (push (cons "CATEGORY" cat) props))
  3092. (when prio
  3093. (if (< (length prio) 3) (setq prio '("A" "C" "B")))
  3094. (setq prio (mapcar 'string-to-char prio))
  3095. (org-set-local 'org-highest-priority (nth 0 prio))
  3096. (org-set-local 'org-lowest-priority (nth 1 prio))
  3097. (org-set-local 'org-default-priority (nth 2 prio)))
  3098. (and props (org-set-local 'org-file-properties (nreverse props)))
  3099. (and ftags (org-set-local 'org-file-tags
  3100. (mapcar 'org-add-prop-inherited ftags)))
  3101. (and drawers (org-set-local 'org-drawers drawers))
  3102. (and arch (org-set-local 'org-archive-location arch))
  3103. (and links (setq org-link-abbrev-alist-local (nreverse links)))
  3104. ;; Process the TODO keywords
  3105. (unless kwds
  3106. ;; Use the global values as if they had been given locally.
  3107. (setq kwds (default-value 'org-todo-keywords))
  3108. (if (stringp (car kwds))
  3109. (setq kwds (list (cons org-todo-interpretation
  3110. (default-value 'org-todo-keywords)))))
  3111. (setq kwds (reverse kwds)))
  3112. (setq kwds (nreverse kwds))
  3113. (let (inter kws kw)
  3114. (while (setq kws (pop kwds))
  3115. (let ((kws (or
  3116. (run-hook-with-args-until-success
  3117. 'org-todo-setup-filter-hook kws)
  3118. kws)))
  3119. (setq inter (pop kws) sep (member "|" kws)
  3120. kws0 (delete "|" (copy-sequence kws))
  3121. kwsa nil
  3122. kws1 (mapcar
  3123. (lambda (x)
  3124. ;; 1 2
  3125. (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
  3126. (progn
  3127. (setq kw (match-string 1 x)
  3128. key (and (match-end 2) (match-string 2 x))
  3129. log (org-extract-log-state-settings x))
  3130. (push (cons kw (and key (string-to-char key))) kwsa)
  3131. (and log (push log org-todo-log-states))
  3132. kw)
  3133. (error "Invalid TODO keyword %s" x)))
  3134. kws0)
  3135. kwsa (if kwsa (append '((:startgroup))
  3136. (nreverse kwsa)
  3137. '((:endgroup))))
  3138. hw (car kws1)
  3139. dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
  3140. tail (list inter hw (car dws) (org-last dws))))
  3141. (add-to-list 'org-todo-heads hw 'append)
  3142. (push kws1 org-todo-sets)
  3143. (setq org-done-keywords (append org-done-keywords dws nil))
  3144. (setq org-todo-key-alist (append org-todo-key-alist kwsa))
  3145. (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
  3146. (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
  3147. (setq org-todo-sets (nreverse org-todo-sets)
  3148. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  3149. org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
  3150. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
  3151. ;; Process the constants
  3152. (when const
  3153. (let (e cst)
  3154. (while (setq e (pop const))
  3155. (if (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" e)
  3156. (push (cons (match-string 1 e) (match-string 2 e)) cst)))
  3157. (setq org-table-formula-constants-local cst)))
  3158. ;; Process the tags.
  3159. (when tags
  3160. (let (e tgs)
  3161. (while (setq e (pop tags))
  3162. (cond
  3163. ((equal e "{") (push '(:startgroup) tgs))
  3164. ((equal e "}") (push '(:endgroup) tgs))
  3165. ((equal e "\\n") (push '(:newline) tgs))
  3166. ((string-match (org-re "^\\([[:alnum:]_@]+\\)(\\(.\\))$") e)
  3167. (push (cons (match-string 1 e)
  3168. (string-to-char (match-string 2 e)))
  3169. tgs))
  3170. (t (push (list e) tgs))))
  3171. (org-set-local 'org-tag-alist nil)
  3172. (while (setq e (pop tgs))
  3173. (or (and (stringp (car e))
  3174. (assoc (car e) org-tag-alist))
  3175. (push e org-tag-alist)))))
  3176. ;; Compute the regular expressions and other local variables
  3177. (if (not org-done-keywords)
  3178. (setq org-done-keywords (list (org-last org-todo-keywords-1))))
  3179. (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
  3180. (length org-scheduled-string)
  3181. (length org-clock-string)
  3182. (length org-closed-string)))
  3183. org-drawer-regexp
  3184. (concat "^[ \t]*:\\("
  3185. (mapconcat 'regexp-quote org-drawers "\\|")
  3186. "\\):[ \t]*$")
  3187. org-not-done-keywords
  3188. (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
  3189. org-todo-regexp
  3190. (concat "\\<\\(" (mapconcat 'regexp-quote org-todo-keywords-1
  3191. "\\|") "\\)\\>")
  3192. org-not-done-regexp
  3193. (concat "\\<\\("
  3194. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  3195. "\\)\\>")
  3196. org-not-done-heading-regexp
  3197. (concat "^\\(\\*+\\)[ \t]+\\("
  3198. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  3199. "\\)\\>")
  3200. org-todo-line-regexp
  3201. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3202. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3203. "\\)\\>\\)?[ \t]*\\(.*\\)")
  3204. org-complex-heading-regexp
  3205. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3206. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3207. "\\)\\>\\)?\\(?:[ \t]*\\(\\[#.\\]\\)\\)?[ \t]*\\(.*?\\)"
  3208. "\\(?:[ \t]+\\(:[[:alnum:]_@:]+:\\)\\)?[ \t]*$")
  3209. org-nl-done-regexp
  3210. (concat "\n\\*+[ \t]+"
  3211. "\\(?:" (mapconcat 'regexp-quote org-done-keywords "\\|")
  3212. "\\)" "\\>")
  3213. org-todo-line-tags-regexp
  3214. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3215. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3216. (org-re
  3217. "\\)\\>\\)? *\\(.*?\\([ \t]:[[:alnum:]:_@]+:[ \t]*\\)?$\\)"))
  3218. org-looking-at-done-regexp
  3219. (concat "^" "\\(?:"
  3220. (mapconcat 'regexp-quote org-done-keywords "\\|") "\\)"
  3221. "\\>")
  3222. org-deadline-regexp (concat "\\<" org-deadline-string)
  3223. org-deadline-time-regexp
  3224. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  3225. org-deadline-line-regexp
  3226. (concat "\\<\\(" org-deadline-string "\\).*")
  3227. org-scheduled-regexp
  3228. (concat "\\<" org-scheduled-string)
  3229. org-scheduled-time-regexp
  3230. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  3231. org-closed-time-regexp
  3232. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  3233. org-keyword-time-regexp
  3234. (concat "\\<\\(" org-scheduled-string
  3235. "\\|" org-deadline-string
  3236. "\\|" org-closed-string
  3237. "\\|" org-clock-string "\\)"
  3238. " *[[<]\\([^]>]+\\)[]>]")
  3239. org-keyword-time-not-clock-regexp
  3240. (concat "\\<\\(" org-scheduled-string
  3241. "\\|" org-deadline-string
  3242. "\\|" org-closed-string
  3243. "\\)"
  3244. " *[[<]\\([^]>]+\\)[]>]")
  3245. org-maybe-keyword-time-regexp
  3246. (concat "\\(\\<\\(" org-scheduled-string
  3247. "\\|" org-deadline-string
  3248. "\\|" org-closed-string
  3249. "\\|" org-clock-string "\\)\\)?"
  3250. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
  3251. org-planning-or-clock-line-re
  3252. (concat "\\(?:^[ \t]*\\(" org-scheduled-string
  3253. "\\|" org-deadline-string
  3254. "\\|" org-closed-string "\\|" org-clock-string
  3255. "\\)\\>\\)")
  3256. )
  3257. (org-compute-latex-and-specials-regexp)
  3258. (org-set-font-lock-defaults))))
  3259. (defun org-file-contents (file &optional noerror)
  3260. "Return the contents of FILE, as a string."
  3261. (if (or (not file)
  3262. (not (file-readable-p file)))
  3263. (if noerror
  3264. (progn
  3265. (message "Cannot read file %s" file)
  3266. (ding) (sit-for 2)
  3267. "")
  3268. (error "Cannot read file %s" file))
  3269. (with-temp-buffer
  3270. (insert-file-contents file)
  3271. (buffer-string))))
  3272. (defun org-extract-log-state-settings (x)
  3273. "Extract the log state setting from a TODO keyword string.
  3274. This will extract info from a string like \"WAIT(w@/!)\"."
  3275. (let (kw key log1 log2)
  3276. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  3277. (setq kw (match-string 1 x)
  3278. key (and (match-end 2) (match-string 2 x))
  3279. log1 (and (match-end 3) (match-string 3 x))
  3280. log2 (and (match-end 4) (match-string 4 x)))
  3281. (and (or log1 log2)
  3282. (list kw
  3283. (and log1 (if (equal log1 "!") 'time 'note))
  3284. (and log2 (if (equal log2 "!") 'time 'note)))))))
  3285. (defun org-remove-keyword-keys (list)
  3286. "Remove a pair of parenthesis at the end of each string in LIST."
  3287. (mapcar (lambda (x)
  3288. (if (string-match "(.*)$" x)
  3289. (substring x 0 (match-beginning 0))
  3290. x))
  3291. list))
  3292. ;; FIXME: this could be done much better, using second characters etc.
  3293. (defun org-assign-fast-keys (alist)
  3294. "Assign fast keys to a keyword-key alist.
  3295. Respect keys that are already there."
  3296. (let (new e k c c1 c2 (char ?a))
  3297. (while (setq e (pop alist))
  3298. (cond
  3299. ((equal e '(:startgroup)) (push e new))
  3300. ((equal e '(:endgroup)) (push e new))
  3301. ((equal e '(:newline)) (push e new))
  3302. (t
  3303. (setq k (car e) c2 nil)
  3304. (if (cdr e)
  3305. (setq c (cdr e))
  3306. ;; automatically assign a character.
  3307. (setq c1 (string-to-char
  3308. (downcase (substring
  3309. k (if (= (string-to-char k) ?@) 1 0)))))
  3310. (if (or (rassoc c1 new) (rassoc c1 alist))
  3311. (while (or (rassoc char new) (rassoc char alist))
  3312. (setq char (1+ char)))
  3313. (setq c2 c1))
  3314. (setq c (or c2 char)))
  3315. (push (cons k c) new))))
  3316. (nreverse new)))
  3317. ;;; Some variables used in various places
  3318. (defvar org-window-configuration nil
  3319. "Used in various places to store a window configuration.")
  3320. (defvar org-finish-function nil
  3321. "Function to be called when `C-c C-c' is used.
  3322. This is for getting out of special buffers like remember.")
  3323. ;; FIXME: Occasionally check by commenting these, to make sure
  3324. ;; no other functions uses these, forgetting to let-bind them.
  3325. (defvar entry)
  3326. (defvar state)
  3327. (defvar last-state)
  3328. (defvar date)
  3329. (defvar description)
  3330. ;; Defined somewhere in this file, but used before definition.
  3331. (defvar org-html-entities)
  3332. (defvar org-struct-menu)
  3333. (defvar org-org-menu)
  3334. (defvar org-tbl-menu)
  3335. (defvar org-agenda-keymap)
  3336. ;;;; Define the Org-mode
  3337. (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
  3338. (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."))
  3339. ;; We use a before-change function to check if a table might need
  3340. ;; an update.
  3341. (defvar org-table-may-need-update t
  3342. "Indicates that a table might need an update.
  3343. This variable is set by `org-before-change-function'.
  3344. `org-table-align' sets it back to nil.")
  3345. (defun org-before-change-function (beg end)
  3346. "Every change indicates that a table might need an update."
  3347. (setq org-table-may-need-update t))
  3348. (defvar org-mode-map)
  3349. (defvar org-mode-hook nil
  3350. "Mode hook for Org-mode, run after the mode was turned on.")
  3351. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  3352. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  3353. (defvar org-table-buffer-is-an nil)
  3354. (defconst org-outline-regexp "\\*+ ")
  3355. ;;;###autoload
  3356. (define-derived-mode org-mode outline-mode "Org"
  3357. "Outline-based notes management and organizer, alias
  3358. \"Carsten's outline-mode for keeping track of everything.\"
  3359. Org-mode develops organizational tasks around a NOTES file which
  3360. contains information about projects as plain text. Org-mode is
  3361. implemented on top of outline-mode, which is ideal to keep the content
  3362. of large files well structured. It supports ToDo items, deadlines and
  3363. time stamps, which magically appear in the diary listing of the Emacs
  3364. calendar. Tables are easily created with a built-in table editor.
  3365. Plain text URL-like links connect to websites, emails (VM), Usenet
  3366. messages (Gnus), BBDB entries, and any files related to the project.
  3367. For printing and sharing of notes, an Org-mode file (or a part of it)
  3368. can be exported as a structured ASCII or HTML file.
  3369. The following commands are available:
  3370. \\{org-mode-map}"
  3371. ;; Get rid of Outline menus, they are not needed
  3372. ;; Need to do this here because define-derived-mode sets up
  3373. ;; the keymap so late. Still, it is a waste to call this each time
  3374. ;; we switch another buffer into org-mode.
  3375. (if (featurep 'xemacs)
  3376. (when (boundp 'outline-mode-menu-heading)
  3377. ;; Assume this is Greg's port, it used easymenu
  3378. (easy-menu-remove outline-mode-menu-heading)
  3379. (easy-menu-remove outline-mode-menu-show)
  3380. (easy-menu-remove outline-mode-menu-hide))
  3381. (define-key org-mode-map [menu-bar headings] 'undefined)
  3382. (define-key org-mode-map [menu-bar hide] 'undefined)
  3383. (define-key org-mode-map [menu-bar show] 'undefined))
  3384. (org-load-modules-maybe)
  3385. (easy-menu-add org-org-menu)
  3386. (easy-menu-add org-tbl-menu)
  3387. (org-install-agenda-files-menu)
  3388. (if org-descriptive-links (org-add-to-invisibility-spec '(org-link)))
  3389. (org-add-to-invisibility-spec '(org-cwidth))
  3390. (when (featurep 'xemacs)
  3391. (org-set-local 'line-move-ignore-invisible t))
  3392. (org-set-local 'outline-regexp org-outline-regexp)
  3393. (org-set-local 'outline-level 'org-outline-level)
  3394. (when (and org-ellipsis
  3395. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  3396. (fboundp 'make-glyph-code))
  3397. (unless org-display-table
  3398. (setq org-display-table (make-display-table)))
  3399. (set-display-table-slot
  3400. org-display-table 4
  3401. (vconcat (mapcar
  3402. (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
  3403. org-ellipsis)))
  3404. (if (stringp org-ellipsis) org-ellipsis "..."))))
  3405. (setq buffer-display-table org-display-table))
  3406. (org-set-regexps-and-options)
  3407. (when (and org-tag-faces (not org-tags-special-faces-re))
  3408. ;; tag faces set outside customize.... force initialization.
  3409. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  3410. ;; Calc embedded
  3411. (org-set-local 'calc-embedded-open-mode "# ")
  3412. (modify-syntax-entry ?# "<")
  3413. (modify-syntax-entry ?@ "w")
  3414. (if org-startup-truncated (setq truncate-lines t))
  3415. (org-set-local 'font-lock-unfontify-region-function
  3416. 'org-unfontify-region)
  3417. ;; Activate before-change-function
  3418. (org-set-local 'org-table-may-need-update t)
  3419. (org-add-hook 'before-change-functions 'org-before-change-function nil
  3420. 'local)
  3421. ;; Check for running clock before killing a buffer
  3422. (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  3423. ;; Paragraphs and auto-filling
  3424. (org-set-autofill-regexps)
  3425. (setq indent-line-function 'org-indent-line-function)
  3426. (org-update-radio-target-regexp)
  3427. ;; Make sure dependence stuff works reliably, even for users who set it
  3428. ;; too late :-(
  3429. (if org-enforce-todo-dependencies
  3430. (add-hook 'org-blocker-hook
  3431. 'org-block-todo-from-children-or-siblings-or-parent)
  3432. (remove-hook 'org-blocker-hook
  3433. 'org-block-todo-from-children-or-siblings-or-parent))
  3434. (if org-enforce-todo-checkbox-dependencies
  3435. (add-hook 'org-blocker-hook
  3436. 'org-block-todo-from-checkboxes)
  3437. (remove-hook 'org-blocker-hook
  3438. 'org-block-todo-from-checkboxes))
  3439. ;; Comment characters
  3440. ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
  3441. (org-set-local 'comment-padding " ")
  3442. ;; Align options lines
  3443. (org-set-local
  3444. 'align-mode-rules-list
  3445. '((org-in-buffer-settings
  3446. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  3447. (modes . '(org-mode)))))
  3448. ;; Imenu
  3449. (org-set-local 'imenu-create-index-function
  3450. 'org-imenu-get-tree)
  3451. ;; Make isearch reveal context
  3452. (if (or (featurep 'xemacs)
  3453. (not (boundp 'outline-isearch-open-invisible-function)))
  3454. ;; Emacs 21 and XEmacs make use of the hook
  3455. (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
  3456. ;; Emacs 22 deals with this through a special variable
  3457. (org-set-local 'outline-isearch-open-invisible-function
  3458. (lambda (&rest ignore) (org-show-context 'isearch))))
  3459. ;; If empty file that did not turn on org-mode automatically, make it to.
  3460. (if (and org-insert-mode-line-in-empty-file
  3461. (interactive-p)
  3462. (= (point-min) (point-max)))
  3463. (insert "# -*- mode: org -*-\n\n"))
  3464. (unless org-inhibit-startup
  3465. (when org-startup-align-all-tables
  3466. (let ((bmp (buffer-modified-p)))
  3467. (org-table-map-tables 'org-table-align)
  3468. (set-buffer-modified-p bmp)))
  3469. (org-set-startup-visibility)))
  3470. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  3471. (defun org-current-time ()
  3472. "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
  3473. (if (> (car org-time-stamp-rounding-minutes) 1)
  3474. (let ((r (car org-time-stamp-rounding-minutes))
  3475. (time (decode-time)))
  3476. (apply 'encode-time
  3477. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  3478. (nthcdr 2 time))))
  3479. (current-time)))
  3480. ;;;; Font-Lock stuff, including the activators
  3481. (defvar org-mouse-map (make-sparse-keymap))
  3482. (org-defkey org-mouse-map
  3483. (if (featurep 'xemacs) [button2] [mouse-2]) 'org-open-at-mouse)
  3484. (org-defkey org-mouse-map
  3485. (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
  3486. (when org-mouse-1-follows-link
  3487. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  3488. (when org-tab-follows-link
  3489. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  3490. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  3491. (require 'font-lock)
  3492. (defconst org-non-link-chars "]\t\n\r<>")
  3493. (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
  3494. "shell" "elisp"))
  3495. (defvar org-link-types-re nil
  3496. "Matches a link that has a url-like prefix like \"http:\"")
  3497. (defvar org-link-re-with-space nil
  3498. "Matches a link with spaces, optional angular brackets around it.")
  3499. (defvar org-link-re-with-space2 nil
  3500. "Matches a link with spaces, optional angular brackets around it.")
  3501. (defvar org-link-re-with-space3 nil
  3502. "Matches a link with spaces, only for internal part in bracket links.")
  3503. (defvar org-angle-link-re nil
  3504. "Matches link with angular brackets, spaces are allowed.")
  3505. (defvar org-plain-link-re nil
  3506. "Matches plain link, without spaces.")
  3507. (defvar org-bracket-link-regexp nil
  3508. "Matches a link in double brackets.")
  3509. (defvar org-bracket-link-analytic-regexp nil
  3510. "Regular expression used to analyze links.
  3511. Here is what the match groups contain after a match:
  3512. 1: http:
  3513. 2: http
  3514. 3: path
  3515. 4: [desc]
  3516. 5: desc")
  3517. (defvar org-bracket-link-analytic-regexp++ nil
  3518. "Like org-bracket-link-analytic-regexp, but include coderef internal type.")
  3519. (defvar org-any-link-re nil
  3520. "Regular expression matching any link.")
  3521. (defun org-make-link-regexps ()
  3522. "Update the link regular expressions.
  3523. This should be called after the variable `org-link-types' has changed."
  3524. (setq org-link-types-re
  3525. (concat
  3526. "\\`\\(" (mapconcat 'identity org-link-types "\\|") "\\):")
  3527. org-link-re-with-space
  3528. (concat
  3529. "<?\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
  3530. "\\([^" org-non-link-chars " ]"
  3531. "[^" org-non-link-chars "]*"
  3532. "[^" org-non-link-chars " ]\\)>?")
  3533. org-link-re-with-space2
  3534. (concat
  3535. "<?\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
  3536. "\\([^" org-non-link-chars " ]"
  3537. "[^\t\n\r]*"
  3538. "[^" org-non-link-chars " ]\\)>?")
  3539. org-link-re-with-space3
  3540. (concat
  3541. "<?\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
  3542. "\\([^" org-non-link-chars " ]"
  3543. "[^\t\n\r]*\\)")
  3544. org-angle-link-re
  3545. (concat
  3546. "<\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
  3547. "\\([^" org-non-link-chars " ]"
  3548. "[^" org-non-link-chars "]*"
  3549. "\\)>")
  3550. org-plain-link-re
  3551. (concat
  3552. "\\<\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
  3553. "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  3554. org-bracket-link-regexp
  3555. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  3556. org-bracket-link-analytic-regexp
  3557. (concat
  3558. "\\[\\["
  3559. "\\(\\(" (mapconcat 'identity org-link-types "\\|") "\\):\\)?"
  3560. "\\([^]]+\\)"
  3561. "\\]"
  3562. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  3563. "\\]")
  3564. org-bracket-link-analytic-regexp++
  3565. (concat
  3566. "\\[\\["
  3567. "\\(\\(" (mapconcat 'identity (cons "coderef" org-link-types) "\\|") "\\):\\)?"
  3568. "\\([^]]+\\)"
  3569. "\\]"
  3570. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  3571. "\\]")
  3572. org-any-link-re
  3573. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  3574. org-angle-link-re "\\)\\|\\("
  3575. org-plain-link-re "\\)")))
  3576. (org-make-link-regexps)
  3577. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^\r\n>]*?\\)>"
  3578. "Regular expression for fast time stamp matching.")
  3579. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^\r\n>]*?\\)[]>]"
  3580. "Regular expression for fast time stamp matching.")
  3581. (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  3582. "Regular expression matching time strings for analysis.
  3583. This one does not require the space after the date, so it can be used
  3584. on a string that terminates immediately after the date.")
  3585. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  3586. "Regular expression matching time strings for analysis.")
  3587. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  3588. "Regular expression matching time stamps, with groups.")
  3589. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  3590. "Regular expression matching time stamps (also [..]), with groups.")
  3591. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  3592. "Regular expression matching a time stamp range.")
  3593. (defconst org-tr-regexp-both
  3594. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  3595. "Regular expression matching a time stamp range.")
  3596. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  3597. org-ts-regexp "\\)?")
  3598. "Regular expression matching a time stamp or time stamp range.")
  3599. (defconst org-tsr-regexp-both (concat org-ts-regexp-both "\\(--?-?"
  3600. org-ts-regexp-both "\\)?")
  3601. "Regular expression matching a time stamp or time stamp range.
  3602. The time stamps may be either active or inactive.")
  3603. (defvar org-emph-face nil)
  3604. (defun org-do-emphasis-faces (limit)
  3605. "Run through the buffer and add overlays to links."
  3606. (let (rtn)
  3607. (while (and (not rtn) (re-search-forward org-emph-re limit t))
  3608. (if (not (= (char-after (match-beginning 3))
  3609. (char-after (match-beginning 4))))
  3610. (progn
  3611. (setq rtn t)
  3612. (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
  3613. 'face
  3614. (nth 1 (assoc (match-string 3)
  3615. org-emphasis-alist)))
  3616. (add-text-properties (match-beginning 2) (match-end 2)
  3617. '(font-lock-multiline t))
  3618. (when org-hide-emphasis-markers
  3619. (add-text-properties (match-end 4) (match-beginning 5)
  3620. '(invisible org-link))
  3621. (add-text-properties (match-beginning 3) (match-end 3)
  3622. '(invisible org-link)))))
  3623. (backward-char 1))
  3624. rtn))
  3625. (defun org-emphasize (&optional char)
  3626. "Insert or change an emphasis, i.e. a font like bold or italic.
  3627. If there is an active region, change that region to a new emphasis.
  3628. If there is no region, just insert the marker characters and position
  3629. the cursor between them.
  3630. CHAR should be either the marker character, or the first character of the
  3631. HTML tag associated with that emphasis. If CHAR is a space, the means
  3632. to remove the emphasis of the selected region.
  3633. If char is not given (for example in an interactive call) it
  3634. will be prompted for."
  3635. (interactive)
  3636. (let ((eal org-emphasis-alist) e det
  3637. (erc org-emphasis-regexp-components)
  3638. (prompt "")
  3639. (string "") beg end move tag c s)
  3640. (if (org-region-active-p)
  3641. (setq beg (region-beginning) end (region-end)
  3642. string (buffer-substring beg end))
  3643. (setq move t))
  3644. (while (setq e (pop eal))
  3645. (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
  3646. c (aref tag 0))
  3647. (push (cons c (string-to-char (car e))) det)
  3648. (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
  3649. (substring tag 1)))))
  3650. (setq det (nreverse det))
  3651. (unless char
  3652. (message "%s" (concat "Emphasis marker or tag:" prompt))
  3653. (setq char (read-char-exclusive)))
  3654. (setq char (or (cdr (assoc char det)) char))
  3655. (if (equal char ?\ )
  3656. (setq s "" move nil)
  3657. (unless (assoc (char-to-string char) org-emphasis-alist)
  3658. (error "No such emphasis marker: \"%c\"" char))
  3659. (setq s (char-to-string char)))
  3660. (while (and (> (length string) 1)
  3661. (equal (substring string 0 1) (substring string -1))
  3662. (assoc (substring string 0 1) org-emphasis-alist))
  3663. (setq string (substring string 1 -1)))
  3664. (setq string (concat s string s))
  3665. (if beg (delete-region beg end))
  3666. (unless (or (bolp)
  3667. (string-match (concat "[" (nth 0 erc) "\n]")
  3668. (char-to-string (char-before (point)))))
  3669. (insert " "))
  3670. (unless (string-match (concat "[" (nth 1 erc) "\n]")
  3671. (char-to-string (char-after (point))))
  3672. (insert " ") (backward-char 1))
  3673. (insert string)
  3674. (and move (backward-char 1))))
  3675. (defconst org-nonsticky-props
  3676. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
  3677. (defsubst org-rear-nonsticky-at (pos)
  3678. (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
  3679. (defun org-activate-plain-links (limit)
  3680. "Run through the buffer and add overlays to links."
  3681. (catch 'exit
  3682. (let (f)
  3683. (while (re-search-forward org-plain-link-re limit t)
  3684. (setq f (get-text-property (match-beginning 0) 'face))
  3685. (if (or (eq f 'org-tag)
  3686. (and (listp f) (memq 'org-tag f)))
  3687. nil
  3688. (add-text-properties (match-beginning 0) (match-end 0)
  3689. (list 'mouse-face 'highlight
  3690. 'keymap org-mouse-map))
  3691. (org-rear-nonsticky-at (match-end 0))
  3692. (throw 'exit t))))))
  3693. (defun org-activate-code (limit)
  3694. (if (re-search-forward "^[ \t]*\\(: .*\n?\\)" limit t)
  3695. (progn
  3696. (remove-text-properties (match-beginning 0) (match-end 0)
  3697. '(display t invisible t intangible t))
  3698. t)))
  3699. (defun org-activate-angle-links (limit)
  3700. "Run through the buffer and add overlays to links."
  3701. (if (re-search-forward org-angle-link-re limit t)
  3702. (progn
  3703. (add-text-properties (match-beginning 0) (match-end 0)
  3704. (list 'mouse-face 'highlight
  3705. 'keymap org-mouse-map))
  3706. (org-rear-nonsticky-at (match-end 0))
  3707. t)))
  3708. (defun org-activate-footnote-links (limit)
  3709. "Run through the buffer and add overlays to links."
  3710. (if (re-search-forward "\\(^\\|[^][]\\)\\(\\[\\([0-9]+\\]\\|fn:[^ \t\r\n:]+?[]:]\\)\\)"
  3711. limit t)
  3712. (progn
  3713. (add-text-properties (match-beginning 2) (match-end 2)
  3714. (list 'mouse-face 'highlight
  3715. 'keymap org-mouse-map
  3716. 'help-echo
  3717. (if (= (point-at-bol) (match-beginning 2))
  3718. "Footnote definition"
  3719. "Footnote reference")
  3720. ))
  3721. (org-rear-nonsticky-at (match-end 2))
  3722. t)))
  3723. (defun org-activate-bracket-links (limit)
  3724. "Run through the buffer and add overlays to bracketed links."
  3725. (if (re-search-forward org-bracket-link-regexp limit t)
  3726. (let* ((help (concat "LINK: "
  3727. (org-match-string-no-properties 1)))
  3728. ;; FIXME: above we should remove the escapes.
  3729. ;; but that requires another match, protecting match data,
  3730. ;; a lot of overhead for font-lock.
  3731. (ip (org-maybe-intangible
  3732. (list 'invisible 'org-link
  3733. 'keymap org-mouse-map 'mouse-face 'highlight
  3734. 'font-lock-multiline t 'help-echo help)))
  3735. (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
  3736. 'font-lock-multiline t 'help-echo help)))
  3737. ;; We need to remove the invisible property here. Table narrowing
  3738. ;; may have made some of this invisible.
  3739. (remove-text-properties (match-beginning 0) (match-end 0)
  3740. '(invisible nil))
  3741. (if (match-end 3)
  3742. (progn
  3743. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  3744. (org-rear-nonsticky-at (match-beginning 3))
  3745. (add-text-properties (match-beginning 3) (match-end 3) vp)
  3746. (org-rear-nonsticky-at (match-end 3))
  3747. (add-text-properties (match-end 3) (match-end 0) ip)
  3748. (org-rear-nonsticky-at (match-end 0)))
  3749. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  3750. (org-rear-nonsticky-at (match-beginning 1))
  3751. (add-text-properties (match-beginning 1) (match-end 1) vp)
  3752. (org-rear-nonsticky-at (match-end 1))
  3753. (add-text-properties (match-end 1) (match-end 0) ip)
  3754. (org-rear-nonsticky-at (match-end 0)))
  3755. t)))
  3756. (defun org-activate-dates (limit)
  3757. "Run through the buffer and add overlays to dates."
  3758. (if (re-search-forward org-tsr-regexp-both limit t)
  3759. (progn
  3760. (add-text-properties (match-beginning 0) (match-end 0)
  3761. (list 'mouse-face 'highlight
  3762. 'keymap org-mouse-map))
  3763. (org-rear-nonsticky-at (match-end 0))
  3764. (when org-display-custom-times
  3765. (if (match-end 3)
  3766. (org-display-custom-time (match-beginning 3) (match-end 3)))
  3767. (org-display-custom-time (match-beginning 1) (match-end 1)))
  3768. t)))
  3769. (defvar org-target-link-regexp nil
  3770. "Regular expression matching radio targets in plain text.")
  3771. (make-variable-buffer-local 'org-target-link-regexp)
  3772. (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
  3773. "Regular expression matching a link target.")
  3774. (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
  3775. "Regular expression matching a radio target.")
  3776. (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
  3777. "Regular expression matching any target.")
  3778. (defun org-activate-target-links (limit)
  3779. "Run through the buffer and add overlays to target matches."
  3780. (when org-target-link-regexp
  3781. (let ((case-fold-search t))
  3782. (if (re-search-forward org-target-link-regexp limit t)
  3783. (progn
  3784. (add-text-properties (match-beginning 0) (match-end 0)
  3785. (list 'mouse-face 'highlight
  3786. 'keymap org-mouse-map
  3787. 'help-echo "Radio target link"
  3788. 'org-linked-text t))
  3789. (org-rear-nonsticky-at (match-end 0))
  3790. t)))))
  3791. (defun org-update-radio-target-regexp ()
  3792. "Find all radio targets in this file and update the regular expression."
  3793. (interactive)
  3794. (when (memq 'radio org-activate-links)
  3795. (setq org-target-link-regexp
  3796. (org-make-target-link-regexp (org-all-targets 'radio)))
  3797. (org-restart-font-lock)))
  3798. (defun org-hide-wide-columns (limit)
  3799. (let (s e)
  3800. (setq s (text-property-any (point) (or limit (point-max))
  3801. 'org-cwidth t))
  3802. (when s
  3803. (setq e (next-single-property-change s 'org-cwidth))
  3804. (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
  3805. (goto-char e)
  3806. t)))
  3807. (defvar org-latex-and-specials-regexp nil
  3808. "Regular expression for highlighting export special stuff.")
  3809. (defvar org-match-substring-regexp)
  3810. (defvar org-match-substring-with-braces-regexp)
  3811. (defvar org-export-html-special-string-regexps)
  3812. (defun org-compute-latex-and-specials-regexp ()
  3813. "Compute regular expression for stuff treated specially by exporters."
  3814. (if (not org-highlight-latex-fragments-and-specials)
  3815. (org-set-local 'org-latex-and-specials-regexp nil)
  3816. (require 'org-exp)
  3817. (let*
  3818. ((matchers (plist-get org-format-latex-options :matchers))
  3819. (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
  3820. org-latex-regexps)))
  3821. (options (org-combine-plists (org-default-export-plist)
  3822. (org-infile-export-plist)))
  3823. (org-export-with-sub-superscripts (plist-get options :sub-superscript))
  3824. (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
  3825. (org-export-with-TeX-macros (plist-get options :TeX-macros))
  3826. (org-export-html-expand (plist-get options :expand-quoted-html))
  3827. (org-export-with-special-strings (plist-get options :special-strings))
  3828. (re-sub
  3829. (cond
  3830. ((equal org-export-with-sub-superscripts '{})
  3831. (list org-match-substring-with-braces-regexp))
  3832. (org-export-with-sub-superscripts
  3833. (list org-match-substring-regexp))
  3834. (t nil)))
  3835. (re-latex
  3836. (if org-export-with-LaTeX-fragments
  3837. (mapcar (lambda (x) (nth 1 x)) latexs)))
  3838. (re-macros
  3839. (if org-export-with-TeX-macros
  3840. (list (concat "\\\\"
  3841. (regexp-opt
  3842. (append (mapcar 'car org-html-entities)
  3843. (if (boundp 'org-latex-entities)
  3844. org-latex-entities nil))
  3845. 'words))) ; FIXME
  3846. ))
  3847. ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
  3848. (re-special (if org-export-with-special-strings
  3849. (mapcar (lambda (x) (car x))
  3850. org-export-html-special-string-regexps)))
  3851. (re-rest
  3852. (delq nil
  3853. (list
  3854. (if org-export-html-expand "@<[^>\n]+>")
  3855. ))))
  3856. (org-set-local
  3857. 'org-latex-and-specials-regexp
  3858. (mapconcat 'identity (append re-latex re-sub re-macros re-special
  3859. re-rest) "\\|")))))
  3860. (defun org-do-latex-and-special-faces (limit)
  3861. "Run through the buffer and add overlays to links."
  3862. (when org-latex-and-specials-regexp
  3863. (let (rtn d)
  3864. (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
  3865. limit t))
  3866. (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
  3867. 'face))
  3868. '(org-code org-verbatim underline)))
  3869. (progn
  3870. (setq rtn t
  3871. d (cond ((member (char-after (1+ (match-beginning 0)))
  3872. '(?_ ?^)) 1)
  3873. (t 0)))
  3874. (font-lock-prepend-text-property
  3875. (+ d (match-beginning 0)) (match-end 0)
  3876. 'face 'org-latex-and-export-specials)
  3877. (add-text-properties (+ d (match-beginning 0)) (match-end 0)
  3878. '(font-lock-multiline t)))))
  3879. rtn)))
  3880. (defun org-restart-font-lock ()
  3881. "Restart font-lock-mode, to force refontification."
  3882. (when (and (boundp 'font-lock-mode) font-lock-mode)
  3883. (font-lock-mode -1)
  3884. (font-lock-mode 1)))
  3885. (defun org-all-targets (&optional radio)
  3886. "Return a list of all targets in this file.
  3887. With optional argument RADIO, only find radio targets."
  3888. (let ((re (if radio org-radio-target-regexp org-target-regexp))
  3889. rtn)
  3890. (save-excursion
  3891. (goto-char (point-min))
  3892. (while (re-search-forward re nil t)
  3893. (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
  3894. rtn)))
  3895. (defun org-make-target-link-regexp (targets)
  3896. "Make regular expression matching all strings in TARGETS.
  3897. The regular expression finds the targets also if there is a line break
  3898. between words."
  3899. (and targets
  3900. (concat
  3901. "\\<\\("
  3902. (mapconcat
  3903. (lambda (x)
  3904. (while (string-match " +" x)
  3905. (setq x (replace-match "\\s-+" t t x)))
  3906. x)
  3907. targets
  3908. "\\|")
  3909. "\\)\\>")))
  3910. (defun org-activate-tags (limit)
  3911. (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \r\n]") limit t)
  3912. (progn
  3913. (add-text-properties (match-beginning 1) (match-end 1)
  3914. (list 'mouse-face 'highlight
  3915. 'keymap org-mouse-map))
  3916. (org-rear-nonsticky-at (match-end 1))
  3917. t)))
  3918. (defun org-outline-level ()
  3919. (save-excursion
  3920. (looking-at outline-regexp)
  3921. (if (match-beginning 1)
  3922. (+ (org-get-string-indentation (match-string 1)) 1000)
  3923. (1- (- (match-end 0) (match-beginning 0))))))
  3924. (defvar org-font-lock-keywords nil)
  3925. (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
  3926. "Regular expression matching a property line.")
  3927. (defvar org-font-lock-hook nil
  3928. "Functions to be called for special font lock stuff.")
  3929. (defun org-font-lock-hook (limit)
  3930. (run-hook-with-args 'org-font-lock-hook limit))
  3931. (defun org-set-font-lock-defaults ()
  3932. (let* ((em org-fontify-emphasized-text)
  3933. (lk org-activate-links)
  3934. (org-font-lock-extra-keywords
  3935. (list
  3936. ;; Call the hook
  3937. '(org-font-lock-hook)
  3938. ;; Headlines
  3939. '("^\\(\\**\\)\\(\\* \\)\\(.*\\)" (1 (org-get-level-face 1))
  3940. (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
  3941. ;; Table lines
  3942. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  3943. (1 'org-table t))
  3944. ;; Table internals
  3945. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  3946. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  3947. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  3948. ;; Drawers
  3949. (list org-drawer-regexp '(0 'org-special-keyword t))
  3950. (list "^[ \t]*:END:" '(0 'org-special-keyword t))
  3951. ;; Properties
  3952. (list org-property-re
  3953. '(1 'org-special-keyword t)
  3954. '(3 'org-property-value t))
  3955. (if org-format-transports-properties-p
  3956. '("| *\\(<[0-9]+>\\) *" (1 'org-formula t)))
  3957. ;; Links
  3958. (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  3959. (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  3960. (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
  3961. (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
  3962. (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
  3963. (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  3964. (if (memq 'footnote lk) '(org-activate-footnote-links
  3965. (2 'org-footnote t)))
  3966. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  3967. '(org-hide-wide-columns (0 nil append))
  3968. ;; TODO lines
  3969. (list (concat "^\\*+[ \t]+" org-todo-regexp "\\([ \t]\\|$\\)")
  3970. '(1 (org-get-todo-face 1) t))
  3971. ;; DONE
  3972. (if org-fontify-done-headline
  3973. (list (concat "^[*]+ +\\<\\("
  3974. (mapconcat 'regexp-quote org-done-keywords "\\|")
  3975. "\\)\\(.*\\)")
  3976. '(2 'org-headline-done t))
  3977. nil)
  3978. ;; Priorities
  3979. '(org-font-lock-add-priority-faces)
  3980. ;; Tags
  3981. '(org-font-lock-add-tag-faces)
  3982. ;; Special keywords
  3983. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  3984. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  3985. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  3986. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  3987. ;; Emphasis
  3988. (if em
  3989. (if (featurep 'xemacs)
  3990. '(org-do-emphasis-faces (0 nil append))
  3991. '(org-do-emphasis-faces)))
  3992. ;; Checkboxes
  3993. '("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(\\[[- X]\\]\\)"
  3994. 2 'org-checkbox prepend)
  3995. (if org-provide-checkbox-statistics
  3996. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  3997. (0 (org-get-checkbox-statistics-face) t)))
  3998. ;; Description list items
  3999. '("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(.*? ::\\)"
  4000. 2 'bold prepend)
  4001. (list (concat "^\\*+ \\(.*:" org-archive-tag ":.*\\)")
  4002. '(1 'org-archived prepend))
  4003. ;; Specials
  4004. '(org-do-latex-and-special-faces)
  4005. ;; Code
  4006. '(org-activate-code (1 'org-code t))
  4007. ;; COMMENT
  4008. (list (concat "^\\*+[ \t]+\\<\\(" org-comment-string
  4009. "\\|" org-quote-string "\\)\\>")
  4010. '(1 'org-special-keyword t))
  4011. '("^#.*" (0 'font-lock-comment-face t))
  4012. )))
  4013. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  4014. ;; Now set the full font-lock-keywords
  4015. (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
  4016. (org-set-local 'font-lock-defaults
  4017. '(org-font-lock-keywords t nil nil backward-paragraph))
  4018. (kill-local-variable 'font-lock-keywords) nil))
  4019. (defun org-fontify-like-in-org-mode (s &optional odd-levels)
  4020. "Fontify string S like in Org-mode"
  4021. (with-temp-buffer
  4022. (insert s)
  4023. (let ((org-odd-levels-only odd-levels))
  4024. (org-mode)
  4025. (font-lock-fontify-buffer)
  4026. (buffer-string))))
  4027. (defvar org-m nil)
  4028. (defvar org-l nil)
  4029. (defvar org-f nil)
  4030. (defun org-get-level-face (n)
  4031. "Get the right face for match N in font-lock matching of headlines."
  4032. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  4033. (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  4034. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  4035. (cond
  4036. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  4037. ((eq n 2) org-f)
  4038. (t (if org-level-color-stars-only nil org-f))))
  4039. (defun org-get-todo-face (kwd)
  4040. "Get the right face for a TODO keyword KWD.
  4041. If KWD is a number, get the corresponding match group."
  4042. (if (numberp kwd) (setq kwd (match-string kwd)))
  4043. (or (cdr (assoc kwd org-todo-keyword-faces))
  4044. (and (member kwd org-done-keywords) 'org-done)
  4045. 'org-todo))
  4046. (defun org-font-lock-add-tag-faces (limit)
  4047. "Add the special tag faces."
  4048. (when (and org-tag-faces org-tags-special-faces-re)
  4049. (while (re-search-forward org-tags-special-faces-re limit t)
  4050. (add-text-properties (match-beginning 1) (match-end 1)
  4051. (list 'face (org-get-tag-face 1)
  4052. 'font-lock-fontified t))
  4053. (backward-char 1))))
  4054. (defun org-font-lock-add-priority-faces (limit)
  4055. "Add the special priority faces."
  4056. (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
  4057. (add-text-properties
  4058. (match-beginning 0) (match-end 0)
  4059. (list 'face (or (cdr (assoc (char-after (match-beginning 1))
  4060. org-priority-faces))
  4061. 'org-special-keyword)
  4062. 'font-lock-fontified t))))
  4063. (defun org-get-tag-face (kwd)
  4064. "Get the right face for a TODO keyword KWD.
  4065. If KWD is a number, get the corresponding match group."
  4066. (if (numberp kwd) (setq kwd (match-string kwd)))
  4067. (or (cdr (assoc kwd org-tag-faces))
  4068. 'org-tag))
  4069. (defun org-unfontify-region (beg end &optional maybe_loudly)
  4070. "Remove fontification and activation overlays from links."
  4071. (font-lock-default-unfontify-region beg end)
  4072. (let* ((buffer-undo-list t)
  4073. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  4074. (inhibit-modification-hooks t)
  4075. deactivate-mark buffer-file-name buffer-file-truename)
  4076. (remove-text-properties beg end
  4077. '(mouse-face t keymap t org-linked-text t
  4078. invisible t intangible t))))
  4079. ;;;; Visibility cycling, including org-goto and indirect buffer
  4080. ;;; Cycling
  4081. (defvar org-cycle-global-status nil)
  4082. (make-variable-buffer-local 'org-cycle-global-status)
  4083. (defvar org-cycle-subtree-status nil)
  4084. (make-variable-buffer-local 'org-cycle-subtree-status)
  4085. ;;;###autoload
  4086. (defvar org-inlinetask-min-level)
  4087. (defun org-cycle (&optional arg)
  4088. "TAB-action and visibility cycling for Org-mode.
  4089. This is the command invoked in Org-moe by the TAB key. It's main purpose
  4090. is outine visibility cycling, but it also invokes other actions
  4091. in special contexts.
  4092. - When this function is called with a prefix argument, rotate the entire
  4093. buffer through 3 states (global cycling)
  4094. 1. OVERVIEW: Show only top-level headlines.
  4095. 2. CONTENTS: Show all headlines of all levels, but no body text.
  4096. 3. SHOW ALL: Show everything.
  4097. When called with two `C-u C-u' prefixes, switch to the startup visibility,
  4098. determined by the variable `org-startup-folded', and by any VISIBILITY
  4099. properties in the buffer.
  4100. When called with three `C-u C-u C-u' prefixed, show the entire buffer,
  4101. including any drawers.
  4102. - When inside a table, re-align the table and move to the next field.
  4103. - When point is at the beginning of a headline, rotate the subtree started
  4104. by this line through 3 different states (local cycling)
  4105. 1. FOLDED: Only the main headline is shown.
  4106. 2. CHILDREN: The main headline and the direct children are shown.
  4107. From this state, you can move to one of the children
  4108. and zoom in further.
  4109. 3. SUBTREE: Show the entire subtree, including body text.
  4110. - When there is a numeric prefix, go up to a heading with level ARG, do
  4111. a `show-subtree' and return to the previous cursor position. If ARG
  4112. is negative, go up that many levels.
  4113. - When point is not at the beginning of a headline, execute the global
  4114. binding for TAB, which is re-indenting the line. See the option
  4115. `org-cycle-emulate-tab' for details.
  4116. - Special case: if point is at the beginning of the buffer and there is
  4117. no headline in line 1, this function will act as if called with prefix arg.
  4118. But only if also the variable `org-cycle-global-at-bob' is t."
  4119. (interactive "P")
  4120. (org-load-modules-maybe)
  4121. (unless (run-hook-with-args-until-success 'org-tab-first-hook)
  4122. (let* ((limit-level
  4123. (or org-cycle-max-level
  4124. (and (boundp 'org-inlinetask-min-level)
  4125. org-inlinetask-min-level
  4126. (1- org-inlinetask-min-level))))
  4127. (nstars (and limit-level
  4128. (if org-odd-levels-only
  4129. (and limit-level (1- (* limit-level 2)))
  4130. limit-level)))
  4131. (outline-regexp
  4132. (cond
  4133. ((not (org-mode-p)) outline-regexp)
  4134. (org-cycle-include-plain-lists
  4135. (concat "\\(?:\\*"
  4136. (if nstars (format "\\{1,%d\\}" nstars) "+")
  4137. " \\|\\([ \t]*\\)\\([-+*]\\|[0-9]+[.)]\\) \\)"))
  4138. (t (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ ")))))
  4139. (bob-special (and org-cycle-global-at-bob (bobp)
  4140. (not (looking-at outline-regexp))))
  4141. (org-cycle-hook
  4142. (if bob-special
  4143. (delq 'org-optimize-window-after-visibility-change
  4144. (copy-sequence org-cycle-hook))
  4145. org-cycle-hook))
  4146. (pos (point)))
  4147. (if (or bob-special (equal arg '(4)))
  4148. ;; special case: use global cycling
  4149. (setq arg t))
  4150. (cond
  4151. ((equal arg '(16))
  4152. (org-set-startup-visibility)
  4153. (message "Startup visibility, plus VISIBILITY properties"))
  4154. ((equal arg '(64))
  4155. (show-all)
  4156. (message "Entire buffer visible, including drawers"))
  4157. ((org-at-table-p 'any)
  4158. ;; Enter the table or move to the next field in the table
  4159. (or (org-table-recognize-table.el)
  4160. (progn
  4161. (if arg (org-table-edit-field t)
  4162. (org-table-justify-field-maybe)
  4163. (call-interactively 'org-table-next-field)))))
  4164. ((run-hook-with-args-until-success
  4165. 'org-tab-after-check-for-table-hook))
  4166. ((eq arg t) ;; Global cycling
  4167. (org-cycle-internal-global))
  4168. ((and org-drawers org-drawer-regexp
  4169. (save-excursion
  4170. (beginning-of-line 1)
  4171. (looking-at org-drawer-regexp)))
  4172. ;; Toggle block visibility
  4173. (org-flag-drawer
  4174. (not (get-char-property (match-end 0) 'invisible))))
  4175. ((integerp arg)
  4176. ;; Show-subtree, ARG levels up from here.
  4177. (save-excursion
  4178. (org-back-to-heading)
  4179. (outline-up-heading (if (< arg 0) (- arg)
  4180. (- (funcall outline-level) arg)))
  4181. (org-show-subtree)))
  4182. ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
  4183. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  4184. (org-cycle-internal-local))
  4185. ;; TAB emulation and template completion
  4186. (buffer-read-only (org-back-to-heading))
  4187. ((run-hook-with-args-until-success
  4188. 'org-tab-after-check-for-cycling-hook))
  4189. ((org-try-structure-completion))
  4190. ((org-try-cdlatex-tab))
  4191. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  4192. (or (not (bolp))
  4193. (not (looking-at outline-regexp))))
  4194. (call-interactively (global-key-binding "\t")))
  4195. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  4196. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  4197. (or (and (eq org-cycle-emulate-tab 'white)
  4198. (= (match-end 0) (point-at-eol)))
  4199. (and (eq org-cycle-emulate-tab 'whitestart)
  4200. (>= (match-end 0) pos))))
  4201. t
  4202. (eq org-cycle-emulate-tab t))
  4203. (call-interactively (global-key-binding "\t")))
  4204. (t (save-excursion
  4205. (org-back-to-heading)
  4206. (org-cycle)))))))
  4207. (defun org-cycle-internal-global ()
  4208. "Do the global cycling action."
  4209. (cond
  4210. ((and (eq last-command this-command)
  4211. (eq org-cycle-global-status 'overview))
  4212. ;; We just created the overview - now do table of contents
  4213. ;; This can be slow in very large buffers, so indicate action
  4214. (run-hook-with-args 'org-pre-cycle-hook 'contents)
  4215. (message "CONTENTS...")
  4216. (org-content)
  4217. (message "CONTENTS...done")
  4218. (setq org-cycle-global-status 'contents)
  4219. (run-hook-with-args 'org-cycle-hook 'contents))
  4220. ((and (eq last-command this-command)
  4221. (eq org-cycle-global-status 'contents))
  4222. ;; We just showed the table of contents - now show everything
  4223. (run-hook-with-args 'org-pre-cycle-hook 'all)
  4224. (show-all)
  4225. (message "SHOW ALL")
  4226. (setq org-cycle-global-status 'all)
  4227. (run-hook-with-args 'org-cycle-hook 'all))
  4228. (t
  4229. ;; Default action: go to overview
  4230. (run-hook-with-args 'org-pre-cycle-hook 'overview)
  4231. (org-overview)
  4232. (message "OVERVIEW")
  4233. (setq org-cycle-global-status 'overview)
  4234. (run-hook-with-args 'org-cycle-hook 'overview))))
  4235. (defun org-cycle-internal-local ()
  4236. "Do the local cycling action."
  4237. (org-back-to-heading)
  4238. (let ((goal-column 0) eoh eol eos)
  4239. ;; First, some boundaries
  4240. (save-excursion
  4241. (org-back-to-heading)
  4242. (save-excursion
  4243. (beginning-of-line 2)
  4244. (while (and (not (eobp)) ;; this is like `next-line'
  4245. (get-char-property (1- (point)) 'invisible))
  4246. (beginning-of-line 2)) (setq eol (point)))
  4247. (outline-end-of-heading) (setq eoh (point))
  4248. (org-end-of-subtree t)
  4249. (unless (eobp)
  4250. (skip-chars-forward " \t\n")
  4251. (beginning-of-line 1) ; in case this is an item
  4252. )
  4253. (setq eos (1- (point))))
  4254. ;; Find out what to do next and set `this-command'
  4255. (cond
  4256. ((= eos eoh)
  4257. ;; Nothing is hidden behind this heading
  4258. (run-hook-with-args 'org-pre-cycle-hook 'empty)
  4259. (message "EMPTY ENTRY")
  4260. (setq org-cycle-subtree-status nil)
  4261. (save-excursion
  4262. (goto-char eos)
  4263. (outline-next-heading)
  4264. (if (org-invisible-p) (org-flag-heading nil))))
  4265. ((or (>= eol eos)
  4266. (not (string-match "\\S-" (buffer-substring eol eos))))
  4267. ;; Entire subtree is hidden in one line: open it
  4268. (run-hook-with-args 'org-pre-cycle-hook 'children)
  4269. (org-show-entry)
  4270. (show-children)
  4271. (message "CHILDREN")
  4272. (save-excursion
  4273. (goto-char eos)
  4274. (outline-next-heading)
  4275. (if (org-invisible-p) (org-flag-heading nil)))
  4276. (setq org-cycle-subtree-status 'children)
  4277. (run-hook-with-args 'org-cycle-hook 'children))
  4278. ((and (eq last-command this-command)
  4279. (eq org-cycle-subtree-status 'children))
  4280. ;; We just showed the children, now show everything.
  4281. (run-hook-with-args 'org-pre-cycle-hook 'subtree)
  4282. (org-show-subtree)
  4283. (message "SUBTREE")
  4284. (setq org-cycle-subtree-status 'subtree)
  4285. (run-hook-with-args 'org-cycle-hook 'subtree))
  4286. (t
  4287. ;; Default action: hide the subtree.
  4288. (run-hook-with-args 'org-pre-cycle-hook 'folded)
  4289. (hide-subtree)
  4290. (message "FOLDED")
  4291. (setq org-cycle-subtree-status 'folded)
  4292. (run-hook-with-args 'org-cycle-hook 'folded)))))
  4293. ;;;###autoload
  4294. (defun org-global-cycle (&optional arg)
  4295. "Cycle the global visibility. For details see `org-cycle'.
  4296. With C-u prefix arg, switch to startup visibility.
  4297. With a numeric prefix, show all headlines up to that level."
  4298. (interactive "P")
  4299. (let ((org-cycle-include-plain-lists
  4300. (if (org-mode-p) org-cycle-include-plain-lists nil)))
  4301. (cond
  4302. ((integerp arg)
  4303. (show-all)
  4304. (hide-sublevels arg)
  4305. (setq org-cycle-global-status 'contents))
  4306. ((equal arg '(4))
  4307. (org-set-startup-visibility)
  4308. (message "Startup visibility, plus VISIBILITY properties."))
  4309. (t
  4310. (org-cycle '(4))))))
  4311. (defun org-set-startup-visibility ()
  4312. "Set the visibility required by startup options and properties."
  4313. (cond
  4314. ((eq org-startup-folded t)
  4315. (org-cycle '(4)))
  4316. ((eq org-startup-folded 'content)
  4317. (let ((this-command 'org-cycle) (last-command 'org-cycle))
  4318. (org-cycle '(4)) (org-cycle '(4)))))
  4319. (org-set-visibility-according-to-property 'no-cleanup)
  4320. (org-cycle-hide-archived-subtrees 'all)
  4321. (org-cycle-hide-drawers 'all)
  4322. (org-cycle-show-empty-lines 'all))
  4323. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  4324. "Switch subtree visibilities according to :VISIBILITY: property."
  4325. (interactive)
  4326. (let (org-show-entry-below state)
  4327. (save-excursion
  4328. (goto-char (point-min))
  4329. (while (re-search-forward
  4330. "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
  4331. nil t)
  4332. (setq state (match-string 1))
  4333. (save-excursion
  4334. (org-back-to-heading t)
  4335. (hide-subtree)
  4336. (org-reveal)
  4337. (cond
  4338. ((equal state '("fold" "folded"))
  4339. (hide-subtree))
  4340. ((equal state "children")
  4341. (org-show-hidden-entry)
  4342. (show-children))
  4343. ((equal state "content")
  4344. (save-excursion
  4345. (save-restriction
  4346. (org-narrow-to-subtree)
  4347. (org-content))))
  4348. ((member state '("all" "showall"))
  4349. (show-subtree)))))
  4350. (unless no-cleanup
  4351. (org-cycle-hide-archived-subtrees 'all)
  4352. (org-cycle-hide-drawers 'all)
  4353. (org-cycle-show-empty-lines 'all)))))
  4354. (defun org-overview ()
  4355. "Switch to overview mode, showing only top-level headlines.
  4356. Really, this shows all headlines with level equal or greater than the level
  4357. of the first headline in the buffer. This is important, because if the
  4358. first headline is not level one, then (hide-sublevels 1) gives confusing
  4359. results."
  4360. (interactive)
  4361. (let ((level (save-excursion
  4362. (goto-char (point-min))
  4363. (if (re-search-forward (concat "^" outline-regexp) nil t)
  4364. (progn
  4365. (goto-char (match-beginning 0))
  4366. (funcall outline-level))))))
  4367. (and level (hide-sublevels level))))
  4368. (defun org-content (&optional arg)
  4369. "Show all headlines in the buffer, like a table of contents.
  4370. With numerical argument N, show content up to level N."
  4371. (interactive "P")
  4372. (save-excursion
  4373. ;; Visit all headings and show their offspring
  4374. (and (integerp arg) (org-overview))
  4375. (goto-char (point-max))
  4376. (catch 'exit
  4377. (while (and (progn (condition-case nil
  4378. (outline-previous-visible-heading 1)
  4379. (error (goto-char (point-min))))
  4380. t)
  4381. (looking-at outline-regexp))
  4382. (if (integerp arg)
  4383. (show-children (1- arg))
  4384. (show-branches))
  4385. (if (bobp) (throw 'exit nil))))))
  4386. (defun org-optimize-window-after-visibility-change (state)
  4387. "Adjust the window after a change in outline visibility.
  4388. This function is the default value of the hook `org-cycle-hook'."
  4389. (when (get-buffer-window (current-buffer))
  4390. (cond
  4391. ((eq state 'content) nil)
  4392. ((eq state 'all) nil)
  4393. ((eq state 'folded) nil)
  4394. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  4395. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  4396. (defun org-compact-display-after-subtree-move ()
  4397. "Show a compacter version of the tree of the entry's parent."
  4398. (save-excursion
  4399. (if (org-up-heading-safe)
  4400. (progn
  4401. (hide-subtree)
  4402. (show-entry)
  4403. (show-children)
  4404. (org-cycle-show-empty-lines 'children)
  4405. (org-cycle-hide-drawers 'children))
  4406. (org-overview))))
  4407. (defun org-cycle-show-empty-lines (state)
  4408. "Show empty lines above all visible headlines.
  4409. The region to be covered depends on STATE when called through
  4410. `org-cycle-hook'. Lisp program can use t for STATE to get the
  4411. entire buffer covered. Note that an empty line is only shown if there
  4412. are at least `org-cycle-separator-lines' empty lines before the headline."
  4413. (when (> org-cycle-separator-lines 0)
  4414. (save-excursion
  4415. (let* ((n org-cycle-separator-lines)
  4416. (re (cond
  4417. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  4418. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  4419. (t (let ((ns (number-to-string (- n 2))))
  4420. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  4421. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  4422. beg end)
  4423. (cond
  4424. ((memq state '(overview contents t))
  4425. (setq beg (point-min) end (point-max)))
  4426. ((memq state '(children folded))
  4427. (setq beg (point) end (progn (org-end-of-subtree t t)
  4428. (beginning-of-line 2)
  4429. (point)))))
  4430. (when beg
  4431. (goto-char beg)
  4432. (while (re-search-forward re end t)
  4433. (if (not (get-char-property (match-end 1) 'invisible))
  4434. (outline-flag-region
  4435. (match-beginning 1) (match-end 1) nil)))))))
  4436. ;; Never hide empty lines at the end of the file.
  4437. (save-excursion
  4438. (goto-char (point-max))
  4439. (outline-previous-heading)
  4440. (outline-end-of-heading)
  4441. (if (and (looking-at "[ \t\n]+")
  4442. (= (match-end 0) (point-max)))
  4443. (outline-flag-region (point) (match-end 0) nil))))
  4444. (defun org-show-empty-lines-in-parent ()
  4445. "Move to the parent and re-show empty lines before visible headlines."
  4446. (save-excursion
  4447. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  4448. (org-cycle-show-empty-lines context))))
  4449. (defun org-cycle-hide-drawers (state)
  4450. "Re-hide all drawers after a visibility state change."
  4451. (when (and (org-mode-p)
  4452. (not (memq state '(overview folded))))
  4453. (save-excursion
  4454. (let* ((globalp (memq state '(contents all)))
  4455. (beg (if globalp (point-min) (point)))
  4456. (end (if globalp (point-max) (org-end-of-subtree t))))
  4457. (goto-char beg)
  4458. (while (re-search-forward org-drawer-regexp end t)
  4459. (org-flag-drawer t))))))
  4460. (defun org-flag-drawer (flag)
  4461. (save-excursion
  4462. (beginning-of-line 1)
  4463. (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
  4464. (let ((b (match-end 0))
  4465. (outline-regexp org-outline-regexp))
  4466. (if (re-search-forward
  4467. "^[ \t]*:END:"
  4468. (save-excursion (outline-next-heading) (point)) t)
  4469. (outline-flag-region b (point-at-eol) flag)
  4470. (error ":END: line missing"))))))
  4471. (defun org-subtree-end-visible-p ()
  4472. "Is the end of the current subtree visible?"
  4473. (pos-visible-in-window-p
  4474. (save-excursion (org-end-of-subtree t) (point))))
  4475. (defun org-first-headline-recenter (&optional N)
  4476. "Move cursor to the first headline and recenter the headline.
  4477. Optional argument N means, put the headline into the Nth line of the window."
  4478. (goto-char (point-min))
  4479. (when (re-search-forward (concat "^\\(" outline-regexp "\\)") nil t)
  4480. (beginning-of-line)
  4481. (recenter (prefix-numeric-value N))))
  4482. ;;; Org-goto
  4483. (defvar org-goto-window-configuration nil)
  4484. (defvar org-goto-marker nil)
  4485. (defvar org-goto-map
  4486. (let ((map (make-sparse-keymap)))
  4487. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
  4488. (while (setq cmd (pop cmds))
  4489. (substitute-key-definition cmd cmd map global-map)))
  4490. (suppress-keymap map)
  4491. (org-defkey map "\C-m" 'org-goto-ret)
  4492. (org-defkey map [(return)] 'org-goto-ret)
  4493. (org-defkey map [(left)] 'org-goto-left)
  4494. (org-defkey map [(right)] 'org-goto-right)
  4495. (org-defkey map [(control ?g)] 'org-goto-quit)
  4496. (org-defkey map "\C-i" 'org-cycle)
  4497. (org-defkey map [(tab)] 'org-cycle)
  4498. (org-defkey map [(down)] 'outline-next-visible-heading)
  4499. (org-defkey map [(up)] 'outline-previous-visible-heading)
  4500. (if org-goto-auto-isearch
  4501. (if (fboundp 'define-key-after)
  4502. (define-key-after map [t] 'org-goto-local-auto-isearch)
  4503. nil)
  4504. (org-defkey map "q" 'org-goto-quit)
  4505. (org-defkey map "n" 'outline-next-visible-heading)
  4506. (org-defkey map "p" 'outline-previous-visible-heading)
  4507. (org-defkey map "f" 'outline-forward-same-level)
  4508. (org-defkey map "b" 'outline-backward-same-level)
  4509. (org-defkey map "u" 'outline-up-heading))
  4510. (org-defkey map "/" 'org-occur)
  4511. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  4512. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  4513. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  4514. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  4515. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  4516. map))
  4517. (defconst org-goto-help
  4518. "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
  4519. RET=jump to location [Q]uit and return to previous location
  4520. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  4521. (defvar org-goto-start-pos) ; dynamically scoped parameter
  4522. ;; FIXME: Docstring doe not mention both interfaces
  4523. (defun org-goto (&optional alternative-interface)
  4524. "Look up a different location in the current file, keeping current visibility.
  4525. When you want look-up or go to a different location in a document, the
  4526. fastest way is often to fold the entire buffer and then dive into the tree.
  4527. This method has the disadvantage, that the previous location will be folded,
  4528. which may not be what you want.
  4529. This command works around this by showing a copy of the current buffer
  4530. in an indirect buffer, in overview mode. You can dive into the tree in
  4531. that copy, use org-occur and incremental search to find a location.
  4532. When pressing RET or `Q', the command returns to the original buffer in
  4533. which the visibility is still unchanged. After RET is will also jump to
  4534. the location selected in the indirect buffer and expose the
  4535. the headline hierarchy above."
  4536. (interactive "P")
  4537. (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
  4538. (org-refile-use-outline-path t)
  4539. (org-refile-target-verify-function nil)
  4540. (interface
  4541. (if (not alternative-interface)
  4542. org-goto-interface
  4543. (if (eq org-goto-interface 'outline)
  4544. 'outline-path-completion
  4545. 'outline)))
  4546. (org-goto-start-pos (point))
  4547. (selected-point
  4548. (if (eq interface 'outline)
  4549. (car (org-get-location (current-buffer) org-goto-help))
  4550. (nth 3 (org-refile-get-location "Goto: ")))))
  4551. (if selected-point
  4552. (progn
  4553. (org-mark-ring-push org-goto-start-pos)
  4554. (goto-char selected-point)
  4555. (if (or (org-invisible-p) (org-invisible-p2))
  4556. (org-show-context 'org-goto)))
  4557. (message "Quit"))))
  4558. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  4559. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  4560. (defvar org-goto-local-auto-isearch-map) ; defined below
  4561. (defun org-get-location (buf help)
  4562. "Let the user select a location in the Org-mode buffer BUF.
  4563. This function uses a recursive edit. It returns the selected position
  4564. or nil."
  4565. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  4566. (isearch-hide-immediately nil)
  4567. (isearch-search-fun-function
  4568. (lambda () 'org-goto-local-search-headings))
  4569. (org-goto-selected-point org-goto-exit-command))
  4570. (save-excursion
  4571. (save-window-excursion
  4572. (delete-other-windows)
  4573. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  4574. (switch-to-buffer
  4575. (condition-case nil
  4576. (make-indirect-buffer (current-buffer) "*org-goto*")
  4577. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  4578. (with-output-to-temp-buffer "*Help*"
  4579. (princ help))
  4580. (org-fit-window-to-buffer (get-buffer-window "*Help*"))
  4581. (setq buffer-read-only nil)
  4582. (let ((org-startup-truncated t)
  4583. (org-startup-folded nil)
  4584. (org-startup-align-all-tables nil))
  4585. (org-mode)
  4586. (org-overview))
  4587. (setq buffer-read-only t)
  4588. (if (and (boundp 'org-goto-start-pos)
  4589. (integer-or-marker-p org-goto-start-pos))
  4590. (let ((org-show-hierarchy-above t)
  4591. (org-show-siblings t)
  4592. (org-show-following-heading t))
  4593. (goto-char org-goto-start-pos)
  4594. (and (org-invisible-p) (org-show-context)))
  4595. (goto-char (point-min)))
  4596. (let (org-special-ctrl-a/e) (org-beginning-of-line))
  4597. (message "Select location and press RET")
  4598. (use-local-map org-goto-map)
  4599. (recursive-edit)
  4600. ))
  4601. (kill-buffer "*org-goto*")
  4602. (cons org-goto-selected-point org-goto-exit-command)))
  4603. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  4604. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  4605. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  4606. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
  4607. (defun org-goto-local-search-headings (string bound noerror)
  4608. "Search and make sure that any matches are in headlines."
  4609. (catch 'return
  4610. (while (if isearch-forward
  4611. (search-forward string bound noerror)
  4612. (search-backward string bound noerror))
  4613. (when (let ((context (mapcar 'car (save-match-data (org-context)))))
  4614. (and (member :headline context)
  4615. (not (member :tags context))))
  4616. (throw 'return (point))))))
  4617. (defun org-goto-local-auto-isearch ()
  4618. "Start isearch."
  4619. (interactive)
  4620. (goto-char (point-min))
  4621. (let ((keys (this-command-keys)))
  4622. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  4623. (isearch-mode t)
  4624. (isearch-process-search-char (string-to-char keys)))))
  4625. (defun org-goto-ret (&optional arg)
  4626. "Finish `org-goto' by going to the new location."
  4627. (interactive "P")
  4628. (setq org-goto-selected-point (point)
  4629. org-goto-exit-command 'return)
  4630. (throw 'exit nil))
  4631. (defun org-goto-left ()
  4632. "Finish `org-goto' by going to the new location."
  4633. (interactive)
  4634. (if (org-on-heading-p)
  4635. (progn
  4636. (beginning-of-line 1)
  4637. (setq org-goto-selected-point (point)
  4638. org-goto-exit-command 'left)
  4639. (throw 'exit nil))
  4640. (error "Not on a heading")))
  4641. (defun org-goto-right ()
  4642. "Finish `org-goto' by going to the new location."
  4643. (interactive)
  4644. (if (org-on-heading-p)
  4645. (progn
  4646. (setq org-goto-selected-point (point)
  4647. org-goto-exit-command 'right)
  4648. (throw 'exit nil))
  4649. (error "Not on a heading")))
  4650. (defun org-goto-quit ()
  4651. "Finish `org-goto' without cursor motion."
  4652. (interactive)
  4653. (setq org-goto-selected-point nil)
  4654. (setq org-goto-exit-command 'quit)
  4655. (throw 'exit nil))
  4656. ;;; Indirect buffer display of subtrees
  4657. (defvar org-indirect-dedicated-frame nil
  4658. "This is the frame being used for indirect tree display.")
  4659. (defvar org-last-indirect-buffer nil)
  4660. (defun org-tree-to-indirect-buffer (&optional arg)
  4661. "Create indirect buffer and narrow it to current subtree.
  4662. With numerical prefix ARG, go up to this level and then take that tree.
  4663. If ARG is negative, go up that many levels.
  4664. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  4665. indirect buffer previously made with this command, to avoid proliferation of
  4666. indirect buffers. However, when you call the command with a `C-u' prefix, or
  4667. when `org-indirect-buffer-display' is `new-frame', the last buffer
  4668. is kept so that you can work with several indirect buffers at the same time.
  4669. If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
  4670. requests that a new frame be made for the new buffer, so that the dedicated
  4671. frame is not changed."
  4672. (interactive "P")
  4673. (let ((cbuf (current-buffer))
  4674. (cwin (selected-window))
  4675. (pos (point))
  4676. beg end level heading ibuf)
  4677. (save-excursion
  4678. (org-back-to-heading t)
  4679. (when (numberp arg)
  4680. (setq level (org-outline-level))
  4681. (if (< arg 0) (setq arg (+ level arg)))
  4682. (while (> (setq level (org-outline-level)) arg)
  4683. (outline-up-heading 1 t)))
  4684. (setq beg (point)
  4685. heading (org-get-heading))
  4686. (org-end-of-subtree t) (setq end (point)))
  4687. (if (and (buffer-live-p org-last-indirect-buffer)
  4688. (not (eq org-indirect-buffer-display 'new-frame))
  4689. (not arg))
  4690. (kill-buffer org-last-indirect-buffer))
  4691. (setq ibuf (org-get-indirect-buffer cbuf)
  4692. org-last-indirect-buffer ibuf)
  4693. (cond
  4694. ((or (eq org-indirect-buffer-display 'new-frame)
  4695. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  4696. (select-frame (make-frame))
  4697. (delete-other-windows)
  4698. (switch-to-buffer ibuf)
  4699. (org-set-frame-title heading))
  4700. ((eq org-indirect-buffer-display 'dedicated-frame)
  4701. (raise-frame
  4702. (select-frame (or (and org-indirect-dedicated-frame
  4703. (frame-live-p org-indirect-dedicated-frame)
  4704. org-indirect-dedicated-frame)
  4705. (setq org-indirect-dedicated-frame (make-frame)))))
  4706. (delete-other-windows)
  4707. (switch-to-buffer ibuf)
  4708. (org-set-frame-title (concat "Indirect: " heading)))
  4709. ((eq org-indirect-buffer-display 'current-window)
  4710. (switch-to-buffer ibuf))
  4711. ((eq org-indirect-buffer-display 'other-window)
  4712. (pop-to-buffer ibuf))
  4713. (t (error "Invalid value.")))
  4714. (if (featurep 'xemacs)
  4715. (save-excursion (org-mode) (turn-on-font-lock)))
  4716. (narrow-to-region beg end)
  4717. (show-all)
  4718. (goto-char pos)
  4719. (and (window-live-p cwin) (select-window cwin))))
  4720. (defun org-get-indirect-buffer (&optional buffer)
  4721. (setq buffer (or buffer (current-buffer)))
  4722. (let ((n 1) (base (buffer-name buffer)) bname)
  4723. (while (buffer-live-p
  4724. (get-buffer (setq bname (concat base "-" (number-to-string n)))))
  4725. (setq n (1+ n)))
  4726. (condition-case nil
  4727. (make-indirect-buffer buffer bname 'clone)
  4728. (error (make-indirect-buffer buffer bname)))))
  4729. (defun org-set-frame-title (title)
  4730. "Set the title of the current frame to the string TITLE."
  4731. ;; FIXME: how to name a single frame in XEmacs???
  4732. (unless (featurep 'xemacs)
  4733. (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
  4734. ;;;; Structure editing
  4735. ;;; Inserting headlines
  4736. (defun org-previous-line-empty-p ()
  4737. (save-excursion
  4738. (and (not (bobp))
  4739. (or (beginning-of-line 0) t)
  4740. (save-match-data
  4741. (looking-at "[ \t]*$")))))
  4742. (defun org-insert-heading (&optional force-heading)
  4743. "Insert a new heading or item with same depth at point.
  4744. If point is in a plain list and FORCE-HEADING is nil, create a new list item.
  4745. If point is at the beginning of a headline, insert a sibling before the
  4746. current headline. If point is not at the beginning, do not split the line,
  4747. but create the new headline after the current line."
  4748. (interactive "P")
  4749. (if (= (buffer-size) 0)
  4750. (insert "\n* ")
  4751. (when (or force-heading (not (org-insert-item)))
  4752. (let* ((empty-line-p nil)
  4753. (head (save-excursion
  4754. (condition-case nil
  4755. (progn
  4756. (org-back-to-heading)
  4757. (setq empty-line-p (org-previous-line-empty-p))
  4758. (match-string 0))
  4759. (error "*"))))
  4760. (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
  4761. (blank (if (eq blank-a 'auto) empty-line-p blank-a))
  4762. pos hide-previous previous-pos)
  4763. (cond
  4764. ((and (org-on-heading-p) (bolp)
  4765. (or (bobp)
  4766. (save-excursion (backward-char 1) (not (org-invisible-p)))))
  4767. ;; insert before the current line
  4768. (open-line (if blank 2 1)))
  4769. ((and (bolp)
  4770. (or (bobp)
  4771. (save-excursion
  4772. (backward-char 1) (not (org-invisible-p)))))
  4773. ;; insert right here
  4774. nil)
  4775. (t
  4776. ;; somewhere in the line
  4777. (save-excursion
  4778. (setq previous-pos (point-at-bol))
  4779. (end-of-line)
  4780. (setq hide-previous (org-invisible-p)))
  4781. (and org-insert-heading-respect-content (org-show-subtree))
  4782. (let ((split
  4783. (and (org-get-alist-option org-M-RET-may-split-line 'headline)
  4784. (save-excursion
  4785. (let ((p (point)))
  4786. (goto-char (point-at-bol))
  4787. (and (looking-at org-complex-heading-regexp)
  4788. (> p (match-beginning 4)))))))
  4789. tags pos)
  4790. (cond
  4791. (org-insert-heading-respect-content
  4792. (org-end-of-subtree nil t)
  4793. (or (bolp) (newline))
  4794. (or (org-previous-line-empty-p)
  4795. (and blank (newline)))
  4796. (open-line 1))
  4797. ((org-on-heading-p)
  4798. (when hide-previous
  4799. (show-children)
  4800. (org-show-entry))
  4801. (looking-at ".*?\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)?[ \t]*$")
  4802. (setq tags (and (match-end 2) (match-string 2)))
  4803. (and (match-end 1)
  4804. (delete-region (match-beginning 1) (match-end 1)))
  4805. (setq pos (point-at-bol))
  4806. (or split (end-of-line 1))
  4807. (delete-horizontal-space)
  4808. (newline (if blank 2 1))
  4809. (when tags
  4810. (save-excursion
  4811. (goto-char pos)
  4812. (end-of-line 1)
  4813. (insert " " tags)
  4814. (org-set-tags nil 'align))))
  4815. (t
  4816. (or split (end-of-line 1))
  4817. (newline (if blank 2 1)))))))
  4818. (insert head) (just-one-space)
  4819. (setq pos (point))
  4820. (end-of-line 1)
  4821. (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
  4822. (when (and org-insert-heading-respect-content hide-previous)
  4823. (save-excursion
  4824. (goto-char previous-pos)
  4825. (hide-subtree)))
  4826. (run-hooks 'org-insert-heading-hook)))))
  4827. (defun org-get-heading (&optional no-tags)
  4828. "Return the heading of the current entry, without the stars."
  4829. (save-excursion
  4830. (org-back-to-heading t)
  4831. (if (looking-at
  4832. (if no-tags
  4833. (org-re "\\*+[ \t]+\\([^\n\r]*?\\)\\([ \t]+:[[:alnum:]:_@]+:[ \t]*\\)?$")
  4834. "\\*+[ \t]+\\([^\r\n]*\\)"))
  4835. (match-string 1) "")))
  4836. (defun org-heading-components ()
  4837. "Return the components of the current heading.
  4838. This is a list with the following elements:
  4839. - the level as an integer
  4840. - the reduced level, different if `org-odd-levels-only' is set.
  4841. - the TODO keyword, or nil
  4842. - the priority character, like ?A, or nil if no priority is given
  4843. - the headline text itself, or the tags string if no headline text
  4844. - the tags string, or nil."
  4845. (save-excursion
  4846. (org-back-to-heading t)
  4847. (if (looking-at org-complex-heading-regexp)
  4848. (list (length (match-string 1))
  4849. (org-reduced-level (length (match-string 1)))
  4850. (org-match-string-no-properties 2)
  4851. (and (match-end 3) (aref (match-string 3) 2))
  4852. (org-match-string-no-properties 4)
  4853. (org-match-string-no-properties 5)))))
  4854. (defun org-get-entry ()
  4855. "Get the entry text, after heading, entire subtree."
  4856. (save-excursion
  4857. (org-back-to-heading t)
  4858. (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
  4859. (defun org-insert-heading-after-current ()
  4860. "Insert a new heading with same level as current, after current subtree."
  4861. (interactive)
  4862. (org-back-to-heading)
  4863. (org-insert-heading)
  4864. (org-move-subtree-down)
  4865. (end-of-line 1))
  4866. (defun org-insert-heading-respect-content ()
  4867. (interactive)
  4868. (let ((org-insert-heading-respect-content t))
  4869. (org-insert-heading t)))
  4870. (defun org-insert-todo-heading-respect-content (&optional force-state)
  4871. (interactive "P")
  4872. (let ((org-insert-heading-respect-content t))
  4873. (org-insert-todo-heading force-state t)))
  4874. (defun org-insert-todo-heading (arg &optional force-heading)
  4875. "Insert a new heading with the same level and TODO state as current heading.
  4876. If the heading has no TODO state, or if the state is DONE, use the first
  4877. state (TODO by default). Also with prefix arg, force first state."
  4878. (interactive "P")
  4879. (when (or force-heading (not (org-insert-item 'checkbox)))
  4880. (org-insert-heading force-heading)
  4881. (save-excursion
  4882. (org-back-to-heading)
  4883. (outline-previous-heading)
  4884. (looking-at org-todo-line-regexp))
  4885. (let*
  4886. ((new-mark-x
  4887. (if (or arg
  4888. (not (match-beginning 2))
  4889. (member (match-string 2) org-done-keywords))
  4890. (car org-todo-keywords-1)
  4891. (match-string 2)))
  4892. (new-mark
  4893. (or
  4894. (run-hook-with-args-until-success
  4895. 'org-todo-get-default-hook new-mark-x nil)
  4896. new-mark-x)))
  4897. (beginning-of-line 1)
  4898. (and (looking-at "\\*+ ") (goto-char (match-end 0))
  4899. (insert new-mark " ")))
  4900. (when org-provide-todo-statistics
  4901. (org-update-parent-todo-statistics))))
  4902. (defun org-insert-subheading (arg)
  4903. "Insert a new subheading and demote it.
  4904. Works for outline headings and for plain lists alike."
  4905. (interactive "P")
  4906. (org-insert-heading arg)
  4907. (cond
  4908. ((org-on-heading-p) (org-do-demote))
  4909. ((org-at-item-p) (org-indent-item 1))))
  4910. (defun org-insert-todo-subheading (arg)
  4911. "Insert a new subheading with TODO keyword or checkbox and demote it.
  4912. Works for outline headings and for plain lists alike."
  4913. (interactive "P")
  4914. (org-insert-todo-heading arg)
  4915. (cond
  4916. ((org-on-heading-p) (org-do-demote))
  4917. ((org-at-item-p) (org-indent-item 1))))
  4918. ;;; Promotion and Demotion
  4919. (defun org-promote-subtree ()
  4920. "Promote the entire subtree.
  4921. See also `org-promote'."
  4922. (interactive)
  4923. (save-excursion
  4924. (org-map-tree 'org-promote))
  4925. (org-fix-position-after-promote))
  4926. (defun org-demote-subtree ()
  4927. "Demote the entire subtree. See `org-demote'.
  4928. See also `org-promote'."
  4929. (interactive)
  4930. (save-excursion
  4931. (org-map-tree 'org-demote))
  4932. (org-fix-position-after-promote))
  4933. (defun org-do-promote ()
  4934. "Promote the current heading higher up the tree.
  4935. If the region is active in `transient-mark-mode', promote all headings
  4936. in the region."
  4937. (interactive)
  4938. (save-excursion
  4939. (if (org-region-active-p)
  4940. (org-map-region 'org-promote (region-beginning) (region-end))
  4941. (org-promote)))
  4942. (org-fix-position-after-promote))
  4943. (defun org-do-demote ()
  4944. "Demote the current heading lower down the tree.
  4945. If the region is active in `transient-mark-mode', demote all headings
  4946. in the region."
  4947. (interactive)
  4948. (save-excursion
  4949. (if (org-region-active-p)
  4950. (org-map-region 'org-demote (region-beginning) (region-end))
  4951. (org-demote)))
  4952. (org-fix-position-after-promote))
  4953. (defun org-fix-position-after-promote ()
  4954. "Make sure that after pro/demotion cursor position is right."
  4955. (let ((pos (point)))
  4956. (when (save-excursion
  4957. (beginning-of-line 1)
  4958. (looking-at org-todo-line-regexp)
  4959. (or (equal pos (match-end 1)) (equal pos (match-end 2))))
  4960. (cond ((eobp) (insert " "))
  4961. ((eolp) (insert " "))
  4962. ((equal (char-after) ?\ ) (forward-char 1))))))
  4963. (defun org-reduced-level (l)
  4964. "Compute the effective level of a heading.
  4965. This takes into account the setting of `org-odd-levels-only'."
  4966. (if org-odd-levels-only (1+ (floor (/ l 2))) l))
  4967. (defun org-get-valid-level (level &optional change)
  4968. "Rectify a level change under the influence of `org-odd-levels-only'
  4969. LEVEL is a current level, CHANGE is by how much the level should be
  4970. modified. Even if CHANGE is nil, LEVEL may be returned modified because
  4971. even level numbers will become the next higher odd number."
  4972. (if org-odd-levels-only
  4973. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  4974. ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
  4975. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  4976. (max 1 (+ level (or change 0)))))
  4977. (if (boundp 'define-obsolete-function-alias)
  4978. (if (or (featurep 'xemacs) (< emacs-major-version 23))
  4979. (define-obsolete-function-alias 'org-get-legal-level
  4980. 'org-get-valid-level)
  4981. (define-obsolete-function-alias 'org-get-legal-level
  4982. 'org-get-valid-level "23.1")))
  4983. (defun org-promote ()
  4984. "Promote the current heading higher up the tree.
  4985. If the region is active in `transient-mark-mode', promote all headings
  4986. in the region."
  4987. (org-back-to-heading t)
  4988. (let* ((level (save-match-data (funcall outline-level)))
  4989. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  4990. (diff (abs (- level (length up-head) -1))))
  4991. (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
  4992. (replace-match up-head nil t)
  4993. ;; Fixup tag positioning
  4994. (and org-auto-align-tags (org-set-tags nil t))
  4995. (if org-adapt-indentation (org-fixup-indentation (- diff)))))
  4996. (defun org-demote ()
  4997. "Demote the current heading lower down the tree.
  4998. If the region is active in `transient-mark-mode', demote all headings
  4999. in the region."
  5000. (org-back-to-heading t)
  5001. (let* ((level (save-match-data (funcall outline-level)))
  5002. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  5003. (diff (abs (- level (length down-head) -1))))
  5004. (replace-match down-head nil t)
  5005. ;; Fixup tag positioning
  5006. (and org-auto-align-tags (org-set-tags nil t))
  5007. (if org-adapt-indentation (org-fixup-indentation diff))))
  5008. (defun org-map-tree (fun)
  5009. "Call FUN for every heading underneath the current one."
  5010. (org-back-to-heading)
  5011. (let ((level (funcall outline-level)))
  5012. (save-excursion
  5013. (funcall fun)
  5014. (while (and (progn
  5015. (outline-next-heading)
  5016. (> (funcall outline-level) level))
  5017. (not (eobp)))
  5018. (funcall fun)))))
  5019. (defun org-map-region (fun beg end)
  5020. "Call FUN for every heading between BEG and END."
  5021. (let ((org-ignore-region t))
  5022. (save-excursion
  5023. (setq end (copy-marker end))
  5024. (goto-char beg)
  5025. (if (and (re-search-forward (concat "^" outline-regexp) nil t)
  5026. (< (point) end))
  5027. (funcall fun))
  5028. (while (and (progn
  5029. (outline-next-heading)
  5030. (< (point) end))
  5031. (not (eobp)))
  5032. (funcall fun)))))
  5033. (defun org-fixup-indentation (diff)
  5034. "Change the indentation in the current entry by DIFF
  5035. However, if any line in the current entry has no indentation, or if it
  5036. would end up with no indentation after the change, nothing at all is done."
  5037. (save-excursion
  5038. (let ((end (save-excursion (outline-next-heading)
  5039. (point-marker)))
  5040. (prohibit (if (> diff 0)
  5041. "^\\S-"
  5042. (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
  5043. col)
  5044. (unless (save-excursion (end-of-line 1)
  5045. (re-search-forward prohibit end t))
  5046. (while (and (< (point) end)
  5047. (re-search-forward "^[ \t]+" end t))
  5048. (goto-char (match-end 0))
  5049. (setq col (current-column))
  5050. (if (< diff 0) (replace-match ""))
  5051. (org-indent-to-column (+ diff col))))
  5052. (move-marker end nil))))
  5053. (defun org-convert-to-odd-levels ()
  5054. "Convert an org-mode file with all levels allowed to one with odd levels.
  5055. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  5056. level 5 etc."
  5057. (interactive)
  5058. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  5059. (let ((org-odd-levels-only nil) n)
  5060. (save-excursion
  5061. (goto-char (point-min))
  5062. (while (re-search-forward "^\\*\\*+ " nil t)
  5063. (setq n (- (length (match-string 0)) 2))
  5064. (while (>= (setq n (1- n)) 0)
  5065. (org-demote))
  5066. (end-of-line 1))))))
  5067. (defun org-convert-to-oddeven-levels ()
  5068. "Convert an org-mode file with only odd levels to one with odd and even levels.
  5069. This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
  5070. section with an even level, conversion would destroy the structure of the file. An error
  5071. is signaled in this case."
  5072. (interactive)
  5073. (goto-char (point-min))
  5074. ;; First check if there are no even levels
  5075. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  5076. (org-show-context t)
  5077. (error "Not all levels are odd in this file. Conversion not possible."))
  5078. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  5079. (let ((org-odd-levels-only nil) n)
  5080. (save-excursion
  5081. (goto-char (point-min))
  5082. (while (re-search-forward "^\\*\\*+ " nil t)
  5083. (setq n (/ (1- (length (match-string 0))) 2))
  5084. (while (>= (setq n (1- n)) 0)
  5085. (org-promote))
  5086. (end-of-line 1))))))
  5087. (defun org-tr-level (n)
  5088. "Make N odd if required."
  5089. (if org-odd-levels-only (1+ (/ n 2)) n))
  5090. ;;; Vertical tree motion, cutting and pasting of subtrees
  5091. (defun org-move-subtree-up (&optional arg)
  5092. "Move the current subtree up past ARG headlines of the same level."
  5093. (interactive "p")
  5094. (org-move-subtree-down (- (prefix-numeric-value arg))))
  5095. (defun org-move-subtree-down (&optional arg)
  5096. "Move the current subtree down past ARG headlines of the same level."
  5097. (interactive "p")
  5098. (setq arg (prefix-numeric-value arg))
  5099. (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
  5100. 'outline-get-last-sibling))
  5101. (ins-point (make-marker))
  5102. (cnt (abs arg))
  5103. beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
  5104. ;; Select the tree
  5105. (org-back-to-heading)
  5106. (setq beg0 (point))
  5107. (save-excursion
  5108. (setq ne-beg (org-back-over-empty-lines))
  5109. (setq beg (point)))
  5110. (save-match-data
  5111. (save-excursion (outline-end-of-heading)
  5112. (setq folded (org-invisible-p)))
  5113. (outline-end-of-subtree))
  5114. (outline-next-heading)
  5115. (setq ne-end (org-back-over-empty-lines))
  5116. (setq end (point))
  5117. (goto-char beg0)
  5118. (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
  5119. ;; include less whitespace
  5120. (save-excursion
  5121. (goto-char beg)
  5122. (forward-line (- ne-beg ne-end))
  5123. (setq beg (point))))
  5124. ;; Find insertion point, with error handling
  5125. (while (> cnt 0)
  5126. (or (and (funcall movfunc) (looking-at outline-regexp))
  5127. (progn (goto-char beg0)
  5128. (error "Cannot move past superior level or buffer limit")))
  5129. (setq cnt (1- cnt)))
  5130. (if (> arg 0)
  5131. ;; Moving forward - still need to move over subtree
  5132. (progn (org-end-of-subtree t t)
  5133. (save-excursion
  5134. (org-back-over-empty-lines)
  5135. (or (bolp) (newline)))))
  5136. (setq ne-ins (org-back-over-empty-lines))
  5137. (move-marker ins-point (point))
  5138. (setq txt (buffer-substring beg end))
  5139. (org-save-markers-in-region beg end)
  5140. (delete-region beg end)
  5141. (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
  5142. (or (bobp) (outline-flag-region (1- (point)) (point) nil))
  5143. (and (not (bolp)) (looking-at "\n") (forward-char 1))
  5144. (let ((bbb (point)))
  5145. (insert-before-markers txt)
  5146. (org-reinstall-markers-in-region bbb)
  5147. (move-marker ins-point bbb))
  5148. (or (bolp) (insert "\n"))
  5149. (setq ins-end (point))
  5150. (goto-char ins-point)
  5151. (org-skip-whitespace)
  5152. (when (and (< arg 0)
  5153. (org-first-sibling-p)
  5154. (> ne-ins ne-beg))
  5155. ;; Move whitespace back to beginning
  5156. (save-excursion
  5157. (goto-char ins-end)
  5158. (let ((kill-whole-line t))
  5159. (kill-line (- ne-ins ne-beg)) (point)))
  5160. (insert (make-string (- ne-ins ne-beg) ?\n)))
  5161. (move-marker ins-point nil)
  5162. (org-compact-display-after-subtree-move)
  5163. (org-show-empty-lines-in-parent)
  5164. (unless folded
  5165. (org-show-entry)
  5166. (show-children)
  5167. (org-cycle-hide-drawers 'children))))
  5168. (defvar org-subtree-clip ""
  5169. "Clipboard for cut and paste of subtrees.
  5170. This is actually only a copy of the kill, because we use the normal kill
  5171. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  5172. (defvar org-subtree-clip-folded nil
  5173. "Was the last copied subtree folded?
  5174. This is used to fold the tree back after pasting.")
  5175. (defun org-cut-subtree (&optional n)
  5176. "Cut the current subtree into the clipboard.
  5177. With prefix arg N, cut this many sequential subtrees.
  5178. This is a short-hand for marking the subtree and then cutting it."
  5179. (interactive "p")
  5180. (org-copy-subtree n 'cut))
  5181. (defun org-copy-subtree (&optional n cut force-store-markers)
  5182. "Cut the current subtree into the clipboard.
  5183. With prefix arg N, cut this many sequential subtrees.
  5184. This is a short-hand for marking the subtree and then copying it.
  5185. If CUT is non-nil, actually cut the subtree.
  5186. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  5187. of some markers in the region, even if CUT is non-nil. This is
  5188. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  5189. (interactive "p")
  5190. (let (beg end folded (beg0 (point)))
  5191. (if (interactive-p)
  5192. (org-back-to-heading nil) ; take what looks like a subtree
  5193. (org-back-to-heading t)) ; take what is really there
  5194. (org-back-over-empty-lines)
  5195. (setq beg (point))
  5196. (skip-chars-forward " \t\r\n")
  5197. (save-match-data
  5198. (save-excursion (outline-end-of-heading)
  5199. (setq folded (org-invisible-p)))
  5200. (condition-case nil
  5201. (outline-forward-same-level (1- n))
  5202. (error nil))
  5203. (org-end-of-subtree t t))
  5204. (org-back-over-empty-lines)
  5205. (setq end (point))
  5206. (goto-char beg0)
  5207. (when (> end beg)
  5208. (setq org-subtree-clip-folded folded)
  5209. (when (or cut force-store-markers)
  5210. (org-save-markers-in-region beg end))
  5211. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  5212. (setq org-subtree-clip (current-kill 0))
  5213. (message "%s: Subtree(s) with %d characters"
  5214. (if cut "Cut" "Copied")
  5215. (length org-subtree-clip)))))
  5216. (defun org-paste-subtree (&optional level tree for-yank)
  5217. "Paste the clipboard as a subtree, with modification of headline level.
  5218. The entire subtree is promoted or demoted in order to match a new headline
  5219. level.
  5220. If the cursor is at the beginning of a headline, the same level as
  5221. that headline is used to paste the tree
  5222. If not, the new level is derived from the *visible* headings
  5223. before and after the insertion point, and taken to be the inferior headline
  5224. level of the two. So if the previous visible heading is level 3 and the
  5225. next is level 4 (or vice versa), level 4 will be used for insertion.
  5226. This makes sure that the subtree remains an independent subtree and does
  5227. not swallow low level entries.
  5228. You can also force a different level, either by using a numeric prefix
  5229. argument, or by inserting the heading marker by hand. For example, if the
  5230. cursor is after \"*****\", then the tree will be shifted to level 5.
  5231. If optional TREE is given, use this text instead of the kill ring.
  5232. When FOR-YANK is set, this is called by `org-yank'. In this case, do not
  5233. move back over whitespace before inserting, and move point to the end of
  5234. the inserted text when done."
  5235. (interactive "P")
  5236. (unless (org-kill-is-subtree-p tree)
  5237. (error "%s"
  5238. (substitute-command-keys
  5239. "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
  5240. (let* ((visp (not (org-invisible-p)))
  5241. (txt (or tree (and kill-ring (current-kill 0))))
  5242. (^re (concat "^\\(" outline-regexp "\\)"))
  5243. (re (concat "\\(" outline-regexp "\\)"))
  5244. (^re_ (concat "\\(\\*+\\)[ \t]*"))
  5245. (old-level (if (string-match ^re txt)
  5246. (- (match-end 0) (match-beginning 0) 1)
  5247. -1))
  5248. (force-level (cond (level (prefix-numeric-value level))
  5249. ((and (looking-at "[ \t]*$")
  5250. (string-match
  5251. ^re_ (buffer-substring
  5252. (point-at-bol) (point))))
  5253. (- (match-end 1) (match-beginning 1)))
  5254. ((and (bolp)
  5255. (looking-at org-outline-regexp))
  5256. (- (match-end 0) (point) 1))
  5257. (t nil)))
  5258. (previous-level (save-excursion
  5259. (condition-case nil
  5260. (progn
  5261. (outline-previous-visible-heading 1)
  5262. (if (looking-at re)
  5263. (- (match-end 0) (match-beginning 0) 1)
  5264. 1))
  5265. (error 1))))
  5266. (next-level (save-excursion
  5267. (condition-case nil
  5268. (progn
  5269. (or (looking-at outline-regexp)
  5270. (outline-next-visible-heading 1))
  5271. (if (looking-at re)
  5272. (- (match-end 0) (match-beginning 0) 1)
  5273. 1))
  5274. (error 1))))
  5275. (new-level (or force-level (max previous-level next-level)))
  5276. (shift (if (or (= old-level -1)
  5277. (= new-level -1)
  5278. (= old-level new-level))
  5279. 0
  5280. (- new-level old-level)))
  5281. (delta (if (> shift 0) -1 1))
  5282. (func (if (> shift 0) 'org-demote 'org-promote))
  5283. (org-odd-levels-only nil)
  5284. beg end newend)
  5285. ;; Remove the forced level indicator
  5286. (if force-level
  5287. (delete-region (point-at-bol) (point)))
  5288. ;; Paste
  5289. (beginning-of-line 1)
  5290. (unless for-yank (org-back-over-empty-lines))
  5291. (setq beg (point))
  5292. (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
  5293. (insert-before-markers txt)
  5294. (unless (string-match "\n\\'" txt) (insert "\n"))
  5295. (setq newend (point))
  5296. (org-reinstall-markers-in-region beg)
  5297. (setq end (point))
  5298. (goto-char beg)
  5299. (skip-chars-forward " \t\n\r")
  5300. (setq beg (point))
  5301. (if (and (org-invisible-p) visp)
  5302. (save-excursion (outline-show-heading)))
  5303. ;; Shift if necessary
  5304. (unless (= shift 0)
  5305. (save-restriction
  5306. (narrow-to-region beg end)
  5307. (while (not (= shift 0))
  5308. (org-map-region func (point-min) (point-max))
  5309. (setq shift (+ delta shift)))
  5310. (goto-char (point-min))
  5311. (setq newend (point-max))))
  5312. (when (or (interactive-p) for-yank)
  5313. (message "Clipboard pasted as level %d subtree" new-level))
  5314. (if (and (not for-yank) ; in this case, org-yank will decide about folding
  5315. kill-ring
  5316. (eq org-subtree-clip (current-kill 0))
  5317. org-subtree-clip-folded)
  5318. ;; The tree was folded before it was killed/copied
  5319. (hide-subtree))
  5320. (and for-yank (goto-char newend))))
  5321. (defun org-kill-is-subtree-p (&optional txt)
  5322. "Check if the current kill is an outline subtree, or a set of trees.
  5323. Returns nil if kill does not start with a headline, or if the first
  5324. headline level is not the largest headline level in the tree.
  5325. So this will actually accept several entries of equal levels as well,
  5326. which is OK for `org-paste-subtree'.
  5327. If optional TXT is given, check this string instead of the current kill."
  5328. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  5329. (start-level (and kill
  5330. (string-match (concat "\\`\\([ \t\n\r]*?\n\\)?\\("
  5331. org-outline-regexp "\\)")
  5332. kill)
  5333. (- (match-end 2) (match-beginning 2) 1)))
  5334. (re (concat "^" org-outline-regexp))
  5335. (start (1+ (or (match-beginning 2) -1))))
  5336. (if (not start-level)
  5337. (progn
  5338. nil) ;; does not even start with a heading
  5339. (catch 'exit
  5340. (while (setq start (string-match re kill (1+ start)))
  5341. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  5342. (throw 'exit nil)))
  5343. t))))
  5344. (defvar org-markers-to-move nil
  5345. "Markers that should be moved with a cut-and-paste operation.
  5346. Those markers are stored together with their positions relative to
  5347. the start of the region.")
  5348. (defun org-save-markers-in-region (beg end)
  5349. "Check markers in region.
  5350. If these markers are between BEG and END, record their position relative
  5351. to BEG, so that after moving the block of text, we can put the markers back
  5352. into place.
  5353. This function gets called just before an entry or tree gets cut from the
  5354. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  5355. called immediately, to move the markers with the entries."
  5356. (setq org-markers-to-move nil)
  5357. (when (featurep 'org-clock)
  5358. (org-clock-save-markers-for-cut-and-paste beg end))
  5359. (when (featurep 'org-agenda)
  5360. (org-agenda-save-markers-for-cut-and-paste beg end)))
  5361. (defun org-check-and-save-marker (marker beg end)
  5362. "Check if MARKER is between BEG and END.
  5363. If yes, remember the marker and the distance to BEG."
  5364. (when (and (marker-buffer marker)
  5365. (equal (marker-buffer marker) (current-buffer)))
  5366. (if (and (>= marker beg) (< marker end))
  5367. (push (cons marker (- marker beg)) org-markers-to-move))))
  5368. (defun org-reinstall-markers-in-region (beg)
  5369. "Move all remembered markers to their position relative to BEG."
  5370. (mapc (lambda (x)
  5371. (move-marker (car x) (+ beg (cdr x))))
  5372. org-markers-to-move)
  5373. (setq org-markers-to-move nil))
  5374. (defun org-narrow-to-subtree ()
  5375. "Narrow buffer to the current subtree."
  5376. (interactive)
  5377. (save-excursion
  5378. (save-match-data
  5379. (narrow-to-region
  5380. (progn (org-back-to-heading) (point))
  5381. (progn (org-end-of-subtree t) (point))))))
  5382. (defun org-clone-subtree-with-time-shift (n &optional shift)
  5383. "Clone the task (subtree) at point N times.
  5384. The clones will be inserted as siblings.
  5385. In interactive use, the user will be prompted for the number of clones
  5386. to be produced, and for a time SHIFT, which may be a repeater as used
  5387. in time stamps, for example `+3d'.
  5388. When a valid repeater is given and the entry contains any time stamps,
  5389. the clones will become a sequence in time, with time stamps in the
  5390. subtree shifted for each clone produced. If SHIFT is nil or the
  5391. empty string, time stamps will be left alone.
  5392. If the original subtree did contain time stamps with a repeater,
  5393. the following will happen:
  5394. - the repeater will be removed in each clone
  5395. - an additional clone will be produced, with the current, unshifted
  5396. date(s) in the entry.
  5397. - the original entry will be placed *after* all the clones, with
  5398. repeater intact.
  5399. - the start days in the repeater in the original entry will be shifted
  5400. to past the last clone.
  5401. I this way you can spell out a number of instances of a repeating task,
  5402. and still retain the repeater to cover future instances of the task."
  5403. (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
  5404. (let (beg end template task
  5405. shift-n shift-what doshift nmin nmax (n-no-remove -1))
  5406. (if (not (and (integerp n) (> n 0)))
  5407. (error "Invalid number of replications %s" n))
  5408. (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
  5409. (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([dwmy]\\)[ \t]*\\'"
  5410. shift)))
  5411. (error "Invalid shift specification %s" shift))
  5412. (when doshift
  5413. (setq shift-n (string-to-number (match-string 1 shift))
  5414. shift-what (cdr (assoc (match-string 2 shift)
  5415. '(("d" . day) ("w" . week)
  5416. ("m" . month) ("y" . year))))))
  5417. (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
  5418. (setq nmin 1 nmax n)
  5419. (org-back-to-heading t)
  5420. (setq beg (point))
  5421. (org-end-of-subtree t t)
  5422. (setq end (point))
  5423. (setq template (buffer-substring beg end))
  5424. (when (and doshift
  5425. (string-match "<[^<>\n]+ \\+[0-9]+[dwmy][^<>\n]*>" template))
  5426. (delete-region beg end)
  5427. (setq end beg)
  5428. (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
  5429. (goto-char end)
  5430. (loop for n from nmin to nmax do
  5431. (if (not doshift)
  5432. (setq task template)
  5433. (with-temp-buffer
  5434. (insert template)
  5435. (org-mode)
  5436. (goto-char (point-min))
  5437. (while (re-search-forward org-ts-regexp nil t)
  5438. (org-timestamp-change (* n shift-n) shift-what))
  5439. (unless (= n n-no-remove)
  5440. (goto-char (point-min))
  5441. (while (re-search-forward org-ts-regexp nil t)
  5442. (save-excursion
  5443. (goto-char (match-beginning 0))
  5444. (if (looking-at "<[^<>\n]+\\( +\\+[0-9]+[dwmy]\\)")
  5445. (delete-region (match-beginning 1) (match-end 1))))))
  5446. (setq task (buffer-string))))
  5447. (insert task))
  5448. (goto-char beg)))
  5449. ;;; Outline Sorting
  5450. (defun org-sort (with-case)
  5451. "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
  5452. Optional argument WITH-CASE means sort case-sensitively.
  5453. With a double prefix argument, also remove duplicate entries."
  5454. (interactive "P")
  5455. (if (org-at-table-p)
  5456. (org-call-with-arg 'org-table-sort-lines with-case)
  5457. (org-call-with-arg 'org-sort-entries-or-items with-case)))
  5458. (defun org-sort-remove-invisible (s)
  5459. (remove-text-properties 0 (length s) org-rm-props s)
  5460. (while (string-match org-bracket-link-regexp s)
  5461. (setq s (replace-match (if (match-end 2)
  5462. (match-string 3 s)
  5463. (match-string 1 s)) t t s)))
  5464. s)
  5465. (defvar org-priority-regexp) ; defined later in the file
  5466. (defvar org-after-sorting-entries-or-items-hook nil
  5467. "Hook that is run after a bunch of entries or items have been sorted.
  5468. When children are sorted, the cursor is in the parent line when this
  5469. hook gets called. When a region or a plain list is sorted, the cursor
  5470. will be in the first entry of the sorted region/list.")
  5471. (defun org-sort-entries-or-items
  5472. (&optional with-case sorting-type getkey-func compare-func property)
  5473. "Sort entries on a certain level of an outline tree, or plain list items.
  5474. If there is an active region, the entries in the region are sorted.
  5475. Else, if the cursor is before the first entry, sort the top-level items.
  5476. Else, the children of the entry at point are sorted.
  5477. If the cursor is at the first item in a plain list, the list items will be
  5478. sorted.
  5479. Sorting can be alphabetically, numerically, by date/time as given by
  5480. a time stamp, by a property or by priority.
  5481. The command prompts for the sorting type unless it has been given to the
  5482. function through the SORTING-TYPE argument, which needs to a character,
  5483. \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
  5484. precise meaning of each character:
  5485. n Numerically, by converting the beginning of the entry/item to a number.
  5486. a Alphabetically, ignoring the TODO keyword and the priority, if any.
  5487. t By date/time, either the first active time stamp in the entry, or, if
  5488. none exist, by the first inactive one.
  5489. In items, only the first line will be chekced.
  5490. s By the scheduled date/time.
  5491. d By deadline date/time.
  5492. c By creation time, which is assumed to be the first inactive time stamp
  5493. at the beginning of a line.
  5494. p By priority according to the cookie.
  5495. r By the value of a property.
  5496. Capital letters will reverse the sort order.
  5497. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  5498. called with point at the beginning of the record. It must return either
  5499. a string or a number that should serve as the sorting key for that record.
  5500. Comparing entries ignores case by default. However, with an optional argument
  5501. WITH-CASE, the sorting considers case as well."
  5502. (interactive "P")
  5503. (let ((case-func (if with-case 'identity 'downcase))
  5504. start beg end stars re re2
  5505. txt what tmp plain-list-p)
  5506. ;; Find beginning and end of region to sort
  5507. (cond
  5508. ((org-region-active-p)
  5509. ;; we will sort the region
  5510. (setq end (region-end)
  5511. what "region")
  5512. (goto-char (region-beginning))
  5513. (if (not (org-on-heading-p)) (outline-next-heading))
  5514. (setq start (point)))
  5515. ((org-at-item-p)
  5516. ;; we will sort this plain list
  5517. (org-beginning-of-item-list) (setq start (point))
  5518. (org-end-of-item-list) (setq end (point))
  5519. (goto-char start)
  5520. (setq plain-list-p t
  5521. what "plain list"))
  5522. ((or (org-on-heading-p)
  5523. (condition-case nil (progn (org-back-to-heading) t) (error nil)))
  5524. ;; we will sort the children of the current headline
  5525. (org-back-to-heading)
  5526. (setq start (point)
  5527. end (progn (org-end-of-subtree t t)
  5528. (org-back-over-empty-lines)
  5529. (point))
  5530. what "children")
  5531. (goto-char start)
  5532. (show-subtree)
  5533. (outline-next-heading))
  5534. (t
  5535. ;; we will sort the top-level entries in this file
  5536. (goto-char (point-min))
  5537. (or (org-on-heading-p) (outline-next-heading))
  5538. (setq start (point) end (point-max) what "top-level")
  5539. (goto-char start)
  5540. (show-all)))
  5541. (setq beg (point))
  5542. (if (>= beg end) (error "Nothing to sort"))
  5543. (unless plain-list-p
  5544. (looking-at "\\(\\*+\\)")
  5545. (setq stars (match-string 1)
  5546. re (concat "^" (regexp-quote stars) " +")
  5547. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
  5548. txt (buffer-substring beg end))
  5549. (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
  5550. (if (and (not (equal stars "*")) (string-match re2 txt))
  5551. (error "Region to sort contains a level above the first entry")))
  5552. (unless sorting-type
  5553. (message
  5554. (if plain-list-p
  5555. "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
  5556. "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
  5557. [t]ime [s ]cheduled [d]eadline [c]reated
  5558. A/N/T/S/D/C/P/O/F means reversed:")
  5559. what)
  5560. (setq sorting-type (read-char-exclusive))
  5561. (and (= (downcase sorting-type) ?f)
  5562. (setq getkey-func
  5563. (org-ido-completing-read "Sort using function: "
  5564. obarray 'fboundp t nil nil))
  5565. (setq getkey-func (intern getkey-func)))
  5566. (and (= (downcase sorting-type) ?r)
  5567. (setq property
  5568. (org-ido-completing-read "Property: "
  5569. (mapcar 'list (org-buffer-property-keys t))
  5570. nil t))))
  5571. (message "Sorting entries...")
  5572. (save-restriction
  5573. (narrow-to-region start end)
  5574. (let ((dcst (downcase sorting-type))
  5575. (case-fold-search nil)
  5576. (now (current-time)))
  5577. (sort-subr
  5578. (/= dcst sorting-type)
  5579. ;; This function moves to the beginning character of the "record" to
  5580. ;; be sorted.
  5581. (if plain-list-p
  5582. (lambda nil
  5583. (if (org-at-item-p) t (goto-char (point-max))))
  5584. (lambda nil
  5585. (if (re-search-forward re nil t)
  5586. (goto-char (match-beginning 0))
  5587. (goto-char (point-max)))))
  5588. ;; This function moves to the last character of the "record" being
  5589. ;; sorted.
  5590. (if plain-list-p
  5591. 'org-end-of-item
  5592. (lambda nil
  5593. (save-match-data
  5594. (condition-case nil
  5595. (outline-forward-same-level 1)
  5596. (error
  5597. (goto-char (point-max)))))))
  5598. ;; This function returns the value that gets sorted against.
  5599. (if plain-list-p
  5600. (lambda nil
  5601. (when (looking-at "[ \t]*[-+*0-9.)]+[ \t]+")
  5602. (cond
  5603. ((= dcst ?n)
  5604. (string-to-number (buffer-substring (match-end 0)
  5605. (point-at-eol))))
  5606. ((= dcst ?a)
  5607. (buffer-substring (match-end 0) (point-at-eol)))
  5608. ((= dcst ?t)
  5609. (if (or (re-search-forward org-ts-regexp (point-at-eol) t)
  5610. (re-search-forward org-ts-regexp-both
  5611. (point-at-eol) t))
  5612. (time-to-seconds
  5613. (org-time-string-to-time (match-string 0)))
  5614. (time-to-seconds now)))
  5615. ((= dcst ?f)
  5616. (if getkey-func
  5617. (progn
  5618. (setq tmp (funcall getkey-func))
  5619. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  5620. tmp)
  5621. (error "Invalid key function `%s'" getkey-func)))
  5622. (t (error "Invalid sorting type `%c'" sorting-type)))))
  5623. (lambda nil
  5624. (cond
  5625. ((= dcst ?n)
  5626. (if (looking-at org-complex-heading-regexp)
  5627. (string-to-number (match-string 4))
  5628. nil))
  5629. ((= dcst ?a)
  5630. (if (looking-at org-complex-heading-regexp)
  5631. (funcall case-func (match-string 4))
  5632. nil))
  5633. ((= dcst ?t)
  5634. (let ((end (save-excursion (outline-next-heading) (point))))
  5635. (if (or (re-search-forward org-ts-regexp end t)
  5636. (re-search-forward org-ts-regexp-both end t))
  5637. (org-time-string-to-time (match-string 0))
  5638. (org-time-string-to-time now))))
  5639. ((= dcst ?c)
  5640. (let ((end (save-excursion (outline-next-heading) (point))))
  5641. (if (re-search-forward
  5642. (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
  5643. end t)
  5644. (time-to-seconds (org-time-string-to-time
  5645. (match-string 0)))
  5646. (time-to-seconds now))))
  5647. ((= dcst ?s)
  5648. (let ((end (save-excursion (outline-next-heading) (point))))
  5649. (if (re-search-forward org-scheduled-time-regexp end t)
  5650. (org-time-string-to-time (match-string 1))
  5651. (org-time-string-to-time now))))
  5652. ((= dcst ?d)
  5653. (let ((end (save-excursion (outline-next-heading) (point))))
  5654. (if (re-search-forward org-deadline-time-regexp end t)
  5655. (org-time-string-to-time (match-string 1))
  5656. (org-time-string-to-time now))))
  5657. ((= dcst ?p)
  5658. (if (re-search-forward org-priority-regexp (point-at-eol) t)
  5659. (string-to-char (match-string 2))
  5660. org-default-priority))
  5661. ((= dcst ?r)
  5662. (or (org-entry-get nil property) ""))
  5663. ((= dcst ?o)
  5664. (if (looking-at org-complex-heading-regexp)
  5665. (- 9999 (length (member (match-string 2)
  5666. org-todo-keywords-1)))))
  5667. ((= dcst ?f)
  5668. (if getkey-func
  5669. (progn
  5670. (setq tmp (funcall getkey-func))
  5671. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  5672. tmp)
  5673. (error "Invalid key function `%s'" getkey-func)))
  5674. (t (error "Invalid sorting type `%c'" sorting-type)))))
  5675. nil
  5676. (cond
  5677. ((= dcst ?a) 'string<)
  5678. ((= dcst ?t) 'time-less-p)
  5679. ((= dcst ?f) compare-func)
  5680. ((= dcst ?p) '<)
  5681. (t nil)))))
  5682. (run-hooks 'org-after-sorting-entries-or-items-hook)
  5683. (message "Sorting entries...done")))
  5684. (defun org-do-sort (table what &optional with-case sorting-type)
  5685. "Sort TABLE of WHAT according to SORTING-TYPE.
  5686. The user will be prompted for the SORTING-TYPE if the call to this
  5687. function does not specify it. WHAT is only for the prompt, to indicate
  5688. what is being sorted. The sorting key will be extracted from
  5689. the car of the elements of the table.
  5690. If WITH-CASE is non-nil, the sorting will be case-sensitive."
  5691. (unless sorting-type
  5692. (message
  5693. "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
  5694. what)
  5695. (setq sorting-type (read-char-exclusive)))
  5696. (let ((dcst (downcase sorting-type))
  5697. extractfun comparefun)
  5698. ;; Define the appropriate functions
  5699. (cond
  5700. ((= dcst ?n)
  5701. (setq extractfun 'string-to-number
  5702. comparefun (if (= dcst sorting-type) '< '>)))
  5703. ((= dcst ?a)
  5704. (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
  5705. (lambda(x) (downcase (org-sort-remove-invisible x))))
  5706. comparefun (if (= dcst sorting-type)
  5707. 'string<
  5708. (lambda (a b) (and (not (string< a b))
  5709. (not (string= a b)))))))
  5710. ((= dcst ?t)
  5711. (setq extractfun
  5712. (lambda (x)
  5713. (if (or (string-match org-ts-regexp x)
  5714. (string-match org-ts-regexp-both x))
  5715. (time-to-seconds
  5716. (org-time-string-to-time (match-string 0 x)))
  5717. 0))
  5718. comparefun (if (= dcst sorting-type) '< '>)))
  5719. (t (error "Invalid sorting type `%c'" sorting-type)))
  5720. (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
  5721. table)
  5722. (lambda (a b) (funcall comparefun (car a) (car b))))))
  5723. ;;; Editing source examples
  5724. (defvar org-exit-edit-mode-map (make-sparse-keymap))
  5725. (define-key org-exit-edit-mode-map "\C-c'" 'org-edit-src-exit)
  5726. (defvar org-edit-src-force-single-line nil)
  5727. (defvar org-edit-src-from-org-mode nil)
  5728. (defvar org-edit-src-picture nil)
  5729. (defvar org-edit-src-beg-marker nil)
  5730. (defvar org-edit-src-end-marker nil)
  5731. (define-minor-mode org-exit-edit-mode
  5732. "Minor mode installing a single key binding, \"C-c '\" to exit special edit.")
  5733. (defun org-edit-src-code ()
  5734. "Edit the source code example at point.
  5735. The example is copied to a separate buffer, and that buffer is switched
  5736. to the correct language mode. When done, exit with \\[org-edit-src-exit].
  5737. This will remove the original code in the Org buffer, and replace it with
  5738. the edited version."
  5739. (interactive)
  5740. (let ((line (org-current-line))
  5741. (case-fold-search t)
  5742. (msg (substitute-command-keys
  5743. "Edit, then exit with C-c ' (C-c and single quote)"))
  5744. (info (org-edit-src-find-region-and-lang))
  5745. (org-mode-p (eq major-mode 'org-mode))
  5746. (beg (make-marker))
  5747. (end (make-marker))
  5748. ovl lang lang-f single lfmt code begline buffer)
  5749. (if (not info)
  5750. nil
  5751. (setq beg (move-marker beg (nth 0 info))
  5752. end (move-marker end (nth 1 info))
  5753. code (buffer-substring-no-properties beg end)
  5754. lang (nth 2 info)
  5755. single (nth 3 info)
  5756. lfmt (nth 4 info)
  5757. lang-f (intern (concat lang "-mode"))
  5758. begline (save-excursion (goto-char beg) (org-current-line)))
  5759. (unless (functionp lang-f)
  5760. (error "No such language mode: %s" lang-f))
  5761. (goto-line line)
  5762. (if (and (setq buffer (org-edit-src-find-buffer beg end))
  5763. (y-or-n-p "Return to existing edit buffer? [n] will revert changes: "))
  5764. (switch-to-buffer buffer)
  5765. (when buffer
  5766. (with-current-buffer buffer
  5767. (if (boundp 'org-edit-src-overlay)
  5768. (org-delete-overlay org-edit-src-overlay)))
  5769. (kill-buffer buffer))
  5770. (setq buffer (generate-new-buffer "*Org Edit Src Example*"))
  5771. (setq ovl (org-make-overlay beg end))
  5772. (org-overlay-put ovl 'face 'secondary-selection)
  5773. (org-overlay-put ovl 'edit-buffer buffer)
  5774. (org-overlay-put ovl 'help-echo "Click with mouse-1 to switch to buffer editing this segment")
  5775. (org-overlay-put ovl 'face 'secondary-selection)
  5776. (org-overlay-put ovl
  5777. 'keymap
  5778. (let ((map (make-sparse-keymap)))
  5779. (define-key map [mouse-1] 'org-edit-src-continue)
  5780. map))
  5781. (org-overlay-put ovl :read-only "Leave me alone")
  5782. (switch-to-buffer buffer)
  5783. (insert code)
  5784. (remove-text-properties (point-min) (point-max)
  5785. '(display nil invisible nil intangible nil))
  5786. (let ((org-inhibit-startup t))
  5787. (funcall lang-f))
  5788. (set (make-local-variable 'org-edit-src-force-single-line) single)
  5789. (set (make-local-variable 'org-edit-src-from-org-mode) org-mode-p)
  5790. (when lfmt
  5791. (set (make-local-variable 'org-coderef-label-format) lfmt))
  5792. (when org-mode-p
  5793. (goto-char (point-min))
  5794. (while (re-search-forward "^," nil t)
  5795. (replace-match "")))
  5796. (goto-line (1+ (- line begline)))
  5797. (org-exit-edit-mode)
  5798. (org-set-local 'org-edit-src-beg-marker beg)
  5799. (org-set-local 'org-edit-src-end-marker end)
  5800. (org-set-local 'org-edit-src-overlay ovl)
  5801. (and org-edit-src-persistent-message
  5802. (org-set-local 'header-line-format msg)))
  5803. (message "%s" msg)
  5804. t)))
  5805. (defun org-edit-src-continue (e)
  5806. (interactive "e")
  5807. (mouse-set-point e)
  5808. (let ((buf (get-char-property (point) 'edit-buffer)))
  5809. (if buf (switch-to-buffer buf)
  5810. (error "Something is wrong here"))))
  5811. (defun org-edit-src-find-buffer (beg end)
  5812. "Find a source editing buffer that is already editing the region BEG to END."
  5813. (catch 'exit
  5814. (mapc
  5815. (lambda (b)
  5816. (with-current-buffer b
  5817. (if (and (string-match "\\`*Org Edit " (buffer-name))
  5818. (local-variable-p 'org-edit-src-beg-marker (current-buffer))
  5819. (local-variable-p 'org-edit-src-end-marker (current-buffer))
  5820. (equal beg org-edit-src-beg-marker)
  5821. (equal end org-edit-src-end-marker))
  5822. (throw 'exit (current-buffer)))))
  5823. (buffer-list))
  5824. nil))
  5825. (defun org-edit-fixed-width-region ()
  5826. "Edit the fixed-width ascii drawing at point.
  5827. This must be a region where each line starts with a colon followed by
  5828. a space character.
  5829. An new buffer is created and the fixed-width region is copied into it,
  5830. and the buffer is switched into `artist-mode' for editing. When done,
  5831. exit with \\[org-edit-src-exit]. The edited text will then replace
  5832. the fragment in the Org-mode buffer."
  5833. (interactive)
  5834. (let ((line (org-current-line))
  5835. (case-fold-search t)
  5836. (msg (substitute-command-keys
  5837. "Edit, then exit with C-c ' (C-c and single quote)"))
  5838. (org-mode-p (eq major-mode 'org-mode))
  5839. (beg (make-marker))
  5840. (end (make-marker))
  5841. ovl beg1 end1 code begline buffer)
  5842. (beginning-of-line 1)
  5843. (if (looking-at "[ \t]*[^:\n \t]")
  5844. nil
  5845. (if (looking-at "[ \t]*\\(\n\\|\\'\\)")
  5846. (setq beg1 (point) end1 beg1)
  5847. (save-excursion
  5848. (if (re-search-backward "^[ \t]*[^:]" nil 'move)
  5849. (setq beg1 (point-at-bol 2))
  5850. (setq beg1 (point))))
  5851. (save-excursion
  5852. (if (re-search-forward "^[ \t]*[^:]" nil 'move)
  5853. (setq end1 (1- (match-beginning 0)))
  5854. (setq end1 (point))))
  5855. (goto-line line))
  5856. (setq beg (move-marker beg beg1)
  5857. end (move-marker end end1)
  5858. code (buffer-substring-no-properties beg end)
  5859. begline (save-excursion (goto-char beg) (org-current-line)))
  5860. (if (and (setq buffer (org-edit-src-find-buffer beg end))
  5861. (y-or-n-p "Return to existing edit buffer? [n] will revert changes: "))
  5862. (switch-to-buffer buffer)
  5863. (when buffer
  5864. (with-current-buffer buffer
  5865. (if (boundp 'org-edit-src-overlay)
  5866. (org-delete-overlay org-edit-src-overlay)))
  5867. (kill-buffer buffer))
  5868. (setq buffer (generate-new-buffer "*Org Edit Src Example*"))
  5869. (setq ovl (org-make-overlay beg end))
  5870. (org-overlay-put ovl 'face 'secondary-selection)
  5871. (org-overlay-put ovl 'edit-buffer buffer)
  5872. (org-overlay-put ovl 'help-echo "Click with mouse-1 to switch to buffer editing this segment")
  5873. (org-overlay-put ovl 'face 'secondary-selection)
  5874. (org-overlay-put ovl
  5875. 'keymap
  5876. (let ((map (make-sparse-keymap)))
  5877. (define-key map [mouse-1] 'org-edit-src-continue)
  5878. map))
  5879. (org-overlay-put ovl :read-only "Leave me alone")
  5880. (switch-to-buffer buffer)
  5881. (insert code)
  5882. (remove-text-properties (point-min) (point-max)
  5883. '(display nil invisible nil intangible nil))
  5884. (cond
  5885. ((eq org-edit-fixed-width-region-mode 'artist-mode)
  5886. (fundamental-mode)
  5887. (artist-mode 1))
  5888. (t (funcall org-edit-fixed-width-region-mode)))
  5889. (set (make-local-variable 'org-edit-src-force-single-line) nil)
  5890. (set (make-local-variable 'org-edit-src-from-org-mode) org-mode-p)
  5891. (set (make-local-variable 'org-edit-src-picture) t)
  5892. (goto-char (point-min))
  5893. (while (re-search-forward "^[ \t]*: ?" nil t)
  5894. (replace-match ""))
  5895. (goto-line (1+ (- line begline)))
  5896. (org-exit-edit-mode)
  5897. (org-set-local 'org-edit-src-beg-marker beg)
  5898. (org-set-local 'org-edit-src-end-marker end)
  5899. (org-set-local 'org-edit-src-overlay ovl)
  5900. (and org-edit-src-persistent-message
  5901. (org-set-local 'header-line-format msg)))
  5902. (message "%s" msg)
  5903. t)))
  5904. (defun org-edit-src-find-region-and-lang ()
  5905. "Find the region and language for a local edit.
  5906. Return a list with beginning and end of the region, a string representing
  5907. the language, a switch telling of the content should be in a single line."
  5908. (let ((re-list
  5909. (append
  5910. org-edit-src-region-extra
  5911. '(
  5912. ("<src\\>[^<]*>[ \t]*\n?" "\n?[ \t]*</src>" lang)
  5913. ("<literal\\>[^<]*>[ \t]*\n?" "\n?[ \t]*</literal>" style)
  5914. ("<example>[ \t]*\n?" "\n?[ \t]*</example>" "fundamental")
  5915. ("<lisp>[ \t]*\n?" "\n?[ \t]*</lisp>" "emacs-lisp")
  5916. ("<perl>[ \t]*\n?" "\n?[ \t]*</perl>" "perl")
  5917. ("<python>[ \t]*\n?" "\n?[ \t]*</python>" "python")
  5918. ("<ruby>[ \t]*\n?" "\n?[ \t]*</ruby>" "ruby")
  5919. ("^#\\+begin_src\\( \\([^ \t\n]+\\)\\)?.*\n" "\n#\\+end_src" 2)
  5920. ("^#\\+begin_example.*\n" "\n#\\+end_example" "fundamental")
  5921. ("^#\\+html:" "\n" "html" single-line)
  5922. ("^#\\+begin_html.*\n" "\n#\\+end_html" "html")
  5923. ("^#\\+begin_latex.*\n" "\n#\\+end_latex" "latex")
  5924. ("^#\\+latex:" "\n" "latex" single-line)
  5925. ("^#\\+begin_ascii.*\n" "\n#\\+end_ascii" "fundamental")
  5926. ("^#\\+ascii:" "\n" "ascii" single-line)
  5927. )))
  5928. (pos (point))
  5929. re1 re2 single beg end lang lfmt match-re1)
  5930. (catch 'exit
  5931. (while (setq entry (pop re-list))
  5932. (setq re1 (car entry) re2 (nth 1 entry) lang (nth 2 entry)
  5933. single (nth 3 entry))
  5934. (save-excursion
  5935. (if (or (looking-at re1)
  5936. (re-search-backward re1 nil t))
  5937. (progn
  5938. (setq match-re1 (match-string 0))
  5939. (setq beg (match-end 0)
  5940. lang (org-edit-src-get-lang lang)
  5941. lfmt (org-edit-src-get-label-format match-re1))
  5942. (if (and (re-search-forward re2 nil t)
  5943. (>= (match-end 0) pos))
  5944. (throw 'exit (list beg (match-beginning 0)
  5945. lang single lfmt))))
  5946. (if (or (looking-at re2)
  5947. (re-search-forward re2 nil t))
  5948. (progn
  5949. (setq end (match-beginning 0))
  5950. (if (and (re-search-backward re1 nil t)
  5951. (<= (match-beginning 0) pos))
  5952. (progn
  5953. (setq lfmt (org-edit-src-get-label-format
  5954. (match-string 0)))
  5955. (throw 'exit
  5956. (list (match-end 0) end
  5957. (org-edit-src-get-lang lang)
  5958. single lfmt))))))))))))
  5959. (defun org-edit-src-get-lang (lang)
  5960. "Extract the src language."
  5961. (let ((m (match-string 0)))
  5962. (cond
  5963. ((stringp lang) lang)
  5964. ((integerp lang) (match-string lang))
  5965. ((and (eq lang 'lang)
  5966. (string-match "\\<lang=\"\\([^ \t\n\"]+\\)\"" m))
  5967. (match-string 1 m))
  5968. ((and (eq lang 'style)
  5969. (string-match "\\<style=\"\\([^ \t\n\"]+\\)\"" m))
  5970. (match-string 1 m))
  5971. (t "fundamental"))))
  5972. (defun org-edit-src-get-label-format (s)
  5973. "Extract the label format."
  5974. (save-match-data
  5975. (if (string-match "-l[ \t]+\\\\?\"\\([^\t\r\n\"]+\\)\\\\?\"" s)
  5976. (match-string 1 s))))
  5977. (defun org-edit-src-exit ()
  5978. "Exit special edit and protect problematic lines."
  5979. (interactive)
  5980. (unless (string-match "\\`*Org Edit " (buffer-name (current-buffer)))
  5981. (error "This is not an sub-editing buffer, something is wrong..."))
  5982. (let ((line (if (org-bound-and-true-p org-edit-src-force-single-line)
  5983. 1
  5984. (org-current-line)))
  5985. (beg org-edit-src-beg-marker)
  5986. (end org-edit-src-end-marker)
  5987. (ovl org-edit-src-overlay)
  5988. (buffer (current-buffer))
  5989. code)
  5990. (goto-char (point-min))
  5991. (if (looking-at "[ \t\n]*\n") (replace-match ""))
  5992. (if (re-search-forward "\n[ \t\n]*\\'" nil t) (replace-match ""))
  5993. (when (org-bound-and-true-p org-edit-src-force-single-line)
  5994. (goto-char (point-min))
  5995. (while (re-search-forward "\n" nil t)
  5996. (replace-match " "))
  5997. (goto-char (point-min))
  5998. (if (looking-at "\\s-*") (replace-match " "))
  5999. (if (re-search-forward "\\s-+\\'" nil t)
  6000. (replace-match "")))
  6001. (when (org-bound-and-true-p org-edit-src-from-org-mode)
  6002. (goto-char (point-min))
  6003. (while (re-search-forward (if (org-mode-p) "^\\(.\\)" "^\\([*#]\\)") nil t)
  6004. (replace-match ",\\1"))
  6005. (when font-lock-mode
  6006. (font-lock-unfontify-region (point-min) (point-max)))
  6007. (put-text-property (point-min) (point-max) 'font-lock-fontified t))
  6008. (when (org-bound-and-true-p org-edit-src-picture)
  6009. (untabify (point-min) (point-max))
  6010. (goto-char (point-min))
  6011. (while (re-search-forward "^" nil t)
  6012. (replace-match ": "))
  6013. (when font-lock-mode
  6014. (font-lock-unfontify-region (point-min) (point-max)))
  6015. (put-text-property (point-min) (point-max) 'font-lock-fontified t))
  6016. (setq code (buffer-string))
  6017. (switch-to-buffer (marker-buffer beg))
  6018. (kill-buffer buffer)
  6019. (goto-char beg)
  6020. (org-delete-overlay ovl)
  6021. (delete-region beg end)
  6022. (insert code)
  6023. (goto-char beg)
  6024. (goto-line (1- (+ (org-current-line) line)))
  6025. (move-marker beg nil)
  6026. (move-marker end nil)))
  6027. ;;; The orgstruct minor mode
  6028. ;; Define a minor mode which can be used in other modes in order to
  6029. ;; integrate the org-mode structure editing commands.
  6030. ;; This is really a hack, because the org-mode structure commands use
  6031. ;; keys which normally belong to the major mode. Here is how it
  6032. ;; works: The minor mode defines all the keys necessary to operate the
  6033. ;; structure commands, but wraps the commands into a function which
  6034. ;; tests if the cursor is currently at a headline or a plain list
  6035. ;; item. If that is the case, the structure command is used,
  6036. ;; temporarily setting many Org-mode variables like regular
  6037. ;; expressions for filling etc. However, when any of those keys is
  6038. ;; used at a different location, function uses `key-binding' to look
  6039. ;; up if the key has an associated command in another currently active
  6040. ;; keymap (minor modes, major mode, global), and executes that
  6041. ;; command. There might be problems if any of the keys is otherwise
  6042. ;; used as a prefix key.
  6043. ;; Another challenge is that the key binding for TAB can be tab or \C-i,
  6044. ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
  6045. ;; addresses this by checking explicitly for both bindings.
  6046. (defvar orgstruct-mode-map (make-sparse-keymap)
  6047. "Keymap for the minor `orgstruct-mode'.")
  6048. (defvar org-local-vars nil
  6049. "List of local variables, for use by `orgstruct-mode'")
  6050. ;;;###autoload
  6051. (define-minor-mode orgstruct-mode
  6052. "Toggle the minor more `orgstruct-mode'.
  6053. This mode is for using Org-mode structure commands in other modes.
  6054. The following key behave as if Org-mode was active, if the cursor
  6055. is on a headline, or on a plain list item (both in the definition
  6056. of Org-mode).
  6057. M-up Move entry/item up
  6058. M-down Move entry/item down
  6059. M-left Promote
  6060. M-right Demote
  6061. M-S-up Move entry/item up
  6062. M-S-down Move entry/item down
  6063. M-S-left Promote subtree
  6064. M-S-right Demote subtree
  6065. M-q Fill paragraph and items like in Org-mode
  6066. C-c ^ Sort entries
  6067. C-c - Cycle list bullet
  6068. TAB Cycle item visibility
  6069. M-RET Insert new heading/item
  6070. S-M-RET Insert new TODO heading / Checkbox item
  6071. C-c C-c Set tags / toggle checkbox"
  6072. nil " OrgStruct" nil
  6073. (org-load-modules-maybe)
  6074. (and (orgstruct-setup) (defun orgstruct-setup () nil)))
  6075. ;;;###autoload
  6076. (defun turn-on-orgstruct ()
  6077. "Unconditionally turn on `orgstruct-mode'."
  6078. (orgstruct-mode 1))
  6079. (defun orgstruct++-mode (&optional arg)
  6080. "Toggle `orgstruct-mode', the enhanced version of it.
  6081. In addition to setting orgstruct-mode, this also exports all indentation and
  6082. autofilling variables from org-mode into the buffer. It will also
  6083. recognize item context in multiline items.
  6084. Note that turning off orgstruct-mode will *not* remove the
  6085. indentation/paragraph settings. This can only be done by refreshing the
  6086. major mode, for example with \[normal-mode]."
  6087. (interactive "P")
  6088. (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
  6089. (if (< arg 1)
  6090. (orgstruct-mode -1)
  6091. (orgstruct-mode 1)
  6092. (let (var val)
  6093. (mapc
  6094. (lambda (x)
  6095. (when (string-match
  6096. "^\\(paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
  6097. (symbol-name (car x)))
  6098. (setq var (car x) val (nth 1 x))
  6099. (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
  6100. org-local-vars)
  6101. (org-set-local 'orgstruct-is-++ t))))
  6102. (defvar orgstruct-is-++ nil
  6103. "Is orgstruct-mode in ++ version in the current-buffer?")
  6104. (make-variable-buffer-local 'orgstruct-is-++)
  6105. ;;;###autoload
  6106. (defun turn-on-orgstruct++ ()
  6107. "Unconditionally turn on `orgstruct++-mode'."
  6108. (orgstruct++-mode 1))
  6109. (defun orgstruct-error ()
  6110. "Error when there is no default binding for a structure key."
  6111. (interactive)
  6112. (error "This key has no function outside structure elements"))
  6113. (defun orgstruct-setup ()
  6114. "Setup orgstruct keymaps."
  6115. (let ((nfunc 0)
  6116. (bindings
  6117. (list
  6118. '([(meta up)] org-metaup)
  6119. '([(meta down)] org-metadown)
  6120. '([(meta left)] org-metaleft)
  6121. '([(meta right)] org-metaright)
  6122. '([(meta shift up)] org-shiftmetaup)
  6123. '([(meta shift down)] org-shiftmetadown)
  6124. '([(meta shift left)] org-shiftmetaleft)
  6125. '([(meta shift right)] org-shiftmetaright)
  6126. '([(shift up)] org-shiftup)
  6127. '([(shift down)] org-shiftdown)
  6128. '([(shift left)] org-shiftleft)
  6129. '([(shift right)] org-shiftright)
  6130. '("\C-c\C-c" org-ctrl-c-ctrl-c)
  6131. '("\M-q" fill-paragraph)
  6132. '("\C-c^" org-sort)
  6133. '("\C-c-" org-cycle-list-bullet)))
  6134. elt key fun cmd)
  6135. (while (setq elt (pop bindings))
  6136. (setq nfunc (1+ nfunc))
  6137. (setq key (org-key (car elt))
  6138. fun (nth 1 elt)
  6139. cmd (orgstruct-make-binding fun nfunc key))
  6140. (org-defkey orgstruct-mode-map key cmd))
  6141. ;; Special treatment needed for TAB and RET
  6142. (org-defkey orgstruct-mode-map [(tab)]
  6143. (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
  6144. (org-defkey orgstruct-mode-map "\C-i"
  6145. (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
  6146. (org-defkey orgstruct-mode-map "\M-\C-m"
  6147. (orgstruct-make-binding 'org-insert-heading 105
  6148. "\M-\C-m" [(meta return)]))
  6149. (org-defkey orgstruct-mode-map [(meta return)]
  6150. (orgstruct-make-binding 'org-insert-heading 106
  6151. [(meta return)] "\M-\C-m"))
  6152. (org-defkey orgstruct-mode-map [(shift meta return)]
  6153. (orgstruct-make-binding 'org-insert-todo-heading 107
  6154. [(meta return)] "\M-\C-m"))
  6155. (unless org-local-vars
  6156. (setq org-local-vars (org-get-local-variables)))
  6157. t))
  6158. (defun orgstruct-make-binding (fun n &rest keys)
  6159. "Create a function for binding in the structure minor mode.
  6160. FUN is the command to call inside a table. N is used to create a unique
  6161. command name. KEYS are keys that should be checked in for a command
  6162. to execute outside of tables."
  6163. (eval
  6164. (list 'defun
  6165. (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
  6166. '(arg)
  6167. (concat "In Structure, run `" (symbol-name fun) "'.\n"
  6168. "Outside of structure, run the binding of `"
  6169. (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
  6170. "'.")
  6171. '(interactive "p")
  6172. (list 'if
  6173. `(org-context-p 'headline 'item
  6174. (and orgstruct-is-++
  6175. ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
  6176. 'item-body))
  6177. (list 'org-run-like-in-org-mode (list 'quote fun))
  6178. (list 'let '(orgstruct-mode)
  6179. (list 'call-interactively
  6180. (append '(or)
  6181. (mapcar (lambda (k)
  6182. (list 'key-binding k))
  6183. keys)
  6184. '('orgstruct-error))))))))
  6185. (defun org-context-p (&rest contexts)
  6186. "Check if local context is any of CONTEXTS.
  6187. Possible values in the list of contexts are `table', `headline', and `item'."
  6188. (let ((pos (point)))
  6189. (goto-char (point-at-bol))
  6190. (prog1 (or (and (memq 'table contexts)
  6191. (looking-at "[ \t]*|"))
  6192. (and (memq 'headline contexts)
  6193. ;;????????? (looking-at "\\*+"))
  6194. (looking-at outline-regexp))
  6195. (and (memq 'item contexts)
  6196. (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
  6197. (and (memq 'item-body contexts)
  6198. (org-in-item-p)))
  6199. (goto-char pos))))
  6200. (defun org-get-local-variables ()
  6201. "Return a list of all local variables in an org-mode buffer."
  6202. (let (varlist)
  6203. (with-current-buffer (get-buffer-create "*Org tmp*")
  6204. (erase-buffer)
  6205. (org-mode)
  6206. (setq varlist (buffer-local-variables)))
  6207. (kill-buffer "*Org tmp*")
  6208. (delq nil
  6209. (mapcar
  6210. (lambda (x)
  6211. (setq x
  6212. (if (symbolp x)
  6213. (list x)
  6214. (list (car x) (list 'quote (cdr x)))))
  6215. (if (string-match
  6216. "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
  6217. (symbol-name (car x)))
  6218. x nil))
  6219. varlist))))
  6220. ;;;###autoload
  6221. (defun org-run-like-in-org-mode (cmd)
  6222. "Run a command, pretending that the current buffer is in Org-mode.
  6223. This will temporarily bind local variables that are typically bound in
  6224. Org-mode to the values they have in Org-mode, and then interactively
  6225. call CMD."
  6226. (org-load-modules-maybe)
  6227. (unless org-local-vars
  6228. (setq org-local-vars (org-get-local-variables)))
  6229. (eval (list 'let org-local-vars
  6230. (list 'call-interactively (list 'quote cmd)))))
  6231. ;;;; Archiving
  6232. (defun org-get-category (&optional pos)
  6233. "Get the category applying to position POS."
  6234. (get-text-property (or pos (point)) 'org-category))
  6235. (defun org-refresh-category-properties ()
  6236. "Refresh category text properties in the buffer."
  6237. (let ((def-cat (cond
  6238. ((null org-category)
  6239. (if buffer-file-name
  6240. (file-name-sans-extension
  6241. (file-name-nondirectory buffer-file-name))
  6242. "???"))
  6243. ((symbolp org-category) (symbol-name org-category))
  6244. (t org-category)))
  6245. beg end cat pos optionp)
  6246. (org-unmodified
  6247. (save-excursion
  6248. (save-restriction
  6249. (widen)
  6250. (goto-char (point-min))
  6251. (put-text-property (point) (point-max) 'org-category def-cat)
  6252. (while (re-search-forward
  6253. "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
  6254. (setq pos (match-end 0)
  6255. optionp (equal (char-after (match-beginning 0)) ?#)
  6256. cat (org-trim (match-string 2)))
  6257. (if optionp
  6258. (setq beg (point-at-bol) end (point-max))
  6259. (org-back-to-heading t)
  6260. (setq beg (point) end (org-end-of-subtree t t)))
  6261. (put-text-property beg end 'org-category cat)
  6262. (goto-char pos)))))))
  6263. ;;;; Link Stuff
  6264. ;;; Link abbreviations
  6265. (defun org-link-expand-abbrev (link)
  6266. "Apply replacements as defined in `org-link-abbrev-alist."
  6267. (if (string-match "^\\([a-zA-Z][-_a-zA-Z0-9]*\\)\\(::?\\(.*\\)\\)?$" link)
  6268. (let* ((key (match-string 1 link))
  6269. (as (or (assoc key org-link-abbrev-alist-local)
  6270. (assoc key org-link-abbrev-alist)))
  6271. (tag (and (match-end 2) (match-string 3 link)))
  6272. rpl)
  6273. (if (not as)
  6274. link
  6275. (setq rpl (cdr as))
  6276. (cond
  6277. ((symbolp rpl) (funcall rpl tag))
  6278. ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
  6279. ((string-match "%h" rpl)
  6280. (replace-match (url-hexify-string (or tag "")) t t rpl))
  6281. (t (concat rpl tag)))))
  6282. link))
  6283. ;;; Storing and inserting links
  6284. (defvar org-insert-link-history nil
  6285. "Minibuffer history for links inserted with `org-insert-link'.")
  6286. (defvar org-stored-links nil
  6287. "Contains the links stored with `org-store-link'.")
  6288. (defvar org-store-link-plist nil
  6289. "Plist with info about the most recently link created with `org-store-link'.")
  6290. (defvar org-link-protocols nil
  6291. "Link protocols added to Org-mode using `org-add-link-type'.")
  6292. (defvar org-store-link-functions nil
  6293. "List of functions that are called to create and store a link.
  6294. Each function will be called in turn until one returns a non-nil
  6295. value. Each function should check if it is responsible for creating
  6296. this link (for example by looking at the major mode).
  6297. If not, it must exit and return nil.
  6298. If yes, it should return a non-nil value after a calling
  6299. `org-store-link-props' with a list of properties and values.
  6300. Special properties are:
  6301. :type The link prefix. like \"http\". This must be given.
  6302. :link The link, like \"http://www.astro.uva.nl/~dominik\".
  6303. This is obligatory as well.
  6304. :description Optional default description for the second pair
  6305. of brackets in an Org-mode link. The user can still change
  6306. this when inserting this link into an Org-mode buffer.
  6307. In addition to these, any additional properties can be specified
  6308. and then used in remember templates.")
  6309. (defun org-add-link-type (type &optional follow export)
  6310. "Add TYPE to the list of `org-link-types'.
  6311. Re-compute all regular expressions depending on `org-link-types'
  6312. FOLLOW and EXPORT are two functions.
  6313. FOLLOW should take the link path as the single argument and do whatever
  6314. is necessary to follow the link, for example find a file or display
  6315. a mail message.
  6316. EXPORT should format the link path for export to one of the export formats.
  6317. It should be a function accepting three arguments:
  6318. path the path of the link, the text after the prefix (like \"http:\")
  6319. desc the description of the link, if any, nil if there was no description
  6320. format the export format, a symbol like `html' or `latex'.
  6321. The function may use the FORMAT information to return different values
  6322. depending on the format. The return value will be put literally into
  6323. the exported file.
  6324. Org-mode has a built-in default for exporting links. If you are happy with
  6325. this default, there is no need to define an export function for the link
  6326. type. For a simple example of an export function, see `org-bbdb.el'."
  6327. (add-to-list 'org-link-types type t)
  6328. (org-make-link-regexps)
  6329. (if (assoc type org-link-protocols)
  6330. (setcdr (assoc type org-link-protocols) (list follow export))
  6331. (push (list type follow export) org-link-protocols)))
  6332. ;;;###autoload
  6333. (defun org-store-link (arg)
  6334. "\\<org-mode-map>Store an org-link to the current location.
  6335. This link is added to `org-stored-links' and can later be inserted
  6336. into an org-buffer with \\[org-insert-link].
  6337. For some link types, a prefix arg is interpreted:
  6338. For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
  6339. For file links, arg negates `org-context-in-file-links'."
  6340. (interactive "P")
  6341. (org-load-modules-maybe)
  6342. (setq org-store-link-plist nil) ; reset
  6343. (let (link cpltxt desc description search txt custom-id)
  6344. (cond
  6345. ((run-hook-with-args-until-success 'org-store-link-functions)
  6346. (setq link (plist-get org-store-link-plist :link)
  6347. desc (or (plist-get org-store-link-plist :description) link)))
  6348. ((equal (buffer-name) "*Org Edit Src Example*")
  6349. (let (label gc)
  6350. (while (or (not label)
  6351. (save-excursion
  6352. (save-restriction
  6353. (widen)
  6354. (goto-char (point-min))
  6355. (re-search-forward
  6356. (regexp-quote (format org-coderef-label-format label))
  6357. nil t))))
  6358. (when label (message "Label exists already") (sit-for 2))
  6359. (setq label (read-string "Code line label: " label)))
  6360. (end-of-line 1)
  6361. (setq link (format org-coderef-label-format label))
  6362. (setq gc (- 79 (length link)))
  6363. (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
  6364. (insert link)
  6365. (setq link (concat "(" label ")") desc nil)))
  6366. ((eq major-mode 'calendar-mode)
  6367. (let ((cd (calendar-cursor-to-date)))
  6368. (setq link
  6369. (format-time-string
  6370. (car org-time-stamp-formats)
  6371. (apply 'encode-time
  6372. (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
  6373. nil nil nil))))
  6374. (org-store-link-props :type "calendar" :date cd)))
  6375. ((eq major-mode 'w3-mode)
  6376. (setq cpltxt (if (and (buffer-name)
  6377. (not (string-match "Untitled" (buffer-name))))
  6378. (buffer-name)
  6379. (url-view-url t))
  6380. link (org-make-link (url-view-url t)))
  6381. (org-store-link-props :type "w3" :url (url-view-url t)))
  6382. ((eq major-mode 'w3m-mode)
  6383. (setq cpltxt (or w3m-current-title w3m-current-url)
  6384. link (org-make-link w3m-current-url))
  6385. (org-store-link-props :type "w3m" :url (url-view-url t)))
  6386. ((setq search (run-hook-with-args-until-success
  6387. 'org-create-file-search-functions))
  6388. (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
  6389. "::" search))
  6390. (setq cpltxt (or description link)))
  6391. ((eq major-mode 'image-mode)
  6392. (setq cpltxt (concat "file:"
  6393. (abbreviate-file-name buffer-file-name))
  6394. link (org-make-link cpltxt))
  6395. (org-store-link-props :type "image" :file buffer-file-name))
  6396. ((eq major-mode 'dired-mode)
  6397. ;; link to the file in the current line
  6398. (setq cpltxt (concat "file:"
  6399. (abbreviate-file-name
  6400. (expand-file-name
  6401. (dired-get-filename nil t))))
  6402. link (org-make-link cpltxt)))
  6403. ((and buffer-file-name (org-mode-p))
  6404. (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
  6405. (cond
  6406. ((org-in-regexp "<<\\(.*?\\)>>")
  6407. (setq cpltxt
  6408. (concat "file:"
  6409. (abbreviate-file-name buffer-file-name)
  6410. "::" (match-string 1))
  6411. link (org-make-link cpltxt)))
  6412. ((and (featurep 'org-id)
  6413. (or (eq org-link-to-org-use-id t)
  6414. (and (eq org-link-to-org-use-id 'create-if-interactive)
  6415. (interactive-p))
  6416. (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
  6417. (interactive-p)
  6418. (not custom-id))
  6419. (and org-link-to-org-use-id
  6420. (condition-case nil
  6421. (org-entry-get nil "ID")
  6422. (error nil)))))
  6423. ;; We can make a link using the ID.
  6424. (setq link (condition-case nil
  6425. (prog1 (org-id-store-link)
  6426. (setq desc (plist-get org-store-link-plist
  6427. :description)))
  6428. (error
  6429. ;; probably before first headline, link to file only
  6430. (concat "file:"
  6431. (abbreviate-file-name buffer-file-name))))))
  6432. (t
  6433. ;; Just link to current headline
  6434. (setq cpltxt (concat "file:"
  6435. (abbreviate-file-name buffer-file-name)))
  6436. ;; Add a context search string
  6437. (when (org-xor org-context-in-file-links arg)
  6438. (setq txt (cond
  6439. ((org-on-heading-p) nil)
  6440. ((org-region-active-p)
  6441. (buffer-substring (region-beginning) (region-end)))
  6442. (t nil)))
  6443. (when (or (null txt) (string-match "\\S-" txt))
  6444. (setq cpltxt
  6445. (concat cpltxt "::"
  6446. (condition-case nil
  6447. (org-make-org-heading-search-string txt)
  6448. (error "")))
  6449. desc "NONE")))
  6450. (if (string-match "::\\'" cpltxt)
  6451. (setq cpltxt (substring cpltxt 0 -2)))
  6452. (setq link (org-make-link cpltxt)))))
  6453. ((buffer-file-name (buffer-base-buffer))
  6454. ;; Just link to this file here.
  6455. (setq cpltxt (concat "file:"
  6456. (abbreviate-file-name
  6457. (buffer-file-name (buffer-base-buffer)))))
  6458. ;; Add a context string
  6459. (when (org-xor org-context-in-file-links arg)
  6460. (setq txt (if (org-region-active-p)
  6461. (buffer-substring (region-beginning) (region-end))
  6462. (buffer-substring (point-at-bol) (point-at-eol))))
  6463. ;; Only use search option if there is some text.
  6464. (when (string-match "\\S-" txt)
  6465. (setq cpltxt
  6466. (concat cpltxt "::" (org-make-org-heading-search-string txt))
  6467. desc "NONE")))
  6468. (setq link (org-make-link cpltxt)))
  6469. ((interactive-p)
  6470. (error "Cannot link to a buffer which is not visiting a file"))
  6471. (t (setq link nil)))
  6472. (if (consp link) (setq cpltxt (car link) link (cdr link)))
  6473. (setq link (or link cpltxt)
  6474. desc (or desc cpltxt))
  6475. (if (equal desc "NONE") (setq desc nil))
  6476. (if (and (interactive-p) link)
  6477. (progn
  6478. (setq org-stored-links
  6479. (cons (list link desc) org-stored-links))
  6480. (message "Stored: %s" (or desc link))
  6481. (when custom-id
  6482. (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
  6483. "::#" custom-id))
  6484. (setq org-stored-links
  6485. (cons (list link desc) org-stored-links))))
  6486. (and link (org-make-link-string link desc)))))
  6487. (defun org-store-link-props (&rest plist)
  6488. "Store link properties, extract names and addresses."
  6489. (let (x adr)
  6490. (when (setq x (plist-get plist :from))
  6491. (setq adr (mail-extract-address-components x))
  6492. (setq plist (plist-put plist :fromname (car adr)))
  6493. (setq plist (plist-put plist :fromaddress (nth 1 adr))))
  6494. (when (setq x (plist-get plist :to))
  6495. (setq adr (mail-extract-address-components x))
  6496. (setq plist (plist-put plist :toname (car adr)))
  6497. (setq plist (plist-put plist :toaddress (nth 1 adr)))))
  6498. (let ((from (plist-get plist :from))
  6499. (to (plist-get plist :to)))
  6500. (when (and from to org-from-is-user-regexp)
  6501. (setq plist
  6502. (plist-put plist :fromto
  6503. (if (string-match org-from-is-user-regexp from)
  6504. (concat "to %t")
  6505. (concat "from %f"))))))
  6506. (setq org-store-link-plist plist))
  6507. (defun org-add-link-props (&rest plist)
  6508. "Add these properties to the link property list."
  6509. (let (key value)
  6510. (while plist
  6511. (setq key (pop plist) value (pop plist))
  6512. (setq org-store-link-plist
  6513. (plist-put org-store-link-plist key value)))))
  6514. (defun org-email-link-description (&optional fmt)
  6515. "Return the description part of an email link.
  6516. This takes information from `org-store-link-plist' and formats it
  6517. according to FMT (default from `org-email-link-description-format')."
  6518. (setq fmt (or fmt org-email-link-description-format))
  6519. (let* ((p org-store-link-plist)
  6520. (to (plist-get p :toaddress))
  6521. (from (plist-get p :fromaddress))
  6522. (table
  6523. (list
  6524. (cons "%c" (plist-get p :fromto))
  6525. (cons "%F" (plist-get p :from))
  6526. (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
  6527. (cons "%T" (plist-get p :to))
  6528. (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
  6529. (cons "%s" (plist-get p :subject))
  6530. (cons "%m" (plist-get p :message-id)))))
  6531. (when (string-match "%c" fmt)
  6532. ;; Check if the user wrote this message
  6533. (if (and org-from-is-user-regexp from to
  6534. (save-match-data (string-match org-from-is-user-regexp from)))
  6535. (setq fmt (replace-match "to %t" t t fmt))
  6536. (setq fmt (replace-match "from %f" t t fmt))))
  6537. (org-replace-escapes fmt table)))
  6538. (defun org-make-org-heading-search-string (&optional string heading)
  6539. "Make search string for STRING or current headline."
  6540. (interactive)
  6541. (let ((s (or string (org-get-heading))))
  6542. (unless (and string (not heading))
  6543. ;; We are using a headline, clean up garbage in there.
  6544. (if (string-match org-todo-regexp s)
  6545. (setq s (replace-match "" t t s)))
  6546. (if (string-match (org-re ":[[:alnum:]_@:]+:[ \t]*$") s)
  6547. (setq s (replace-match "" t t s)))
  6548. (setq s (org-trim s))
  6549. (if (string-match (concat "^\\(" org-quote-string "\\|"
  6550. org-comment-string "\\)") s)
  6551. (setq s (replace-match "" t t s)))
  6552. (while (string-match org-ts-regexp s)
  6553. (setq s (replace-match "" t t s))))
  6554. (while (string-match "[^a-zA-Z_0-9 \t]+" s)
  6555. (setq s (replace-match " " t t s)))
  6556. (or string (setq s (concat "*" s))) ; Add * for headlines
  6557. (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
  6558. (defun org-make-link (&rest strings)
  6559. "Concatenate STRINGS."
  6560. (apply 'concat strings))
  6561. (defun org-make-link-string (link &optional description)
  6562. "Make a link with brackets, consisting of LINK and DESCRIPTION."
  6563. (unless (string-match "\\S-" link)
  6564. (error "Empty link"))
  6565. (when (stringp description)
  6566. ;; Remove brackets from the description, they are fatal.
  6567. (while (string-match "\\[" description)
  6568. (setq description (replace-match "{" t t description)))
  6569. (while (string-match "\\]" description)
  6570. (setq description (replace-match "}" t t description))))
  6571. (when (equal (org-link-escape link) description)
  6572. ;; No description needed, it is identical
  6573. (setq description nil))
  6574. (when (and (not description)
  6575. (not (equal link (org-link-escape link))))
  6576. (setq description (org-extract-attributes link)))
  6577. (concat "[[" (org-link-escape link) "]"
  6578. (if description (concat "[" description "]") "")
  6579. "]"))
  6580. (defconst org-link-escape-chars
  6581. '((?\ . "%20")
  6582. (?\[ . "%5B")
  6583. (?\] . "%5D")
  6584. (?\340 . "%E0") ; `a
  6585. (?\342 . "%E2") ; ^a
  6586. (?\347 . "%E7") ; ,c
  6587. (?\350 . "%E8") ; `e
  6588. (?\351 . "%E9") ; 'e
  6589. (?\352 . "%EA") ; ^e
  6590. (?\356 . "%EE") ; ^i
  6591. (?\364 . "%F4") ; ^o
  6592. (?\371 . "%F9") ; `u
  6593. (?\373 . "%FB") ; ^u
  6594. (?\; . "%3B")
  6595. (?? . "%3F")
  6596. (?= . "%3D")
  6597. (?+ . "%2B")
  6598. )
  6599. "Association list of escapes for some characters problematic in links.
  6600. This is the list that is used for internal purposes.")
  6601. (defvar org-url-encoding-use-url-hexify nil)
  6602. (defconst org-link-escape-chars-browser
  6603. '((?\ . "%20")) ; 32 for the SPC char
  6604. "Association list of escapes for some characters problematic in links.
  6605. This is the list that is used before handing over to the browser.")
  6606. (defun org-link-escape (text &optional table)
  6607. "Escape characters in TEXT that are problematic for links."
  6608. (if org-url-encoding-use-url-hexify
  6609. (url-hexify-string text)
  6610. (setq table (or table org-link-escape-chars))
  6611. (when text
  6612. (let ((re (mapconcat (lambda (x) (regexp-quote
  6613. (char-to-string (car x))))
  6614. table "\\|")))
  6615. (while (string-match re text)
  6616. (setq text
  6617. (replace-match
  6618. (cdr (assoc (string-to-char (match-string 0 text))
  6619. table))
  6620. t t text)))
  6621. text))))
  6622. (defun org-link-unescape (text &optional table)
  6623. "Reverse the action of `org-link-escape'."
  6624. (if org-url-encoding-use-url-hexify
  6625. (url-unhex-string text)
  6626. (setq table (or table org-link-escape-chars))
  6627. (when text
  6628. (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
  6629. table "\\|")))
  6630. (while (string-match re text)
  6631. (setq text
  6632. (replace-match
  6633. (char-to-string (car (rassoc (match-string 0 text) table)))
  6634. t t text)))
  6635. text))))
  6636. (defun org-xor (a b)
  6637. "Exclusive or."
  6638. (if a (not b) b))
  6639. (defun org-fixup-message-id-for-http (s)
  6640. "Replace special characters in a message id, so it can be used in an http query."
  6641. (while (string-match "<" s)
  6642. (setq s (replace-match "%3C" t t s)))
  6643. (while (string-match ">" s)
  6644. (setq s (replace-match "%3E" t t s)))
  6645. (while (string-match "@" s)
  6646. (setq s (replace-match "%40" t t s)))
  6647. s)
  6648. ;;;###autoload
  6649. (defun org-insert-link-global ()
  6650. "Insert a link like Org-mode does.
  6651. This command can be called in any mode to insert a link in Org-mode syntax."
  6652. (interactive)
  6653. (org-load-modules-maybe)
  6654. (org-run-like-in-org-mode 'org-insert-link))
  6655. (defun org-insert-link (&optional complete-file link-location)
  6656. "Insert a link. At the prompt, enter the link.
  6657. Completion can be used to insert any of the link protocol prefixes like
  6658. http or ftp in use.
  6659. The history can be used to select a link previously stored with
  6660. `org-store-link'. When the empty string is entered (i.e. if you just
  6661. press RET at the prompt), the link defaults to the most recently
  6662. stored link. As SPC triggers completion in the minibuffer, you need to
  6663. use M-SPC or C-q SPC to force the insertion of a space character.
  6664. You will also be prompted for a description, and if one is given, it will
  6665. be displayed in the buffer instead of the link.
  6666. If there is already a link at point, this command will allow you to edit link
  6667. and description parts.
  6668. With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
  6669. be selected using completion. The path to the file will be relative to the
  6670. current directory if the file is in the current directory or a subdirectory.
  6671. Otherwise, the link will be the absolute path as completed in the minibuffer
  6672. \(i.e. normally ~/path/to/file). You can configure this behavior using the
  6673. option `org-link-file-path-type'.
  6674. With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
  6675. the current directory or below.
  6676. With three \\[universal-argument] prefixes, negate the meaning of
  6677. `org-keep-stored-link-after-insertion'.
  6678. If `org-make-link-description-function' is non-nil, this function will be
  6679. called with the link target, and the result will be the default
  6680. link description.
  6681. If the LINK-LOCATION parameter is non-nil, this value will be
  6682. used as the link location instead of reading one interactively."
  6683. (interactive "P")
  6684. (let* ((wcf (current-window-configuration))
  6685. (region (if (org-region-active-p)
  6686. (buffer-substring (region-beginning) (region-end))))
  6687. (remove (and region (list (region-beginning) (region-end))))
  6688. (desc region)
  6689. tmphist ; byte-compile incorrectly complains about this
  6690. (link link-location)
  6691. entry file all-prefixes)
  6692. (cond
  6693. (link-location) ; specified by arg, just use it.
  6694. ((org-in-regexp org-bracket-link-regexp 1)
  6695. ;; We do have a link at point, and we are going to edit it.
  6696. (setq remove (list (match-beginning 0) (match-end 0)))
  6697. (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
  6698. (setq link (read-string "Link: "
  6699. (org-link-unescape
  6700. (org-match-string-no-properties 1)))))
  6701. ((or (org-in-regexp org-angle-link-re)
  6702. (org-in-regexp org-plain-link-re))
  6703. ;; Convert to bracket link
  6704. (setq remove (list (match-beginning 0) (match-end 0))
  6705. link (read-string "Link: "
  6706. (org-remove-angle-brackets (match-string 0)))))
  6707. ((member complete-file '((4) (16)))
  6708. ;; Completing read for file names.
  6709. (setq link (org-file-complete-link complete-file)))
  6710. (t
  6711. ;; Read link, with completion for stored links.
  6712. (with-output-to-temp-buffer "*Org Links*"
  6713. (princ "Insert a link.
  6714. Use TAB to complete link prefixes, then RET for type-specific completion support\n")
  6715. (when org-stored-links
  6716. (princ "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
  6717. (princ (mapconcat
  6718. (lambda (x)
  6719. (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
  6720. (reverse org-stored-links) "\n"))))
  6721. (let ((cw (selected-window)))
  6722. (select-window (get-buffer-window "*Org Links*"))
  6723. (setq truncate-lines t)
  6724. (unless (pos-visible-in-window-p (point-max))
  6725. (org-fit-window-to-buffer))
  6726. (and (window-live-p cw) (select-window cw)))
  6727. ;; Fake a link history, containing the stored links.
  6728. (setq tmphist (append (mapcar 'car org-stored-links)
  6729. org-insert-link-history))
  6730. (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
  6731. (mapcar 'car org-link-abbrev-alist)
  6732. org-link-types))
  6733. (unwind-protect
  6734. (progn
  6735. (setq link
  6736. (let ((org-completion-use-ido nil))
  6737. (org-completing-read
  6738. "Link: "
  6739. (mapcar (lambda (x) (list (concat x ":")))
  6740. all-prefixes)
  6741. nil nil nil
  6742. 'tmphist
  6743. (or (car (car org-stored-links))))))
  6744. (if (or (member link all-prefixes)
  6745. (and (equal ":" (substring link -1))
  6746. (member (substring link 0 -1) all-prefixes)
  6747. (setq link (substring link 0 -1))))
  6748. (setq link (org-link-try-special-completion link))))
  6749. (set-window-configuration wcf)
  6750. (kill-buffer "*Org Links*"))
  6751. (setq entry (assoc link org-stored-links))
  6752. (or entry (push link org-insert-link-history))
  6753. (if (funcall (if (equal complete-file '(64)) 'not 'identity)
  6754. (not org-keep-stored-link-after-insertion))
  6755. (setq org-stored-links (delq (assoc link org-stored-links)
  6756. org-stored-links)))
  6757. (setq desc (or desc (nth 1 entry)))))
  6758. (if (string-match org-plain-link-re link)
  6759. ;; URL-like link, normalize the use of angular brackets.
  6760. (setq link (org-make-link (org-remove-angle-brackets link))))
  6761. ;; Check if we are linking to the current file with a search option
  6762. ;; If yes, simplify the link by using only the search option.
  6763. (when (and buffer-file-name
  6764. (string-match "^file:\\(.+?\\)::\\([^>]+\\)" link))
  6765. (let* ((path (match-string 1 link))
  6766. (case-fold-search nil)
  6767. (search (match-string 2 link)))
  6768. (save-match-data
  6769. (if (equal (file-truename buffer-file-name) (file-truename path))
  6770. ;; We are linking to this same file, with a search option
  6771. (setq link search)))))
  6772. ;; Check if we can/should use a relative path. If yes, simplify the link
  6773. (when (string-match "^file:\\(.*\\)" link)
  6774. (let* ((path (match-string 1 link))
  6775. (origpath path)
  6776. (case-fold-search nil))
  6777. (cond
  6778. ((or (eq org-link-file-path-type 'absolute)
  6779. (equal complete-file '(16)))
  6780. (setq path (abbreviate-file-name (expand-file-name path))))
  6781. ((eq org-link-file-path-type 'noabbrev)
  6782. (setq path (expand-file-name path)))
  6783. ((eq org-link-file-path-type 'relative)
  6784. (setq path (file-relative-name path)))
  6785. (t
  6786. (save-match-data
  6787. (if (string-match (concat "^" (regexp-quote
  6788. (file-name-as-directory
  6789. (expand-file-name "."))))
  6790. (expand-file-name path))
  6791. ;; We are linking a file with relative path name.
  6792. (setq path (substring (expand-file-name path)
  6793. (match-end 0)))
  6794. (setq path (abbreviate-file-name (expand-file-name path)))))))
  6795. (setq link (concat "file:" path))
  6796. (if (equal desc origpath)
  6797. (setq desc path))))
  6798. (if org-make-link-description-function
  6799. (setq desc (funcall org-make-link-description-function link desc)))
  6800. (setq desc (read-string "Description: " desc))
  6801. (unless (string-match "\\S-" desc) (setq desc nil))
  6802. (if remove (apply 'delete-region remove))
  6803. (insert (org-make-link-string link desc))))
  6804. (defun org-link-try-special-completion (type)
  6805. "If there is completion support for link type TAPE, offer it."
  6806. (let ((fun (intern (concat "org-" type "-complete-link"))))
  6807. (if (functionp fun)
  6808. (funcall fun)
  6809. (read-string "Link (no completion support): " (concat type ":")))))
  6810. (defun org-file-complete-link (&optional arg)
  6811. "Create a file link using completion."
  6812. (let (file link)
  6813. (setq file (read-file-name "File: "))
  6814. (let ((pwd (file-name-as-directory (expand-file-name ".")))
  6815. (pwd1 (file-name-as-directory (abbreviate-file-name
  6816. (expand-file-name ".")))))
  6817. (cond
  6818. ((equal arg '(16))
  6819. (setq link (org-make-link
  6820. "file:"
  6821. (abbreviate-file-name (expand-file-name file)))))
  6822. ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
  6823. (setq link (org-make-link "file:" (match-string 1 file))))
  6824. ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
  6825. (expand-file-name file))
  6826. (setq link (org-make-link
  6827. "file:" (match-string 1 (expand-file-name file)))))
  6828. (t (setq link (org-make-link "file:" file)))))
  6829. link))
  6830. (defun org-completing-read (&rest args)
  6831. "Completing-read with SPACE being a normal character."
  6832. (let ((minibuffer-local-completion-map
  6833. (copy-keymap minibuffer-local-completion-map)))
  6834. (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
  6835. (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
  6836. (apply 'org-ido-completing-read args)))
  6837. (defun org-completing-read-no-ido (&rest args)
  6838. (let (org-completion-use-ido)
  6839. (apply 'org-completing-read args)))
  6840. (defun org-ido-completing-read (&rest args)
  6841. "Completing-read using `ido-mode' speedups if available"
  6842. (if (and org-completion-use-ido
  6843. (fboundp 'ido-completing-read)
  6844. (boundp 'ido-mode) ido-mode
  6845. (listp (second args)))
  6846. (let ((ido-enter-matching-directory nil))
  6847. (apply 'ido-completing-read (concat (car args))
  6848. (mapcar (lambda (x) (car x)) (nth 1 args))
  6849. (cddr args)))
  6850. (apply 'completing-read args)))
  6851. (defun org-extract-attributes (s)
  6852. "Extract the attributes cookie from a string and set as text property."
  6853. (let (a attr (start 0) key value)
  6854. (save-match-data
  6855. (when (string-match "{{\\([^}]+\\)}}$" s)
  6856. (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
  6857. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
  6858. (setq key (match-string 1 a) value (match-string 2 a)
  6859. start (match-end 0)
  6860. attr (plist-put attr (intern key) value))))
  6861. (org-add-props s nil 'org-attr attr))
  6862. s))
  6863. (defun org-extract-attributes-from-string (tag)
  6864. (let (key value attr)
  6865. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"\\s-?" tag)
  6866. (setq key (match-string 1 tag) value (match-string 2 tag)
  6867. tag (replace-match "" t t tag)
  6868. attr (plist-put attr (intern key) value)))
  6869. (cons tag attr)))
  6870. (defun org-attributes-to-string (plist)
  6871. "Format a property list into an HTML attribute list."
  6872. (let ((s "") key value)
  6873. (while plist
  6874. (setq key (pop plist) value (pop plist))
  6875. (and value
  6876. (setq s (concat s " " (symbol-name key) "=\"" value "\""))))
  6877. s))
  6878. ;;; Opening/following a link
  6879. (defvar org-link-search-failed nil)
  6880. (defun org-next-link ()
  6881. "Move forward to the next link.
  6882. If the link is in hidden text, expose it."
  6883. (interactive)
  6884. (when (and org-link-search-failed (eq this-command last-command))
  6885. (goto-char (point-min))
  6886. (message "Link search wrapped back to beginning of buffer"))
  6887. (setq org-link-search-failed nil)
  6888. (let* ((pos (point))
  6889. (ct (org-context))
  6890. (a (assoc :link ct)))
  6891. (if a (goto-char (nth 2 a)))
  6892. (if (re-search-forward org-any-link-re nil t)
  6893. (progn
  6894. (goto-char (match-beginning 0))
  6895. (if (org-invisible-p) (org-show-context)))
  6896. (goto-char pos)
  6897. (setq org-link-search-failed t)
  6898. (error "No further link found"))))
  6899. (defun org-previous-link ()
  6900. "Move backward to the previous link.
  6901. If the link is in hidden text, expose it."
  6902. (interactive)
  6903. (when (and org-link-search-failed (eq this-command last-command))
  6904. (goto-char (point-max))
  6905. (message "Link search wrapped back to end of buffer"))
  6906. (setq org-link-search-failed nil)
  6907. (let* ((pos (point))
  6908. (ct (org-context))
  6909. (a (assoc :link ct)))
  6910. (if a (goto-char (nth 1 a)))
  6911. (if (re-search-backward org-any-link-re nil t)
  6912. (progn
  6913. (goto-char (match-beginning 0))
  6914. (if (org-invisible-p) (org-show-context)))
  6915. (goto-char pos)
  6916. (setq org-link-search-failed t)
  6917. (error "No further link found"))))
  6918. (defun org-translate-link (s)
  6919. "Translate a link string if a translation function has been defined."
  6920. (if (and org-link-translation-function
  6921. (fboundp org-link-translation-function)
  6922. (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
  6923. (progn
  6924. (setq s (funcall org-link-translation-function
  6925. (match-string 1) (match-string 2)))
  6926. (concat (car s) ":" (cdr s)))
  6927. s))
  6928. (defun org-translate-link-from-planner (type path)
  6929. "Translate a link from Emacs Planner syntax so that Org can follow it.
  6930. This is still an experimental function, your mileage may vary."
  6931. (cond
  6932. ((member type '("http" "https" "news" "ftp"))
  6933. ;; standard Internet links are the same.
  6934. nil)
  6935. ((and (equal type "irc") (string-match "^//" path))
  6936. ;; Planner has two / at the beginning of an irc link, we have 1.
  6937. ;; We should have zero, actually....
  6938. (setq path (substring path 1)))
  6939. ((and (equal type "lisp") (string-match "^/" path))
  6940. ;; Planner has a slash, we do not.
  6941. (setq type "elisp" path (substring path 1)))
  6942. ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
  6943. ;; A typical message link. Planner has the id after the fina slash,
  6944. ;; we separate it with a hash mark
  6945. (setq path (concat (match-string 1 path) "#"
  6946. (org-remove-angle-brackets (match-string 2 path)))))
  6947. )
  6948. (cons type path))
  6949. (defun org-find-file-at-mouse (ev)
  6950. "Open file link or URL at mouse."
  6951. (interactive "e")
  6952. (mouse-set-point ev)
  6953. (org-open-at-point 'in-emacs))
  6954. (defun org-open-at-mouse (ev)
  6955. "Open file link or URL at mouse."
  6956. (interactive "e")
  6957. (mouse-set-point ev)
  6958. (if (eq major-mode 'org-agenda-mode)
  6959. (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
  6960. (org-open-at-point))
  6961. (defvar org-window-config-before-follow-link nil
  6962. "The window configuration before following a link.
  6963. This is saved in case the need arises to restore it.")
  6964. (defvar org-open-link-marker (make-marker)
  6965. "Marker pointing to the location where `org-open-at-point; was called.")
  6966. ;;;###autoload
  6967. (defun org-open-at-point-global ()
  6968. "Follow a link like Org-mode does.
  6969. This command can be called in any mode to follow a link that has
  6970. Org-mode syntax."
  6971. (interactive)
  6972. (org-run-like-in-org-mode 'org-open-at-point))
  6973. ;;;###autoload
  6974. (defun org-open-link-from-string (s &optional arg)
  6975. "Open a link in the string S, as if it was in Org-mode."
  6976. (interactive "sLink: \nP")
  6977. (let ((reference-buffer (current-buffer)))
  6978. (with-temp-buffer
  6979. (let ((org-inhibit-startup t))
  6980. (org-mode)
  6981. (insert s)
  6982. (goto-char (point-min))
  6983. (org-open-at-point arg reference-buffer)))))
  6984. (defun org-open-at-point (&optional in-emacs reference-buffer)
  6985. "Open link at or after point.
  6986. If there is no link at point, this function will search forward up to
  6987. the end of the current line.
  6988. Normally, files will be opened by an appropriate application. If the
  6989. optional argument IN-EMACS is non-nil, Emacs will visit the file.
  6990. With a double prefix argument, try to open outside of Emacs, in the
  6991. application the system uses for this file type."
  6992. (interactive "P")
  6993. (org-load-modules-maybe)
  6994. (move-marker org-open-link-marker (point))
  6995. (setq org-window-config-before-follow-link (current-window-configuration))
  6996. (org-remove-occur-highlights nil nil t)
  6997. (cond
  6998. ((org-at-timestamp-p t) (org-follow-timestamp-link))
  6999. ((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
  7000. (org-footnote-action))
  7001. (t
  7002. (let (type path link line search (pos (point)))
  7003. (catch 'match
  7004. (save-excursion
  7005. (skip-chars-forward "^]\n\r")
  7006. (when (org-in-regexp org-bracket-link-regexp)
  7007. (setq link (org-extract-attributes
  7008. (org-link-unescape (org-match-string-no-properties 1))))
  7009. (while (string-match " *\n *" link)
  7010. (setq link (replace-match " " t t link)))
  7011. (setq link (org-link-expand-abbrev link))
  7012. (cond
  7013. ((or (file-name-absolute-p link)
  7014. (string-match "^\\.\\.?/" link))
  7015. (setq type "file" path link))
  7016. ((string-match org-link-re-with-space3 link)
  7017. (setq type (match-string 1 link) path (match-string 2 link)))
  7018. (t (setq type "thisfile" path link)))
  7019. (throw 'match t)))
  7020. (when (get-text-property (point) 'org-linked-text)
  7021. (setq type "thisfile"
  7022. pos (if (get-text-property (1+ (point)) 'org-linked-text)
  7023. (1+ (point)) (point))
  7024. path (buffer-substring
  7025. (previous-single-property-change pos 'org-linked-text)
  7026. (next-single-property-change pos 'org-linked-text)))
  7027. (throw 'match t))
  7028. (save-excursion
  7029. (when (or (org-in-regexp org-angle-link-re)
  7030. (org-in-regexp org-plain-link-re))
  7031. (setq type (match-string 1) path (match-string 2))
  7032. (throw 'match t)))
  7033. (save-excursion
  7034. (when (org-in-regexp (org-re "\\(:[[:alnum:]_@:]+\\):[ \t]*$"))
  7035. (setq type "tags"
  7036. path (match-string 1))
  7037. (while (string-match ":" path)
  7038. (setq path (replace-match "+" t t path)))
  7039. (throw 'match t)))
  7040. (when (org-in-regexp "<\\([^><\n]+\\)>")
  7041. (setq type "tree-match"
  7042. path (match-string 1))
  7043. (throw 'match t)))
  7044. (unless path
  7045. (error "No link found"))
  7046. ;; switch back to reference buffer
  7047. ;; needed when if called in a temporary buffer through
  7048. ;; org-open-link-from-string
  7049. (and reference-buffer (switch-to-buffer reference-buffer))
  7050. ;; Remove any trailing spaces in path
  7051. (if (string-match " +\\'" path)
  7052. (setq path (replace-match "" t t path)))
  7053. (if (and org-link-translation-function
  7054. (fboundp org-link-translation-function))
  7055. ;; Check if we need to translate the link
  7056. (let ((tmp (funcall org-link-translation-function type path)))
  7057. (setq type (car tmp) path (cdr tmp))))
  7058. (cond
  7059. ((assoc type org-link-protocols)
  7060. (funcall (nth 1 (assoc type org-link-protocols)) path))
  7061. ((equal type "mailto")
  7062. (let ((cmd (car org-link-mailto-program))
  7063. (args (cdr org-link-mailto-program)) args1
  7064. (address path) (subject "") a)
  7065. (if (string-match "\\(.*\\)::\\(.*\\)" path)
  7066. (setq address (match-string 1 path)
  7067. subject (org-link-escape (match-string 2 path))))
  7068. (while args
  7069. (cond
  7070. ((not (stringp (car args))) (push (pop args) args1))
  7071. (t (setq a (pop args))
  7072. (if (string-match "%a" a)
  7073. (setq a (replace-match address t t a)))
  7074. (if (string-match "%s" a)
  7075. (setq a (replace-match subject t t a)))
  7076. (push a args1))))
  7077. (apply cmd (nreverse args1))))
  7078. ((member type '("http" "https" "ftp" "news"))
  7079. (browse-url (concat type ":" (org-link-escape
  7080. path org-link-escape-chars-browser))))
  7081. ((member type '("message"))
  7082. (browse-url (concat type ":" path)))
  7083. ((string= type "tags")
  7084. (org-tags-view in-emacs path))
  7085. ((string= type "thisfile")
  7086. (if in-emacs
  7087. (switch-to-buffer-other-window
  7088. (org-get-buffer-for-internal-link (current-buffer)))
  7089. (org-mark-ring-push))
  7090. (let ((cmd `(org-link-search
  7091. ,path
  7092. ,(cond ((equal in-emacs '(4)) 'occur)
  7093. ((equal in-emacs '(16)) 'org-occur)
  7094. (t nil))
  7095. ,pos)))
  7096. (condition-case nil (eval cmd)
  7097. (error (progn (widen) (eval cmd))))))
  7098. ((string= type "tree-match")
  7099. (org-occur (concat "\\[" (regexp-quote path) "\\]")))
  7100. ((string= type "file")
  7101. (if (string-match "::\\([0-9]+\\)\\'" path)
  7102. (setq line (string-to-number (match-string 1 path))
  7103. path (substring path 0 (match-beginning 0)))
  7104. (if (string-match "::\\(.+\\)\\'" path)
  7105. (setq search (match-string 1 path)
  7106. path (substring path 0 (match-beginning 0)))))
  7107. (if (string-match "[*?{]" (file-name-nondirectory path))
  7108. (dired path)
  7109. (org-open-file path in-emacs line search)))
  7110. ((string= type "news")
  7111. (require 'org-gnus)
  7112. (org-gnus-follow-link path))
  7113. ((string= type "shell")
  7114. (let ((cmd path))
  7115. (if (or (not org-confirm-shell-link-function)
  7116. (funcall org-confirm-shell-link-function
  7117. (format "Execute \"%s\" in shell? "
  7118. (org-add-props cmd nil
  7119. 'face 'org-warning))))
  7120. (progn
  7121. (message "Executing %s" cmd)
  7122. (shell-command cmd))
  7123. (error "Abort"))))
  7124. ((string= type "elisp")
  7125. (let ((cmd path))
  7126. (if (or (not org-confirm-elisp-link-function)
  7127. (funcall org-confirm-elisp-link-function
  7128. (format "Execute \"%s\" as elisp? "
  7129. (org-add-props cmd nil
  7130. 'face 'org-warning))))
  7131. (message "%s => %s" cmd
  7132. (if (equal (string-to-char cmd) ?\()
  7133. (eval (read cmd))
  7134. (call-interactively (read cmd))))
  7135. (error "Abort"))))
  7136. (t
  7137. (browse-url-at-point))))))
  7138. (move-marker org-open-link-marker nil)
  7139. (run-hook-with-args 'org-follow-link-hook))
  7140. ;;;; Time estimates
  7141. (defun org-get-effort (&optional pom)
  7142. "Get the effort estimate for the current entry."
  7143. (org-entry-get pom org-effort-property))
  7144. ;;; File search
  7145. (defvar org-create-file-search-functions nil
  7146. "List of functions to construct the right search string for a file link.
  7147. These functions are called in turn with point at the location to
  7148. which the link should point.
  7149. A function in the hook should first test if it would like to
  7150. handle this file type, for example by checking the major-mode or
  7151. the file extension. If it decides not to handle this file, it
  7152. should just return nil to give other functions a chance. If it
  7153. does handle the file, it must return the search string to be used
  7154. when following the link. The search string will be part of the
  7155. file link, given after a double colon, and `org-open-at-point'
  7156. will automatically search for it. If special measures must be
  7157. taken to make the search successful, another function should be
  7158. added to the companion hook `org-execute-file-search-functions',
  7159. which see.
  7160. A function in this hook may also use `setq' to set the variable
  7161. `description' to provide a suggestion for the descriptive text to
  7162. be used for this link when it gets inserted into an Org-mode
  7163. buffer with \\[org-insert-link].")
  7164. (defvar org-execute-file-search-functions nil
  7165. "List of functions to execute a file search triggered by a link.
  7166. Functions added to this hook must accept a single argument, the
  7167. search string that was part of the file link, the part after the
  7168. double colon. The function must first check if it would like to
  7169. handle this search, for example by checking the major-mode or the
  7170. file extension. If it decides not to handle this search, it
  7171. should just return nil to give other functions a chance. If it
  7172. does handle the search, it must return a non-nil value to keep
  7173. other functions from trying.
  7174. Each function can access the current prefix argument through the
  7175. variable `current-prefix-argument'. Note that a single prefix is
  7176. used to force opening a link in Emacs, so it may be good to only
  7177. use a numeric or double prefix to guide the search function.
  7178. In case this is needed, a function in this hook can also restore
  7179. the window configuration before `org-open-at-point' was called using:
  7180. (set-window-configuration org-window-config-before-follow-link)")
  7181. (defun org-link-search (s &optional type avoid-pos)
  7182. "Search for a link search option.
  7183. If S is surrounded by forward slashes, it is interpreted as a
  7184. regular expression. In org-mode files, this will create an `org-occur'
  7185. sparse tree. In ordinary files, `occur' will be used to list matches.
  7186. If the current buffer is in `dired-mode', grep will be used to search
  7187. in all files. If AVOID-POS is given, ignore matches near that position."
  7188. (let ((case-fold-search t)
  7189. (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
  7190. (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
  7191. (append '(("") (" ") ("\t") ("\n"))
  7192. org-emphasis-alist)
  7193. "\\|") "\\)"))
  7194. (pos (point))
  7195. (pre nil) (post nil)
  7196. words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
  7197. (cond
  7198. ;; First check if there are any special
  7199. ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
  7200. ;; Now try the builtin stuff
  7201. ((and (equal (string-to-char s0) ?#)
  7202. (> (length s0) 1)
  7203. (save-excursion
  7204. (goto-char (point-min))
  7205. (and
  7206. (re-search-forward
  7207. (concat "^[ \t]*:CUSTOM_ID:[ \t]+" (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
  7208. (setq type 'dedicated
  7209. pos (match-beginning 0))))
  7210. ;; There is an exact target for this
  7211. (goto-char pos)
  7212. (org-back-to-heading t)))
  7213. ((save-excursion
  7214. (goto-char (point-min))
  7215. (and
  7216. (re-search-forward
  7217. (concat "<<" (regexp-quote s0) ">>") nil t)
  7218. (setq type 'dedicated
  7219. pos (match-beginning 0))))
  7220. ;; There is an exact target for this
  7221. (goto-char pos))
  7222. ((and (string-match "^(\\(.*\\))$" s0)
  7223. (save-excursion
  7224. (goto-char (point-min))
  7225. (and
  7226. (re-search-forward
  7227. (concat "[^[]" (regexp-quote
  7228. (format org-coderef-label-format
  7229. (match-string 1 s0))))
  7230. nil t)
  7231. (setq type 'dedicated
  7232. pos (1+ (match-beginning 0))))))
  7233. ;; There is a coderef target for this
  7234. (goto-char pos))
  7235. ((string-match "^/\\(.*\\)/$" s)
  7236. ;; A regular expression
  7237. (cond
  7238. ((org-mode-p)
  7239. (org-occur (match-string 1 s)))
  7240. ;;((eq major-mode 'dired-mode)
  7241. ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
  7242. (t (org-do-occur (match-string 1 s)))))
  7243. (t
  7244. ;; A normal search strings
  7245. (when (equal (string-to-char s) ?*)
  7246. ;; Anchor on headlines, post may include tags.
  7247. (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
  7248. post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@:+]:[ \t]*\\)?$")
  7249. s (substring s 1)))
  7250. (remove-text-properties
  7251. 0 (length s)
  7252. '(face nil mouse-face nil keymap nil fontified nil) s)
  7253. ;; Make a series of regular expressions to find a match
  7254. (setq words (org-split-string s "[ \n\r\t]+")
  7255. re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
  7256. re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
  7257. "\\)" markers)
  7258. re2a_ (concat "\\(" (mapconcat 'downcase words "[ \t\r\n]+") "\\)[ \t\r\n]")
  7259. re2a (concat "[ \t\r\n]" re2a_)
  7260. re4_ (concat "\\(" (mapconcat 'downcase words "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
  7261. re4 (concat "[^a-zA-Z_]" re4_)
  7262. re1 (concat pre re2 post)
  7263. re3 (concat pre (if pre re4_ re4) post)
  7264. re5 (concat pre ".*" re4)
  7265. re2 (concat pre re2)
  7266. re2a (concat pre (if pre re2a_ re2a))
  7267. re4 (concat pre (if pre re4_ re4))
  7268. reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
  7269. "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
  7270. re5 "\\)"
  7271. ))
  7272. (cond
  7273. ((eq type 'org-occur) (org-occur reall))
  7274. ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
  7275. (t (goto-char (point-min))
  7276. (setq type 'fuzzy)
  7277. (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
  7278. (org-search-not-self 1 re1 nil t)
  7279. (org-search-not-self 1 re2 nil t)
  7280. (org-search-not-self 1 re2a nil t)
  7281. (org-search-not-self 1 re3 nil t)
  7282. (org-search-not-self 1 re4 nil t)
  7283. (org-search-not-self 1 re5 nil t)
  7284. )
  7285. (goto-char (match-beginning 1))
  7286. (goto-char pos)
  7287. (error "No match")))))
  7288. (t
  7289. ;; Normal string-search
  7290. (goto-char (point-min))
  7291. (if (search-forward s nil t)
  7292. (goto-char (match-beginning 0))
  7293. (error "No match"))))
  7294. (and (org-mode-p) (org-show-context 'link-search))
  7295. type))
  7296. (defun org-search-not-self (group &rest args)
  7297. "Execute `re-search-forward', but only accept matches that do not
  7298. enclose the position of `org-open-link-marker'."
  7299. (let ((m org-open-link-marker))
  7300. (catch 'exit
  7301. (while (apply 're-search-forward args)
  7302. (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
  7303. (goto-char (match-end group))
  7304. (if (and (or (not (eq (marker-buffer m) (current-buffer)))
  7305. (> (match-beginning 0) (marker-position m))
  7306. (< (match-end 0) (marker-position m)))
  7307. (save-match-data
  7308. (or (not (org-in-regexp
  7309. org-bracket-link-analytic-regexp 1))
  7310. (not (match-end 4)) ; no description
  7311. (and (<= (match-beginning 4) (point))
  7312. (>= (match-end 4) (point))))))
  7313. (throw 'exit (point))))))))
  7314. (defun org-get-buffer-for-internal-link (buffer)
  7315. "Return a buffer to be used for displaying the link target of internal links."
  7316. (cond
  7317. ((not org-display-internal-link-with-indirect-buffer)
  7318. buffer)
  7319. ((string-match "(Clone)$" (buffer-name buffer))
  7320. (message "Buffer is already a clone, not making another one")
  7321. ;; we also do not modify visibility in this case
  7322. buffer)
  7323. (t ; make a new indirect buffer for displaying the link
  7324. (let* ((bn (buffer-name buffer))
  7325. (ibn (concat bn "(Clone)"))
  7326. (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
  7327. (with-current-buffer ib (org-overview))
  7328. ib))))
  7329. (defun org-do-occur (regexp &optional cleanup)
  7330. "Call the Emacs command `occur'.
  7331. If CLEANUP is non-nil, remove the printout of the regular expression
  7332. in the *Occur* buffer. This is useful if the regex is long and not useful
  7333. to read."
  7334. (occur regexp)
  7335. (when cleanup
  7336. (let ((cwin (selected-window)) win beg end)
  7337. (when (setq win (get-buffer-window "*Occur*"))
  7338. (select-window win))
  7339. (goto-char (point-min))
  7340. (when (re-search-forward "match[a-z]+" nil t)
  7341. (setq beg (match-end 0))
  7342. (if (re-search-forward "^[ \t]*[0-9]+" nil t)
  7343. (setq end (1- (match-beginning 0)))))
  7344. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  7345. (goto-char (point-min))
  7346. (select-window cwin))))
  7347. ;;; The mark ring for links jumps
  7348. (defvar org-mark-ring nil
  7349. "Mark ring for positions before jumps in Org-mode.")
  7350. (defvar org-mark-ring-last-goto nil
  7351. "Last position in the mark ring used to go back.")
  7352. ;; Fill and close the ring
  7353. (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
  7354. (loop for i from 1 to org-mark-ring-length do
  7355. (push (make-marker) org-mark-ring))
  7356. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  7357. org-mark-ring)
  7358. (defun org-mark-ring-push (&optional pos buffer)
  7359. "Put the current position or POS into the mark ring and rotate it."
  7360. (interactive)
  7361. (setq pos (or pos (point)))
  7362. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  7363. (move-marker (car org-mark-ring)
  7364. (or pos (point))
  7365. (or buffer (current-buffer)))
  7366. (message "%s"
  7367. (substitute-command-keys
  7368. "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
  7369. (defun org-mark-ring-goto (&optional n)
  7370. "Jump to the previous position in the mark ring.
  7371. With prefix arg N, jump back that many stored positions. When
  7372. called several times in succession, walk through the entire ring.
  7373. Org-mode commands jumping to a different position in the current file,
  7374. or to another Org-mode file, automatically push the old position
  7375. onto the ring."
  7376. (interactive "p")
  7377. (let (p m)
  7378. (if (eq last-command this-command)
  7379. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  7380. (setq p org-mark-ring))
  7381. (setq org-mark-ring-last-goto p)
  7382. (setq m (car p))
  7383. (switch-to-buffer (marker-buffer m))
  7384. (goto-char m)
  7385. (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
  7386. (defun org-remove-angle-brackets (s)
  7387. (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
  7388. (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
  7389. s)
  7390. (defun org-add-angle-brackets (s)
  7391. (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
  7392. (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
  7393. s)
  7394. (defun org-remove-double-quotes (s)
  7395. (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
  7396. (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
  7397. s)
  7398. ;;; Following specific links
  7399. (defun org-follow-timestamp-link ()
  7400. (cond
  7401. ((org-at-date-range-p t)
  7402. (let ((org-agenda-start-on-weekday)
  7403. (t1 (match-string 1))
  7404. (t2 (match-string 2)))
  7405. (setq t1 (time-to-days (org-time-string-to-time t1))
  7406. t2 (time-to-days (org-time-string-to-time t2)))
  7407. (org-agenda-list nil t1 (1+ (- t2 t1)))))
  7408. ((org-at-timestamp-p t)
  7409. (org-agenda-list nil (time-to-days (org-time-string-to-time
  7410. (substring (match-string 1) 0 10)))
  7411. 1))
  7412. (t (error "This should not happen"))))
  7413. ;;; Following file links
  7414. (defvar org-wait nil)
  7415. (defun org-open-file (path &optional in-emacs line search)
  7416. "Open the file at PATH.
  7417. First, this expands any special file name abbreviations. Then the
  7418. configuration variable `org-file-apps' is checked if it contains an
  7419. entry for this file type, and if yes, the corresponding command is launched.
  7420. If no application is found, Emacs simply visits the file.
  7421. With optional prefix argument IN-EMACS, Emacs will visit the file.
  7422. With a double C-c C-u prefix arg, Org tries to avoid opening in Emacs
  7423. and o use an external application to visit the file.
  7424. Optional LINE specifies a line to go to, optional SEARCH a string to
  7425. search for. If LINE or SEARCH is given, the file will always be
  7426. opened in Emacs.
  7427. If the file does not exist, an error is thrown."
  7428. (setq in-emacs (or in-emacs line search))
  7429. (let* ((file (if (equal path "")
  7430. buffer-file-name
  7431. (substitute-in-file-name (expand-file-name path))))
  7432. (apps (append org-file-apps (org-default-apps)))
  7433. (remp (and (assq 'remote apps) (org-file-remote-p file)))
  7434. (dirp (if remp nil (file-directory-p file)))
  7435. (file (if (and dirp org-open-directory-means-index-dot-org)
  7436. (concat (file-name-as-directory file) "index.org")
  7437. file))
  7438. (a-m-a-p (assq 'auto-mode apps))
  7439. (dfile (downcase file))
  7440. (old-buffer (current-buffer))
  7441. (old-pos (point))
  7442. (old-mode major-mode)
  7443. ext cmd)
  7444. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
  7445. (setq ext (match-string 1 dfile))
  7446. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
  7447. (setq ext (match-string 1 dfile))))
  7448. (cond
  7449. ((equal in-emacs '(16))
  7450. (setq cmd (cdr (assoc 'system apps))))
  7451. (in-emacs (setq cmd 'emacs))
  7452. (t
  7453. (setq cmd (or (and remp (cdr (assoc 'remote apps)))
  7454. (and dirp (cdr (assoc 'directory apps)))
  7455. (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
  7456. 'string-match)
  7457. (cdr (assoc ext apps))
  7458. (cdr (assoc t apps))))))
  7459. (when (eq cmd 'system)
  7460. (setq cmd (cdr (assoc 'system apps))))
  7461. (when (eq cmd 'default)
  7462. (setq cmd (cdr (assoc t apps))))
  7463. (when (eq cmd 'mailcap)
  7464. (require 'mailcap)
  7465. (mailcap-parse-mailcaps)
  7466. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  7467. (command (mailcap-mime-info mime-type)))
  7468. (if (stringp command)
  7469. (setq cmd command)
  7470. (setq cmd 'emacs))))
  7471. (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  7472. (not (file-exists-p file))
  7473. (not org-open-non-existing-files))
  7474. (error "No such file: %s" file))
  7475. (cond
  7476. ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
  7477. ;; Remove quotes around the file name - we'll use shell-quote-argument.
  7478. (while (string-match "['\"]%s['\"]" cmd)
  7479. (setq cmd (replace-match "%s" t t cmd)))
  7480. (while (string-match "%s" cmd)
  7481. (setq cmd (replace-match
  7482. (save-match-data
  7483. (shell-quote-argument
  7484. (convert-standard-filename file)))
  7485. t t cmd)))
  7486. (save-window-excursion
  7487. (start-process-shell-command cmd nil cmd)
  7488. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
  7489. ))
  7490. ((or (stringp cmd)
  7491. (eq cmd 'emacs))
  7492. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  7493. (widen)
  7494. (if line (goto-line line)
  7495. (if search (org-link-search search))))
  7496. ((consp cmd)
  7497. (let ((file (convert-standard-filename file)))
  7498. (eval cmd)))
  7499. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  7500. (and (org-mode-p) (eq old-mode 'org-mode)
  7501. (or (not (equal old-buffer (current-buffer)))
  7502. (not (equal old-pos (point))))
  7503. (org-mark-ring-push old-pos old-buffer))))
  7504. (defun org-default-apps ()
  7505. "Return the default applications for this operating system."
  7506. (cond
  7507. ((eq system-type 'darwin)
  7508. org-file-apps-defaults-macosx)
  7509. ((eq system-type 'windows-nt)
  7510. org-file-apps-defaults-windowsnt)
  7511. (t org-file-apps-defaults-gnu)))
  7512. (defun org-apps-regexp-alist (list &optional add-auto-mode)
  7513. "Convert extensions to regular expressions in the cars of LIST.
  7514. Also, weed out any non-string entries, because the return value is used
  7515. only for regexp matching.
  7516. When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
  7517. point to the symbol `emacs', indicating that the file should
  7518. be opened in Emacs."
  7519. (append
  7520. (delq nil
  7521. (mapcar (lambda (x)
  7522. (if (not (stringp (car x)))
  7523. nil
  7524. (if (string-match "\\W" (car x))
  7525. x
  7526. (cons (concat "\\." (car x) "\\'") (cdr x)))))
  7527. list))
  7528. (if add-auto-mode
  7529. (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
  7530. (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
  7531. (defun org-file-remote-p (file)
  7532. "Test whether FILE specifies a location on a remote system.
  7533. Return non-nil if the location is indeed remote.
  7534. For example, the filename \"/user@host:/foo\" specifies a location
  7535. on the system \"/user@host:\"."
  7536. (cond ((fboundp 'file-remote-p)
  7537. (file-remote-p file))
  7538. ((fboundp 'tramp-handle-file-remote-p)
  7539. (tramp-handle-file-remote-p file))
  7540. ((and (boundp 'ange-ftp-name-format)
  7541. (string-match (car ange-ftp-name-format) file))
  7542. t)
  7543. (t nil)))
  7544. ;;;; Refiling
  7545. (defun org-get-org-file ()
  7546. "Read a filename, with default directory `org-directory'."
  7547. (let ((default (or org-default-notes-file remember-data-file)))
  7548. (read-file-name (format "File name [%s]: " default)
  7549. (file-name-as-directory org-directory)
  7550. default)))
  7551. (defun org-notes-order-reversed-p ()
  7552. "Check if the current file should receive notes in reversed order."
  7553. (cond
  7554. ((not org-reverse-note-order) nil)
  7555. ((eq t org-reverse-note-order) t)
  7556. ((not (listp org-reverse-note-order)) nil)
  7557. (t (catch 'exit
  7558. (let ((all org-reverse-note-order)
  7559. entry)
  7560. (while (setq entry (pop all))
  7561. (if (string-match (car entry) buffer-file-name)
  7562. (throw 'exit (cdr entry))))
  7563. nil)))))
  7564. (defvar org-refile-target-table nil
  7565. "The list of refile targets, created by `org-refile'.")
  7566. (defvar org-agenda-new-buffers nil
  7567. "Buffers created to visit agenda files.")
  7568. (defun org-get-refile-targets (&optional default-buffer)
  7569. "Produce a table with refile targets."
  7570. (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
  7571. targets txt re files f desc descre fast-path-p level pos0)
  7572. (message "Getting targets...")
  7573. (with-current-buffer (or default-buffer (current-buffer))
  7574. (while (setq entry (pop entries))
  7575. (setq files (car entry) desc (cdr entry))
  7576. (setq fast-path-p nil)
  7577. (cond
  7578. ((null files) (setq files (list (current-buffer))))
  7579. ((eq files 'org-agenda-files)
  7580. (setq files (org-agenda-files 'unrestricted)))
  7581. ((and (symbolp files) (fboundp files))
  7582. (setq files (funcall files)))
  7583. ((and (symbolp files) (boundp files))
  7584. (setq files (symbol-value files))))
  7585. (if (stringp files) (setq files (list files)))
  7586. (cond
  7587. ((eq (car desc) :tag)
  7588. (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
  7589. ((eq (car desc) :todo)
  7590. (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
  7591. ((eq (car desc) :regexp)
  7592. (setq descre (cdr desc)))
  7593. ((eq (car desc) :level)
  7594. (setq descre (concat "^\\*\\{" (number-to-string
  7595. (if org-odd-levels-only
  7596. (1- (* 2 (cdr desc)))
  7597. (cdr desc)))
  7598. "\\}[ \t]")))
  7599. ((eq (car desc) :maxlevel)
  7600. (setq fast-path-p t)
  7601. (setq descre (concat "^\\*\\{1," (number-to-string
  7602. (if org-odd-levels-only
  7603. (1- (* 2 (cdr desc)))
  7604. (cdr desc)))
  7605. "\\}[ \t]")))
  7606. (t (error "Bad refiling target description %s" desc)))
  7607. (while (setq f (pop files))
  7608. (save-excursion
  7609. (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
  7610. (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
  7611. (setq f (expand-file-name f))
  7612. (if (eq org-refile-use-outline-path 'file)
  7613. (push (list (file-name-nondirectory f) f nil nil) targets))
  7614. (save-excursion
  7615. (save-restriction
  7616. (widen)
  7617. (goto-char (point-min))
  7618. (while (re-search-forward descre nil t)
  7619. (goto-char (setq pos0 (point-at-bol)))
  7620. (catch 'next
  7621. (when org-refile-target-verify-function
  7622. (save-match-data
  7623. (or (funcall org-refile-target-verify-function)
  7624. (throw 'next t))))
  7625. (when (looking-at org-complex-heading-regexp)
  7626. (setq level (org-reduced-level (- (match-end 1) (match-beginning 1)))
  7627. txt (org-link-display-format (match-string 4))
  7628. re (concat "^" (regexp-quote
  7629. (buffer-substring (match-beginning 1)
  7630. (match-end 4)))))
  7631. (if (match-end 5) (setq re (concat re "[ \t]+"
  7632. (regexp-quote
  7633. (match-string 5)))))
  7634. (setq re (concat re "[ \t]*$"))
  7635. (when org-refile-use-outline-path
  7636. (setq txt (mapconcat 'org-protect-slash
  7637. (append
  7638. (if (eq org-refile-use-outline-path 'file)
  7639. (list (file-name-nondirectory
  7640. (buffer-file-name (buffer-base-buffer))))
  7641. (if (eq org-refile-use-outline-path 'full-file-path)
  7642. (list (buffer-file-name (buffer-base-buffer)))))
  7643. (org-get-outline-path fast-path-p level txt)
  7644. (list txt))
  7645. "/")))
  7646. (push (list txt f re (point)) targets)))
  7647. (when (= (point) pos0)
  7648. ;; verification function has not moved point
  7649. (goto-char (point-at-eol))))))))))
  7650. (message "Getting targets...done")
  7651. (nreverse targets)))
  7652. (defun org-protect-slash (s)
  7653. (while (string-match "/" s)
  7654. (setq s (replace-match "\\" t t s)))
  7655. s)
  7656. (defvar org-olpa (make-vector 20 nil))
  7657. (defun org-get-outline-path (&optional fastp level heading)
  7658. "Return the outline path to the current entry, as a list."
  7659. (if fastp
  7660. (progn
  7661. (if (> level 19)
  7662. (error "Outline path failure, more than 19 levels."))
  7663. (loop for i from level upto 19 do
  7664. (aset org-olpa i nil))
  7665. (prog1
  7666. (delq nil (append org-olpa nil))
  7667. (aset org-olpa level heading)))
  7668. (let (rtn)
  7669. (save-excursion
  7670. (while (org-up-heading-safe)
  7671. (when (looking-at org-complex-heading-regexp)
  7672. (push (org-match-string-no-properties 4) rtn)))
  7673. rtn))))
  7674. (defvar org-refile-history nil
  7675. "History for refiling operations.")
  7676. (defvar org-after-refile-insert-hook nil
  7677. "Hook run after `org-refile' has inserted its stuff at the new location.
  7678. Note that this is still *before* the stuff will be removed from
  7679. the *old* location.")
  7680. (defun org-refile (&optional goto default-buffer)
  7681. "Move the entry at point to another heading.
  7682. The list of target headings is compiled using the information in
  7683. `org-refile-targets', which see. This list is created before each use
  7684. and will therefore always be up-to-date.
  7685. At the target location, the entry is filed as a subitem of the target heading.
  7686. Depending on `org-reverse-note-order', the new subitem will either be the
  7687. first or the last subitem.
  7688. If there is an active region, all entries in that region will be moved.
  7689. However, the region must fulfil the requirement that the first heading
  7690. is the first one sets the top-level of the moved text - at most siblings
  7691. below it are allowed.
  7692. With prefix arg GOTO, the command will only visit the target location,
  7693. not actually move anything.
  7694. With a double prefix `C-u C-u', go to the location where the last refiling
  7695. operation has put the subtree.
  7696. See also `org-refile-use-outline-path' and `org-completion-use-ido'"
  7697. (interactive "P")
  7698. (let* ((cbuf (current-buffer))
  7699. (regionp (org-region-active-p))
  7700. (region-start (and regionp (region-beginning)))
  7701. (region-end (and regionp (region-end)))
  7702. (region-length (and regionp (- region-end region-start)))
  7703. (filename (buffer-file-name (buffer-base-buffer cbuf)))
  7704. pos it nbuf file re level reversed)
  7705. (when regionp (goto-char region-start)
  7706. (unless (org-kill-is-subtree-p
  7707. (buffer-substring region-start region-end))
  7708. (error "The region is not a (sequence of) subtree(s)")))
  7709. (if (equal goto '(16))
  7710. (org-refile-goto-last-stored)
  7711. (when (setq it (org-refile-get-location
  7712. (if goto "Goto: " "Refile to: ") default-buffer
  7713. org-refile-allow-creating-parent-nodes))
  7714. (setq file (nth 1 it)
  7715. re (nth 2 it)
  7716. pos (nth 3 it))
  7717. (if (and (not goto)
  7718. pos
  7719. (equal (buffer-file-name) file)
  7720. (if regionp
  7721. (and (>= pos region-start)
  7722. (<= pos region-end))
  7723. (and (>= pos (point))
  7724. (< pos (save-excursion
  7725. (org-end-of-subtree t t))))))
  7726. (error "Cannot refile to position inside the tree or region"))
  7727. (setq nbuf (or (find-buffer-visiting file)
  7728. (find-file-noselect file)))
  7729. (if goto
  7730. (progn
  7731. (switch-to-buffer nbuf)
  7732. (goto-char pos)
  7733. (org-show-context 'org-goto))
  7734. (if regionp
  7735. (progn
  7736. (kill-new (buffer-substring region-start region-end))
  7737. (org-save-markers-in-region region-start region-end))
  7738. (org-copy-subtree 1 nil t))
  7739. (save-excursion
  7740. (set-buffer (setq nbuf (or (find-buffer-visiting file)
  7741. (find-file-noselect file))))
  7742. (setq reversed (org-notes-order-reversed-p))
  7743. (save-excursion
  7744. (save-restriction
  7745. (widen)
  7746. (if pos
  7747. (progn
  7748. (goto-char pos)
  7749. (looking-at outline-regexp)
  7750. (setq level (org-get-valid-level (funcall outline-level) 1))
  7751. (goto-char
  7752. (if reversed
  7753. (or (outline-next-heading) (point-max))
  7754. (or (save-excursion (outline-get-next-sibling))
  7755. (org-end-of-subtree t t)
  7756. (point-max)))))
  7757. (setq level 1)
  7758. (if (not reversed)
  7759. (goto-char (point-max))
  7760. (goto-char (point-min))
  7761. (or (outline-next-heading) (goto-char (point-max)))))
  7762. (if (not (bolp)) (newline))
  7763. (bookmark-set "org-refile-last-stored")
  7764. (org-paste-subtree level)
  7765. (run-hooks 'org-after-refile-insert-hook))))
  7766. (if regionp
  7767. (delete-region (point) (+ (point) region-length))
  7768. (org-cut-subtree))
  7769. (setq org-markers-to-move nil)
  7770. (message "Refiled to \"%s\"" (car it))))))
  7771. (org-reveal))
  7772. (defun org-refile-goto-last-stored ()
  7773. "Go to the location where the last refile was stored."
  7774. (interactive)
  7775. (bookmark-jump "org-refile-last-stored")
  7776. (message "This is the location of the last refile"))
  7777. (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
  7778. "Prompt the user for a refile location, using PROMPT."
  7779. (let ((org-refile-targets org-refile-targets)
  7780. (org-refile-use-outline-path org-refile-use-outline-path))
  7781. (setq org-refile-target-table (org-get-refile-targets default-buffer)))
  7782. (unless org-refile-target-table
  7783. (error "No refile targets"))
  7784. (let* ((cbuf (current-buffer))
  7785. (partial-completion-mode nil)
  7786. (cfn (buffer-file-name (buffer-base-buffer cbuf)))
  7787. (cfunc (if (and org-refile-use-outline-path
  7788. org-outline-path-complete-in-steps)
  7789. 'org-olpath-completing-read
  7790. 'org-ido-completing-read))
  7791. (extra (if org-refile-use-outline-path "/" ""))
  7792. (filename (and cfn (expand-file-name cfn)))
  7793. (tbl (mapcar
  7794. (lambda (x)
  7795. (if (and (not (member org-refile-use-outline-path
  7796. '(file full-file-path)))
  7797. (not (equal filename (nth 1 x))))
  7798. (cons (concat (car x) extra " ("
  7799. (file-name-nondirectory (nth 1 x)) ")")
  7800. (cdr x))
  7801. (cons (concat (car x) extra) (cdr x))))
  7802. org-refile-target-table))
  7803. (completion-ignore-case t)
  7804. pa answ parent-target child parent)
  7805. (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
  7806. nil 'org-refile-history))
  7807. (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
  7808. (if pa
  7809. pa
  7810. (when (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
  7811. (setq parent (match-string 1 answ)
  7812. child (match-string 2 answ))
  7813. (setq parent-target (or (assoc parent tbl) (assoc (concat parent "/") tbl)))
  7814. (when (and parent-target
  7815. (or (eq new-nodes t)
  7816. (and (eq new-nodes 'confirm)
  7817. (y-or-n-p (format "Create new node \"%s\"? " child)))))
  7818. (org-refile-new-child parent-target child))))))
  7819. (defun org-refile-new-child (parent-target child)
  7820. "Use refile target PARENT-TARGET to add new CHILD below it."
  7821. (unless parent-target
  7822. (error "Cannot find parent for new node"))
  7823. (let ((file (nth 1 parent-target))
  7824. (pos (nth 3 parent-target))
  7825. level)
  7826. (with-current-buffer (or (find-buffer-visiting file)
  7827. (find-file-noselect file))
  7828. (save-excursion
  7829. (save-restriction
  7830. (widen)
  7831. (if pos
  7832. (goto-char pos)
  7833. (goto-char (point-max))
  7834. (if (not (bolp)) (newline)))
  7835. (when (looking-at outline-regexp)
  7836. (setq level (funcall outline-level))
  7837. (org-end-of-subtree t t))
  7838. (org-back-over-empty-lines)
  7839. (insert "\n" (make-string
  7840. (if pos (org-get-valid-level level 1) 1) ?*)
  7841. " " child "\n")
  7842. (beginning-of-line 0)
  7843. (list (concat (car parent-target) "/" child) file "" (point)))))))
  7844. (defun org-olpath-completing-read (prompt collection &rest args)
  7845. "Read an outline path like a file name."
  7846. (let ((thetable collection)
  7847. (org-completion-use-ido nil)) ; does not work with ido.
  7848. (apply
  7849. 'org-ido-completing-read prompt
  7850. (lambda (string predicate &optional flag)
  7851. (let (rtn r f (l (length string)))
  7852. (cond
  7853. ((eq flag nil)
  7854. ;; try completion
  7855. (try-completion string thetable))
  7856. ((eq flag t)
  7857. ;; all-completions
  7858. (setq rtn (all-completions string thetable predicate))
  7859. (mapcar
  7860. (lambda (x)
  7861. (setq r (substring x l))
  7862. (if (string-match " ([^)]*)$" x)
  7863. (setq f (match-string 0 x))
  7864. (setq f ""))
  7865. (if (string-match "/" r)
  7866. (concat string (substring r 0 (match-end 0)) f)
  7867. x))
  7868. rtn))
  7869. ((eq flag 'lambda)
  7870. ;; exact match?
  7871. (assoc string thetable)))
  7872. ))
  7873. args)))
  7874. ;;;; Dynamic blocks
  7875. (defun org-find-dblock (name)
  7876. "Find the first dynamic block with name NAME in the buffer.
  7877. If not found, stay at current position and return nil."
  7878. (let (pos)
  7879. (save-excursion
  7880. (goto-char (point-min))
  7881. (setq pos (and (re-search-forward (concat "^#\\+BEGIN:[ \t]+" name "\\>")
  7882. nil t)
  7883. (match-beginning 0))))
  7884. (if pos (goto-char pos))
  7885. pos))
  7886. (defconst org-dblock-start-re
  7887. "^#\\+BEGIN:[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  7888. "Matches the startline of a dynamic block, with parameters.")
  7889. (defconst org-dblock-end-re "^#\\+END\\([: \t\r\n]\\|$\\)"
  7890. "Matches the end of a dynamic block.")
  7891. (defun org-create-dblock (plist)
  7892. "Create a dynamic block section, with parameters taken from PLIST.
  7893. PLIST must contain a :name entry which is used as name of the block."
  7894. (unless (bolp) (newline))
  7895. (let ((name (plist-get plist :name)))
  7896. (insert "#+BEGIN: " name)
  7897. (while plist
  7898. (if (eq (car plist) :name)
  7899. (setq plist (cddr plist))
  7900. (insert " " (prin1-to-string (pop plist)))))
  7901. (insert "\n\n#+END:\n")
  7902. (beginning-of-line -2)))
  7903. (defun org-prepare-dblock ()
  7904. "Prepare dynamic block for refresh.
  7905. This empties the block, puts the cursor at the insert position and returns
  7906. the property list including an extra property :name with the block name."
  7907. (unless (looking-at org-dblock-start-re)
  7908. (error "Not at a dynamic block"))
  7909. (let* ((begdel (1+ (match-end 0)))
  7910. (name (org-no-properties (match-string 1)))
  7911. (params (append (list :name name)
  7912. (read (concat "(" (match-string 3) ")")))))
  7913. (unless (re-search-forward org-dblock-end-re nil t)
  7914. (error "Dynamic block not terminated"))
  7915. (setq params
  7916. (append params
  7917. (list :content (buffer-substring
  7918. begdel (match-beginning 0)))))
  7919. (delete-region begdel (match-beginning 0))
  7920. (goto-char begdel)
  7921. (open-line 1)
  7922. params))
  7923. (defun org-map-dblocks (&optional command)
  7924. "Apply COMMAND to all dynamic blocks in the current buffer.
  7925. If COMMAND is not given, use `org-update-dblock'."
  7926. (let ((cmd (or command 'org-update-dblock))
  7927. pos)
  7928. (save-excursion
  7929. (goto-char (point-min))
  7930. (while (re-search-forward org-dblock-start-re nil t)
  7931. (goto-char (setq pos (match-beginning 0)))
  7932. (condition-case nil
  7933. (funcall cmd)
  7934. (error (message "Error during update of dynamic block")))
  7935. (goto-char pos)
  7936. (unless (re-search-forward org-dblock-end-re nil t)
  7937. (error "Dynamic block not terminated"))))))
  7938. (defun org-dblock-update (&optional arg)
  7939. "User command for updating dynamic blocks.
  7940. Update the dynamic block at point. With prefix ARG, update all dynamic
  7941. blocks in the buffer."
  7942. (interactive "P")
  7943. (if arg
  7944. (org-update-all-dblocks)
  7945. (or (looking-at org-dblock-start-re)
  7946. (org-beginning-of-dblock))
  7947. (org-update-dblock)))
  7948. (defun org-update-dblock ()
  7949. "Update the dynamic block at point
  7950. This means to empty the block, parse for parameters and then call
  7951. the correct writing function."
  7952. (save-window-excursion
  7953. (let* ((pos (point))
  7954. (line (org-current-line))
  7955. (params (org-prepare-dblock))
  7956. (name (plist-get params :name))
  7957. (cmd (intern (concat "org-dblock-write:" name))))
  7958. (message "Updating dynamic block `%s' at line %d..." name line)
  7959. (funcall cmd params)
  7960. (message "Updating dynamic block `%s' at line %d...done" name line)
  7961. (goto-char pos))))
  7962. (defun org-beginning-of-dblock ()
  7963. "Find the beginning of the dynamic block at point.
  7964. Error if there is no such block at point."
  7965. (let ((pos (point))
  7966. beg)
  7967. (end-of-line 1)
  7968. (if (and (re-search-backward org-dblock-start-re nil t)
  7969. (setq beg (match-beginning 0))
  7970. (re-search-forward org-dblock-end-re nil t)
  7971. (> (match-end 0) pos))
  7972. (goto-char beg)
  7973. (goto-char pos)
  7974. (error "Not in a dynamic block"))))
  7975. (defun org-update-all-dblocks ()
  7976. "Update all dynamic blocks in the buffer.
  7977. This function can be used in a hook."
  7978. (when (org-mode-p)
  7979. (org-map-dblocks 'org-update-dblock)))
  7980. ;;;; Completion
  7981. (defconst org-additional-option-like-keywords
  7982. '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
  7983. "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "TBLFM"
  7984. "LATEX_HEADER:"
  7985. "BEGIN_EXAMPLE" "END_EXAMPLE"
  7986. "BEGIN_QUOTE" "END_QUOTE"
  7987. "BEGIN_VERSE" "END_VERSE"
  7988. "BEGIN_CENTER" "END_CENTER"
  7989. "BEGIN_SRC" "END_SRC"
  7990. "CATEGORY" "COLUMNS"
  7991. "CAPTION" "LABEL" "ATTR_HTML" "ATTR_LaTeX"))
  7992. (defcustom org-structure-template-alist
  7993. '(
  7994. ("s" "#+begin_src ?\n\n#+end_src"
  7995. "<src lang=\"?\">\n\n</src>")
  7996. ("e" "#+begin_example\n?\n#+end_example"
  7997. "<example>\n?\n</example>")
  7998. ("q" "#+begin_quote\n?\n#+end_quote"
  7999. "<quote>\n?\n</quote>")
  8000. ("v" "#+begin_verse\n?\n#+end_verse"
  8001. "<verse>\n?\n/verse>")
  8002. ("c" "#+begin_center\n?\n#+end_center"
  8003. "<center>\n?\n/center>")
  8004. ("l" "#+begin_latex\n?\n#+end_latex"
  8005. "<literal style=\"latex\">\n?\n</literal>")
  8006. ("L" "#+latex: "
  8007. "<literal style=\"latex\">?</literal>")
  8008. ("h" "#+begin_html\n?\n#+end_html"
  8009. "<literal style=\"html\">\n?\n</literal>")
  8010. ("H" "#+html: "
  8011. "<literal style=\"html\">?</literal>")
  8012. ("a" "#+begin_ascii\n?\n#+end_ascii")
  8013. ("A" "#+ascii: ")
  8014. ("i" "#+include %file ?"
  8015. "<include file=%file markup=\"?\">")
  8016. )
  8017. "Structure completion elements.
  8018. This is a list of abbreviation keys and values. The value gets inserted
  8019. it you type @samp{.} followed by the key and then the completion key,
  8020. usually `M-TAB'. %file will be replaced by a file name after prompting
  8021. for the file using completion.
  8022. There are two templates for each key, the first uses the original Org syntax,
  8023. the second uses Emacs Muse-like syntax tags. These Muse-like tags become
  8024. the default when the /org-mtags.el/ module has been loaded. See also the
  8025. variable `org-mtags-prefer-muse-templates'.
  8026. This is an experimental feature, it is undecided if it is going to stay in."
  8027. :group 'org-completion
  8028. :type '(repeat
  8029. (string :tag "Key")
  8030. (string :tag "Template")
  8031. (string :tag "Muse Template")))
  8032. (defun org-try-structure-completion ()
  8033. "Try to complete a structure template before point.
  8034. This looks for strings like \"<e\" on an otherwise empty line and
  8035. expands them."
  8036. (let ((l (buffer-substring (point-at-bol) (point)))
  8037. a)
  8038. (when (and (looking-at "[ \t]*$")
  8039. (string-match "^[ \t]*<\\([a-z]+\\)$"l)
  8040. (setq a (assoc (match-string 1 l) org-structure-template-alist)))
  8041. (org-complete-expand-structure-template (+ -1 (point-at-bol)
  8042. (match-beginning 1)) a)
  8043. t)))
  8044. (defun org-complete-expand-structure-template (start cell)
  8045. "Expand a structure template."
  8046. (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
  8047. (rpl (nth (if musep 2 1) cell)))
  8048. (delete-region start (point))
  8049. (when (string-match "\\`#\\+" rpl)
  8050. (cond
  8051. ((bolp))
  8052. ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
  8053. (delete-region (point-at-bol) (point)))
  8054. (t (newline))))
  8055. (setq start (point))
  8056. (if (string-match "%file" rpl)
  8057. (setq rpl (replace-match
  8058. (concat
  8059. "\""
  8060. (save-match-data
  8061. (abbreviate-file-name (read-file-name "Include file: ")))
  8062. "\"")
  8063. t t rpl)))
  8064. (insert rpl)
  8065. (if (re-search-backward "\\?" start t) (delete-char 1))))
  8066. (defun org-complete (&optional arg)
  8067. "Perform completion on word at point.
  8068. At the beginning of a headline, this completes TODO keywords as given in
  8069. `org-todo-keywords'.
  8070. If the current word is preceded by a backslash, completes the TeX symbols
  8071. that are supported for HTML support.
  8072. If the current word is preceded by \"#+\", completes special words for
  8073. setting file options.
  8074. In the line after \"#+STARTUP:, complete valid keywords.\"
  8075. At all other locations, this simply calls the value of
  8076. `org-completion-fallback-command'."
  8077. (interactive "P")
  8078. (org-without-partial-completion
  8079. (catch 'exit
  8080. (let* ((a nil)
  8081. (end (point))
  8082. (beg1 (save-excursion
  8083. (skip-chars-backward (org-re "[:alnum:]_@"))
  8084. (point)))
  8085. (beg (save-excursion
  8086. (skip-chars-backward "a-zA-Z0-9_:$")
  8087. (point)))
  8088. (confirm (lambda (x) (stringp (car x))))
  8089. (searchhead (equal (char-before beg) ?*))
  8090. (struct
  8091. (when (and (member (char-before beg1) '(?. ?<))
  8092. (setq a (assoc (buffer-substring beg1 (point))
  8093. org-structure-template-alist)))
  8094. (org-complete-expand-structure-template (1- beg1) a)
  8095. (throw 'exit t)))
  8096. (tag (and (equal (char-before beg1) ?:)
  8097. (equal (char-after (point-at-bol)) ?*)))
  8098. (prop (and (equal (char-before beg1) ?:)
  8099. (not (equal (char-after (point-at-bol)) ?*))))
  8100. (texp (equal (char-before beg) ?\\))
  8101. (link (equal (char-before beg) ?\[))
  8102. (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
  8103. beg)
  8104. "#+"))
  8105. (startup (string-match "^#\\+STARTUP:.*"
  8106. (buffer-substring (point-at-bol) (point))))
  8107. (completion-ignore-case opt)
  8108. (type nil)
  8109. (tbl nil)
  8110. (table (cond
  8111. (opt
  8112. (setq type :opt)
  8113. (require 'org-exp)
  8114. (append
  8115. (mapcar
  8116. (lambda (x)
  8117. (string-match "^#\\+\\(\\([A-Z_]+:?\\).*\\)" x)
  8118. (cons (match-string 2 x) (match-string 1 x)))
  8119. (org-split-string (org-get-current-options) "\n"))
  8120. (mapcar 'list org-additional-option-like-keywords)))
  8121. (startup
  8122. (setq type :startup)
  8123. org-startup-options)
  8124. (link (append org-link-abbrev-alist-local
  8125. org-link-abbrev-alist))
  8126. (texp
  8127. (setq type :tex)
  8128. org-html-entities)
  8129. ((string-match "\\`\\*+[ \t]+\\'"
  8130. (buffer-substring (point-at-bol) beg))
  8131. (setq type :todo)
  8132. (mapcar 'list org-todo-keywords-1))
  8133. (searchhead
  8134. (setq type :searchhead)
  8135. (save-excursion
  8136. (goto-char (point-min))
  8137. (while (re-search-forward org-todo-line-regexp nil t)
  8138. (push (list
  8139. (org-make-org-heading-search-string
  8140. (match-string 3) t))
  8141. tbl)))
  8142. tbl)
  8143. (tag (setq type :tag beg beg1)
  8144. (or org-tag-alist (org-get-buffer-tags)))
  8145. (prop (setq type :prop beg beg1)
  8146. (mapcar 'list (org-buffer-property-keys nil t t)))
  8147. (t (progn
  8148. (call-interactively org-completion-fallback-command)
  8149. (throw 'exit nil)))))
  8150. (pattern (buffer-substring-no-properties beg end))
  8151. (completion (try-completion pattern table confirm)))
  8152. (cond ((eq completion t)
  8153. (if (not (assoc (upcase pattern) table))
  8154. (message "Already complete")
  8155. (if (and (equal type :opt)
  8156. (not (member (car (assoc (upcase pattern) table))
  8157. org-additional-option-like-keywords)))
  8158. (insert (substring (cdr (assoc (upcase pattern) table))
  8159. (length pattern)))
  8160. (if (memq type '(:tag :prop)) (insert ":")))))
  8161. ((null completion)
  8162. (message "Can't find completion for \"%s\"" pattern)
  8163. (ding))
  8164. ((not (string= pattern completion))
  8165. (delete-region beg end)
  8166. (if (string-match " +$" completion)
  8167. (setq completion (replace-match "" t t completion)))
  8168. (insert completion)
  8169. (if (get-buffer-window "*Completions*")
  8170. (delete-window (get-buffer-window "*Completions*")))
  8171. (if (assoc completion table)
  8172. (if (eq type :todo) (insert " ")
  8173. (if (memq type '(:tag :prop)) (insert ":"))))
  8174. (if (and (equal type :opt) (assoc completion table))
  8175. (message "%s" (substitute-command-keys
  8176. "Press \\[org-complete] again to insert example settings"))))
  8177. (t
  8178. (message "Making completion list...")
  8179. (let ((list (sort (all-completions pattern table confirm)
  8180. 'string<)))
  8181. (with-output-to-temp-buffer "*Completions*"
  8182. (condition-case nil
  8183. ;; Protection needed for XEmacs and emacs 21
  8184. (display-completion-list list pattern)
  8185. (error (display-completion-list list)))))
  8186. (message "Making completion list...%s" "done")))))))
  8187. ;;;; TODO, DEADLINE, Comments
  8188. (defun org-toggle-comment ()
  8189. "Change the COMMENT state of an entry."
  8190. (interactive)
  8191. (save-excursion
  8192. (org-back-to-heading)
  8193. (let (case-fold-search)
  8194. (if (looking-at (concat outline-regexp
  8195. "\\( *\\<" org-comment-string "\\>[ \t]*\\)"))
  8196. (replace-match "" t t nil 1)
  8197. (if (looking-at outline-regexp)
  8198. (progn
  8199. (goto-char (match-end 0))
  8200. (insert org-comment-string " ")))))))
  8201. (defvar org-last-todo-state-is-todo nil
  8202. "This is non-nil when the last TODO state change led to a TODO state.
  8203. If the last change removed the TODO tag or switched to DONE, then
  8204. this is nil.")
  8205. (defvar org-setting-tags nil) ; dynamically skipped
  8206. (defun org-parse-local-options (string var)
  8207. "Parse STRING for startup setting relevant for variable VAR."
  8208. (let ((rtn (symbol-value var))
  8209. e opts)
  8210. (save-match-data
  8211. (if (or (not string) (not (string-match "\\S-" string)))
  8212. rtn
  8213. (setq opts (delq nil (mapcar (lambda (x)
  8214. (setq e (assoc x org-startup-options))
  8215. (if (eq (nth 1 e) var) e nil))
  8216. (org-split-string string "[ \t]+"))))
  8217. (if (not opts)
  8218. rtn
  8219. (setq rtn nil)
  8220. (while (setq e (pop opts))
  8221. (if (not (nth 3 e))
  8222. (setq rtn (nth 2 e))
  8223. (if (not (listp rtn)) (setq rtn nil))
  8224. (push (nth 2 e) rtn)))
  8225. rtn)))))
  8226. (defvar org-todo-setup-filter-hook nil
  8227. "Hook for functions that pre-filter todo specs.
  8228. Each function takes a todo spec and returns either `nil' or the spec
  8229. transformed into canonical form." )
  8230. (defvar org-todo-get-default-hook nil
  8231. "Hook for functions that get a default item for todo.
  8232. Each function takes arguments (NEW-MARK OLD-MARK) and returns either
  8233. `nil' or a string to be used for the todo mark." )
  8234. (defvar org-agenda-headline-snapshot-before-repeat)
  8235. (defun org-todo (&optional arg)
  8236. "Change the TODO state of an item.
  8237. The state of an item is given by a keyword at the start of the heading,
  8238. like
  8239. *** TODO Write paper
  8240. *** DONE Call mom
  8241. The different keywords are specified in the variable `org-todo-keywords'.
  8242. By default the available states are \"TODO\" and \"DONE\".
  8243. So for this example: when the item starts with TODO, it is changed to DONE.
  8244. When it starts with DONE, the DONE is removed. And when neither TODO nor
  8245. DONE are present, add TODO at the beginning of the heading.
  8246. With C-u prefix arg, use completion to determine the new state.
  8247. With numeric prefix arg, switch to that state.
  8248. With a double C-u prefix, switch to the next set of TODO keywords (nextset).
  8249. With a tripple C-u prefix, circumvent any state blocking.
  8250. For calling through lisp, arg is also interpreted in the following way:
  8251. 'none -> empty state
  8252. \"\"(empty string) -> switch to empty state
  8253. 'done -> switch to DONE
  8254. 'nextset -> switch to the next set of keywords
  8255. 'previousset -> switch to the previous set of keywords
  8256. \"WAITING\" -> switch to the specified keyword, but only if it
  8257. really is a member of `org-todo-keywords'."
  8258. (interactive "P")
  8259. (if (equal arg '(16)) (setq arg 'nextset))
  8260. (let ((org-blocker-hook org-blocker-hook)
  8261. (case-fold-search nil))
  8262. (when (equal arg '(64))
  8263. (setq arg nil org-blocker-hook nil))
  8264. (when (and org-blocker-hook
  8265. (org-entry-get nil "NOBLOCKING"))
  8266. (setq org-blocker-hook nil))
  8267. (save-excursion
  8268. (catch 'exit
  8269. (org-back-to-heading)
  8270. (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
  8271. (or (looking-at (concat " +" org-todo-regexp "\\( +\\|$\\)"))
  8272. (looking-at " *"))
  8273. (let* ((match-data (match-data))
  8274. (startpos (point-at-bol))
  8275. (logging (save-match-data (org-entry-get nil "LOGGING" t)))
  8276. (org-log-done org-log-done)
  8277. (org-log-repeat org-log-repeat)
  8278. (org-todo-log-states org-todo-log-states)
  8279. (this (match-string 1))
  8280. (hl-pos (match-beginning 0))
  8281. (head (org-get-todo-sequence-head this))
  8282. (ass (assoc head org-todo-kwd-alist))
  8283. (interpret (nth 1 ass))
  8284. (done-word (nth 3 ass))
  8285. (final-done-word (nth 4 ass))
  8286. (last-state (or this ""))
  8287. (completion-ignore-case t)
  8288. (member (member this org-todo-keywords-1))
  8289. (tail (cdr member))
  8290. (state (cond
  8291. ((and org-todo-key-trigger
  8292. (or (and (equal arg '(4))
  8293. (eq org-use-fast-todo-selection 'prefix))
  8294. (and (not arg) org-use-fast-todo-selection
  8295. (not (eq org-use-fast-todo-selection
  8296. 'prefix)))))
  8297. ;; Use fast selection
  8298. (org-fast-todo-selection))
  8299. ((and (equal arg '(4))
  8300. (or (not org-use-fast-todo-selection)
  8301. (not org-todo-key-trigger)))
  8302. ;; Read a state with completion
  8303. (org-ido-completing-read
  8304. "State: " (mapcar (lambda(x) (list x))
  8305. org-todo-keywords-1)
  8306. nil t))
  8307. ((eq arg 'right)
  8308. (if this
  8309. (if tail (car tail) nil)
  8310. (car org-todo-keywords-1)))
  8311. ((eq arg 'left)
  8312. (if (equal member org-todo-keywords-1)
  8313. nil
  8314. (if this
  8315. (nth (- (length org-todo-keywords-1)
  8316. (length tail) 2)
  8317. org-todo-keywords-1)
  8318. (org-last org-todo-keywords-1))))
  8319. ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
  8320. (setq arg nil))) ; hack to fall back to cycling
  8321. (arg
  8322. ;; user or caller requests a specific state
  8323. (cond
  8324. ((equal arg "") nil)
  8325. ((eq arg 'none) nil)
  8326. ((eq arg 'done) (or done-word (car org-done-keywords)))
  8327. ((eq arg 'nextset)
  8328. (or (car (cdr (member head org-todo-heads)))
  8329. (car org-todo-heads)))
  8330. ((eq arg 'previousset)
  8331. (let ((org-todo-heads (reverse org-todo-heads)))
  8332. (or (car (cdr (member head org-todo-heads)))
  8333. (car org-todo-heads))))
  8334. ((car (member arg org-todo-keywords-1)))
  8335. ((nth (1- (prefix-numeric-value arg))
  8336. org-todo-keywords-1))))
  8337. ((null member) (or head (car org-todo-keywords-1)))
  8338. ((equal this final-done-word) nil) ;; -> make empty
  8339. ((null tail) nil) ;; -> first entry
  8340. ((memq interpret '(type priority))
  8341. (if (eq this-command last-command)
  8342. (car tail)
  8343. (if (> (length tail) 0)
  8344. (or done-word (car org-done-keywords))
  8345. nil)))
  8346. (t
  8347. (car tail))))
  8348. (state (or
  8349. (run-hook-with-args-until-success
  8350. 'org-todo-get-default-hook state last-state)
  8351. state))
  8352. (next (if state (concat " " state " ") " "))
  8353. (change-plist (list :type 'todo-state-change :from this :to state
  8354. :position startpos))
  8355. dolog now-done-p)
  8356. (when org-blocker-hook
  8357. (setq org-last-todo-state-is-todo
  8358. (not (member this org-done-keywords)))
  8359. (unless (save-excursion
  8360. (save-match-data
  8361. (run-hook-with-args-until-failure
  8362. 'org-blocker-hook change-plist)))
  8363. (if (interactive-p)
  8364. (error "TODO state change from %s to %s blocked" this state)
  8365. ;; fail silently
  8366. (message "TODO state change from %s to %s blocked" this state)
  8367. (throw 'exit nil))))
  8368. (store-match-data match-data)
  8369. (replace-match next t t)
  8370. (unless (pos-visible-in-window-p hl-pos)
  8371. (message "TODO state changed to %s" (org-trim next)))
  8372. (unless head
  8373. (setq head (org-get-todo-sequence-head state)
  8374. ass (assoc head org-todo-kwd-alist)
  8375. interpret (nth 1 ass)
  8376. done-word (nth 3 ass)
  8377. final-done-word (nth 4 ass)))
  8378. (when (memq arg '(nextset previousset))
  8379. (message "Keyword-Set %d/%d: %s"
  8380. (- (length org-todo-sets) -1
  8381. (length (memq (assoc state org-todo-sets) org-todo-sets)))
  8382. (length org-todo-sets)
  8383. (mapconcat 'identity (assoc state org-todo-sets) " ")))
  8384. (setq org-last-todo-state-is-todo
  8385. (not (member state org-done-keywords)))
  8386. (setq now-done-p (and (member state org-done-keywords)
  8387. (not (member this org-done-keywords))))
  8388. (and logging (org-local-logging logging))
  8389. (when (and (or org-todo-log-states org-log-done)
  8390. (not (memq arg '(nextset previousset))))
  8391. ;; we need to look at recording a time and note
  8392. (setq dolog (or (nth 1 (assoc state org-todo-log-states))
  8393. (nth 2 (assoc this org-todo-log-states))))
  8394. (when (and state
  8395. (member state org-not-done-keywords)
  8396. (not (member this org-not-done-keywords)))
  8397. ;; This is now a todo state and was not one before
  8398. ;; If there was a CLOSED time stamp, get rid of it.
  8399. (org-add-planning-info nil nil 'closed))
  8400. (when (and now-done-p org-log-done)
  8401. ;; It is now done, and it was not done before
  8402. (org-add-planning-info 'closed (org-current-time))
  8403. (if (and (not dolog) (eq 'note org-log-done))
  8404. (org-add-log-setup 'done state this 'findpos 'note)))
  8405. (when (and state dolog)
  8406. ;; This is a non-nil state, and we need to log it
  8407. (org-add-log-setup 'state state this 'findpos dolog)))
  8408. ;; Fixup tag positioning
  8409. (org-todo-trigger-tag-changes state)
  8410. (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
  8411. (when org-provide-todo-statistics
  8412. (org-update-parent-todo-statistics))
  8413. (run-hooks 'org-after-todo-state-change-hook)
  8414. (if (and arg (not (member state org-done-keywords)))
  8415. (setq head (org-get-todo-sequence-head state)))
  8416. (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
  8417. ;; Do we need to trigger a repeat?
  8418. (when now-done-p
  8419. (when (boundp 'org-agenda-headline-snapshot-before-repeat)
  8420. ;; This is for the agenda, take a snapshot of the headline.
  8421. (save-match-data
  8422. (setq org-agenda-headline-snapshot-before-repeat
  8423. (org-get-heading))))
  8424. (org-auto-repeat-maybe state))
  8425. ;; Fixup cursor location if close to the keyword
  8426. (if (and (outline-on-heading-p)
  8427. (not (bolp))
  8428. (save-excursion (beginning-of-line 1)
  8429. (looking-at org-todo-line-regexp))
  8430. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  8431. (progn
  8432. (goto-char (or (match-end 2) (match-end 1)))
  8433. (and (looking-at " ") (just-one-space))))
  8434. (when org-trigger-hook
  8435. (save-excursion
  8436. (run-hook-with-args 'org-trigger-hook change-plist))))))))
  8437. (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
  8438. "Block turning an entry into a TODO, using the hierarchy.
  8439. This checks whether the current task should be blocked from state
  8440. changes. Such blocking occurs when:
  8441. 1. The task has children which are not all in a completed state.
  8442. 2. A task has a parent with the property :ORDERED:, and there
  8443. are siblings prior to the current task with incomplete
  8444. status.
  8445. 3. The parent of the task is blocked because it has siblings that should
  8446. be done first, or is child of a block grandparent TODO entry."
  8447. (catch 'dont-block
  8448. ;; If this is not a todo state change, or if this entry is already DONE,
  8449. ;; do not block
  8450. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  8451. (member (plist-get change-plist :from)
  8452. (cons 'done org-done-keywords))
  8453. (member (plist-get change-plist :to)
  8454. (cons 'todo org-not-done-keywords)))
  8455. (throw 'dont-block t))
  8456. ;; If this task has children, and any are undone, it's blocked
  8457. (save-excursion
  8458. (org-back-to-heading t)
  8459. (let ((this-level (funcall outline-level)))
  8460. (outline-next-heading)
  8461. (let ((child-level (funcall outline-level)))
  8462. (while (and (not (eobp))
  8463. (> child-level this-level))
  8464. ;; this todo has children, check whether they are all
  8465. ;; completed
  8466. (if (and (not (org-entry-is-done-p))
  8467. (org-entry-is-todo-p))
  8468. (throw 'dont-block nil))
  8469. (outline-next-heading)
  8470. (setq child-level (funcall outline-level))))))
  8471. ;; Otherwise, if the task's parent has the :ORDERED: property, and
  8472. ;; any previous siblings are undone, it's blocked
  8473. (save-excursion
  8474. (org-back-to-heading t)
  8475. (let* ((pos (point))
  8476. (parent-pos (and (org-up-heading-safe) (point))))
  8477. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  8478. (when (and (org-entry-get (point) "ORDERED")
  8479. (forward-line 1)
  8480. (re-search-forward org-not-done-heading-regexp pos t))
  8481. (throw 'dont-block nil)) ; block, there is an older sibling not done.
  8482. ;; Search further up the hierarchy, to see if an anchestor is blocked
  8483. (while t
  8484. (goto-char parent-pos)
  8485. (if (not (looking-at org-not-done-heading-regexp))
  8486. (throw 'dont-block t)) ; do not block, parent is not a TODO
  8487. (setq pos (point))
  8488. (setq parent-pos (and (org-up-heading-safe) (point)))
  8489. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  8490. (when (and (org-entry-get (point) "ORDERED")
  8491. (forward-line 1)
  8492. (re-search-forward org-not-done-heading-regexp pos t))
  8493. (throw 'dont-block nil))))))) ; block, older sibling not done.
  8494. (defcustom org-track-ordered-property-with-tag nil
  8495. "Should the ORDERED property also be shown as a tag?
  8496. The ORDERED property decides if an entry should require subtasks to be
  8497. completed in sequence. Since a property is not very visible, setting
  8498. this option means that toggling the ORDERED property with the command
  8499. `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
  8500. not relevant for the behavior, but it makes things more visible.
  8501. Note that toggling the tag with tags commands will not change the property
  8502. and therefore not influence behavior!
  8503. This can be t, meaning the tag ORDERED should be used, It can also be a
  8504. string to select a different tag for this task."
  8505. :group 'org-todo
  8506. :type '(choice
  8507. (const :tag "No tracking" nil)
  8508. (const :tag "Track with ORDERED tag" t)
  8509. (string :tag "Use other tag")))
  8510. (defun org-toggle-ordered-property ()
  8511. "Toggle the ORDERED property of the current entry.
  8512. For better visibility, you can track the value of this property with a tag.
  8513. See variable `org-track-ordered-property-with-tag'."
  8514. (interactive)
  8515. (let* ((t1 org-track-ordered-property-with-tag)
  8516. (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
  8517. (save-excursion
  8518. (org-back-to-heading)
  8519. (if (org-entry-get nil "ORDERED")
  8520. (progn
  8521. (org-delete-property "ORDERED")
  8522. (and tag (org-toggle-tag tag 'off))
  8523. (message "Subtasks can be completed in arbitrary order"))
  8524. (org-entry-put nil "ORDERED" "t")
  8525. (and tag (org-toggle-tag tag 'on))
  8526. (message "Subtasks must be completed in sequence")))))
  8527. (defvar org-blocked-by-checkboxes) ; dynamically scoped
  8528. (defun org-block-todo-from-checkboxes (change-plist)
  8529. "Block turning an entry into a TODO, using checkboxes.
  8530. This checks whether the current task should be blocked from state
  8531. changes because there are uncheckd boxes in this entry."
  8532. (catch 'dont-block
  8533. ;; If this is not a todo state change, or if this entry is already DONE,
  8534. ;; do not block
  8535. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  8536. (member (plist-get change-plist :from)
  8537. (cons 'done org-done-keywords))
  8538. (member (plist-get change-plist :to)
  8539. (cons 'todo org-not-done-keywords)))
  8540. (throw 'dont-block t))
  8541. ;; If this task has checkboxes that are not checked, it's blocked
  8542. (save-excursion
  8543. (org-back-to-heading t)
  8544. (let ((beg (point)) end)
  8545. (outline-next-heading)
  8546. (setq end (point))
  8547. (goto-char beg)
  8548. (if (re-search-forward "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\)[ \t]+\\[[- ]\\]"
  8549. end t)
  8550. (progn
  8551. (if (boundp 'org-blocked-by-checkboxes)
  8552. (setq org-blocked-by-checkboxes t))
  8553. (throw 'dont-block nil)))))
  8554. t)) ; do not block
  8555. (defun org-update-parent-todo-statistics ()
  8556. "Update any statistics cookie in the parent of the current headline."
  8557. (interactive)
  8558. (let ((box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  8559. level (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
  8560. (catch 'exit
  8561. (save-excursion
  8562. (setq level (org-up-heading-safe))
  8563. (unless (and level
  8564. (not (equal (downcase
  8565. (or (org-entry-get
  8566. nil "COOKIE_DATA")
  8567. ""))
  8568. "checkbox")))
  8569. (throw 'exit nil))
  8570. (while (re-search-forward box-re (point-at-eol) t)
  8571. (setq cnt-all 0 cnt-done 0 cookie-present t)
  8572. (setq is-percent (match-end 2))
  8573. (save-match-data
  8574. (unless (outline-next-heading) (throw 'exit nil))
  8575. (while (looking-at org-todo-line-regexp)
  8576. (setq kwd (match-string 2))
  8577. (and kwd (setq cnt-all (1+ cnt-all)))
  8578. (and (member kwd org-done-keywords)
  8579. (setq cnt-done (1+ cnt-done)))
  8580. (condition-case nil
  8581. (org-forward-same-level 1)
  8582. (error (end-of-line 1)))))
  8583. (replace-match
  8584. (if is-percent
  8585. (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
  8586. (format "[%d/%d]" cnt-done cnt-all))))
  8587. (when cookie-present
  8588. (run-hook-with-args 'org-after-todo-statistics-hook
  8589. cnt-done (- cnt-all cnt-done)))))
  8590. (run-hooks 'org-todo-statistics-hook)))
  8591. (defvar org-after-todo-statistics-hook nil
  8592. "Hook that is called after a TODO statistics cookie has been updated.
  8593. Each function is called with two arguments: the number of not-done entries
  8594. and the number of done entries.
  8595. For example, the following function, when added to this hook, will switch
  8596. an entry to DONE when all children are done, and back to TODO when new
  8597. entries are set to a TODO status. Note that this hook is only called
  8598. when there is a statistics cookie in the headline!
  8599. (defun org-summary-todo (n-done n-not-done)
  8600. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  8601. (let (org-log-done org-log-states) ; turn off logging
  8602. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
  8603. ")
  8604. (defvar org-todo-statistics-hook nil
  8605. "Hook that is run whenever Org thinks TODO statistics should be updated.
  8606. This hook runs even if there is no statisics cookie present, in which case
  8607. `org-after-todo-statistics-hook' would not run.")
  8608. (defun org-todo-trigger-tag-changes (state)
  8609. "Apply the changes defined in `org-todo-state-tags-triggers'."
  8610. (let ((l org-todo-state-tags-triggers)
  8611. changes)
  8612. (when (or (not state) (equal state ""))
  8613. (setq changes (append changes (cdr (assoc "" l)))))
  8614. (when (and (stringp state) (> (length state) 0))
  8615. (setq changes (append changes (cdr (assoc state l)))))
  8616. (when (member state org-not-done-keywords)
  8617. (setq changes (append changes (cdr (assoc 'todo l)))))
  8618. (when (member state org-done-keywords)
  8619. (setq changes (append changes (cdr (assoc 'done l)))))
  8620. (dolist (c changes)
  8621. (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
  8622. (defun org-local-logging (value)
  8623. "Get logging settings from a property VALUE."
  8624. (let* (words w a)
  8625. ;; directly set the variables, they are already local.
  8626. (setq org-log-done nil
  8627. org-log-repeat nil
  8628. org-todo-log-states nil)
  8629. (setq words (org-split-string value))
  8630. (while (setq w (pop words))
  8631. (cond
  8632. ((setq a (assoc w org-startup-options))
  8633. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  8634. (set (nth 1 a) (nth 2 a))))
  8635. ((setq a (org-extract-log-state-settings w))
  8636. (and (member (car a) org-todo-keywords-1)
  8637. (push a org-todo-log-states)))))))
  8638. (defun org-get-todo-sequence-head (kwd)
  8639. "Return the head of the TODO sequence to which KWD belongs.
  8640. If KWD is not set, check if there is a text property remembering the
  8641. right sequence."
  8642. (let (p)
  8643. (cond
  8644. ((not kwd)
  8645. (or (get-text-property (point-at-bol) 'org-todo-head)
  8646. (progn
  8647. (setq p (next-single-property-change (point-at-bol) 'org-todo-head
  8648. nil (point-at-eol)))
  8649. (get-text-property p 'org-todo-head))))
  8650. ((not (member kwd org-todo-keywords-1))
  8651. (car org-todo-keywords-1))
  8652. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  8653. (defun org-fast-todo-selection ()
  8654. "Fast TODO keyword selection with single keys.
  8655. Returns the new TODO keyword, or nil if no state change should occur."
  8656. (let* ((fulltable org-todo-key-alist)
  8657. (done-keywords org-done-keywords) ;; needed for the faces.
  8658. (maxlen (apply 'max (mapcar
  8659. (lambda (x)
  8660. (if (stringp (car x)) (string-width (car x)) 0))
  8661. fulltable)))
  8662. (expert nil)
  8663. (fwidth (+ maxlen 3 1 3))
  8664. (ncol (/ (- (window-width) 4) fwidth))
  8665. tg cnt e c tbl
  8666. groups ingroup)
  8667. (save-excursion
  8668. (save-window-excursion
  8669. (if expert
  8670. (set-buffer (get-buffer-create " *Org todo*"))
  8671. (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
  8672. (erase-buffer)
  8673. (org-set-local 'org-done-keywords done-keywords)
  8674. (setq tbl fulltable cnt 0)
  8675. (while (setq e (pop tbl))
  8676. (cond
  8677. ((equal e '(:startgroup))
  8678. (push '() groups) (setq ingroup t)
  8679. (when (not (= cnt 0))
  8680. (setq cnt 0)
  8681. (insert "\n"))
  8682. (insert "{ "))
  8683. ((equal e '(:endgroup))
  8684. (setq ingroup nil cnt 0)
  8685. (insert "}\n"))
  8686. ((equal e '(:newline))
  8687. (when (not (= cnt 0))
  8688. (setq cnt 0)
  8689. (insert "\n")
  8690. (setq e (car tbl))
  8691. (while (equal (car tbl) '(:newline))
  8692. (insert "\n")
  8693. (setq tbl (cdr tbl)))))
  8694. (t
  8695. (setq tg (car e) c (cdr e))
  8696. (if ingroup (push tg (car groups)))
  8697. (setq tg (org-add-props tg nil 'face
  8698. (org-get-todo-face tg)))
  8699. (if (and (= cnt 0) (not ingroup)) (insert " "))
  8700. (insert "[" c "] " tg (make-string
  8701. (- fwidth 4 (length tg)) ?\ ))
  8702. (when (= (setq cnt (1+ cnt)) ncol)
  8703. (insert "\n")
  8704. (if ingroup (insert " "))
  8705. (setq cnt 0)))))
  8706. (insert "\n")
  8707. (goto-char (point-min))
  8708. (if (not expert) (org-fit-window-to-buffer))
  8709. (message "[a-z..]:Set [SPC]:clear")
  8710. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  8711. (cond
  8712. ((or (= c ?\C-g)
  8713. (and (= c ?q) (not (rassoc c fulltable))))
  8714. (setq quit-flag t))
  8715. ((= c ?\ ) nil)
  8716. ((setq e (rassoc c fulltable) tg (car e))
  8717. tg)
  8718. (t (setq quit-flag t)))))))
  8719. (defun org-entry-is-todo-p ()
  8720. (member (org-get-todo-state) org-not-done-keywords))
  8721. (defun org-entry-is-done-p ()
  8722. (member (org-get-todo-state) org-done-keywords))
  8723. (defun org-get-todo-state ()
  8724. (save-excursion
  8725. (org-back-to-heading t)
  8726. (and (looking-at org-todo-line-regexp)
  8727. (match-end 2)
  8728. (match-string 2))))
  8729. (defun org-at-date-range-p (&optional inactive-ok)
  8730. "Is the cursor inside a date range?"
  8731. (interactive)
  8732. (save-excursion
  8733. (catch 'exit
  8734. (let ((pos (point)))
  8735. (skip-chars-backward "^[<\r\n")
  8736. (skip-chars-backward "<[")
  8737. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  8738. (>= (match-end 0) pos)
  8739. (throw 'exit t))
  8740. (skip-chars-backward "^<[\r\n")
  8741. (skip-chars-backward "<[")
  8742. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  8743. (>= (match-end 0) pos)
  8744. (throw 'exit t)))
  8745. nil)))
  8746. (defun org-get-repeat ()
  8747. "Check if there is a deadline/schedule with repeater in this entry."
  8748. (save-match-data
  8749. (save-excursion
  8750. (org-back-to-heading t)
  8751. (if (re-search-forward
  8752. org-repeat-re (save-excursion (outline-next-heading) (point)) t)
  8753. (match-string 1)))))
  8754. (defvar org-last-changed-timestamp)
  8755. (defvar org-last-inserted-timestamp)
  8756. (defvar org-log-post-message)
  8757. (defvar org-log-note-purpose)
  8758. (defvar org-log-note-how)
  8759. (defvar org-log-note-extra)
  8760. (defun org-auto-repeat-maybe (done-word)
  8761. "Check if the current headline contains a repeated deadline/schedule.
  8762. If yes, set TODO state back to what it was and change the base date
  8763. of repeating deadline/scheduled time stamps to new date.
  8764. This function is run automatically after each state change to a DONE state."
  8765. ;; last-state is dynamically scoped into this function
  8766. (let* ((repeat (org-get-repeat))
  8767. (aa (assoc last-state org-todo-kwd-alist))
  8768. (interpret (nth 1 aa))
  8769. (head (nth 2 aa))
  8770. (whata '(("d" . day) ("m" . month) ("y" . year)))
  8771. (msg "Entry repeats: ")
  8772. (org-log-done nil)
  8773. (org-todo-log-states nil)
  8774. (nshiftmax 10) (nshift 0)
  8775. re type n what ts time)
  8776. (when repeat
  8777. (if (eq org-log-repeat t) (setq org-log-repeat 'state))
  8778. (org-todo (if (eq interpret 'type) last-state head))
  8779. (when org-log-repeat
  8780. (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
  8781. (memq 'org-add-log-note post-command-hook))
  8782. ;; OK, we are already setup for some record
  8783. (if (eq org-log-repeat 'note)
  8784. ;; make sure we take a note, not only a time stamp
  8785. (setq org-log-note-how 'note))
  8786. ;; Set up for taking a record
  8787. (org-add-log-setup 'state (or done-word (car org-done-keywords))
  8788. last-state
  8789. 'findpos org-log-repeat)))
  8790. (org-back-to-heading t)
  8791. (org-add-planning-info nil nil 'closed)
  8792. (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  8793. org-deadline-time-regexp "\\)\\|\\("
  8794. org-ts-regexp "\\)"))
  8795. (while (re-search-forward
  8796. re (save-excursion (outline-next-heading) (point)) t)
  8797. (setq type (if (match-end 1) org-scheduled-string
  8798. (if (match-end 3) org-deadline-string "Plain:"))
  8799. ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
  8800. (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([dwmy]\\)" ts)
  8801. (setq n (string-to-number (match-string 2 ts))
  8802. what (match-string 3 ts))
  8803. (if (equal what "w") (setq n (* n 7) what "d"))
  8804. ;; Preparation, see if we need to modify the start date for the change
  8805. (when (match-end 1)
  8806. (setq time (save-match-data (org-time-string-to-time ts)))
  8807. (cond
  8808. ((equal (match-string 1 ts) ".")
  8809. ;; Shift starting date to today
  8810. (org-timestamp-change
  8811. (- (time-to-days (current-time)) (time-to-days time))
  8812. 'day))
  8813. ((equal (match-string 1 ts) "+")
  8814. (while (or (= nshift 0)
  8815. (<= (time-to-days time) (time-to-days (current-time))))
  8816. (when (= (incf nshift) nshiftmax)
  8817. (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
  8818. (error "Abort")))
  8819. (org-timestamp-change n (cdr (assoc what whata)))
  8820. (org-at-timestamp-p t)
  8821. (setq ts (match-string 1))
  8822. (setq time (save-match-data (org-time-string-to-time ts))))
  8823. (org-timestamp-change (- n) (cdr (assoc what whata)))
  8824. ;; rematch, so that we have everything in place for the real shift
  8825. (org-at-timestamp-p t)
  8826. (setq ts (match-string 1))
  8827. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([dwmy]\\)" ts))))
  8828. (org-timestamp-change n (cdr (assoc what whata)))
  8829. (setq msg (concat msg type " " org-last-changed-timestamp " "))))
  8830. (setq org-log-post-message msg)
  8831. (message "%s" msg))))
  8832. (defun org-show-todo-tree (arg)
  8833. "Make a compact tree which shows all headlines marked with TODO.
  8834. The tree will show the lines where the regexp matches, and all higher
  8835. headlines above the match.
  8836. With a \\[universal-argument] prefix, also show the DONE entries.
  8837. With a numeric prefix N, construct a sparse tree for the Nth element
  8838. of `org-todo-keywords-1'."
  8839. (interactive "P")
  8840. (let ((case-fold-search nil)
  8841. (kwd-re
  8842. (cond ((null arg) org-not-done-regexp)
  8843. ((equal arg '(4))
  8844. (let ((kwd (org-ido-completing-read "Keyword (or KWD1|KWD2|...): "
  8845. (mapcar 'list org-todo-keywords-1))))
  8846. (concat "\\("
  8847. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  8848. "\\)\\>")))
  8849. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  8850. (regexp-quote (nth (1- (prefix-numeric-value arg))
  8851. org-todo-keywords-1)))
  8852. (t (error "Invalid prefix argument: %s" arg)))))
  8853. (message "%d TODO entries found"
  8854. (org-occur (concat "^" outline-regexp " *" kwd-re )))))
  8855. (defun org-deadline (&optional remove time)
  8856. "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
  8857. With argument REMOVE, remove any deadline from the item.
  8858. When TIME is set, it should be an internal time specification, and the
  8859. scheduling will use the corresponding date."
  8860. (interactive "P")
  8861. (if remove
  8862. (progn
  8863. (org-remove-timestamp-with-keyword org-deadline-string)
  8864. (message "Item no longer has a deadline."))
  8865. (if (org-get-repeat)
  8866. (error "Cannot change deadline on task with repeater, please do that by hand")
  8867. (org-add-planning-info 'deadline time 'closed)
  8868. (message "Deadline on %s" org-last-inserted-timestamp))))
  8869. (defun org-schedule (&optional remove time)
  8870. "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
  8871. With argument REMOVE, remove any scheduling date from the item.
  8872. When TIME is set, it should be an internal time specification, and the
  8873. scheduling will use the corresponding date."
  8874. (interactive "P")
  8875. (if remove
  8876. (progn
  8877. (org-remove-timestamp-with-keyword org-scheduled-string)
  8878. (message "Item is no longer scheduled."))
  8879. (if (org-get-repeat)
  8880. (error "Cannot reschedule task with repeater, please do that by hand")
  8881. (org-add-planning-info 'scheduled time 'closed)
  8882. (message "Scheduled to %s" org-last-inserted-timestamp))))
  8883. (defun org-get-scheduled-time (pom &optional inherit)
  8884. "Get the scheduled time as a time tuple, of a format suitable
  8885. for calling org-schedule with, or if there is no scheduling,
  8886. returns nil."
  8887. (let ((time (org-entry-get pom "SCHEDULED" inherit)))
  8888. (when time
  8889. (apply 'encode-time (org-parse-time-string time)))))
  8890. (defun org-get-deadline-time (pom &optional inherit)
  8891. "Get the deadine as a time tuple, of a format suitable for
  8892. calling org-deadlin with, or if there is no scheduling, returns
  8893. nil."
  8894. (let ((time (org-entry-get pom "DEADLINE" inherit)))
  8895. (when time
  8896. (apply 'encode-time (org-parse-time-string time)))))
  8897. (defun org-remove-timestamp-with-keyword (keyword)
  8898. "Remove all time stamps with KEYWORD in the current entry."
  8899. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  8900. beg)
  8901. (save-excursion
  8902. (org-back-to-heading t)
  8903. (setq beg (point))
  8904. (org-end-of-subtree t t)
  8905. (while (re-search-backward re beg t)
  8906. (replace-match "")
  8907. (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
  8908. (equal (char-before) ?\ ))
  8909. (backward-delete-char 1)
  8910. (if (string-match "^[ \t]*$" (buffer-substring
  8911. (point-at-bol) (point-at-eol)))
  8912. (delete-region (point-at-bol)
  8913. (min (point-max) (1+ (point-at-eol))))))))))
  8914. (defun org-add-planning-info (what &optional time &rest remove)
  8915. "Insert new timestamp with keyword in the line directly after the headline.
  8916. WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
  8917. If non is given, the user is prompted for a date.
  8918. REMOVE indicates what kind of entries to remove. An old WHAT entry will also
  8919. be removed."
  8920. (interactive)
  8921. (let (org-time-was-given org-end-time-was-given ts
  8922. end default-time default-input)
  8923. (catch 'exit
  8924. (when (and (not time) (memq what '(scheduled deadline)))
  8925. ;; Try to get a default date/time from existing timestamp
  8926. (save-excursion
  8927. (org-back-to-heading t)
  8928. (setq end (save-excursion (outline-next-heading) (point)))
  8929. (when (re-search-forward (if (eq what 'scheduled)
  8930. org-scheduled-time-regexp
  8931. org-deadline-time-regexp)
  8932. end t)
  8933. (setq ts (match-string 1)
  8934. default-time
  8935. (apply 'encode-time (org-parse-time-string ts))
  8936. default-input (and ts (org-get-compact-tod ts))))))
  8937. (when what
  8938. ;; If necessary, get the time from the user
  8939. (setq time (or time (org-read-date nil 'to-time nil nil
  8940. default-time default-input))))
  8941. (when (and org-insert-labeled-timestamps-at-point
  8942. (member what '(scheduled deadline)))
  8943. (insert
  8944. (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
  8945. (org-insert-time-stamp time org-time-was-given
  8946. nil nil nil (list org-end-time-was-given))
  8947. (setq what nil))
  8948. (save-excursion
  8949. (save-restriction
  8950. (let (col list elt ts buffer-invisibility-spec)
  8951. (org-back-to-heading t)
  8952. (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"))
  8953. (goto-char (match-end 1))
  8954. (setq col (current-column))
  8955. (goto-char (match-end 0))
  8956. (if (eobp) (insert "\n") (forward-char 1))
  8957. (when (and (not what)
  8958. (not (looking-at
  8959. (concat "[ \t]*"
  8960. org-keyword-time-not-clock-regexp))))
  8961. ;; Nothing to add, nothing to remove...... :-)
  8962. (throw 'exit nil))
  8963. (if (and (not (looking-at outline-regexp))
  8964. (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
  8965. "[^\r\n]*"))
  8966. (not (equal (match-string 1) org-clock-string)))
  8967. (narrow-to-region (match-beginning 0) (match-end 0))
  8968. (insert-before-markers "\n")
  8969. (backward-char 1)
  8970. (narrow-to-region (point) (point))
  8971. (and org-adapt-indentation (org-indent-to-column col)))
  8972. ;; Check if we have to remove something.
  8973. (setq list (cons what remove))
  8974. (while list
  8975. (setq elt (pop list))
  8976. (goto-char (point-min))
  8977. (when (or (and (eq elt 'scheduled)
  8978. (re-search-forward org-scheduled-time-regexp nil t))
  8979. (and (eq elt 'deadline)
  8980. (re-search-forward org-deadline-time-regexp nil t))
  8981. (and (eq elt 'closed)
  8982. (re-search-forward org-closed-time-regexp nil t)))
  8983. (replace-match "")
  8984. (if (looking-at "--+<[^>]+>") (replace-match ""))
  8985. (if (looking-at " +") (replace-match ""))))
  8986. (goto-char (point-max))
  8987. (when what
  8988. (insert
  8989. (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
  8990. (cond ((eq what 'scheduled) org-scheduled-string)
  8991. ((eq what 'deadline) org-deadline-string)
  8992. ((eq what 'closed) org-closed-string))
  8993. " ")
  8994. (setq ts (org-insert-time-stamp
  8995. time
  8996. (or org-time-was-given
  8997. (and (eq what 'closed) org-log-done-with-time))
  8998. (eq what 'closed)
  8999. nil nil (list org-end-time-was-given)))
  9000. (end-of-line 1))
  9001. (goto-char (point-min))
  9002. (widen)
  9003. (if (and (looking-at "[ \t]+\n")
  9004. (equal (char-before) ?\n))
  9005. (delete-region (1- (point)) (point-at-eol)))
  9006. ts))))))
  9007. (defvar org-log-note-marker (make-marker))
  9008. (defvar org-log-note-purpose nil)
  9009. (defvar org-log-note-state nil)
  9010. (defvar org-log-note-previous-state nil)
  9011. (defvar org-log-note-how nil)
  9012. (defvar org-log-note-extra nil)
  9013. (defvar org-log-note-window-configuration nil)
  9014. (defvar org-log-note-return-to (make-marker))
  9015. (defvar org-log-post-message nil
  9016. "Message to be displayed after a log note has been stored.
  9017. The auto-repeater uses this.")
  9018. (defun org-add-note ()
  9019. "Add a note to the current entry.
  9020. This is done in the same way as adding a state change note."
  9021. (interactive)
  9022. (org-add-log-setup 'note nil nil 'findpos nil))
  9023. (defvar org-property-end-re)
  9024. (defun org-add-log-setup (&optional purpose state prev-state
  9025. findpos how &optional extra)
  9026. "Set up the post command hook to take a note.
  9027. If this is about to TODO state change, the new state is expected in STATE.
  9028. When FINDPOS is non-nil, find the correct position for the note in
  9029. the current entry. If not, assume that it can be inserted at point.
  9030. HOW is an indicator what kind of note should be created.
  9031. EXTRA is additional text that will be inserted into the notes buffer."
  9032. (let* ((org-log-into-drawer (org-log-into-drawer))
  9033. (drawer (cond ((stringp org-log-into-drawer)
  9034. org-log-into-drawer)
  9035. (org-log-into-drawer "LOGBOOK")
  9036. (t nil))))
  9037. (save-restriction
  9038. (save-excursion
  9039. (when findpos
  9040. (org-back-to-heading t)
  9041. (narrow-to-region (point) (save-excursion
  9042. (outline-next-heading) (point)))
  9043. (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"
  9044. "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
  9045. "[^\r\n]*\\)?"))
  9046. (goto-char (match-end 0))
  9047. (cond
  9048. (drawer
  9049. (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
  9050. nil t)
  9051. (progn
  9052. (goto-char (match-end 0))
  9053. (or org-log-states-order-reversed
  9054. (and (re-search-forward org-property-end-re nil t)
  9055. (goto-char (1- (match-beginning 0))))))
  9056. (insert "\n:" drawer ":\n:END:")
  9057. (beginning-of-line 0)
  9058. (org-indent-line-function)
  9059. (beginning-of-line 2)
  9060. (org-indent-line-function)
  9061. (end-of-line 0)))
  9062. ((and org-log-state-notes-insert-after-drawers
  9063. (save-excursion
  9064. (forward-line) (looking-at org-drawer-regexp)))
  9065. (forward-line)
  9066. (while (looking-at org-drawer-regexp)
  9067. (goto-char (match-end 0))
  9068. (re-search-forward org-property-end-re (point-max) t)
  9069. (forward-line))
  9070. (forward-line -1)))
  9071. (unless org-log-states-order-reversed
  9072. (and (= (char-after) ?\n) (forward-char 1))
  9073. (org-skip-over-state-notes)
  9074. (skip-chars-backward " \t\n\r")))
  9075. (move-marker org-log-note-marker (point))
  9076. (setq org-log-note-purpose purpose
  9077. org-log-note-state state
  9078. org-log-note-previous-state prev-state
  9079. org-log-note-how how
  9080. org-log-note-extra extra)
  9081. (add-hook 'post-command-hook 'org-add-log-note 'append)))))
  9082. (defun org-skip-over-state-notes ()
  9083. "Skip past the list of State notes in an entry."
  9084. (if (looking-at "\n[ \t]*- State") (forward-char 1))
  9085. (while (looking-at "[ \t]*- State")
  9086. (condition-case nil
  9087. (org-next-item)
  9088. (error (org-end-of-item)))))
  9089. (defun org-add-log-note (&optional purpose)
  9090. "Pop up a window for taking a note, and add this note later at point."
  9091. (remove-hook 'post-command-hook 'org-add-log-note)
  9092. (setq org-log-note-window-configuration (current-window-configuration))
  9093. (delete-other-windows)
  9094. (move-marker org-log-note-return-to (point))
  9095. (switch-to-buffer (marker-buffer org-log-note-marker))
  9096. (goto-char org-log-note-marker)
  9097. (org-switch-to-buffer-other-window "*Org Note*")
  9098. (erase-buffer)
  9099. (if (memq org-log-note-how '(time state))
  9100. (let (current-prefix-arg) (org-store-log-note))
  9101. (let ((org-inhibit-startup t)) (org-mode))
  9102. (insert (format "# Insert note for %s.
  9103. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  9104. (cond
  9105. ((eq org-log-note-purpose 'clock-out) "stopped clock")
  9106. ((eq org-log-note-purpose 'done) "closed todo item")
  9107. ((eq org-log-note-purpose 'state)
  9108. (format "state change from \"%s\" to \"%s\""
  9109. (or org-log-note-previous-state "")
  9110. (or org-log-note-state "")))
  9111. ((eq org-log-note-purpose 'note)
  9112. "this entry")
  9113. (t (error "This should not happen")))))
  9114. (if org-log-note-extra (insert org-log-note-extra))
  9115. (org-set-local 'org-finish-function 'org-store-log-note)))
  9116. (defvar org-note-abort nil) ; dynamically scoped
  9117. (defun org-store-log-note ()
  9118. "Finish taking a log note, and insert it to where it belongs."
  9119. (let ((txt (buffer-string))
  9120. (note (cdr (assq org-log-note-purpose org-log-note-headings)))
  9121. lines ind)
  9122. (kill-buffer (current-buffer))
  9123. (while (string-match "\\`#.*\n[ \t\n]*" txt)
  9124. (setq txt (replace-match "" t t txt)))
  9125. (if (string-match "\\s-+\\'" txt)
  9126. (setq txt (replace-match "" t t txt)))
  9127. (setq lines (org-split-string txt "\n"))
  9128. (when (and note (string-match "\\S-" note))
  9129. (setq note
  9130. (org-replace-escapes
  9131. note
  9132. (list (cons "%u" (user-login-name))
  9133. (cons "%U" user-full-name)
  9134. (cons "%t" (format-time-string
  9135. (org-time-stamp-format 'long 'inactive)
  9136. (current-time)))
  9137. (cons "%s" (if org-log-note-state
  9138. (concat "\"" org-log-note-state "\"")
  9139. ""))
  9140. (cons "%S" (if org-log-note-previous-state
  9141. (concat "\"" org-log-note-previous-state "\"")
  9142. "\"\"")))))
  9143. (if lines (setq note (concat note " \\\\")))
  9144. (push note lines))
  9145. (when (or current-prefix-arg org-note-abort)
  9146. (when org-log-into-drawer
  9147. (org-remove-empty-drawer-at
  9148. (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
  9149. org-log-note-marker))
  9150. (setq lines nil))
  9151. (when lines
  9152. (save-excursion
  9153. (set-buffer (marker-buffer org-log-note-marker))
  9154. (save-excursion
  9155. (goto-char org-log-note-marker)
  9156. (move-marker org-log-note-marker nil)
  9157. (end-of-line 1)
  9158. (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
  9159. (insert "- " (pop lines))
  9160. (org-indent-line-function)
  9161. (beginning-of-line 1)
  9162. (looking-at "[ \t]*")
  9163. (setq ind (concat (match-string 0) " "))
  9164. (end-of-line 1)
  9165. (while lines (insert "\n" ind (pop lines)))
  9166. (message "Note stored")
  9167. (org-back-to-heading t)
  9168. (org-cycle-hide-drawers 'children)))))
  9169. (set-window-configuration org-log-note-window-configuration)
  9170. (with-current-buffer (marker-buffer org-log-note-return-to)
  9171. (goto-char org-log-note-return-to))
  9172. (move-marker org-log-note-return-to nil)
  9173. (and org-log-post-message (message "%s" org-log-post-message)))
  9174. (defun org-remove-empty-drawer-at (drawer pos)
  9175. "Remove an emptyr DARWER drawer at position POS.
  9176. POS may also be a marker."
  9177. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  9178. (save-excursion
  9179. (save-restriction
  9180. (widen)
  9181. (goto-char pos)
  9182. (if (org-in-regexp
  9183. (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
  9184. (replace-match ""))))))
  9185. (defun org-sparse-tree (&optional arg)
  9186. "Create a sparse tree, prompt for the details.
  9187. This command can create sparse trees. You first need to select the type
  9188. of match used to create the tree:
  9189. t Show entries with a specific TODO keyword.
  9190. m Show entries selected by a tags/property match.
  9191. p Enter a property name and its value (both with completion on existing
  9192. names/values) and show entries with that property.
  9193. r Show entries matching a regular expression.
  9194. d Show deadlines due within `org-deadline-warning-days'.
  9195. b Show deadlines and scheduled items before a date.
  9196. a Show deadlines and scheduled items after a date."
  9197. (interactive "P")
  9198. (let (ans kwd value)
  9199. (message "Sparse tree: [/]regexp [t]odo-kwd [m]atch [p]roperty [d]eadlines [b]efore-date [a]fter-date")
  9200. (setq ans (read-char-exclusive))
  9201. (cond
  9202. ((equal ans ?d)
  9203. (call-interactively 'org-check-deadlines))
  9204. ((equal ans ?b)
  9205. (call-interactively 'org-check-before-date))
  9206. ((equal ans ?a)
  9207. (call-interactively 'org-check-after-date))
  9208. ((equal ans ?t)
  9209. (org-show-todo-tree '(4)))
  9210. ((member ans '(?T ?m))
  9211. (call-interactively 'org-match-sparse-tree))
  9212. ((member ans '(?p ?P))
  9213. (setq kwd (org-ido-completing-read "Property: "
  9214. (mapcar 'list (org-buffer-property-keys))))
  9215. (setq value (org-ido-completing-read "Value: "
  9216. (mapcar 'list (org-property-values kwd))))
  9217. (unless (string-match "\\`{.*}\\'" value)
  9218. (setq value (concat "\"" value "\"")))
  9219. (org-match-sparse-tree arg (concat kwd "=" value)))
  9220. ((member ans '(?r ?R ?/))
  9221. (call-interactively 'org-occur))
  9222. (t (error "No such sparse tree command \"%c\"" ans)))))
  9223. (defvar org-occur-highlights nil
  9224. "List of overlays used for occur matches.")
  9225. (make-variable-buffer-local 'org-occur-highlights)
  9226. (defvar org-occur-parameters nil
  9227. "Parameters of the active org-occur calls.
  9228. This is a list, each call to org-occur pushes as cons cell,
  9229. containing the regular expression and the callback, onto the list.
  9230. The list can contain several entries if `org-occur' has been called
  9231. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  9232. will only contain one set of parameters. When the highlights are
  9233. removed (for example with `C-c C-c', or with the next edit (depending
  9234. on `org-remove-highlights-with-change'), this variable is emptied
  9235. as well.")
  9236. (make-variable-buffer-local 'org-occur-parameters)
  9237. (defun org-occur (regexp &optional keep-previous callback)
  9238. "Make a compact tree which shows all matches of REGEXP.
  9239. The tree will show the lines where the regexp matches, and all higher
  9240. headlines above the match. It will also show the heading after the match,
  9241. to make sure editing the matching entry is easy.
  9242. If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
  9243. call to `org-occur' will be kept, to allow stacking of calls to this
  9244. command.
  9245. If CALLBACK is non-nil, it is a function which is called to confirm
  9246. that the match should indeed be shown."
  9247. (interactive "sRegexp: \nP")
  9248. (unless keep-previous
  9249. (org-remove-occur-highlights nil nil t))
  9250. (push (cons regexp callback) org-occur-parameters)
  9251. (let ((cnt 0))
  9252. (save-excursion
  9253. (goto-char (point-min))
  9254. (if (or (not keep-previous) ; do not want to keep
  9255. (not org-occur-highlights)) ; no previous matches
  9256. ;; hide everything
  9257. (org-overview))
  9258. (while (re-search-forward regexp nil t)
  9259. (when (or (not callback)
  9260. (save-match-data (funcall callback)))
  9261. (setq cnt (1+ cnt))
  9262. (when org-highlight-sparse-tree-matches
  9263. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  9264. (org-show-context 'occur-tree))))
  9265. (when org-remove-highlights-with-change
  9266. (org-add-hook 'before-change-functions 'org-remove-occur-highlights
  9267. nil 'local))
  9268. (unless org-sparse-tree-open-archived-trees
  9269. (org-hide-archived-subtrees (point-min) (point-max)))
  9270. (run-hooks 'org-occur-hook)
  9271. (if (interactive-p)
  9272. (message "%d match(es) for regexp %s" cnt regexp))
  9273. cnt))
  9274. (defun org-show-context (&optional key)
  9275. "Make sure point and context and visible.
  9276. How much context is shown depends upon the variables
  9277. `org-show-hierarchy-above', `org-show-following-heading'. and
  9278. `org-show-siblings'."
  9279. (let ((heading-p (org-on-heading-p t))
  9280. (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
  9281. (following-p (org-get-alist-option org-show-following-heading key))
  9282. (entry-p (org-get-alist-option org-show-entry-below key))
  9283. (siblings-p (org-get-alist-option org-show-siblings key)))
  9284. (catch 'exit
  9285. ;; Show heading or entry text
  9286. (if (and heading-p (not entry-p))
  9287. (org-flag-heading nil) ; only show the heading
  9288. (and (or entry-p (org-invisible-p) (org-invisible-p2))
  9289. (org-show-hidden-entry))) ; show entire entry
  9290. (when following-p
  9291. ;; Show next sibling, or heading below text
  9292. (save-excursion
  9293. (and (if heading-p (org-goto-sibling) (outline-next-heading))
  9294. (org-flag-heading nil))))
  9295. (when siblings-p (org-show-siblings))
  9296. (when hierarchy-p
  9297. ;; show all higher headings, possibly with siblings
  9298. (save-excursion
  9299. (while (and (condition-case nil
  9300. (progn (org-up-heading-all 1) t)
  9301. (error nil))
  9302. (not (bobp)))
  9303. (org-flag-heading nil)
  9304. (when siblings-p (org-show-siblings))))))))
  9305. (defun org-reveal (&optional siblings)
  9306. "Show current entry, hierarchy above it, and the following headline.
  9307. This can be used to show a consistent set of context around locations
  9308. exposed with `org-show-hierarchy-above' or `org-show-following-heading'
  9309. not t for the search context.
  9310. With optional argument SIBLINGS, on each level of the hierarchy all
  9311. siblings are shown. This repairs the tree structure to what it would
  9312. look like when opened with hierarchical calls to `org-cycle'."
  9313. (interactive "P")
  9314. (let ((org-show-hierarchy-above t)
  9315. (org-show-following-heading t)
  9316. (org-show-siblings (if siblings t org-show-siblings)))
  9317. (org-show-context nil)))
  9318. (defun org-highlight-new-match (beg end)
  9319. "Highlight from BEG to END and mark the highlight is an occur headline."
  9320. (let ((ov (org-make-overlay beg end)))
  9321. (org-overlay-put ov 'face 'secondary-selection)
  9322. (push ov org-occur-highlights)))
  9323. (defun org-remove-occur-highlights (&optional beg end noremove)
  9324. "Remove the occur highlights from the buffer.
  9325. BEG and END are ignored. If NOREMOVE is nil, remove this function
  9326. from the `before-change-functions' in the current buffer."
  9327. (interactive)
  9328. (unless org-inhibit-highlight-removal
  9329. (mapc 'org-delete-overlay org-occur-highlights)
  9330. (setq org-occur-highlights nil)
  9331. (setq org-occur-parameters nil)
  9332. (unless noremove
  9333. (remove-hook 'before-change-functions
  9334. 'org-remove-occur-highlights 'local))))
  9335. ;;;; Priorities
  9336. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
  9337. "Regular expression matching the priority indicator.")
  9338. (defvar org-remove-priority-next-time nil)
  9339. (defun org-priority-up ()
  9340. "Increase the priority of the current item."
  9341. (interactive)
  9342. (org-priority 'up))
  9343. (defun org-priority-down ()
  9344. "Decrease the priority of the current item."
  9345. (interactive)
  9346. (org-priority 'down))
  9347. (defun org-priority (&optional action)
  9348. "Change the priority of an item by ARG.
  9349. ACTION can be `set', `up', `down', or a character."
  9350. (interactive)
  9351. (setq action (or action 'set))
  9352. (let (current new news have remove)
  9353. (save-excursion
  9354. (org-back-to-heading t)
  9355. (if (looking-at org-priority-regexp)
  9356. (setq current (string-to-char (match-string 2))
  9357. have t)
  9358. (setq current org-default-priority))
  9359. (cond
  9360. ((or (eq action 'set)
  9361. (if (featurep 'xemacs) (characterp action) (integerp action)))
  9362. (if (not (eq action 'set))
  9363. (setq new action)
  9364. (message "Priority %c-%c, SPC to remove: "
  9365. org-highest-priority org-lowest-priority)
  9366. (setq new (read-char-exclusive)))
  9367. (if (and (= (upcase org-highest-priority) org-highest-priority)
  9368. (= (upcase org-lowest-priority) org-lowest-priority))
  9369. (setq new (upcase new)))
  9370. (cond ((equal new ?\ ) (setq remove t))
  9371. ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
  9372. (error "Priority must be between `%c' and `%c'"
  9373. org-highest-priority org-lowest-priority))))
  9374. ((eq action 'up)
  9375. (if (and (not have) (eq last-command this-command))
  9376. (setq new org-lowest-priority)
  9377. (setq new (if (and org-priority-start-cycle-with-default (not have))
  9378. org-default-priority (1- current)))))
  9379. ((eq action 'down)
  9380. (if (and (not have) (eq last-command this-command))
  9381. (setq new org-highest-priority)
  9382. (setq new (if (and org-priority-start-cycle-with-default (not have))
  9383. org-default-priority (1+ current)))))
  9384. (t (error "Invalid action")))
  9385. (if (or (< (upcase new) org-highest-priority)
  9386. (> (upcase new) org-lowest-priority))
  9387. (setq remove t))
  9388. (setq news (format "%c" new))
  9389. (if have
  9390. (if remove
  9391. (replace-match "" t t nil 1)
  9392. (replace-match news t t nil 2))
  9393. (if remove
  9394. (error "No priority cookie found in line")
  9395. (let ((case-fold-search nil))
  9396. (looking-at org-todo-line-regexp))
  9397. (if (match-end 2)
  9398. (progn
  9399. (goto-char (match-end 2))
  9400. (insert " [#" news "]"))
  9401. (goto-char (match-beginning 3))
  9402. (insert "[#" news "] ")))))
  9403. (org-preserve-lc (org-set-tags nil 'align))
  9404. (if remove
  9405. (message "Priority removed")
  9406. (message "Priority of current item set to %s" news))))
  9407. (defun org-get-priority (s)
  9408. "Find priority cookie and return priority."
  9409. (save-match-data
  9410. (if (not (string-match org-priority-regexp s))
  9411. (* 1000 (- org-lowest-priority org-default-priority))
  9412. (* 1000 (- org-lowest-priority
  9413. (string-to-char (match-string 2 s)))))))
  9414. ;;;; Tags
  9415. (defvar org-agenda-archives-mode)
  9416. (defvar org-map-continue-from nil
  9417. "Position from where mapping should continue.
  9418. Can be set byt the action argument to `org-scan-tag's and `org-map-entries'.")
  9419. (defvar org-scanner-tags nil
  9420. "The current tag list while the tags scanner is running.")
  9421. (defvar org-trust-scanner-tags nil
  9422. "Should `org-get-tags-at' use the tags fro the scanner.
  9423. This is for internal dynamical scoping only.
  9424. When this is non-nil, the function `org-get-tags-at' will return the value
  9425. of `org-scanner-tags' instead of building the list by itself. This
  9426. can lead to large speed-ups when the tags scanner is used in a file with
  9427. many entries, and when the list of tags is retrieved, for example to
  9428. obtain a list of properties. Building the tags list for each entry in such
  9429. a file becomes an N^2 operation - but with this variable set, it scales
  9430. as N.")
  9431. (defun org-scan-tags (action matcher &optional todo-only)
  9432. "Scan headline tags with inheritance and produce output ACTION.
  9433. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  9434. or `agenda' to produce an entry list for an agenda view. It can also be
  9435. a Lisp form or a function that should be called at each matched headline, in
  9436. this case the return value is a list of all return values from these calls.
  9437. MATCHER is a Lisp form to be evaluated, testing if a given set of tags
  9438. qualifies a headline for inclusion. When TODO-ONLY is non-nil,
  9439. only lines with a TODO keyword are included in the output."
  9440. (require 'org-agenda)
  9441. (let* ((re (concat "^" outline-regexp " *\\(\\<\\("
  9442. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  9443. (org-re
  9444. "\\>\\)\\)? *\\(.*?\\)\\(:[[:alnum:]_@:]+:\\)?[ \t]*$")))
  9445. (props (list 'face 'default
  9446. 'done-face 'org-agenda-done
  9447. 'undone-face 'default
  9448. 'mouse-face 'highlight
  9449. 'org-not-done-regexp org-not-done-regexp
  9450. 'org-todo-regexp org-todo-regexp
  9451. 'keymap org-agenda-keymap
  9452. 'help-echo
  9453. (format "mouse-2 or RET jump to org file %s"
  9454. (abbreviate-file-name
  9455. (or (buffer-file-name (buffer-base-buffer))
  9456. (buffer-name (buffer-base-buffer)))))))
  9457. (case-fold-search nil)
  9458. (org-map-continue-from nil)
  9459. lspos tags tags-list
  9460. (tags-alist (list (cons 0 org-file-tags)))
  9461. (llast 0) rtn rtn1 level category i txt
  9462. todo marker entry priority)
  9463. (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
  9464. (setq action (list 'lambda nil action)))
  9465. (save-excursion
  9466. (goto-char (point-min))
  9467. (when (eq action 'sparse-tree)
  9468. (org-overview)
  9469. (org-remove-occur-highlights))
  9470. (while (re-search-forward re nil t)
  9471. (catch :skip
  9472. (setq todo (if (match-end 1) (org-match-string-no-properties 2))
  9473. tags (if (match-end 4) (org-match-string-no-properties 4)))
  9474. (goto-char (setq lspos (match-beginning 0)))
  9475. (setq level (org-reduced-level (funcall outline-level))
  9476. category (org-get-category))
  9477. (setq i llast llast level)
  9478. ;; remove tag lists from same and sublevels
  9479. (while (>= i level)
  9480. (when (setq entry (assoc i tags-alist))
  9481. (setq tags-alist (delete entry tags-alist)))
  9482. (setq i (1- i)))
  9483. ;; add the next tags
  9484. (when tags
  9485. (setq tags (org-split-string tags ":")
  9486. tags-alist
  9487. (cons (cons level tags) tags-alist)))
  9488. ;; compile tags for current headline
  9489. (setq tags-list
  9490. (if org-use-tag-inheritance
  9491. (apply 'append (mapcar 'cdr (reverse tags-alist)))
  9492. tags)
  9493. org-scanner-tags tags-list)
  9494. (when org-use-tag-inheritance
  9495. (setcdr (car tags-alist)
  9496. (mapcar (lambda (x)
  9497. (setq x (copy-sequence x))
  9498. (org-add-prop-inherited x))
  9499. (cdar tags-alist))))
  9500. (when (and tags org-use-tag-inheritance
  9501. (or (not (eq t org-use-tag-inheritance))
  9502. org-tags-exclude-from-inheritance))
  9503. ;; selective inheritance, remove uninherited ones
  9504. (setcdr (car tags-alist)
  9505. (org-remove-uniherited-tags (cdar tags-alist))))
  9506. (when (and (or (not todo-only)
  9507. (and (member todo org-not-done-keywords)
  9508. (or (not org-agenda-tags-todo-honor-ignore-options)
  9509. (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
  9510. (let ((case-fold-search t)) (eval matcher))
  9511. (or
  9512. (not (member org-archive-tag tags-list))
  9513. ;; we have an archive tag, should we use this anyway?
  9514. (or (not org-agenda-skip-archived-trees)
  9515. (and (eq action 'agenda) org-agenda-archives-mode))))
  9516. (unless (eq action 'sparse-tree) (org-agenda-skip))
  9517. ;; select this headline
  9518. (cond
  9519. ((eq action 'sparse-tree)
  9520. (and org-highlight-sparse-tree-matches
  9521. (org-get-heading) (match-end 0)
  9522. (org-highlight-new-match
  9523. (match-beginning 0) (match-beginning 1)))
  9524. (org-show-context 'tags-tree))
  9525. ((eq action 'agenda)
  9526. (setq txt (org-format-agenda-item
  9527. ""
  9528. (concat
  9529. (if (eq org-tags-match-list-sublevels 'indented)
  9530. (make-string (1- level) ?.) "")
  9531. (org-get-heading))
  9532. category
  9533. tags-list
  9534. )
  9535. priority (org-get-priority txt))
  9536. (goto-char lspos)
  9537. (setq marker (org-agenda-new-marker))
  9538. (org-add-props txt props
  9539. 'org-marker marker 'org-hd-marker marker 'org-category category
  9540. 'todo-state todo
  9541. 'priority priority 'type "tagsmatch")
  9542. (push txt rtn))
  9543. ((functionp action)
  9544. (setq org-map-continue-from nil)
  9545. (save-excursion
  9546. (setq rtn1 (funcall action))
  9547. (push rtn1 rtn)))
  9548. (t (error "Invalid action")))
  9549. ;; if we are to skip sublevels, jump to end of subtree
  9550. (unless org-tags-match-list-sublevels
  9551. (org-end-of-subtree t)
  9552. (backward-char 1))))
  9553. ;; Get the correct position from where to continue
  9554. (if org-map-continue-from
  9555. (goto-char org-map-continue-from)
  9556. (and (= (point) lspos) (end-of-line 1)))))
  9557. (when (and (eq action 'sparse-tree)
  9558. (not org-sparse-tree-open-archived-trees))
  9559. (org-hide-archived-subtrees (point-min) (point-max)))
  9560. (nreverse rtn)))
  9561. (defun org-remove-uniherited-tags (tags)
  9562. "Remove all tags that are not inherited from the list TAGS."
  9563. (cond
  9564. ((eq org-use-tag-inheritance t)
  9565. (if org-tags-exclude-from-inheritance
  9566. (org-delete-all org-tags-exclude-from-inheritance tags)
  9567. tags))
  9568. ((not org-use-tag-inheritance) nil)
  9569. ((stringp org-use-tag-inheritance)
  9570. (delq nil (mapcar
  9571. (lambda (x)
  9572. (if (and (string-match org-use-tag-inheritance x)
  9573. (not (member x org-tags-exclude-from-inheritance)))
  9574. x nil))
  9575. tags)))
  9576. ((listp org-use-tag-inheritance)
  9577. (delq nil (mapcar
  9578. (lambda (x)
  9579. (if (member x org-use-tag-inheritance) x nil))
  9580. tags)))))
  9581. (defvar todo-only) ;; dynamically scoped
  9582. (defun org-match-sparse-tree (&optional todo-only match)
  9583. "Create a sparse tree according to tags string MATCH.
  9584. MATCH can contain positive and negative selection of tags, like
  9585. \"+WORK+URGENT-WITHBOSS\".
  9586. If optional argument TODO-ONLY is non-nil, only select lines that are
  9587. also TODO lines."
  9588. (interactive "P")
  9589. (org-prepare-agenda-buffers (list (current-buffer)))
  9590. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
  9591. (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
  9592. (defvar org-cached-props nil)
  9593. (defun org-cached-entry-get (pom property)
  9594. (if (or (eq t org-use-property-inheritance)
  9595. (and (stringp org-use-property-inheritance)
  9596. (string-match org-use-property-inheritance property))
  9597. (and (listp org-use-property-inheritance)
  9598. (member property org-use-property-inheritance)))
  9599. ;; Caching is not possible, check it directly
  9600. (org-entry-get pom property 'inherit)
  9601. ;; Get all properties, so that we can do complicated checks easily
  9602. (cdr (assoc property (or org-cached-props
  9603. (setq org-cached-props
  9604. (org-entry-properties pom)))))))
  9605. (defun org-global-tags-completion-table (&optional files)
  9606. "Return the list of all tags in all agenda buffer/files."
  9607. (save-excursion
  9608. (org-uniquify
  9609. (delq nil
  9610. (apply 'append
  9611. (mapcar
  9612. (lambda (file)
  9613. (set-buffer (find-file-noselect file))
  9614. (append (org-get-buffer-tags)
  9615. (mapcar (lambda (x) (if (stringp (car-safe x))
  9616. (list (car-safe x)) nil))
  9617. org-tag-alist)))
  9618. (if (and files (car files))
  9619. files
  9620. (org-agenda-files))))))))
  9621. (defun org-make-tags-matcher (match)
  9622. "Create the TAGS//TODO matcher form for the selection string MATCH."
  9623. ;; todo-only is scoped dynamically into this function, and the function
  9624. ;; may change it if the matcher asks for it.
  9625. (unless match
  9626. ;; Get a new match request, with completion
  9627. (let ((org-last-tags-completion-table
  9628. (org-global-tags-completion-table)))
  9629. (setq match (org-completing-read-no-ido
  9630. "Match: " 'org-tags-completion-function nil nil nil
  9631. 'org-tags-history))))
  9632. ;; Parse the string and create a lisp form
  9633. (let ((match0 match)
  9634. (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@]+\\)"))
  9635. minus tag mm
  9636. tagsmatch todomatch tagsmatcher todomatcher kwd matcher
  9637. orterms term orlist re-p str-p level-p level-op time-p
  9638. prop-p pn pv po cat-p gv rest)
  9639. (if (string-match "/+" match)
  9640. ;; match contains also a todo-matching request
  9641. (progn
  9642. (setq tagsmatch (substring match 0 (match-beginning 0))
  9643. todomatch (substring match (match-end 0)))
  9644. (if (string-match "^!" todomatch)
  9645. (setq todo-only t todomatch (substring todomatch 1)))
  9646. (if (string-match "^\\s-*$" todomatch)
  9647. (setq todomatch nil)))
  9648. ;; only matching tags
  9649. (setq tagsmatch match todomatch nil))
  9650. ;; Make the tags matcher
  9651. (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
  9652. (setq tagsmatcher t)
  9653. (setq orterms (org-split-string tagsmatch "|") orlist nil)
  9654. (while (setq term (pop orterms))
  9655. (while (and (equal (substring term -1) "\\") orterms)
  9656. (setq term (concat term "|" (pop orterms)))) ; repair bad split
  9657. (while (string-match re term)
  9658. (setq rest (substring term (match-end 0))
  9659. minus (and (match-end 1)
  9660. (equal (match-string 1 term) "-"))
  9661. tag (match-string 2 term)
  9662. re-p (equal (string-to-char tag) ?{)
  9663. level-p (match-end 4)
  9664. prop-p (match-end 5)
  9665. mm (cond
  9666. (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
  9667. (level-p
  9668. (setq level-op (org-op-to-function (match-string 3 term)))
  9669. `(,level-op level ,(string-to-number
  9670. (match-string 4 term))))
  9671. (prop-p
  9672. (setq pn (match-string 5 term)
  9673. po (match-string 6 term)
  9674. pv (match-string 7 term)
  9675. cat-p (equal pn "CATEGORY")
  9676. re-p (equal (string-to-char pv) ?{)
  9677. str-p (equal (string-to-char pv) ?\")
  9678. time-p (save-match-data
  9679. (string-match "^\"[[<].*[]>]\"$" pv))
  9680. pv (if (or re-p str-p) (substring pv 1 -1) pv))
  9681. (if time-p (setq pv (org-matcher-time pv)))
  9682. (setq po (org-op-to-function po (if time-p 'time str-p)))
  9683. (cond
  9684. ((equal pn "CATEGORY")
  9685. (setq gv '(get-text-property (point) 'org-category)))
  9686. ((equal pn "TODO")
  9687. (setq gv 'todo))
  9688. (t
  9689. (setq gv `(org-cached-entry-get nil ,pn))))
  9690. (if re-p
  9691. (if (eq po 'org<>)
  9692. `(not (string-match ,pv (or ,gv "")))
  9693. `(string-match ,pv (or ,gv "")))
  9694. (if str-p
  9695. `(,po (or ,gv "") ,pv)
  9696. `(,po (string-to-number (or ,gv ""))
  9697. ,(string-to-number pv) ))))
  9698. (t `(member ,tag tags-list)))
  9699. mm (if minus (list 'not mm) mm)
  9700. term rest)
  9701. (push mm tagsmatcher))
  9702. (push (if (> (length tagsmatcher) 1)
  9703. (cons 'and tagsmatcher)
  9704. (car tagsmatcher))
  9705. orlist)
  9706. (setq tagsmatcher nil))
  9707. (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
  9708. (setq tagsmatcher
  9709. (list 'progn '(setq org-cached-props nil) tagsmatcher)))
  9710. ;; Make the todo matcher
  9711. (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
  9712. (setq todomatcher t)
  9713. (setq orterms (org-split-string todomatch "|") orlist nil)
  9714. (while (setq term (pop orterms))
  9715. (while (string-match re term)
  9716. (setq minus (and (match-end 1)
  9717. (equal (match-string 1 term) "-"))
  9718. kwd (match-string 2 term)
  9719. re-p (equal (string-to-char kwd) ?{)
  9720. term (substring term (match-end 0))
  9721. mm (if re-p
  9722. `(string-match ,(substring kwd 1 -1) todo)
  9723. (list 'equal 'todo kwd))
  9724. mm (if minus (list 'not mm) mm))
  9725. (push mm todomatcher))
  9726. (push (if (> (length todomatcher) 1)
  9727. (cons 'and todomatcher)
  9728. (car todomatcher))
  9729. orlist)
  9730. (setq todomatcher nil))
  9731. (setq todomatcher (if (> (length orlist) 1)
  9732. (cons 'or orlist) (car orlist))))
  9733. ;; Return the string and lisp forms of the matcher
  9734. (setq matcher (if todomatcher
  9735. (list 'and tagsmatcher todomatcher)
  9736. tagsmatcher))
  9737. (cons match0 matcher)))
  9738. (defun org-op-to-function (op &optional stringp)
  9739. "Turn an operator into the appropriate function."
  9740. (setq op
  9741. (cond
  9742. ((equal op "<" ) '(< string< org-time<))
  9743. ((equal op ">" ) '(> org-string> org-time>))
  9744. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  9745. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  9746. ((member op '("=" "==")) '(= string= org-time=))
  9747. ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
  9748. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  9749. (defun org<> (a b) (not (= a b)))
  9750. (defun org-string<= (a b) (or (string= a b) (string< a b)))
  9751. (defun org-string>= (a b) (not (string< a b)))
  9752. (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
  9753. (defun org-string<> (a b) (not (string= a b)))
  9754. (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
  9755. (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
  9756. (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
  9757. (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
  9758. (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
  9759. (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
  9760. (defun org-2ft (s)
  9761. "Convert S to a floating point time.
  9762. If S is already a number, just return it. If it is a string, parse
  9763. it as a time string and apply `float-time' to it. If S is nil, just return 0."
  9764. (cond
  9765. ((numberp s) s)
  9766. ((stringp s)
  9767. (condition-case nil
  9768. (float-time (apply 'encode-time (org-parse-time-string s)))
  9769. (error 0.)))
  9770. (t 0.)))
  9771. (defun org-time-today ()
  9772. "Time in seconds today at 0:00.
  9773. Returns the float number of seconds since the beginning of the
  9774. epoch to the beginning of today (00:00)."
  9775. (float-time (apply 'encode-time
  9776. (append '(0 0 0) (nthcdr 3 (decode-time))))))
  9777. (defun org-matcher-time (s)
  9778. "Interpret a time comparison value."
  9779. (save-match-data
  9780. (cond
  9781. ((string= s "<now>") (float-time))
  9782. ((string= s "<today>") (org-time-today))
  9783. ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
  9784. ((string= s "<yesterday>") (- (org-time-today) 86400.0))
  9785. ((string-match "^<\\([-+][0-9]+\\)\\([dwmy]\\)>$" s)
  9786. (+ (org-time-today)
  9787. (* (string-to-number (match-string 1 s))
  9788. (cdr (assoc (match-string 2 s)
  9789. '(("d" . 86400.0) ("w" . 604800.0)
  9790. ("m" . 2678400.0) ("y" . 31557600.0)))))))
  9791. (t (org-2ft s)))))
  9792. (defun org-match-any-p (re list)
  9793. "Does re match any element of list?"
  9794. (setq list (mapcar (lambda (x) (string-match re x)) list))
  9795. (delq nil list))
  9796. (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
  9797. (defvar org-tags-overlay (org-make-overlay 1 1))
  9798. (org-detach-overlay org-tags-overlay)
  9799. (defun org-get-local-tags-at (&optional pos)
  9800. "Get a list of tags defined in the current headline."
  9801. (org-get-tags-at pos 'local))
  9802. (defun org-get-local-tags ()
  9803. "Get a list of tags defined in the current headline."
  9804. (org-get-tags-at nil 'local))
  9805. (defun org-get-tags-at (&optional pos local)
  9806. "Get a list of all headline tags applicable at POS.
  9807. POS defaults to point. If tags are inherited, the list contains
  9808. the targets in the same sequence as the headlines appear, i.e.
  9809. the tags of the current headline come last.
  9810. When LOCAL is non-nil, only return tags from the current headline,
  9811. ignore inherited ones."
  9812. (interactive)
  9813. (if (and org-trust-scanner-tags
  9814. (or (not pos) (equal pos (point)))
  9815. (not local))
  9816. org-scanner-tags
  9817. (let (tags ltags lastpos parent)
  9818. (save-excursion
  9819. (save-restriction
  9820. (widen)
  9821. (goto-char (or pos (point)))
  9822. (save-match-data
  9823. (catch 'done
  9824. (condition-case nil
  9825. (progn
  9826. (org-back-to-heading t)
  9827. (while (not (equal lastpos (point)))
  9828. (setq lastpos (point))
  9829. (when (looking-at
  9830. (org-re "[^\r\n]+?:\\([[:alnum:]_@:]+\\):[ \t]*$"))
  9831. (setq ltags (org-split-string
  9832. (org-match-string-no-properties 1) ":"))
  9833. (when parent
  9834. (setq ltags (mapcar 'org-add-prop-inherited ltags)))
  9835. (setq tags (append
  9836. (if parent
  9837. (org-remove-uniherited-tags ltags)
  9838. ltags)
  9839. tags)))
  9840. (or org-use-tag-inheritance (throw 'done t))
  9841. (if local (throw 'done t))
  9842. (or (org-up-heading-safe) (error nil))
  9843. (setq parent t)))
  9844. (error nil)))))
  9845. (append (org-remove-uniherited-tags org-file-tags) tags)))))
  9846. (defun org-add-prop-inherited (s)
  9847. (add-text-properties 0 (length s) '(inherited t) s)
  9848. s)
  9849. (defun org-toggle-tag (tag &optional onoff)
  9850. "Toggle the tag TAG for the current line.
  9851. If ONOFF is `on' or `off', don't toggle but set to this state."
  9852. (let (res current)
  9853. (save-excursion
  9854. (org-back-to-heading t)
  9855. (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@:]+\\):[ \t]*$")
  9856. (point-at-eol) t)
  9857. (progn
  9858. (setq current (match-string 1))
  9859. (replace-match ""))
  9860. (setq current ""))
  9861. (setq current (nreverse (org-split-string current ":")))
  9862. (cond
  9863. ((eq onoff 'on)
  9864. (setq res t)
  9865. (or (member tag current) (push tag current)))
  9866. ((eq onoff 'off)
  9867. (or (not (member tag current)) (setq current (delete tag current))))
  9868. (t (if (member tag current)
  9869. (setq current (delete tag current))
  9870. (setq res t)
  9871. (push tag current))))
  9872. (end-of-line 1)
  9873. (if current
  9874. (progn
  9875. (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
  9876. (org-set-tags nil t))
  9877. (delete-horizontal-space))
  9878. (run-hooks 'org-after-tags-change-hook))
  9879. res))
  9880. (defun org-align-tags-here (to-col)
  9881. ;; Assumes that this is a headline
  9882. (let ((pos (point)) (col (current-column)) ncol tags-l p)
  9883. (beginning-of-line 1)
  9884. (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  9885. (< pos (match-beginning 2)))
  9886. (progn
  9887. (setq tags-l (- (match-end 2) (match-beginning 2)))
  9888. (goto-char (match-beginning 1))
  9889. (insert " ")
  9890. (delete-region (point) (1+ (match-beginning 2)))
  9891. (setq ncol (max (1+ (current-column))
  9892. (1+ col)
  9893. (if (> to-col 0)
  9894. to-col
  9895. (- (abs to-col) tags-l))))
  9896. (setq p (point))
  9897. (insert (make-string (- ncol (current-column)) ?\ ))
  9898. (setq ncol (current-column))
  9899. (when indent-tabs-mode (tabify p (point-at-eol)))
  9900. (org-move-to-column (min ncol col) t))
  9901. (goto-char pos))))
  9902. (defun org-set-tags-command (&optional arg just-align)
  9903. "Call the set-tags command for the current entry."
  9904. (interactive "P")
  9905. (if (org-on-heading-p)
  9906. (org-set-tags arg just-align)
  9907. (save-excursion
  9908. (org-back-to-heading t)
  9909. (org-set-tags arg just-align))))
  9910. (defun org-set-tags (&optional arg just-align)
  9911. "Set the tags for the current headline.
  9912. With prefix ARG, realign all tags in headings in the current buffer."
  9913. (interactive "P")
  9914. (let* ((re (concat "^" outline-regexp))
  9915. (current (org-get-tags-string))
  9916. (col (current-column))
  9917. (org-setting-tags t)
  9918. table current-tags inherited-tags ; computed below when needed
  9919. tags p0 c0 c1 rpl)
  9920. (if arg
  9921. (save-excursion
  9922. (goto-char (point-min))
  9923. (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
  9924. (while (re-search-forward re nil t)
  9925. (org-set-tags nil t)
  9926. (end-of-line 1)))
  9927. (message "All tags realigned to column %d" org-tags-column))
  9928. (if just-align
  9929. (setq tags current)
  9930. ;; Get a new set of tags from the user
  9931. (save-excursion
  9932. (setq table (append org-tag-persistent-alist
  9933. (or org-tag-alist (org-get-buffer-tags)))
  9934. org-last-tags-completion-table table
  9935. current-tags (org-split-string current ":")
  9936. inherited-tags (nreverse
  9937. (nthcdr (length current-tags)
  9938. (nreverse (org-get-tags-at))))
  9939. tags
  9940. (if (or (eq t org-use-fast-tag-selection)
  9941. (and org-use-fast-tag-selection
  9942. (delq nil (mapcar 'cdr table))))
  9943. (org-fast-tag-selection
  9944. current-tags inherited-tags table
  9945. (if org-fast-tag-selection-include-todo org-todo-key-alist))
  9946. (let ((org-add-colon-after-tag-completion t))
  9947. (org-trim
  9948. (org-without-partial-completion
  9949. (org-ido-completing-read "Tags: " 'org-tags-completion-function
  9950. nil nil current 'org-tags-history)))))))
  9951. (while (string-match "[-+&]+" tags)
  9952. ;; No boolean logic, just a list
  9953. (setq tags (replace-match ":" t t tags))))
  9954. (if (string-match "\\`[\t ]*\\'" tags)
  9955. (setq tags "")
  9956. (unless (string-match ":$" tags) (setq tags (concat tags ":")))
  9957. (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
  9958. ;; Insert new tags at the correct column
  9959. (beginning-of-line 1)
  9960. (cond
  9961. ((and (equal current "") (equal tags "")))
  9962. ((re-search-forward
  9963. (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
  9964. (point-at-eol) t)
  9965. (if (equal tags "")
  9966. (setq rpl "")
  9967. (goto-char (match-beginning 0))
  9968. (setq c0 (current-column) p0 (point)
  9969. c1 (max (1+ c0) (if (> org-tags-column 0)
  9970. org-tags-column
  9971. (- (- org-tags-column) (length tags))))
  9972. rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
  9973. (replace-match rpl t t)
  9974. (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
  9975. tags)
  9976. (t (error "Tags alignment failed")))
  9977. (org-move-to-column col)
  9978. (unless just-align
  9979. (run-hooks 'org-after-tags-change-hook)))))
  9980. (defun org-change-tag-in-region (beg end tag off)
  9981. "Add or remove TAG for each entry in the region.
  9982. This works in the agenda, and also in an org-mode buffer."
  9983. (interactive
  9984. (list (region-beginning) (region-end)
  9985. (let ((org-last-tags-completion-table
  9986. (if (org-mode-p)
  9987. (org-get-buffer-tags)
  9988. (org-global-tags-completion-table))))
  9989. (org-ido-completing-read
  9990. "Tag: " 'org-tags-completion-function nil nil nil
  9991. 'org-tags-history))
  9992. (progn
  9993. (message "[s]et or [r]emove? ")
  9994. (equal (read-char-exclusive) ?r))))
  9995. (if (fboundp 'deactivate-mark) (deactivate-mark))
  9996. (let ((agendap (equal major-mode 'org-agenda-mode))
  9997. l1 l2 m buf pos newhead (cnt 0))
  9998. (goto-char end)
  9999. (setq l2 (1- (org-current-line)))
  10000. (goto-char beg)
  10001. (setq l1 (org-current-line))
  10002. (loop for l from l1 to l2 do
  10003. (goto-line l)
  10004. (setq m (get-text-property (point) 'org-hd-marker))
  10005. (when (or (and (org-mode-p) (org-on-heading-p))
  10006. (and agendap m))
  10007. (setq buf (if agendap (marker-buffer m) (current-buffer))
  10008. pos (if agendap m (point)))
  10009. (with-current-buffer buf
  10010. (save-excursion
  10011. (save-restriction
  10012. (goto-char pos)
  10013. (setq cnt (1+ cnt))
  10014. (org-toggle-tag tag (if off 'off 'on))
  10015. (setq newhead (org-get-heading)))))
  10016. (and agendap (org-agenda-change-all-lines newhead m))))
  10017. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  10018. (defun org-tags-completion-function (string predicate &optional flag)
  10019. (let (s1 s2 rtn (ctable org-last-tags-completion-table)
  10020. (confirm (lambda (x) (stringp (car x)))))
  10021. (if (string-match "^\\(.*[-+:&|]\\)\\([^-+:&|]*\\)$" string)
  10022. (setq s1 (match-string 1 string)
  10023. s2 (match-string 2 string))
  10024. (setq s1 "" s2 string))
  10025. (cond
  10026. ((eq flag nil)
  10027. ;; try completion
  10028. (setq rtn (try-completion s2 ctable confirm))
  10029. (if (stringp rtn)
  10030. (setq rtn
  10031. (concat s1 s2 (substring rtn (length s2))
  10032. (if (and org-add-colon-after-tag-completion
  10033. (assoc rtn ctable))
  10034. ":" ""))))
  10035. rtn)
  10036. ((eq flag t)
  10037. ;; all-completions
  10038. (all-completions s2 ctable confirm)
  10039. )
  10040. ((eq flag 'lambda)
  10041. ;; exact match?
  10042. (assoc s2 ctable)))
  10043. ))
  10044. (defun org-fast-tag-insert (kwd tags face &optional end)
  10045. "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
  10046. (insert (format "%-12s" (concat kwd ":"))
  10047. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  10048. (or end "")))
  10049. (defun org-fast-tag-show-exit (flag)
  10050. (save-excursion
  10051. (goto-line 3)
  10052. (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
  10053. (replace-match ""))
  10054. (when flag
  10055. (end-of-line 1)
  10056. (org-move-to-column (- (window-width) 19) t)
  10057. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  10058. (defun org-set-current-tags-overlay (current prefix)
  10059. (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
  10060. (if (featurep 'xemacs)
  10061. (org-overlay-display org-tags-overlay (concat prefix s)
  10062. 'secondary-selection)
  10063. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  10064. (org-overlay-display org-tags-overlay (concat prefix s)))))
  10065. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  10066. "Fast tag selection with single keys.
  10067. CURRENT is the current list of tags in the headline, INHERITED is the
  10068. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  10069. possibly with grouping information. TODO-TABLE is a similar table with
  10070. TODO keywords, should these have keys assigned to them.
  10071. If the keys are nil, a-z are automatically assigned.
  10072. Returns the new tags string, or nil to not change the current settings."
  10073. (let* ((fulltable (append table todo-table))
  10074. (maxlen (apply 'max (mapcar
  10075. (lambda (x)
  10076. (if (stringp (car x)) (string-width (car x)) 0))
  10077. fulltable)))
  10078. (buf (current-buffer))
  10079. (expert (eq org-fast-tag-selection-single-key 'expert))
  10080. (buffer-tags nil)
  10081. (fwidth (+ maxlen 3 1 3))
  10082. (ncol (/ (- (window-width) 4) fwidth))
  10083. (i-face 'org-done)
  10084. (c-face 'org-todo)
  10085. tg cnt e c char c1 c2 ntable tbl rtn
  10086. ov-start ov-end ov-prefix
  10087. (exit-after-next org-fast-tag-selection-single-key)
  10088. (done-keywords org-done-keywords)
  10089. groups ingroup)
  10090. (save-excursion
  10091. (beginning-of-line 1)
  10092. (if (looking-at
  10093. (org-re ".*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  10094. (setq ov-start (match-beginning 1)
  10095. ov-end (match-end 1)
  10096. ov-prefix "")
  10097. (setq ov-start (1- (point-at-eol))
  10098. ov-end (1+ ov-start))
  10099. (skip-chars-forward "^\n\r")
  10100. (setq ov-prefix
  10101. (concat
  10102. (buffer-substring (1- (point)) (point))
  10103. (if (> (current-column) org-tags-column)
  10104. " "
  10105. (make-string (- org-tags-column (current-column)) ?\ ))))))
  10106. (org-move-overlay org-tags-overlay ov-start ov-end)
  10107. (save-window-excursion
  10108. (if expert
  10109. (set-buffer (get-buffer-create " *Org tags*"))
  10110. (delete-other-windows)
  10111. (split-window-vertically)
  10112. (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
  10113. (erase-buffer)
  10114. (org-set-local 'org-done-keywords done-keywords)
  10115. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  10116. (org-fast-tag-insert "Current" current c-face "\n\n")
  10117. (org-fast-tag-show-exit exit-after-next)
  10118. (org-set-current-tags-overlay current ov-prefix)
  10119. (setq tbl fulltable char ?a cnt 0)
  10120. (while (setq e (pop tbl))
  10121. (cond
  10122. ((equal e '(:startgroup))
  10123. (push '() groups) (setq ingroup t)
  10124. (when (not (= cnt 0))
  10125. (setq cnt 0)
  10126. (insert "\n"))
  10127. (insert "{ "))
  10128. ((equal e '(:endgroup))
  10129. (setq ingroup nil cnt 0)
  10130. (insert "}\n"))
  10131. ((equal e '(:newline))
  10132. (when (not (= cnt 0))
  10133. (setq cnt 0)
  10134. (insert "\n")
  10135. (setq e (car tbl))
  10136. (while (equal (car tbl) '(:newline))
  10137. (insert "\n")
  10138. (setq tbl (cdr tbl)))))
  10139. (t
  10140. (setq tg (car e) c2 nil)
  10141. (if (cdr e)
  10142. (setq c (cdr e))
  10143. ;; automatically assign a character.
  10144. (setq c1 (string-to-char
  10145. (downcase (substring
  10146. tg (if (= (string-to-char tg) ?@) 1 0)))))
  10147. (if (or (rassoc c1 ntable) (rassoc c1 table))
  10148. (while (or (rassoc char ntable) (rassoc char table))
  10149. (setq char (1+ char)))
  10150. (setq c2 c1))
  10151. (setq c (or c2 char)))
  10152. (if ingroup (push tg (car groups)))
  10153. (setq tg (org-add-props tg nil 'face
  10154. (cond
  10155. ((not (assoc tg table))
  10156. (org-get-todo-face tg))
  10157. ((member tg current) c-face)
  10158. ((member tg inherited) i-face)
  10159. (t nil))))
  10160. (if (and (= cnt 0) (not ingroup)) (insert " "))
  10161. (insert "[" c "] " tg (make-string
  10162. (- fwidth 4 (length tg)) ?\ ))
  10163. (push (cons tg c) ntable)
  10164. (when (= (setq cnt (1+ cnt)) ncol)
  10165. (insert "\n")
  10166. (if ingroup (insert " "))
  10167. (setq cnt 0)))))
  10168. (setq ntable (nreverse ntable))
  10169. (insert "\n")
  10170. (goto-char (point-min))
  10171. (if (not expert) (org-fit-window-to-buffer))
  10172. (setq rtn
  10173. (catch 'exit
  10174. (while t
  10175. (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
  10176. (if groups " [!] no groups" " [!]groups")
  10177. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  10178. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  10179. (cond
  10180. ((= c ?\r) (throw 'exit t))
  10181. ((= c ?!)
  10182. (setq groups (not groups))
  10183. (goto-char (point-min))
  10184. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  10185. ((= c ?\C-c)
  10186. (if (not expert)
  10187. (org-fast-tag-show-exit
  10188. (setq exit-after-next (not exit-after-next)))
  10189. (setq expert nil)
  10190. (delete-other-windows)
  10191. (split-window-vertically)
  10192. (org-switch-to-buffer-other-window " *Org tags*")
  10193. (org-fit-window-to-buffer)))
  10194. ((or (= c ?\C-g)
  10195. (and (= c ?q) (not (rassoc c ntable))))
  10196. (org-detach-overlay org-tags-overlay)
  10197. (setq quit-flag t))
  10198. ((= c ?\ )
  10199. (setq current nil)
  10200. (if exit-after-next (setq exit-after-next 'now)))
  10201. ((= c ?\t)
  10202. (condition-case nil
  10203. (setq tg (org-ido-completing-read
  10204. "Tag: "
  10205. (or buffer-tags
  10206. (with-current-buffer buf
  10207. (org-get-buffer-tags)))))
  10208. (quit (setq tg "")))
  10209. (when (string-match "\\S-" tg)
  10210. (add-to-list 'buffer-tags (list tg))
  10211. (if (member tg current)
  10212. (setq current (delete tg current))
  10213. (push tg current)))
  10214. (if exit-after-next (setq exit-after-next 'now)))
  10215. ((setq e (rassoc c todo-table) tg (car e))
  10216. (with-current-buffer buf
  10217. (save-excursion (org-todo tg)))
  10218. (if exit-after-next (setq exit-after-next 'now)))
  10219. ((setq e (rassoc c ntable) tg (car e))
  10220. (if (member tg current)
  10221. (setq current (delete tg current))
  10222. (loop for g in groups do
  10223. (if (member tg g)
  10224. (mapc (lambda (x)
  10225. (setq current (delete x current)))
  10226. g)))
  10227. (push tg current))
  10228. (if exit-after-next (setq exit-after-next 'now))))
  10229. ;; Create a sorted list
  10230. (setq current
  10231. (sort current
  10232. (lambda (a b)
  10233. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  10234. (if (eq exit-after-next 'now) (throw 'exit t))
  10235. (goto-char (point-min))
  10236. (beginning-of-line 2)
  10237. (delete-region (point) (point-at-eol))
  10238. (org-fast-tag-insert "Current" current c-face)
  10239. (org-set-current-tags-overlay current ov-prefix)
  10240. (while (re-search-forward
  10241. (org-re "\\[.\\] \\([[:alnum:]_@]+\\)") nil t)
  10242. (setq tg (match-string 1))
  10243. (add-text-properties
  10244. (match-beginning 1) (match-end 1)
  10245. (list 'face
  10246. (cond
  10247. ((member tg current) c-face)
  10248. ((member tg inherited) i-face)
  10249. (t (get-text-property (match-beginning 1) 'face))))))
  10250. (goto-char (point-min)))))
  10251. (org-detach-overlay org-tags-overlay)
  10252. (if rtn
  10253. (mapconcat 'identity current ":")
  10254. nil))))
  10255. (defun org-get-tags-string ()
  10256. "Get the TAGS string in the current headline."
  10257. (unless (org-on-heading-p t)
  10258. (error "Not on a heading"))
  10259. (save-excursion
  10260. (beginning-of-line 1)
  10261. (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  10262. (org-match-string-no-properties 1)
  10263. "")))
  10264. (defun org-get-tags ()
  10265. "Get the list of tags specified in the current headline."
  10266. (org-split-string (org-get-tags-string) ":"))
  10267. (defun org-get-buffer-tags ()
  10268. "Get a table of all tags used in the buffer, for completion."
  10269. (let (tags)
  10270. (save-excursion
  10271. (goto-char (point-min))
  10272. (while (re-search-forward
  10273. (org-re "[ \t]:\\([[:alnum:]_@:]+\\):[ \t\r\n]") nil t)
  10274. (when (equal (char-after (point-at-bol 0)) ?*)
  10275. (mapc (lambda (x) (add-to-list 'tags x))
  10276. (org-split-string (org-match-string-no-properties 1) ":")))))
  10277. (mapcar 'list tags)))
  10278. ;;;; The mapping API
  10279. ;;;###autoload
  10280. (defun org-map-entries (func &optional match scope &rest skip)
  10281. "Call FUNC at each headline selected by MATCH in SCOPE.
  10282. FUNC is a function or a lisp form. The function will be called without
  10283. arguments, with the cursor positioned at the beginning of the headline.
  10284. The return values of all calls to the function will be collected and
  10285. returned as a list.
  10286. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  10287. does not need to preserve point. After evaluaton, the cursor will be
  10288. moved to the end of the line (presumably of the headline of the
  10289. processed entry) and search continues from there. Under some
  10290. circumstances, this may not produce the wanted results. For example,
  10291. if you have removed (e.g. archived) the current (sub)tree it could
  10292. mean that the next entry will be skipped entirely. In such cases, you
  10293. can specify the position from where search should continue by making
  10294. FUNC set the variable `org-map-continue-from' to the desired buffer
  10295. position.
  10296. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  10297. Only headlines that are matched by this query will be considered during
  10298. the iteration. When MATCH is nil or t, all headlines will be
  10299. visited by the iteration.
  10300. SCOPE determines the scope of this command. It can be any of:
  10301. nil The current buffer, respecting the restriction if any
  10302. tree The subtree started with the entry at point
  10303. file The current buffer, without restriction
  10304. file-with-archives
  10305. The current buffer, and any archives associated with it
  10306. agenda All agenda files
  10307. agenda-with-archives
  10308. All agenda files with any archive files associated with them
  10309. \(file1 file2 ...)
  10310. If this is a list, all files in the list will be scanned
  10311. The remaining args are treated as settings for the skipping facilities of
  10312. the scanner. The following items can be given here:
  10313. archive skip trees with the archive tag.
  10314. comment skip trees with the COMMENT keyword
  10315. function or Emacs Lisp form:
  10316. will be used as value for `org-agenda-skip-function', so whenever
  10317. the the function returns t, FUNC will not be called for that
  10318. entry and search will continue from the point where the
  10319. function leaves it.
  10320. If your function needs to retrieve the tags including inherited tags
  10321. at the *current* entry, you can use the value of the variable
  10322. `org-scanner-tags' which will be much faster than getting the value
  10323. with `org-get-tags-at'. If your function gets properties with
  10324. `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
  10325. to t around the call to `org-entry-properties' to get the same speedup.
  10326. Note that if your function moves around to retrieve tags and properties at
  10327. a *different* entry, you cannot use these techniques."
  10328. (let* ((org-agenda-archives-mode nil) ; just to make sure
  10329. (org-agenda-skip-archived-trees (memq 'archive skip))
  10330. (org-agenda-skip-comment-trees (memq 'comment skip))
  10331. (org-agenda-skip-function
  10332. (car (org-delete-all '(comment archive) skip)))
  10333. (org-tags-match-list-sublevels t)
  10334. matcher file res
  10335. org-todo-keywords-for-agenda
  10336. org-done-keywords-for-agenda
  10337. org-todo-keyword-alist-for-agenda
  10338. org-tag-alist-for-agenda)
  10339. (cond
  10340. ((eq match t) (setq matcher t))
  10341. ((eq match nil) (setq matcher t))
  10342. (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
  10343. (save-excursion
  10344. (save-restriction
  10345. (when (eq scope 'tree)
  10346. (org-back-to-heading t)
  10347. (org-narrow-to-subtree)
  10348. (setq scope nil))
  10349. (if (not scope)
  10350. (progn
  10351. (org-prepare-agenda-buffers
  10352. (list (buffer-file-name (current-buffer))))
  10353. (setq res (org-scan-tags func matcher)))
  10354. ;; Get the right scope
  10355. (cond
  10356. ((and scope (listp scope) (symbolp (car scope)))
  10357. (setq scope (eval scope)))
  10358. ((eq scope 'agenda)
  10359. (setq scope (org-agenda-files t)))
  10360. ((eq scope 'agenda-with-archives)
  10361. (setq scope (org-agenda-files t))
  10362. (setq scope (org-add-archive-files scope)))
  10363. ((eq scope 'file)
  10364. (setq scope (list (buffer-file-name))))
  10365. ((eq scope 'file-with-archives)
  10366. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  10367. (org-prepare-agenda-buffers scope)
  10368. (while (setq file (pop scope))
  10369. (with-current-buffer (org-find-base-buffer-visiting file)
  10370. (save-excursion
  10371. (save-restriction
  10372. (widen)
  10373. (goto-char (point-min))
  10374. (setq res (append res (org-scan-tags func matcher))))))))))
  10375. res))
  10376. ;;;; Properties
  10377. ;;; Setting and retrieving properties
  10378. (defconst org-special-properties
  10379. '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
  10380. "TIMESTAMP" "TIMESTAMP_IA")
  10381. "The special properties valid in Org-mode.
  10382. These are properties that are not defined in the property drawer,
  10383. but in some other way.")
  10384. (defconst org-default-properties
  10385. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
  10386. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  10387. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  10388. "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
  10389. "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER")
  10390. "Some properties that are used by Org-mode for various purposes.
  10391. Being in this list makes sure that they are offered for completion.")
  10392. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  10393. "Regular expression matching the first line of a property drawer.")
  10394. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  10395. "Regular expression matching the first line of a property drawer.")
  10396. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  10397. "Regular expression matching the first line of a property drawer.")
  10398. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  10399. "Regular expression matching the first line of a property drawer.")
  10400. (defconst org-property-drawer-re
  10401. (concat "\\(" org-property-start-re "\\)[^\000]*\\("
  10402. org-property-end-re "\\)\n?")
  10403. "Matches an entire property drawer.")
  10404. (defconst org-clock-drawer-re
  10405. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
  10406. org-property-end-re "\\)\n?")
  10407. "Matches an entire clock drawer.")
  10408. (defun org-property-action ()
  10409. "Do an action on properties."
  10410. (interactive)
  10411. (let (c)
  10412. (org-at-property-p)
  10413. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  10414. (setq c (read-char-exclusive))
  10415. (cond
  10416. ((equal c ?s)
  10417. (call-interactively 'org-set-property))
  10418. ((equal c ?d)
  10419. (call-interactively 'org-delete-property))
  10420. ((equal c ?D)
  10421. (call-interactively 'org-delete-property-globally))
  10422. ((equal c ?c)
  10423. (call-interactively 'org-compute-property-at-point))
  10424. (t (error "No such property action %c" c)))))
  10425. (defun org-at-property-p ()
  10426. "Is the cursor in a property line?"
  10427. ;; FIXME: Does not check if we are actually in the drawer.
  10428. ;; FIXME: also returns true on any drawers.....
  10429. ;; This is used by C-c C-c for property action.
  10430. (save-excursion
  10431. (beginning-of-line 1)
  10432. (looking-at (org-re "^[ \t]*\\(:\\([[:alpha:]][[:alnum:]_-]*\\):\\)[ \t]*\\(.*\\)"))))
  10433. (defun org-get-property-block (&optional beg end force)
  10434. "Return the (beg . end) range of the body of the property drawer.
  10435. BEG and END can be beginning and end of subtree, if not given
  10436. they will be found.
  10437. If the drawer does not exist and FORCE is non-nil, create the drawer."
  10438. (catch 'exit
  10439. (save-excursion
  10440. (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
  10441. (end (or end (progn (outline-next-heading) (point)))))
  10442. (goto-char beg)
  10443. (if (re-search-forward org-property-start-re end t)
  10444. (setq beg (1+ (match-end 0)))
  10445. (if force
  10446. (save-excursion
  10447. (org-insert-property-drawer)
  10448. (setq end (progn (outline-next-heading) (point))))
  10449. (throw 'exit nil))
  10450. (goto-char beg)
  10451. (if (re-search-forward org-property-start-re end t)
  10452. (setq beg (1+ (match-end 0)))))
  10453. (if (re-search-forward org-property-end-re end t)
  10454. (setq end (match-beginning 0))
  10455. (or force (throw 'exit nil))
  10456. (goto-char beg)
  10457. (setq end beg)
  10458. (org-indent-line-function)
  10459. (insert ":END:\n"))
  10460. (cons beg end)))))
  10461. (defun org-entry-properties (&optional pom which)
  10462. "Get all properties of the entry at point-or-marker POM.
  10463. This includes the TODO keyword, the tags, time strings for deadline,
  10464. scheduled, and clocking, and any additional properties defined in the
  10465. entry. The return value is an alist, keys may occur multiple times
  10466. if the property key was used several times.
  10467. POM may also be nil, in which case the current entry is used.
  10468. If WHICH is nil or `all', get all properties. If WHICH is
  10469. `special' or `standard', only get that subclass."
  10470. (setq which (or which 'all))
  10471. (org-with-point-at pom
  10472. (let ((clockstr (substring org-clock-string 0 -1))
  10473. (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
  10474. beg end range props sum-props key value string clocksum)
  10475. (save-excursion
  10476. (when (condition-case nil
  10477. (and (org-mode-p) (org-back-to-heading t))
  10478. (error nil))
  10479. (setq beg (point))
  10480. (setq sum-props (get-text-property (point) 'org-summaries))
  10481. (setq clocksum (get-text-property (point) :org-clock-minutes))
  10482. (outline-next-heading)
  10483. (setq end (point))
  10484. (when (memq which '(all special))
  10485. ;; Get the special properties, like TODO and tags
  10486. (goto-char beg)
  10487. (when (and (looking-at org-todo-line-regexp) (match-end 2))
  10488. (push (cons "TODO" (org-match-string-no-properties 2)) props))
  10489. (when (looking-at org-priority-regexp)
  10490. (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
  10491. (when (and (setq value (org-get-tags-string))
  10492. (string-match "\\S-" value))
  10493. (push (cons "TAGS" value) props))
  10494. (when (setq value (org-get-tags-at))
  10495. (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
  10496. props))
  10497. (while (re-search-forward org-maybe-keyword-time-regexp end t)
  10498. (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
  10499. string (if (equal key clockstr)
  10500. (org-no-properties
  10501. (org-trim
  10502. (buffer-substring
  10503. (match-beginning 3) (goto-char (point-at-eol)))))
  10504. (substring (org-match-string-no-properties 3) 1 -1)))
  10505. (unless key
  10506. (if (= (char-after (match-beginning 3)) ?\[)
  10507. (setq key "TIMESTAMP_IA")
  10508. (setq key "TIMESTAMP")))
  10509. (when (or (equal key clockstr) (not (assoc key props)))
  10510. (push (cons key string) props)))
  10511. )
  10512. (when (memq which '(all standard))
  10513. ;; Get the standard properties, like :PROP: ...
  10514. (setq range (org-get-property-block beg end))
  10515. (when range
  10516. (goto-char (car range))
  10517. (while (re-search-forward
  10518. (org-re "^[ \t]*:\\([[:alpha:]][[:alnum:]_-]*\\):[ \t]*\\(\\S-.*\\)?")
  10519. (cdr range) t)
  10520. (setq key (org-match-string-no-properties 1)
  10521. value (org-trim (or (org-match-string-no-properties 2) "")))
  10522. (unless (member key excluded)
  10523. (push (cons key (or value "")) props)))))
  10524. (if clocksum
  10525. (push (cons "CLOCKSUM"
  10526. (org-columns-number-to-string (/ (float clocksum) 60.)
  10527. 'add_times))
  10528. props))
  10529. (unless (assoc "CATEGORY" props)
  10530. (setq value (or (org-get-category)
  10531. (progn (org-refresh-category-properties)
  10532. (org-get-category))))
  10533. (push (cons "CATEGORY" value) props))
  10534. (append sum-props (nreverse props)))))))
  10535. (defun org-entry-get (pom property &optional inherit)
  10536. "Get value of PROPERTY for entry at point-or-marker POM.
  10537. If INHERIT is non-nil and the entry does not have the property,
  10538. then also check higher levels of the hierarchy.
  10539. If INHERIT is the symbol `selective', use inheritance only if the setting
  10540. in `org-use-property-inheritance' selects PROPERTY for inheritance.
  10541. If the property is present but empty, the return value is the empty string.
  10542. If the property is not present at all, nil is returned."
  10543. (org-with-point-at pom
  10544. (if (and inherit (if (eq inherit 'selective)
  10545. (org-property-inherit-p property)
  10546. t))
  10547. (org-entry-get-with-inheritance property)
  10548. (if (member property org-special-properties)
  10549. ;; We need a special property. Use brute force, get all properties.
  10550. (cdr (assoc property (org-entry-properties nil 'special)))
  10551. (let ((range (org-get-property-block)))
  10552. (if (and range
  10553. (goto-char (car range))
  10554. (re-search-forward
  10555. (concat "^[ \t]*:" property ":[ \t]*\\(.*[^ \t\r\n\f\v]\\)?")
  10556. (cdr range) t))
  10557. ;; Found the property, return it.
  10558. (if (match-end 1)
  10559. (org-match-string-no-properties 1)
  10560. "")))))))
  10561. (defun org-property-or-variable-value (var &optional inherit)
  10562. "Check if there is a property fixing the value of VAR.
  10563. If yes, return this value. If not, return the current value of the variable."
  10564. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  10565. (if (and prop (stringp prop) (string-match "\\S-" prop))
  10566. (read prop)
  10567. (symbol-value var))))
  10568. (defun org-entry-delete (pom property)
  10569. "Delete the property PROPERTY from entry at point-or-marker POM."
  10570. (org-with-point-at pom
  10571. (if (member property org-special-properties)
  10572. nil ; cannot delete these properties.
  10573. (let ((range (org-get-property-block)))
  10574. (if (and range
  10575. (goto-char (car range))
  10576. (re-search-forward
  10577. (concat "^[ \t]*:" property ":[ \t]*\\(.*[^ \t\r\n\f\v]\\)")
  10578. (cdr range) t))
  10579. (progn
  10580. (delete-region (match-beginning 0) (1+ (point-at-eol)))
  10581. t)
  10582. nil)))))
  10583. ;; Multi-values properties are properties that contain multiple values
  10584. ;; These values are assumed to be single words, separated by whitespace.
  10585. (defun org-entry-add-to-multivalued-property (pom property value)
  10586. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  10587. (let* ((old (org-entry-get pom property))
  10588. (values (and old (org-split-string old "[ \t]"))))
  10589. (setq value (org-entry-protect-space value))
  10590. (unless (member value values)
  10591. (setq values (cons value values))
  10592. (org-entry-put pom property
  10593. (mapconcat 'identity values " ")))))
  10594. (defun org-entry-remove-from-multivalued-property (pom property value)
  10595. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  10596. (let* ((old (org-entry-get pom property))
  10597. (values (and old (org-split-string old "[ \t]"))))
  10598. (setq value (org-entry-protect-space value))
  10599. (when (member value values)
  10600. (setq values (delete value values))
  10601. (org-entry-put pom property
  10602. (mapconcat 'identity values " ")))))
  10603. (defun org-entry-member-in-multivalued-property (pom property value)
  10604. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  10605. (let* ((old (org-entry-get pom property))
  10606. (values (and old (org-split-string old "[ \t]"))))
  10607. (setq value (org-entry-protect-space value))
  10608. (member value values)))
  10609. (defun org-entry-get-multivalued-property (pom property)
  10610. "Return a list of values in a multivalued property."
  10611. (let* ((value (org-entry-get pom property))
  10612. (values (and value (org-split-string value "[ \t]"))))
  10613. (mapcar 'org-entry-restore-space values)))
  10614. (defun org-entry-put-multivalued-property (pom property &rest values)
  10615. "Set multivalued PROPERTY at point-or-marker POM to VALUES.
  10616. VALUES should be a list of strings. Spaces will be protected."
  10617. (org-entry-put pom property
  10618. (mapconcat 'org-entry-protect-space values " "))
  10619. (let* ((value (org-entry-get pom property))
  10620. (values (and value (org-split-string value "[ \t]"))))
  10621. (mapcar 'org-entry-restore-space values)))
  10622. (defun org-entry-protect-space (s)
  10623. "Protect spaces and newline in string S."
  10624. (while (string-match " " s)
  10625. (setq s (replace-match "%20" t t s)))
  10626. (while (string-match "\n" s)
  10627. (setq s (replace-match "%0A" t t s)))
  10628. s)
  10629. (defun org-entry-restore-space (s)
  10630. "Restore spaces and newline in string S."
  10631. (while (string-match "%20" s)
  10632. (setq s (replace-match " " t t s)))
  10633. (while (string-match "%0A" s)
  10634. (setq s (replace-match "\n" t t s)))
  10635. s)
  10636. (defvar org-entry-property-inherited-from (make-marker)
  10637. "Marker pointing to the entry from where a property was inherited.
  10638. Each call to `org-entry-get-with-inheritance' will set this marker to the
  10639. location of the entry where the inheritance search matched. If there was
  10640. no match, the marker will point nowhere.
  10641. Note that also `org-entry-get' calls this function, if the INHERIT flag
  10642. is set.")
  10643. (defun org-entry-get-with-inheritance (property)
  10644. "Get entry property, and search higher levels if not present."
  10645. (move-marker org-entry-property-inherited-from nil)
  10646. (let (tmp)
  10647. (save-excursion
  10648. (save-restriction
  10649. (widen)
  10650. (catch 'ex
  10651. (while t
  10652. (when (setq tmp (org-entry-get nil property))
  10653. (org-back-to-heading t)
  10654. (move-marker org-entry-property-inherited-from (point))
  10655. (throw 'ex tmp))
  10656. (or (org-up-heading-safe) (throw 'ex nil)))))
  10657. (or tmp
  10658. (cdr (assoc property org-file-properties))
  10659. (cdr (assoc property org-global-properties))
  10660. (cdr (assoc property org-global-properties-fixed))))))
  10661. (defun org-entry-put (pom property value)
  10662. "Set PROPERTY to VALUE for entry at point-or-marker POM."
  10663. (org-with-point-at pom
  10664. (org-back-to-heading t)
  10665. (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
  10666. range)
  10667. (cond
  10668. ((equal property "TODO")
  10669. (when (and (stringp value) (string-match "\\S-" value)
  10670. (not (member value org-todo-keywords-1)))
  10671. (error "\"%s\" is not a valid TODO state" value))
  10672. (if (or (not value)
  10673. (not (string-match "\\S-" value)))
  10674. (setq value 'none))
  10675. (org-todo value)
  10676. (org-set-tags nil 'align))
  10677. ((equal property "PRIORITY")
  10678. (org-priority (if (and value (stringp value) (string-match "\\S-" value))
  10679. (string-to-char value) ?\ ))
  10680. (org-set-tags nil 'align))
  10681. ((equal property "SCHEDULED")
  10682. (if (re-search-forward org-scheduled-time-regexp end t)
  10683. (cond
  10684. ((eq value 'earlier) (org-timestamp-change -1 'day))
  10685. ((eq value 'later) (org-timestamp-change 1 'day))
  10686. (t (call-interactively 'org-schedule)))
  10687. (call-interactively 'org-schedule)))
  10688. ((equal property "DEADLINE")
  10689. (if (re-search-forward org-deadline-time-regexp end t)
  10690. (cond
  10691. ((eq value 'earlier) (org-timestamp-change -1 'day))
  10692. ((eq value 'later) (org-timestamp-change 1 'day))
  10693. (t (call-interactively 'org-deadline)))
  10694. (call-interactively 'org-deadline)))
  10695. ((member property org-special-properties)
  10696. (error "The %s property can not yet be set with `org-entry-put'"
  10697. property))
  10698. (t ; a non-special property
  10699. (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
  10700. (setq range (org-get-property-block beg end 'force))
  10701. (goto-char (car range))
  10702. (if (re-search-forward
  10703. (concat "^[ \t]*:" property ":\\(.*\\)") (cdr range) t)
  10704. (progn
  10705. (delete-region (match-beginning 1) (match-end 1))
  10706. (goto-char (match-beginning 1)))
  10707. (goto-char (cdr range))
  10708. (insert "\n")
  10709. (backward-char 1)
  10710. (org-indent-line-function)
  10711. (insert ":" property ":"))
  10712. (and value (insert " " value))
  10713. (org-indent-line-function)))))))
  10714. (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
  10715. "Get all property keys in the current buffer.
  10716. With INCLUDE-SPECIALS, also list the special properties that reflect things
  10717. like tags and TODO state.
  10718. With INCLUDE-DEFAULTS, also include properties that has special meaning
  10719. internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
  10720. With INCLUDE-COLUMNS, also include property names given in COLUMN
  10721. formats in the current buffer."
  10722. (let (rtn range cfmt s p)
  10723. (save-excursion
  10724. (save-restriction
  10725. (widen)
  10726. (goto-char (point-min))
  10727. (while (re-search-forward org-property-start-re nil t)
  10728. (setq range (org-get-property-block))
  10729. (goto-char (car range))
  10730. (while (re-search-forward
  10731. (org-re "^[ \t]*:\\([-[:alnum:]_]+\\):")
  10732. (cdr range) t)
  10733. (add-to-list 'rtn (org-match-string-no-properties 1)))
  10734. (outline-next-heading))))
  10735. (when include-specials
  10736. (setq rtn (append org-special-properties rtn)))
  10737. (when include-defaults
  10738. (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
  10739. (when include-columns
  10740. (save-excursion
  10741. (save-restriction
  10742. (widen)
  10743. (goto-char (point-min))
  10744. (while (re-search-forward
  10745. "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
  10746. nil t)
  10747. (setq cfmt (match-string 2) s 0)
  10748. (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
  10749. cfmt s)
  10750. (setq s (match-end 0)
  10751. p (match-string 1 cfmt))
  10752. (unless (or (equal p "ITEM")
  10753. (member p org-special-properties))
  10754. (add-to-list 'rtn (match-string 1 cfmt))))))))
  10755. (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
  10756. (defun org-property-values (key)
  10757. "Return a list of all values of property KEY."
  10758. (save-excursion
  10759. (save-restriction
  10760. (widen)
  10761. (goto-char (point-min))
  10762. (let ((re (concat "^[ \t]*:" key ":[ \t]*\\(\\S-.*\\)"))
  10763. values)
  10764. (while (re-search-forward re nil t)
  10765. (add-to-list 'values (org-trim (match-string 1))))
  10766. (delete "" values)))))
  10767. (defun org-insert-property-drawer ()
  10768. "Insert a property drawer into the current entry."
  10769. (interactive)
  10770. (org-back-to-heading t)
  10771. (looking-at outline-regexp)
  10772. (let ((indent (- (match-end 0)(match-beginning 0)))
  10773. (beg (point))
  10774. (re (concat "^[ \t]*" org-keyword-time-regexp))
  10775. end hiddenp)
  10776. (outline-next-heading)
  10777. (setq end (point))
  10778. (goto-char beg)
  10779. (while (re-search-forward re end t))
  10780. (setq hiddenp (org-invisible-p))
  10781. (end-of-line 1)
  10782. (and (equal (char-after) ?\n) (forward-char 1))
  10783. (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
  10784. (if (member (match-string 1) '("CLOCK:" ":END:"))
  10785. ;; just skip this line
  10786. (beginning-of-line 2)
  10787. ;; Drawer start, find the end
  10788. (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
  10789. (beginning-of-line 1)))
  10790. (org-skip-over-state-notes)
  10791. (skip-chars-backward " \t\n\r")
  10792. (if (eq (char-before) ?*) (forward-char 1))
  10793. (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
  10794. (beginning-of-line 0)
  10795. (org-indent-to-column indent)
  10796. (beginning-of-line 2)
  10797. (org-indent-to-column indent)
  10798. (beginning-of-line 0)
  10799. (if hiddenp
  10800. (save-excursion
  10801. (org-back-to-heading t)
  10802. (hide-entry))
  10803. (org-flag-drawer t))))
  10804. (defun org-set-property (property value)
  10805. "In the current entry, set PROPERTY to VALUE.
  10806. When called interactively, this will prompt for a property name, offering
  10807. completion on existing and default properties. And then it will prompt
  10808. for a value, offering completion either on allowed values (via an inherited
  10809. xxx_ALL property) or on existing values in other instances of this property
  10810. in the current file."
  10811. (interactive
  10812. (let* ((completion-ignore-case t)
  10813. (keys (org-buffer-property-keys nil t t))
  10814. (prop0 (org-ido-completing-read "Property: " (mapcar 'list keys)))
  10815. (prop (if (member prop0 keys)
  10816. prop0
  10817. (or (cdr (assoc (downcase prop0)
  10818. (mapcar (lambda (x) (cons (downcase x) x))
  10819. keys)))
  10820. prop0)))
  10821. (cur (org-entry-get nil prop))
  10822. (allowed (org-property-get-allowed-values nil prop 'table))
  10823. (existing (mapcar 'list (org-property-values prop)))
  10824. (val (if allowed
  10825. (org-completing-read "Value: " allowed nil 'req-match)
  10826. (let (org-completion-use-ido)
  10827. (org-completing-read
  10828. (concat "Value" (if (and cur (string-match "\\S-" cur))
  10829. (concat "[" cur "]") "")
  10830. ": ")
  10831. existing nil nil "" nil cur)))))
  10832. (list prop (if (equal val "") cur val))))
  10833. (unless (equal (org-entry-get nil property) value)
  10834. (org-entry-put nil property value)))
  10835. (defun org-delete-property (property)
  10836. "In the current entry, delete PROPERTY."
  10837. (interactive
  10838. (let* ((completion-ignore-case t)
  10839. (prop (org-ido-completing-read
  10840. "Property: " (org-entry-properties nil 'standard))))
  10841. (list prop)))
  10842. (message "Property %s %s" property
  10843. (if (org-entry-delete nil property)
  10844. "deleted"
  10845. "was not present in the entry")))
  10846. (defun org-delete-property-globally (property)
  10847. "Remove PROPERTY globally, from all entries."
  10848. (interactive
  10849. (let* ((completion-ignore-case t)
  10850. (prop (org-ido-completing-read
  10851. "Globally remove property: "
  10852. (mapcar 'list (org-buffer-property-keys)))))
  10853. (list prop)))
  10854. (save-excursion
  10855. (save-restriction
  10856. (widen)
  10857. (goto-char (point-min))
  10858. (let ((cnt 0))
  10859. (while (re-search-forward
  10860. (concat "^[ \t]*:" (regexp-quote property) ":.*\n?")
  10861. nil t)
  10862. (setq cnt (1+ cnt))
  10863. (replace-match ""))
  10864. (message "Property \"%s\" removed from %d entries" property cnt)))))
  10865. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  10866. (defun org-compute-property-at-point ()
  10867. "Compute the property at point.
  10868. This looks for an enclosing column format, extracts the operator and
  10869. then applies it to the property in the column format's scope."
  10870. (interactive)
  10871. (unless (org-at-property-p)
  10872. (error "Not at a property"))
  10873. (let ((prop (org-match-string-no-properties 2)))
  10874. (org-columns-get-format-and-top-level)
  10875. (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
  10876. (error "No operator defined for property %s" prop))
  10877. (org-columns-compute prop)))
  10878. (defun org-property-get-allowed-values (pom property &optional table)
  10879. "Get allowed values for the property PROPERTY.
  10880. When TABLE is non-nil, return an alist that can directly be used for
  10881. completion."
  10882. (let (vals)
  10883. (cond
  10884. ((equal property "TODO")
  10885. (setq vals (org-with-point-at pom
  10886. (append org-todo-keywords-1 '("")))))
  10887. ((equal property "PRIORITY")
  10888. (let ((n org-lowest-priority))
  10889. (while (>= n org-highest-priority)
  10890. (push (char-to-string n) vals)
  10891. (setq n (1- n)))))
  10892. ((member property org-special-properties))
  10893. (t
  10894. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  10895. (when (and vals (string-match "\\S-" vals))
  10896. (setq vals (car (read-from-string (concat "(" vals ")"))))
  10897. (setq vals (mapcar (lambda (x)
  10898. (cond ((stringp x) x)
  10899. ((numberp x) (number-to-string x))
  10900. ((symbolp x) (symbol-name x))
  10901. (t "???")))
  10902. vals)))))
  10903. (if table (mapcar 'list vals) vals)))
  10904. (defun org-property-previous-allowed-value (&optional previous)
  10905. "Switch to the next allowed value for this property."
  10906. (interactive)
  10907. (org-property-next-allowed-value t))
  10908. (defun org-property-next-allowed-value (&optional previous)
  10909. "Switch to the next allowed value for this property."
  10910. (interactive)
  10911. (unless (org-at-property-p)
  10912. (error "Not at a property"))
  10913. (let* ((key (match-string 2))
  10914. (value (match-string 3))
  10915. (allowed (or (org-property-get-allowed-values (point) key)
  10916. (and (member value '("[ ]" "[-]" "[X]"))
  10917. '("[ ]" "[X]"))))
  10918. nval)
  10919. (unless allowed
  10920. (error "Allowed values for this property have not been defined"))
  10921. (if previous (setq allowed (reverse allowed)))
  10922. (if (member value allowed)
  10923. (setq nval (car (cdr (member value allowed)))))
  10924. (setq nval (or nval (car allowed)))
  10925. (if (equal nval value)
  10926. (error "Only one allowed value for this property"))
  10927. (org-at-property-p)
  10928. (replace-match (concat " :" key ": " nval) t t)
  10929. (org-indent-line-function)
  10930. (beginning-of-line 1)
  10931. (skip-chars-forward " \t")))
  10932. (defun org-find-entry-with-id (ident)
  10933. "Locate the entry that contains the ID property with exact value IDENT.
  10934. IDENT can be a string, a symbol or a number, this function will search for
  10935. the string representation of it.
  10936. Return the position where this entry starts, or nil if there is no such entry."
  10937. (interactive "sID: ")
  10938. (let ((id (cond
  10939. ((stringp ident) ident)
  10940. ((symbol-name ident) (symbol-name ident))
  10941. ((numberp ident) (number-to-string ident))
  10942. (t (error "IDENT %s must be a string, symbol or number" ident))))
  10943. (case-fold-search nil))
  10944. (save-excursion
  10945. (save-restriction
  10946. (widen)
  10947. (goto-char (point-min))
  10948. (when (re-search-forward
  10949. (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
  10950. nil t)
  10951. (org-back-to-heading)
  10952. (point))))))
  10953. ;;;; Timestamps
  10954. (defvar org-last-changed-timestamp nil)
  10955. (defvar org-last-inserted-timestamp nil
  10956. "The last time stamp inserted with `org-insert-time-stamp'.")
  10957. (defvar org-time-was-given) ; dynamically scoped parameter
  10958. (defvar org-end-time-was-given) ; dynamically scoped parameter
  10959. (defvar org-ts-what) ; dynamically scoped parameter
  10960. (defun org-time-stamp (arg &optional inactive)
  10961. "Prompt for a date/time and insert a time stamp.
  10962. If the user specifies a time like HH:MM, or if this command is called
  10963. with a prefix argument, the time stamp will contain date and time.
  10964. Otherwise, only the date will be included. All parts of a date not
  10965. specified by the user will be filled in from the current date/time.
  10966. So if you press just return without typing anything, the time stamp
  10967. will represent the current date/time. If there is already a timestamp
  10968. at the cursor, it will be modified."
  10969. (interactive "P")
  10970. (let* ((ts nil)
  10971. (default-time
  10972. ;; Default time is either today, or, when entering a range,
  10973. ;; the range start.
  10974. (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
  10975. (save-excursion
  10976. (re-search-backward
  10977. (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
  10978. (- (point) 20) t)))
  10979. (apply 'encode-time (org-parse-time-string (match-string 1)))
  10980. (current-time)))
  10981. (default-input (and ts (org-get-compact-tod ts)))
  10982. org-time-was-given org-end-time-was-given time)
  10983. (cond
  10984. ((and (org-at-timestamp-p t)
  10985. (memq last-command '(org-time-stamp org-time-stamp-inactive))
  10986. (memq this-command '(org-time-stamp org-time-stamp-inactive)))
  10987. (insert "--")
  10988. (setq time (let ((this-command this-command))
  10989. (org-read-date arg 'totime nil nil
  10990. default-time default-input)))
  10991. (org-insert-time-stamp time (or org-time-was-given arg) inactive))
  10992. ((org-at-timestamp-p t)
  10993. (setq time (let ((this-command this-command))
  10994. (org-read-date arg 'totime nil nil default-time default-input)))
  10995. (when (org-at-timestamp-p t) ; just to get the match data
  10996. ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
  10997. (replace-match "")
  10998. (setq org-last-changed-timestamp
  10999. (org-insert-time-stamp
  11000. time (or org-time-was-given arg)
  11001. inactive nil nil (list org-end-time-was-given))))
  11002. (message "Timestamp updated"))
  11003. (t
  11004. (setq time (let ((this-command this-command))
  11005. (org-read-date arg 'totime nil nil default-time default-input)))
  11006. (org-insert-time-stamp time (or org-time-was-given arg) inactive
  11007. nil nil (list org-end-time-was-given))))))
  11008. ;; FIXME: can we use this for something else, like computing time differences?
  11009. (defun org-get-compact-tod (s)
  11010. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  11011. (let* ((t1 (match-string 1 s))
  11012. (h1 (string-to-number (match-string 2 s)))
  11013. (m1 (string-to-number (match-string 3 s)))
  11014. (t2 (and (match-end 4) (match-string 5 s)))
  11015. (h2 (and t2 (string-to-number (match-string 6 s))))
  11016. (m2 (and t2 (string-to-number (match-string 7 s))))
  11017. dh dm)
  11018. (if (not t2)
  11019. t1
  11020. (setq dh (- h2 h1) dm (- m2 m1))
  11021. (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  11022. (concat t1 "+" (number-to-string dh)
  11023. (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
  11024. (defun org-time-stamp-inactive (&optional arg)
  11025. "Insert an inactive time stamp.
  11026. An inactive time stamp is enclosed in square brackets instead of angle
  11027. brackets. It is inactive in the sense that it does not trigger agenda entries,
  11028. does not link to the calendar and cannot be changed with the S-cursor keys.
  11029. So these are more for recording a certain time/date."
  11030. (interactive "P")
  11031. (org-time-stamp arg 'inactive))
  11032. (defvar org-date-ovl (org-make-overlay 1 1))
  11033. (org-overlay-put org-date-ovl 'face 'org-warning)
  11034. (org-detach-overlay org-date-ovl)
  11035. (defvar org-ans1) ; dynamically scoped parameter
  11036. (defvar org-ans2) ; dynamically scoped parameter
  11037. (defvar org-plain-time-of-day-regexp) ; defined below
  11038. (defvar org-overriding-default-time nil) ; dynamically scoped
  11039. (defvar org-read-date-overlay nil)
  11040. (defvar org-dcst nil) ; dynamically scoped
  11041. (defvar org-read-date-history nil)
  11042. (defun org-read-date (&optional with-time to-time from-string prompt
  11043. default-time default-input)
  11044. "Read a date, possibly a time, and make things smooth for the user.
  11045. The prompt will suggest to enter an ISO date, but you can also enter anything
  11046. which will at least partially be understood by `parse-time-string'.
  11047. Unrecognized parts of the date will default to the current day, month, year,
  11048. hour and minute. If this command is called to replace a timestamp at point,
  11049. of to enter the second timestamp of a range, the default time is taken from the
  11050. existing stamp. For example,
  11051. 3-2-5 --> 2003-02-05
  11052. feb 15 --> currentyear-02-15
  11053. sep 12 9 --> 2009-09-12
  11054. 12:45 --> today 12:45
  11055. 22 sept 0:34 --> currentyear-09-22 0:34
  11056. 12 --> currentyear-currentmonth-12
  11057. Fri --> nearest Friday (today or later)
  11058. etc.
  11059. Furthermore you can specify a relative date by giving, as the *first* thing
  11060. in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
  11061. change in days weeks, months, years.
  11062. With a single plus or minus, the date is relative to today. With a double
  11063. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  11064. +4d --> four days from today
  11065. +4 --> same as above
  11066. +2w --> two weeks from today
  11067. ++5 --> five days from default date
  11068. The function understands only English month and weekday abbreviations,
  11069. but this can be configured with the variables `parse-time-months' and
  11070. `parse-time-weekdays'.
  11071. While prompting, a calendar is popped up - you can also select the
  11072. date with the mouse (button 1). The calendar shows a period of three
  11073. months. To scroll it to other months, use the keys `>' and `<'.
  11074. If you don't like the calendar, turn it off with
  11075. \(setq org-read-date-popup-calendar nil)
  11076. With optional argument TO-TIME, the date will immediately be converted
  11077. to an internal time.
  11078. With an optional argument WITH-TIME, the prompt will suggest to also
  11079. insert a time. Note that when WITH-TIME is not set, you can still
  11080. enter a time, and this function will inform the calling routine about
  11081. this change. The calling routine may then choose to change the format
  11082. used to insert the time stamp into the buffer to include the time.
  11083. With optional argument FROM-STRING, read from this string instead from
  11084. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  11085. the time/date that is used for everything that is not specified by the
  11086. user."
  11087. (require 'parse-time)
  11088. (let* ((org-time-stamp-rounding-minutes
  11089. (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
  11090. (org-dcst org-display-custom-times)
  11091. (ct (org-current-time))
  11092. (def (or org-overriding-default-time default-time ct))
  11093. (defdecode (decode-time def))
  11094. (dummy (progn
  11095. (when (< (nth 2 defdecode) org-extend-today-until)
  11096. (setcar (nthcdr 2 defdecode) -1)
  11097. (setcar (nthcdr 1 defdecode) 59)
  11098. (setq def (apply 'encode-time defdecode)
  11099. defdecode (decode-time def)))))
  11100. (calendar-move-hook nil)
  11101. (calendar-view-diary-initially-flag nil)
  11102. (view-diary-entries-initially nil)
  11103. (calendar-view-holidays-initially-flag nil)
  11104. (view-calendar-holidays-initially nil)
  11105. (timestr (format-time-string
  11106. (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
  11107. (prompt (concat (if prompt (concat prompt " ") "")
  11108. (format "Date+time [%s]: " timestr)))
  11109. ans (org-ans0 "") org-ans1 org-ans2 final)
  11110. (cond
  11111. (from-string (setq ans from-string))
  11112. (org-read-date-popup-calendar
  11113. (save-excursion
  11114. (save-window-excursion
  11115. (calendar)
  11116. (calendar-forward-day (- (time-to-days def)
  11117. (calendar-absolute-from-gregorian
  11118. (calendar-current-date))))
  11119. (org-eval-in-calendar nil t)
  11120. (let* ((old-map (current-local-map))
  11121. (map (copy-keymap calendar-mode-map))
  11122. (minibuffer-local-map (copy-keymap minibuffer-local-map)))
  11123. (org-defkey map (kbd "RET") 'org-calendar-select)
  11124. (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
  11125. 'org-calendar-select-mouse)
  11126. (org-defkey map (if (featurep 'xemacs) [button2] [mouse-2])
  11127. 'org-calendar-select-mouse)
  11128. (org-defkey minibuffer-local-map [(meta shift left)]
  11129. (lambda () (interactive)
  11130. (org-eval-in-calendar '(calendar-backward-month 1))))
  11131. (org-defkey minibuffer-local-map [(meta shift right)]
  11132. (lambda () (interactive)
  11133. (org-eval-in-calendar '(calendar-forward-month 1))))
  11134. (org-defkey minibuffer-local-map [(meta shift up)]
  11135. (lambda () (interactive)
  11136. (org-eval-in-calendar '(calendar-backward-year 1))))
  11137. (org-defkey minibuffer-local-map [(meta shift down)]
  11138. (lambda () (interactive)
  11139. (org-eval-in-calendar '(calendar-forward-year 1))))
  11140. (org-defkey minibuffer-local-map [(shift up)]
  11141. (lambda () (interactive)
  11142. (org-eval-in-calendar '(calendar-backward-week 1))))
  11143. (org-defkey minibuffer-local-map [(shift down)]
  11144. (lambda () (interactive)
  11145. (org-eval-in-calendar '(calendar-forward-week 1))))
  11146. (org-defkey minibuffer-local-map [(shift left)]
  11147. (lambda () (interactive)
  11148. (org-eval-in-calendar '(calendar-backward-day 1))))
  11149. (org-defkey minibuffer-local-map [(shift right)]
  11150. (lambda () (interactive)
  11151. (org-eval-in-calendar '(calendar-forward-day 1))))
  11152. (org-defkey minibuffer-local-map ">"
  11153. (lambda () (interactive)
  11154. (org-eval-in-calendar '(scroll-calendar-left 1))))
  11155. (org-defkey minibuffer-local-map "<"
  11156. (lambda () (interactive)
  11157. (org-eval-in-calendar '(scroll-calendar-right 1))))
  11158. (run-hooks 'org-read-date-minibuffer-setup-hook)
  11159. (unwind-protect
  11160. (progn
  11161. (use-local-map map)
  11162. (add-hook 'post-command-hook 'org-read-date-display)
  11163. (setq org-ans0 (read-string prompt default-input
  11164. 'org-read-date-history nil))
  11165. ;; org-ans0: from prompt
  11166. ;; org-ans1: from mouse click
  11167. ;; org-ans2: from calendar motion
  11168. (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
  11169. (remove-hook 'post-command-hook 'org-read-date-display)
  11170. (use-local-map old-map)
  11171. (when org-read-date-overlay
  11172. (org-delete-overlay org-read-date-overlay)
  11173. (setq org-read-date-overlay nil)))))))
  11174. (t ; Naked prompt only
  11175. (unwind-protect
  11176. (setq ans (read-string prompt default-input
  11177. 'org-read-date-history timestr))
  11178. (when org-read-date-overlay
  11179. (org-delete-overlay org-read-date-overlay)
  11180. (setq org-read-date-overlay nil)))))
  11181. (setq final (org-read-date-analyze ans def defdecode))
  11182. (if to-time
  11183. (apply 'encode-time final)
  11184. (if (and (boundp 'org-time-was-given) org-time-was-given)
  11185. (format "%04d-%02d-%02d %02d:%02d"
  11186. (nth 5 final) (nth 4 final) (nth 3 final)
  11187. (nth 2 final) (nth 1 final))
  11188. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  11189. (defvar def)
  11190. (defvar defdecode)
  11191. (defvar with-time)
  11192. (defun org-read-date-display ()
  11193. "Display the current date prompt interpretation in the minibuffer."
  11194. (when org-read-date-display-live
  11195. (when org-read-date-overlay
  11196. (org-delete-overlay org-read-date-overlay))
  11197. (let ((p (point)))
  11198. (end-of-line 1)
  11199. (while (not (equal (buffer-substring
  11200. (max (point-min) (- (point) 4)) (point))
  11201. " "))
  11202. (insert " "))
  11203. (goto-char p))
  11204. (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
  11205. " " (or org-ans1 org-ans2)))
  11206. (org-end-time-was-given nil)
  11207. (f (org-read-date-analyze ans def defdecode))
  11208. (fmts (if org-dcst
  11209. org-time-stamp-custom-formats
  11210. org-time-stamp-formats))
  11211. (fmt (if (or with-time
  11212. (and (boundp 'org-time-was-given) org-time-was-given))
  11213. (cdr fmts)
  11214. (car fmts)))
  11215. (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
  11216. (when (and org-end-time-was-given
  11217. (string-match org-plain-time-of-day-regexp txt))
  11218. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  11219. org-end-time-was-given
  11220. (substring txt (match-end 0)))))
  11221. (setq org-read-date-overlay
  11222. (org-make-overlay (1- (point-at-eol)) (point-at-eol)))
  11223. (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
  11224. (defun org-read-date-analyze (ans def defdecode)
  11225. "Analyse the combined answer of the date prompt."
  11226. ;; FIXME: cleanup and comment
  11227. (let (delta deltan deltaw deltadef year month day
  11228. hour minute second wday pm h2 m2 tl wday1
  11229. iso-year iso-weekday iso-week iso-year iso-date)
  11230. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  11231. (setq ans "+0"))
  11232. (when (setq delta (org-read-date-get-relative ans (current-time) def))
  11233. (setq ans (replace-match "" t t ans)
  11234. deltan (car delta)
  11235. deltaw (nth 1 delta)
  11236. deltadef (nth 2 delta)))
  11237. ;; Check if there is an iso week date in there
  11238. ;; If yes, sore the info and postpone interpreting it until the rest
  11239. ;; of the parsing is done
  11240. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  11241. (setq iso-year (if (match-end 1) (org-small-year-to-year (string-to-number (match-string 1 ans))))
  11242. iso-weekday (if (match-end 3) (string-to-number (match-string 3 ans)))
  11243. iso-week (string-to-number (match-string 2 ans)))
  11244. (setq ans (replace-match "" t t ans)))
  11245. ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
  11246. (when (string-match
  11247. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  11248. (setq year (if (match-end 2)
  11249. (string-to-number (match-string 2 ans))
  11250. (string-to-number (format-time-string "%Y")))
  11251. month (string-to-number (match-string 3 ans))
  11252. day (string-to-number (match-string 4 ans)))
  11253. (if (< year 100) (setq year (+ 2000 year)))
  11254. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  11255. t nil ans)))
  11256. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  11257. ;; If there is a time with am/pm, and *no* time without it, we convert
  11258. ;; so that matching will be successful.
  11259. (loop for i from 1 to 2 do ; twice, for end time as well
  11260. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  11261. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  11262. (setq hour (string-to-number (match-string 1 ans))
  11263. minute (if (match-end 3)
  11264. (string-to-number (match-string 3 ans))
  11265. 0)
  11266. pm (equal ?p
  11267. (string-to-char (downcase (match-string 4 ans)))))
  11268. (if (and (= hour 12) (not pm))
  11269. (setq hour 0)
  11270. (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
  11271. (setq ans (replace-match (format "%02d:%02d" hour minute)
  11272. t t ans))))
  11273. ;; Check if a time range is given as a duration
  11274. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  11275. (setq hour (string-to-number (match-string 1 ans))
  11276. h2 (+ hour (string-to-number (match-string 3 ans)))
  11277. minute (string-to-number (match-string 2 ans))
  11278. m2 (+ minute (if (match-end 5) (string-to-number
  11279. (match-string 5 ans))0)))
  11280. (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  11281. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  11282. t t ans)))
  11283. ;; Check if there is a time range
  11284. (when (boundp 'org-end-time-was-given)
  11285. (setq org-time-was-given nil)
  11286. (when (and (string-match org-plain-time-of-day-regexp ans)
  11287. (match-end 8))
  11288. (setq org-end-time-was-given (match-string 8 ans))
  11289. (setq ans (concat (substring ans 0 (match-beginning 7))
  11290. (substring ans (match-end 7))))))
  11291. (setq tl (parse-time-string ans)
  11292. day (or (nth 3 tl) (nth 3 defdecode))
  11293. month (or (nth 4 tl)
  11294. (if (and org-read-date-prefer-future
  11295. (nth 3 tl) (< (nth 3 tl) (nth 3 defdecode)))
  11296. (1+ (nth 4 defdecode))
  11297. (nth 4 defdecode)))
  11298. year (or (nth 5 tl)
  11299. (if (and org-read-date-prefer-future
  11300. (nth 4 tl) (< (nth 4 tl) (nth 4 defdecode)))
  11301. (1+ (nth 5 defdecode))
  11302. (nth 5 defdecode)))
  11303. hour (or (nth 2 tl) (nth 2 defdecode))
  11304. minute (or (nth 1 tl) (nth 1 defdecode))
  11305. second (or (nth 0 tl) 0)
  11306. wday (nth 6 tl))
  11307. ;; Special date definitions below
  11308. (cond
  11309. (iso-week
  11310. ;; There was an iso week
  11311. (setq year (or iso-year year)
  11312. day (or iso-weekday wday 1)
  11313. wday nil ; to make sure that the trigger below does not match
  11314. iso-date (calendar-gregorian-from-absolute
  11315. (calendar-absolute-from-iso
  11316. (list iso-week day year))))
  11317. ; FIXME: Should we also push ISO weeks into the future?
  11318. ; (when (and org-read-date-prefer-future
  11319. ; (not iso-year)
  11320. ; (< (calendar-absolute-from-gregorian iso-date)
  11321. ; (time-to-days (current-time))))
  11322. ; (setq year (1+ year)
  11323. ; iso-date (calendar-gregorian-from-absolute
  11324. ; (calendar-absolute-from-iso
  11325. ; (list iso-week day year)))))
  11326. (setq month (car iso-date)
  11327. year (nth 2 iso-date)
  11328. day (nth 1 iso-date)))
  11329. (deltan
  11330. (unless deltadef
  11331. (let ((now (decode-time (current-time))))
  11332. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  11333. (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
  11334. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  11335. ((equal deltaw "m") (setq month (+ month deltan)))
  11336. ((equal deltaw "y") (setq year (+ year deltan)))))
  11337. ((and wday (not (nth 3 tl)))
  11338. ;; Weekday was given, but no day, so pick that day in the week
  11339. ;; on or after the derived date.
  11340. (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
  11341. (unless (equal wday wday1)
  11342. (setq day (+ day (% (- wday wday1 -7) 7))))))
  11343. (if (and (boundp 'org-time-was-given)
  11344. (nth 2 tl))
  11345. (setq org-time-was-given t))
  11346. (if (< year 100) (setq year (+ 2000 year)))
  11347. (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
  11348. (list second minute hour day month year)))
  11349. (defvar parse-time-weekdays)
  11350. (defun org-read-date-get-relative (s today default)
  11351. "Check string S for special relative date string.
  11352. TODAY and DEFAULT are internal times, for today and for a default.
  11353. Return shift list (N what def-flag)
  11354. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  11355. N is the number of WHATs to shift.
  11356. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  11357. the DEFAULT date rather than TODAY."
  11358. (when (and
  11359. (string-match
  11360. (concat
  11361. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  11362. "\\([0-9]+\\)?"
  11363. "\\([dwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  11364. "\\([ \t]\\|$\\)") s)
  11365. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  11366. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  11367. (string-to-char (substring (match-string 1 s) -1))
  11368. ?+))
  11369. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  11370. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  11371. (what (if (match-end 3) (match-string 3 s) "d"))
  11372. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  11373. (date (if rel default today))
  11374. (wday (nth 6 (decode-time date)))
  11375. delta)
  11376. (if wday1
  11377. (progn
  11378. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  11379. (if (= dir ?-) (setq delta (- delta 7)))
  11380. (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  11381. (list delta "d" rel))
  11382. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  11383. (defun org-eval-in-calendar (form &optional keepdate)
  11384. "Eval FORM in the calendar window and return to current window.
  11385. Also, store the cursor date in variable org-ans2."
  11386. (let ((sw (selected-window)))
  11387. (select-window (get-buffer-window "*Calendar*"))
  11388. (eval form)
  11389. (when (and (not keepdate) (calendar-cursor-to-date))
  11390. (let* ((date (calendar-cursor-to-date))
  11391. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  11392. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  11393. (org-move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  11394. (select-window sw)))
  11395. (defun org-calendar-select ()
  11396. "Return to `org-read-date' with the date currently selected.
  11397. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  11398. (interactive)
  11399. (when (calendar-cursor-to-date)
  11400. (let* ((date (calendar-cursor-to-date))
  11401. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  11402. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  11403. (if (active-minibuffer-window) (exit-minibuffer))))
  11404. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  11405. "Insert a date stamp for the date given by the internal TIME.
  11406. WITH-HM means, use the stamp format that includes the time of the day.
  11407. INACTIVE means use square brackets instead of angular ones, so that the
  11408. stamp will not contribute to the agenda.
  11409. PRE and POST are optional strings to be inserted before and after the
  11410. stamp.
  11411. The command returns the inserted time stamp."
  11412. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  11413. stamp)
  11414. (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  11415. (insert-before-markers (or pre ""))
  11416. (insert-before-markers (setq stamp (format-time-string fmt time)))
  11417. (when (listp extra)
  11418. (setq extra (car extra))
  11419. (if (and (stringp extra)
  11420. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  11421. (setq extra (format "-%02d:%02d"
  11422. (string-to-number (match-string 1 extra))
  11423. (string-to-number (match-string 2 extra))))
  11424. (setq extra nil)))
  11425. (when extra
  11426. (backward-char 1)
  11427. (insert-before-markers extra)
  11428. (forward-char 1))
  11429. (insert-before-markers (or post ""))
  11430. (setq org-last-inserted-timestamp stamp)))
  11431. (defun org-toggle-time-stamp-overlays ()
  11432. "Toggle the use of custom time stamp formats."
  11433. (interactive)
  11434. (setq org-display-custom-times (not org-display-custom-times))
  11435. (unless org-display-custom-times
  11436. (let ((p (point-min)) (bmp (buffer-modified-p)))
  11437. (while (setq p (next-single-property-change p 'display))
  11438. (if (and (get-text-property p 'display)
  11439. (eq (get-text-property p 'face) 'org-date))
  11440. (remove-text-properties
  11441. p (setq p (next-single-property-change p 'display))
  11442. '(display t))))
  11443. (set-buffer-modified-p bmp)))
  11444. (if (featurep 'xemacs)
  11445. (remove-text-properties (point-min) (point-max) '(end-glyph t)))
  11446. (org-restart-font-lock)
  11447. (setq org-table-may-need-update t)
  11448. (if org-display-custom-times
  11449. (message "Time stamps are overlayed with custom format")
  11450. (message "Time stamp overlays removed")))
  11451. (defun org-display-custom-time (beg end)
  11452. "Overlay modified time stamp format over timestamp between BEG and END."
  11453. (let* ((ts (buffer-substring beg end))
  11454. t1 w1 with-hm tf time str w2 (off 0))
  11455. (save-match-data
  11456. (setq t1 (org-parse-time-string ts t))
  11457. (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\)?\\'" ts)
  11458. (setq off (- (match-end 0) (match-beginning 0)))))
  11459. (setq end (- end off))
  11460. (setq w1 (- end beg)
  11461. with-hm (and (nth 1 t1) (nth 2 t1))
  11462. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  11463. time (org-fix-decoded-time t1)
  11464. str (org-add-props
  11465. (format-time-string
  11466. (substring tf 1 -1) (apply 'encode-time time))
  11467. nil 'mouse-face 'highlight)
  11468. w2 (length str))
  11469. (if (not (= w2 w1))
  11470. (add-text-properties (1+ beg) (+ 2 beg)
  11471. (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
  11472. (if (featurep 'xemacs)
  11473. (progn
  11474. (put-text-property beg end 'invisible t)
  11475. (put-text-property beg end 'end-glyph (make-glyph str)))
  11476. (put-text-property beg end 'display str))))
  11477. (defun org-translate-time (string)
  11478. "Translate all timestamps in STRING to custom format.
  11479. But do this only if the variable `org-display-custom-times' is set."
  11480. (when org-display-custom-times
  11481. (save-match-data
  11482. (let* ((start 0)
  11483. (re org-ts-regexp-both)
  11484. t1 with-hm inactive tf time str beg end)
  11485. (while (setq start (string-match re string start))
  11486. (setq beg (match-beginning 0)
  11487. end (match-end 0)
  11488. t1 (save-match-data
  11489. (org-parse-time-string (substring string beg end) t))
  11490. with-hm (and (nth 1 t1) (nth 2 t1))
  11491. inactive (equal (substring string beg (1+ beg)) "[")
  11492. tf (funcall (if with-hm 'cdr 'car)
  11493. org-time-stamp-custom-formats)
  11494. time (org-fix-decoded-time t1)
  11495. str (format-time-string
  11496. (concat
  11497. (if inactive "[" "<") (substring tf 1 -1)
  11498. (if inactive "]" ">"))
  11499. (apply 'encode-time time))
  11500. string (replace-match str t t string)
  11501. start (+ start (length str)))))))
  11502. string)
  11503. (defun org-fix-decoded-time (time)
  11504. "Set 0 instead of nil for the first 6 elements of time.
  11505. Don't touch the rest."
  11506. (let ((n 0))
  11507. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  11508. (defun org-days-to-time (timestamp-string)
  11509. "Difference between TIMESTAMP-STRING and now in days."
  11510. (- (time-to-days (org-time-string-to-time timestamp-string))
  11511. (time-to-days (current-time))))
  11512. (defun org-deadline-close (timestamp-string &optional ndays)
  11513. "Is the time in TIMESTAMP-STRING close to the current date?"
  11514. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  11515. (and (< (org-days-to-time timestamp-string) ndays)
  11516. (not (org-entry-is-done-p))))
  11517. (defun org-get-wdays (ts)
  11518. "Get the deadline lead time appropriate for timestring TS."
  11519. (cond
  11520. ((<= org-deadline-warning-days 0)
  11521. ;; 0 or negative, enforce this value no matter what
  11522. (- org-deadline-warning-days))
  11523. ((string-match "-\\([0-9]+\\)\\([dwmy]\\)\\(\\'\\|>\\| \\)" ts)
  11524. ;; lead time is specified.
  11525. (floor (* (string-to-number (match-string 1 ts))
  11526. (cdr (assoc (match-string 2 ts)
  11527. '(("d" . 1) ("w" . 7)
  11528. ("m" . 30.4) ("y" . 365.25)))))))
  11529. ;; go for the default.
  11530. (t org-deadline-warning-days)))
  11531. (defun org-calendar-select-mouse (ev)
  11532. "Return to `org-read-date' with the date currently selected.
  11533. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  11534. (interactive "e")
  11535. (mouse-set-point ev)
  11536. (when (calendar-cursor-to-date)
  11537. (let* ((date (calendar-cursor-to-date))
  11538. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  11539. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  11540. (if (active-minibuffer-window) (exit-minibuffer))))
  11541. (defun org-check-deadlines (ndays)
  11542. "Check if there are any deadlines due or past due.
  11543. A deadline is considered due if it happens within `org-deadline-warning-days'
  11544. days from today's date. If the deadline appears in an entry marked DONE,
  11545. it is not shown. The prefix arg NDAYS can be used to test that many
  11546. days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
  11547. (interactive "P")
  11548. (let* ((org-warn-days
  11549. (cond
  11550. ((equal ndays '(4)) 100000)
  11551. (ndays (prefix-numeric-value ndays))
  11552. (t (abs org-deadline-warning-days))))
  11553. (case-fold-search nil)
  11554. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  11555. (callback
  11556. (lambda () (org-deadline-close (match-string 1) org-warn-days))))
  11557. (message "%d deadlines past-due or due within %d days"
  11558. (org-occur regexp nil callback)
  11559. org-warn-days)))
  11560. (defun org-check-before-date (date)
  11561. "Check if there are deadlines or scheduled entries before DATE."
  11562. (interactive (list (org-read-date)))
  11563. (let ((case-fold-search nil)
  11564. (regexp (concat "\\<\\(" org-deadline-string
  11565. "\\|" org-scheduled-string
  11566. "\\) *<\\([^>]+\\)>"))
  11567. (callback
  11568. (lambda () (time-less-p
  11569. (org-time-string-to-time (match-string 2))
  11570. (org-time-string-to-time date)))))
  11571. (message "%d entries before %s"
  11572. (org-occur regexp nil callback) date)))
  11573. (defun org-check-after-date (date)
  11574. "Check if there are deadlines or scheduled entries after DATE."
  11575. (interactive (list (org-read-date)))
  11576. (let ((case-fold-search nil)
  11577. (regexp (concat "\\<\\(" org-deadline-string
  11578. "\\|" org-scheduled-string
  11579. "\\) *<\\([^>]+\\)>"))
  11580. (callback
  11581. (lambda () (not
  11582. (time-less-p
  11583. (org-time-string-to-time (match-string 2))
  11584. (org-time-string-to-time date))))))
  11585. (message "%d entries after %s"
  11586. (org-occur regexp nil callback) date)))
  11587. (defun org-evaluate-time-range (&optional to-buffer)
  11588. "Evaluate a time range by computing the difference between start and end.
  11589. Normally the result is just printed in the echo area, but with prefix arg
  11590. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  11591. If the time range is actually in a table, the result is inserted into the
  11592. next column.
  11593. For time difference computation, a year is assumed to be exactly 365
  11594. days in order to avoid rounding problems."
  11595. (interactive "P")
  11596. (or
  11597. (org-clock-update-time-maybe)
  11598. (save-excursion
  11599. (unless (org-at-date-range-p t)
  11600. (goto-char (point-at-bol))
  11601. (re-search-forward org-tr-regexp-both (point-at-eol) t))
  11602. (if (not (org-at-date-range-p t))
  11603. (error "Not at a time-stamp range, and none found in current line")))
  11604. (let* ((ts1 (match-string 1))
  11605. (ts2 (match-string 2))
  11606. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  11607. (match-end (match-end 0))
  11608. (time1 (org-time-string-to-time ts1))
  11609. (time2 (org-time-string-to-time ts2))
  11610. (t1 (time-to-seconds time1))
  11611. (t2 (time-to-seconds time2))
  11612. (diff (abs (- t2 t1)))
  11613. (negative (< (- t2 t1) 0))
  11614. ;; (ys (floor (* 365 24 60 60)))
  11615. (ds (* 24 60 60))
  11616. (hs (* 60 60))
  11617. (fy "%dy %dd %02d:%02d")
  11618. (fy1 "%dy %dd")
  11619. (fd "%dd %02d:%02d")
  11620. (fd1 "%dd")
  11621. (fh "%02d:%02d")
  11622. y d h m align)
  11623. (if havetime
  11624. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  11625. y 0
  11626. d (floor (/ diff ds)) diff (mod diff ds)
  11627. h (floor (/ diff hs)) diff (mod diff hs)
  11628. m (floor (/ diff 60)))
  11629. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  11630. y 0
  11631. d (floor (+ (/ diff ds) 0.5))
  11632. h 0 m 0))
  11633. (if (not to-buffer)
  11634. (message "%s" (org-make-tdiff-string y d h m))
  11635. (if (org-at-table-p)
  11636. (progn
  11637. (goto-char match-end)
  11638. (setq align t)
  11639. (and (looking-at " *|") (goto-char (match-end 0))))
  11640. (goto-char match-end))
  11641. (if (looking-at
  11642. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  11643. (replace-match ""))
  11644. (if negative (insert " -"))
  11645. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  11646. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  11647. (insert " " (format fh h m))))
  11648. (if align (org-table-align))
  11649. (message "Time difference inserted")))))
  11650. (defun org-make-tdiff-string (y d h m)
  11651. (let ((fmt "")
  11652. (l nil))
  11653. (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
  11654. l (push y l)))
  11655. (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
  11656. l (push d l)))
  11657. (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
  11658. l (push h l)))
  11659. (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
  11660. l (push m l)))
  11661. (apply 'format fmt (nreverse l))))
  11662. (defun org-time-string-to-time (s)
  11663. (apply 'encode-time (org-parse-time-string s)))
  11664. (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
  11665. "Convert a time stamp to an absolute day number.
  11666. If there is a specifyer for a cyclic time stamp, get the closest date to
  11667. DAYNR.
  11668. PREFER and SHOW-ALL are passed through to `org-closest-date'."
  11669. (cond
  11670. ((and daynr (string-match "\\`%%\\((.*)\\)" s))
  11671. (if (org-diary-sexp-entry (match-string 1 s) "" date)
  11672. daynr
  11673. (+ daynr 1000)))
  11674. ((and daynr (string-match "\\+[0-9]+[dwmy]" s))
  11675. (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
  11676. (time-to-days (current-time))) (match-string 0 s)
  11677. prefer show-all))
  11678. (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
  11679. (defun org-days-to-iso-week (days)
  11680. "Return the iso week number."
  11681. (require 'cal-iso)
  11682. (car (calendar-iso-from-absolute days)))
  11683. (defun org-small-year-to-year (year)
  11684. "Convert 2-digit years into 4-digit years.
  11685. 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
  11686. The year 2000 cannot be abbreviated. Any year larger than 99
  11687. is returned unchanged."
  11688. (if (< year 38)
  11689. (setq year (+ 2000 year))
  11690. (if (< year 100)
  11691. (setq year (+ 1900 year))))
  11692. year)
  11693. (defun org-time-from-absolute (d)
  11694. "Return the time corresponding to date D.
  11695. D may be an absolute day number, or a calendar-type list (month day year)."
  11696. (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  11697. (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  11698. (defun org-calendar-holiday ()
  11699. "List of holidays, for Diary display in Org-mode."
  11700. (require 'holidays)
  11701. (let ((hl (funcall
  11702. (if (fboundp 'calendar-check-holidays)
  11703. 'calendar-check-holidays 'check-calendar-holidays) date)))
  11704. (if hl (mapconcat 'identity hl "; "))))
  11705. (defun org-diary-sexp-entry (sexp entry date)
  11706. "Process a SEXP diary ENTRY for DATE."
  11707. (require 'diary-lib)
  11708. (let ((result (if calendar-debug-sexp
  11709. (let ((stack-trace-on-error t))
  11710. (eval (car (read-from-string sexp))))
  11711. (condition-case nil
  11712. (eval (car (read-from-string sexp)))
  11713. (error
  11714. (beep)
  11715. (message "Bad sexp at line %d in %s: %s"
  11716. (org-current-line)
  11717. (buffer-file-name) sexp)
  11718. (sleep-for 2))))))
  11719. (cond ((stringp result) result)
  11720. ((and (consp result)
  11721. (stringp (cdr result))) (cdr result))
  11722. (result entry)
  11723. (t nil))))
  11724. (defun org-diary-to-ical-string (frombuf)
  11725. "Get iCalendar entries from diary entries in buffer FROMBUF.
  11726. This uses the icalendar.el library."
  11727. (let* ((tmpdir (if (featurep 'xemacs)
  11728. (temp-directory)
  11729. temporary-file-directory))
  11730. (tmpfile (make-temp-name
  11731. (expand-file-name "orgics" tmpdir)))
  11732. buf rtn b e)
  11733. (save-excursion
  11734. (set-buffer frombuf)
  11735. (icalendar-export-region (point-min) (point-max) tmpfile)
  11736. (setq buf (find-buffer-visiting tmpfile))
  11737. (set-buffer buf)
  11738. (goto-char (point-min))
  11739. (if (re-search-forward "^BEGIN:VEVENT" nil t)
  11740. (setq b (match-beginning 0)))
  11741. (goto-char (point-max))
  11742. (if (re-search-backward "^END:VEVENT" nil t)
  11743. (setq e (match-end 0)))
  11744. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  11745. (kill-buffer buf)
  11746. (delete-file tmpfile)
  11747. rtn))
  11748. (defun org-closest-date (start current change prefer show-all)
  11749. "Find the date closest to CURRENT that is consistent with START and CHANGE.
  11750. When PREFER is `past' return a date that is either CURRENT or past.
  11751. When PREFER is `future', return a date that is either CURRENT or future.
  11752. When SHOW-ALL is nil, only return the current occurrence of a time stamp."
  11753. ;; Make the proper lists from the dates
  11754. (catch 'exit
  11755. (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
  11756. dn dw sday cday n1 n2 n0
  11757. d m y y1 y2 date1 date2 nmonths nm ny m2)
  11758. (setq start (org-date-to-gregorian start)
  11759. current (org-date-to-gregorian
  11760. (if show-all
  11761. current
  11762. (time-to-days (current-time))))
  11763. sday (calendar-absolute-from-gregorian start)
  11764. cday (calendar-absolute-from-gregorian current))
  11765. (if (<= cday sday) (throw 'exit sday))
  11766. (if (string-match "\\(\\+[0-9]+\\)\\([dwmy]\\)" change)
  11767. (setq dn (string-to-number (match-string 1 change))
  11768. dw (cdr (assoc (match-string 2 change) a1)))
  11769. (error "Invalid change specifyer: %s" change))
  11770. (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
  11771. (cond
  11772. ((eq dw 'day)
  11773. (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
  11774. n2 (+ n1 dn)))
  11775. ((eq dw 'year)
  11776. (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
  11777. (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
  11778. (setq date1 (list m d y1)
  11779. n1 (calendar-absolute-from-gregorian date1)
  11780. date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
  11781. n2 (calendar-absolute-from-gregorian date2)))
  11782. ((eq dw 'month)
  11783. ;; approx number of month between the two dates
  11784. (setq nmonths (floor (/ (- cday sday) 30.436875)))
  11785. ;; How often does dn fit in there?
  11786. (setq d (nth 1 start) m (car start) y (nth 2 start)
  11787. nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
  11788. m (+ m nm)
  11789. ny (floor (/ m 12))
  11790. y (+ y ny)
  11791. m (- m (* ny 12)))
  11792. (while (> m 12) (setq m (- m 12) y (1+ y)))
  11793. (setq n1 (calendar-absolute-from-gregorian (list m d y)))
  11794. (setq m2 (+ m dn) y2 y)
  11795. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  11796. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
  11797. (while (<= n2 cday)
  11798. (setq n1 n2 m m2 y y2)
  11799. (setq m2 (+ m dn) y2 y)
  11800. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  11801. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
  11802. ;; Make sure n1 is the earlier date
  11803. (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
  11804. (if show-all
  11805. (cond
  11806. ((eq prefer 'past) n1)
  11807. ((eq prefer 'future) (if (= cday n1) n1 n2))
  11808. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
  11809. (cond
  11810. ((eq prefer 'past) n1)
  11811. ((eq prefer 'future) (if (= cday n1) n1 n2))
  11812. (t (if (= cday n1) n1 n2)))))))
  11813. (defun org-date-to-gregorian (date)
  11814. "Turn any specification of DATE into a gregorian date for the calendar."
  11815. (cond ((integerp date) (calendar-gregorian-from-absolute date))
  11816. ((and (listp date) (= (length date) 3)) date)
  11817. ((stringp date)
  11818. (setq date (org-parse-time-string date))
  11819. (list (nth 4 date) (nth 3 date) (nth 5 date)))
  11820. ((listp date)
  11821. (list (nth 4 date) (nth 3 date) (nth 5 date)))))
  11822. (defun org-parse-time-string (s &optional nodefault)
  11823. "Parse the standard Org-mode time string.
  11824. This should be a lot faster than the normal `parse-time-string'.
  11825. If time is not given, defaults to 0:00. However, with optional NODEFAULT,
  11826. hour and minute fields will be nil if not given."
  11827. (if (string-match org-ts-regexp0 s)
  11828. (list 0
  11829. (if (or (match-beginning 8) (not nodefault))
  11830. (string-to-number (or (match-string 8 s) "0")))
  11831. (if (or (match-beginning 7) (not nodefault))
  11832. (string-to-number (or (match-string 7 s) "0")))
  11833. (string-to-number (match-string 4 s))
  11834. (string-to-number (match-string 3 s))
  11835. (string-to-number (match-string 2 s))
  11836. nil nil nil)
  11837. (make-list 9 0)))
  11838. (defun org-timestamp-up (&optional arg)
  11839. "Increase the date item at the cursor by one.
  11840. If the cursor is on the year, change the year. If it is on the month or
  11841. the day, change that.
  11842. With prefix ARG, change by that many units."
  11843. (interactive "p")
  11844. (org-timestamp-change (prefix-numeric-value arg)))
  11845. (defun org-timestamp-down (&optional arg)
  11846. "Decrease the date item at the cursor by one.
  11847. If the cursor is on the year, change the year. If it is on the month or
  11848. the day, change that.
  11849. With prefix ARG, change by that many units."
  11850. (interactive "p")
  11851. (org-timestamp-change (- (prefix-numeric-value arg))))
  11852. (defun org-timestamp-up-day (&optional arg)
  11853. "Increase the date in the time stamp by one day.
  11854. With prefix ARG, change that many days."
  11855. (interactive "p")
  11856. (if (and (not (org-at-timestamp-p t))
  11857. (org-on-heading-p))
  11858. (org-todo 'up)
  11859. (org-timestamp-change (prefix-numeric-value arg) 'day)))
  11860. (defun org-timestamp-down-day (&optional arg)
  11861. "Decrease the date in the time stamp by one day.
  11862. With prefix ARG, change that many days."
  11863. (interactive "p")
  11864. (if (and (not (org-at-timestamp-p t))
  11865. (org-on-heading-p))
  11866. (org-todo 'down)
  11867. (org-timestamp-change (- (prefix-numeric-value arg)) 'day)))
  11868. (defun org-at-timestamp-p (&optional inactive-ok)
  11869. "Determine if the cursor is in or at a timestamp."
  11870. (interactive)
  11871. (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
  11872. (pos (point))
  11873. (ans (or (looking-at tsr)
  11874. (save-excursion
  11875. (skip-chars-backward "^[<\n\r\t")
  11876. (if (> (point) (point-min)) (backward-char 1))
  11877. (and (looking-at tsr)
  11878. (> (- (match-end 0) pos) -1))))))
  11879. (and ans
  11880. (boundp 'org-ts-what)
  11881. (setq org-ts-what
  11882. (cond
  11883. ((= pos (match-beginning 0)) 'bracket)
  11884. ((= pos (1- (match-end 0))) 'bracket)
  11885. ((org-pos-in-match-range pos 2) 'year)
  11886. ((org-pos-in-match-range pos 3) 'month)
  11887. ((org-pos-in-match-range pos 7) 'hour)
  11888. ((org-pos-in-match-range pos 8) 'minute)
  11889. ((or (org-pos-in-match-range pos 4)
  11890. (org-pos-in-match-range pos 5)) 'day)
  11891. ((and (> pos (or (match-end 8) (match-end 5)))
  11892. (< pos (match-end 0)))
  11893. (- pos (or (match-end 8) (match-end 5))))
  11894. (t 'day))))
  11895. ans))
  11896. (defun org-toggle-timestamp-type ()
  11897. "Toggle the type (<active> or [inactive]) of a time stamp."
  11898. (interactive)
  11899. (when (org-at-timestamp-p t)
  11900. (let ((beg (match-beginning 0)) (end (match-end 0))
  11901. (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
  11902. (save-excursion
  11903. (goto-char beg)
  11904. (while (re-search-forward "[][<>]" end t)
  11905. (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
  11906. t t)))
  11907. (message "Timestamp is now %sactive"
  11908. (if (equal (char-after beg) ?<) "" "in")))))
  11909. (defun org-timestamp-change (n &optional what)
  11910. "Change the date in the time stamp at point.
  11911. The date will be changed by N times WHAT. WHAT can be `day', `month',
  11912. `year', `minute', `second'. If WHAT is not given, the cursor position
  11913. in the timestamp determines what will be changed."
  11914. (let ((pos (point))
  11915. with-hm inactive
  11916. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  11917. org-ts-what
  11918. extra rem
  11919. ts time time0)
  11920. (if (not (org-at-timestamp-p t))
  11921. (error "Not at a timestamp"))
  11922. (if (and (not what) (eq org-ts-what 'bracket))
  11923. (org-toggle-timestamp-type)
  11924. (if (and (not what) (not (eq org-ts-what 'day))
  11925. org-display-custom-times
  11926. (get-text-property (point) 'display)
  11927. (not (get-text-property (1- (point)) 'display)))
  11928. (setq org-ts-what 'day))
  11929. (setq org-ts-what (or what org-ts-what)
  11930. inactive (= (char-after (match-beginning 0)) ?\[)
  11931. ts (match-string 0))
  11932. (replace-match "")
  11933. (if (string-match
  11934. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?[-+][0-9]+[dwmy]\\)*\\)[]>]"
  11935. ts)
  11936. (setq extra (match-string 1 ts)))
  11937. (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  11938. (setq with-hm t))
  11939. (setq time0 (org-parse-time-string ts))
  11940. (when (and (eq org-ts-what 'minute)
  11941. (eq current-prefix-arg nil))
  11942. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  11943. (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
  11944. (setcar (cdr time0) (+ (nth 1 time0)
  11945. (if (> n 0) (- rem) (- dm rem))))))
  11946. (setq time
  11947. (encode-time (or (car time0) 0)
  11948. (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
  11949. (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
  11950. (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
  11951. (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
  11952. (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
  11953. (nthcdr 6 time0)))
  11954. (when (and (member org-ts-what '(hour minute))
  11955. extra
  11956. (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
  11957. (setq extra (org-modify-ts-extra
  11958. extra
  11959. (if (eq org-ts-what 'hour) 2 5)
  11960. n dm)))
  11961. (when (integerp org-ts-what)
  11962. (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
  11963. (if (eq what 'calendar)
  11964. (let ((cal-date (org-get-date-from-calendar)))
  11965. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  11966. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  11967. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  11968. (setcar time0 (or (car time0) 0))
  11969. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  11970. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  11971. (setq time (apply 'encode-time time0))))
  11972. (setq org-last-changed-timestamp
  11973. (org-insert-time-stamp time with-hm inactive nil nil extra))
  11974. (org-clock-update-time-maybe)
  11975. (goto-char pos)
  11976. ;; Try to recenter the calendar window, if any
  11977. (if (and org-calendar-follow-timestamp-change
  11978. (get-buffer-window "*Calendar*" t)
  11979. (memq org-ts-what '(day month year)))
  11980. (org-recenter-calendar (time-to-days time))))))
  11981. (defun org-modify-ts-extra (s pos n dm)
  11982. "Change the different parts of the lead-time and repeat fields in timestamp."
  11983. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  11984. ng h m new rem)
  11985. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  11986. (cond
  11987. ((or (org-pos-in-match-range pos 2)
  11988. (org-pos-in-match-range pos 3))
  11989. (setq m (string-to-number (match-string 3 s))
  11990. h (string-to-number (match-string 2 s)))
  11991. (if (org-pos-in-match-range pos 2)
  11992. (setq h (+ h n))
  11993. (setq n (* dm (org-no-warnings (signum n))))
  11994. (when (not (= 0 (setq rem (% m dm))))
  11995. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  11996. (setq m (+ m n)))
  11997. (if (< m 0) (setq m (+ m 60) h (1- h)))
  11998. (if (> m 59) (setq m (- m 60) h (1+ h)))
  11999. (setq h (min 24 (max 0 h)))
  12000. (setq ng 1 new (format "-%02d:%02d" h m)))
  12001. ((org-pos-in-match-range pos 6)
  12002. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  12003. ((org-pos-in-match-range pos 5)
  12004. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  12005. ((org-pos-in-match-range pos 9)
  12006. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  12007. ((org-pos-in-match-range pos 8)
  12008. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  12009. (when ng
  12010. (setq s (concat
  12011. (substring s 0 (match-beginning ng))
  12012. new
  12013. (substring s (match-end ng))))))
  12014. s))
  12015. (defun org-recenter-calendar (date)
  12016. "If the calendar is visible, recenter it to DATE."
  12017. (let* ((win (selected-window))
  12018. (cwin (get-buffer-window "*Calendar*" t))
  12019. (calendar-move-hook nil))
  12020. (when cwin
  12021. (select-window cwin)
  12022. (calendar-goto-date (if (listp date) date
  12023. (calendar-gregorian-from-absolute date)))
  12024. (select-window win))))
  12025. (defun org-goto-calendar (&optional arg)
  12026. "Go to the Emacs calendar at the current date.
  12027. If there is a time stamp in the current line, go to that date.
  12028. A prefix ARG can be used to force the current date."
  12029. (interactive "P")
  12030. (let ((tsr org-ts-regexp) diff
  12031. (calendar-move-hook nil)
  12032. (calendar-view-holidays-initially-flag nil)
  12033. (view-calendar-holidays-initially nil)
  12034. (calendar-view-diary-initially-flag nil)
  12035. (view-diary-entries-initially nil))
  12036. (if (or (org-at-timestamp-p)
  12037. (save-excursion
  12038. (beginning-of-line 1)
  12039. (looking-at (concat ".*" tsr))))
  12040. (let ((d1 (time-to-days (current-time)))
  12041. (d2 (time-to-days
  12042. (org-time-string-to-time (match-string 1)))))
  12043. (setq diff (- d2 d1))))
  12044. (calendar)
  12045. (calendar-goto-today)
  12046. (if (and diff (not arg)) (calendar-forward-day diff))))
  12047. (defun org-get-date-from-calendar ()
  12048. "Return a list (month day year) of date at point in calendar."
  12049. (with-current-buffer "*Calendar*"
  12050. (save-match-data
  12051. (calendar-cursor-to-date))))
  12052. (defun org-date-from-calendar ()
  12053. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  12054. If there is already a time stamp at the cursor position, update it."
  12055. (interactive)
  12056. (if (org-at-timestamp-p t)
  12057. (org-timestamp-change 0 'calendar)
  12058. (let ((cal-date (org-get-date-from-calendar)))
  12059. (org-insert-time-stamp
  12060. (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  12061. (defun org-minutes-to-hh:mm-string (m)
  12062. "Compute H:MM from a number of minutes."
  12063. (let ((h (/ m 60)))
  12064. (setq m (- m (* 60 h)))
  12065. (format org-time-clocksum-format h m)))
  12066. (defun org-hh:mm-string-to-minutes (s)
  12067. "Convert a string H:MM to a number of minutes."
  12068. (if (string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  12069. (+ (* (string-to-number (match-string 1 s)) 60)
  12070. (string-to-number (match-string 2 s)))
  12071. 0))
  12072. ;;;; Files
  12073. (defun org-save-all-org-buffers ()
  12074. "Save all Org-mode buffers without user confirmation."
  12075. (interactive)
  12076. (message "Saving all Org-mode buffers...")
  12077. (save-some-buffers t 'org-mode-p)
  12078. (when (featurep 'org-id) (org-id-locations-save))
  12079. (message "Saving all Org-mode buffers... done"))
  12080. (defun org-revert-all-org-buffers ()
  12081. "Revert all Org-mode buffers.
  12082. Prompt for confirmation when there are unsaved changes.
  12083. Be sure you know what you are doing before letting this function
  12084. overwrite your changes.
  12085. This function is useful in a setup where one tracks org files
  12086. with a version control system, to revert on one machine after pulling
  12087. changes from another. I believe the procedure must be like this:
  12088. 1. M-x org-save-all-org-buffers
  12089. 2. Pull changes from the other machine, resolve conflicts
  12090. 3. M-x org-revert-all-org-buffers"
  12091. (interactive)
  12092. (unless (yes-or-no-p "Revert all Org buffers from their files? ")
  12093. (error "Abort"))
  12094. (save-excursion
  12095. (save-window-excursion
  12096. (mapc
  12097. (lambda (b)
  12098. (when (and (with-current-buffer b (org-mode-p))
  12099. (with-current-buffer b buffer-file-name))
  12100. (switch-to-buffer b)
  12101. (revert-buffer t 'no-confirm)))
  12102. (buffer-list))
  12103. (when (and (featurep 'org-id) org-id-track-globally)
  12104. (org-id-locations-load)))))
  12105. ;;;; Agenda files
  12106. ;;;###autoload
  12107. (defun org-iswitchb (&optional arg)
  12108. "Use `iswitchb-read-buffer' to prompt for an Org buffer to switch to.
  12109. With a prefix argument, restrict available to files.
  12110. With two prefix arguments, restrict available buffers to agenda files.
  12111. Due to some yet unresolved reason, the global function
  12112. `iswitchb-mode' needs to be active for this function to work."
  12113. (interactive "P")
  12114. (require 'iswitchb)
  12115. (let ((enabled iswitchb-mode) blist)
  12116. (or enabled (iswitchb-mode 1))
  12117. (setq blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  12118. ((equal arg '(16)) (org-buffer-list 'agenda))
  12119. (t (org-buffer-list))))
  12120. (unwind-protect
  12121. (let ((iswitchb-make-buflist-hook
  12122. (lambda ()
  12123. (setq iswitchb-temp-buflist
  12124. (mapcar 'buffer-name blist)))))
  12125. (switch-to-buffer
  12126. (iswitchb-read-buffer
  12127. "Switch-to: " nil t))
  12128. (or enabled (iswitchb-mode -1))))))
  12129. ;;;###autoload
  12130. (defun org-ido-switchb (&optional arg)
  12131. "Use `org-ido-completing-read' to prompt for an Org buffer to switch to.
  12132. With a prefix argument, restrict available to files.
  12133. With two prefix arguments, restrict available buffers to agenda files."
  12134. (interactive "P")
  12135. (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  12136. ((equal arg '(16)) (org-buffer-list 'agenda))
  12137. (t (org-buffer-list)))))
  12138. (switch-to-buffer
  12139. (org-ido-completing-read "Org buffer: "
  12140. (mapcar 'list (mapcar 'buffer-name blist))
  12141. nil t))))
  12142. (defun org-buffer-list (&optional predicate exclude-tmp)
  12143. "Return a list of Org buffers.
  12144. PREDICATE can be `export', `files' or `agenda'.
  12145. export restrict the list to Export buffers.
  12146. files restrict the list to buffers visiting Org files.
  12147. agenda restrict the list to buffers visiting agenda files.
  12148. If EXCLUDE-TMP is non-nil, ignore temporary buffers."
  12149. (let* ((bfn nil)
  12150. (agenda-files (and (eq predicate 'agenda)
  12151. (mapcar 'file-truename (org-agenda-files t))))
  12152. (filter
  12153. (cond
  12154. ((eq predicate 'files)
  12155. (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
  12156. ((eq predicate 'export)
  12157. (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
  12158. ((eq predicate 'agenda)
  12159. (lambda (b)
  12160. (with-current-buffer b
  12161. (and (eq major-mode 'org-mode)
  12162. (setq bfn (buffer-file-name b))
  12163. (member (file-truename bfn) agenda-files)))))
  12164. (t (lambda (b) (with-current-buffer b
  12165. (or (eq major-mode 'org-mode)
  12166. (string-match "\*Org .*Export"
  12167. (buffer-name b)))))))))
  12168. (delq nil
  12169. (mapcar
  12170. (lambda(b)
  12171. (if (and (funcall filter b)
  12172. (or (not exclude-tmp)
  12173. (not (string-match "tmp" (buffer-name b)))))
  12174. b
  12175. nil))
  12176. (buffer-list)))))
  12177. (defun org-agenda-files (&optional unrestricted archives)
  12178. "Get the list of agenda files.
  12179. Optional UNRESTRICTED means return the full list even if a restriction
  12180. is currently in place.
  12181. When ARCHIVES is t, include all archive files hat are really being
  12182. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  12183. `org-agenda-archives-mode' is t."
  12184. (let ((files
  12185. (cond
  12186. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  12187. ((stringp org-agenda-files) (org-read-agenda-file-list))
  12188. ((listp org-agenda-files) org-agenda-files)
  12189. (t (error "Invalid value of `org-agenda-files'")))))
  12190. (setq files (apply 'append
  12191. (mapcar (lambda (f)
  12192. (if (file-directory-p f)
  12193. (directory-files
  12194. f t org-agenda-file-regexp)
  12195. (list f)))
  12196. files)))
  12197. (when org-agenda-skip-unavailable-files
  12198. (setq files (delq nil
  12199. (mapcar (function
  12200. (lambda (file)
  12201. (and (file-readable-p file) file)))
  12202. files))))
  12203. (when (or (eq archives t)
  12204. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  12205. (setq files (org-add-archive-files files)))
  12206. files))
  12207. (defun org-edit-agenda-file-list ()
  12208. "Edit the list of agenda files.
  12209. Depending on setup, this either uses customize to edit the variable
  12210. `org-agenda-files', or it visits the file that is holding the list. In the
  12211. latter case, the buffer is set up in a way that saving it automatically kills
  12212. the buffer and restores the previous window configuration."
  12213. (interactive)
  12214. (if (stringp org-agenda-files)
  12215. (let ((cw (current-window-configuration)))
  12216. (find-file org-agenda-files)
  12217. (org-set-local 'org-window-configuration cw)
  12218. (org-add-hook 'after-save-hook
  12219. (lambda ()
  12220. (set-window-configuration
  12221. (prog1 org-window-configuration
  12222. (kill-buffer (current-buffer))))
  12223. (org-install-agenda-files-menu)
  12224. (message "New agenda file list installed"))
  12225. nil 'local)
  12226. (message "%s" (substitute-command-keys
  12227. "Edit list and finish with \\[save-buffer]")))
  12228. (customize-variable 'org-agenda-files)))
  12229. (defun org-store-new-agenda-file-list (list)
  12230. "Set new value for the agenda file list and save it correctly."
  12231. (if (stringp org-agenda-files)
  12232. (let ((f org-agenda-files) b)
  12233. (while (setq b (find-buffer-visiting f)) (kill-buffer b))
  12234. (with-temp-file f
  12235. (insert (mapconcat 'identity list "\n") "\n")))
  12236. (let ((org-mode-hook nil) (default-major-mode 'fundamental-mode))
  12237. (setq org-agenda-files list)
  12238. (customize-save-variable 'org-agenda-files org-agenda-files))))
  12239. (defun org-read-agenda-file-list ()
  12240. "Read the list of agenda files from a file."
  12241. (when (file-directory-p org-agenda-files)
  12242. (error "`org-agenda-files' cannot be a single directory"))
  12243. (when (stringp org-agenda-files)
  12244. (with-temp-buffer
  12245. (insert-file-contents org-agenda-files)
  12246. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*"))))
  12247. ;;;###autoload
  12248. (defun org-cycle-agenda-files ()
  12249. "Cycle through the files in `org-agenda-files'.
  12250. If the current buffer visits an agenda file, find the next one in the list.
  12251. If the current buffer does not, find the first agenda file."
  12252. (interactive)
  12253. (let* ((fs (org-agenda-files t))
  12254. (files (append fs (list (car fs))))
  12255. (tcf (if buffer-file-name (file-truename buffer-file-name)))
  12256. file)
  12257. (unless files (error "No agenda files"))
  12258. (catch 'exit
  12259. (while (setq file (pop files))
  12260. (if (equal (file-truename file) tcf)
  12261. (when (car files)
  12262. (find-file (car files))
  12263. (throw 'exit t))))
  12264. (find-file (car fs)))
  12265. (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
  12266. (defun org-agenda-file-to-front (&optional to-end)
  12267. "Move/add the current file to the top of the agenda file list.
  12268. If the file is not present in the list, it is added to the front. If it is
  12269. present, it is moved there. With optional argument TO-END, add/move to the
  12270. end of the list."
  12271. (interactive "P")
  12272. (let ((org-agenda-skip-unavailable-files nil)
  12273. (file-alist (mapcar (lambda (x)
  12274. (cons (file-truename x) x))
  12275. (org-agenda-files t)))
  12276. (ctf (file-truename buffer-file-name))
  12277. x had)
  12278. (setq x (assoc ctf file-alist) had x)
  12279. (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  12280. (if to-end
  12281. (setq file-alist (append (delq x file-alist) (list x)))
  12282. (setq file-alist (cons x (delq x file-alist))))
  12283. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  12284. (org-install-agenda-files-menu)
  12285. (message "File %s to %s of agenda file list"
  12286. (if had "moved" "added") (if to-end "end" "front"))))
  12287. (defun org-remove-file (&optional file)
  12288. "Remove current file from the list of files in variable `org-agenda-files'.
  12289. These are the files which are being checked for agenda entries.
  12290. Optional argument FILE means, use this file instead of the current."
  12291. (interactive)
  12292. (let* ((org-agenda-skip-unavailable-files nil)
  12293. (file (or file buffer-file-name))
  12294. (true-file (file-truename file))
  12295. (afile (abbreviate-file-name file))
  12296. (files (delq nil (mapcar
  12297. (lambda (x)
  12298. (if (equal true-file
  12299. (file-truename x))
  12300. nil x))
  12301. (org-agenda-files t)))))
  12302. (if (not (= (length files) (length (org-agenda-files t))))
  12303. (progn
  12304. (org-store-new-agenda-file-list files)
  12305. (org-install-agenda-files-menu)
  12306. (message "Removed file: %s" afile))
  12307. (message "File was not in list: %s (not removed)" afile))))
  12308. (defun org-file-menu-entry (file)
  12309. (vector file (list 'find-file file) t))
  12310. (defun org-check-agenda-file (file)
  12311. "Make sure FILE exists. If not, ask user what to do."
  12312. (when (not (file-exists-p file))
  12313. (message "non-existent file %s. [R]emove from list or [A]bort?"
  12314. (abbreviate-file-name file))
  12315. (let ((r (downcase (read-char-exclusive))))
  12316. (cond
  12317. ((equal r ?r)
  12318. (org-remove-file file)
  12319. (throw 'nextfile t))
  12320. (t (error "Abort"))))))
  12321. (defun org-get-agenda-file-buffer (file)
  12322. "Get a buffer visiting FILE. If the buffer needs to be created, add
  12323. it to the list of buffers which might be released later."
  12324. (let ((buf (org-find-base-buffer-visiting file)))
  12325. (if buf
  12326. buf ; just return it
  12327. ;; Make a new buffer and remember it
  12328. (setq buf (find-file-noselect file))
  12329. (if buf (push buf org-agenda-new-buffers))
  12330. buf)))
  12331. (defun org-release-buffers (blist)
  12332. "Release all buffers in list, asking the user for confirmation when needed.
  12333. When a buffer is unmodified, it is just killed. When modified, it is saved
  12334. \(if the user agrees) and then killed."
  12335. (let (buf file)
  12336. (while (setq buf (pop blist))
  12337. (setq file (buffer-file-name buf))
  12338. (when (and (buffer-modified-p buf)
  12339. file
  12340. (y-or-n-p (format "Save file %s? " file)))
  12341. (with-current-buffer buf (save-buffer)))
  12342. (kill-buffer buf))))
  12343. (defun org-prepare-agenda-buffers (files)
  12344. "Create buffers for all agenda files, protect archived trees and comments."
  12345. (interactive)
  12346. (let ((pa '(:org-archived t))
  12347. (pc '(:org-comment t))
  12348. (pall '(:org-archived t :org-comment t))
  12349. (inhibit-read-only t)
  12350. (rea (concat ":" org-archive-tag ":"))
  12351. bmp file re)
  12352. (save-excursion
  12353. (save-restriction
  12354. (while (setq file (pop files))
  12355. (catch 'nextfile
  12356. (if (bufferp file)
  12357. (set-buffer file)
  12358. (org-check-agenda-file file)
  12359. (set-buffer (org-get-agenda-file-buffer file)))
  12360. (widen)
  12361. (setq bmp (buffer-modified-p))
  12362. (org-refresh-category-properties)
  12363. (setq org-todo-keywords-for-agenda
  12364. (append org-todo-keywords-for-agenda org-todo-keywords-1))
  12365. (setq org-done-keywords-for-agenda
  12366. (append org-done-keywords-for-agenda org-done-keywords))
  12367. (setq org-todo-keyword-alist-for-agenda
  12368. (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
  12369. (setq org-tag-alist-for-agenda
  12370. (append org-tag-alist-for-agenda org-tag-alist))
  12371. (save-excursion
  12372. (remove-text-properties (point-min) (point-max) pall)
  12373. (when org-agenda-skip-archived-trees
  12374. (goto-char (point-min))
  12375. (while (re-search-forward rea nil t)
  12376. (if (org-on-heading-p t)
  12377. (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
  12378. (goto-char (point-min))
  12379. (setq re (concat "^\\*+ +" org-comment-string "\\>"))
  12380. (while (re-search-forward re nil t)
  12381. (add-text-properties
  12382. (match-beginning 0) (org-end-of-subtree t) pc)))
  12383. (set-buffer-modified-p bmp)))))
  12384. (setq org-todo-keyword-alist-for-agenda
  12385. (org-uniquify org-todo-keyword-alist-for-agenda)
  12386. org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
  12387. ;;;; Embedded LaTeX
  12388. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  12389. "Keymap for the minor `org-cdlatex-mode'.")
  12390. (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
  12391. (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
  12392. (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
  12393. (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
  12394. (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
  12395. (defvar org-cdlatex-texmathp-advice-is-done nil
  12396. "Flag remembering if we have applied the advice to texmathp already.")
  12397. (define-minor-mode org-cdlatex-mode
  12398. "Toggle the minor `org-cdlatex-mode'.
  12399. This mode supports entering LaTeX environment and math in LaTeX fragments
  12400. in Org-mode.
  12401. \\{org-cdlatex-mode-map}"
  12402. nil " OCDL" nil
  12403. (when org-cdlatex-mode (require 'cdlatex))
  12404. (unless org-cdlatex-texmathp-advice-is-done
  12405. (setq org-cdlatex-texmathp-advice-is-done t)
  12406. (defadvice texmathp (around org-math-always-on activate)
  12407. "Always return t in org-mode buffers.
  12408. This is because we want to insert math symbols without dollars even outside
  12409. the LaTeX math segments. If Orgmode thinks that point is actually inside
  12410. an embedded LaTeX fragment, let texmathp do its job.
  12411. \\[org-cdlatex-mode-map]"
  12412. (interactive)
  12413. (let (p)
  12414. (cond
  12415. ((not (org-mode-p)) ad-do-it)
  12416. ((eq this-command 'cdlatex-math-symbol)
  12417. (setq ad-return-value t
  12418. texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
  12419. (t
  12420. (let ((p (org-inside-LaTeX-fragment-p)))
  12421. (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
  12422. (setq ad-return-value t
  12423. texmathp-why '("Org-mode embedded math" . 0))
  12424. (if p ad-do-it)))))))))
  12425. (defun turn-on-org-cdlatex ()
  12426. "Unconditionally turn on `org-cdlatex-mode'."
  12427. (org-cdlatex-mode 1))
  12428. (defun org-inside-LaTeX-fragment-p ()
  12429. "Test if point is inside a LaTeX fragment.
  12430. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  12431. sequence appearing also before point.
  12432. Even though the matchers for math are configurable, this function assumes
  12433. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  12434. delimiters are skipped when they have been removed by customization.
  12435. The return value is nil, or a cons cell with the delimiter and
  12436. and the position of this delimiter.
  12437. This function does a reasonably good job, but can locally be fooled by
  12438. for example currency specifications. For example it will assume being in
  12439. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  12440. fragments that are properly closed, but during editing, we have to live
  12441. with the uncertainty caused by missing closing delimiters. This function
  12442. looks only before point, not after."
  12443. (catch 'exit
  12444. (let ((pos (point))
  12445. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  12446. (lim (progn
  12447. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
  12448. (point)))
  12449. dd-on str (start 0) m re)
  12450. (goto-char pos)
  12451. (when dodollar
  12452. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  12453. re (nth 1 (assoc "$" org-latex-regexps)))
  12454. (while (string-match re str start)
  12455. (cond
  12456. ((= (match-end 0) (length str))
  12457. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  12458. ((= (match-end 0) (- (length str) 5))
  12459. (throw 'exit nil))
  12460. (t (setq start (match-end 0))))))
  12461. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  12462. (goto-char pos)
  12463. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  12464. (and (match-beginning 2) (throw 'exit nil))
  12465. ;; count $$
  12466. (while (re-search-backward "\\$\\$" lim t)
  12467. (setq dd-on (not dd-on)))
  12468. (goto-char pos)
  12469. (if dd-on (cons "$$" m))))))
  12470. (defun org-try-cdlatex-tab ()
  12471. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  12472. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  12473. - inside a LaTeX fragment, or
  12474. - after the first word in a line, where an abbreviation expansion could
  12475. insert a LaTeX environment."
  12476. (when org-cdlatex-mode
  12477. (cond
  12478. ((save-excursion
  12479. (skip-chars-backward "a-zA-Z0-9*")
  12480. (skip-chars-backward " \t")
  12481. (bolp))
  12482. (cdlatex-tab) t)
  12483. ((org-inside-LaTeX-fragment-p)
  12484. (cdlatex-tab) t)
  12485. (t nil))))
  12486. (defun org-cdlatex-underscore-caret (&optional arg)
  12487. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  12488. Revert to the normal definition outside of these fragments."
  12489. (interactive "P")
  12490. (if (org-inside-LaTeX-fragment-p)
  12491. (call-interactively 'cdlatex-sub-superscript)
  12492. (let (org-cdlatex-mode)
  12493. (call-interactively (key-binding (vector last-input-event))))))
  12494. (defun org-cdlatex-math-modify (&optional arg)
  12495. "Execute `cdlatex-math-modify' in LaTeX fragments.
  12496. Revert to the normal definition outside of these fragments."
  12497. (interactive "P")
  12498. (if (org-inside-LaTeX-fragment-p)
  12499. (call-interactively 'cdlatex-math-modify)
  12500. (let (org-cdlatex-mode)
  12501. (call-interactively (key-binding (vector last-input-event))))))
  12502. (defvar org-latex-fragment-image-overlays nil
  12503. "List of overlays carrying the images of latex fragments.")
  12504. (make-variable-buffer-local 'org-latex-fragment-image-overlays)
  12505. (defun org-remove-latex-fragment-image-overlays ()
  12506. "Remove all overlays with LaTeX fragment images in current buffer."
  12507. (mapc 'org-delete-overlay org-latex-fragment-image-overlays)
  12508. (setq org-latex-fragment-image-overlays nil))
  12509. (defun org-preview-latex-fragment (&optional subtree)
  12510. "Preview the LaTeX fragment at point, or all locally or globally.
  12511. If the cursor is in a LaTeX fragment, create the image and overlay
  12512. it over the source code. If there is no fragment at point, display
  12513. all fragments in the current text, from one headline to the next. With
  12514. prefix SUBTREE, display all fragments in the current subtree. With a
  12515. double prefix `C-u C-u', or when the cursor is before the first headline,
  12516. display all fragments in the buffer.
  12517. The images can be removed again with \\[org-ctrl-c-ctrl-c]."
  12518. (interactive "P")
  12519. (org-remove-latex-fragment-image-overlays)
  12520. (save-excursion
  12521. (save-restriction
  12522. (let (beg end at msg)
  12523. (cond
  12524. ((or (equal subtree '(16))
  12525. (not (save-excursion
  12526. (re-search-backward (concat "^" outline-regexp) nil t))))
  12527. (setq beg (point-min) end (point-max)
  12528. msg "Creating images for buffer...%s"))
  12529. ((equal subtree '(4))
  12530. (org-back-to-heading)
  12531. (setq beg (point) end (org-end-of-subtree t)
  12532. msg "Creating images for subtree...%s"))
  12533. (t
  12534. (if (setq at (org-inside-LaTeX-fragment-p))
  12535. (goto-char (max (point-min) (- (cdr at) 2)))
  12536. (org-back-to-heading))
  12537. (setq beg (point) end (progn (outline-next-heading) (point))
  12538. msg (if at "Creating image...%s"
  12539. "Creating images for entry...%s"))))
  12540. (message msg "")
  12541. (narrow-to-region beg end)
  12542. (goto-char beg)
  12543. (org-format-latex
  12544. (concat "ltxpng/" (file-name-sans-extension
  12545. (file-name-nondirectory
  12546. buffer-file-name)))
  12547. default-directory 'overlays msg at 'forbuffer)
  12548. (message msg "done. Use `C-c C-c' to remove images.")))))
  12549. (defvar org-latex-regexps
  12550. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  12551. ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
  12552. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  12553. ("$1" "\\([^$]\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  12554. ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  12555. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  12556. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 t)
  12557. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 t))
  12558. "Regular expressions for matching embedded LaTeX.")
  12559. (defun org-format-latex (prefix &optional dir overlays msg at forbuffer)
  12560. "Replace LaTeX fragments with links to an image, and produce images."
  12561. (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  12562. (let* ((prefixnodir (file-name-nondirectory prefix))
  12563. (absprefix (expand-file-name prefix dir))
  12564. (todir (file-name-directory absprefix))
  12565. (opt org-format-latex-options)
  12566. (matchers (plist-get opt :matchers))
  12567. (re-list org-latex-regexps)
  12568. (cnt 0) txt link beg end re e checkdir
  12569. executables-checked
  12570. m n block linkfile movefile ov)
  12571. ;; Check if there are old images files with this prefix, and remove them
  12572. (when (file-directory-p todir)
  12573. (mapc 'delete-file
  12574. (directory-files
  12575. todir 'full
  12576. (concat (regexp-quote prefixnodir) "_[0-9]+\\.png$"))))
  12577. ;; Check the different regular expressions
  12578. (while (setq e (pop re-list))
  12579. (setq m (car e) re (nth 1 e) n (nth 2 e)
  12580. block (if (nth 3 e) "\n\n" ""))
  12581. (when (member m matchers)
  12582. (goto-char (point-min))
  12583. (while (re-search-forward re nil t)
  12584. (when (and (or (not at) (equal (cdr at) (match-beginning n)))
  12585. (not (get-text-property (match-beginning n)
  12586. 'org-protected)))
  12587. (setq txt (match-string n)
  12588. beg (match-beginning n) end (match-end n)
  12589. cnt (1+ cnt)
  12590. linkfile (format "%s_%04d.png" prefix cnt)
  12591. movefile (format "%s_%04d.png" absprefix cnt)
  12592. link (concat block "[[file:" linkfile "]]" block))
  12593. (if msg (message msg cnt))
  12594. (goto-char beg)
  12595. (unless checkdir ; make sure the directory exists
  12596. (setq checkdir t)
  12597. (or (file-directory-p todir) (make-directory todir)))
  12598. (unless executables-checked
  12599. (org-check-external-command
  12600. "latex" "needed to convert LaTeX fragments to images")
  12601. (org-check-external-command
  12602. "dvipng" "needed to convert LaTeX fragments to images")
  12603. (setq executables-checked t))
  12604. (org-create-formula-image
  12605. txt movefile opt forbuffer)
  12606. (if overlays
  12607. (progn
  12608. (setq ov (org-make-overlay beg end))
  12609. (if (featurep 'xemacs)
  12610. (progn
  12611. (org-overlay-put ov 'invisible t)
  12612. (org-overlay-put
  12613. ov 'end-glyph
  12614. (make-glyph (vector 'png :file movefile))))
  12615. (org-overlay-put
  12616. ov 'display
  12617. (list 'image :type 'png :file movefile :ascent 'center)))
  12618. (push ov org-latex-fragment-image-overlays)
  12619. (goto-char end))
  12620. (delete-region beg end)
  12621. (insert link))))))))
  12622. ;; This function borrows from Ganesh Swami's latex2png.el
  12623. (defun org-create-formula-image (string tofile options buffer)
  12624. (let* ((tmpdir (if (featurep 'xemacs)
  12625. (temp-directory)
  12626. temporary-file-directory))
  12627. (texfilebase (make-temp-name
  12628. (expand-file-name "orgtex" tmpdir)))
  12629. (texfile (concat texfilebase ".tex"))
  12630. (dvifile (concat texfilebase ".dvi"))
  12631. (pngfile (concat texfilebase ".png"))
  12632. (fnh (if (featurep 'xemacs)
  12633. (font-height (get-face-font 'default))
  12634. (face-attribute 'default :height nil)))
  12635. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  12636. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  12637. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  12638. "Black"))
  12639. (bg (or (plist-get options (if buffer :background :html-background))
  12640. "Transparent")))
  12641. (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
  12642. (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
  12643. (with-temp-file texfile
  12644. (insert org-format-latex-header
  12645. "\n\\begin{document}\n" string "\n\\end{document}\n"))
  12646. (let ((dir default-directory))
  12647. (condition-case nil
  12648. (progn
  12649. (cd tmpdir)
  12650. (call-process "latex" nil nil nil texfile))
  12651. (error nil))
  12652. (cd dir))
  12653. (if (not (file-exists-p dvifile))
  12654. (progn (message "Failed to create dvi file from %s" texfile) nil)
  12655. (condition-case nil
  12656. (call-process "dvipng" nil nil nil
  12657. "-E" "-fg" fg "-bg" bg
  12658. "-D" dpi
  12659. ;;"-x" scale "-y" scale
  12660. "-T" "tight"
  12661. "-o" pngfile
  12662. dvifile)
  12663. (error nil))
  12664. (if (not (file-exists-p pngfile))
  12665. (progn (message "Failed to create png file from %s" texfile) nil)
  12666. ;; Use the requested file name and clean up
  12667. (copy-file pngfile tofile 'replace)
  12668. (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
  12669. (delete-file (concat texfilebase e)))
  12670. pngfile))))
  12671. (defun org-dvipng-color (attr)
  12672. "Return an rgb color specification for dvipng."
  12673. (apply 'format "rgb %s %s %s"
  12674. (mapcar 'org-normalize-color
  12675. (color-values (face-attribute 'default attr nil)))))
  12676. (defun org-normalize-color (value)
  12677. "Return string to be used as color value for an RGB component."
  12678. (format "%g" (/ value 65535.0)))
  12679. ;;;; Key bindings
  12680. ;; Make `C-c C-x' a prefix key
  12681. (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
  12682. ;; TAB key with modifiers
  12683. (org-defkey org-mode-map "\C-i" 'org-cycle)
  12684. (org-defkey org-mode-map [(tab)] 'org-cycle)
  12685. (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
  12686. (org-defkey org-mode-map [(meta tab)] 'org-complete)
  12687. (org-defkey org-mode-map "\M-\t" 'org-complete)
  12688. (org-defkey org-mode-map "\M-\C-i" 'org-complete)
  12689. ;; The following line is necessary under Suse GNU/Linux
  12690. (unless (featurep 'xemacs)
  12691. (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
  12692. (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
  12693. (define-key org-mode-map [backtab] 'org-shifttab)
  12694. (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
  12695. (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
  12696. (org-defkey org-mode-map [(meta return)] 'org-meta-return)
  12697. ;; Cursor keys with modifiers
  12698. (org-defkey org-mode-map [(meta left)] 'org-metaleft)
  12699. (org-defkey org-mode-map [(meta right)] 'org-metaright)
  12700. (org-defkey org-mode-map [(meta up)] 'org-metaup)
  12701. (org-defkey org-mode-map [(meta down)] 'org-metadown)
  12702. (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
  12703. (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
  12704. (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
  12705. (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
  12706. (org-defkey org-mode-map [(shift up)] 'org-shiftup)
  12707. (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
  12708. (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
  12709. (org-defkey org-mode-map [(shift right)] 'org-shiftright)
  12710. (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
  12711. (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
  12712. ;;; Extra keys for tty access.
  12713. ;; We only set them when really needed because otherwise the
  12714. ;; menus don't show the simple keys
  12715. (when (or org-use-extra-keys
  12716. (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
  12717. (not window-system))
  12718. (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
  12719. (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
  12720. (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
  12721. (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
  12722. (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
  12723. (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
  12724. (org-defkey org-mode-map [?\e (right)] 'org-metaright)
  12725. (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
  12726. (org-defkey org-mode-map [?\e (up)] 'org-metaup)
  12727. (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
  12728. (org-defkey org-mode-map [?\e (down)] 'org-metadown)
  12729. (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
  12730. (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
  12731. (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
  12732. (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
  12733. (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
  12734. (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
  12735. (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
  12736. (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
  12737. (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
  12738. (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
  12739. (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
  12740. ;; All the other keys
  12741. (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
  12742. (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
  12743. (if (boundp 'narrow-map)
  12744. (org-defkey narrow-map "s" 'org-narrow-to-subtree)
  12745. (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
  12746. (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
  12747. (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
  12748. (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
  12749. (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
  12750. (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
  12751. (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
  12752. (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
  12753. (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
  12754. (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
  12755. (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
  12756. (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
  12757. (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
  12758. (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
  12759. (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
  12760. (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
  12761. (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
  12762. (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
  12763. (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
  12764. (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
  12765. (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
  12766. (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
  12767. (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
  12768. (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
  12769. (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
  12770. (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
  12771. (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
  12772. (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
  12773. (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
  12774. (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
  12775. (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
  12776. (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
  12777. (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
  12778. (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
  12779. (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
  12780. (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
  12781. (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
  12782. (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
  12783. (org-defkey org-mode-map "\C-c]" 'org-remove-file)
  12784. (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
  12785. (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  12786. (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
  12787. (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
  12788. (org-defkey org-mode-map "\C-c^" 'org-sort)
  12789. (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
  12790. (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
  12791. (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
  12792. (org-defkey org-mode-map "\C-m" 'org-return)
  12793. (org-defkey org-mode-map "\C-j" 'org-return-indent)
  12794. (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
  12795. (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
  12796. (org-defkey org-mode-map "\C-c+" 'org-table-sum)
  12797. (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
  12798. (org-defkey org-mode-map "\C-c'" 'org-edit-special)
  12799. (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
  12800. (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
  12801. (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
  12802. (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
  12803. (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
  12804. (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
  12805. (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
  12806. (org-defkey org-mode-map "\C-c\C-e" 'org-export)
  12807. (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
  12808. (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
  12809. (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
  12810. (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
  12811. (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
  12812. (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
  12813. (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
  12814. (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
  12815. (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
  12816. (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
  12817. (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  12818. (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
  12819. (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
  12820. (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
  12821. (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
  12822. (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
  12823. (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
  12824. (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
  12825. (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
  12826. (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
  12827. (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
  12828. (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
  12829. (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
  12830. (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
  12831. (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
  12832. (define-key org-mode-map "\C-c\C-x!" 'org-reload)
  12833. (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
  12834. (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
  12835. (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
  12836. (when (featurep 'xemacs)
  12837. (org-defkey org-mode-map 'button3 'popup-mode-menu))
  12838. (defvar org-self-insert-command-undo-counter 0)
  12839. (defvar org-table-auto-blank-field) ; defined in org-table.el
  12840. (defun org-self-insert-command (N)
  12841. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  12842. If the cursor is in a table looking at whitespace, the whitespace is
  12843. overwritten, and the table is not marked as requiring realignment."
  12844. (interactive "p")
  12845. (if (and
  12846. (org-table-p)
  12847. (progn
  12848. ;; check if we blank the field, and if that triggers align
  12849. (and (featurep 'org-table) org-table-auto-blank-field
  12850. (member last-command
  12851. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
  12852. (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
  12853. ;; got extra space, this field does not determine column width
  12854. (let (org-table-may-need-update) (org-table-blank-field))
  12855. ;; no extra space, this field may determine column width
  12856. (org-table-blank-field)))
  12857. t)
  12858. (eq N 1)
  12859. (looking-at "[^|\n]* |"))
  12860. (let (org-table-may-need-update)
  12861. (goto-char (1- (match-end 0)))
  12862. (delete-backward-char 1)
  12863. (goto-char (match-beginning 0))
  12864. (self-insert-command N))
  12865. (setq org-table-may-need-update t)
  12866. (self-insert-command N)
  12867. (org-fix-tags-on-the-fly)
  12868. (if org-self-insert-cluster-for-undo
  12869. (if (not (eq last-command 'org-self-insert-command))
  12870. (setq org-self-insert-command-undo-counter 1)
  12871. (if (>= org-self-insert-command-undo-counter 20)
  12872. (setq org-self-insert-command-undo-counter 1)
  12873. (and (> org-self-insert-command-undo-counter 0)
  12874. buffer-undo-list
  12875. (not (cadr buffer-undo-list)) ; remove nil entry
  12876. (setcdr buffer-undo-list (cddr buffer-undo-list)))
  12877. (setq org-self-insert-command-undo-counter
  12878. (1+ org-self-insert-command-undo-counter)))))))
  12879. (defun org-fix-tags-on-the-fly ()
  12880. (when (and (equal (char-after (point-at-bol)) ?*)
  12881. (org-on-heading-p))
  12882. (org-align-tags-here org-tags-column)))
  12883. (defun org-delete-backward-char (N)
  12884. "Like `delete-backward-char', insert whitespace at field end in tables.
  12885. When deleting backwards, in tables this function will insert whitespace in
  12886. front of the next \"|\" separator, to keep the table aligned. The table will
  12887. still be marked for re-alignment if the field did fill the entire column,
  12888. because, in this case the deletion might narrow the column."
  12889. (interactive "p")
  12890. (if (and (org-table-p)
  12891. (eq N 1)
  12892. (string-match "|" (buffer-substring (point-at-bol) (point)))
  12893. (looking-at ".*?|"))
  12894. (let ((pos (point))
  12895. (noalign (looking-at "[^|\n\r]* |"))
  12896. (c org-table-may-need-update))
  12897. (backward-delete-char N)
  12898. (skip-chars-forward "^|")
  12899. (insert " ")
  12900. (goto-char (1- pos))
  12901. ;; noalign: if there were two spaces at the end, this field
  12902. ;; does not determine the width of the column.
  12903. (if noalign (setq org-table-may-need-update c)))
  12904. (backward-delete-char N)
  12905. (org-fix-tags-on-the-fly)))
  12906. (defun org-delete-char (N)
  12907. "Like `delete-char', but insert whitespace at field end in tables.
  12908. When deleting characters, in tables this function will insert whitespace in
  12909. front of the next \"|\" separator, to keep the table aligned. The table will
  12910. still be marked for re-alignment if the field did fill the entire column,
  12911. because, in this case the deletion might narrow the column."
  12912. (interactive "p")
  12913. (if (and (org-table-p)
  12914. (not (bolp))
  12915. (not (= (char-after) ?|))
  12916. (eq N 1))
  12917. (if (looking-at ".*?|")
  12918. (let ((pos (point))
  12919. (noalign (looking-at "[^|\n\r]* |"))
  12920. (c org-table-may-need-update))
  12921. (replace-match (concat
  12922. (substring (match-string 0) 1 -1)
  12923. " |"))
  12924. (goto-char pos)
  12925. ;; noalign: if there were two spaces at the end, this field
  12926. ;; does not determine the width of the column.
  12927. (if noalign (setq org-table-may-need-update c)))
  12928. (delete-char N))
  12929. (delete-char N)
  12930. (org-fix-tags-on-the-fly)))
  12931. ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
  12932. (put 'org-self-insert-command 'delete-selection t)
  12933. (put 'orgtbl-self-insert-command 'delete-selection t)
  12934. (put 'org-delete-char 'delete-selection 'supersede)
  12935. (put 'org-delete-backward-char 'delete-selection 'supersede)
  12936. (put 'org-yank 'delete-selection 'yank)
  12937. ;; Make `flyspell-mode' delay after some commands
  12938. (put 'org-self-insert-command 'flyspell-delayed t)
  12939. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  12940. (put 'org-delete-char 'flyspell-delayed t)
  12941. (put 'org-delete-backward-char 'flyspell-delayed t)
  12942. ;; Make pabbrev-mode expand after org-mode commands
  12943. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  12944. (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
  12945. ;; How to do this: Measure non-white length of current string
  12946. ;; If equal to column width, we should realign.
  12947. (defun org-remap (map &rest commands)
  12948. "In MAP, remap the functions given in COMMANDS.
  12949. COMMANDS is a list of alternating OLDDEF NEWDEF command names."
  12950. (let (new old)
  12951. (while commands
  12952. (setq old (pop commands) new (pop commands))
  12953. (if (fboundp 'command-remapping)
  12954. (org-defkey map (vector 'remap old) new)
  12955. (substitute-key-definition old new map global-map)))))
  12956. (when (eq org-enable-table-editor 'optimized)
  12957. ;; If the user wants maximum table support, we need to hijack
  12958. ;; some standard editing functions
  12959. (org-remap org-mode-map
  12960. 'self-insert-command 'org-self-insert-command
  12961. 'delete-char 'org-delete-char
  12962. 'delete-backward-char 'org-delete-backward-char)
  12963. (org-defkey org-mode-map "|" 'org-force-self-insert))
  12964. (defvar org-ctrl-c-ctrl-c-hook nil
  12965. "Hook for functions attaching themselves to `C-c C-c'.
  12966. This can be used to add additional functionality to the C-c C-c key which
  12967. executes context-dependent commands.
  12968. Each function will be called with no arguments. The function must check
  12969. if the context is appropriate for it to act. If yes, it should do its
  12970. thing and then return a non-nil value. If the context is wrong,
  12971. just do nothing and return nil.")
  12972. (defvar org-tab-first-hook nil
  12973. "Hook for functions to attach themselves to TAB.
  12974. See `org-ctrl-c-ctrl-c-hook' for more information.
  12975. This hook runs as the first action when TAB is pressed, even before
  12976. `org-cycle' messes around with the `outline-regexp' to cater for
  12977. inline tasks and plain list item folding.
  12978. If any function in this hook returns t, not other actions like table
  12979. field motion visibility cycling will be done.")
  12980. (defvar org-tab-after-check-for-table-hook nil
  12981. "Hook for functions to attach themselves to TAB.
  12982. See `org-ctrl-c-ctrl-c-hook' for more information.
  12983. This hook runs after it has been established that the cursor is not in a
  12984. table, but before checking if the cursor is in a headline or if global cycling
  12985. should be done.
  12986. If any function in this hook returns t, not other actions like visibility
  12987. cycling will be done.")
  12988. (defvar org-tab-after-check-for-cycling-hook nil
  12989. "Hook for functions to attach themselves to TAB.
  12990. See `org-ctrl-c-ctrl-c-hook' for more information.
  12991. This hook runs after it has been established that not table field motion and
  12992. not visibility should be done because of current context. This is probably
  12993. the place where a package like yasnippets can hook in.")
  12994. (defvar org-metaleft-hook nil
  12995. "Hook for functions attaching themselves to `M-left'.
  12996. See `org-ctrl-c-ctrl-c-hook' for more information.")
  12997. (defvar org-metaright-hook nil
  12998. "Hook for functions attaching themselves to `M-right'.
  12999. See `org-ctrl-c-ctrl-c-hook' for more information.")
  13000. (defvar org-metaup-hook nil
  13001. "Hook for functions attaching themselves to `M-up'.
  13002. See `org-ctrl-c-ctrl-c-hook' for more information.")
  13003. (defvar org-metadown-hook nil
  13004. "Hook for functions attaching themselves to `M-down'.
  13005. See `org-ctrl-c-ctrl-c-hook' for more information.")
  13006. (defvar org-shiftmetaleft-hook nil
  13007. "Hook for functions attaching themselves to `M-S-left'.
  13008. See `org-ctrl-c-ctrl-c-hook' for more information.")
  13009. (defvar org-shiftmetaright-hook nil
  13010. "Hook for functions attaching themselves to `M-S-right'.
  13011. See `org-ctrl-c-ctrl-c-hook' for more information.")
  13012. (defvar org-shiftmetaup-hook nil
  13013. "Hook for functions attaching themselves to `M-S-up'.
  13014. See `org-ctrl-c-ctrl-c-hook' for more information.")
  13015. (defvar org-shiftmetadown-hook nil
  13016. "Hook for functions attaching themselves to `M-S-down'.
  13017. See `org-ctrl-c-ctrl-c-hook' for more information.")
  13018. (defvar org-metareturn-hook nil
  13019. "Hook for functions attaching themselves to `M-RET'.
  13020. See `org-ctrl-c-ctrl-c-hook' for more information.")
  13021. (defun org-modifier-cursor-error ()
  13022. "Throw an error, a modified cursor command was applied in wrong context."
  13023. (error "This command is active in special context like tables, headlines or items"))
  13024. (defun org-shiftselect-error ()
  13025. "Throw an error because Shift-Cursor command was applied in wrong context."
  13026. (if (and (boundp 'shift-select-mode) shift-select-mode)
  13027. (error "To use shift-selection with Org-mode, customize `org-support-shift-select'.")
  13028. (error "This command works only in special context like headlines or timestamps.")))
  13029. (defun org-call-for-shift-select (cmd)
  13030. (let ((this-command-keys-shift-translated t))
  13031. (call-interactively cmd)))
  13032. (defun org-shifttab (&optional arg)
  13033. "Global visibility cycling or move to previous table field.
  13034. Calls `org-cycle' with argument t, or `org-table-previous-field', depending
  13035. on context.
  13036. See the individual commands for more information."
  13037. (interactive "P")
  13038. (cond
  13039. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  13040. ((integerp arg)
  13041. (message "Content view to level: %d" arg)
  13042. (org-content (prefix-numeric-value arg))
  13043. (setq org-cycle-global-status 'overview))
  13044. (t (call-interactively 'org-global-cycle))))
  13045. (defun org-shiftmetaleft ()
  13046. "Promote subtree or delete table column.
  13047. Calls `org-promote-subtree', `org-outdent-item',
  13048. or `org-table-delete-column', depending on context.
  13049. See the individual commands for more information."
  13050. (interactive)
  13051. (cond
  13052. ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
  13053. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  13054. ((org-on-heading-p) (call-interactively 'org-promote-subtree))
  13055. ((org-at-item-p) (call-interactively 'org-outdent-item))
  13056. (t (org-modifier-cursor-error))))
  13057. (defun org-shiftmetaright ()
  13058. "Demote subtree or insert table column.
  13059. Calls `org-demote-subtree', `org-indent-item',
  13060. or `org-table-insert-column', depending on context.
  13061. See the individual commands for more information."
  13062. (interactive)
  13063. (cond
  13064. ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
  13065. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  13066. ((org-on-heading-p) (call-interactively 'org-demote-subtree))
  13067. ((org-at-item-p) (call-interactively 'org-indent-item))
  13068. (t (org-modifier-cursor-error))))
  13069. (defun org-shiftmetaup (&optional arg)
  13070. "Move subtree up or kill table row.
  13071. Calls `org-move-subtree-up' or `org-table-kill-row' or
  13072. `org-move-item-up' depending on context. See the individual commands
  13073. for more information."
  13074. (interactive "P")
  13075. (cond
  13076. ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
  13077. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  13078. ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
  13079. ((org-at-item-p) (call-interactively 'org-move-item-up))
  13080. (t (org-modifier-cursor-error))))
  13081. (defun org-shiftmetadown (&optional arg)
  13082. "Move subtree down or insert table row.
  13083. Calls `org-move-subtree-down' or `org-table-insert-row' or
  13084. `org-move-item-down', depending on context. See the individual
  13085. commands for more information."
  13086. (interactive "P")
  13087. (cond
  13088. ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
  13089. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  13090. ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
  13091. ((org-at-item-p) (call-interactively 'org-move-item-down))
  13092. (t (org-modifier-cursor-error))))
  13093. (defun org-metaleft (&optional arg)
  13094. "Promote heading or move table column to left.
  13095. Calls `org-do-promote' or `org-table-move-column', depending on context.
  13096. With no specific context, calls the Emacs default `backward-word'.
  13097. See the individual commands for more information."
  13098. (interactive "P")
  13099. (cond
  13100. ((run-hook-with-args-until-success 'org-metaleft-hook))
  13101. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  13102. ((or (org-on-heading-p)
  13103. (and (org-region-active-p)
  13104. (save-excursion
  13105. (goto-char (region-beginning))
  13106. (org-on-heading-p))))
  13107. (call-interactively 'org-do-promote))
  13108. ((or (org-at-item-p)
  13109. (and (org-region-active-p)
  13110. (save-excursion
  13111. (goto-char (region-beginning))
  13112. (org-at-item-p))))
  13113. (call-interactively 'org-outdent-item))
  13114. (t (call-interactively 'backward-word))))
  13115. (defun org-metaright (&optional arg)
  13116. "Demote subtree or move table column to right.
  13117. Calls `org-do-demote' or `org-table-move-column', depending on context.
  13118. With no specific context, calls the Emacs default `forward-word'.
  13119. See the individual commands for more information."
  13120. (interactive "P")
  13121. (cond
  13122. ((run-hook-with-args-until-success 'org-metaright-hook))
  13123. ((org-at-table-p) (call-interactively 'org-table-move-column))
  13124. ((or (org-on-heading-p)
  13125. (and (org-region-active-p)
  13126. (save-excursion
  13127. (goto-char (region-beginning))
  13128. (org-on-heading-p))))
  13129. (call-interactively 'org-do-demote))
  13130. ((or (org-at-item-p)
  13131. (and (org-region-active-p)
  13132. (save-excursion
  13133. (goto-char (region-beginning))
  13134. (org-at-item-p))))
  13135. (call-interactively 'org-indent-item))
  13136. (t (call-interactively 'forward-word))))
  13137. (defun org-metaup (&optional arg)
  13138. "Move subtree up or move table row up.
  13139. Calls `org-move-subtree-up' or `org-table-move-row' or
  13140. `org-move-item-up', depending on context. See the individual commands
  13141. for more information."
  13142. (interactive "P")
  13143. (cond
  13144. ((run-hook-with-args-until-success 'org-metaup-hook))
  13145. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  13146. ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
  13147. ((org-at-item-p) (call-interactively 'org-move-item-up))
  13148. (t (transpose-lines 1) (beginning-of-line -1))))
  13149. (defun org-metadown (&optional arg)
  13150. "Move subtree down or move table row down.
  13151. Calls `org-move-subtree-down' or `org-table-move-row' or
  13152. `org-move-item-down', depending on context. See the individual
  13153. commands for more information."
  13154. (interactive "P")
  13155. (cond
  13156. ((run-hook-with-args-until-success 'org-metadown-hook))
  13157. ((org-at-table-p) (call-interactively 'org-table-move-row))
  13158. ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
  13159. ((org-at-item-p) (call-interactively 'org-move-item-down))
  13160. (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
  13161. (defun org-shiftup (&optional arg)
  13162. "Increase item in timestamp or increase priority of current headline.
  13163. Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
  13164. depending on context. See the individual commands for more information."
  13165. (interactive "P")
  13166. (cond
  13167. ((and org-support-shift-select (org-region-active-p))
  13168. (org-call-for-shift-select 'previous-line))
  13169. ((org-at-timestamp-p t)
  13170. (call-interactively (if org-edit-timestamp-down-means-later
  13171. 'org-timestamp-down 'org-timestamp-up)))
  13172. ((and (not (eq org-support-shift-select 'always))
  13173. (org-on-heading-p))
  13174. (call-interactively 'org-priority-up))
  13175. ((and (not org-support-shift-select) (org-at-item-p))
  13176. (call-interactively 'org-previous-item))
  13177. ((org-clocktable-try-shift 'up arg))
  13178. (org-support-shift-select
  13179. (org-call-for-shift-select 'previous-line))
  13180. (t (org-shiftselect-error))))
  13181. (defun org-shiftdown (&optional arg)
  13182. "Decrease item in timestamp or decrease priority of current headline.
  13183. Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
  13184. depending on context. See the individual commands for more information."
  13185. (interactive "P")
  13186. (cond
  13187. ((and org-support-shift-select (org-region-active-p))
  13188. (org-call-for-shift-select 'next-line))
  13189. ((org-at-timestamp-p t)
  13190. (call-interactively (if org-edit-timestamp-down-means-later
  13191. 'org-timestamp-up 'org-timestamp-down)))
  13192. ((and (not (eq org-support-shift-select 'always))
  13193. (org-on-heading-p))
  13194. (call-interactively 'org-priority-down))
  13195. ((and (not org-support-shift-select) (org-at-item-p))
  13196. (call-interactively 'org-next-item))
  13197. ((org-clocktable-try-shift 'down arg))
  13198. (org-support-shift-select
  13199. (org-call-for-shift-select 'next-line))
  13200. (t (org-shiftselect-error))))
  13201. (defun org-shiftright (&optional arg)
  13202. "Cycle the thing at point or in the current line, depending on context.
  13203. Depending on context, this does one of the following:
  13204. - switch a timestamp at point one day into the future
  13205. - on a headline, switch to the next TODO keyword.
  13206. - on an item, switch entire list to the next bullet type
  13207. - on a property line, switch to the next allowed value
  13208. - on a clocktable definition line, move time block into the future"
  13209. (interactive "P")
  13210. (cond
  13211. ((and org-support-shift-select (org-region-active-p))
  13212. (org-call-for-shift-select 'forward-char))
  13213. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
  13214. ((and (not (eq org-support-shift-select 'always))
  13215. (org-on-heading-p))
  13216. (org-call-with-arg 'org-todo 'right))
  13217. ((or (and org-support-shift-select
  13218. (not (eq org-support-shift-select 'always))
  13219. (org-at-item-bullet-p))
  13220. (and (not org-support-shift-select) (org-at-item-p)))
  13221. (org-call-with-arg 'org-cycle-list-bullet nil))
  13222. ((and (not (eq org-support-shift-select 'always))
  13223. (org-at-property-p))
  13224. (call-interactively 'org-property-next-allowed-value))
  13225. ((org-clocktable-try-shift 'right arg))
  13226. (org-support-shift-select
  13227. (org-call-for-shift-select 'forward-char))
  13228. (t (org-shiftselect-error))))
  13229. (defun org-shiftleft (&optional arg)
  13230. "Cycle the thing at point or in the current line, depending on context.
  13231. Depending on context, this does one of the following:
  13232. - switch a timestamp at point one day into the past
  13233. - on a headline, switch to the previous TODO keyword.
  13234. - on an item, switch entire list to the previous bullet type
  13235. - on a property line, switch to the previous allowed value
  13236. - on a clocktable definition line, move time block into the past"
  13237. (interactive "P")
  13238. (cond
  13239. ((and org-support-shift-select (org-region-active-p))
  13240. (org-call-for-shift-select 'backward-char))
  13241. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
  13242. ((and (not (eq org-support-shift-select 'always))
  13243. (org-on-heading-p))
  13244. (org-call-with-arg 'org-todo 'left))
  13245. ((or (and org-support-shift-select
  13246. (not (eq org-support-shift-select 'always))
  13247. (org-at-item-bullet-p))
  13248. (and (not org-support-shift-select) (org-at-item-p)))
  13249. (org-call-with-arg 'org-cycle-list-bullet 'previous))
  13250. ((and (not (eq org-support-shift-select 'always))
  13251. (org-at-property-p))
  13252. (call-interactively 'org-property-previous-allowed-value))
  13253. ((org-clocktable-try-shift 'left arg))
  13254. (org-support-shift-select
  13255. (org-call-for-shift-select 'backward-char))
  13256. (t (org-shiftselect-error))))
  13257. (defun org-shiftcontrolright ()
  13258. "Switch to next TODO set."
  13259. (interactive)
  13260. (cond
  13261. ((and org-support-shift-select (org-region-active-p))
  13262. (org-call-for-shift-select 'forward-word))
  13263. ((and (not (eq org-support-shift-select 'always))
  13264. (org-on-heading-p))
  13265. (org-call-with-arg 'org-todo 'nextset))
  13266. (org-support-shift-select
  13267. (org-call-for-shift-select 'forward-word))
  13268. (t (org-shiftselect-error))))
  13269. (defun org-shiftcontrolleft ()
  13270. "Switch to previous TODO set."
  13271. (interactive)
  13272. (cond
  13273. ((and org-support-shift-select (org-region-active-p))
  13274. (org-call-for-shift-select 'backward-word))
  13275. ((and (not (eq org-support-shift-select 'always))
  13276. (org-on-heading-p))
  13277. (org-call-with-arg 'org-todo 'previousset))
  13278. (org-support-shift-select
  13279. (org-call-for-shift-select 'backward-word))
  13280. (t (org-shiftselect-error))))
  13281. (defun org-ctrl-c-ret ()
  13282. "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
  13283. (interactive)
  13284. (cond
  13285. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  13286. (t (call-interactively 'org-insert-heading))))
  13287. (defun org-copy-special ()
  13288. "Copy region in table or copy current subtree.
  13289. Calls `org-table-copy' or `org-copy-subtree', depending on context.
  13290. See the individual commands for more information."
  13291. (interactive)
  13292. (call-interactively
  13293. (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
  13294. (defun org-cut-special ()
  13295. "Cut region in table or cut current subtree.
  13296. Calls `org-table-copy' or `org-cut-subtree', depending on context.
  13297. See the individual commands for more information."
  13298. (interactive)
  13299. (call-interactively
  13300. (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
  13301. (defun org-paste-special (arg)
  13302. "Paste rectangular region into table, or past subtree relative to level.
  13303. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  13304. See the individual commands for more information."
  13305. (interactive "P")
  13306. (if (org-at-table-p)
  13307. (org-table-paste-rectangle)
  13308. (org-paste-subtree arg)))
  13309. (defun org-edit-special ()
  13310. "Call a special editor for the stuff at point.
  13311. When at a table, call the formula editor with `org-table-edit-formulas'.
  13312. When at the first line of an src example, call `org-edit-src-code'.
  13313. When in an #+include line, visit the include file. Otherwise call
  13314. `ffap' to visit the file at point."
  13315. (interactive)
  13316. (cond
  13317. ((org-at-table-p)
  13318. (call-interactively 'org-table-edit-formulas))
  13319. ((save-excursion
  13320. (beginning-of-line 1)
  13321. (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
  13322. (find-file (org-trim (match-string 1))))
  13323. ((org-edit-src-code))
  13324. ((org-edit-fixed-width-region))
  13325. (t (call-interactively 'ffap))))
  13326. (defun org-ctrl-c-ctrl-c (&optional arg)
  13327. "Set tags in headline, or update according to changed information at point.
  13328. This command does many different things, depending on context:
  13329. - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
  13330. this is what we do.
  13331. - If the cursor is in a headline, prompt for tags and insert them
  13332. into the current line, aligned to `org-tags-column'. When called
  13333. with prefix arg, realign all tags in the current buffer.
  13334. - If the cursor is in one of the special #+KEYWORD lines, this
  13335. triggers scanning the buffer for these lines and updating the
  13336. information.
  13337. - If the cursor is inside a table, realign the table. This command
  13338. works even if the automatic table editor has been turned off.
  13339. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  13340. the entire table.
  13341. - If the cursor is at a footnote reference or definition, jump to
  13342. the corresponding definition or references, respectively.
  13343. - If the cursor is a the beginning of a dynamic block, update it.
  13344. - If the cursor is inside a table created by the table.el package,
  13345. activate that table.
  13346. - If the current buffer is a remember buffer, close note and file
  13347. it. A prefix argument of 1 files to the default location
  13348. without further interaction. A prefix argument of 2 files to
  13349. the currently clocking task.
  13350. - If the cursor is on a <<<target>>>, update radio targets and corresponding
  13351. links in this buffer.
  13352. - If the cursor is on a numbered item in a plain list, renumber the
  13353. ordered list.
  13354. - If the cursor is on a checkbox, toggle it."
  13355. (interactive "P")
  13356. (let ((org-enable-table-editor t))
  13357. (cond
  13358. ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
  13359. org-occur-highlights
  13360. org-latex-fragment-image-overlays)
  13361. (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
  13362. (org-remove-occur-highlights)
  13363. (org-remove-latex-fragment-image-overlays)
  13364. (message "Temporary highlights/overlays removed from current buffer"))
  13365. ((and (local-variable-p 'org-finish-function (current-buffer))
  13366. (fboundp org-finish-function))
  13367. (funcall org-finish-function))
  13368. ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
  13369. ((org-at-property-p)
  13370. (call-interactively 'org-property-action))
  13371. ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
  13372. ((org-on-heading-p) (call-interactively 'org-set-tags))
  13373. ((org-at-table.el-p)
  13374. (require 'table)
  13375. (beginning-of-line 1)
  13376. (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
  13377. (call-interactively 'table-recognize-table))
  13378. ((org-at-table-p)
  13379. (org-table-maybe-eval-formula)
  13380. (if arg
  13381. (call-interactively 'org-table-recalculate)
  13382. (org-table-maybe-recalculate-line))
  13383. (call-interactively 'org-table-align))
  13384. ((or (org-footnote-at-reference-p)
  13385. (org-footnote-at-definition-p))
  13386. (call-interactively 'org-footnote-action))
  13387. ((org-at-item-checkbox-p)
  13388. (call-interactively 'org-toggle-checkbox))
  13389. ((org-at-item-p)
  13390. (if arg
  13391. (call-interactively 'org-toggle-checkbox)
  13392. (call-interactively 'org-maybe-renumber-ordered-list)))
  13393. ((save-excursion (beginning-of-line 1) (looking-at "#\\+BEGIN:"))
  13394. ;; Dynamic block
  13395. (beginning-of-line 1)
  13396. (save-excursion (org-update-dblock)))
  13397. ((save-excursion (beginning-of-line 1) (looking-at "#\\+\\([A-Z]+\\)"))
  13398. (cond
  13399. ((equal (match-string 1) "TBLFM")
  13400. ;; Recalculate the table before this line
  13401. (save-excursion
  13402. (beginning-of-line 1)
  13403. (skip-chars-backward " \r\n\t")
  13404. (if (org-at-table-p)
  13405. (org-call-with-arg 'org-table-recalculate t))))
  13406. (t
  13407. ; (org-set-regexps-and-options)
  13408. ; (org-restart-font-lock)
  13409. (let ((org-inhibit-startup t)) (org-mode-restart))
  13410. (message "Local setup has been refreshed"))))
  13411. (t (error "C-c C-c can do nothing useful at this location.")))))
  13412. (defun org-mode-restart ()
  13413. "Restart Org-mode, to scan again for special lines.
  13414. Also updates the keyword regular expressions."
  13415. (interactive)
  13416. (org-mode)
  13417. (message "Org-mode restarted"))
  13418. (defun org-kill-note-or-show-branches ()
  13419. "If this is a Note buffer, abort storing the note. Else call `show-branches'."
  13420. (interactive)
  13421. (if (not org-finish-function)
  13422. (call-interactively 'show-branches)
  13423. (let ((org-note-abort t))
  13424. (funcall org-finish-function))))
  13425. (defun org-return (&optional indent)
  13426. "Goto next table row or insert a newline.
  13427. Calls `org-table-next-row' or `newline', depending on context.
  13428. See the individual commands for more information."
  13429. (interactive)
  13430. (cond
  13431. ((bobp) (if indent (newline-and-indent) (newline)))
  13432. ((org-at-table-p)
  13433. (org-table-justify-field-maybe)
  13434. (call-interactively 'org-table-next-row))
  13435. ((and org-return-follows-link
  13436. (eq (get-text-property (point) 'face) 'org-link))
  13437. (call-interactively 'org-open-at-point))
  13438. ((and (org-at-heading-p)
  13439. (looking-at
  13440. (org-re "\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)[ \t]*$")))
  13441. (org-show-entry)
  13442. (end-of-line 1)
  13443. (newline))
  13444. (t (if indent (newline-and-indent) (newline)))))
  13445. (defun org-return-indent ()
  13446. "Goto next table row or insert a newline and indent.
  13447. Calls `org-table-next-row' or `newline-and-indent', depending on
  13448. context. See the individual commands for more information."
  13449. (interactive)
  13450. (org-return t))
  13451. (defun org-ctrl-c-star ()
  13452. "Compute table, or change heading status of lines.
  13453. Calls `org-table-recalculate' or `org-toggle-heading',
  13454. depending on context."
  13455. (interactive)
  13456. (cond
  13457. ((org-at-table-p)
  13458. (call-interactively 'org-table-recalculate))
  13459. (t
  13460. ;; Convert all lines in region to list items
  13461. (call-interactively 'org-toggle-heading))))
  13462. (defun org-ctrl-c-minus ()
  13463. "Insert separator line in table or modify bullet status of line.
  13464. Also turns a plain line or a region of lines into list items.
  13465. Calls `org-table-insert-hline', `org-toggle-item', or
  13466. `org-cycle-list-bullet', depending on context."
  13467. (interactive)
  13468. (cond
  13469. ((org-at-table-p)
  13470. (call-interactively 'org-table-insert-hline))
  13471. ((org-region-active-p)
  13472. (call-interactively 'org-toggle-item))
  13473. ((org-in-item-p)
  13474. (call-interactively 'org-cycle-list-bullet))
  13475. (t
  13476. (call-interactively 'org-toggle-item))))
  13477. (defun org-toggle-item ()
  13478. "Convert headings or normal lines to items, items to normal lines.
  13479. If there is no active region, only the current line is considered.
  13480. If the first line in the region is a headline, convert all headlines to items.
  13481. If the first line in the region is an item, convert all items to normal lines.
  13482. If the first line is normal text, add an item bullet to each line."
  13483. (interactive)
  13484. (let (l2 l beg end)
  13485. (if (org-region-active-p)
  13486. (setq beg (region-beginning) end (region-end))
  13487. (setq beg (point-at-bol)
  13488. end (min (1+ (point-at-eol)) (point-max))))
  13489. (save-excursion
  13490. (goto-char end)
  13491. (setq l2 (org-current-line))
  13492. (goto-char beg)
  13493. (beginning-of-line 1)
  13494. (setq l (1- (org-current-line)))
  13495. (if (org-at-item-p)
  13496. ;; We already have items, de-itemize
  13497. (while (< (setq l (1+ l)) l2)
  13498. (when (org-at-item-p)
  13499. (goto-char (match-beginning 2))
  13500. (delete-region (match-beginning 2) (match-end 2))
  13501. (and (looking-at "[ \t]+") (replace-match "")))
  13502. (beginning-of-line 2))
  13503. (if (org-on-heading-p)
  13504. ;; Headings, convert to items
  13505. (while (< (setq l (1+ l)) l2)
  13506. (if (looking-at org-outline-regexp)
  13507. (replace-match "- " t t))
  13508. (beginning-of-line 2))
  13509. ;; normal lines, turn them into items
  13510. (while (< (setq l (1+ l)) l2)
  13511. (unless (org-at-item-p)
  13512. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  13513. (replace-match "\\1- \\2")))
  13514. (beginning-of-line 2)))))))
  13515. (defun org-toggle-heading (&optional nstars)
  13516. "Convert headings to normal text, or items or text to headings.
  13517. If there is no active region, only the current line is considered.
  13518. If the first line is a heading, remove the stars from all headlines
  13519. in the region.
  13520. If the first line is a plain list item, turn all plain list items into
  13521. headings.
  13522. If the first line is a normal line, turn each and every line in the region
  13523. into a heading.
  13524. When converting a line into a heading, the number of stars is chosen
  13525. such that the lines become children of the current entry. However, when
  13526. a prefix argument is given, its value determines the number of stars to add."
  13527. (interactive "P")
  13528. (let (l2 l itemp beg end)
  13529. (if (org-region-active-p)
  13530. (setq beg (region-beginning) end (region-end))
  13531. (setq beg (point-at-bol)
  13532. end (min (1+ (point-at-eol)) (point-max))))
  13533. (save-excursion
  13534. (goto-char end)
  13535. (setq l2 (org-current-line))
  13536. (goto-char beg)
  13537. (beginning-of-line 1)
  13538. (setq l (1- (org-current-line)))
  13539. (if (org-on-heading-p)
  13540. ;; We already have headlines, de-star them
  13541. (while (< (setq l (1+ l)) l2)
  13542. (when (org-on-heading-p t)
  13543. (and (looking-at outline-regexp) (replace-match "")))
  13544. (beginning-of-line 2))
  13545. (setq itemp (org-at-item-p))
  13546. (let* ((stars
  13547. (if nstars
  13548. (make-string (prefix-numeric-value current-prefix-arg)
  13549. ?*)
  13550. (save-excursion
  13551. (re-search-backward org-complex-heading-regexp nil t)
  13552. (or (match-string 1) ""))))
  13553. (add-stars (cond (nstars "")
  13554. ((equal stars "") "*")
  13555. (org-odd-levels-only "**")
  13556. (t "*")))
  13557. (rpl (concat stars add-stars " ")))
  13558. (while (< (setq l (1+ l)) l2)
  13559. (if itemp
  13560. (and (org-at-item-p) (replace-match rpl t t))
  13561. (unless (org-on-heading-p)
  13562. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  13563. (replace-match (concat rpl (match-string 2))))))
  13564. (beginning-of-line 2)))))))
  13565. (defun org-meta-return (&optional arg)
  13566. "Insert a new heading or wrap a region in a table.
  13567. Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
  13568. See the individual commands for more information."
  13569. (interactive "P")
  13570. (cond
  13571. ((run-hook-with-args-until-success 'org-metareturn-hook))
  13572. ((org-at-table-p)
  13573. (call-interactively 'org-table-wrap-region))
  13574. (t (call-interactively 'org-insert-heading))))
  13575. ;;; Menu entries
  13576. ;; Define the Org-mode menus
  13577. (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
  13578. '("Tbl"
  13579. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  13580. ["Next Field" org-cycle (org-at-table-p)]
  13581. ["Previous Field" org-shifttab (org-at-table-p)]
  13582. ["Next Row" org-return (org-at-table-p)]
  13583. "--"
  13584. ["Blank Field" org-table-blank-field (org-at-table-p)]
  13585. ["Edit Field" org-table-edit-field (org-at-table-p)]
  13586. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  13587. "--"
  13588. ("Column"
  13589. ["Move Column Left" org-metaleft (org-at-table-p)]
  13590. ["Move Column Right" org-metaright (org-at-table-p)]
  13591. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  13592. ["Insert Column" org-shiftmetaright (org-at-table-p)])
  13593. ("Row"
  13594. ["Move Row Up" org-metaup (org-at-table-p)]
  13595. ["Move Row Down" org-metadown (org-at-table-p)]
  13596. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  13597. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  13598. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  13599. "--"
  13600. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  13601. ("Rectangle"
  13602. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  13603. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  13604. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  13605. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  13606. "--"
  13607. ("Calculate"
  13608. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  13609. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  13610. ["Edit Formulas" org-edit-special (org-at-table-p)]
  13611. "--"
  13612. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  13613. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  13614. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  13615. "--"
  13616. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  13617. "--"
  13618. ["Sum Column/Rectangle" org-table-sum
  13619. (or (org-at-table-p) (org-region-active-p))]
  13620. ["Which Column?" org-table-current-column (org-at-table-p)])
  13621. ["Debug Formulas"
  13622. org-table-toggle-formula-debugger
  13623. :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
  13624. ["Show Col/Row Numbers"
  13625. org-table-toggle-coordinate-overlays
  13626. :style toggle
  13627. :selected (org-bound-and-true-p org-table-overlay-coordinates)]
  13628. "--"
  13629. ["Create" org-table-create (and (not (org-at-table-p))
  13630. org-enable-table-editor)]
  13631. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  13632. ["Import from File" org-table-import (not (org-at-table-p))]
  13633. ["Export to File" org-table-export (org-at-table-p)]
  13634. "--"
  13635. ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
  13636. (easy-menu-define org-org-menu org-mode-map "Org menu"
  13637. '("Org"
  13638. ("Show/Hide"
  13639. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  13640. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  13641. ["Sparse Tree..." org-sparse-tree t]
  13642. ["Reveal Context" org-reveal t]
  13643. ["Show All" show-all t]
  13644. "--"
  13645. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  13646. "--"
  13647. ["New Heading" org-insert-heading t]
  13648. ("Navigate Headings"
  13649. ["Up" outline-up-heading t]
  13650. ["Next" outline-next-visible-heading t]
  13651. ["Previous" outline-previous-visible-heading t]
  13652. ["Next Same Level" outline-forward-same-level t]
  13653. ["Previous Same Level" outline-backward-same-level t]
  13654. "--"
  13655. ["Jump" org-goto t])
  13656. ("Edit Structure"
  13657. ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
  13658. ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
  13659. "--"
  13660. ["Copy Subtree" org-copy-special (not (org-at-table-p))]
  13661. ["Cut Subtree" org-cut-special (not (org-at-table-p))]
  13662. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  13663. "--"
  13664. ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
  13665. "--"
  13666. ["Promote Heading" org-metaleft (not (org-at-table-p))]
  13667. ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
  13668. ["Demote Heading" org-metaright (not (org-at-table-p))]
  13669. ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
  13670. "--"
  13671. ["Sort Region/Children" org-sort (not (org-at-table-p))]
  13672. "--"
  13673. ["Convert to odd levels" org-convert-to-odd-levels t]
  13674. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  13675. ("Editing"
  13676. ["Emphasis..." org-emphasize t]
  13677. ["Edit Source Example" org-edit-special t]
  13678. "--"
  13679. ["Footnote new/jump" org-footnote-action t]
  13680. ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
  13681. ("Archive"
  13682. ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
  13683. ; ["Check and Tag Children" (org-toggle-archive-tag (4))
  13684. ; :active t :keys "C-u C-c C-x C-a"]
  13685. ["Sparse trees open ARCHIVE trees"
  13686. (setq org-sparse-tree-open-archived-trees
  13687. (not org-sparse-tree-open-archived-trees))
  13688. :style toggle :selected org-sparse-tree-open-archived-trees]
  13689. ["Cycling opens ARCHIVE trees"
  13690. (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
  13691. :style toggle :selected org-cycle-open-archived-trees]
  13692. "--"
  13693. ["Move subtree to archive sibling" org-archive-to-archive-sibling t]
  13694. ["Move Subtree to Archive" org-advertized-archive-subtree t]
  13695. ; ["Check and Move Children" (org-archive-subtree '(4))
  13696. ; :active t :keys "C-u C-c C-x C-s"]
  13697. )
  13698. "--"
  13699. ("Hyperlinks"
  13700. ["Store Link (Global)" org-store-link t]
  13701. ["Insert Link" org-insert-link t]
  13702. ["Follow Link" org-open-at-point t]
  13703. "--"
  13704. ["Next link" org-next-link t]
  13705. ["Previous link" org-previous-link t]
  13706. "--"
  13707. ["Descriptive Links"
  13708. (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
  13709. :style radio
  13710. :selected (member '(org-link) buffer-invisibility-spec)]
  13711. ["Literal Links"
  13712. (progn
  13713. (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
  13714. :style radio
  13715. :selected (not (member '(org-link) buffer-invisibility-spec))])
  13716. "--"
  13717. ("TODO Lists"
  13718. ["TODO/DONE/-" org-todo t]
  13719. ("Select keyword"
  13720. ["Next keyword" org-shiftright (org-on-heading-p)]
  13721. ["Previous keyword" org-shiftleft (org-on-heading-p)]
  13722. ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
  13723. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
  13724. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
  13725. ["Show TODO Tree" org-show-todo-tree t]
  13726. ["Global TODO list" org-todo-list t]
  13727. "--"
  13728. ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
  13729. :selected org-enforce-todo-dependencies :style toggle :active t]
  13730. "Settings for tree at point"
  13731. ["Do Children sequentially" org-toggle-ordered-property :style radio
  13732. :selected (ignore-errors (org-entry-get nil "ORDERED"))
  13733. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  13734. ["Do Children parallel" org-toggle-ordered-property :style radio
  13735. :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
  13736. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  13737. "--"
  13738. ["Set Priority" org-priority t]
  13739. ["Priority Up" org-shiftup t]
  13740. ["Priority Down" org-shiftdown t]
  13741. "--"
  13742. ["Get news from all feeds" org-feed-update-all t]
  13743. ["Go to the inbox of a feed..." org-feed-goto-inbox t]
  13744. ["Customize feeds" (customize-variable 'org-feed-alist) t])
  13745. ("TAGS and Properties"
  13746. ["Set Tags" org-set-tags-command t]
  13747. ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
  13748. "--"
  13749. ["Set property" org-set-property t]
  13750. ["Column view of properties" org-columns t]
  13751. ["Insert Column View DBlock" org-insert-columns-dblock t])
  13752. ("Dates and Scheduling"
  13753. ["Timestamp" org-time-stamp t]
  13754. ["Timestamp (inactive)" org-time-stamp-inactive t]
  13755. ("Change Date"
  13756. ["1 Day Later" org-shiftright t]
  13757. ["1 Day Earlier" org-shiftleft t]
  13758. ["1 ... Later" org-shiftup t]
  13759. ["1 ... Earlier" org-shiftdown t])
  13760. ["Compute Time Range" org-evaluate-time-range t]
  13761. ["Schedule Item" org-schedule t]
  13762. ["Deadline" org-deadline t]
  13763. "--"
  13764. ["Custom time format" org-toggle-time-stamp-overlays
  13765. :style radio :selected org-display-custom-times]
  13766. "--"
  13767. ["Goto Calendar" org-goto-calendar t]
  13768. ["Date from Calendar" org-date-from-calendar t]
  13769. "--"
  13770. ["Start/Restart Timer" org-timer-start t]
  13771. ["Pause/Continue Timer" org-timer-pause-or-continue t]
  13772. ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
  13773. ["Insert Timer String" org-timer t]
  13774. ["Insert Timer Item" org-timer-item t])
  13775. ("Logging work"
  13776. ["Clock in" org-clock-in t]
  13777. ["Clock out" org-clock-out t]
  13778. ["Clock cancel" org-clock-cancel t]
  13779. ["Goto running clock" org-clock-goto t]
  13780. ["Display times" org-clock-display t]
  13781. ["Create clock table" org-clock-report t]
  13782. "--"
  13783. ["Record DONE time"
  13784. (progn (setq org-log-done (not org-log-done))
  13785. (message "Switching to %s will %s record a timestamp"
  13786. (car org-done-keywords)
  13787. (if org-log-done "automatically" "not")))
  13788. :style toggle :selected org-log-done])
  13789. "--"
  13790. ["Agenda Command..." org-agenda t]
  13791. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  13792. ("File List for Agenda")
  13793. ("Special views current file"
  13794. ["TODO Tree" org-show-todo-tree t]
  13795. ["Check Deadlines" org-check-deadlines t]
  13796. ["Timeline" org-timeline t]
  13797. ["Tags/Property tree" org-match-sparse-tree t])
  13798. "--"
  13799. ["Export/Publish..." org-export t]
  13800. ("LaTeX"
  13801. ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
  13802. :selected org-cdlatex-mode]
  13803. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  13804. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  13805. ["Modify math symbol" org-cdlatex-math-modify
  13806. (org-inside-LaTeX-fragment-p)]
  13807. ["Insert citation" org-reftex-citation t]
  13808. "--"
  13809. ["Export LaTeX fragments as images"
  13810. (if (featurep 'org-exp)
  13811. (setq org-export-with-LaTeX-fragments
  13812. (not org-export-with-LaTeX-fragments))
  13813. (require 'org-exp))
  13814. :style toggle :selected (and (boundp 'org-export-with-LaTeX-fragments)
  13815. org-export-with-LaTeX-fragments)])
  13816. "--"
  13817. ("Documentation"
  13818. ["Show Version" org-version t]
  13819. ["Info Documentation" org-info t])
  13820. ("Customize"
  13821. ["Browse Org Group" org-customize t]
  13822. "--"
  13823. ["Expand This Menu" org-create-customize-menu
  13824. (fboundp 'customize-menu-create)])
  13825. "--"
  13826. ("Refresh/Reload"
  13827. ["Refresh setup current buffer" org-mode-restart t]
  13828. ["Reload Org (after update)" org-reload t]
  13829. ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
  13830. ))
  13831. (defun org-info (&optional node)
  13832. "Read documentation for Org-mode in the info system.
  13833. With optional NODE, go directly to that node."
  13834. (interactive)
  13835. (info (format "(org)%s" (or node ""))))
  13836. (defun org-install-agenda-files-menu ()
  13837. (let ((bl (buffer-list)))
  13838. (save-excursion
  13839. (while bl
  13840. (set-buffer (pop bl))
  13841. (if (org-mode-p) (setq bl nil)))
  13842. (when (org-mode-p)
  13843. (easy-menu-change
  13844. '("Org") "File List for Agenda"
  13845. (append
  13846. (list
  13847. ["Edit File List" (org-edit-agenda-file-list) t]
  13848. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  13849. ["Remove Current File from List" org-remove-file t]
  13850. ["Cycle through agenda files" org-cycle-agenda-files t]
  13851. ["Occur in all agenda files" org-occur-in-agenda-files t]
  13852. "--")
  13853. (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
  13854. ;;;; Documentation
  13855. ;;;###autoload
  13856. (defun org-require-autoloaded-modules ()
  13857. (interactive)
  13858. (mapc 'require
  13859. '(org-agenda org-archive org-ascii org-attach org-clock org-colview
  13860. org-docbook org-exp org-html org-icalendar
  13861. org-id org-latex
  13862. org-publish org-remember org-table
  13863. org-timer org-xoxo)))
  13864. ;;;###autoload
  13865. (defun org-reload (&optional uncompiled)
  13866. "Reload all org lisp files.
  13867. With prefix arg UNCOMPILED, load the uncompiled versions."
  13868. (interactive "P")
  13869. (require 'find-func)
  13870. (let* ((file-re "^\\(org\\|orgtbl\\)\\(\\.el\\|-.*\\.el\\)")
  13871. (dir-org (file-name-directory (org-find-library-name "org")))
  13872. (dir-org-contrib (ignore-errors
  13873. (file-name-directory
  13874. (org-find-library-name "org-contribdir"))))
  13875. (files
  13876. (append (directory-files dir-org t file-re)
  13877. (and dir-org-contrib
  13878. (directory-files dir-org-contrib t file-re))))
  13879. (remove-re (concat (if (featurep 'xemacs)
  13880. "org-colview" "org-colview-xemacs")
  13881. "\\'")))
  13882. (setq files (mapcar 'file-name-sans-extension files))
  13883. (setq files (mapcar
  13884. (lambda (x) (if (string-match remove-re x) nil x))
  13885. files))
  13886. (setq files (delq nil files))
  13887. (mapc
  13888. (lambda (f)
  13889. (when (featurep (intern (file-name-nondirectory f)))
  13890. (if (and (not uncompiled)
  13891. (file-exists-p (concat f ".elc")))
  13892. (load (concat f ".elc") nil nil t)
  13893. (load (concat f ".el") nil nil t))))
  13894. files))
  13895. (org-version))
  13896. ;;;###autoload
  13897. (defun org-customize ()
  13898. "Call the customize function with org as argument."
  13899. (interactive)
  13900. (org-load-modules-maybe)
  13901. (org-require-autoloaded-modules)
  13902. (customize-browse 'org))
  13903. (defun org-create-customize-menu ()
  13904. "Create a full customization menu for Org-mode, insert it into the menu."
  13905. (interactive)
  13906. (org-load-modules-maybe)
  13907. (org-require-autoloaded-modules)
  13908. (if (fboundp 'customize-menu-create)
  13909. (progn
  13910. (easy-menu-change
  13911. '("Org") "Customize"
  13912. `(["Browse Org group" org-customize t]
  13913. "--"
  13914. ,(customize-menu-create 'org)
  13915. ["Set" Custom-set t]
  13916. ["Save" Custom-save t]
  13917. ["Reset to Current" Custom-reset-current t]
  13918. ["Reset to Saved" Custom-reset-saved t]
  13919. ["Reset to Standard Settings" Custom-reset-standard t]))
  13920. (message "\"Org\"-menu now contains full customization menu"))
  13921. (error "Cannot expand menu (outdated version of cus-edit.el)")))
  13922. ;;;; Miscellaneous stuff
  13923. ;;; Generally useful functions
  13924. (defun org-find-text-property-in-string (prop s)
  13925. "Return the first non-nil value of property PROP in string S."
  13926. (or (get-text-property 0 prop s)
  13927. (get-text-property (or (next-single-property-change 0 prop s) 0)
  13928. prop s)))
  13929. (defun org-display-warning (message) ;; Copied from Emacs-Muse
  13930. "Display the given MESSAGE as a warning."
  13931. (if (fboundp 'display-warning)
  13932. (display-warning 'org message
  13933. (if (featurep 'xemacs)
  13934. 'warning
  13935. :warning))
  13936. (let ((buf (get-buffer-create "*Org warnings*")))
  13937. (with-current-buffer buf
  13938. (goto-char (point-max))
  13939. (insert "Warning (Org): " message)
  13940. (unless (bolp)
  13941. (newline)))
  13942. (display-buffer buf)
  13943. (sit-for 0))))
  13944. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  13945. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  13946. (if (and marker (marker-buffer marker)
  13947. (buffer-live-p (marker-buffer marker)))
  13948. (progn
  13949. (switch-to-buffer (marker-buffer marker))
  13950. (if (or (> marker (point-max)) (< marker (point-min)))
  13951. (widen))
  13952. (goto-char marker)
  13953. (org-show-context 'org-goto))
  13954. (if bookmark
  13955. (bookmark-jump bookmark)
  13956. (error "Cannot find location"))))
  13957. (defun org-quote-csv-field (s)
  13958. "Quote field for inclusion in CSV material."
  13959. (if (string-match "[\",]" s)
  13960. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  13961. s))
  13962. (defun org-plist-delete (plist property)
  13963. "Delete PROPERTY from PLIST.
  13964. This is in contrast to merely setting it to 0."
  13965. (let (p)
  13966. (while plist
  13967. (if (not (eq property (car plist)))
  13968. (setq p (plist-put p (car plist) (nth 1 plist))))
  13969. (setq plist (cddr plist)))
  13970. p))
  13971. (defun org-force-self-insert (N)
  13972. "Needed to enforce self-insert under remapping."
  13973. (interactive "p")
  13974. (self-insert-command N))
  13975. (defun org-string-width (s)
  13976. "Compute width of string, ignoring invisible characters.
  13977. This ignores character with invisibility property `org-link', and also
  13978. characters with property `org-cwidth', because these will become invisible
  13979. upon the next fontification round."
  13980. (let (b l)
  13981. (when (or (eq t buffer-invisibility-spec)
  13982. (assq 'org-link buffer-invisibility-spec))
  13983. (while (setq b (text-property-any 0 (length s)
  13984. 'invisible 'org-link s))
  13985. (setq s (concat (substring s 0 b)
  13986. (substring s (or (next-single-property-change
  13987. b 'invisible s) (length s)))))))
  13988. (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
  13989. (setq s (concat (substring s 0 b)
  13990. (substring s (or (next-single-property-change
  13991. b 'org-cwidth s) (length s))))))
  13992. (setq l (string-width s) b -1)
  13993. (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
  13994. (setq l (- l (get-text-property b 'org-dwidth-n s))))
  13995. l))
  13996. (defun org-get-indentation (&optional line)
  13997. "Get the indentation of the current line, interpreting tabs.
  13998. When LINE is given, assume it represents a line and compute its indentation."
  13999. (if line
  14000. (if (string-match "^ *" (org-remove-tabs line))
  14001. (match-end 0))
  14002. (save-excursion
  14003. (beginning-of-line 1)
  14004. (skip-chars-forward " \t")
  14005. (current-column))))
  14006. (defun org-remove-tabs (s &optional width)
  14007. "Replace tabulators in S with spaces.
  14008. Assumes that s is a single line, starting in column 0."
  14009. (setq width (or width tab-width))
  14010. (while (string-match "\t" s)
  14011. (setq s (replace-match
  14012. (make-string
  14013. (- (* width (/ (+ (match-beginning 0) width) width))
  14014. (match-beginning 0)) ?\ )
  14015. t t s)))
  14016. s)
  14017. (defun org-fix-indentation (line ind)
  14018. "Fix indentation in LINE.
  14019. IND is a cons cell with target and minimum indentation.
  14020. If the current indentation in LINE is smaller than the minimum,
  14021. leave it alone. If it is larger than ind, set it to the target."
  14022. (let* ((l (org-remove-tabs line))
  14023. (i (org-get-indentation l))
  14024. (i1 (car ind)) (i2 (cdr ind)))
  14025. (if (>= i i2) (setq l (substring line i2)))
  14026. (if (> i1 0)
  14027. (concat (make-string i1 ?\ ) l)
  14028. l)))
  14029. (defun org-base-buffer (buffer)
  14030. "Return the base buffer of BUFFER, if it has one. Else return the buffer."
  14031. (if (not buffer)
  14032. buffer
  14033. (or (buffer-base-buffer buffer)
  14034. buffer)))
  14035. (defun org-trim (s)
  14036. "Remove whitespace at beginning and end of string."
  14037. (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
  14038. (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
  14039. s)
  14040. (defun org-wrap (string &optional width lines)
  14041. "Wrap string to either a number of lines, or a width in characters.
  14042. If WIDTH is non-nil, the string is wrapped to that width, however many lines
  14043. that costs. If there is a word longer than WIDTH, the text is actually
  14044. wrapped to the length of that word.
  14045. IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
  14046. many lines, whatever width that takes.
  14047. The return value is a list of lines, without newlines at the end."
  14048. (let* ((words (org-split-string string "[ \t\n]+"))
  14049. (maxword (apply 'max (mapcar 'org-string-width words)))
  14050. w ll)
  14051. (cond (width
  14052. (org-do-wrap words (max maxword width)))
  14053. (lines
  14054. (setq w maxword)
  14055. (setq ll (org-do-wrap words maxword))
  14056. (if (<= (length ll) lines)
  14057. ll
  14058. (setq ll words)
  14059. (while (> (length ll) lines)
  14060. (setq w (1+ w))
  14061. (setq ll (org-do-wrap words w)))
  14062. ll))
  14063. (t (error "Cannot wrap this")))))
  14064. (defun org-do-wrap (words width)
  14065. "Create lines of maximum width WIDTH (in characters) from word list WORDS."
  14066. (let (lines line)
  14067. (while words
  14068. (setq line (pop words))
  14069. (while (and words (< (+ (length line) (length (car words))) width))
  14070. (setq line (concat line " " (pop words))))
  14071. (setq lines (push line lines)))
  14072. (nreverse lines)))
  14073. (defun org-split-string (string &optional separators)
  14074. "Splits STRING into substrings at SEPARATORS.
  14075. No empty strings are returned if there are matches at the beginning
  14076. and end of string."
  14077. (let ((rexp (or separators "[ \f\t\n\r\v]+"))
  14078. (start 0)
  14079. notfirst
  14080. (list nil))
  14081. (while (and (string-match rexp string
  14082. (if (and notfirst
  14083. (= start (match-beginning 0))
  14084. (< start (length string)))
  14085. (1+ start) start))
  14086. (< (match-beginning 0) (length string)))
  14087. (setq notfirst t)
  14088. (or (eq (match-beginning 0) 0)
  14089. (and (eq (match-beginning 0) (match-end 0))
  14090. (eq (match-beginning 0) start))
  14091. (setq list
  14092. (cons (substring string start (match-beginning 0))
  14093. list)))
  14094. (setq start (match-end 0)))
  14095. (or (eq start (length string))
  14096. (setq list
  14097. (cons (substring string start)
  14098. list)))
  14099. (nreverse list)))
  14100. (defun org-uuidgen-p (s)
  14101. "Is S an ID created by UUIDGEN?"
  14102. (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
  14103. (defun org-context ()
  14104. "Return a list of contexts of the current cursor position.
  14105. If several contexts apply, all are returned.
  14106. Each context entry is a list with a symbol naming the context, and
  14107. two positions indicating start and end of the context. Possible
  14108. contexts are:
  14109. :headline anywhere in a headline
  14110. :headline-stars on the leading stars in a headline
  14111. :todo-keyword on a TODO keyword (including DONE) in a headline
  14112. :tags on the TAGS in a headline
  14113. :priority on the priority cookie in a headline
  14114. :item on the first line of a plain list item
  14115. :item-bullet on the bullet/number of a plain list item
  14116. :checkbox on the checkbox in a plain list item
  14117. :table in an org-mode table
  14118. :table-special on a special filed in a table
  14119. :table-table in a table.el table
  14120. :link on a hyperlink
  14121. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
  14122. :target on a <<target>>
  14123. :radio-target on a <<<radio-target>>>
  14124. :latex-fragment on a LaTeX fragment
  14125. :latex-preview on a LaTeX fragment with overlayed preview image
  14126. This function expects the position to be visible because it uses font-lock
  14127. faces as a help to recognize the following contexts: :table-special, :link,
  14128. and :keyword."
  14129. (let* ((f (get-text-property (point) 'face))
  14130. (faces (if (listp f) f (list f)))
  14131. (p (point)) clist o)
  14132. ;; First the large context
  14133. (cond
  14134. ((org-on-heading-p t)
  14135. (push (list :headline (point-at-bol) (point-at-eol)) clist)
  14136. (when (progn
  14137. (beginning-of-line 1)
  14138. (looking-at org-todo-line-tags-regexp))
  14139. (push (org-point-in-group p 1 :headline-stars) clist)
  14140. (push (org-point-in-group p 2 :todo-keyword) clist)
  14141. (push (org-point-in-group p 4 :tags) clist))
  14142. (goto-char p)
  14143. (skip-chars-backward "^[\n\r \t") (or (eobp) (backward-char 1))
  14144. (if (looking-at "\\[#[A-Z0-9]\\]")
  14145. (push (org-point-in-group p 0 :priority) clist)))
  14146. ((org-at-item-p)
  14147. (push (org-point-in-group p 2 :item-bullet) clist)
  14148. (push (list :item (point-at-bol)
  14149. (save-excursion (org-end-of-item) (point)))
  14150. clist)
  14151. (and (org-at-item-checkbox-p)
  14152. (push (org-point-in-group p 0 :checkbox) clist)))
  14153. ((org-at-table-p)
  14154. (push (list :table (org-table-begin) (org-table-end)) clist)
  14155. (if (memq 'org-formula faces)
  14156. (push (list :table-special
  14157. (previous-single-property-change p 'face)
  14158. (next-single-property-change p 'face)) clist)))
  14159. ((org-at-table-p 'any)
  14160. (push (list :table-table) clist)))
  14161. (goto-char p)
  14162. ;; Now the small context
  14163. (cond
  14164. ((org-at-timestamp-p)
  14165. (push (org-point-in-group p 0 :timestamp) clist))
  14166. ((memq 'org-link faces)
  14167. (push (list :link
  14168. (previous-single-property-change p 'face)
  14169. (next-single-property-change p 'face)) clist))
  14170. ((memq 'org-special-keyword faces)
  14171. (push (list :keyword
  14172. (previous-single-property-change p 'face)
  14173. (next-single-property-change p 'face)) clist))
  14174. ((org-on-target-p)
  14175. (push (org-point-in-group p 0 :target) clist)
  14176. (goto-char (1- (match-beginning 0)))
  14177. (if (looking-at org-radio-target-regexp)
  14178. (push (org-point-in-group p 0 :radio-target) clist))
  14179. (goto-char p))
  14180. ((setq o (car (delq nil
  14181. (mapcar
  14182. (lambda (x)
  14183. (if (memq x org-latex-fragment-image-overlays) x))
  14184. (org-overlays-at (point))))))
  14185. (push (list :latex-fragment
  14186. (org-overlay-start o) (org-overlay-end o)) clist)
  14187. (push (list :latex-preview
  14188. (org-overlay-start o) (org-overlay-end o)) clist))
  14189. ((org-inside-LaTeX-fragment-p)
  14190. ;; FIXME: positions wrong.
  14191. (push (list :latex-fragment (point) (point)) clist)))
  14192. (setq clist (nreverse (delq nil clist)))
  14193. clist))
  14194. ;; FIXME: Compare with at-regexp-p Do we need both?
  14195. (defun org-in-regexp (re &optional nlines visually)
  14196. "Check if point is inside a match of regexp.
  14197. Normally only the current line is checked, but you can include NLINES extra
  14198. lines both before and after point into the search.
  14199. If VISUALLY is set, require that the cursor is not after the match but
  14200. really on, so that the block visually is on the match."
  14201. (catch 'exit
  14202. (let ((pos (point))
  14203. (eol (point-at-eol (+ 1 (or nlines 0))))
  14204. (inc (if visually 1 0)))
  14205. (save-excursion
  14206. (beginning-of-line (- 1 (or nlines 0)))
  14207. (while (re-search-forward re eol t)
  14208. (if (and (<= (match-beginning 0) pos)
  14209. (>= (+ inc (match-end 0)) pos))
  14210. (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
  14211. (defun org-at-regexp-p (regexp)
  14212. "Is point inside a match of REGEXP in the current line?"
  14213. (catch 'exit
  14214. (save-excursion
  14215. (let ((pos (point)) (end (point-at-eol)))
  14216. (beginning-of-line 1)
  14217. (while (re-search-forward regexp end t)
  14218. (if (and (<= (match-beginning 0) pos)
  14219. (>= (match-end 0) pos))
  14220. (throw 'exit t)))
  14221. nil))))
  14222. (defun org-occur-in-agenda-files (regexp &optional nlines)
  14223. "Call `multi-occur' with buffers for all agenda files."
  14224. (interactive "sOrg-files matching: \np")
  14225. (let* ((files (org-agenda-files))
  14226. (tnames (mapcar 'file-truename files))
  14227. (extra org-agenda-text-search-extra-files)
  14228. f)
  14229. (when (eq (car extra) 'agenda-archives)
  14230. (setq extra (cdr extra))
  14231. (setq files (org-add-archive-files files)))
  14232. (while (setq f (pop extra))
  14233. (unless (member (file-truename f) tnames)
  14234. (add-to-list 'files f 'append)
  14235. (add-to-list 'tnames (file-truename f) 'append)))
  14236. (multi-occur
  14237. (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
  14238. regexp)))
  14239. (if (boundp 'occur-mode-find-occurrence-hook)
  14240. ;; Emacs 23
  14241. (add-hook 'occur-mode-find-occurrence-hook
  14242. (lambda ()
  14243. (when (org-mode-p)
  14244. (org-reveal))))
  14245. ;; Emacs 22
  14246. (defadvice occur-mode-goto-occurrence
  14247. (after org-occur-reveal activate)
  14248. (and (org-mode-p) (org-reveal)))
  14249. (defadvice occur-mode-goto-occurrence-other-window
  14250. (after org-occur-reveal activate)
  14251. (and (org-mode-p) (org-reveal)))
  14252. (defadvice occur-mode-display-occurrence
  14253. (after org-occur-reveal activate)
  14254. (when (org-mode-p)
  14255. (let ((pos (occur-mode-find-occurrence)))
  14256. (with-current-buffer (marker-buffer pos)
  14257. (save-excursion
  14258. (goto-char pos)
  14259. (org-reveal)))))))
  14260. (defun org-uniquify (list)
  14261. "Remove duplicate elements from LIST."
  14262. (let (res)
  14263. (mapc (lambda (x) (add-to-list 'res x 'append)) list)
  14264. res))
  14265. (defun org-delete-all (elts list)
  14266. "Remove all elements in ELTS from LIST."
  14267. (while elts
  14268. (setq list (delete (pop elts) list)))
  14269. list)
  14270. (defun org-back-over-empty-lines ()
  14271. "Move backwards over whitespace, to the beginning of the first empty line.
  14272. Returns the number of empty lines passed."
  14273. (let ((pos (point)))
  14274. (skip-chars-backward " \t\n\r")
  14275. (beginning-of-line 2)
  14276. (goto-char (min (point) pos))
  14277. (count-lines (point) pos)))
  14278. (defun org-skip-whitespace ()
  14279. (skip-chars-forward " \t\n\r"))
  14280. (defun org-point-in-group (point group &optional context)
  14281. "Check if POINT is in match-group GROUP.
  14282. If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
  14283. match. If the match group does ot exist or point is not inside it,
  14284. return nil."
  14285. (and (match-beginning group)
  14286. (>= point (match-beginning group))
  14287. (<= point (match-end group))
  14288. (if context
  14289. (list context (match-beginning group) (match-end group))
  14290. t)))
  14291. (defun org-switch-to-buffer-other-window (&rest args)
  14292. "Switch to buffer in a second window on the current frame.
  14293. In particular, do not allow pop-up frames."
  14294. (let (pop-up-frames special-display-buffer-names special-display-regexps
  14295. special-display-function)
  14296. (apply 'switch-to-buffer-other-window args)))
  14297. (defun org-combine-plists (&rest plists)
  14298. "Create a single property list from all plists in PLISTS.
  14299. The process starts by copying the first list, and then setting properties
  14300. from the other lists. Settings in the last list are the most significant
  14301. ones and overrule settings in the other lists."
  14302. (let ((rtn (copy-sequence (pop plists)))
  14303. p v ls)
  14304. (while plists
  14305. (setq ls (pop plists))
  14306. (while ls
  14307. (setq p (pop ls) v (pop ls))
  14308. (setq rtn (plist-put rtn p v))))
  14309. rtn))
  14310. (defun org-move-line-down (arg)
  14311. "Move the current line down. With prefix argument, move it past ARG lines."
  14312. (interactive "p")
  14313. (let ((col (current-column))
  14314. beg end pos)
  14315. (beginning-of-line 1) (setq beg (point))
  14316. (beginning-of-line 2) (setq end (point))
  14317. (beginning-of-line (+ 1 arg))
  14318. (setq pos (move-marker (make-marker) (point)))
  14319. (insert (delete-and-extract-region beg end))
  14320. (goto-char pos)
  14321. (org-move-to-column col)))
  14322. (defun org-move-line-up (arg)
  14323. "Move the current line up. With prefix argument, move it past ARG lines."
  14324. (interactive "p")
  14325. (let ((col (current-column))
  14326. beg end pos)
  14327. (beginning-of-line 1) (setq beg (point))
  14328. (beginning-of-line 2) (setq end (point))
  14329. (beginning-of-line (- arg))
  14330. (setq pos (move-marker (make-marker) (point)))
  14331. (insert (delete-and-extract-region beg end))
  14332. (goto-char pos)
  14333. (org-move-to-column col)))
  14334. (defun org-replace-escapes (string table)
  14335. "Replace %-escapes in STRING with values in TABLE.
  14336. TABLE is an association list with keys like \"%a\" and string values.
  14337. The sequences in STRING may contain normal field width and padding information,
  14338. for example \"%-5s\". Replacements happen in the sequence given by TABLE,
  14339. so values can contain further %-escapes if they are define later in TABLE."
  14340. (let ((case-fold-search nil)
  14341. e re rpl)
  14342. (while (setq e (pop table))
  14343. (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
  14344. (while (string-match re string)
  14345. (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
  14346. (cdr e)))
  14347. (setq string (replace-match rpl t t string))))
  14348. string))
  14349. (defun org-sublist (list start end)
  14350. "Return a section of LIST, from START to END.
  14351. Counting starts at 1."
  14352. (let (rtn (c start))
  14353. (setq list (nthcdr (1- start) list))
  14354. (while (and list (<= c end))
  14355. (push (pop list) rtn)
  14356. (setq c (1+ c)))
  14357. (nreverse rtn)))
  14358. (defun org-find-base-buffer-visiting (file)
  14359. "Like `find-buffer-visiting' but always return the base buffer and
  14360. not an indirect buffer."
  14361. (let ((buf (or (get-file-buffer file)
  14362. (find-buffer-visiting file))))
  14363. (if buf
  14364. (or (buffer-base-buffer buf) buf)
  14365. nil)))
  14366. (defun org-image-file-name-regexp (&optional extensions)
  14367. "Return regexp matching the file names of images.
  14368. If EXTENSIONS is given, only match these."
  14369. (if (and (not extensions) (fboundp 'image-file-name-regexp))
  14370. (image-file-name-regexp)
  14371. (let ((image-file-name-extensions
  14372. (or extensions
  14373. '("png" "jpeg" "jpg" "gif" "tiff" "tif"
  14374. "xbm" "xpm" "pbm" "pgm" "ppm"))))
  14375. (concat "\\."
  14376. (regexp-opt (nconc (mapcar 'upcase
  14377. image-file-name-extensions)
  14378. image-file-name-extensions)
  14379. t)
  14380. "\\'"))))
  14381. (defun org-file-image-p (file &optional extensions)
  14382. "Return non-nil if FILE is an image."
  14383. (save-match-data
  14384. (string-match (org-image-file-name-regexp extensions) file)))
  14385. (defun org-get-cursor-date ()
  14386. "Return the date at cursor in as a time.
  14387. This works in the calendar and in the agenda, anywhere else it just
  14388. returns the current time."
  14389. (let (date day defd)
  14390. (cond
  14391. ((eq major-mode 'calendar-mode)
  14392. (setq date (calendar-cursor-to-date)
  14393. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14394. ((eq major-mode 'org-agenda-mode)
  14395. (setq day (get-text-property (point) 'day))
  14396. (if day
  14397. (setq date (calendar-gregorian-from-absolute day)
  14398. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  14399. (nth 2 date))))))
  14400. (or defd (current-time))))
  14401. (defvar org-agenda-action-marker (make-marker)
  14402. "Marker pointing to the entry for the next agenda action.")
  14403. (defun org-mark-entry-for-agenda-action ()
  14404. "Mark the current entry as target of an agenda action.
  14405. Agenda actions are actions executed from the agenda with the key `k',
  14406. which make use of the date at the cursor."
  14407. (interactive)
  14408. (move-marker org-agenda-action-marker
  14409. (save-excursion (org-back-to-heading t) (point))
  14410. (current-buffer))
  14411. (message
  14412. "Entry marked for action; press `k' at desired date in agenda or calendar"))
  14413. ;;; Paragraph filling stuff.
  14414. ;; We want this to be just right, so use the full arsenal.
  14415. (defun org-indent-line-function ()
  14416. "Indent line like previous, but further if previous was headline or item."
  14417. (interactive)
  14418. (let* ((pos (point))
  14419. (itemp (org-at-item-p))
  14420. (org-drawer-regexp (or org-drawer-regexp "\000"))
  14421. column bpos bcol tpos tcol bullet btype bullet-type)
  14422. ;; Find the previous relevant line
  14423. (beginning-of-line 1)
  14424. (cond
  14425. ((looking-at "#") (setq column 0))
  14426. ((looking-at "\\*+ ") (setq column 0))
  14427. ((and (looking-at "[ \t]*:END:")
  14428. (save-excursion (re-search-backward org-drawer-regexp nil t)))
  14429. (save-excursion
  14430. (goto-char (1- (match-beginning 1)))
  14431. (setq column (current-column))))
  14432. (t
  14433. (beginning-of-line 0)
  14434. (while (and (not (bobp)) (looking-at "[ \t]*[\n:#|]")
  14435. (not (looking-at "[ \t]*:END:"))
  14436. (not (looking-at org-drawer-regexp)))
  14437. (beginning-of-line 0))
  14438. (cond
  14439. ((looking-at "\\*+[ \t]+")
  14440. (if (not org-adapt-indentation)
  14441. (setq column 0)
  14442. (goto-char (match-end 0))
  14443. (setq column (current-column))))
  14444. ((looking-at org-drawer-regexp)
  14445. (goto-char (1- (match-beginning 1)))
  14446. (setq column (current-column)))
  14447. ((looking-at "\\([ \t]*\\):END:")
  14448. (goto-char (match-end 1))
  14449. (setq column (current-column)))
  14450. ((org-in-item-p)
  14451. (org-beginning-of-item)
  14452. (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\[[- X]\\][ \t]*\\|.*? :: \\)?")
  14453. (setq bpos (match-beginning 1) tpos (match-end 0)
  14454. bcol (progn (goto-char bpos) (current-column))
  14455. tcol (progn (goto-char tpos) (current-column))
  14456. bullet (match-string 1)
  14457. bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
  14458. (if (> tcol (+ bcol org-description-max-indent))
  14459. (setq tcol (+ bcol 5)))
  14460. (if (not itemp)
  14461. (setq column tcol)
  14462. (goto-char pos)
  14463. (beginning-of-line 1)
  14464. (if (looking-at "\\S-")
  14465. (progn
  14466. (looking-at "[ \t]*\\(\\S-+\\)[ \t]*")
  14467. (setq bullet (match-string 1)
  14468. btype (if (string-match "[0-9]" bullet) "n" bullet))
  14469. (setq column (if (equal btype bullet-type) bcol tcol)))
  14470. (setq column (org-get-indentation)))))
  14471. (t (setq column (org-get-indentation))))))
  14472. (goto-char pos)
  14473. (if (<= (current-column) (current-indentation))
  14474. (org-indent-line-to column)
  14475. (save-excursion (org-indent-line-to column)))
  14476. (setq column (current-column))
  14477. (beginning-of-line 1)
  14478. (if (looking-at
  14479. "\\([ \t]+\\)\\(:[-_0-9a-zA-Z]+:\\)[ \t]*\\(\\S-.*\\(\\S-\\|$\\)\\)")
  14480. (replace-match (concat "\\1" (format org-property-format
  14481. (match-string 2) (match-string 3)))
  14482. t nil))
  14483. (org-move-to-column column)))
  14484. (defun org-set-autofill-regexps ()
  14485. (interactive)
  14486. ;; In the paragraph separator we include headlines, because filling
  14487. ;; text in a line directly attached to a headline would otherwise
  14488. ;; fill the headline as well.
  14489. (org-set-local 'comment-start-skip "^#+[ \t]*")
  14490. (org-set-local 'paragraph-separate "\f\\|\\*+ \\|[ ]*$\\|[ \t]*[:|]")
  14491. ;; The paragraph starter includes hand-formatted lists.
  14492. (org-set-local 'paragraph-start
  14493. "\f\\|[ ]*$\\|\\*+ \\|\f\\|[ \t]*\\([-+*][ \t]+\\|[0-9]+[.)][ \t]+\\)\\|[ \t]*[:|]")
  14494. ;; Inhibit auto-fill for headers, tables and fixed-width lines.
  14495. ;; But only if the user has not turned off tables or fixed-width regions
  14496. (org-set-local
  14497. 'auto-fill-inhibit-regexp
  14498. (concat "\\*+ \\|#\\+"
  14499. "\\|[ \t]*" org-keyword-time-regexp
  14500. (if (or org-enable-table-editor org-enable-fixed-width-editor)
  14501. (concat
  14502. "\\|[ \t]*["
  14503. (if org-enable-table-editor "|" "")
  14504. (if org-enable-fixed-width-editor ":" "")
  14505. "]"))))
  14506. ;; We use our own fill-paragraph function, to make sure that tables
  14507. ;; and fixed-width regions are not wrapped. That function will pass
  14508. ;; through to `fill-paragraph' when appropriate.
  14509. (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
  14510. ; Adaptive filling: To get full control, first make sure that
  14511. ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
  14512. (org-set-local 'adaptive-fill-regexp "\000")
  14513. (org-set-local 'adaptive-fill-function
  14514. 'org-adaptive-fill-function)
  14515. (org-set-local
  14516. 'align-mode-rules-list
  14517. '((org-in-buffer-settings
  14518. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  14519. (modes . '(org-mode))))))
  14520. (defun org-fill-paragraph (&optional justify)
  14521. "Re-align a table, pass through to fill-paragraph if no table."
  14522. (let ((table-p (org-at-table-p))
  14523. (table.el-p (org-at-table.el-p)))
  14524. (cond ((and (equal (char-after (point-at-bol)) ?*)
  14525. (save-excursion (goto-char (point-at-bol))
  14526. (looking-at outline-regexp)))
  14527. t) ; skip headlines
  14528. (table.el-p t) ; skip table.el tables
  14529. (table-p (org-table-align) t) ; align org-mode tables
  14530. (t nil)))) ; call paragraph-fill
  14531. ;; For reference, this is the default value of adaptive-fill-regexp
  14532. ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
  14533. (defun org-adaptive-fill-function ()
  14534. "Return a fill prefix for org-mode files.
  14535. In particular, this makes sure hanging paragraphs for hand-formatted lists
  14536. work correctly."
  14537. (cond ((looking-at "#[ \t]+")
  14538. (match-string 0))
  14539. ((looking-at "[ \t]*\\([-*+] .*? :: \\)")
  14540. (save-excursion
  14541. (if (> (match-end 1) (+ (match-beginning 1)
  14542. org-description-max-indent))
  14543. (goto-char (+ (match-beginning 1) 5))
  14544. (goto-char (match-end 0)))
  14545. (make-string (current-column) ?\ )))
  14546. ((looking-at "[ \t]*\\([-*+] \\|[0-9]+[.)] ?\\)?")
  14547. (save-excursion
  14548. (goto-char (match-end 0))
  14549. (make-string (current-column) ?\ )))
  14550. (t nil)))
  14551. ;;; Other stuff.
  14552. (defun org-toggle-fixed-width-section (arg)
  14553. "Toggle the fixed-width export.
  14554. If there is no active region, the QUOTE keyword at the current headline is
  14555. inserted or removed. When present, it causes the text between this headline
  14556. and the next to be exported as fixed-width text, and unmodified.
  14557. If there is an active region, this command adds or removes a colon as the
  14558. first character of this line. If the first character of a line is a colon,
  14559. this line is also exported in fixed-width font."
  14560. (interactive "P")
  14561. (let* ((cc 0)
  14562. (regionp (org-region-active-p))
  14563. (beg (if regionp (region-beginning) (point)))
  14564. (end (if regionp (region-end)))
  14565. (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
  14566. (case-fold-search nil)
  14567. (re "[ \t]*\\(: \\)")
  14568. off)
  14569. (if regionp
  14570. (save-excursion
  14571. (goto-char beg)
  14572. (setq cc (current-column))
  14573. (beginning-of-line 1)
  14574. (setq off (looking-at re))
  14575. (while (> nlines 0)
  14576. (setq nlines (1- nlines))
  14577. (beginning-of-line 1)
  14578. (cond
  14579. (arg
  14580. (org-move-to-column cc t)
  14581. (insert ": \n")
  14582. (forward-line -1))
  14583. ((and off (looking-at re))
  14584. (replace-match "" t t nil 1))
  14585. ((not off) (org-move-to-column cc t) (insert ": ")))
  14586. (forward-line 1)))
  14587. (save-excursion
  14588. (org-back-to-heading)
  14589. (if (looking-at (concat outline-regexp
  14590. "\\( *\\<" org-quote-string "\\>[ \t]*\\)"))
  14591. (replace-match "" t t nil 1)
  14592. (if (looking-at outline-regexp)
  14593. (progn
  14594. (goto-char (match-end 0))
  14595. (insert org-quote-string " "))))))))
  14596. (defun org-reftex-citation ()
  14597. "Use reftex-citation to insert a citation into the buffer.
  14598. This looks for a line like
  14599. #+BIBLIOGRAPHY: foo plain option:-d
  14600. and derives from it that foo.bib is the bbliography file relevant
  14601. for this document. It then installs the necessary environment for RefTeX
  14602. to work in this buffer and calls `reftex-citation' to insert a citation
  14603. into the buffer.
  14604. Export of such citations to both LaTeX and HTML is handled by the contributed
  14605. package org-exp-bibtex by Taru Karttunen."
  14606. (interactive)
  14607. (let ((reftex-docstruct-symbol 'rds)
  14608. (reftex-cite-format "\\cite{%l}")
  14609. rds bib)
  14610. (save-excursion
  14611. (save-restriction
  14612. (widen)
  14613. (let ((case-fold-search t)
  14614. (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
  14615. (if (not (save-excursion
  14616. (or (re-search-forward re nil t)
  14617. (re-search-backward re nil t))))
  14618. (error "No bibliography defined in file")
  14619. (setq bib (concat (match-string 1) ".bib")
  14620. rds (list (list 'bib bib)))))))
  14621. (call-interactively 'reftex-citation)))
  14622. ;;;; Functions extending outline functionality
  14623. (defun org-beginning-of-line (&optional arg)
  14624. "Go to the beginning of the current line. If that is invisible, continue
  14625. to a visible line beginning. This makes the function of C-a more intuitive.
  14626. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  14627. first attempt, and only move to after the tags when the cursor is already
  14628. beyond the end of the headline."
  14629. (interactive "P")
  14630. (let ((pos (point))
  14631. (special (if (consp org-special-ctrl-a/e)
  14632. (car org-special-ctrl-a/e)
  14633. org-special-ctrl-a/e))
  14634. refpos)
  14635. (beginning-of-line 1)
  14636. (if (and arg (fboundp 'move-beginning-of-line))
  14637. (call-interactively 'move-beginning-of-line)
  14638. (if (bobp)
  14639. nil
  14640. (backward-char 1)
  14641. (if (org-invisible-p)
  14642. (while (and (not (bobp)) (org-invisible-p))
  14643. (backward-char 1)
  14644. (beginning-of-line 1))
  14645. (forward-char 1))))
  14646. (when special
  14647. (cond
  14648. ((and (looking-at org-complex-heading-regexp)
  14649. (= (char-after (match-end 1)) ?\ ))
  14650. (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  14651. (point-at-eol)))
  14652. (goto-char
  14653. (if (eq special t)
  14654. (cond ((> pos refpos) refpos)
  14655. ((= pos (point)) refpos)
  14656. (t (point)))
  14657. (cond ((> pos (point)) (point))
  14658. ((not (eq last-command this-command)) (point))
  14659. (t refpos)))))
  14660. ((org-at-item-p)
  14661. (goto-char
  14662. (if (eq special t)
  14663. (cond ((> pos (match-end 4)) (match-end 4))
  14664. ((= pos (point)) (match-end 4))
  14665. (t (point)))
  14666. (cond ((> pos (point)) (point))
  14667. ((not (eq last-command this-command)) (point))
  14668. (t (match-end 4))))))))
  14669. (org-no-warnings
  14670. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  14671. (defun org-end-of-line (&optional arg)
  14672. "Go to the end of the line.
  14673. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  14674. first attempt, and only move to after the tags when the cursor is already
  14675. beyond the end of the headline."
  14676. (interactive "P")
  14677. (let ((special (if (consp org-special-ctrl-a/e)
  14678. (cdr org-special-ctrl-a/e)
  14679. org-special-ctrl-a/e)))
  14680. (if (or (not special)
  14681. (not (org-on-heading-p))
  14682. arg)
  14683. (call-interactively (if (fboundp 'move-end-of-line)
  14684. 'move-end-of-line
  14685. 'end-of-line))
  14686. (let ((pos (point)))
  14687. (beginning-of-line 1)
  14688. (if (looking-at (org-re ".*?\\([ \t]*\\)\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  14689. (if (eq special t)
  14690. (if (or (< pos (match-beginning 1))
  14691. (= pos (match-end 0)))
  14692. (goto-char (match-beginning 1))
  14693. (goto-char (match-end 0)))
  14694. (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
  14695. (goto-char (match-end 0))
  14696. (goto-char (match-beginning 1))))
  14697. (call-interactively (if (fboundp 'move-end-of-line)
  14698. 'move-end-of-line
  14699. 'end-of-line)))))
  14700. (org-no-warnings
  14701. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  14702. (define-key org-mode-map "\C-a" 'org-beginning-of-line)
  14703. (define-key org-mode-map "\C-e" 'org-end-of-line)
  14704. (defun org-backward-sentence (&optional arg)
  14705. "Go to beginning of sentence, or beginning of table field.
  14706. This will call `backward-sentence' or `org-table-beginning-of-field',
  14707. depending on context."
  14708. (interactive "P")
  14709. (cond
  14710. ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
  14711. (t (call-interactively 'backward-sentence))))
  14712. (defun org-forward-sentence (&optional arg)
  14713. "Go to end of sentence, or end of table field.
  14714. This will call `forward-sentence' or `org-table-end-of-field',
  14715. depending on context."
  14716. (interactive "P")
  14717. (cond
  14718. ((org-at-table-p) (call-interactively 'org-table-end-of-field))
  14719. (t (call-interactively 'forward-sentence))))
  14720. (define-key org-mode-map "\M-a" 'org-backward-sentence)
  14721. (define-key org-mode-map "\M-e" 'org-forward-sentence)
  14722. (defun org-kill-line (&optional arg)
  14723. "Kill line, to tags or end of line."
  14724. (interactive "P")
  14725. (cond
  14726. ((or (not org-special-ctrl-k)
  14727. (bolp)
  14728. (not (org-on-heading-p)))
  14729. (call-interactively 'kill-line))
  14730. ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)[ \t]*$"))
  14731. (kill-region (point) (match-beginning 1))
  14732. (org-set-tags nil t))
  14733. (t (kill-region (point) (point-at-eol)))))
  14734. (define-key org-mode-map "\C-k" 'org-kill-line)
  14735. (defun org-yank (&optional arg)
  14736. "Yank. If the kill is a subtree, treat it specially.
  14737. This command will look at the current kill and check if is a single
  14738. subtree, or a series of subtrees[1]. If it passes the test, and if the
  14739. cursor is at the beginning of a line or after the stars of a currently
  14740. empty headline, then the yank is handled specially. How exactly depends
  14741. on the value of the following variables, both set by default.
  14742. org-yank-folded-subtrees
  14743. When set, the subtree(s) will be folded after insertion, but only
  14744. if doing so would now swallow text after the yanked text.
  14745. org-yank-adjusted-subtrees
  14746. When set, the subtree will be promoted or demoted in order to
  14747. fit into the local outline tree structure, which means that the level
  14748. will be adjusted so that it becomes the smaller one of the two
  14749. *visible* surrounding headings.
  14750. Any prefix to this command will cause `yank' to be called directly with
  14751. no special treatment. In particular, a simple `C-u' prefix will just
  14752. plainly yank the text as it is.
  14753. \[1] The test checks if the first non-white line is a heading
  14754. and if there are no other headings with fewer stars."
  14755. (interactive "P")
  14756. (org-yank-generic 'yank arg))
  14757. (defun org-yank-generic (command arg)
  14758. "Perform some yank-like command.
  14759. This function implements the behavior described in the `org-yank'
  14760. documentation. However, it has been generalized to work for any
  14761. interactive command with similar behavior."
  14762. ;; pretend to be command COMMAND
  14763. (setq this-command command)
  14764. (if arg
  14765. (call-interactively command)
  14766. (let ((subtreep ; is kill a subtree, and the yank position appropriate?
  14767. (and (org-kill-is-subtree-p)
  14768. (or (bolp)
  14769. (and (looking-at "[ \t]*$")
  14770. (string-match
  14771. "\\`\\*+\\'"
  14772. (buffer-substring (point-at-bol) (point)))))))
  14773. swallowp)
  14774. (cond
  14775. ((and subtreep org-yank-folded-subtrees)
  14776. (let ((beg (point))
  14777. end)
  14778. (if (and subtreep org-yank-adjusted-subtrees)
  14779. (org-paste-subtree nil nil 'for-yank)
  14780. (call-interactively command))
  14781. (setq end (point))
  14782. (goto-char beg)
  14783. (when (and (bolp) subtreep
  14784. (not (setq swallowp
  14785. (org-yank-folding-would-swallow-text beg end))))
  14786. (or (looking-at outline-regexp)
  14787. (re-search-forward (concat "^" outline-regexp) end t))
  14788. (while (and (< (point) end) (looking-at outline-regexp))
  14789. (hide-subtree)
  14790. (org-cycle-show-empty-lines 'folded)
  14791. (condition-case nil
  14792. (outline-forward-same-level 1)
  14793. (error (goto-char end)))))
  14794. (when swallowp
  14795. (message
  14796. "Inserted text not folded because that would swallow text"))
  14797. (goto-char end)
  14798. (skip-chars-forward " \t\n\r")
  14799. (beginning-of-line 1)
  14800. (push-mark beg 'nomsg)))
  14801. ((and subtreep org-yank-adjusted-subtrees)
  14802. (let ((beg (point-at-bol)))
  14803. (org-paste-subtree nil nil 'for-yank)
  14804. (push-mark beg 'nomsg)))
  14805. (t
  14806. (call-interactively command))))))
  14807. (defun org-yank-folding-would-swallow-text (beg end)
  14808. "Would hide-subtree at BEG swallow any text after END?"
  14809. (let (level)
  14810. (save-excursion
  14811. (goto-char beg)
  14812. (when (or (looking-at outline-regexp)
  14813. (re-search-forward (concat "^" outline-regexp) end t))
  14814. (setq level (org-outline-level)))
  14815. (goto-char end)
  14816. (skip-chars-forward " \t\r\n\v\f")
  14817. (if (or (eobp)
  14818. (and (bolp) (looking-at org-outline-regexp)
  14819. (<= (org-outline-level) level)))
  14820. nil ; Nothing would be swallowed
  14821. t)))) ; something would swallow
  14822. (define-key org-mode-map "\C-y" 'org-yank)
  14823. (defun org-invisible-p ()
  14824. "Check if point is at a character currently not visible."
  14825. ;; Early versions of noutline don't have `outline-invisible-p'.
  14826. (if (fboundp 'outline-invisible-p)
  14827. (outline-invisible-p)
  14828. (get-char-property (point) 'invisible)))
  14829. (defun org-invisible-p2 ()
  14830. "Check if point is at a character currently not visible."
  14831. (save-excursion
  14832. (if (and (eolp) (not (bobp))) (backward-char 1))
  14833. ;; Early versions of noutline don't have `outline-invisible-p'.
  14834. (if (fboundp 'outline-invisible-p)
  14835. (outline-invisible-p)
  14836. (get-char-property (point) 'invisible))))
  14837. (defun org-back-to-heading (&optional invisible-ok)
  14838. "Call `outline-back-to-heading', but provide a better error message."
  14839. (condition-case nil
  14840. (outline-back-to-heading invisible-ok)
  14841. (error (error "Before first headline at position %d in buffer %s"
  14842. (point) (current-buffer)))))
  14843. (defun org-before-first-heading-p ()
  14844. "Before first heading?"
  14845. (save-excursion
  14846. (null (re-search-backward "^\\*+ " nil t))))
  14847. (defalias 'org-on-heading-p 'outline-on-heading-p)
  14848. (defalias 'org-at-heading-p 'outline-on-heading-p)
  14849. (defun org-at-heading-or-item-p ()
  14850. (or (org-on-heading-p) (org-at-item-p)))
  14851. (defun org-on-target-p ()
  14852. (or (org-in-regexp org-radio-target-regexp)
  14853. (org-in-regexp org-target-regexp)))
  14854. (defun org-up-heading-all (arg)
  14855. "Move to the heading line of which the present line is a subheading.
  14856. This function considers both visible and invisible heading lines.
  14857. With argument, move up ARG levels."
  14858. (if (fboundp 'outline-up-heading-all)
  14859. (outline-up-heading-all arg) ; emacs 21 version of outline.el
  14860. (outline-up-heading arg t))) ; emacs 22 version of outline.el
  14861. (defun org-up-heading-safe ()
  14862. "Move to the heading line of which the present line is a subheading.
  14863. This version will not throw an error. It will return the level of the
  14864. headline found, or nil if no higher level is found.
  14865. Also, this function will be a lot faster than `outline-up-heading',
  14866. because it relies on stars being the outline starters. This can really
  14867. make a significant difference in outlines with very many siblings."
  14868. (let (start-level re)
  14869. (org-back-to-heading t)
  14870. (setq start-level (funcall outline-level))
  14871. (if (equal start-level 1)
  14872. nil
  14873. (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
  14874. (if (re-search-backward re nil t)
  14875. (funcall outline-level)))))
  14876. (defun org-first-sibling-p ()
  14877. "Is this heading the first child of its parents?"
  14878. (interactive)
  14879. (let ((re (concat "^" outline-regexp))
  14880. level l)
  14881. (unless (org-at-heading-p t)
  14882. (error "Not at a heading"))
  14883. (setq level (funcall outline-level))
  14884. (save-excursion
  14885. (if (not (re-search-backward re nil t))
  14886. t
  14887. (setq l (funcall outline-level))
  14888. (< l level)))))
  14889. (defun org-goto-sibling (&optional previous)
  14890. "Goto the next sibling, even if it is invisible.
  14891. When PREVIOUS is set, go to the previous sibling instead. Returns t
  14892. when a sibling was found. When none is found, return nil and don't
  14893. move point."
  14894. (let ((fun (if previous 're-search-backward 're-search-forward))
  14895. (pos (point))
  14896. (re (concat "^" outline-regexp))
  14897. level l)
  14898. (when (condition-case nil (org-back-to-heading t) (error nil))
  14899. (setq level (funcall outline-level))
  14900. (catch 'exit
  14901. (or previous (forward-char 1))
  14902. (while (funcall fun re nil t)
  14903. (setq l (funcall outline-level))
  14904. (when (< l level) (goto-char pos) (throw 'exit nil))
  14905. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  14906. (goto-char pos)
  14907. nil))))
  14908. (defun org-show-siblings ()
  14909. "Show all siblings of the current headline."
  14910. (save-excursion
  14911. (while (org-goto-sibling) (org-flag-heading nil)))
  14912. (save-excursion
  14913. (while (org-goto-sibling 'previous)
  14914. (org-flag-heading nil))))
  14915. (defun org-show-hidden-entry ()
  14916. "Show an entry where even the heading is hidden."
  14917. (save-excursion
  14918. (org-show-entry)))
  14919. (defun org-flag-heading (flag &optional entry)
  14920. "Flag the current heading. FLAG non-nil means make invisible.
  14921. When ENTRY is non-nil, show the entire entry."
  14922. (save-excursion
  14923. (org-back-to-heading t)
  14924. ;; Check if we should show the entire entry
  14925. (if entry
  14926. (progn
  14927. (org-show-entry)
  14928. (save-excursion
  14929. (and (outline-next-heading)
  14930. (org-flag-heading nil))))
  14931. (outline-flag-region (max (point-min) (1- (point)))
  14932. (save-excursion (outline-end-of-heading) (point))
  14933. flag))))
  14934. (defun org-forward-same-level (arg)
  14935. "Move forward to the ARG'th subheading at same level as this one.
  14936. Stop at the first and last subheadings of a superior heading.
  14937. This is like outline-forward-same-level, but invisible headings are ok."
  14938. (interactive "p")
  14939. (org-back-to-heading t)
  14940. (while (> arg 0)
  14941. (let ((point-to-move-to (save-excursion
  14942. (org-get-next-sibling))))
  14943. (if point-to-move-to
  14944. (progn
  14945. (goto-char point-to-move-to)
  14946. (setq arg (1- arg)))
  14947. (progn
  14948. (setq arg 0)
  14949. (error "No following same-level heading"))))))
  14950. (defun org-get-next-sibling ()
  14951. "Move to next heading of the same level, and return point.
  14952. If there is no such heading, return nil.
  14953. This is like outline-next-sibling, but invisible headings are ok."
  14954. (let ((level (funcall outline-level)))
  14955. (outline-next-heading)
  14956. (while (and (not (eobp)) (> (funcall outline-level) level))
  14957. (outline-next-heading))
  14958. (if (or (eobp) (< (funcall outline-level) level))
  14959. nil
  14960. (point))))
  14961. (defun org-end-of-subtree (&optional invisible-OK to-heading)
  14962. ;; This contains an exact copy of the original function, but it uses
  14963. ;; `org-back-to-heading', to make it work also in invisible
  14964. ;; trees. And is uses an invisible-OK argument.
  14965. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  14966. ;; Furthermore, when used inside Org, finding the end of a large subtree
  14967. ;; with many children and grandchildren etc, this can be much faster
  14968. ;; than the outline version.
  14969. (org-back-to-heading invisible-OK)
  14970. (let ((first t)
  14971. (level (funcall outline-level)))
  14972. (if (and (org-mode-p) (< level 1000))
  14973. ;; A true heading (not a plain list item), in Org-mode
  14974. ;; This means we can easily find the end by looking
  14975. ;; only for the right number of stars. Using a regexp to do
  14976. ;; this is so much faster than using a Lisp loop.
  14977. (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
  14978. (forward-char 1)
  14979. (and (re-search-forward re nil 'move) (beginning-of-line 1)))
  14980. ;; something else, do it the slow way
  14981. (while (and (not (eobp))
  14982. (or first (> (funcall outline-level) level)))
  14983. (setq first nil)
  14984. (outline-next-heading)))
  14985. (unless to-heading
  14986. (if (memq (preceding-char) '(?\n ?\^M))
  14987. (progn
  14988. ;; Go to end of line before heading
  14989. (forward-char -1)
  14990. (if (memq (preceding-char) '(?\n ?\^M))
  14991. ;; leave blank line before heading
  14992. (forward-char -1))))))
  14993. (point))
  14994. (defun org-show-subtree ()
  14995. "Show everything after this heading at deeper levels."
  14996. (outline-flag-region
  14997. (point)
  14998. (save-excursion
  14999. (outline-end-of-subtree) (outline-next-heading) (point))
  15000. nil))
  15001. (defun org-show-entry ()
  15002. "Show the body directly following this heading.
  15003. Show the heading too, if it is currently invisible."
  15004. (interactive)
  15005. (save-excursion
  15006. (condition-case nil
  15007. (progn
  15008. (org-back-to-heading t)
  15009. (outline-flag-region
  15010. (max (point-min) (1- (point)))
  15011. (save-excursion
  15012. (if (re-search-forward
  15013. (concat "[\r\n]\\(" outline-regexp "\\)") nil t)
  15014. (match-beginning 1)
  15015. (point-max)))
  15016. nil))
  15017. (error nil))))
  15018. (defun org-make-options-regexp (kwds &optional extra)
  15019. "Make a regular expression for keyword lines."
  15020. (concat
  15021. "^"
  15022. "#?[ \t]*\\+\\("
  15023. (mapconcat 'regexp-quote kwds "\\|")
  15024. (if extra (concat "\\|" extra))
  15025. "\\):[ \t]*"
  15026. "\\(.+\\)"))
  15027. ;; Make isearch reveal the necessary context
  15028. (defun org-isearch-end ()
  15029. "Reveal context after isearch exits."
  15030. (when isearch-success ; only if search was successful
  15031. (if (featurep 'xemacs)
  15032. ;; Under XEmacs, the hook is run in the correct place,
  15033. ;; we directly show the context.
  15034. (org-show-context 'isearch)
  15035. ;; In Emacs the hook runs *before* restoring the overlays.
  15036. ;; So we have to use a one-time post-command-hook to do this.
  15037. ;; (Emacs 22 has a special variable, see function `org-mode')
  15038. (unless (and (boundp 'isearch-mode-end-hook-quit)
  15039. isearch-mode-end-hook-quit)
  15040. ;; Only when the isearch was not quitted.
  15041. (org-add-hook 'post-command-hook 'org-isearch-post-command
  15042. 'append 'local)))))
  15043. (defun org-isearch-post-command ()
  15044. "Remove self from hook, and show context."
  15045. (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
  15046. (org-show-context 'isearch))
  15047. ;;;; Integration with and fixes for other packages
  15048. ;;; Imenu support
  15049. (defvar org-imenu-markers nil
  15050. "All markers currently used by Imenu.")
  15051. (make-variable-buffer-local 'org-imenu-markers)
  15052. (defun org-imenu-new-marker (&optional pos)
  15053. "Return a new marker for use by Imenu, and remember the marker."
  15054. (let ((m (make-marker)))
  15055. (move-marker m (or pos (point)))
  15056. (push m org-imenu-markers)
  15057. m))
  15058. (defun org-imenu-get-tree ()
  15059. "Produce the index for Imenu."
  15060. (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
  15061. (setq org-imenu-markers nil)
  15062. (let* ((n org-imenu-depth)
  15063. (re (concat "^" outline-regexp))
  15064. (subs (make-vector (1+ n) nil))
  15065. (last-level 0)
  15066. m level head)
  15067. (save-excursion
  15068. (save-restriction
  15069. (widen)
  15070. (goto-char (point-max))
  15071. (while (re-search-backward re nil t)
  15072. (setq level (org-reduced-level (funcall outline-level)))
  15073. (when (<= level n)
  15074. (looking-at org-complex-heading-regexp)
  15075. (setq head (org-link-display-format
  15076. (org-match-string-no-properties 4))
  15077. m (org-imenu-new-marker))
  15078. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  15079. (if (>= level last-level)
  15080. (push (cons head m) (aref subs level))
  15081. (push (cons head (aref subs (1+ level))) (aref subs level))
  15082. (loop for i from (1+ level) to n do (aset subs i nil)))
  15083. (setq last-level level)))))
  15084. (aref subs 1)))
  15085. (eval-after-load "imenu"
  15086. '(progn
  15087. (add-hook 'imenu-after-jump-hook
  15088. (lambda ()
  15089. (if (eq major-mode 'org-mode)
  15090. (org-show-context 'org-goto))))))
  15091. (defun org-link-display-format (link)
  15092. "Replace a link with either the description, or the link target
  15093. if no description is present"
  15094. (save-match-data
  15095. (if (string-match org-bracket-link-analytic-regexp link)
  15096. (replace-match (or (match-string 5 link)
  15097. (concat (match-string 1 link)
  15098. (match-string 3 link)))
  15099. nil nil link)
  15100. link)))
  15101. ;; Speedbar support
  15102. (defvar org-speedbar-restriction-lock-overlay (org-make-overlay 1 1)
  15103. "Overlay marking the agenda restriction line in speedbar.")
  15104. (org-overlay-put org-speedbar-restriction-lock-overlay
  15105. 'face 'org-agenda-restriction-lock)
  15106. (org-overlay-put org-speedbar-restriction-lock-overlay
  15107. 'help-echo "Agendas are currently limited to this item.")
  15108. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  15109. (defun org-speedbar-set-agenda-restriction ()
  15110. "Restrict future agenda commands to the location at point in speedbar.
  15111. To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
  15112. (interactive)
  15113. (require 'org-agenda)
  15114. (let (p m tp np dir txt)
  15115. (cond
  15116. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  15117. 'org-imenu t))
  15118. (setq m (get-text-property p 'org-imenu-marker))
  15119. (save-excursion
  15120. (save-restriction
  15121. (set-buffer (marker-buffer m))
  15122. (goto-char m)
  15123. (org-agenda-set-restriction-lock 'subtree))))
  15124. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  15125. 'speedbar-function 'speedbar-find-file))
  15126. (setq tp (previous-single-property-change
  15127. (1+ p) 'speedbar-function)
  15128. np (next-single-property-change
  15129. tp 'speedbar-function)
  15130. dir (speedbar-line-directory)
  15131. txt (buffer-substring-no-properties (or tp (point-min))
  15132. (or np (point-max))))
  15133. (save-excursion
  15134. (save-restriction
  15135. (set-buffer (find-file-noselect
  15136. (let ((default-directory dir))
  15137. (expand-file-name txt))))
  15138. (unless (org-mode-p)
  15139. (error "Cannot restrict to non-Org-mode file"))
  15140. (org-agenda-set-restriction-lock 'file))))
  15141. (t (error "Don't know how to restrict Org-mode's agenda")))
  15142. (org-move-overlay org-speedbar-restriction-lock-overlay
  15143. (point-at-bol) (point-at-eol))
  15144. (setq current-prefix-arg nil)
  15145. (org-agenda-maybe-redo)))
  15146. (eval-after-load "speedbar"
  15147. '(progn
  15148. (speedbar-add-supported-extension ".org")
  15149. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  15150. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  15151. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  15152. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  15153. (add-hook 'speedbar-visiting-tag-hook
  15154. (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
  15155. ;;; Fixes and Hacks for problems with other packages
  15156. ;; Make flyspell not check words in links, to not mess up our keymap
  15157. (defun org-mode-flyspell-verify ()
  15158. "Don't let flyspell put overlays at active buttons."
  15159. (not (get-text-property (point) 'keymap)))
  15160. ;; Make `bookmark-jump' show the jump location if it was hidden.
  15161. (eval-after-load "bookmark"
  15162. '(if (boundp 'bookmark-after-jump-hook)
  15163. ;; We can use the hook
  15164. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  15165. ;; Hook not available, use advice
  15166. (defadvice bookmark-jump (after org-make-visible activate)
  15167. "Make the position visible."
  15168. (org-bookmark-jump-unhide))))
  15169. ;; Make sure saveplace show the location if it was hidden
  15170. (eval-after-load "saveplace"
  15171. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  15172. "Make the position visible."
  15173. (org-bookmark-jump-unhide)))
  15174. (defun org-bookmark-jump-unhide ()
  15175. "Unhide the current position, to show the bookmark location."
  15176. (and (org-mode-p)
  15177. (or (org-invisible-p)
  15178. (save-excursion (goto-char (max (point-min) (1- (point))))
  15179. (org-invisible-p)))
  15180. (org-show-context 'bookmark-jump)))
  15181. ;; Make session.el ignore our circular variable
  15182. (eval-after-load "session"
  15183. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  15184. ;;;; Experimental code
  15185. (defun org-closed-in-range ()
  15186. "Sparse tree of items closed in a certain time range.
  15187. Still experimental, may disappear in the future."
  15188. (interactive)
  15189. ;; Get the time interval from the user.
  15190. (let* ((time1 (time-to-seconds
  15191. (org-read-date nil 'to-time nil "Starting date: ")))
  15192. (time2 (time-to-seconds
  15193. (org-read-date nil 'to-time nil "End date:")))
  15194. ;; callback function
  15195. (callback (lambda ()
  15196. (let ((time
  15197. (time-to-seconds
  15198. (apply 'encode-time
  15199. (org-parse-time-string
  15200. (match-string 1))))))
  15201. ;; check if time in interval
  15202. (and (>= time time1) (<= time time2))))))
  15203. ;; make tree, check each match with the callback
  15204. (org-occur "CLOSED: +\\[\\(.*?\\)\\]" nil callback)))
  15205. ;;;; Finish up
  15206. (provide 'org)
  15207. (run-hooks 'org-load-hook)
  15208. ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
  15209. ;;; org.el ends here