org.el 677 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171
  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.34trans
  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-src)
  86. (require 'org-footnote)
  87. ;;;; Customization variables
  88. ;;; Version
  89. (defconst org-version "6.34trans"
  90. "The version number of the file org.el.")
  91. (defun org-version (&optional here)
  92. "Show the org-mode version in the echo area.
  93. With prefix arg HERE, insert it at point."
  94. (interactive "P")
  95. (let* ((origin default-directory)
  96. (version org-version)
  97. (git-version)
  98. (dir (concat (file-name-directory (locate-library "org")) "../" )))
  99. (when (and (file-exists-p (expand-file-name ".git" dir))
  100. (executable-find "git"))
  101. (unwind-protect
  102. (progn
  103. (cd dir)
  104. (when (eql 0 (shell-command "git describe --abbrev=4 HEAD"))
  105. (with-current-buffer "*Shell Command Output*"
  106. (goto-char (point-min))
  107. (setq git-version (buffer-substring (point) (point-at-eol))))
  108. (subst-char-in-string ?- ?. git-version t)
  109. (when (string-match "\\S-"
  110. (shell-command-to-string
  111. "git diff-index --name-only HEAD --"))
  112. (setq git-version (concat git-version ".dirty")))
  113. (setq version (concat version " (" git-version ")"))))
  114. (cd origin)))
  115. (setq version (format "Org-mode version %s" version))
  116. (if here (insert version))
  117. (message version)))
  118. ;;; Compatibility constants
  119. ;;; The custom variables
  120. (defgroup org nil
  121. "Outline-based notes management and organizer."
  122. :tag "Org"
  123. :group 'outlines
  124. :group 'hypermedia
  125. :group 'calendar)
  126. (defcustom org-mode-hook nil
  127. "Mode hook for Org-mode, run after the mode was turned on."
  128. :group 'org
  129. :type 'hook)
  130. (defcustom org-load-hook nil
  131. "Hook that is run after org.el has been loaded."
  132. :group 'org
  133. :type 'hook)
  134. (defvar org-modules) ; defined below
  135. (defvar org-modules-loaded nil
  136. "Have the modules been loaded already?")
  137. (defun org-load-modules-maybe (&optional force)
  138. "Load all extensions listed in `org-modules'."
  139. (when (or force (not org-modules-loaded))
  140. (mapc (lambda (ext)
  141. (condition-case nil (require ext)
  142. (error (message "Problems while trying to load feature `%s'" ext))))
  143. org-modules)
  144. (setq org-modules-loaded t)))
  145. (defun org-set-modules (var value)
  146. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  147. (set var value)
  148. (when (featurep 'org)
  149. (org-load-modules-maybe 'force)))
  150. (when (org-bound-and-true-p org-modules)
  151. (let ((a (member 'org-infojs org-modules)))
  152. (and a (setcar a 'org-jsinfo))))
  153. (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
  154. "Modules that should always be loaded together with org.el.
  155. If a description starts with <C>, the file is not part of Emacs
  156. and loading it will require that you have downloaded and properly installed
  157. the org-mode distribution.
  158. You can also use this system to load external packages (i.e. neither Org
  159. core modules, nor modules from the CONTRIB directory). Just add symbols
  160. to the end of the list. If the package is called org-xyz.el, then you need
  161. to add the symbol `xyz', and the package must have a call to
  162. (provide 'org-xyz)"
  163. :group 'org
  164. :set 'org-set-modules
  165. :type
  166. '(set :greedy t
  167. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  168. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  169. (const :tag " crypt: Encryption of subtrees" org-crypt)
  170. (const :tag " ctags: Access to Emacs tags with links" org-ctags)
  171. (const :tag " docview: Links to doc-view buffers" org-docview)
  172. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  173. (const :tag " id: Global IDs for identifying entries" org-id)
  174. (const :tag " info: Links to Info nodes" org-info)
  175. (const :tag " jsinfo: Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
  176. (const :tag " habit: Track your consistency with habits" org-habit)
  177. (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
  178. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  179. (const :tag " mac-message: Links to messages in Apple Mail" org-mac-message)
  180. (const :tag " mew Links to Mew folders/messages" org-mew)
  181. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  182. (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
  183. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  184. (const :tag " vm: Links to VM folders/messages" org-vm)
  185. (const :tag " wl: Links to Wanderlust folders/messages" org-wl)
  186. (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
  187. (const :tag " mouse: Additional mouse support" org-mouse)
  188. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  189. (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
  190. (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
  191. (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
  192. (const :tag "C collector: Collect properties into tables" org-collector)
  193. (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
  194. (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
  195. (const :tag "C eval: Include command output as text" org-eval)
  196. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  197. (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
  198. (const :tag "C exp-bibtex: Export citations using BibTeX" org-exp-bibtex)
  199. (const :tag "C git-link: Provide org links to specific file version" org-git-link)
  200. (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
  201. (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
  202. (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
  203. (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
  204. (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
  205. (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
  206. (const :tag "C man: Support for links to manpages in Org-mode" org-man)
  207. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  208. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  209. (const :tag "C R: Computation using the R language" org-R)
  210. (const :tag "C registry: A registry for Org-mode links" org-registry)
  211. (const :tag "C org2rem: Convert org appointments into reminders" org2rem)
  212. (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
  213. (const :tag "C secretary: Team management with org-mode" org-secretary)
  214. (const :tag "C special-blocks: Turn blocks into LaTeX envs and HTML divs" org-special-blocks)
  215. (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
  216. (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
  217. (const :tag "C track: Keep up with Org-mode development" org-track)
  218. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  219. (defcustom org-support-shift-select nil
  220. "Non-nil means make shift-cursor commands select text when possible.
  221. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
  222. selecting a region, or enlarge thusly regions started in this way.
  223. In Org-mode, in special contexts, these same keys are used for other
  224. purposes, important enough to compete with shift selection. Org tries
  225. to balance these needs by supporting `shift-select-mode' outside these
  226. special contexts, under control of this variable.
  227. The default of this variable is nil, to avoid confusing behavior. Shifted
  228. cursor keys will then execute Org commands in the following contexts:
  229. - on a headline, changing TODO state (left/right) and priority (up/down)
  230. - on a time stamp, changing the time
  231. - in a plain list item, changing the bullet type
  232. - in a property definition line, switching between allowed values
  233. - in the BEGIN line of a clock table (changing the time block).
  234. Outside these contexts, the commands will throw an error.
  235. When this variable is t and the cursor is not in a special context,
  236. Org-mode will support shift-selection for making and enlarging regions.
  237. To make this more effective, the bullet cycling will no longer happen
  238. anywhere in an item line, but only if the cursor is exactly on the bullet.
  239. If you set this variable to the symbol `always', then the keys
  240. will not be special in headlines, property lines, and item lines, to make
  241. shift selection work there as well. If this is what you want, you can
  242. use the following alternative commands: `C-c C-t' and `C-c ,' to
  243. change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
  244. TODO sets, `C-c -' to cycle item bullet types, and properties can be
  245. edited by hand or in column view.
  246. However, when the cursor is on a timestamp, shift-cursor commands
  247. will still edit the time stamp - this is just too good to give up.
  248. XEmacs user should have this variable set to nil, because shift-select-mode
  249. is Emacs 23 only."
  250. :group 'org
  251. :type '(choice
  252. (const :tag "Never" nil)
  253. (const :tag "When outside special context" t)
  254. (const :tag "Everywhere except timestamps" always)))
  255. (defgroup org-startup nil
  256. "Options concerning startup of Org-mode."
  257. :tag "Org Startup"
  258. :group 'org)
  259. (defcustom org-startup-folded t
  260. "Non-nil means entering Org-mode will switch to OVERVIEW.
  261. This can also be configured on a per-file basis by adding one of
  262. the following lines anywhere in the buffer:
  263. #+STARTUP: fold (or `overview', this is equivalent)
  264. #+STARTUP: nofold (or `showall', this is equivalent)
  265. #+STARTUP: content
  266. #+STARTUP: showeverything"
  267. :group 'org-startup
  268. :type '(choice
  269. (const :tag "nofold: show all" nil)
  270. (const :tag "fold: overview" t)
  271. (const :tag "content: all headlines" content)
  272. (const :tag "show everything, even drawers" showeverything)))
  273. (defcustom org-startup-truncated t
  274. "Non-nil means entering Org-mode will set `truncate-lines'.
  275. This is useful since some lines containing links can be very long and
  276. uninteresting. Also tables look terrible when wrapped."
  277. :group 'org-startup
  278. :type 'boolean)
  279. (defcustom org-startup-indented nil
  280. "Non-nil means turn on `org-indent-mode' on startup.
  281. This can also be configured on a per-file basis by adding one of
  282. the following lines anywhere in the buffer:
  283. #+STARTUP: indent
  284. #+STARTUP: noindent"
  285. :group 'org-structure
  286. :type '(choice
  287. (const :tag "Not" nil)
  288. (const :tag "Globally (slow on startup in large files)" t)))
  289. (defcustom org-startup-with-beamer-mode nil
  290. "Non-nil means turn on `org-beamer-mode' on startup.
  291. This can also be configured on a per-file basis by adding one of
  292. the following lines anywhere in the buffer:
  293. #+STARTUP: beamer"
  294. :group 'org-startup
  295. :type 'boolean)
  296. (defcustom org-startup-align-all-tables nil
  297. "Non-nil means align all tables when visiting a file.
  298. This is useful when the column width in tables is forced with <N> cookies
  299. in table fields. Such tables will look correct only after the first re-align.
  300. This can also be configured on a per-file basis by adding one of
  301. the following lines anywhere in the buffer:
  302. #+STARTUP: align
  303. #+STARTUP: noalign"
  304. :group 'org-startup
  305. :type 'boolean)
  306. (defcustom org-insert-mode-line-in-empty-file nil
  307. "Non-nil means insert the first line setting Org-mode in empty files.
  308. When the function `org-mode' is called interactively in an empty file, this
  309. normally means that the file name does not automatically trigger Org-mode.
  310. To ensure that the file will always be in Org-mode in the future, a
  311. line enforcing Org-mode will be inserted into the buffer, if this option
  312. has been set."
  313. :group 'org-startup
  314. :type 'boolean)
  315. (defcustom org-replace-disputed-keys nil
  316. "Non-nil means use alternative key bindings for some keys.
  317. Org-mode uses S-<cursor> keys for changing timestamps and priorities.
  318. These keys are also used by other packages like shift-selection-mode'
  319. \(built into Emacs 23), `CUA-mode' or `windmove.el'.
  320. If you want to use Org-mode together with one of these other modes,
  321. or more generally if you would like to move some Org-mode commands to
  322. other keys, set this variable and configure the keys with the variable
  323. `org-disputed-keys'.
  324. This option is only relevant at load-time of Org-mode, and must be set
  325. *before* org.el is loaded. Changing it requires a restart of Emacs to
  326. become effective."
  327. :group 'org-startup
  328. :type 'boolean)
  329. (defcustom org-use-extra-keys nil
  330. "Non-nil means use extra key sequence definitions for certain
  331. commands. This happens automatically if you run XEmacs or if
  332. window-system is nil. This variable lets you do the same
  333. manually. You must set it before loading org.
  334. Example: on Carbon Emacs 22 running graphically, with an external
  335. keyboard on a Powerbook, the default way of setting M-left might
  336. not work for either Alt or ESC. Setting this variable will make
  337. it work for ESC."
  338. :group 'org-startup
  339. :type 'boolean)
  340. (if (fboundp 'defvaralias)
  341. (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys))
  342. (defcustom org-disputed-keys
  343. '(([(shift up)] . [(meta p)])
  344. ([(shift down)] . [(meta n)])
  345. ([(shift left)] . [(meta -)])
  346. ([(shift right)] . [(meta +)])
  347. ([(control shift right)] . [(meta shift +)])
  348. ([(control shift left)] . [(meta shift -)]))
  349. "Keys for which Org-mode and other modes compete.
  350. This is an alist, cars are the default keys, second element specifies
  351. the alternative to use when `org-replace-disputed-keys' is t.
  352. Keys can be specified in any syntax supported by `define-key'.
  353. The value of this option takes effect only at Org-mode's startup,
  354. therefore you'll have to restart Emacs to apply it after changing."
  355. :group 'org-startup
  356. :type 'alist)
  357. (defun org-key (key)
  358. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  359. Or return the original if not disputed."
  360. (if org-replace-disputed-keys
  361. (let* ((nkey (key-description key))
  362. (x (org-find-if (lambda (x)
  363. (equal (key-description (car x)) nkey))
  364. org-disputed-keys)))
  365. (if x (cdr x) key))
  366. key))
  367. (defun org-find-if (predicate seq)
  368. (catch 'exit
  369. (while seq
  370. (if (funcall predicate (car seq))
  371. (throw 'exit (car seq))
  372. (pop seq)))))
  373. (defun org-defkey (keymap key def)
  374. "Define a key, possibly translated, as returned by `org-key'."
  375. (define-key keymap (org-key key) def))
  376. (defcustom org-ellipsis nil
  377. "The ellipsis to use in the Org-mode outline.
  378. When nil, just use the standard three dots. When a string, use that instead,
  379. When a face, use the standard 3 dots, but with the specified face.
  380. The change affects only Org-mode (which will then use its own display table).
  381. Changing this requires executing `M-x org-mode' in a buffer to become
  382. effective."
  383. :group 'org-startup
  384. :type '(choice (const :tag "Default" nil)
  385. (face :tag "Face" :value org-warning)
  386. (string :tag "String" :value "...#")))
  387. (defvar org-display-table nil
  388. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  389. (defgroup org-keywords nil
  390. "Keywords in Org-mode."
  391. :tag "Org Keywords"
  392. :group 'org)
  393. (defcustom org-deadline-string "DEADLINE:"
  394. "String to mark deadline entries.
  395. A deadline is this string, followed by a time stamp. Should be a word,
  396. terminated by a colon. You can insert a schedule keyword and
  397. a timestamp with \\[org-deadline].
  398. Changes become only effective after restarting Emacs."
  399. :group 'org-keywords
  400. :type 'string)
  401. (defcustom org-scheduled-string "SCHEDULED:"
  402. "String to mark scheduled TODO entries.
  403. A schedule is this string, followed by a time stamp. Should be a word,
  404. terminated by a colon. You can insert a schedule keyword and
  405. a timestamp with \\[org-schedule].
  406. Changes become only effective after restarting Emacs."
  407. :group 'org-keywords
  408. :type 'string)
  409. (defcustom org-closed-string "CLOSED:"
  410. "String used as the prefix for timestamps logging closing a TODO entry."
  411. :group 'org-keywords
  412. :type 'string)
  413. (defcustom org-clock-string "CLOCK:"
  414. "String used as prefix for timestamps clocking work hours on an item."
  415. :group 'org-keywords
  416. :type 'string)
  417. (defcustom org-comment-string "COMMENT"
  418. "Entries starting with this keyword will never be exported.
  419. An entry can be toggled between COMMENT and normal with
  420. \\[org-toggle-comment].
  421. Changes become only effective after restarting Emacs."
  422. :group 'org-keywords
  423. :type 'string)
  424. (defcustom org-quote-string "QUOTE"
  425. "Entries starting with this keyword will be exported in fixed-width font.
  426. Quoting applies only to the text in the entry following the headline, and does
  427. not extend beyond the next headline, even if that is lower level.
  428. An entry can be toggled between QUOTE and normal with
  429. \\[org-toggle-fixed-width-section]."
  430. :group 'org-keywords
  431. :type 'string)
  432. (defconst org-repeat-re
  433. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)"
  434. "Regular expression for specifying repeated events.
  435. After a match, group 1 contains the repeat expression.")
  436. (defgroup org-structure nil
  437. "Options concerning the general structure of Org-mode files."
  438. :tag "Org Structure"
  439. :group 'org)
  440. (defgroup org-reveal-location nil
  441. "Options about how to make context of a location visible."
  442. :tag "Org Reveal Location"
  443. :group 'org-structure)
  444. (defconst org-context-choice
  445. '(choice
  446. (const :tag "Always" t)
  447. (const :tag "Never" nil)
  448. (repeat :greedy t :tag "Individual contexts"
  449. (cons
  450. (choice :tag "Context"
  451. (const agenda)
  452. (const org-goto)
  453. (const occur-tree)
  454. (const tags-tree)
  455. (const link-search)
  456. (const mark-goto)
  457. (const bookmark-jump)
  458. (const isearch)
  459. (const default))
  460. (boolean))))
  461. "Contexts for the reveal options.")
  462. (defcustom org-show-hierarchy-above '((default . t))
  463. "Non-nil means show full hierarchy when revealing a location.
  464. Org-mode often shows locations in an org-mode file which might have
  465. been invisible before. When this is set, the hierarchy of headings
  466. above the exposed location is shown.
  467. Turning this off for example for sparse trees makes them very compact.
  468. Instead of t, this can also be an alist specifying this option for different
  469. contexts. Valid contexts are
  470. agenda when exposing an entry from the agenda
  471. org-goto when using the command `org-goto' on key C-c C-j
  472. occur-tree when using the command `org-occur' on key C-c /
  473. tags-tree when constructing a sparse tree based on tags matches
  474. link-search when exposing search matches associated with a link
  475. mark-goto when exposing the jump goal of a mark
  476. bookmark-jump when exposing a bookmark location
  477. isearch when exiting from an incremental search
  478. default default for all contexts not set explicitly"
  479. :group 'org-reveal-location
  480. :type org-context-choice)
  481. (defcustom org-show-following-heading '((default . nil))
  482. "Non-nil means show following heading when revealing a location.
  483. Org-mode often shows locations in an org-mode file which might have
  484. been invisible before. When this is set, the heading following the
  485. match is shown.
  486. Turning this off for example for sparse trees makes them very compact,
  487. but makes it harder to edit the location of the match. In such a case,
  488. use the command \\[org-reveal] to show more context.
  489. Instead of t, this can also be an alist specifying this option for different
  490. contexts. See `org-show-hierarchy-above' for valid contexts."
  491. :group 'org-reveal-location
  492. :type org-context-choice)
  493. (defcustom org-show-siblings '((default . nil) (isearch t))
  494. "Non-nil means show all sibling heading when revealing a location.
  495. Org-mode often shows locations in an org-mode file which might have
  496. been invisible before. When this is set, the sibling of the current entry
  497. heading are all made visible. If `org-show-hierarchy-above' is t,
  498. the same happens on each level of the hierarchy above the current entry.
  499. By default this is on for the isearch context, off for all other contexts.
  500. Turning this off for example for sparse trees makes them very compact,
  501. but makes it harder to edit the location of the match. In such a case,
  502. use the command \\[org-reveal] to show more context.
  503. Instead of t, this can also be an alist specifying this option for different
  504. contexts. See `org-show-hierarchy-above' for valid contexts."
  505. :group 'org-reveal-location
  506. :type org-context-choice)
  507. (defcustom org-show-entry-below '((default . nil))
  508. "Non-nil means show the entry below a headline when revealing a location.
  509. Org-mode often shows locations in an org-mode file which might have
  510. been invisible before. When this is set, the text below the headline that is
  511. exposed is also shown.
  512. By default this is off for all contexts.
  513. Instead of t, this can also be an alist specifying this option for different
  514. contexts. See `org-show-hierarchy-above' for valid contexts."
  515. :group 'org-reveal-location
  516. :type org-context-choice)
  517. (defcustom org-indirect-buffer-display 'other-window
  518. "How should indirect tree buffers be displayed?
  519. This applies to indirect buffers created with the commands
  520. \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
  521. Valid values are:
  522. current-window Display in the current window
  523. other-window Just display in another window.
  524. dedicated-frame Create one new frame, and re-use it each time.
  525. new-frame Make a new frame each time. Note that in this case
  526. previously-made indirect buffers are kept, and you need to
  527. kill these buffers yourself."
  528. :group 'org-structure
  529. :group 'org-agenda-windows
  530. :type '(choice
  531. (const :tag "In current window" current-window)
  532. (const :tag "In current frame, other window" other-window)
  533. (const :tag "Each time a new frame" new-frame)
  534. (const :tag "One dedicated frame" dedicated-frame)))
  535. (defcustom org-use-speed-commands nil
  536. "Non-nil means activate single letter commands at beginning of a headline.
  537. This may also be a function to test for appropriate locations where speed
  538. commands should be active."
  539. :group 'org-structure
  540. :type '(choice
  541. (const :tag "Never" nil)
  542. (const :tag "At beginning of headline stars" t)
  543. (function)))
  544. (defcustom org-speed-commands-user nil
  545. "Alist of additional speed commands.
  546. This list will be checked before `org-speed-commands-default'
  547. when the variable `org-use-speed-commands' is non-nil
  548. and when the cursor is at the beginning of a headline.
  549. The car if each entry is a string with a single letter, which must
  550. be assigned to `self-insert-command' in the global map.
  551. The cdr is either a command to be called interactively, a function
  552. to be called, or a form to be evaluated.
  553. An entry that is just a list with a single string will be interpreted
  554. as a descriptive headline that will be added when listing the speed
  555. copmmands in the Help buffer using the `?' speed command."
  556. :group 'org-structure
  557. :type '(repeat :value ("k" . ignore)
  558. (choice :value ("k" . ignore)
  559. (list :tag "Descriptive Headline" (string :tag "Headline"))
  560. (cons :tag "Letter and Command"
  561. (string :tag "Command letter")
  562. (choice
  563. (function)
  564. (sexp))))))
  565. (defgroup org-cycle nil
  566. "Options concerning visibility cycling in Org-mode."
  567. :tag "Org Cycle"
  568. :group 'org-structure)
  569. (defcustom org-cycle-skip-children-state-if-no-children t
  570. "Non-nil means skip CHILDREN state in entries that don't have any."
  571. :group 'org-cycle
  572. :type 'boolean)
  573. (defcustom org-cycle-max-level nil
  574. "Maximum level which should still be subject to visibility cycling.
  575. Levels higher than this will, for cycling, be treated as text, not a headline.
  576. When `org-odd-levels-only' is set, a value of N in this variable actually
  577. means 2N-1 stars as the limiting headline.
  578. When nil, cycle all levels.
  579. Note that the limiting level of cycling is also influenced by
  580. `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
  581. `org-inlinetask-min-level' is, cycling will be limited to levels one less
  582. than its value."
  583. :group 'org-cycle
  584. :type '(choice
  585. (const :tag "No limit" nil)
  586. (integer :tag "Maximum level")))
  587. (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK")
  588. "Names of drawers. Drawers are not opened by cycling on the headline above.
  589. Drawers only open with a TAB on the drawer line itself. A drawer looks like
  590. this:
  591. :DRAWERNAME:
  592. .....
  593. :END:
  594. The drawer \"PROPERTIES\" is special for capturing properties through
  595. the property API.
  596. Drawers can be defined on the per-file basis with a line like:
  597. #+DRAWERS: HIDDEN STATE PROPERTIES"
  598. :group 'org-structure
  599. :group 'org-cycle
  600. :type '(repeat (string :tag "Drawer Name")))
  601. (defcustom org-hide-block-startup nil
  602. "Non-nil means entering Org-mode will fold all blocks.
  603. This can also be set in on a per-file basis with
  604. #+STARTUP: hideblocks
  605. #+STARTUP: showblocks"
  606. :group 'org-startup
  607. :group 'org-cycle
  608. :type 'boolean)
  609. (defcustom org-cycle-global-at-bob nil
  610. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  611. This makes it possible to do global cycling without having to use S-TAB or
  612. C-u TAB. For this special case to work, the first line of the buffer
  613. must not be a headline - it may be empty or some other text. When used in
  614. this way, `org-cycle-hook' is disables temporarily, to make sure the
  615. cursor stays at the beginning of the buffer.
  616. When this option is nil, don't do anything special at the beginning
  617. of the buffer."
  618. :group 'org-cycle
  619. :type 'boolean)
  620. (defcustom org-cycle-level-after-item/entry-creation t
  621. "Non-nil means cycle entry level or item indentation in new empty entries.
  622. When the cursor is at the end of an empty headline, i.e with only stars
  623. and maybe a TODO keyword, TAB will then switch the entry to become a child,
  624. and then all possible anchestor states, before returning to the original state.
  625. This makes data entry extremely fast: M-RET to create a new headline,
  626. on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
  627. When the cursor is at the end of an empty plain list item, one TAB will
  628. make it a subitem, two or more tabs will back up to make this an item
  629. higher up in the item hierarchy."
  630. :group 'org-cycle
  631. :type 'boolean)
  632. (defcustom org-cycle-emulate-tab t
  633. "Where should `org-cycle' emulate TAB.
  634. nil Never
  635. white Only in completely white lines
  636. whitestart Only at the beginning of lines, before the first non-white char
  637. t Everywhere except in headlines
  638. exc-hl-bol Everywhere except at the start of a headline
  639. If TAB is used in a place where it does not emulate TAB, the current subtree
  640. visibility is cycled."
  641. :group 'org-cycle
  642. :type '(choice (const :tag "Never" nil)
  643. (const :tag "Only in completely white lines" white)
  644. (const :tag "Before first char in a line" whitestart)
  645. (const :tag "Everywhere except in headlines" t)
  646. (const :tag "Everywhere except at bol in headlines" exc-hl-bol)
  647. ))
  648. (defcustom org-cycle-separator-lines 2
  649. "Number of empty lines needed to keep an empty line between collapsed trees.
  650. If you leave an empty line between the end of a subtree and the following
  651. headline, this empty line is hidden when the subtree is folded.
  652. Org-mode will leave (exactly) one empty line visible if the number of
  653. empty lines is equal or larger to the number given in this variable.
  654. So the default 2 means at least 2 empty lines after the end of a subtree
  655. are needed to produce free space between a collapsed subtree and the
  656. following headline.
  657. If the number is negative, and the number of empty lines is at least -N,
  658. all empty lines are shown.
  659. Special case: when 0, never leave empty lines in collapsed view."
  660. :group 'org-cycle
  661. :type 'integer)
  662. (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
  663. (defcustom org-pre-cycle-hook nil
  664. "Hook that is run before visibility cycling is happening.
  665. The function(s) in this hook must accept a single argument which indicates
  666. the new state that will be set right after running this hook. The
  667. argument is a symbol. Before a global state change, it can have the values
  668. `overview', `content', or `all'. Before a local state change, it can have
  669. the values `folded', `children', or `subtree'."
  670. :group 'org-cycle
  671. :type 'hook)
  672. (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
  673. org-cycle-hide-drawers
  674. org-cycle-show-empty-lines
  675. org-optimize-window-after-visibility-change)
  676. "Hook that is run after `org-cycle' has changed the buffer visibility.
  677. The function(s) in this hook must accept a single argument which indicates
  678. the new state that was set by the most recent `org-cycle' command. The
  679. argument is a symbol. After a global state change, it can have the values
  680. `overview', `content', or `all'. After a local state change, it can have
  681. the values `folded', `children', or `subtree'."
  682. :group 'org-cycle
  683. :type 'hook)
  684. (defgroup org-edit-structure nil
  685. "Options concerning structure editing in Org-mode."
  686. :tag "Org Edit Structure"
  687. :group 'org-structure)
  688. (defcustom org-odd-levels-only nil
  689. "Non-nil means skip even levels and only use odd levels for the outline.
  690. This has the effect that two stars are being added/taken away in
  691. promotion/demotion commands. It also influences how levels are
  692. handled by the exporters.
  693. Changing it requires restart of `font-lock-mode' to become effective
  694. for fontification also in regions already fontified.
  695. You may also set this on a per-file basis by adding one of the following
  696. lines to the buffer:
  697. #+STARTUP: odd
  698. #+STARTUP: oddeven"
  699. :group 'org-edit-structure
  700. :group 'org-font-lock
  701. :type 'boolean)
  702. (defcustom org-adapt-indentation t
  703. "Non-nil means adapt indentation to outline node level.
  704. When this variable is set, Org assumes that you write outlines by
  705. indenting text in each node to align with the headline (after the stars).
  706. The following issues are influenced by this variable:
  707. - When this is set and the *entire* text in an entry is indented, the
  708. indentation is increased by one space in a demotion command, and
  709. decreased by one in a promotion command. If any line in the entry
  710. body starts with text at column 0, indentation is not changed at all.
  711. - Property drawers and planning information is inserted indented when
  712. this variable s set. When nil, they will not be indented.
  713. - TAB indents a line relative to context. The lines below a headline
  714. will be indented when this variable is set.
  715. Note that this is all about true indentation, by adding and removing
  716. space characters. See also `org-indent.el' which does level-dependent
  717. indentation in a virtual way, i.e. at display time in Emacs."
  718. :group 'org-edit-structure
  719. :type 'boolean)
  720. (defcustom org-special-ctrl-a/e nil
  721. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  722. When t, `C-a' will bring back the cursor to the beginning of the
  723. headline text, i.e. after the stars and after a possible TODO keyword.
  724. In an item, this will be the position after the bullet.
  725. When the cursor is already at that position, another `C-a' will bring
  726. it to the beginning of the line.
  727. `C-e' will jump to the end of the headline, ignoring the presence of tags
  728. in the headline. A second `C-e' will then jump to the true end of the
  729. line, after any tags. This also means that, when this variable is
  730. non-nil, `C-e' also will never jump beyond the end of the heading of a
  731. folded section, i.e. not after the ellipses.
  732. When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
  733. going to the true line boundary first. Only a directly following, identical
  734. keypress will bring the cursor to the special positions.
  735. This may also be a cons cell where the behavior for `C-a' and `C-e' is
  736. set separately."
  737. :group 'org-edit-structure
  738. :type '(choice
  739. (const :tag "off" nil)
  740. (const :tag "on: after stars/bullet and before tags first" t)
  741. (const :tag "reversed: true line boundary first" reversed)
  742. (cons :tag "Set C-a and C-e separately"
  743. (choice :tag "Special C-a"
  744. (const :tag "off" nil)
  745. (const :tag "on: after stars/bullet first" t)
  746. (const :tag "reversed: before stars/bullet first" reversed))
  747. (choice :tag "Special C-e"
  748. (const :tag "off" nil)
  749. (const :tag "on: before tags first" t)
  750. (const :tag "reversed: after tags first" reversed)))))
  751. (if (fboundp 'defvaralias)
  752. (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
  753. (defcustom org-special-ctrl-k nil
  754. "Non-nil means `C-k' will behave specially in headlines.
  755. When nil, `C-k' will call the default `kill-line' command.
  756. When t, the following will happen while the cursor is in the headline:
  757. - When the cursor is at the beginning of a headline, kill the entire
  758. line and possible the folded subtree below the line.
  759. - When in the middle of the headline text, kill the headline up to the tags.
  760. - When after the headline text, kill the tags."
  761. :group 'org-edit-structure
  762. :type 'boolean)
  763. (defcustom org-yank-folded-subtrees t
  764. "Non-nil means when yanking subtrees, fold them.
  765. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  766. it starts with a heading and all other headings in it are either children
  767. or siblings, then fold all the subtrees. However, do this only if no
  768. text after the yank would be swallowed into a folded tree by this action."
  769. :group 'org-edit-structure
  770. :type 'boolean)
  771. (defcustom org-yank-adjusted-subtrees nil
  772. "Non-nil means when yanking subtrees, adjust the level.
  773. With this setting, `org-paste-subtree' is used to insert the subtree, see
  774. this function for details."
  775. :group 'org-edit-structure
  776. :type 'boolean)
  777. (defcustom org-M-RET-may-split-line '((default . t))
  778. "Non-nil means M-RET will split the line at the cursor position.
  779. When nil, it will go to the end of the line before making a
  780. new line.
  781. You may also set this option in a different way for different
  782. contexts. Valid contexts are:
  783. headline when creating a new headline
  784. item when creating a new item
  785. table in a table field
  786. default the value to be used for all contexts not explicitly
  787. customized"
  788. :group 'org-structure
  789. :group 'org-table
  790. :type '(choice
  791. (const :tag "Always" t)
  792. (const :tag "Never" nil)
  793. (repeat :greedy t :tag "Individual contexts"
  794. (cons
  795. (choice :tag "Context"
  796. (const headline)
  797. (const item)
  798. (const table)
  799. (const default))
  800. (boolean)))))
  801. (defcustom org-insert-heading-respect-content nil
  802. "Non-nil means insert new headings after the current subtree.
  803. When nil, the new heading is created directly after the current line.
  804. The commands \\[org-insert-heading-respect-content] and
  805. \\[org-insert-todo-heading-respect-content] turn this variable on
  806. for the duration of the command."
  807. :group 'org-structure
  808. :type 'boolean)
  809. (defcustom org-blank-before-new-entry '((heading . auto)
  810. (plain-list-item . auto))
  811. "Should `org-insert-heading' leave a blank line before new heading/item?
  812. The value is an alist, with `heading' and `plain-list-item' as car,
  813. and a boolean flag as cdr. For plain lists, if the variable
  814. `org-empty-line-terminates-plain-lists' is set, the setting here
  815. is ignored and no empty line is inserted, to keep the list in tact."
  816. :group 'org-edit-structure
  817. :type '(list
  818. (cons (const heading)
  819. (choice (const :tag "Never" nil)
  820. (const :tag "Always" t)
  821. (const :tag "Auto" auto)))
  822. (cons (const plain-list-item)
  823. (choice (const :tag "Never" nil)
  824. (const :tag "Always" t)
  825. (const :tag "Auto" auto)))))
  826. (defcustom org-insert-heading-hook nil
  827. "Hook being run after inserting a new heading."
  828. :group 'org-edit-structure
  829. :type 'hook)
  830. (defcustom org-enable-fixed-width-editor t
  831. "Non-nil means lines starting with \":\" are treated as fixed-width.
  832. This currently only means they are never auto-wrapped.
  833. When nil, such lines will be treated like ordinary lines.
  834. See also the QUOTE keyword."
  835. :group 'org-edit-structure
  836. :type 'boolean)
  837. (defcustom org-goto-auto-isearch t
  838. "Non-nil means typing characters in org-goto starts incremental search."
  839. :group 'org-edit-structure
  840. :type 'boolean)
  841. (defgroup org-sparse-trees nil
  842. "Options concerning sparse trees in Org-mode."
  843. :tag "Org Sparse Trees"
  844. :group 'org-structure)
  845. (defcustom org-highlight-sparse-tree-matches t
  846. "Non-nil means highlight all matches that define a sparse tree.
  847. The highlights will automatically disappear the next time the buffer is
  848. changed by an edit command."
  849. :group 'org-sparse-trees
  850. :type 'boolean)
  851. (defcustom org-remove-highlights-with-change t
  852. "Non-nil means any change to the buffer will remove temporary highlights.
  853. Such highlights are created by `org-occur' and `org-clock-display'.
  854. When nil, `C-c C-c needs to be used to get rid of the highlights.
  855. The highlights created by `org-preview-latex-fragment' always need
  856. `C-c C-c' to be removed."
  857. :group 'org-sparse-trees
  858. :group 'org-time
  859. :type 'boolean)
  860. (defcustom org-occur-hook '(org-first-headline-recenter)
  861. "Hook that is run after `org-occur' has constructed a sparse tree.
  862. This can be used to recenter the window to show as much of the structure
  863. as possible."
  864. :group 'org-sparse-trees
  865. :type 'hook)
  866. (defgroup org-imenu-and-speedbar nil
  867. "Options concerning imenu and speedbar in Org-mode."
  868. :tag "Org Imenu and Speedbar"
  869. :group 'org-structure)
  870. (defcustom org-imenu-depth 2
  871. "The maximum level for Imenu access to Org-mode headlines.
  872. This also applied for speedbar access."
  873. :group 'org-imenu-and-speedbar
  874. :type 'integer)
  875. (defgroup org-table nil
  876. "Options concerning tables in Org-mode."
  877. :tag "Org Table"
  878. :group 'org)
  879. (defcustom org-enable-table-editor 'optimized
  880. "Non-nil means lines starting with \"|\" are handled by the table editor.
  881. When nil, such lines will be treated like ordinary lines.
  882. When equal to the symbol `optimized', the table editor will be optimized to
  883. do the following:
  884. - Automatic overwrite mode in front of whitespace in table fields.
  885. This makes the structure of the table stay in tact as long as the edited
  886. field does not exceed the column width.
  887. - Minimize the number of realigns. Normally, the table is aligned each time
  888. TAB or RET are pressed to move to another field. With optimization this
  889. happens only if changes to a field might have changed the column width.
  890. Optimization requires replacing the functions `self-insert-command',
  891. `delete-char', and `backward-delete-char' in Org-mode buffers, with a
  892. slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
  893. very good at guessing when a re-align will be necessary, but you can always
  894. force one with \\[org-ctrl-c-ctrl-c].
  895. If you would like to use the optimized version in Org-mode, but the
  896. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  897. This variable can be used to turn on and off the table editor during a session,
  898. but in order to toggle optimization, a restart is required.
  899. See also the variable `org-table-auto-blank-field'."
  900. :group 'org-table
  901. :type '(choice
  902. (const :tag "off" nil)
  903. (const :tag "on" t)
  904. (const :tag "on, optimized" optimized)))
  905. (defcustom org-self-insert-cluster-for-undo t
  906. "Non-nil means cluster self-insert commands for undo when possible.
  907. If this is set, then, like in the Emacs command loop, 20 consecutive
  908. characters will be undone together.
  909. This is configurable, because there is some impact on typing performance."
  910. :group 'org-table
  911. :type 'boolean)
  912. (defcustom org-table-tab-recognizes-table.el t
  913. "Non-nil means TAB will automatically notice a table.el table.
  914. When it sees such a table, it moves point into it and - if necessary -
  915. calls `table-recognize-table'."
  916. :group 'org-table-editing
  917. :type 'boolean)
  918. (defgroup org-link nil
  919. "Options concerning links in Org-mode."
  920. :tag "Org Link"
  921. :group 'org)
  922. (defvar org-link-abbrev-alist-local nil
  923. "Buffer-local version of `org-link-abbrev-alist', which see.
  924. The value of this is taken from the #+LINK lines.")
  925. (make-variable-buffer-local 'org-link-abbrev-alist-local)
  926. (defcustom org-link-abbrev-alist nil
  927. "Alist of link abbreviations.
  928. The car of each element is a string, to be replaced at the start of a link.
  929. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  930. links in Org-mode buffers can have an optional tag after a double colon, e.g.
  931. [[linkkey:tag][description]]
  932. The 'linkkey' must be a word word, starting with a letter, followed
  933. by letters, numbers, '-' or '_'.
  934. If REPLACE is a string, the tag will simply be appended to create the link.
  935. If the string contains \"%s\", the tag will be inserted there. Alternatively,
  936. the placeholder \"%h\" will cause a url-encoded version of the tag to
  937. be inserted at that point (see the function `url-hexify-string').
  938. REPLACE may also be a function that will be called with the tag as the
  939. only argument to create the link, which should be returned as a string.
  940. See the manual for examples."
  941. :group 'org-link
  942. :type '(repeat
  943. (cons
  944. (string :tag "Protocol")
  945. (choice
  946. (string :tag "Format")
  947. (function)))))
  948. (defcustom org-descriptive-links t
  949. "Non-nil means hide link part and only show description of bracket links.
  950. Bracket links are like [[link][description]]. This variable sets the initial
  951. state in new org-mode buffers. The setting can then be toggled on a
  952. per-buffer basis from the Org->Hyperlinks menu."
  953. :group 'org-link
  954. :type 'boolean)
  955. (defcustom org-link-file-path-type 'adaptive
  956. "How the path name in file links should be stored.
  957. Valid values are:
  958. relative Relative to the current directory, i.e. the directory of the file
  959. into which the link is being inserted.
  960. absolute Absolute path, if possible with ~ for home directory.
  961. noabbrev Absolute path, no abbreviation of home directory.
  962. adaptive Use relative path for files in the current directory and sub-
  963. directories of it. For other files, use an absolute path."
  964. :group 'org-link
  965. :type '(choice
  966. (const relative)
  967. (const absolute)
  968. (const noabbrev)
  969. (const adaptive)))
  970. (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
  971. "Types of links that should be activated in Org-mode files.
  972. This is a list of symbols, each leading to the activation of a certain link
  973. type. In principle, it does not hurt to turn on most link types - there may
  974. be a small gain when turning off unused link types. The types are:
  975. bracket The recommended [[link][description]] or [[link]] links with hiding.
  976. angular Links in angular brackets that may contain whitespace like
  977. <bbdb:Carsten Dominik>.
  978. plain Plain links in normal text, no whitespace, like http://google.com.
  979. radio Text that is matched by a radio target, see manual for details.
  980. tag Tag settings in a headline (link to tag search).
  981. date Time stamps (link to calendar).
  982. footnote Footnote labels.
  983. Changing this variable requires a restart of Emacs to become effective."
  984. :group 'org-link
  985. :type '(set :greedy t
  986. (const :tag "Double bracket links (new style)" bracket)
  987. (const :tag "Angular bracket links (old style)" angular)
  988. (const :tag "Plain text links" plain)
  989. (const :tag "Radio target matches" radio)
  990. (const :tag "Tags" tag)
  991. (const :tag "Timestamps" date)
  992. (const :tag "Footnotes" footnote)))
  993. (defcustom org-make-link-description-function nil
  994. "Function to use to generate link descriptions from links. If
  995. nil the link location will be used. This function must take two
  996. parameters; the first is the link and the second the description
  997. org-insert-link has generated, and should return the description
  998. to use."
  999. :group 'org-link
  1000. :type 'function)
  1001. (defgroup org-link-store nil
  1002. "Options concerning storing links in Org-mode."
  1003. :tag "Org Store Link"
  1004. :group 'org-link)
  1005. (defcustom org-email-link-description-format "Email %c: %.30s"
  1006. "Format of the description part of a link to an email or usenet message.
  1007. The following %-escapes will be replaced by corresponding information:
  1008. %F full \"From\" field
  1009. %f name, taken from \"From\" field, address if no name
  1010. %T full \"To\" field
  1011. %t first name in \"To\" field, address if no name
  1012. %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
  1013. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  1014. %s subject
  1015. %m message-id.
  1016. You may use normal field width specification between the % and the letter.
  1017. This is for example useful to limit the length of the subject.
  1018. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  1019. :group 'org-link-store
  1020. :type 'string)
  1021. (defcustom org-from-is-user-regexp
  1022. (let (r1 r2)
  1023. (when (and user-mail-address (not (string= user-mail-address "")))
  1024. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  1025. (when (and user-full-name (not (string= user-full-name "")))
  1026. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  1027. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  1028. "Regexp matched against the \"From:\" header of an email or usenet message.
  1029. It should match if the message is from the user him/herself."
  1030. :group 'org-link-store
  1031. :type 'regexp)
  1032. (defcustom org-link-to-org-use-id 'create-if-interactive-and-no-custom-id
  1033. "Non-nil means storing a link to an Org file will use entry IDs.
  1034. Note that before this variable is even considered, org-id must be loaded,
  1035. so please customize `org-modules' and turn it on.
  1036. The variable can have the following values:
  1037. t Create an ID if needed to make a link to the current entry.
  1038. create-if-interactive
  1039. If `org-store-link' is called directly (interactively, as a user
  1040. command), do create an ID to support the link. But when doing the
  1041. job for remember, only use the ID if it already exists. The
  1042. purpose of this setting is to avoid proliferation of unwanted
  1043. IDs, just because you happen to be in an Org file when you
  1044. call `org-remember' that automatically and preemptively
  1045. creates a link. If you do want to get an ID link in a remember
  1046. template to an entry not having an ID, create it first by
  1047. explicitly creating a link to it, using `C-c C-l' first.
  1048. create-if-interactive-and-no-custom-id
  1049. Like create-if-interactive, but do not create an ID if there is
  1050. a CUSTOM_ID property defined in the entry. This is the default.
  1051. use-existing
  1052. Use existing ID, do not create one.
  1053. nil Never use an ID to make a link, instead link using a text search for
  1054. the headline text."
  1055. :group 'org-link-store
  1056. :type '(choice
  1057. (const :tag "Create ID to make link" t)
  1058. (const :tag "Create if storing link interactively"
  1059. create-if-interactive)
  1060. (const :tag "Create if storing link interactively and no CUSTOM_ID is present"
  1061. create-if-interactive-and-no-custom-id)
  1062. (const :tag "Only use existing" use-existing)
  1063. (const :tag "Do not use ID to create link" nil)))
  1064. (defcustom org-context-in-file-links t
  1065. "Non-nil means file links from `org-store-link' contain context.
  1066. A search string will be added to the file name with :: as separator and
  1067. used to find the context when the link is activated by the command
  1068. `org-open-at-point'.
  1069. Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  1070. negates this setting for the duration of the command."
  1071. :group 'org-link-store
  1072. :type 'boolean)
  1073. (defcustom org-keep-stored-link-after-insertion nil
  1074. "Non-nil means keep link in list for entire session.
  1075. The command `org-store-link' adds a link pointing to the current
  1076. location to an internal list. These links accumulate during a session.
  1077. The command `org-insert-link' can be used to insert links into any
  1078. Org-mode file (offering completion for all stored links). When this
  1079. option is nil, every link which has been inserted once using \\[org-insert-link]
  1080. will be removed from the list, to make completing the unused links
  1081. more efficient."
  1082. :group 'org-link-store
  1083. :type 'boolean)
  1084. (defgroup org-link-follow nil
  1085. "Options concerning following links in Org-mode."
  1086. :tag "Org Follow Link"
  1087. :group 'org-link)
  1088. (defcustom org-link-translation-function nil
  1089. "Function to translate links with different syntax to Org syntax.
  1090. This can be used to translate links created for example by the Planner
  1091. or emacs-wiki packages to Org syntax.
  1092. The function must accept two parameters, a TYPE containing the link
  1093. protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
  1094. which is everything after the link protocol. It should return a cons
  1095. with possibly modified values of type and path.
  1096. Org contains a function for this, so if you set this variable to
  1097. `org-translate-link-from-planner', you should be able follow many
  1098. links created by planner."
  1099. :group 'org-link-follow
  1100. :type 'function)
  1101. (defcustom org-follow-link-hook nil
  1102. "Hook that is run after a link has been followed."
  1103. :group 'org-link-follow
  1104. :type 'hook)
  1105. (defcustom org-tab-follows-link nil
  1106. "Non-nil means on links TAB will follow the link.
  1107. Needs to be set before org.el is loaded.
  1108. This really should not be used, it does not make sense, and the
  1109. implementation is bad."
  1110. :group 'org-link-follow
  1111. :type 'boolean)
  1112. (defcustom org-return-follows-link nil
  1113. "Non-nil means on links RET will follow the link.
  1114. Needs to be set before org.el is loaded."
  1115. :group 'org-link-follow
  1116. :type 'boolean)
  1117. (defcustom org-mouse-1-follows-link
  1118. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  1119. "Non-nil means mouse-1 on a link will follow the link.
  1120. A longer mouse click will still set point. Does not work on XEmacs.
  1121. Needs to be set before org.el is loaded."
  1122. :group 'org-link-follow
  1123. :type 'boolean)
  1124. (defcustom org-mark-ring-length 4
  1125. "Number of different positions to be recorded in the ring
  1126. Changing this requires a restart of Emacs to work correctly."
  1127. :group 'org-link-follow
  1128. :type 'integer)
  1129. (defcustom org-link-frame-setup
  1130. '((vm . vm-visit-folder-other-frame)
  1131. (gnus . gnus-other-frame)
  1132. (file . find-file-other-window))
  1133. "Setup the frame configuration for following links.
  1134. When following a link with Emacs, it may often be useful to display
  1135. this link in another window or frame. This variable can be used to
  1136. set this up for the different types of links.
  1137. For VM, use any of
  1138. `vm-visit-folder'
  1139. `vm-visit-folder-other-frame'
  1140. For Gnus, use any of
  1141. `gnus'
  1142. `gnus-other-frame'
  1143. `org-gnus-no-new-news'
  1144. For FILE, use any of
  1145. `find-file'
  1146. `find-file-other-window'
  1147. `find-file-other-frame'
  1148. For the calendar, use the variable `calendar-setup'.
  1149. For BBDB, it is currently only possible to display the matches in
  1150. another window."
  1151. :group 'org-link-follow
  1152. :type '(list
  1153. (cons (const vm)
  1154. (choice
  1155. (const vm-visit-folder)
  1156. (const vm-visit-folder-other-window)
  1157. (const vm-visit-folder-other-frame)))
  1158. (cons (const gnus)
  1159. (choice
  1160. (const gnus)
  1161. (const gnus-other-frame)
  1162. (const org-gnus-no-new-news)))
  1163. (cons (const file)
  1164. (choice
  1165. (const find-file)
  1166. (const find-file-other-window)
  1167. (const find-file-other-frame)))))
  1168. (defcustom org-display-internal-link-with-indirect-buffer nil
  1169. "Non-nil means use indirect buffer to display infile links.
  1170. Activating internal links (from one location in a file to another location
  1171. in the same file) normally just jumps to the location. When the link is
  1172. activated with a C-u prefix (or with mouse-3), the link is displayed in
  1173. another window. When this option is set, the other window actually displays
  1174. an indirect buffer clone of the current buffer, to avoid any visibility
  1175. changes to the current buffer."
  1176. :group 'org-link-follow
  1177. :type 'boolean)
  1178. (defcustom org-open-non-existing-files nil
  1179. "Non-nil means `org-open-file' will open non-existing files.
  1180. When nil, an error will be generated.
  1181. This variable applies only to external applications because they
  1182. might choke on non-existing files. If the link is to a file that
  1183. will be opened in Emacs, the variable is ignored."
  1184. :group 'org-link-follow
  1185. :type 'boolean)
  1186. (defcustom org-open-directory-means-index-dot-org nil
  1187. "Non-nil means a link to a directory really means to index.org.
  1188. When nil, following a directory link will run dired or open a finder/explorer
  1189. window on that directory."
  1190. :group 'org-link-follow
  1191. :type 'boolean)
  1192. (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
  1193. "Function and arguments to call for following mailto links.
  1194. This is a list with the first element being a lisp function, and the
  1195. remaining elements being arguments to the function. In string arguments,
  1196. %a will be replaced by the address, and %s will be replaced by the subject
  1197. if one was given like in <mailto:arthur@galaxy.org::this subject>."
  1198. :group 'org-link-follow
  1199. :type '(choice
  1200. (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
  1201. (const :tag "compose-mail" (compose-mail "%a" "%s"))
  1202. (const :tag "message-mail" (message-mail "%a" "%s"))
  1203. (cons :tag "other" (function) (repeat :tag "argument" sexp))))
  1204. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  1205. "Non-nil means ask for confirmation before executing shell links.
  1206. Shell links can be dangerous: just think about a link
  1207. [[shell:rm -rf ~/*][Google Search]]
  1208. This link would show up in your Org-mode document as \"Google Search\",
  1209. but really it would remove your entire home directory.
  1210. Therefore we advise against setting this variable to nil.
  1211. Just change it to `y-or-n-p' if you want to confirm with a
  1212. single keystroke rather than having to type \"yes\"."
  1213. :group 'org-link-follow
  1214. :type '(choice
  1215. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1216. (const :tag "with y-or-n (faster)" y-or-n-p)
  1217. (const :tag "no confirmation (dangerous)" nil)))
  1218. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  1219. "Non-nil means ask for confirmation before executing Emacs Lisp links.
  1220. Elisp links can be dangerous: just think about a link
  1221. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  1222. This link would show up in your Org-mode document as \"Google Search\",
  1223. but really it would remove your entire home directory.
  1224. Therefore we advise against setting this variable to nil.
  1225. Just change it to `y-or-n-p' if you want to confirm with a
  1226. single keystroke rather than having to type \"yes\"."
  1227. :group 'org-link-follow
  1228. :type '(choice
  1229. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1230. (const :tag "with y-or-n (faster)" y-or-n-p)
  1231. (const :tag "no confirmation (dangerous)" nil)))
  1232. (defconst org-file-apps-defaults-gnu
  1233. '((remote . emacs)
  1234. (system . mailcap)
  1235. (t . mailcap))
  1236. "Default file applications on a UNIX or GNU/Linux system.
  1237. See `org-file-apps'.")
  1238. (defconst org-file-apps-defaults-macosx
  1239. '((remote . emacs)
  1240. (t . "open %s")
  1241. (system . "open %s")
  1242. ("ps.gz" . "gv %s")
  1243. ("eps.gz" . "gv %s")
  1244. ("dvi" . "xdvi %s")
  1245. ("fig" . "xfig %s"))
  1246. "Default file applications on a MacOS X system.
  1247. The system \"open\" is known as a default, but we use X11 applications
  1248. for some files for which the OS does not have a good default.
  1249. See `org-file-apps'.")
  1250. (defconst org-file-apps-defaults-windowsnt
  1251. (list
  1252. '(remote . emacs)
  1253. (cons t
  1254. (list (if (featurep 'xemacs)
  1255. 'mswindows-shell-execute
  1256. 'w32-shell-execute)
  1257. "open" 'file))
  1258. (cons 'system
  1259. (list (if (featurep 'xemacs)
  1260. 'mswindows-shell-execute
  1261. 'w32-shell-execute)
  1262. "open" 'file)))
  1263. "Default file applications on a Windows NT system.
  1264. The system \"open\" is used for most files.
  1265. See `org-file-apps'.")
  1266. (defcustom org-file-apps
  1267. '(
  1268. (auto-mode . emacs)
  1269. ("\\.mm\\'" . default)
  1270. ("\\.x?html?\\'" . default)
  1271. ("\\.pdf\\'" . default)
  1272. )
  1273. "External applications for opening `file:path' items in a document.
  1274. Org-mode uses system defaults for different file types, but
  1275. you can use this variable to set the application for a given file
  1276. extension. The entries in this list are cons cells where the car identifies
  1277. files and the cdr the corresponding command. Possible values for the
  1278. file identifier are
  1279. \"regex\" Regular expression matched against the file name. For backward
  1280. compatibility, this can also be a string with only alphanumeric
  1281. characters, which is then interpreted as an extension.
  1282. `directory' Matches a directory
  1283. `remote' Matches a remote file, accessible through tramp or efs.
  1284. Remote files most likely should be visited through Emacs
  1285. because external applications cannot handle such paths.
  1286. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1287. so all files Emacs knows how to handle. Using this with
  1288. command `emacs' will open most files in Emacs. Beware that this
  1289. will also open html files inside Emacs, unless you add
  1290. (\"html\" . default) to the list as well.
  1291. t Default for files not matched by any of the other options.
  1292. `system' The system command to open files, like `open' on Windows
  1293. and Mac OS X, and mailcap under GNU/Linux. This is the command
  1294. that will be selected if you call `C-c C-o' with a double
  1295. `C-u C-u' prefix.
  1296. Possible values for the command are:
  1297. `emacs' The file will be visited by the current Emacs process.
  1298. `default' Use the default application for this file type, which is the
  1299. association for t in the list, most likely in the system-specific
  1300. part.
  1301. This can be used to overrule an unwanted setting in the
  1302. system-specific variable.
  1303. `system' Use the system command for opening files, like \"open\".
  1304. This command is specified by the entry whose car is `system'.
  1305. Most likely, the system-specific version of this variable
  1306. does define this command, but you can overrule/replace it
  1307. here.
  1308. string A command to be executed by a shell; %s will be replaced
  1309. by the path to the file.
  1310. sexp A Lisp form which will be evaluated. The file path will
  1311. be available in the Lisp variable `file'.
  1312. For more examples, see the system specific constants
  1313. `org-file-apps-defaults-macosx'
  1314. `org-file-apps-defaults-windowsnt'
  1315. `org-file-apps-defaults-gnu'."
  1316. :group 'org-link-follow
  1317. :type '(repeat
  1318. (cons (choice :value ""
  1319. (string :tag "Extension")
  1320. (const :tag "System command to open files" system)
  1321. (const :tag "Default for unrecognized files" t)
  1322. (const :tag "Remote file" remote)
  1323. (const :tag "Links to a directory" directory)
  1324. (const :tag "Any files that have Emacs modes"
  1325. auto-mode))
  1326. (choice :value ""
  1327. (const :tag "Visit with Emacs" emacs)
  1328. (const :tag "Use default" default)
  1329. (const :tag "Use the system command" system)
  1330. (string :tag "Command")
  1331. (sexp :tag "Lisp form")))))
  1332. (defgroup org-refile nil
  1333. "Options concerning refiling entries in Org-mode."
  1334. :tag "Org Refile"
  1335. :group 'org)
  1336. (defcustom org-directory "~/org"
  1337. "Directory with org files.
  1338. This is just a default location to look for Org files. There is no need
  1339. at all to put your files into this directory. It is only used in the
  1340. following situations:
  1341. 1. When a remember template specifies a target file that is not an
  1342. absolute path. The path will then be interpreted relative to
  1343. `org-directory'
  1344. 2. When a remember note is filed away in an interactive way (when exiting the
  1345. note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
  1346. with `org-directory' as the default path."
  1347. :group 'org-refile
  1348. :group 'org-remember
  1349. :type 'directory)
  1350. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  1351. "Default target for storing notes.
  1352. Used by the hooks for remember.el. This can be a string, or nil to mean
  1353. the value of `remember-data-file'.
  1354. You can set this on a per-template basis with the variable
  1355. `org-remember-templates'."
  1356. :group 'org-refile
  1357. :group 'org-remember
  1358. :type '(choice
  1359. (const :tag "Default from remember-data-file" nil)
  1360. file))
  1361. (defcustom org-goto-interface 'outline
  1362. "The default interface to be used for `org-goto'.
  1363. Allowed values are:
  1364. outline The interface shows an outline of the relevant file
  1365. and the correct heading is found by moving through
  1366. the outline or by searching with incremental search.
  1367. outline-path-completion Headlines in the current buffer are offered via
  1368. completion. This is the interface also used by
  1369. the refile command."
  1370. :group 'org-refile
  1371. :type '(choice
  1372. (const :tag "Outline" outline)
  1373. (const :tag "Outline-path-completion" outline-path-completion)))
  1374. (defcustom org-goto-max-level 5
  1375. "Maximum level to be considered when running org-goto with refile interface."
  1376. :group 'org-refile
  1377. :type 'integer)
  1378. (defcustom org-reverse-note-order nil
  1379. "Non-nil means store new notes at the beginning of a file or entry.
  1380. When nil, new notes will be filed to the end of a file or entry.
  1381. This can also be a list with cons cells of regular expressions that
  1382. are matched against file names, and values."
  1383. :group 'org-remember
  1384. :group 'org-refile
  1385. :type '(choice
  1386. (const :tag "Reverse always" t)
  1387. (const :tag "Reverse never" nil)
  1388. (repeat :tag "By file name regexp"
  1389. (cons regexp boolean))))
  1390. (defcustom org-refile-targets nil
  1391. "Targets for refiling entries with \\[org-refile].
  1392. This is list of cons cells. Each cell contains:
  1393. - a specification of the files to be considered, either a list of files,
  1394. or a symbol whose function or variable value will be used to retrieve
  1395. a file name or a list of file names. If you use `org-agenda-files' for
  1396. that, all agenda files will be scanned for targets. Nil means consider
  1397. headings in the current buffer.
  1398. - A specification of how to find candidate refile targets. This may be
  1399. any of:
  1400. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  1401. This tag has to be present in all target headlines, inheritance will
  1402. not be considered.
  1403. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  1404. todo keyword.
  1405. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  1406. headlines that are refiling targets.
  1407. - a cons cell (:level . N). Any headline of level N is considered a target.
  1408. Note that, when `org-odd-levels-only' is set, level corresponds to
  1409. order in hierarchy, not to the number of stars.
  1410. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  1411. Note that, when `org-odd-levels-only' is set, level corresponds to
  1412. order in hierarchy, not to the number of stars.
  1413. You can set the variable `org-refile-target-verify-function' to a function
  1414. to verify each headline found by the simple critery above.
  1415. When this variable is nil, all top-level headlines in the current buffer
  1416. are used, equivalent to the value `((nil . (:level . 1))'."
  1417. :group 'org-refile
  1418. :type '(repeat
  1419. (cons
  1420. (choice :value org-agenda-files
  1421. (const :tag "All agenda files" org-agenda-files)
  1422. (const :tag "Current buffer" nil)
  1423. (function) (variable) (file))
  1424. (choice :tag "Identify target headline by"
  1425. (cons :tag "Specific tag" (const :value :tag) (string))
  1426. (cons :tag "TODO keyword" (const :value :todo) (string))
  1427. (cons :tag "Regular expression" (const :value :regexp) (regexp))
  1428. (cons :tag "Level number" (const :value :level) (integer))
  1429. (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
  1430. (defcustom org-refile-target-verify-function nil
  1431. "Function to verify if the headline at point should be a refile target.
  1432. The function will be called without arguments, with point at the
  1433. beginning of the headline. It should return t and leave point
  1434. where it is if the headline is a valid target for refiling.
  1435. If the target should not be selected, the function must return nil.
  1436. In addition to this, it may move point to a place from where the search
  1437. should be continued. For example, the function may decide that the entire
  1438. subtree of the current entry should be excluded and move point to the end
  1439. of the subtree."
  1440. :group 'org-refile
  1441. :type 'function)
  1442. (defcustom org-refile-use-outline-path nil
  1443. "Non-nil means provide refile targets as paths.
  1444. So a level 3 headline will be available as level1/level2/level3.
  1445. When the value is `file', also include the file name (without directory)
  1446. into the path. In this case, you can also stop the completion after
  1447. the file name, to get entries inserted as top level in the file.
  1448. When `full-file-path', include the full file path."
  1449. :group 'org-refile
  1450. :type '(choice
  1451. (const :tag "Not" nil)
  1452. (const :tag "Yes" t)
  1453. (const :tag "Start with file name" file)
  1454. (const :tag "Start with full file path" full-file-path)))
  1455. (defcustom org-outline-path-complete-in-steps t
  1456. "Non-nil means complete the outline path in hierarchical steps.
  1457. When Org-mode uses the refile interface to select an outline path
  1458. \(see variable `org-refile-use-outline-path'), the completion of
  1459. the path can be done is a single go, or if can be done in steps down
  1460. the headline hierarchy. Going in steps is probably the best if you
  1461. do not use a special completion package like `ido' or `icicles'.
  1462. However, when using these packages, going in one step can be very
  1463. fast, while still showing the whole path to the entry."
  1464. :group 'org-refile
  1465. :type 'boolean)
  1466. (defcustom org-refile-allow-creating-parent-nodes nil
  1467. "Non-nil means allow to create new nodes as refile targets.
  1468. New nodes are then created by adding \"/new node name\" to the completion
  1469. of an existing node. When the value of this variable is `confirm',
  1470. new node creation must be confirmed by the user (recommended)
  1471. When nil, the completion must match an existing entry.
  1472. Note that, if the new heading is not seen by the criteria
  1473. listed in `org-refile-targets', multiple instances of the same
  1474. heading would be created by trying again to file under the new
  1475. heading."
  1476. :group 'org-refile
  1477. :type '(choice
  1478. (const :tag "Never" nil)
  1479. (const :tag "Always" t)
  1480. (const :tag "Prompt for confirmation" confirm)))
  1481. (defgroup org-todo nil
  1482. "Options concerning TODO items in Org-mode."
  1483. :tag "Org TODO"
  1484. :group 'org)
  1485. (defgroup org-progress nil
  1486. "Options concerning Progress logging in Org-mode."
  1487. :tag "Org Progress"
  1488. :group 'org-time)
  1489. (defvar org-todo-interpretation-widgets
  1490. '(
  1491. (:tag "Sequence (cycling hits every state)" sequence)
  1492. (:tag "Type (cycling directly to DONE)" type))
  1493. "The available interpretation symbols for customizing
  1494. `org-todo-keywords'.
  1495. Interested libraries should add to this list.")
  1496. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  1497. "List of TODO entry keyword sequences and their interpretation.
  1498. \\<org-mode-map>This is a list of sequences.
  1499. Each sequence starts with a symbol, either `sequence' or `type',
  1500. indicating if the keywords should be interpreted as a sequence of
  1501. action steps, or as different types of TODO items. The first
  1502. keywords are states requiring action - these states will select a headline
  1503. for inclusion into the global TODO list Org-mode produces. If one of
  1504. the \"keywords\" is the vertical bat \"|\" the remaining keywords
  1505. signify that no further action is necessary. If \"|\" is not found,
  1506. the last keyword is treated as the only DONE state of the sequence.
  1507. The command \\[org-todo] cycles an entry through these states, and one
  1508. additional state where no keyword is present. For details about this
  1509. cycling, see the manual.
  1510. TODO keywords and interpretation can also be set on a per-file basis with
  1511. the special #+SEQ_TODO and #+TYP_TODO lines.
  1512. Each keyword can optionally specify a character for fast state selection
  1513. \(in combination with the variable `org-use-fast-todo-selection')
  1514. and specifiers for state change logging, using the same syntax
  1515. that is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says
  1516. that the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  1517. indicates to record a time stamp each time this state is selected.
  1518. Each keyword may also specify if a timestamp or a note should be
  1519. recorded when entering or leaving the state, by adding additional
  1520. characters in the parenthesis after the keyword. This looks like this:
  1521. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  1522. record only the time of the state change. With X and Y being either
  1523. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  1524. Y when leaving the state if and only if the *target* state does not
  1525. define X. You may omit any of the fast-selection key or X or /Y,
  1526. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  1527. For backward compatibility, this variable may also be just a list
  1528. of keywords - in this case the interpretation (sequence or type) will be
  1529. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  1530. :group 'org-todo
  1531. :group 'org-keywords
  1532. :type '(choice
  1533. (repeat :tag "Old syntax, just keywords"
  1534. (string :tag "Keyword"))
  1535. (repeat :tag "New syntax"
  1536. (cons
  1537. (choice
  1538. :tag "Interpretation"
  1539. ;;Quick and dirty way to see
  1540. ;;`org-todo-interpretations'. This takes the
  1541. ;;place of item arguments
  1542. :convert-widget
  1543. (lambda (widget)
  1544. (widget-put widget
  1545. :args (mapcar
  1546. #'(lambda (x)
  1547. (widget-convert
  1548. (cons 'const x)))
  1549. org-todo-interpretation-widgets))
  1550. widget))
  1551. (repeat
  1552. (string :tag "Keyword"))))))
  1553. (defvar org-todo-keywords-1 nil
  1554. "All TODO and DONE keywords active in a buffer.")
  1555. (make-variable-buffer-local 'org-todo-keywords-1)
  1556. (defvar org-todo-keywords-for-agenda nil)
  1557. (defvar org-done-keywords-for-agenda nil)
  1558. (defvar org-drawers-for-agenda nil)
  1559. (defvar org-todo-keyword-alist-for-agenda nil)
  1560. (defvar org-tag-alist-for-agenda nil)
  1561. (defvar org-agenda-contributing-files nil)
  1562. (defvar org-not-done-keywords nil)
  1563. (make-variable-buffer-local 'org-not-done-keywords)
  1564. (defvar org-done-keywords nil)
  1565. (make-variable-buffer-local 'org-done-keywords)
  1566. (defvar org-todo-heads nil)
  1567. (make-variable-buffer-local 'org-todo-heads)
  1568. (defvar org-todo-sets nil)
  1569. (make-variable-buffer-local 'org-todo-sets)
  1570. (defvar org-todo-log-states nil)
  1571. (make-variable-buffer-local 'org-todo-log-states)
  1572. (defvar org-todo-kwd-alist nil)
  1573. (make-variable-buffer-local 'org-todo-kwd-alist)
  1574. (defvar org-todo-key-alist nil)
  1575. (make-variable-buffer-local 'org-todo-key-alist)
  1576. (defvar org-todo-key-trigger nil)
  1577. (make-variable-buffer-local 'org-todo-key-trigger)
  1578. (defcustom org-todo-interpretation 'sequence
  1579. "Controls how TODO keywords are interpreted.
  1580. This variable is in principle obsolete and is only used for
  1581. backward compatibility, if the interpretation of todo keywords is
  1582. not given already in `org-todo-keywords'. See that variable for
  1583. more information."
  1584. :group 'org-todo
  1585. :group 'org-keywords
  1586. :type '(choice (const sequence)
  1587. (const type)))
  1588. (defcustom org-use-fast-todo-selection t
  1589. "Non-nil means use the fast todo selection scheme with C-c C-t.
  1590. This variable describes if and under what circumstances the cycling
  1591. mechanism for TODO keywords will be replaced by a single-key, direct
  1592. selection scheme.
  1593. When nil, fast selection is never used.
  1594. When the symbol `prefix', it will be used when `org-todo' is called with
  1595. a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
  1596. in an agenda buffer.
  1597. When t, fast selection is used by default. In this case, the prefix
  1598. argument forces cycling instead.
  1599. In all cases, the special interface is only used if access keys have actually
  1600. been assigned by the user, i.e. if keywords in the configuration are followed
  1601. by a letter in parenthesis, like TODO(t)."
  1602. :group 'org-todo
  1603. :type '(choice
  1604. (const :tag "Never" nil)
  1605. (const :tag "By default" t)
  1606. (const :tag "Only with C-u C-c C-t" prefix)))
  1607. (defcustom org-provide-todo-statistics t
  1608. "Non-nil means update todo statistics after insert and toggle.
  1609. ALL-HEADLINES means update todo statistics by including headlines
  1610. with no TODO keyword as well, counting them as not done.
  1611. A list of TODO keywords means the same, but skip keywords that are
  1612. not in this list.
  1613. When this is set, todo statistics is updated in the parent of the
  1614. current entry each time a todo state is changed."
  1615. :group 'org-todo
  1616. :type '(choice
  1617. (const :tag "Yes, only for TODO entries" t)
  1618. (const :tag "Yes, including all entries" 'all-headlines)
  1619. (repeat :tag "Yes, for TODOs in this list"
  1620. (string :tag "TODO keyword"))
  1621. (other :tag "No TODO statistics" nil)))
  1622. (defcustom org-hierarchical-todo-statistics t
  1623. "Non-nil means TODO statistics covers just direct children.
  1624. When nil, all entries in the subtree are considered.
  1625. This has only an effect if `org-provide-todo-statistics' is set.
  1626. To set this to nil for only a single subtree, use a COOKIE_DATA
  1627. property and include the word \"recursive\" into the value."
  1628. :group 'org-todo
  1629. :type 'boolean)
  1630. (defcustom org-after-todo-state-change-hook nil
  1631. "Hook which is run after the state of a TODO item was changed.
  1632. The new state (a string with a TODO keyword, or nil) is available in the
  1633. Lisp variable `state'."
  1634. :group 'org-todo
  1635. :type 'hook)
  1636. (defvar org-blocker-hook nil
  1637. "Hook for functions that are allowed to block a state change.
  1638. Each function gets as its single argument a property list, see
  1639. `org-trigger-hook' for more information about this list.
  1640. If any of the functions in this hook returns nil, the state change
  1641. is blocked.")
  1642. (defvar org-trigger-hook nil
  1643. "Hook for functions that are triggered by a state change.
  1644. Each function gets as its single argument a property list with at least
  1645. the following elements:
  1646. (:type type-of-change :position pos-at-entry-start
  1647. :from old-state :to new-state)
  1648. Depending on the type, more properties may be present.
  1649. This mechanism is currently implemented for:
  1650. TODO state changes
  1651. ------------------
  1652. :type todo-state-change
  1653. :from previous state (keyword as a string), or nil, or a symbol
  1654. 'todo' or 'done', to indicate the general type of state.
  1655. :to new state, like in :from")
  1656. (defcustom org-enforce-todo-dependencies nil
  1657. "Non-nil means undone TODO entries will block switching the parent to DONE.
  1658. Also, if a parent has an :ORDERED: property, switching an entry to DONE will
  1659. be blocked if any prior sibling is not yet done.
  1660. Finally, if the parent is blocked because of ordered siblings of its own,
  1661. the child will also be blocked.
  1662. This variable needs to be set before org.el is loaded, and you need to
  1663. restart Emacs after a change to make the change effective. The only way
  1664. to change is while Emacs is running is through the customize interface."
  1665. :set (lambda (var val)
  1666. (set var val)
  1667. (if val
  1668. (add-hook 'org-blocker-hook
  1669. 'org-block-todo-from-children-or-siblings-or-parent)
  1670. (remove-hook 'org-blocker-hook
  1671. 'org-block-todo-from-children-or-siblings-or-parent)))
  1672. :group 'org-todo
  1673. :type 'boolean)
  1674. (defcustom org-enforce-todo-checkbox-dependencies nil
  1675. "Non-nil means unchecked boxes will block switching the parent to DONE.
  1676. When this is nil, checkboxes have no influence on switching TODO states.
  1677. When non-nil, you first need to check off all check boxes before the TODO
  1678. entry can be switched to DONE.
  1679. This variable needs to be set before org.el is loaded, and you need to
  1680. restart Emacs after a change to make the change effective. The only way
  1681. to change is while Emacs is running is through the customize interface."
  1682. :set (lambda (var val)
  1683. (set var val)
  1684. (if val
  1685. (add-hook 'org-blocker-hook
  1686. 'org-block-todo-from-checkboxes)
  1687. (remove-hook 'org-blocker-hook
  1688. 'org-block-todo-from-checkboxes)))
  1689. :group 'org-todo
  1690. :type 'boolean)
  1691. (defcustom org-treat-insert-todo-heading-as-state-change nil
  1692. "Non-nil means inserting a TODO heading is treated as state change.
  1693. So when the command \\[org-insert-todo-heading] is used, state change
  1694. logging will apply if appropriate. When nil, the new TODO item will
  1695. be inserted directly, and no logging will take place."
  1696. :group 'org-todo
  1697. :type 'boolean)
  1698. (defcustom org-treat-S-cursor-todo-selection-as-state-change t
  1699. "Non-nil means switching TODO states with S-cursor counts as state change.
  1700. This is the default behavior. However, setting this to nil allows a
  1701. convenient way to select a TODO state and bypass any logging associated
  1702. with that."
  1703. :group 'org-todo
  1704. :type 'boolean)
  1705. (defcustom org-todo-state-tags-triggers nil
  1706. "Tag changes that should be triggered by TODO state changes.
  1707. This is a list. Each entry is
  1708. (state-change (tag . flag) .......)
  1709. State-change can be a string with a state, and empty string to indicate the
  1710. state that has no TODO keyword, or it can be one of the symbols `todo'
  1711. or `done', meaning any not-done or done state, respectively."
  1712. :group 'org-todo
  1713. :group 'org-tags
  1714. :type '(repeat
  1715. (cons (choice :tag "When changing to"
  1716. (const :tag "Not-done state" todo)
  1717. (const :tag "Done state" done)
  1718. (string :tag "State"))
  1719. (repeat
  1720. (cons :tag "Tag action"
  1721. (string :tag "Tag")
  1722. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  1723. (defcustom org-log-done nil
  1724. "Information to record when a task moves to the DONE state.
  1725. Possible values are:
  1726. nil Don't add anything, just change the keyword
  1727. time Add a time stamp to the task
  1728. note Prompt for a note and add it with template `org-log-note-headings'
  1729. This option can also be set with on a per-file-basis with
  1730. #+STARTUP: nologdone
  1731. #+STARTUP: logdone
  1732. #+STARTUP: lognotedone
  1733. You can have local logging settings for a subtree by setting the LOGGING
  1734. property to one or more of these keywords."
  1735. :group 'org-todo
  1736. :group 'org-progress
  1737. :type '(choice
  1738. (const :tag "No logging" nil)
  1739. (const :tag "Record CLOSED timestamp" time)
  1740. (const :tag "Record CLOSED timestamp with note." note)))
  1741. ;; Normalize old uses of org-log-done.
  1742. (cond
  1743. ((eq org-log-done t) (setq org-log-done 'time))
  1744. ((and (listp org-log-done) (memq 'done org-log-done))
  1745. (setq org-log-done 'note)))
  1746. (defcustom org-log-reschedule nil
  1747. "Information to record when the scheduling date of a tasks is modified.
  1748. Possible values are:
  1749. nil Don't add anything, just change the date
  1750. time Add a time stamp to the task
  1751. note Prompt for a note and add it with template `org-log-note-headings'
  1752. This option can also be set with on a per-file-basis with
  1753. #+STARTUP: nologreschedule
  1754. #+STARTUP: logreschedule
  1755. #+STARTUP: lognotereschedule"
  1756. :group 'org-todo
  1757. :group 'org-progress
  1758. :type '(choice
  1759. (const :tag "No logging" nil)
  1760. (const :tag "Record timestamp" time)
  1761. (const :tag "Record timestamp with note." note)))
  1762. (defcustom org-log-redeadline nil
  1763. "Information to record when the deadline date of a tasks is modified.
  1764. Possible values are:
  1765. nil Don't add anything, just change the date
  1766. time Add a time stamp to the task
  1767. note Prompt for a note and add it with template `org-log-note-headings'
  1768. This option can also be set with on a per-file-basis with
  1769. #+STARTUP: nologredeadline
  1770. #+STARTUP: logredeadline
  1771. #+STARTUP: lognoteredeadline
  1772. You can have local logging settings for a subtree by setting the LOGGING
  1773. property to one or more of these keywords."
  1774. :group 'org-todo
  1775. :group 'org-progress
  1776. :type '(choice
  1777. (const :tag "No logging" nil)
  1778. (const :tag "Record timestamp" time)
  1779. (const :tag "Record timestamp with note." note)))
  1780. (defcustom org-log-note-clock-out nil
  1781. "Non-nil means record a note when clocking out of an item.
  1782. This can also be configured on a per-file basis by adding one of
  1783. the following lines anywhere in the buffer:
  1784. #+STARTUP: lognoteclock-out
  1785. #+STARTUP: nolognoteclock-out"
  1786. :group 'org-todo
  1787. :group 'org-progress
  1788. :type 'boolean)
  1789. (defcustom org-log-done-with-time t
  1790. "Non-nil means the CLOSED time stamp will contain date and time.
  1791. When nil, only the date will be recorded."
  1792. :group 'org-progress
  1793. :type 'boolean)
  1794. (defcustom org-log-note-headings
  1795. '((done . "CLOSING NOTE %t")
  1796. (state . "State %-12s from %-12S %t")
  1797. (note . "Note taken on %t")
  1798. (reschedule . "Rescheduled from %S on %t")
  1799. (delschedule . "Not scheduled, was %S on %t")
  1800. (redeadline . "New deadline from %S on %t")
  1801. (deldeadline . "Removed deadline, was %S on %t")
  1802. (clock-out . ""))
  1803. "Headings for notes added to entries.
  1804. The value is an alist, with the car being a symbol indicating the note
  1805. context, and the cdr is the heading to be used. The heading may also be the
  1806. empty string.
  1807. %t in the heading will be replaced by a time stamp.
  1808. %s will be replaced by the new TODO state, in double quotes.
  1809. %S will be replaced by the old TODO state, in double quotes.
  1810. %u will be replaced by the user name.
  1811. %U will be replaced by the full user name.
  1812. In fact, it is not a good idea to change the `state' entry, because
  1813. agenda log mode depends on the format of these entries."
  1814. :group 'org-todo
  1815. :group 'org-progress
  1816. :type '(list :greedy t
  1817. (cons (const :tag "Heading when closing an item" done) string)
  1818. (cons (const :tag
  1819. "Heading when changing todo state (todo sequence only)"
  1820. state) string)
  1821. (cons (const :tag "Heading when just taking a note" note) string)
  1822. (cons (const :tag "Heading when clocking out" clock-out) string)
  1823. (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
  1824. (cons (const :tag "Heading when rescheduling" reschedule) string)
  1825. (cons (const :tag "Heading when changing deadline" redeadline) string
  1826. (cons (const :tag "Heading when deleting a deadline" deldeadline) string))))
  1827. (unless (assq 'note org-log-note-headings)
  1828. (push '(note . "%t") org-log-note-headings))
  1829. (defcustom org-log-into-drawer nil
  1830. "Non-nil means insert state change notes and time stamps into a drawer.
  1831. When nil, state changes notes will be inserted after the headline and
  1832. any scheduling and clock lines, but not inside a drawer.
  1833. The value of this variable should be the name of the drawer to use.
  1834. LOGBOOK is proposed at the default drawer for this purpose, you can
  1835. also set this to a string to define the drawer of your choice.
  1836. A value of t is also allowed, representing \"LOGBOOK\".
  1837. If this variable is set, `org-log-state-notes-insert-after-drawers'
  1838. will be ignored.
  1839. You can set the property LOG_INTO_DRAWER to overrule this setting for
  1840. a subtree."
  1841. :group 'org-todo
  1842. :group 'org-progress
  1843. :type '(choice
  1844. (const :tag "Not into a drawer" nil)
  1845. (const :tag "LOGBOOK" t)
  1846. (string :tag "Other")))
  1847. (if (fboundp 'defvaralias)
  1848. (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer))
  1849. (defun org-log-into-drawer ()
  1850. "Return the value of `org-log-into-drawer', but let properties overrule.
  1851. If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
  1852. used instead of the default value."
  1853. (let ((p (ignore-errors (org-entry-get nil "LOG_INTO_DRAWER" 'inherit))))
  1854. (cond
  1855. ((or (not p) (equal p "nil")) org-log-into-drawer)
  1856. ((equal p "t") "LOGBOOK")
  1857. (t p))))
  1858. (defcustom org-log-state-notes-insert-after-drawers nil
  1859. "Non-nil means insert state change notes after any drawers in entry.
  1860. Only the drawers that *immediately* follow the headline and the
  1861. deadline/scheduled line are skipped.
  1862. When nil, insert notes right after the heading and perhaps the line
  1863. with deadline/scheduling if present.
  1864. This variable will have no effect if `org-log-into-drawer' is
  1865. set."
  1866. :group 'org-todo
  1867. :group 'org-progress
  1868. :type 'boolean)
  1869. (defcustom org-log-states-order-reversed t
  1870. "Non-nil means the latest state change note will be directly after heading.
  1871. When nil, the notes will be orderer according to time."
  1872. :group 'org-todo
  1873. :group 'org-progress
  1874. :type 'boolean)
  1875. (defcustom org-log-repeat 'time
  1876. "Non-nil means record moving through the DONE state when triggering repeat.
  1877. An auto-repeating task is immediately switched back to TODO when
  1878. marked DONE. If you are not logging state changes (by adding \"@\"
  1879. or \"!\" to the TODO keyword definition), or set `org-log-done' to
  1880. record a closing note, there will be no record of the task moving
  1881. through DONE. This variable forces taking a note anyway.
  1882. nil Don't force a record
  1883. time Record a time stamp
  1884. note Record a note
  1885. This option can also be set with on a per-file-basis with
  1886. #+STARTUP: logrepeat
  1887. #+STARTUP: lognoterepeat
  1888. #+STARTUP: nologrepeat
  1889. You can have local logging settings for a subtree by setting the LOGGING
  1890. property to one or more of these keywords."
  1891. :group 'org-todo
  1892. :group 'org-progress
  1893. :type '(choice
  1894. (const :tag "Don't force a record" nil)
  1895. (const :tag "Force recording the DONE state" time)
  1896. (const :tag "Force recording a note with the DONE state" note)))
  1897. (defgroup org-priorities nil
  1898. "Priorities in Org-mode."
  1899. :tag "Org Priorities"
  1900. :group 'org-todo)
  1901. (defcustom org-enable-priority-commands t
  1902. "Non-nil means priority commands are active.
  1903. When nil, these commands will be disabled, so that you never accidentally
  1904. set a priority."
  1905. :group 'org-priorities
  1906. :type 'boolean)
  1907. (defcustom org-highest-priority ?A
  1908. "The highest priority of TODO items. A character like ?A, ?B etc.
  1909. Must have a smaller ASCII number than `org-lowest-priority'."
  1910. :group 'org-priorities
  1911. :type 'character)
  1912. (defcustom org-lowest-priority ?C
  1913. "The lowest priority of TODO items. A character like ?A, ?B etc.
  1914. Must have a larger ASCII number than `org-highest-priority'."
  1915. :group 'org-priorities
  1916. :type 'character)
  1917. (defcustom org-default-priority ?B
  1918. "The default priority of TODO items.
  1919. This is the priority an item get if no explicit priority is given."
  1920. :group 'org-priorities
  1921. :type 'character)
  1922. (defcustom org-priority-start-cycle-with-default t
  1923. "Non-nil means start with default priority when starting to cycle.
  1924. When this is nil, the first step in the cycle will be (depending on the
  1925. command used) one higher or lower that the default priority."
  1926. :group 'org-priorities
  1927. :type 'boolean)
  1928. (defgroup org-time nil
  1929. "Options concerning time stamps and deadlines in Org-mode."
  1930. :tag "Org Time"
  1931. :group 'org)
  1932. (defcustom org-insert-labeled-timestamps-at-point nil
  1933. "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
  1934. When nil, these labeled time stamps are forces into the second line of an
  1935. entry, just after the headline. When scheduling from the global TODO list,
  1936. the time stamp will always be forced into the second line."
  1937. :group 'org-time
  1938. :type 'boolean)
  1939. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  1940. "Formats for `format-time-string' which are used for time stamps.
  1941. It is not recommended to change this constant.")
  1942. (defcustom org-time-stamp-rounding-minutes '(0 5)
  1943. "Number of minutes to round time stamps to.
  1944. These are two values, the first applies when first creating a time stamp.
  1945. The second applies when changing it with the commands `S-up' and `S-down'.
  1946. When changing the time stamp, this means that it will change in steps
  1947. of N minutes, as given by the second value.
  1948. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  1949. numbers should be factors of 60, so for example 5, 10, 15.
  1950. When this is larger than 1, you can still force an exact time-stamp by using
  1951. a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
  1952. and by using a prefix arg to `S-up/down' to specify the exact number
  1953. of minutes to shift."
  1954. :group 'org-time
  1955. :get '(lambda (var) ; Make sure all entries have 5 elements
  1956. (if (integerp (default-value var))
  1957. (list (default-value var) 5)
  1958. (default-value var)))
  1959. :type '(list
  1960. (integer :tag "when inserting times")
  1961. (integer :tag "when modifying times")))
  1962. ;; Normalize old customizations of this variable.
  1963. (when (integerp org-time-stamp-rounding-minutes)
  1964. (setq org-time-stamp-rounding-minutes
  1965. (list org-time-stamp-rounding-minutes
  1966. org-time-stamp-rounding-minutes)))
  1967. (defcustom org-display-custom-times nil
  1968. "Non-nil means overlay custom formats over all time stamps.
  1969. The formats are defined through the variable `org-time-stamp-custom-formats'.
  1970. To turn this on on a per-file basis, insert anywhere in the file:
  1971. #+STARTUP: customtime"
  1972. :group 'org-time
  1973. :set 'set-default
  1974. :type 'sexp)
  1975. (make-variable-buffer-local 'org-display-custom-times)
  1976. (defcustom org-time-stamp-custom-formats
  1977. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  1978. "Custom formats for time stamps. See `format-time-string' for the syntax.
  1979. These are overlayed over the default ISO format if the variable
  1980. `org-display-custom-times' is set. Time like %H:%M should be at the
  1981. end of the second format. The custom formats are also honored by export
  1982. commands, if custom time display is turned on at the time of export."
  1983. :group 'org-time
  1984. :type 'sexp)
  1985. (defun org-time-stamp-format (&optional long inactive)
  1986. "Get the right format for a time string."
  1987. (let ((f (if long (cdr org-time-stamp-formats)
  1988. (car org-time-stamp-formats))))
  1989. (if inactive
  1990. (concat "[" (substring f 1 -1) "]")
  1991. f)))
  1992. (defcustom org-time-clocksum-format "%d:%02d"
  1993. "The format string used when creating CLOCKSUM lines, or when
  1994. org-mode generates a time duration."
  1995. :group 'org-time
  1996. :type 'string)
  1997. (defcustom org-time-clocksum-use-fractional nil
  1998. "If non-nil, \\[org-clock-display] uses fractional times.
  1999. org-mode generates a time duration."
  2000. :group 'org-time
  2001. :type 'boolean)
  2002. (defcustom org-time-clocksum-fractional-format "%.2f"
  2003. "The format string used when creating CLOCKSUM lines, or when
  2004. org-mode generates a time duration."
  2005. :group 'org-time
  2006. :type 'string)
  2007. (defcustom org-deadline-warning-days 14
  2008. "No. of days before expiration during which a deadline becomes active.
  2009. This variable governs the display in sparse trees and in the agenda.
  2010. When 0 or negative, it means use this number (the absolute value of it)
  2011. even if a deadline has a different individual lead time specified.
  2012. Custom commands can set this variable in the options section."
  2013. :group 'org-time
  2014. :group 'org-agenda-daily/weekly
  2015. :type 'integer)
  2016. (defcustom org-read-date-prefer-future t
  2017. "Non-nil means assume future for incomplete date input from user.
  2018. This affects the following situations:
  2019. 1. The user gives a month but not a year.
  2020. For example, if it is april and you enter \"feb 2\", this will be read
  2021. as feb 2, *next* year. \"May 5\", however, will be this year.
  2022. 2. The user gives a day, but no month.
  2023. For example, if today is the 15th, and you enter \"3\", Org-mode will
  2024. read this as the third of *next* month. However, if you enter \"17\",
  2025. it will be considered as *this* month.
  2026. If you set this variable to the symbol `time', then also the following
  2027. will work:
  2028. 3. If the user gives a time, but no day. If the time is before now,
  2029. to will be interpreted as tomorrow.
  2030. Currently none of this works for ISO week specifications.
  2031. When this option is nil, the current day, month and year will always be
  2032. used as defaults."
  2033. :group 'org-time
  2034. :type '(choice
  2035. (const :tag "Never" nil)
  2036. (const :tag "Check month and day" t)
  2037. (const :tag "Check month, day, and time" time)))
  2038. (defcustom org-read-date-display-live t
  2039. "Non-nil means display current interpretation of date prompt live.
  2040. This display will be in an overlay, in the minibuffer."
  2041. :group 'org-time
  2042. :type 'boolean)
  2043. (defcustom org-read-date-popup-calendar t
  2044. "Non-nil means pop up a calendar when prompting for a date.
  2045. In the calendar, the date can be selected with mouse-1. However, the
  2046. minibuffer will also be active, and you can simply enter the date as well.
  2047. When nil, only the minibuffer will be available."
  2048. :group 'org-time
  2049. :type 'boolean)
  2050. (if (fboundp 'defvaralias)
  2051. (defvaralias 'org-popup-calendar-for-date-prompt
  2052. 'org-read-date-popup-calendar))
  2053. (defcustom org-read-date-minibuffer-setup-hook nil
  2054. "Hook to be used to set up keys for the date/time interface.
  2055. Add key definitions to `minibuffer-local-map', which will be a temporary
  2056. copy."
  2057. :group 'org-time
  2058. :type 'hook)
  2059. (defcustom org-extend-today-until 0
  2060. "The hour when your day really ends. Must be an integer.
  2061. This has influence for the following applications:
  2062. - When switching the agenda to \"today\". It it is still earlier than
  2063. the time given here, the day recognized as TODAY is actually yesterday.
  2064. - When a date is read from the user and it is still before the time given
  2065. here, the current date and time will be assumed to be yesterday, 23:59.
  2066. Also, timestamps inserted in remember templates follow this rule.
  2067. IMPORTANT: This is a feature whose implementation is and likely will
  2068. remain incomplete. Really, it is only here because past midnight seems to
  2069. be the favorite working time of John Wiegley :-)"
  2070. :group 'org-time
  2071. :type 'integer)
  2072. (defcustom org-edit-timestamp-down-means-later nil
  2073. "Non-nil means S-down will increase the time in a time stamp.
  2074. When nil, S-up will increase."
  2075. :group 'org-time
  2076. :type 'boolean)
  2077. (defcustom org-calendar-follow-timestamp-change t
  2078. "Non-nil means make the calendar window follow timestamp changes.
  2079. When a timestamp is modified and the calendar window is visible, it will be
  2080. moved to the new date."
  2081. :group 'org-time
  2082. :type 'boolean)
  2083. (defgroup org-tags nil
  2084. "Options concerning tags in Org-mode."
  2085. :tag "Org Tags"
  2086. :group 'org)
  2087. (defcustom org-tag-alist nil
  2088. "List of tags allowed in Org-mode files.
  2089. When this list is nil, Org-mode will base TAG input on what is already in the
  2090. buffer.
  2091. The value of this variable is an alist, the car of each entry must be a
  2092. keyword as a string, the cdr may be a character that is used to select
  2093. that tag through the fast-tag-selection interface.
  2094. See the manual for details."
  2095. :group 'org-tags
  2096. :type '(repeat
  2097. (choice
  2098. (cons (string :tag "Tag name")
  2099. (character :tag "Access char"))
  2100. (list :tag "Start radio group"
  2101. (const :startgroup)
  2102. (option (string :tag "Group description")))
  2103. (list :tag "End radio group"
  2104. (const :endgroup)
  2105. (option (string :tag "Group description")))
  2106. (const :tag "New line" (:newline)))))
  2107. (defcustom org-tag-persistent-alist nil
  2108. "List of tags that will always appear in all Org-mode files.
  2109. This is in addition to any in buffer settings or customizations
  2110. of `org-tag-alist'.
  2111. When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
  2112. The value of this variable is an alist, the car of each entry must be a
  2113. keyword as a string, the cdr may be a character that is used to select
  2114. that tag through the fast-tag-selection interface.
  2115. See the manual for details.
  2116. To disable these tags on a per-file basis, insert anywhere in the file:
  2117. #+STARTUP: noptag"
  2118. :group 'org-tags
  2119. :type '(repeat
  2120. (choice
  2121. (cons (string :tag "Tag name")
  2122. (character :tag "Access char"))
  2123. (const :tag "Start radio group" (:startgroup))
  2124. (const :tag "End radio group" (:endgroup))
  2125. (const :tag "New line" (:newline)))))
  2126. (defcustom org-complete-tags-always-offer-all-agenda-tags nil
  2127. "If non-nil, always offer completion for all tags of all agenda files.
  2128. Instead of customizing this variable directly, you might want to
  2129. set it locally for remember buffers, because there no list of
  2130. tags in that file can be created dynamically (there are none).
  2131. (add-hook 'org-remember-mode-hook
  2132. (lambda ()
  2133. (set (make-local-variable
  2134. 'org-complete-tags-always-offer-all-agenda-tags)
  2135. t)))"
  2136. :group 'org-tags
  2137. :type 'boolean)
  2138. (defvar org-file-tags nil
  2139. "List of tags that can be inherited by all entries in the file.
  2140. The tags will be inherited if the variable `org-use-tag-inheritance'
  2141. says they should be.
  2142. This variable is populated from #+FILETAGS lines.")
  2143. (defcustom org-use-fast-tag-selection 'auto
  2144. "Non-nil means use fast tag selection scheme.
  2145. This is a special interface to select and deselect tags with single keys.
  2146. When nil, fast selection is never used.
  2147. When the symbol `auto', fast selection is used if and only if selection
  2148. characters for tags have been configured, either through the variable
  2149. `org-tag-alist' or through a #+TAGS line in the buffer.
  2150. When t, fast selection is always used and selection keys are assigned
  2151. automatically if necessary."
  2152. :group 'org-tags
  2153. :type '(choice
  2154. (const :tag "Always" t)
  2155. (const :tag "Never" nil)
  2156. (const :tag "When selection characters are configured" 'auto)))
  2157. (defcustom org-fast-tag-selection-single-key nil
  2158. "Non-nil means fast tag selection exits after first change.
  2159. When nil, you have to press RET to exit it.
  2160. During fast tag selection, you can toggle this flag with `C-c'.
  2161. This variable can also have the value `expert'. In this case, the window
  2162. displaying the tags menu is not even shown, until you press C-c again."
  2163. :group 'org-tags
  2164. :type '(choice
  2165. (const :tag "No" nil)
  2166. (const :tag "Yes" t)
  2167. (const :tag "Expert" expert)))
  2168. (defvar org-fast-tag-selection-include-todo nil
  2169. "Non-nil means fast tags selection interface will also offer TODO states.
  2170. This is an undocumented feature, you should not rely on it.")
  2171. (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
  2172. "The column to which tags should be indented in a headline.
  2173. If this number is positive, it specifies the column. If it is negative,
  2174. it means that the tags should be flushright to that column. For example,
  2175. -80 works well for a normal 80 character screen."
  2176. :group 'org-tags
  2177. :type 'integer)
  2178. (defcustom org-auto-align-tags t
  2179. "Non-nil means realign tags after pro/demotion of TODO state change.
  2180. These operations change the length of a headline and therefore shift
  2181. the tags around. With this options turned on, after each such operation
  2182. the tags are again aligned to `org-tags-column'."
  2183. :group 'org-tags
  2184. :type 'boolean)
  2185. (defcustom org-use-tag-inheritance t
  2186. "Non-nil means tags in levels apply also for sublevels.
  2187. When nil, only the tags directly given in a specific line apply there.
  2188. This may also be a list of tags that should be inherited, or a regexp that
  2189. matches tags that should be inherited. Additional control is possible
  2190. with the variable `org-tags-exclude-from-inheritance' which gives an
  2191. explicit list of tags to be excluded from inheritance., even if the value of
  2192. `org-use-tag-inheritance' would select it for inheritance.
  2193. If this option is t, a match early-on in a tree can lead to a large
  2194. number of matches in the subtree when constructing the agenda or creating
  2195. a sparse tree. If you only want to see the first match in a tree during
  2196. a search, check out the variable `org-tags-match-list-sublevels'."
  2197. :group 'org-tags
  2198. :type '(choice
  2199. (const :tag "Not" nil)
  2200. (const :tag "Always" t)
  2201. (repeat :tag "Specific tags" (string :tag "Tag"))
  2202. (regexp :tag "Tags matched by regexp")))
  2203. (defcustom org-tags-exclude-from-inheritance nil
  2204. "List of tags that should never be inherited.
  2205. This is a way to exclude a few tags from inheritance. For way to do
  2206. the opposite, to actively allow inheritance for selected tags,
  2207. see the variable `org-use-tag-inheritance'."
  2208. :group 'org-tags
  2209. :type '(repeat (string :tag "Tag")))
  2210. (defun org-tag-inherit-p (tag)
  2211. "Check if TAG is one that should be inherited."
  2212. (cond
  2213. ((member tag org-tags-exclude-from-inheritance) nil)
  2214. ((eq org-use-tag-inheritance t) t)
  2215. ((not org-use-tag-inheritance) nil)
  2216. ((stringp org-use-tag-inheritance)
  2217. (string-match org-use-tag-inheritance tag))
  2218. ((listp org-use-tag-inheritance)
  2219. (member tag org-use-tag-inheritance))
  2220. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  2221. (defcustom org-tags-match-list-sublevels t
  2222. "Non-nil means list also sublevels of headlines matching a search.
  2223. This variable applies to tags/property searches, and also to stuck
  2224. projects because this search is based on a tags match as well.
  2225. When set to the symbol `indented', sublevels are indented with
  2226. leading dots.
  2227. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  2228. the sublevels of a headline matching a tag search often also match
  2229. the same search. Listing all of them can create very long lists.
  2230. Setting this variable to nil causes subtrees of a match to be skipped.
  2231. This variable is semi-obsolete and probably should always be true. It
  2232. is better to limit inheritance to certain tags using the variables
  2233. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  2234. :group 'org-tags
  2235. :type '(choice
  2236. (const :tag "No, don't list them" nil)
  2237. (const :tag "Yes, do list them" t)
  2238. (const :tag "List them, indented with leading dots" indented)))
  2239. (defcustom org-tags-sort-function nil
  2240. "When set, tags are sorted using this function as a comparator"
  2241. :group 'org-tags
  2242. :type '(choice
  2243. (const :tag "No sorting" nil)
  2244. (const :tag "Alphabetical" string<)
  2245. (const :tag "Reverse alphabetical" string>)
  2246. (function :tag "Custom function" nil)))
  2247. (defvar org-tags-history nil
  2248. "History of minibuffer reads for tags.")
  2249. (defvar org-last-tags-completion-table nil
  2250. "The last used completion table for tags.")
  2251. (defvar org-after-tags-change-hook nil
  2252. "Hook that is run after the tags in a line have changed.")
  2253. (defgroup org-properties nil
  2254. "Options concerning properties in Org-mode."
  2255. :tag "Org Properties"
  2256. :group 'org)
  2257. (defcustom org-property-format "%-10s %s"
  2258. "How property key/value pairs should be formatted by `indent-line'.
  2259. When `indent-line' hits a property definition, it will format the line
  2260. according to this format, mainly to make sure that the values are
  2261. lined-up with respect to each other."
  2262. :group 'org-properties
  2263. :type 'string)
  2264. (defcustom org-use-property-inheritance nil
  2265. "Non-nil means properties apply also for sublevels.
  2266. This setting is chiefly used during property searches. Turning it on can
  2267. cause significant overhead when doing a search, which is why it is not
  2268. on by default.
  2269. When nil, only the properties directly given in the current entry count.
  2270. When t, every property is inherited. The value may also be a list of
  2271. properties that should have inheritance, or a regular expression matching
  2272. properties that should be inherited.
  2273. However, note that some special properties use inheritance under special
  2274. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  2275. and the properties ending in \"_ALL\" when they are used as descriptor
  2276. for valid values of a property.
  2277. Note for programmers:
  2278. When querying an entry with `org-entry-get', you can control if inheritance
  2279. should be used. By default, `org-entry-get' looks only at the local
  2280. properties. You can request inheritance by setting the inherit argument
  2281. to t (to force inheritance) or to `selective' (to respect the setting
  2282. in this variable)."
  2283. :group 'org-properties
  2284. :type '(choice
  2285. (const :tag "Not" nil)
  2286. (const :tag "Always" t)
  2287. (repeat :tag "Specific properties" (string :tag "Property"))
  2288. (regexp :tag "Properties matched by regexp")))
  2289. (defun org-property-inherit-p (property)
  2290. "Check if PROPERTY is one that should be inherited."
  2291. (cond
  2292. ((eq org-use-property-inheritance t) t)
  2293. ((not org-use-property-inheritance) nil)
  2294. ((stringp org-use-property-inheritance)
  2295. (string-match org-use-property-inheritance property))
  2296. ((listp org-use-property-inheritance)
  2297. (member property org-use-property-inheritance))
  2298. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  2299. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  2300. "The default column format, if no other format has been defined.
  2301. This variable can be set on the per-file basis by inserting a line
  2302. #+COLUMNS: %25ITEM ....."
  2303. :group 'org-properties
  2304. :type 'string)
  2305. (defcustom org-columns-ellipses ".."
  2306. "The ellipses to be used when a field in column view is truncated.
  2307. When this is the empty string, as many characters as possible are shown,
  2308. but then there will be no visual indication that the field has been truncated.
  2309. When this is a string of length N, the last N characters of a truncated
  2310. field are replaced by this string. If the column is narrower than the
  2311. ellipses string, only part of the ellipses string will be shown."
  2312. :group 'org-properties
  2313. :type 'string)
  2314. (defcustom org-columns-modify-value-for-display-function nil
  2315. "Function that modifies values for display in column view.
  2316. For example, it can be used to cut out a certain part from a time stamp.
  2317. The function must take 2 arguments:
  2318. column-title The title of the column (*not* the property name)
  2319. value The value that should be modified.
  2320. The function should return the value that should be displayed,
  2321. or nil if the normal value should be used."
  2322. :group 'org-properties
  2323. :type 'function)
  2324. (defcustom org-effort-property "Effort"
  2325. "The property that is being used to keep track of effort estimates.
  2326. Effort estimates given in this property need to have the format H:MM."
  2327. :group 'org-properties
  2328. :group 'org-progress
  2329. :type '(string :tag "Property"))
  2330. (defconst org-global-properties-fixed
  2331. '(("VISIBILITY_ALL" . "folded children content all")
  2332. ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
  2333. "List of property/value pairs that can be inherited by any entry.
  2334. These are fixed values, for the preset properties. The user variable
  2335. that can be used to add to this list is `org-global-properties'.
  2336. The entries in this list are cons cells where the car is a property
  2337. name and cdr is a string with the value. If the value represents
  2338. multiple items like an \"_ALL\" property, separate the items by
  2339. spaces.")
  2340. (defcustom org-global-properties nil
  2341. "List of property/value pairs that can be inherited by any entry.
  2342. This list will be combined with the constant `org-global-properties-fixed'.
  2343. The entries in this list are cons cells where the car is a property
  2344. name and cdr is a string with the value.
  2345. You can set buffer-local values for the same purpose in the variable
  2346. `org-file-properties' this by adding lines like
  2347. #+PROPERTY: NAME VALUE"
  2348. :group 'org-properties
  2349. :type '(repeat
  2350. (cons (string :tag "Property")
  2351. (string :tag "Value"))))
  2352. (defvar org-file-properties nil
  2353. "List of property/value pairs that can be inherited by any entry.
  2354. Valid for the current buffer.
  2355. This variable is populated from #+PROPERTY lines.")
  2356. (make-variable-buffer-local 'org-file-properties)
  2357. (defgroup org-agenda nil
  2358. "Options concerning agenda views in Org-mode."
  2359. :tag "Org Agenda"
  2360. :group 'org)
  2361. (defvar org-category nil
  2362. "Variable used by org files to set a category for agenda display.
  2363. Such files should use a file variable to set it, for example
  2364. # -*- mode: org; org-category: \"ELisp\"
  2365. or contain a special line
  2366. #+CATEGORY: ELisp
  2367. If the file does not specify a category, then file's base name
  2368. is used instead.")
  2369. (make-variable-buffer-local 'org-category)
  2370. (put 'org-category 'safe-local-variable '(lambda (x) (or (symbolp x) (stringp x))))
  2371. (defcustom org-agenda-files nil
  2372. "The files to be used for agenda display.
  2373. Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
  2374. \\[org-remove-file]. You can also use customize to edit the list.
  2375. If an entry is a directory, all files in that directory that are matched by
  2376. `org-agenda-file-regexp' will be part of the file list.
  2377. If the value of the variable is not a list but a single file name, then
  2378. the list of agenda files is actually stored and maintained in that file, one
  2379. agenda file per line."
  2380. :group 'org-agenda
  2381. :type '(choice
  2382. (repeat :tag "List of files and directories" file)
  2383. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  2384. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  2385. "Regular expression to match files for `org-agenda-files'.
  2386. If any element in the list in that variable contains a directory instead
  2387. of a normal file, all files in that directory that are matched by this
  2388. regular expression will be included."
  2389. :group 'org-agenda
  2390. :type 'regexp)
  2391. (defcustom org-agenda-text-search-extra-files nil
  2392. "List of extra files to be searched by text search commands.
  2393. These files will be search in addition to the agenda files by the
  2394. commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
  2395. Note that these files will only be searched for text search commands,
  2396. not for the other agenda views like todo lists, tag searches or the weekly
  2397. agenda. This variable is intended to list notes and possibly archive files
  2398. that should also be searched by these two commands.
  2399. In fact, if the first element in the list is the symbol `agenda-archives',
  2400. than all archive files of all agenda files will be added to the search
  2401. scope."
  2402. :group 'org-agenda
  2403. :type '(set :greedy t
  2404. (const :tag "Agenda Archives" agenda-archives)
  2405. (repeat :inline t (file))))
  2406. (if (fboundp 'defvaralias)
  2407. (defvaralias 'org-agenda-multi-occur-extra-files
  2408. 'org-agenda-text-search-extra-files))
  2409. (defcustom org-agenda-skip-unavailable-files nil
  2410. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  2411. A nil value means to remove them, after a query, from the list."
  2412. :group 'org-agenda
  2413. :type 'boolean)
  2414. (defcustom org-calendar-to-agenda-key [?c]
  2415. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  2416. The command `org-calendar-goto-agenda' will be bound to this key. The
  2417. default is the character `c' because then `c' can be used to switch back and
  2418. forth between agenda and calendar."
  2419. :group 'org-agenda
  2420. :type 'sexp)
  2421. (defcustom org-calendar-agenda-action-key [?k]
  2422. "The key to be installed in `calendar-mode-map' for agenda-action.
  2423. The command `org-agenda-action' will be bound to this key. The
  2424. default is the character `k' because we use the same key in the agenda."
  2425. :group 'org-agenda
  2426. :type 'sexp)
  2427. (defcustom org-calendar-insert-diary-entry-key [?i]
  2428. "The key to be installed in `calendar-mode-map' for adding diary entries.
  2429. This option is irrelevant until `org-agenda-diary-file' has been configured
  2430. to point to an Org-mode file. When that is the case, the command
  2431. `org-agenda-diary-entry' will be bound to the key given here, by default
  2432. `i'. In the calendar, `i' normally adds entries to `diary-file'. So
  2433. if you want to continue doing this, you need to change this to a different
  2434. key."
  2435. :group 'org-agenda
  2436. :type 'sexp)
  2437. (defcustom org-agenda-diary-file 'diary-file
  2438. "File to which to add new entries with the `i' key in agenda and calendar.
  2439. When this is the symbol `diary-file', the functionality in the Emacs
  2440. calendar will be used to add entries to the `diary-file'. But when this
  2441. points to a file, `org-agenda-diary-entry' will be used instead."
  2442. :group 'org-agenda
  2443. :type '(choice
  2444. (const :tag "The standard Emacs diary file" diary-file)
  2445. (file :tag "Special Org file diary entries")))
  2446. (eval-after-load "calendar"
  2447. '(progn
  2448. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  2449. 'org-calendar-goto-agenda)
  2450. (org-defkey calendar-mode-map org-calendar-agenda-action-key
  2451. 'org-agenda-action)
  2452. (add-hook 'calendar-mode-hook
  2453. (lambda ()
  2454. (unless (eq org-agenda-diary-file 'diary-file)
  2455. (define-key calendar-mode-map
  2456. org-calendar-insert-diary-entry-key
  2457. 'org-agenda-diary-entry))))))
  2458. (defgroup org-latex nil
  2459. "Options for embedding LaTeX code into Org-mode."
  2460. :tag "Org LaTeX"
  2461. :group 'org)
  2462. (defcustom org-format-latex-options
  2463. '(:foreground default :background default :scale 1.0
  2464. :html-foreground "Black" :html-background "Transparent" :html-scale 1.0
  2465. :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
  2466. "Options for creating images from LaTeX fragments.
  2467. This is a property list with the following properties:
  2468. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  2469. `default' means use the foreground of the default face.
  2470. :background the background color, or \"Transparent\".
  2471. `default' means use the background of the default face.
  2472. :scale a scaling factor for the size of the images.
  2473. :html-foreground, :html-background, :html-scale
  2474. the same numbers for HTML export.
  2475. :matchers a list indicating which matchers should be used to
  2476. find LaTeX fragments. Valid members of this list are:
  2477. \"begin\" find environments
  2478. \"$1\" find single characters surrounded by $.$
  2479. \"$\" find math expressions surrounded by $...$
  2480. \"$$\" find math expressions surrounded by $$....$$
  2481. \"\\(\" find math expressions surrounded by \\(...\\)
  2482. \"\\ [\" find math expressions surrounded by \\ [...\\]"
  2483. :group 'org-latex
  2484. :type 'plist)
  2485. (defcustom org-format-latex-signal-error t
  2486. "Non-nil means signal an error when image creation of LaTeX snippets fails.
  2487. When nil, just push out a message."
  2488. :group 'org-latex
  2489. :type 'boolean)
  2490. (defcustom org-format-latex-header "\\documentclass{article}
  2491. \\usepackage{amssymb}
  2492. \\usepackage[usenames]{color}
  2493. \\usepackage{amsmath}
  2494. \\usepackage{latexsym}
  2495. \\usepackage[mathscr]{eucal}
  2496. \\pagestyle{empty} % do not remove
  2497. % The settings below are copied from fullpage.sty
  2498. \\setlength{\\textwidth}{\\paperwidth}
  2499. \\addtolength{\\textwidth}{-3cm}
  2500. \\setlength{\\oddsidemargin}{1.5cm}
  2501. \\addtolength{\\oddsidemargin}{-2.54cm}
  2502. \\setlength{\\evensidemargin}{\\oddsidemargin}
  2503. \\setlength{\\textheight}{\\paperheight}
  2504. \\addtolength{\\textheight}{-\\headheight}
  2505. \\addtolength{\\textheight}{-\\headsep}
  2506. \\addtolength{\\textheight}{-\\footskip}
  2507. \\addtolength{\\textheight}{-3cm}
  2508. \\setlength{\\topmargin}{1.5cm}
  2509. \\addtolength{\\topmargin}{-2.54cm}"
  2510. "The document header used for processing LaTeX fragments.
  2511. It is imperative that this header make sure that no page number
  2512. appears on the page."
  2513. :group 'org-latex
  2514. :type 'string)
  2515. (defvar org-format-latex-header-extra nil)
  2516. ;; The following variable is defined here because is it also used
  2517. ;; when formatting latex fragments. Originally it was part of the
  2518. ;; LaTeX exporter, which is why the name includes "export".
  2519. (defcustom org-export-latex-packages-alist nil
  2520. "Alist of packages to be inserted in the header.
  2521. Each cell is of the format \( \"option\" . \"package\" \)."
  2522. :group 'org-export-latex
  2523. :type '(repeat
  2524. (list
  2525. (string :tag "option")
  2526. (string :tag "package"))))
  2527. (defgroup org-font-lock nil
  2528. "Font-lock settings for highlighting in Org-mode."
  2529. :tag "Org Font Lock"
  2530. :group 'org)
  2531. (defcustom org-level-color-stars-only nil
  2532. "Non-nil means fontify only the stars in each headline.
  2533. When nil, the entire headline is fontified.
  2534. Changing it requires restart of `font-lock-mode' to become effective
  2535. also in regions already fontified."
  2536. :group 'org-font-lock
  2537. :type 'boolean)
  2538. (defcustom org-hide-leading-stars nil
  2539. "Non-nil means hide the first N-1 stars in a headline.
  2540. This works by using the face `org-hide' for these stars. This
  2541. face is white for a light background, and black for a dark
  2542. background. You may have to customize the face `org-hide' to
  2543. make this work.
  2544. Changing it requires restart of `font-lock-mode' to become effective
  2545. also in regions already fontified.
  2546. You may also set this on a per-file basis by adding one of the following
  2547. lines to the buffer:
  2548. #+STARTUP: hidestars
  2549. #+STARTUP: showstars"
  2550. :group 'org-font-lock
  2551. :type 'boolean)
  2552. (defcustom org-fontify-done-headline nil
  2553. "Non-nil means change the face of a headline if it is marked DONE.
  2554. Normally, only the TODO/DONE keyword indicates the state of a headline.
  2555. When this is non-nil, the headline after the keyword is set to the
  2556. `org-headline-done' as an additional indication."
  2557. :group 'org-font-lock
  2558. :type 'boolean)
  2559. (defcustom org-fontify-emphasized-text t
  2560. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  2561. Changing this variable requires a restart of Emacs to take effect."
  2562. :group 'org-font-lock
  2563. :type 'boolean)
  2564. (defcustom org-fontify-whole-heading-line nil
  2565. "Non-nil means fontify the whole line for headings.
  2566. This is useful when setting a background color for the
  2567. org-level-* faces."
  2568. :group 'org-font-lock
  2569. :type 'boolean)
  2570. (defcustom org-highlight-latex-fragments-and-specials nil
  2571. "Non-nil means fontify what is treated specially by the exporters."
  2572. :group 'org-font-lock
  2573. :type 'boolean)
  2574. (defcustom org-hide-emphasis-markers nil
  2575. "Non-nil mean font-lock should hide the emphasis marker characters."
  2576. :group 'org-font-lock
  2577. :type 'boolean)
  2578. (defvar org-emph-re nil
  2579. "Regular expression for matching emphasis.")
  2580. (defvar org-verbatim-re nil
  2581. "Regular expression for matching verbatim text.")
  2582. (defvar org-emphasis-regexp-components) ; defined just below
  2583. (defvar org-emphasis-alist) ; defined just below
  2584. (defun org-set-emph-re (var val)
  2585. "Set variable and compute the emphasis regular expression."
  2586. (set var val)
  2587. (when (and (boundp 'org-emphasis-alist)
  2588. (boundp 'org-emphasis-regexp-components)
  2589. org-emphasis-alist org-emphasis-regexp-components)
  2590. (let* ((e org-emphasis-regexp-components)
  2591. (pre (car e))
  2592. (post (nth 1 e))
  2593. (border (nth 2 e))
  2594. (body (nth 3 e))
  2595. (nl (nth 4 e))
  2596. (body1 (concat body "*?"))
  2597. (markers (mapconcat 'car org-emphasis-alist ""))
  2598. (vmarkers (mapconcat
  2599. (lambda (x) (if (eq (nth 4 x) 'verbatim) (car x) ""))
  2600. org-emphasis-alist "")))
  2601. ;; make sure special characters appear at the right position in the class
  2602. (if (string-match "\\^" markers)
  2603. (setq markers (concat (replace-match "" t t markers) "^")))
  2604. (if (string-match "-" markers)
  2605. (setq markers (concat (replace-match "" t t markers) "-")))
  2606. (if (string-match "\\^" vmarkers)
  2607. (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
  2608. (if (string-match "-" vmarkers)
  2609. (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
  2610. (if (> nl 0)
  2611. (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
  2612. (int-to-string nl) "\\}")))
  2613. ;; Make the regexp
  2614. (setq org-emph-re
  2615. (concat "\\([" pre "]\\|^\\)"
  2616. "\\("
  2617. "\\([" markers "]\\)"
  2618. "\\("
  2619. "[^" border "]\\|"
  2620. "[^" border "]"
  2621. body1
  2622. "[^" border "]"
  2623. "\\)"
  2624. "\\3\\)"
  2625. "\\([" post "]\\|$\\)"))
  2626. (setq org-verbatim-re
  2627. (concat "\\([" pre "]\\|^\\)"
  2628. "\\("
  2629. "\\([" vmarkers "]\\)"
  2630. "\\("
  2631. "[^" border "]\\|"
  2632. "[^" border "]"
  2633. body1
  2634. "[^" border "]"
  2635. "\\)"
  2636. "\\3\\)"
  2637. "\\([" post "]\\|$\\)")))))
  2638. (defcustom org-emphasis-regexp-components
  2639. '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
  2640. "Components used to build the regular expression for emphasis.
  2641. This is a list with 6 entries. Terminology: In an emphasis string
  2642. like \" *strong word* \", we call the initial space PREMATCH, the final
  2643. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  2644. and \"trong wor\" is the body. The different components in this variable
  2645. specify what is allowed/forbidden in each part:
  2646. pre Chars allowed as prematch. Beginning of line will be allowed too.
  2647. post Chars allowed as postmatch. End of line will be allowed too.
  2648. border The chars *forbidden* as border characters.
  2649. body-regexp A regexp like \".\" to match a body character. Don't use
  2650. non-shy groups here, and don't allow newline here.
  2651. newline The maximum number of newlines allowed in an emphasis exp.
  2652. Use customize to modify this, or restart Emacs after changing it."
  2653. :group 'org-font-lock
  2654. :set 'org-set-emph-re
  2655. :type '(list
  2656. (sexp :tag "Allowed chars in pre ")
  2657. (sexp :tag "Allowed chars in post ")
  2658. (sexp :tag "Forbidden chars in border ")
  2659. (sexp :tag "Regexp for body ")
  2660. (integer :tag "number of newlines allowed")
  2661. (option (boolean :tag "Please ignore this button"))))
  2662. (defcustom org-emphasis-alist
  2663. `(("*" bold "<b>" "</b>")
  2664. ("/" italic "<i>" "</i>")
  2665. ("_" underline "<span style=\"text-decoration:underline;\">" "</span>")
  2666. ("=" org-code "<code>" "</code>" verbatim)
  2667. ("~" org-verbatim "<code>" "</code>" verbatim)
  2668. ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))
  2669. "<del>" "</del>")
  2670. )
  2671. "Special syntax for emphasized text.
  2672. Text starting and ending with a special character will be emphasized, for
  2673. example *bold*, _underlined_ and /italic/. This variable sets the marker
  2674. characters, the face to be used by font-lock for highlighting in Org-mode
  2675. Emacs buffers, and the HTML tags to be used for this.
  2676. For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
  2677. Use customize to modify this, or restart Emacs after changing it."
  2678. :group 'org-font-lock
  2679. :set 'org-set-emph-re
  2680. :type '(repeat
  2681. (list
  2682. (string :tag "Marker character")
  2683. (choice
  2684. (face :tag "Font-lock-face")
  2685. (plist :tag "Face property list"))
  2686. (string :tag "HTML start tag")
  2687. (string :tag "HTML end tag")
  2688. (option (const verbatim)))))
  2689. (defvar org-protecting-blocks
  2690. '("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")
  2691. "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
  2692. This is needed for font-lock setup.")
  2693. ;;; Miscellaneous options
  2694. (defgroup org-completion nil
  2695. "Completion in Org-mode."
  2696. :tag "Org Completion"
  2697. :group 'org)
  2698. (defcustom org-completion-use-ido nil
  2699. "Non-nil means use ido completion wherever possible.
  2700. Note that `ido-mode' must be active for this variable to be relevant.
  2701. If you decide to turn this variable on, you might well want to turn off
  2702. `org-outline-path-complete-in-steps'.
  2703. See also `org-completion-use-iswitchb'."
  2704. :group 'org-completion
  2705. :type 'boolean)
  2706. (defcustom org-completion-use-iswitchb nil
  2707. "Non-nil means use iswitchb completion wherever possible.
  2708. Note that `iswitchb-mode' must be active for this variable to be relevant.
  2709. If you decide to turn this variable on, you might well want to turn off
  2710. `org-outline-path-complete-in-steps'.
  2711. Note that this variable has only an effect if `org-completion-use-ido' is nil."
  2712. :group 'org-completion
  2713. :type 'boolean)
  2714. (defcustom org-completion-fallback-command 'hippie-expand
  2715. "The expansion command called by \\[org-complete] in normal context.
  2716. Normal means no org-mode-specific context."
  2717. :group 'org-completion
  2718. :type 'function)
  2719. ;;; Functions and variables from their packages
  2720. ;; Declared here to avoid compiler warnings
  2721. ;; XEmacs only
  2722. (defvar outline-mode-menu-heading)
  2723. (defvar outline-mode-menu-show)
  2724. (defvar outline-mode-menu-hide)
  2725. (defvar zmacs-regions) ; XEmacs regions
  2726. ;; Emacs only
  2727. (defvar mark-active)
  2728. ;; Various packages
  2729. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  2730. (declare-function calendar-forward-day "cal-move" (arg))
  2731. (declare-function calendar-goto-date "cal-move" (date))
  2732. (declare-function calendar-goto-today "cal-move" ())
  2733. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  2734. (defvar calc-embedded-close-formula)
  2735. (defvar calc-embedded-open-formula)
  2736. (declare-function cdlatex-tab "ext:cdlatex" ())
  2737. (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
  2738. (defvar font-lock-unfontify-region-function)
  2739. (declare-function iswitchb-read-buffer "iswitchb"
  2740. (prompt &optional default require-match start matches-set))
  2741. (defvar iswitchb-temp-buflist)
  2742. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  2743. (defvar org-agenda-tags-todo-honor-ignore-options)
  2744. (declare-function org-agenda-skip "org-agenda" ())
  2745. (declare-function
  2746. org-format-agenda-item "org-agenda"
  2747. (extra txt &optional category tags dotime noprefix remove-re habitp))
  2748. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  2749. (declare-function org-agenda-change-all-lines "org-agenda"
  2750. (newhead hdmarker &optional fixface just-this))
  2751. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  2752. (declare-function org-agenda-maybe-redo "org-agenda" ())
  2753. (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
  2754. (beg end))
  2755. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  2756. (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  2757. "org-agenda" (&optional end))
  2758. (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  2759. (declare-function org-indent-mode "org-indent" (&optional arg))
  2760. (declare-function parse-time-string "parse-time" (string))
  2761. (declare-function org-attach-reveal "org-attach" (&optional if-exists))
  2762. (defvar remember-data-file)
  2763. (defvar texmathp-why)
  2764. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  2765. (declare-function table--at-cell-p "table" (position &optional object at-column))
  2766. (defvar w3m-current-url)
  2767. (defvar w3m-current-title)
  2768. (defvar org-latex-regexps)
  2769. ;;; Autoload and prepare some org modules
  2770. ;; Some table stuff that needs to be defined here, because it is used
  2771. ;; by the functions setting up org-mode or checking for table context.
  2772. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  2773. "Detects an org-type or table-type table.")
  2774. (defconst org-table-line-regexp "^[ \t]*|"
  2775. "Detects an org-type table line.")
  2776. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  2777. "Detects an org-type table line.")
  2778. (defconst org-table-hline-regexp "^[ \t]*|-"
  2779. "Detects an org-type table hline.")
  2780. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  2781. "Detects a table-type table hline.")
  2782. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  2783. "Searching from within a table (any type) this finds the first line
  2784. outside the table.")
  2785. ;; Autoload the functions in org-table.el that are needed by functions here.
  2786. (eval-and-compile
  2787. (org-autoload "org-table"
  2788. '(org-table-align org-table-begin org-table-blank-field
  2789. org-table-convert org-table-convert-region org-table-copy-down
  2790. org-table-copy-region org-table-create
  2791. org-table-create-or-convert-from-region
  2792. org-table-create-with-table.el org-table-current-dline
  2793. org-table-cut-region org-table-delete-column org-table-edit-field
  2794. org-table-edit-formulas org-table-end org-table-eval-formula
  2795. org-table-export org-table-field-info
  2796. org-table-get-stored-formulas org-table-goto-column
  2797. org-table-hline-and-move org-table-import org-table-insert-column
  2798. org-table-insert-hline org-table-insert-row org-table-iterate
  2799. org-table-justify-field-maybe org-table-kill-row
  2800. org-table-maybe-eval-formula org-table-maybe-recalculate-line
  2801. org-table-move-column org-table-move-column-left
  2802. org-table-move-column-right org-table-move-row
  2803. org-table-move-row-down org-table-move-row-up
  2804. org-table-next-field org-table-next-row org-table-paste-rectangle
  2805. org-table-previous-field org-table-recalculate
  2806. org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
  2807. org-table-toggle-coordinate-overlays
  2808. org-table-toggle-formula-debugger org-table-wrap-region
  2809. orgtbl-mode turn-on-orgtbl org-table-to-lisp)))
  2810. (defun org-at-table-p (&optional table-type)
  2811. "Return t if the cursor is inside an org-type table.
  2812. If TABLE-TYPE is non-nil, also check for table.el-type tables."
  2813. (if org-enable-table-editor
  2814. (save-excursion
  2815. (beginning-of-line 1)
  2816. (looking-at (if table-type org-table-any-line-regexp
  2817. org-table-line-regexp)))
  2818. nil))
  2819. (defsubst org-table-p () (org-at-table-p))
  2820. (defun org-at-table.el-p ()
  2821. "Return t if and only if we are at a table.el table."
  2822. (and (org-at-table-p 'any)
  2823. (save-excursion
  2824. (goto-char (org-table-begin 'any))
  2825. (looking-at org-table1-hline-regexp))))
  2826. (defun org-table-recognize-table.el ()
  2827. "If there is a table.el table nearby, recognize it and move into it."
  2828. (if org-table-tab-recognizes-table.el
  2829. (if (org-at-table.el-p)
  2830. (progn
  2831. (beginning-of-line 1)
  2832. (if (looking-at org-table-dataline-regexp)
  2833. nil
  2834. (if (looking-at org-table1-hline-regexp)
  2835. (progn
  2836. (beginning-of-line 2)
  2837. (if (looking-at org-table-any-border-regexp)
  2838. (beginning-of-line -1)))))
  2839. (if (re-search-forward "|" (org-table-end t) t)
  2840. (progn
  2841. (require 'table)
  2842. (if (table--at-cell-p (point))
  2843. t
  2844. (message "recognizing table.el table...")
  2845. (table-recognize-table)
  2846. (message "recognizing table.el table...done")))
  2847. (error "This should not happen..."))
  2848. t)
  2849. nil)
  2850. nil))
  2851. (defun org-at-table-hline-p ()
  2852. "Return t if the cursor is inside a hline in a table."
  2853. (if org-enable-table-editor
  2854. (save-excursion
  2855. (beginning-of-line 1)
  2856. (looking-at org-table-hline-regexp))
  2857. nil))
  2858. (defvar org-table-clean-did-remove-column nil)
  2859. (defun org-table-map-tables (function)
  2860. "Apply FUNCTION to the start of all tables in the buffer."
  2861. (save-excursion
  2862. (save-restriction
  2863. (widen)
  2864. (goto-char (point-min))
  2865. (while (re-search-forward org-table-any-line-regexp nil t)
  2866. (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
  2867. (beginning-of-line 1)
  2868. (when (looking-at org-table-line-regexp)
  2869. (save-excursion (funcall function))
  2870. (or (looking-at org-table-line-regexp)
  2871. (forward-char 1)))
  2872. (re-search-forward org-table-any-border-regexp nil 1))))
  2873. (message "Mapping tables: done"))
  2874. ;; Declare and autoload functions from org-exp.el & Co
  2875. (declare-function org-default-export-plist "org-exp")
  2876. (declare-function org-infile-export-plist "org-exp")
  2877. (declare-function org-get-current-options "org-exp")
  2878. (eval-and-compile
  2879. (org-autoload "org-exp"
  2880. '(org-export org-export-visible
  2881. org-insert-export-options-template
  2882. org-table-clean-before-export))
  2883. (org-autoload "org-ascii"
  2884. '(org-export-as-ascii org-export-ascii-preprocess
  2885. org-export-as-ascii-to-buffer org-replace-region-by-ascii
  2886. org-export-region-as-ascii))
  2887. (org-autoload "org-latex"
  2888. '(org-export-as-latex-batch org-export-as-latex-to-buffer
  2889. org-replace-region-by-latex org-export-region-as-latex
  2890. org-export-as-latex org-export-as-pdf
  2891. org-export-as-pdf-and-open))
  2892. (org-autoload "org-html"
  2893. '(org-export-as-html-and-open
  2894. org-export-as-html-batch org-export-as-html-to-buffer
  2895. org-replace-region-by-html org-export-region-as-html
  2896. org-export-as-html))
  2897. (org-autoload "org-docbook"
  2898. '(org-export-as-docbook-batch org-export-as-docbook-to-buffer
  2899. org-replace-region-by-docbook org-export-region-as-docbook
  2900. org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
  2901. org-export-as-docbook))
  2902. (org-autoload "org-icalendar"
  2903. '(org-export-icalendar-this-file
  2904. org-export-icalendar-all-agenda-files
  2905. org-export-icalendar-combine-agenda-files))
  2906. (org-autoload "org-xoxo" '(org-export-as-xoxo))
  2907. (org-autoload "org-beamer" '(org-beamer-mode org-beamer-sectioning)))
  2908. ;; Declare and autoload functions from org-agenda.el
  2909. (eval-and-compile
  2910. (org-autoload "org-agenda"
  2911. '(org-agenda org-agenda-list org-search-view
  2912. org-todo-list org-tags-view org-agenda-list-stuck-projects
  2913. org-diary org-agenda-to-appt
  2914. org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
  2915. ;; Autoload org-remember
  2916. (eval-and-compile
  2917. (org-autoload "org-remember"
  2918. '(org-remember-insinuate org-remember-annotation
  2919. org-remember-apply-template org-remember org-remember-handler)))
  2920. ;; Autoload org-clock.el
  2921. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock"
  2922. (beg end))
  2923. (declare-function org-clock-update-mode-line "org-clock" ())
  2924. (declare-function org-resolve-clocks "org-clock"
  2925. (&optional also-non-dangling-p prompt last-valid))
  2926. (defvar org-clock-start-time)
  2927. (defvar org-clock-marker (make-marker)
  2928. "Marker recording the last clock-in.")
  2929. (defvar org-clock-hd-marker (make-marker)
  2930. "Marker recording the last clock-in, but the headline position.")
  2931. (defvar org-clock-heading ""
  2932. "The heading of the current clock entry.")
  2933. (defun org-clock-is-active ()
  2934. "Return non-nil if clock is currently running.
  2935. The return value is actually the clock marker."
  2936. (marker-buffer org-clock-marker))
  2937. (eval-and-compile
  2938. (org-autoload
  2939. "org-clock"
  2940. '(org-clock-in org-clock-out org-clock-cancel
  2941. org-clock-goto org-clock-sum org-clock-display
  2942. org-clock-remove-overlays org-clock-report
  2943. org-clocktable-shift org-dblock-write:clocktable
  2944. org-get-clocktable org-resolve-clocks)))
  2945. (defun org-clock-update-time-maybe ()
  2946. "If this is a CLOCK line, update it and return t.
  2947. Otherwise, return nil."
  2948. (interactive)
  2949. (save-excursion
  2950. (beginning-of-line 1)
  2951. (skip-chars-forward " \t")
  2952. (when (looking-at org-clock-string)
  2953. (let ((re (concat "[ \t]*" org-clock-string
  2954. " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
  2955. "\\([ \t]*=>.*\\)?\\)?"))
  2956. ts te h m s neg)
  2957. (cond
  2958. ((not (looking-at re))
  2959. nil)
  2960. ((not (match-end 2))
  2961. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  2962. (> org-clock-marker (point))
  2963. (<= org-clock-marker (point-at-eol)))
  2964. ;; The clock is running here
  2965. (setq org-clock-start-time
  2966. (apply 'encode-time
  2967. (org-parse-time-string (match-string 1))))
  2968. (org-clock-update-mode-line)))
  2969. (t
  2970. (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
  2971. (end-of-line 1)
  2972. (setq ts (match-string 1)
  2973. te (match-string 3))
  2974. (setq s (- (org-float-time
  2975. (apply 'encode-time (org-parse-time-string te)))
  2976. (org-float-time
  2977. (apply 'encode-time (org-parse-time-string ts))))
  2978. neg (< s 0)
  2979. s (abs s)
  2980. h (floor (/ s 3600))
  2981. s (- s (* 3600 h))
  2982. m (floor (/ s 60))
  2983. s (- s (* 60 s)))
  2984. (insert " => " (format (if neg "-%d:%02d" "%2d:%02d") h m))
  2985. t))))))
  2986. (defun org-check-running-clock ()
  2987. "Check if the current buffer contains the running clock.
  2988. If yes, offer to stop it and to save the buffer with the changes."
  2989. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  2990. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  2991. (buffer-name))))
  2992. (org-clock-out)
  2993. (when (y-or-n-p "Save changed buffer?")
  2994. (save-buffer))))
  2995. (defun org-clocktable-try-shift (dir n)
  2996. "Check if this line starts a clock table, if yes, shift the time block."
  2997. (when (org-match-line "#\\+BEGIN: clocktable\\>")
  2998. (org-clocktable-shift dir n)))
  2999. ;; Autoload org-timer.el
  3000. (eval-and-compile
  3001. (org-autoload
  3002. "org-timer"
  3003. '(org-timer-start org-timer org-timer-item
  3004. org-timer-change-times-in-region
  3005. org-timer-set-timer
  3006. org-timer-reset-timers
  3007. org-timer-show-remaining-time)))
  3008. ;; Autoload org-feed.el
  3009. (eval-and-compile
  3010. (org-autoload
  3011. "org-feed"
  3012. '(org-feed-update org-feed-update-all org-feed-goto-inbox)))
  3013. ;; Autoload org-indent.el
  3014. ;; Define the variable already here, to make sure we have it.
  3015. (defvar org-indent-mode nil
  3016. "Non-nil if Org-Indent mode is enabled.
  3017. Use the command `org-indent-mode' to change this variable.")
  3018. (eval-and-compile
  3019. (org-autoload
  3020. "org-indent"
  3021. '(org-indent-mode)))
  3022. ;; Autoload org-mobile.el
  3023. (eval-and-compile
  3024. (org-autoload
  3025. "org-mobile"
  3026. '(org-mobile-push org-mobile-pull org-mobile-create-sumo-agenda)))
  3027. ;; Autoload archiving code
  3028. ;; The stuff that is needed for cycling and tags has to be defined here.
  3029. (defgroup org-archive nil
  3030. "Options concerning archiving in Org-mode."
  3031. :tag "Org Archive"
  3032. :group 'org-structure)
  3033. (defcustom org-archive-location "%s_archive::"
  3034. "The location where subtrees should be archived.
  3035. The value of this variable is a string, consisting of two parts,
  3036. separated by a double-colon. The first part is a filename and
  3037. the second part is a headline.
  3038. When the filename is omitted, archiving happens in the same file.
  3039. %s in the filename will be replaced by the current file
  3040. name (without the directory part). Archiving to a different file
  3041. is useful to keep archived entries from contributing to the
  3042. Org-mode Agenda.
  3043. The archived entries will be filed as subtrees of the specified
  3044. headline. When the headline is omitted, the subtrees are simply
  3045. filed away at the end of the file, as top-level entries. Also in
  3046. the heading you can use %s to represent the file name, this can be
  3047. useful when using the same archive for a number of different files.
  3048. Here are a few examples:
  3049. \"%s_archive::\"
  3050. If the current file is Projects.org, archive in file
  3051. Projects.org_archive, as top-level trees. This is the default.
  3052. \"::* Archived Tasks\"
  3053. Archive in the current file, under the top-level headline
  3054. \"* Archived Tasks\".
  3055. \"~/org/archive.org::\"
  3056. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  3057. \"~/org/archive.org::From %s\"
  3058. Archive in file ~/org/archive.org (absolute path), under headlines
  3059. \"From FILENAME\" where file name is the current file name.
  3060. \"basement::** Finished Tasks\"
  3061. Archive in file ./basement (relative path), as level 3 trees
  3062. below the level 2 heading \"** Finished Tasks\".
  3063. You may set this option on a per-file basis by adding to the buffer a
  3064. line like
  3065. #+ARCHIVE: basement::** Finished Tasks
  3066. You may also define it locally for a subtree by setting an ARCHIVE property
  3067. in the entry. If such a property is found in an entry, or anywhere up
  3068. the hierarchy, it will be used."
  3069. :group 'org-archive
  3070. :type 'string)
  3071. (defcustom org-archive-tag "ARCHIVE"
  3072. "The tag that marks a subtree as archived.
  3073. An archived subtree does not open during visibility cycling, and does
  3074. not contribute to the agenda listings.
  3075. After changing this, font-lock must be restarted in the relevant buffers to
  3076. get the proper fontification."
  3077. :group 'org-archive
  3078. :group 'org-keywords
  3079. :type 'string)
  3080. (defcustom org-agenda-skip-archived-trees t
  3081. "Non-nil means the agenda will skip any items located in archived trees.
  3082. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  3083. variable is no longer recommended, you should leave it at the value t.
  3084. Instead, use the key `v' to cycle the archives-mode in the agenda."
  3085. :group 'org-archive
  3086. :group 'org-agenda-skip
  3087. :type 'boolean)
  3088. (defcustom org-columns-skip-archived-trees t
  3089. "Non-nil means ignore archived trees when creating column view."
  3090. :group 'org-archive
  3091. :group 'org-properties
  3092. :type 'boolean)
  3093. (defcustom org-cycle-open-archived-trees nil
  3094. "Non-nil means `org-cycle' will open archived trees.
  3095. An archived tree is a tree marked with the tag ARCHIVE.
  3096. When nil, archived trees will stay folded. You can still open them with
  3097. normal outline commands like `show-all', but not with the cycling commands."
  3098. :group 'org-archive
  3099. :group 'org-cycle
  3100. :type 'boolean)
  3101. (defcustom org-sparse-tree-open-archived-trees nil
  3102. "Non-nil means sparse tree construction shows matches in archived trees.
  3103. When nil, matches in these trees are highlighted, but the trees are kept in
  3104. collapsed state."
  3105. :group 'org-archive
  3106. :group 'org-sparse-trees
  3107. :type 'boolean)
  3108. (defun org-cycle-hide-archived-subtrees (state)
  3109. "Re-hide all archived subtrees after a visibility state change."
  3110. (when (and (not org-cycle-open-archived-trees)
  3111. (not (memq state '(overview folded))))
  3112. (save-excursion
  3113. (let* ((globalp (memq state '(contents all)))
  3114. (beg (if globalp (point-min) (point)))
  3115. (end (if globalp (point-max) (org-end-of-subtree t))))
  3116. (org-hide-archived-subtrees beg end)
  3117. (goto-char beg)
  3118. (if (looking-at (concat ".*:" org-archive-tag ":"))
  3119. (message "%s" (substitute-command-keys
  3120. "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
  3121. (defun org-force-cycle-archived ()
  3122. "Cycle subtree even if it is archived."
  3123. (interactive)
  3124. (setq this-command 'org-cycle)
  3125. (let ((org-cycle-open-archived-trees t))
  3126. (call-interactively 'org-cycle)))
  3127. (defun org-hide-archived-subtrees (beg end)
  3128. "Re-hide all archived subtrees after a visibility state change."
  3129. (save-excursion
  3130. (let* ((re (concat ":" org-archive-tag ":")))
  3131. (goto-char beg)
  3132. (while (re-search-forward re end t)
  3133. (when (org-on-heading-p)
  3134. (org-flag-subtree t)
  3135. (org-end-of-subtree t))))))
  3136. (defun org-flag-subtree (flag)
  3137. (save-excursion
  3138. (org-back-to-heading t)
  3139. (outline-end-of-heading)
  3140. (outline-flag-region (point)
  3141. (progn (org-end-of-subtree t) (point))
  3142. flag)))
  3143. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  3144. (eval-and-compile
  3145. (org-autoload "org-archive"
  3146. '(org-add-archive-files org-archive-subtree
  3147. org-archive-to-archive-sibling org-toggle-archive-tag
  3148. org-archive-subtree-default
  3149. org-archive-subtree-default-with-confirmation)))
  3150. ;; Autoload Column View Code
  3151. (declare-function org-columns-number-to-string "org-colview")
  3152. (declare-function org-columns-get-format-and-top-level "org-colview")
  3153. (declare-function org-columns-compute "org-colview")
  3154. (org-autoload (if (featurep 'xemacs) "org-colview-xemacs" "org-colview")
  3155. '(org-columns-number-to-string org-columns-get-format-and-top-level
  3156. org-columns-compute org-agenda-columns org-columns-remove-overlays
  3157. org-columns org-insert-columns-dblock org-dblock-write:columnview))
  3158. ;; Autoload ID code
  3159. (declare-function org-id-store-link "org-id")
  3160. (declare-function org-id-locations-load "org-id")
  3161. (declare-function org-id-locations-save "org-id")
  3162. (defvar org-id-track-globally)
  3163. (org-autoload "org-id"
  3164. '(org-id-get-create org-id-new org-id-copy org-id-get
  3165. org-id-get-with-outline-path-completion
  3166. org-id-get-with-outline-drilling
  3167. org-id-goto org-id-find org-id-store-link))
  3168. ;; Autoload Plotting Code
  3169. (org-autoload "org-plot"
  3170. '(org-plot/gnuplot))
  3171. ;;; Variables for pre-computed regular expressions, all buffer local
  3172. (defvar org-drawer-regexp nil
  3173. "Matches first line of a hidden block.")
  3174. (make-variable-buffer-local 'org-drawer-regexp)
  3175. (defvar org-todo-regexp nil
  3176. "Matches any of the TODO state keywords.")
  3177. (make-variable-buffer-local 'org-todo-regexp)
  3178. (defvar org-not-done-regexp nil
  3179. "Matches any of the TODO state keywords except the last one.")
  3180. (make-variable-buffer-local 'org-not-done-regexp)
  3181. (defvar org-not-done-heading-regexp nil
  3182. "Matches a TODO headline that is not done.")
  3183. (make-variable-buffer-local 'org-not-done-regexp)
  3184. (defvar org-todo-line-regexp nil
  3185. "Matches a headline and puts TODO state into group 2 if present.")
  3186. (make-variable-buffer-local 'org-todo-line-regexp)
  3187. (defvar org-complex-heading-regexp nil
  3188. "Matches a headline and puts everything into groups:
  3189. group 1: the stars
  3190. group 2: The todo keyword, maybe
  3191. group 3: Priority cookie
  3192. group 4: True headline
  3193. group 5: Tags")
  3194. (make-variable-buffer-local 'org-complex-heading-regexp)
  3195. (defvar org-complex-heading-regexp-format nil)
  3196. (make-variable-buffer-local 'org-complex-heading-regexp-format)
  3197. (defvar org-todo-line-tags-regexp nil
  3198. "Matches a headline and puts TODO state into group 2 if present.
  3199. Also put tags into group 4 if tags are present.")
  3200. (make-variable-buffer-local 'org-todo-line-tags-regexp)
  3201. (defvar org-nl-done-regexp nil
  3202. "Matches newline followed by a headline with the DONE keyword.")
  3203. (make-variable-buffer-local 'org-nl-done-regexp)
  3204. (defvar org-looking-at-done-regexp nil
  3205. "Matches the DONE keyword a point.")
  3206. (make-variable-buffer-local 'org-looking-at-done-regexp)
  3207. (defvar org-ds-keyword-length 12
  3208. "Maximum length of the Deadline and SCHEDULED keywords.")
  3209. (make-variable-buffer-local 'org-ds-keyword-length)
  3210. (defvar org-deadline-regexp nil
  3211. "Matches the DEADLINE keyword.")
  3212. (make-variable-buffer-local 'org-deadline-regexp)
  3213. (defvar org-deadline-time-regexp nil
  3214. "Matches the DEADLINE keyword together with a time stamp.")
  3215. (make-variable-buffer-local 'org-deadline-time-regexp)
  3216. (defvar org-deadline-line-regexp nil
  3217. "Matches the DEADLINE keyword and the rest of the line.")
  3218. (make-variable-buffer-local 'org-deadline-line-regexp)
  3219. (defvar org-scheduled-regexp nil
  3220. "Matches the SCHEDULED keyword.")
  3221. (make-variable-buffer-local 'org-scheduled-regexp)
  3222. (defvar org-scheduled-time-regexp nil
  3223. "Matches the SCHEDULED keyword together with a time stamp.")
  3224. (make-variable-buffer-local 'org-scheduled-time-regexp)
  3225. (defvar org-closed-time-regexp nil
  3226. "Matches the CLOSED keyword together with a time stamp.")
  3227. (make-variable-buffer-local 'org-closed-time-regexp)
  3228. (defvar org-keyword-time-regexp nil
  3229. "Matches any of the 4 keywords, together with the time stamp.")
  3230. (make-variable-buffer-local 'org-keyword-time-regexp)
  3231. (defvar org-keyword-time-not-clock-regexp nil
  3232. "Matches any of the 3 keywords, together with the time stamp.")
  3233. (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
  3234. (defvar org-maybe-keyword-time-regexp nil
  3235. "Matches a timestamp, possibly preceeded by a keyword.")
  3236. (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
  3237. (defvar org-planning-or-clock-line-re nil
  3238. "Matches a line with planning or clock info.")
  3239. (make-variable-buffer-local 'org-planning-or-clock-line-re)
  3240. (defvar org-all-time-keywords nil
  3241. "List of time keywords.")
  3242. (make-variable-buffer-local 'org-all-time-keywords)
  3243. (defconst org-plain-time-of-day-regexp
  3244. (concat
  3245. "\\(\\<[012]?[0-9]"
  3246. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3247. "\\(--?"
  3248. "\\(\\<[012]?[0-9]"
  3249. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3250. "\\)?")
  3251. "Regular expression to match a plain time or time range.
  3252. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3253. groups carry important information:
  3254. 0 the full match
  3255. 1 the first time, range or not
  3256. 8 the second time, if it is a range.")
  3257. (defconst org-plain-time-extension-regexp
  3258. (concat
  3259. "\\(\\<[012]?[0-9]"
  3260. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3261. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  3262. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  3263. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3264. groups carry important information:
  3265. 0 the full match
  3266. 7 hours of duration
  3267. 9 minutes of duration")
  3268. (defconst org-stamp-time-of-day-regexp
  3269. (concat
  3270. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  3271. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  3272. "\\(--?"
  3273. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  3274. "Regular expression to match a timestamp time or time range.
  3275. After a match, the following groups carry important information:
  3276. 0 the full match
  3277. 1 date plus weekday, for back referencing to make sure both times are on the same day
  3278. 2 the first time, range or not
  3279. 4 the second time, if it is a range.")
  3280. (defconst org-startup-options
  3281. '(("fold" org-startup-folded t)
  3282. ("overview" org-startup-folded t)
  3283. ("nofold" org-startup-folded nil)
  3284. ("showall" org-startup-folded nil)
  3285. ("showeverything" org-startup-folded showeverything)
  3286. ("content" org-startup-folded content)
  3287. ("indent" org-startup-indented t)
  3288. ("noindent" org-startup-indented nil)
  3289. ("hidestars" org-hide-leading-stars t)
  3290. ("showstars" org-hide-leading-stars nil)
  3291. ("odd" org-odd-levels-only t)
  3292. ("oddeven" org-odd-levels-only nil)
  3293. ("align" org-startup-align-all-tables t)
  3294. ("noalign" org-startup-align-all-tables nil)
  3295. ("customtime" org-display-custom-times t)
  3296. ("logdone" org-log-done time)
  3297. ("lognotedone" org-log-done note)
  3298. ("nologdone" org-log-done nil)
  3299. ("lognoteclock-out" org-log-note-clock-out t)
  3300. ("nolognoteclock-out" org-log-note-clock-out nil)
  3301. ("logrepeat" org-log-repeat state)
  3302. ("lognoterepeat" org-log-repeat note)
  3303. ("nologrepeat" org-log-repeat nil)
  3304. ("logreschedule" org-log-reschedule time)
  3305. ("lognotereschedule" org-log-reschedule note)
  3306. ("nologreschedule" org-log-reschedule nil)
  3307. ("logredeadline" org-log-redeadline time)
  3308. ("lognoteredeadline" org-log-redeadline note)
  3309. ("nologredeadline" org-log-redeadline nil)
  3310. ("fninline" org-footnote-define-inline t)
  3311. ("nofninline" org-footnote-define-inline nil)
  3312. ("fnlocal" org-footnote-section nil)
  3313. ("fnauto" org-footnote-auto-label t)
  3314. ("fnprompt" org-footnote-auto-label nil)
  3315. ("fnconfirm" org-footnote-auto-label confirm)
  3316. ("fnplain" org-footnote-auto-label plain)
  3317. ("fnadjust" org-footnote-auto-adjust t)
  3318. ("nofnadjust" org-footnote-auto-adjust nil)
  3319. ("constcgs" constants-unit-system cgs)
  3320. ("constSI" constants-unit-system SI)
  3321. ("noptag" org-tag-persistent-alist nil)
  3322. ("hideblocks" org-hide-block-startup t)
  3323. ("nohideblocks" org-hide-block-startup nil)
  3324. ("beamer" org-startup-with-beamer-mode t))
  3325. "Variable associated with STARTUP options for org-mode.
  3326. Each element is a list of three items: The startup options as written
  3327. in the #+STARTUP line, the corresponding variable, and the value to
  3328. set this variable to if the option is found. An optional forth element PUSH
  3329. means to push this value onto the list in the variable.")
  3330. (defun org-set-regexps-and-options ()
  3331. "Precompute regular expressions for current buffer."
  3332. (when (org-mode-p)
  3333. (org-set-local 'org-todo-kwd-alist nil)
  3334. (org-set-local 'org-todo-key-alist nil)
  3335. (org-set-local 'org-todo-key-trigger nil)
  3336. (org-set-local 'org-todo-keywords-1 nil)
  3337. (org-set-local 'org-done-keywords nil)
  3338. (org-set-local 'org-todo-heads nil)
  3339. (org-set-local 'org-todo-sets nil)
  3340. (org-set-local 'org-todo-log-states nil)
  3341. (org-set-local 'org-file-properties nil)
  3342. (org-set-local 'org-file-tags nil)
  3343. (let ((re (org-make-options-regexp
  3344. '("CATEGORY" "TODO" "COLUMNS"
  3345. "STARTUP" "ARCHIVE" "FILETAGS" "TAGS" "LINK" "PRIORITIES"
  3346. "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE" "LATEX_CLASS")
  3347. "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
  3348. (splitre "[ \t]+")
  3349. kwds kws0 kwsa key log value cat arch tags const links hw dws
  3350. tail sep kws1 prio props ftags drawers beamer-p
  3351. ext-setup-or-nil setup-contents (start 0))
  3352. (save-excursion
  3353. (save-restriction
  3354. (widen)
  3355. (goto-char (point-min))
  3356. (while (or (and ext-setup-or-nil
  3357. (string-match re ext-setup-or-nil start)
  3358. (setq start (match-end 0)))
  3359. (and (setq ext-setup-or-nil nil start 0)
  3360. (re-search-forward re nil t)))
  3361. (setq key (upcase (match-string 1 ext-setup-or-nil))
  3362. value (org-match-string-no-properties 2 ext-setup-or-nil))
  3363. (cond
  3364. ((equal key "CATEGORY")
  3365. (if (string-match "[ \t]+$" value)
  3366. (setq value (replace-match "" t t value)))
  3367. (setq cat value))
  3368. ((member key '("SEQ_TODO" "TODO"))
  3369. (push (cons 'sequence (org-split-string value splitre)) kwds))
  3370. ((equal key "TYP_TODO")
  3371. (push (cons 'type (org-split-string value splitre)) kwds))
  3372. ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
  3373. ;; general TODO-like setup
  3374. (push (cons (intern (downcase (match-string 1 key)))
  3375. (org-split-string value splitre)) kwds))
  3376. ((equal key "TAGS")
  3377. (setq tags (append tags (if tags '("\\n") nil)
  3378. (org-split-string value splitre))))
  3379. ((equal key "COLUMNS")
  3380. (org-set-local 'org-columns-default-format value))
  3381. ((equal key "LINK")
  3382. (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  3383. (push (cons (match-string 1 value)
  3384. (org-trim (match-string 2 value)))
  3385. links)))
  3386. ((equal key "PRIORITIES")
  3387. (setq prio (org-split-string value " +")))
  3388. ((equal key "PROPERTY")
  3389. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  3390. (push (cons (match-string 1 value) (match-string 2 value))
  3391. props)))
  3392. ((equal key "FILETAGS")
  3393. (when (string-match "\\S-" value)
  3394. (setq ftags
  3395. (append
  3396. ftags
  3397. (apply 'append
  3398. (mapcar (lambda (x) (org-split-string x ":"))
  3399. (org-split-string value)))))))
  3400. ((equal key "DRAWERS")
  3401. (setq drawers (org-split-string value splitre)))
  3402. ((equal key "CONSTANTS")
  3403. (setq const (append const (org-split-string value splitre))))
  3404. ((equal key "STARTUP")
  3405. (let ((opts (org-split-string value splitre))
  3406. l var val)
  3407. (while (setq l (pop opts))
  3408. (when (setq l (assoc l org-startup-options))
  3409. (setq var (nth 1 l) val (nth 2 l))
  3410. (if (not (nth 3 l))
  3411. (set (make-local-variable var) val)
  3412. (if (not (listp (symbol-value var)))
  3413. (set (make-local-variable var) nil))
  3414. (set (make-local-variable var) (symbol-value var))
  3415. (add-to-list var val))))))
  3416. ((equal key "ARCHIVE")
  3417. (string-match " *$" value)
  3418. (setq arch (replace-match "" t t value))
  3419. (remove-text-properties 0 (length arch)
  3420. '(face t fontified t) arch))
  3421. ((equal key "LATEX_CLASS")
  3422. (setq beamer-p (equal value "beamer")))
  3423. ((equal key "SETUPFILE")
  3424. (setq setup-contents (org-file-contents
  3425. (expand-file-name
  3426. (org-remove-double-quotes value))
  3427. 'noerror))
  3428. (if (not ext-setup-or-nil)
  3429. (setq ext-setup-or-nil setup-contents start 0)
  3430. (setq ext-setup-or-nil
  3431. (concat (substring ext-setup-or-nil 0 start)
  3432. "\n" setup-contents "\n"
  3433. (substring ext-setup-or-nil start)))))
  3434. ))))
  3435. (when cat
  3436. (org-set-local 'org-category (intern cat))
  3437. (push (cons "CATEGORY" cat) props))
  3438. (when prio
  3439. (if (< (length prio) 3) (setq prio '("A" "C" "B")))
  3440. (setq prio (mapcar 'string-to-char prio))
  3441. (org-set-local 'org-highest-priority (nth 0 prio))
  3442. (org-set-local 'org-lowest-priority (nth 1 prio))
  3443. (org-set-local 'org-default-priority (nth 2 prio)))
  3444. (and props (org-set-local 'org-file-properties (nreverse props)))
  3445. (and ftags (org-set-local 'org-file-tags
  3446. (mapcar 'org-add-prop-inherited ftags)))
  3447. (and drawers (org-set-local 'org-drawers drawers))
  3448. (and arch (org-set-local 'org-archive-location arch))
  3449. (and links (setq org-link-abbrev-alist-local (nreverse links)))
  3450. ;; Process the TODO keywords
  3451. (unless kwds
  3452. ;; Use the global values as if they had been given locally.
  3453. (setq kwds (default-value 'org-todo-keywords))
  3454. (if (stringp (car kwds))
  3455. (setq kwds (list (cons org-todo-interpretation
  3456. (default-value 'org-todo-keywords)))))
  3457. (setq kwds (reverse kwds)))
  3458. (setq kwds (nreverse kwds))
  3459. (let (inter kws kw)
  3460. (while (setq kws (pop kwds))
  3461. (let ((kws (or
  3462. (run-hook-with-args-until-success
  3463. 'org-todo-setup-filter-hook kws)
  3464. kws)))
  3465. (setq inter (pop kws) sep (member "|" kws)
  3466. kws0 (delete "|" (copy-sequence kws))
  3467. kwsa nil
  3468. kws1 (mapcar
  3469. (lambda (x)
  3470. ;; 1 2
  3471. (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
  3472. (progn
  3473. (setq kw (match-string 1 x)
  3474. key (and (match-end 2) (match-string 2 x))
  3475. log (org-extract-log-state-settings x))
  3476. (push (cons kw (and key (string-to-char key))) kwsa)
  3477. (and log (push log org-todo-log-states))
  3478. kw)
  3479. (error "Invalid TODO keyword %s" x)))
  3480. kws0)
  3481. kwsa (if kwsa (append '((:startgroup))
  3482. (nreverse kwsa)
  3483. '((:endgroup))))
  3484. hw (car kws1)
  3485. dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
  3486. tail (list inter hw (car dws) (org-last dws))))
  3487. (add-to-list 'org-todo-heads hw 'append)
  3488. (push kws1 org-todo-sets)
  3489. (setq org-done-keywords (append org-done-keywords dws nil))
  3490. (setq org-todo-key-alist (append org-todo-key-alist kwsa))
  3491. (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
  3492. (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
  3493. (setq org-todo-sets (nreverse org-todo-sets)
  3494. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  3495. org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
  3496. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
  3497. ;; Process the constants
  3498. (when const
  3499. (let (e cst)
  3500. (while (setq e (pop const))
  3501. (if (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" e)
  3502. (push (cons (match-string 1 e) (match-string 2 e)) cst)))
  3503. (setq org-table-formula-constants-local cst)))
  3504. ;; Process the tags.
  3505. (when tags
  3506. (let (e tgs)
  3507. (while (setq e (pop tags))
  3508. (cond
  3509. ((equal e "{") (push '(:startgroup) tgs))
  3510. ((equal e "}") (push '(:endgroup) tgs))
  3511. ((equal e "\\n") (push '(:newline) tgs))
  3512. ((string-match (org-re "^\\([[:alnum:]_@]+\\)(\\(.\\))$") e)
  3513. (push (cons (match-string 1 e)
  3514. (string-to-char (match-string 2 e)))
  3515. tgs))
  3516. (t (push (list e) tgs))))
  3517. (org-set-local 'org-tag-alist nil)
  3518. (while (setq e (pop tgs))
  3519. (or (and (stringp (car e))
  3520. (assoc (car e) org-tag-alist))
  3521. (push e org-tag-alist)))))
  3522. ;; Compute the regular expressions and other local variables
  3523. (if (not org-done-keywords)
  3524. (setq org-done-keywords (and org-todo-keywords-1
  3525. (list (org-last org-todo-keywords-1)))))
  3526. (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
  3527. (length org-scheduled-string)
  3528. (length org-clock-string)
  3529. (length org-closed-string)))
  3530. org-drawer-regexp
  3531. (concat "^[ \t]*:\\("
  3532. (mapconcat 'regexp-quote org-drawers "\\|")
  3533. "\\):[ \t]*$")
  3534. org-not-done-keywords
  3535. (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
  3536. org-todo-regexp
  3537. (concat "\\<\\(" (mapconcat 'regexp-quote org-todo-keywords-1
  3538. "\\|") "\\)\\>")
  3539. org-not-done-regexp
  3540. (concat "\\<\\("
  3541. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  3542. "\\)\\>")
  3543. org-not-done-heading-regexp
  3544. (concat "^\\(\\*+\\)[ \t]+\\("
  3545. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  3546. "\\)\\>")
  3547. org-todo-line-regexp
  3548. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3549. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3550. "\\)\\>\\)?[ \t]*\\(.*\\)")
  3551. org-complex-heading-regexp
  3552. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3553. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3554. "\\)\\>\\)?\\(?:[ \t]*\\(\\[#.\\]\\)\\)?[ \t]*\\(.*?\\)"
  3555. "\\(?:[ \t]+\\(:[[:alnum:]_@:]+:\\)\\)?[ \t]*$")
  3556. org-complex-heading-regexp-format
  3557. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3558. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3559. "\\)\\>\\)?\\(?:[ \t]*\\(\\[#.\\]\\)\\)?[ \t]*\\(%s\\)"
  3560. "\\(?:[ \t]+\\(:[[:alnum:]_@:]+:\\)\\)?[ \t]*$")
  3561. org-nl-done-regexp
  3562. (concat "\n\\*+[ \t]+"
  3563. "\\(?:" (mapconcat 'regexp-quote org-done-keywords "\\|")
  3564. "\\)" "\\>")
  3565. org-todo-line-tags-regexp
  3566. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3567. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3568. (org-re
  3569. "\\)\\>\\)? *\\(.*?\\([ \t]:[[:alnum:]:_@]+:[ \t]*\\)?$\\)"))
  3570. org-looking-at-done-regexp
  3571. (concat "^" "\\(?:"
  3572. (mapconcat 'regexp-quote org-done-keywords "\\|") "\\)"
  3573. "\\>")
  3574. org-deadline-regexp (concat "\\<" org-deadline-string)
  3575. org-deadline-time-regexp
  3576. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  3577. org-deadline-line-regexp
  3578. (concat "\\<\\(" org-deadline-string "\\).*")
  3579. org-scheduled-regexp
  3580. (concat "\\<" org-scheduled-string)
  3581. org-scheduled-time-regexp
  3582. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  3583. org-closed-time-regexp
  3584. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  3585. org-keyword-time-regexp
  3586. (concat "\\<\\(" org-scheduled-string
  3587. "\\|" org-deadline-string
  3588. "\\|" org-closed-string
  3589. "\\|" org-clock-string "\\)"
  3590. " *[[<]\\([^]>]+\\)[]>]")
  3591. org-keyword-time-not-clock-regexp
  3592. (concat "\\<\\(" org-scheduled-string
  3593. "\\|" org-deadline-string
  3594. "\\|" org-closed-string
  3595. "\\)"
  3596. " *[[<]\\([^]>]+\\)[]>]")
  3597. org-maybe-keyword-time-regexp
  3598. (concat "\\(\\<\\(" org-scheduled-string
  3599. "\\|" org-deadline-string
  3600. "\\|" org-closed-string
  3601. "\\|" org-clock-string "\\)\\)?"
  3602. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
  3603. org-planning-or-clock-line-re
  3604. (concat "\\(?:^[ \t]*\\(" org-scheduled-string
  3605. "\\|" org-deadline-string
  3606. "\\|" org-closed-string "\\|" org-clock-string
  3607. "\\)\\>\\)")
  3608. org-all-time-keywords
  3609. (mapcar (lambda (w) (substring w 0 -1))
  3610. (list org-scheduled-string org-deadline-string
  3611. org-clock-string org-closed-string))
  3612. )
  3613. (org-compute-latex-and-specials-regexp)
  3614. (org-set-font-lock-defaults))))
  3615. (defun org-file-contents (file &optional noerror)
  3616. "Return the contents of FILE, as a string."
  3617. (if (or (not file)
  3618. (not (file-readable-p file)))
  3619. (if noerror
  3620. (progn
  3621. (message "Cannot read file %s" file)
  3622. (ding) (sit-for 2)
  3623. "")
  3624. (error "Cannot read file %s" file))
  3625. (with-temp-buffer
  3626. (insert-file-contents file)
  3627. (buffer-string))))
  3628. (defun org-extract-log-state-settings (x)
  3629. "Extract the log state setting from a TODO keyword string.
  3630. This will extract info from a string like \"WAIT(w@/!)\"."
  3631. (let (kw key log1 log2)
  3632. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  3633. (setq kw (match-string 1 x)
  3634. key (and (match-end 2) (match-string 2 x))
  3635. log1 (and (match-end 3) (match-string 3 x))
  3636. log2 (and (match-end 4) (match-string 4 x)))
  3637. (and (or log1 log2)
  3638. (list kw
  3639. (and log1 (if (equal log1 "!") 'time 'note))
  3640. (and log2 (if (equal log2 "!") 'time 'note)))))))
  3641. (defun org-remove-keyword-keys (list)
  3642. "Remove a pair of parenthesis at the end of each string in LIST."
  3643. (mapcar (lambda (x)
  3644. (if (string-match "(.*)$" x)
  3645. (substring x 0 (match-beginning 0))
  3646. x))
  3647. list))
  3648. (defun org-assign-fast-keys (alist)
  3649. "Assign fast keys to a keyword-key alist.
  3650. Respect keys that are already there."
  3651. (let (new e (alt ?0))
  3652. (while (setq e (pop alist))
  3653. (if (or (memq (car e) '(:newline :endgroup :startgroup))
  3654. (cdr e)) ;; Key already assigned.
  3655. (push e new)
  3656. (let ((clist (string-to-list (downcase (car e))))
  3657. (used (append new alist)))
  3658. (when (= (car clist) ?@)
  3659. (pop clist))
  3660. (while (and clist (rassoc (car clist) used))
  3661. (pop clist))
  3662. (unless clist
  3663. (while (rassoc alt used)
  3664. (incf alt)))
  3665. (push (cons (car e) (or (car clist) alt)) new))))
  3666. (nreverse new)))
  3667. ;;; Some variables used in various places
  3668. (defvar org-window-configuration nil
  3669. "Used in various places to store a window configuration.")
  3670. (defvar org-selected-window nil
  3671. "Used in various places to store a window configuration.")
  3672. (defvar org-finish-function nil
  3673. "Function to be called when `C-c C-c' is used.
  3674. This is for getting out of special buffers like remember.")
  3675. ;; FIXME: Occasionally check by commenting these, to make sure
  3676. ;; no other functions uses these, forgetting to let-bind them.
  3677. (defvar entry)
  3678. (defvar last-state)
  3679. (defvar date)
  3680. ;; Defined somewhere in this file, but used before definition.
  3681. (defvar org-html-entities)
  3682. (defvar org-struct-menu)
  3683. (defvar org-org-menu)
  3684. (defvar org-tbl-menu)
  3685. ;;;; Define the Org-mode
  3686. (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
  3687. (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."))
  3688. ;; We use a before-change function to check if a table might need
  3689. ;; an update.
  3690. (defvar org-table-may-need-update t
  3691. "Indicates that a table might need an update.
  3692. This variable is set by `org-before-change-function'.
  3693. `org-table-align' sets it back to nil.")
  3694. (defun org-before-change-function (beg end)
  3695. "Every change indicates that a table might need an update."
  3696. (setq org-table-may-need-update t))
  3697. (defvar org-mode-map)
  3698. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  3699. (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
  3700. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  3701. (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
  3702. (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
  3703. (defvar org-table-buffer-is-an nil)
  3704. (defconst org-outline-regexp "\\*+ ")
  3705. ;;;###autoload
  3706. (define-derived-mode org-mode outline-mode "Org"
  3707. "Outline-based notes management and organizer, alias
  3708. \"Carsten's outline-mode for keeping track of everything.\"
  3709. Org-mode develops organizational tasks around a NOTES file which
  3710. contains information about projects as plain text. Org-mode is
  3711. implemented on top of outline-mode, which is ideal to keep the content
  3712. of large files well structured. It supports ToDo items, deadlines and
  3713. time stamps, which magically appear in the diary listing of the Emacs
  3714. calendar. Tables are easily created with a built-in table editor.
  3715. Plain text URL-like links connect to websites, emails (VM), Usenet
  3716. messages (Gnus), BBDB entries, and any files related to the project.
  3717. For printing and sharing of notes, an Org-mode file (or a part of it)
  3718. can be exported as a structured ASCII or HTML file.
  3719. The following commands are available:
  3720. \\{org-mode-map}"
  3721. ;; Get rid of Outline menus, they are not needed
  3722. ;; Need to do this here because define-derived-mode sets up
  3723. ;; the keymap so late. Still, it is a waste to call this each time
  3724. ;; we switch another buffer into org-mode.
  3725. (if (featurep 'xemacs)
  3726. (when (boundp 'outline-mode-menu-heading)
  3727. ;; Assume this is Greg's port, it used easymenu
  3728. (easy-menu-remove outline-mode-menu-heading)
  3729. (easy-menu-remove outline-mode-menu-show)
  3730. (easy-menu-remove outline-mode-menu-hide))
  3731. (define-key org-mode-map [menu-bar headings] 'undefined)
  3732. (define-key org-mode-map [menu-bar hide] 'undefined)
  3733. (define-key org-mode-map [menu-bar show] 'undefined))
  3734. (org-load-modules-maybe)
  3735. (easy-menu-add org-org-menu)
  3736. (easy-menu-add org-tbl-menu)
  3737. (org-install-agenda-files-menu)
  3738. (if org-descriptive-links (org-add-to-invisibility-spec '(org-link)))
  3739. (org-add-to-invisibility-spec '(org-cwidth))
  3740. (org-add-to-invisibility-spec '(org-hide-block . t))
  3741. (when (featurep 'xemacs)
  3742. (org-set-local 'line-move-ignore-invisible t))
  3743. (org-set-local 'outline-regexp org-outline-regexp)
  3744. (org-set-local 'outline-level 'org-outline-level)
  3745. (when (and org-ellipsis
  3746. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  3747. (fboundp 'make-glyph-code))
  3748. (unless org-display-table
  3749. (setq org-display-table (make-display-table)))
  3750. (set-display-table-slot
  3751. org-display-table 4
  3752. (vconcat (mapcar
  3753. (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
  3754. org-ellipsis)))
  3755. (if (stringp org-ellipsis) org-ellipsis "..."))))
  3756. (setq buffer-display-table org-display-table))
  3757. (org-set-regexps-and-options)
  3758. (when (and org-tag-faces (not org-tags-special-faces-re))
  3759. ;; tag faces set outside customize.... force initialization.
  3760. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  3761. ;; Calc embedded
  3762. (org-set-local 'calc-embedded-open-mode "# ")
  3763. (modify-syntax-entry ?# "<")
  3764. (modify-syntax-entry ?@ "w")
  3765. (if org-startup-truncated (setq truncate-lines t))
  3766. (org-set-local 'font-lock-unfontify-region-function
  3767. 'org-unfontify-region)
  3768. ;; Activate before-change-function
  3769. (org-set-local 'org-table-may-need-update t)
  3770. (org-add-hook 'before-change-functions 'org-before-change-function nil
  3771. 'local)
  3772. ;; Check for running clock before killing a buffer
  3773. (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  3774. ;; Paragraphs and auto-filling
  3775. (org-set-autofill-regexps)
  3776. (setq indent-line-function 'org-indent-line-function)
  3777. (org-update-radio-target-regexp)
  3778. ;; Make sure dependence stuff works reliably, even for users who set it
  3779. ;; too late :-(
  3780. (if org-enforce-todo-dependencies
  3781. (add-hook 'org-blocker-hook
  3782. 'org-block-todo-from-children-or-siblings-or-parent)
  3783. (remove-hook 'org-blocker-hook
  3784. 'org-block-todo-from-children-or-siblings-or-parent))
  3785. (if org-enforce-todo-checkbox-dependencies
  3786. (add-hook 'org-blocker-hook
  3787. 'org-block-todo-from-checkboxes)
  3788. (remove-hook 'org-blocker-hook
  3789. 'org-block-todo-from-checkboxes))
  3790. ;; Comment characters
  3791. ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
  3792. (org-set-local 'comment-padding " ")
  3793. ;; Align options lines
  3794. (org-set-local
  3795. 'align-mode-rules-list
  3796. '((org-in-buffer-settings
  3797. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  3798. (modes . '(org-mode)))))
  3799. ;; Imenu
  3800. (org-set-local 'imenu-create-index-function
  3801. 'org-imenu-get-tree)
  3802. ;; Make isearch reveal context
  3803. (if (or (featurep 'xemacs)
  3804. (not (boundp 'outline-isearch-open-invisible-function)))
  3805. ;; Emacs 21 and XEmacs make use of the hook
  3806. (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
  3807. ;; Emacs 22 deals with this through a special variable
  3808. (org-set-local 'outline-isearch-open-invisible-function
  3809. (lambda (&rest ignore) (org-show-context 'isearch))))
  3810. ;; Turn on org-beamer-mode?
  3811. (and org-startup-with-beamer-mode (org-beamer-mode 1))
  3812. ;; If empty file that did not turn on org-mode automatically, make it to.
  3813. (if (and org-insert-mode-line-in-empty-file
  3814. (interactive-p)
  3815. (= (point-min) (point-max)))
  3816. (insert "# -*- mode: org -*-\n\n"))
  3817. (unless org-inhibit-startup
  3818. (when org-startup-align-all-tables
  3819. (let ((bmp (buffer-modified-p)))
  3820. (org-table-map-tables 'org-table-align)
  3821. (set-buffer-modified-p bmp)))
  3822. (when org-startup-indented
  3823. (require 'org-indent)
  3824. (org-indent-mode 1))
  3825. (unless org-inhibit-startup-visibility-stuff
  3826. (org-set-startup-visibility))))
  3827. (when (fboundp 'abbrev-table-put)
  3828. (abbrev-table-put org-mode-abbrev-table
  3829. :parents (list text-mode-abbrev-table)))
  3830. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  3831. (defun org-current-time ()
  3832. "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
  3833. (if (> (car org-time-stamp-rounding-minutes) 1)
  3834. (let ((r (car org-time-stamp-rounding-minutes))
  3835. (time (decode-time)))
  3836. (apply 'encode-time
  3837. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  3838. (nthcdr 2 time))))
  3839. (current-time)))
  3840. ;;;; Font-Lock stuff, including the activators
  3841. (defvar org-mouse-map (make-sparse-keymap))
  3842. (org-defkey org-mouse-map
  3843. (if (featurep 'xemacs) [button2] [mouse-2]) 'org-open-at-mouse)
  3844. (org-defkey org-mouse-map
  3845. (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
  3846. (when org-mouse-1-follows-link
  3847. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  3848. (when org-tab-follows-link
  3849. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  3850. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  3851. (require 'font-lock)
  3852. (defconst org-non-link-chars "]\t\n\r<>")
  3853. (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
  3854. "shell" "elisp"))
  3855. (defvar org-link-types-re nil
  3856. "Matches a link that has a url-like prefix like \"http:\"")
  3857. (defvar org-link-re-with-space nil
  3858. "Matches a link with spaces, optional angular brackets around it.")
  3859. (defvar org-link-re-with-space2 nil
  3860. "Matches a link with spaces, optional angular brackets around it.")
  3861. (defvar org-link-re-with-space3 nil
  3862. "Matches a link with spaces, only for internal part in bracket links.")
  3863. (defvar org-angle-link-re nil
  3864. "Matches link with angular brackets, spaces are allowed.")
  3865. (defvar org-plain-link-re nil
  3866. "Matches plain link, without spaces.")
  3867. (defvar org-bracket-link-regexp nil
  3868. "Matches a link in double brackets.")
  3869. (defvar org-bracket-link-analytic-regexp nil
  3870. "Regular expression used to analyze links.
  3871. Here is what the match groups contain after a match:
  3872. 1: http:
  3873. 2: http
  3874. 3: path
  3875. 4: [desc]
  3876. 5: desc")
  3877. (defvar org-bracket-link-analytic-regexp++ nil
  3878. "Like org-bracket-link-analytic-regexp, but include coderef internal type.")
  3879. (defvar org-any-link-re nil
  3880. "Regular expression matching any link.")
  3881. (defun org-make-link-regexps ()
  3882. "Update the link regular expressions.
  3883. This should be called after the variable `org-link-types' has changed."
  3884. (setq org-link-types-re
  3885. (concat
  3886. "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
  3887. org-link-re-with-space
  3888. (concat
  3889. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  3890. "\\([^" org-non-link-chars " ]"
  3891. "[^" org-non-link-chars "]*"
  3892. "[^" org-non-link-chars " ]\\)>?")
  3893. org-link-re-with-space2
  3894. (concat
  3895. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  3896. "\\([^" org-non-link-chars " ]"
  3897. "[^\t\n\r]*"
  3898. "[^" org-non-link-chars " ]\\)>?")
  3899. org-link-re-with-space3
  3900. (concat
  3901. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  3902. "\\([^" org-non-link-chars " ]"
  3903. "[^\t\n\r]*\\)")
  3904. org-angle-link-re
  3905. (concat
  3906. "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  3907. "\\([^" org-non-link-chars " ]"
  3908. "[^" org-non-link-chars "]*"
  3909. "\\)>")
  3910. org-plain-link-re
  3911. (concat
  3912. "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  3913. (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
  3914. ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  3915. org-bracket-link-regexp
  3916. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  3917. org-bracket-link-analytic-regexp
  3918. (concat
  3919. "\\[\\["
  3920. "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
  3921. "\\([^]]+\\)"
  3922. "\\]"
  3923. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  3924. "\\]")
  3925. org-bracket-link-analytic-regexp++
  3926. (concat
  3927. "\\[\\["
  3928. "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
  3929. "\\([^]]+\\)"
  3930. "\\]"
  3931. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  3932. "\\]")
  3933. org-any-link-re
  3934. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  3935. org-angle-link-re "\\)\\|\\("
  3936. org-plain-link-re "\\)")))
  3937. (org-make-link-regexps)
  3938. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^\r\n>]*?\\)>"
  3939. "Regular expression for fast time stamp matching.")
  3940. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^\r\n>]*?\\)[]>]"
  3941. "Regular expression for fast time stamp matching.")
  3942. (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  3943. "Regular expression matching time strings for analysis.
  3944. This one does not require the space after the date, so it can be used
  3945. on a string that terminates immediately after the date.")
  3946. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  3947. "Regular expression matching time strings for analysis.")
  3948. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  3949. "Regular expression matching time stamps, with groups.")
  3950. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  3951. "Regular expression matching time stamps (also [..]), with groups.")
  3952. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  3953. "Regular expression matching a time stamp range.")
  3954. (defconst org-tr-regexp-both
  3955. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  3956. "Regular expression matching a time stamp range.")
  3957. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  3958. org-ts-regexp "\\)?")
  3959. "Regular expression matching a time stamp or time stamp range.")
  3960. (defconst org-tsr-regexp-both (concat org-ts-regexp-both "\\(--?-?"
  3961. org-ts-regexp-both "\\)?")
  3962. "Regular expression matching a time stamp or time stamp range.
  3963. The time stamps may be either active or inactive.")
  3964. (defvar org-emph-face nil)
  3965. (defun org-do-emphasis-faces (limit)
  3966. "Run through the buffer and add overlays to links."
  3967. (let (rtn a)
  3968. (while (and (not rtn) (re-search-forward org-emph-re limit t))
  3969. (if (not (= (char-after (match-beginning 3))
  3970. (char-after (match-beginning 4))))
  3971. (progn
  3972. (setq rtn t)
  3973. (setq a (assoc (match-string 3) org-emphasis-alist))
  3974. (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
  3975. 'face
  3976. (nth 1 a))
  3977. (and (nth 4 a)
  3978. (org-remove-flyspell-overlays-in
  3979. (match-beginning 0) (match-end 0)))
  3980. (add-text-properties (match-beginning 2) (match-end 2)
  3981. '(font-lock-multiline t))
  3982. (when org-hide-emphasis-markers
  3983. (add-text-properties (match-end 4) (match-beginning 5)
  3984. '(invisible org-link))
  3985. (add-text-properties (match-beginning 3) (match-end 3)
  3986. '(invisible org-link)))))
  3987. (backward-char 1))
  3988. rtn))
  3989. (defun org-emphasize (&optional char)
  3990. "Insert or change an emphasis, i.e. a font like bold or italic.
  3991. If there is an active region, change that region to a new emphasis.
  3992. If there is no region, just insert the marker characters and position
  3993. the cursor between them.
  3994. CHAR should be either the marker character, or the first character of the
  3995. HTML tag associated with that emphasis. If CHAR is a space, the means
  3996. to remove the emphasis of the selected region.
  3997. If char is not given (for example in an interactive call) it
  3998. will be prompted for."
  3999. (interactive)
  4000. (let ((eal org-emphasis-alist) e det
  4001. (erc org-emphasis-regexp-components)
  4002. (prompt "")
  4003. (string "") beg end move tag c s)
  4004. (if (org-region-active-p)
  4005. (setq beg (region-beginning) end (region-end)
  4006. string (buffer-substring beg end))
  4007. (setq move t))
  4008. (while (setq e (pop eal))
  4009. (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
  4010. c (aref tag 0))
  4011. (push (cons c (string-to-char (car e))) det)
  4012. (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
  4013. (substring tag 1)))))
  4014. (setq det (nreverse det))
  4015. (unless char
  4016. (message "%s" (concat "Emphasis marker or tag:" prompt))
  4017. (setq char (read-char-exclusive)))
  4018. (setq char (or (cdr (assoc char det)) char))
  4019. (if (equal char ?\ )
  4020. (setq s "" move nil)
  4021. (unless (assoc (char-to-string char) org-emphasis-alist)
  4022. (error "No such emphasis marker: \"%c\"" char))
  4023. (setq s (char-to-string char)))
  4024. (while (and (> (length string) 1)
  4025. (equal (substring string 0 1) (substring string -1))
  4026. (assoc (substring string 0 1) org-emphasis-alist))
  4027. (setq string (substring string 1 -1)))
  4028. (setq string (concat s string s))
  4029. (if beg (delete-region beg end))
  4030. (unless (or (bolp)
  4031. (string-match (concat "[" (nth 0 erc) "\n]")
  4032. (char-to-string (char-before (point)))))
  4033. (insert " "))
  4034. (unless (or (eobp)
  4035. (string-match (concat "[" (nth 1 erc) "\n]")
  4036. (char-to-string (char-after (point)))))
  4037. (insert " ") (backward-char 1))
  4038. (insert string)
  4039. (and move (backward-char 1))))
  4040. (defconst org-nonsticky-props
  4041. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
  4042. (defsubst org-rear-nonsticky-at (pos)
  4043. (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
  4044. (defun org-activate-plain-links (limit)
  4045. "Run through the buffer and add overlays to links."
  4046. (catch 'exit
  4047. (let (f)
  4048. (if (re-search-forward org-plain-link-re limit t)
  4049. (progn
  4050. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4051. (setq f (get-text-property (match-beginning 0) 'face))
  4052. (if (or (eq f 'org-tag)
  4053. (and (listp f) (memq 'org-tag f)))
  4054. nil
  4055. (add-text-properties (match-beginning 0) (match-end 0)
  4056. (list 'mouse-face 'highlight
  4057. 'face 'org-link
  4058. 'keymap org-mouse-map))
  4059. (org-rear-nonsticky-at (match-end 0)))
  4060. t)))))
  4061. (defun org-activate-code (limit)
  4062. (if (re-search-forward "^[ \t]*\\(: .*\n?\\)" limit t)
  4063. (progn
  4064. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4065. (remove-text-properties (match-beginning 0) (match-end 0)
  4066. '(display t invisible t intangible t))
  4067. t)))
  4068. (defun org-fontify-meta-lines-and-blocks (limit)
  4069. "Fontify #+ lines and blocks, in the correct ways."
  4070. (let ((case-fold-search t))
  4071. (if (re-search-forward
  4072. "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)\\(.*\\)\\)"
  4073. limit t)
  4074. (let ((beg (match-beginning 0))
  4075. (beg1 (line-beginning-position 2))
  4076. (dc1 (downcase (match-string 2)))
  4077. (dc3 (downcase (match-string 3)))
  4078. end end1 quoting block-type)
  4079. (cond
  4080. ((member dc1 '("html:" "ascii:" "latex:" "docbook:"))
  4081. ;; a single line of backend-specific content
  4082. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4083. (remove-text-properties (match-beginning 0) (match-end 0)
  4084. '(display t invisible t intangible t))
  4085. (add-text-properties (match-beginning 1) (match-end 3)
  4086. '(font-lock-fontified t face org-meta-line))
  4087. (add-text-properties (match-beginning 6) (match-end 6)
  4088. '(font-lock-fontified t face org-block))
  4089. t)
  4090. ((and (match-end 4) (equal dc3 "begin"))
  4091. ;; Truely a block
  4092. (setq block-type (downcase (match-string 5))
  4093. quoting (member block-type org-protecting-blocks))
  4094. (when (re-search-forward
  4095. (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
  4096. nil t) ;; on purpose, we look further than LIMIT
  4097. (setq end (match-end 0) end1 (1- (match-beginning 0)))
  4098. (when quoting
  4099. (remove-text-properties beg end
  4100. '(display t invisible t intangible t)))
  4101. (add-text-properties
  4102. beg end
  4103. '(font-lock-fontified t font-lock-multiline t))
  4104. (add-text-properties beg beg1 '(face org-meta-line))
  4105. (add-text-properties end1 end '(face org-meta-line))
  4106. (cond
  4107. (quoting
  4108. (add-text-properties beg1 end1 '(face org-block)))
  4109. ((not org-fontify-quote-and-verse-blocks))
  4110. ((string= block-type "quote")
  4111. (add-text-properties beg1 end1 '(face org-quote)))
  4112. ((string= block-type "verse")
  4113. (add-text-properties beg1 end1 '(face org-verse))))
  4114. t))
  4115. ((not (member (char-after beg) '(?\ ?\t)))
  4116. ;; just any other in-buffer setting, but not indented
  4117. (add-text-properties
  4118. beg (match-end 0)
  4119. '(font-lock-fontified t face org-meta-line))
  4120. t)
  4121. ((or (member dc1 '("begin:" "end:" "caption:" "label:"
  4122. "orgtbl:" "tblfm:" "tblname:"))
  4123. (and (match-end 4) (equal dc3 "attr")))
  4124. (add-text-properties
  4125. beg (match-end 0)
  4126. '(font-lock-fontified t face org-meta-line))
  4127. t)
  4128. ((member dc3 '(" " ""))
  4129. (add-text-properties
  4130. beg (match-end 0)
  4131. '(font-lock-fontified t face font-lock-comment-face)))
  4132. (t nil))))))
  4133. (defun org-activate-angle-links (limit)
  4134. "Run through the buffer and add overlays to links."
  4135. (if (re-search-forward org-angle-link-re limit t)
  4136. (progn
  4137. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4138. (add-text-properties (match-beginning 0) (match-end 0)
  4139. (list 'mouse-face 'highlight
  4140. 'keymap org-mouse-map))
  4141. (org-rear-nonsticky-at (match-end 0))
  4142. t)))
  4143. (defun org-activate-footnote-links (limit)
  4144. "Run through the buffer and add overlays to links."
  4145. (if (re-search-forward "\\(^\\|[^][]\\)\\(\\[\\([0-9]+\\]\\|fn:[^ \t\r\n:]+?[]:]\\)\\)"
  4146. limit t)
  4147. (progn
  4148. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4149. (add-text-properties (match-beginning 2) (match-end 2)
  4150. (list 'mouse-face 'highlight
  4151. 'keymap org-mouse-map
  4152. 'help-echo
  4153. (if (= (point-at-bol) (match-beginning 2))
  4154. "Footnote definition"
  4155. "Footnote reference")
  4156. ))
  4157. (org-rear-nonsticky-at (match-end 2))
  4158. t)))
  4159. (defun org-activate-bracket-links (limit)
  4160. "Run through the buffer and add overlays to bracketed links."
  4161. (if (re-search-forward org-bracket-link-regexp limit t)
  4162. (let* ((help (concat "LINK: "
  4163. (org-match-string-no-properties 1)))
  4164. ;; FIXME: above we should remove the escapes.
  4165. ;; but that requires another match, protecting match data,
  4166. ;; a lot of overhead for font-lock.
  4167. (ip (org-maybe-intangible
  4168. (list 'invisible 'org-link
  4169. 'keymap org-mouse-map 'mouse-face 'highlight
  4170. 'font-lock-multiline t 'help-echo help)))
  4171. (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
  4172. 'font-lock-multiline t 'help-echo help)))
  4173. ;; We need to remove the invisible property here. Table narrowing
  4174. ;; may have made some of this invisible.
  4175. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4176. (remove-text-properties (match-beginning 0) (match-end 0)
  4177. '(invisible nil))
  4178. (if (match-end 3)
  4179. (progn
  4180. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  4181. (org-rear-nonsticky-at (match-beginning 3))
  4182. (add-text-properties (match-beginning 3) (match-end 3) vp)
  4183. (org-rear-nonsticky-at (match-end 3))
  4184. (add-text-properties (match-end 3) (match-end 0) ip)
  4185. (org-rear-nonsticky-at (match-end 0)))
  4186. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  4187. (org-rear-nonsticky-at (match-beginning 1))
  4188. (add-text-properties (match-beginning 1) (match-end 1) vp)
  4189. (org-rear-nonsticky-at (match-end 1))
  4190. (add-text-properties (match-end 1) (match-end 0) ip)
  4191. (org-rear-nonsticky-at (match-end 0)))
  4192. t)))
  4193. (defun org-activate-dates (limit)
  4194. "Run through the buffer and add overlays to dates."
  4195. (if (re-search-forward org-tsr-regexp-both limit t)
  4196. (progn
  4197. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4198. (add-text-properties (match-beginning 0) (match-end 0)
  4199. (list 'mouse-face 'highlight
  4200. 'keymap org-mouse-map))
  4201. (org-rear-nonsticky-at (match-end 0))
  4202. (when org-display-custom-times
  4203. (if (match-end 3)
  4204. (org-display-custom-time (match-beginning 3) (match-end 3)))
  4205. (org-display-custom-time (match-beginning 1) (match-end 1)))
  4206. t)))
  4207. (defvar org-target-link-regexp nil
  4208. "Regular expression matching radio targets in plain text.")
  4209. (make-variable-buffer-local 'org-target-link-regexp)
  4210. (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
  4211. "Regular expression matching a link target.")
  4212. (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
  4213. "Regular expression matching a radio target.")
  4214. (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
  4215. "Regular expression matching any target.")
  4216. (defun org-activate-target-links (limit)
  4217. "Run through the buffer and add overlays to target matches."
  4218. (when org-target-link-regexp
  4219. (let ((case-fold-search t))
  4220. (if (re-search-forward org-target-link-regexp limit t)
  4221. (progn
  4222. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4223. (add-text-properties (match-beginning 0) (match-end 0)
  4224. (list 'mouse-face 'highlight
  4225. 'keymap org-mouse-map
  4226. 'help-echo "Radio target link"
  4227. 'org-linked-text t))
  4228. (org-rear-nonsticky-at (match-end 0))
  4229. t)))))
  4230. (defun org-update-radio-target-regexp ()
  4231. "Find all radio targets in this file and update the regular expression."
  4232. (interactive)
  4233. (when (memq 'radio org-activate-links)
  4234. (setq org-target-link-regexp
  4235. (org-make-target-link-regexp (org-all-targets 'radio)))
  4236. (org-restart-font-lock)))
  4237. (defun org-hide-wide-columns (limit)
  4238. (let (s e)
  4239. (setq s (text-property-any (point) (or limit (point-max))
  4240. 'org-cwidth t))
  4241. (when s
  4242. (setq e (next-single-property-change s 'org-cwidth))
  4243. (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
  4244. (goto-char e)
  4245. t)))
  4246. (defvar org-latex-and-specials-regexp nil
  4247. "Regular expression for highlighting export special stuff.")
  4248. (defvar org-match-substring-regexp)
  4249. (defvar org-match-substring-with-braces-regexp)
  4250. ;; This should be with the exporter code, but we also use if for font-locking
  4251. (defconst org-export-html-special-string-regexps
  4252. '(("\\\\-" . "&shy;")
  4253. ("---\\([^-]\\)" . "&mdash;\\1")
  4254. ("--\\([^-]\\)" . "&ndash;\\1")
  4255. ("\\.\\.\\." . "&hellip;"))
  4256. "Regular expressions for special string conversion.")
  4257. (defun org-compute-latex-and-specials-regexp ()
  4258. "Compute regular expression for stuff treated specially by exporters."
  4259. (if (not org-highlight-latex-fragments-and-specials)
  4260. (org-set-local 'org-latex-and-specials-regexp nil)
  4261. (require 'org-exp)
  4262. (let*
  4263. ((matchers (plist-get org-format-latex-options :matchers))
  4264. (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
  4265. org-latex-regexps)))
  4266. (org-export-allow-BIND nil)
  4267. (options (org-combine-plists (org-default-export-plist)
  4268. (org-infile-export-plist)))
  4269. (org-export-with-sub-superscripts (plist-get options :sub-superscript))
  4270. (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
  4271. (org-export-with-TeX-macros (plist-get options :TeX-macros))
  4272. (org-export-html-expand (plist-get options :expand-quoted-html))
  4273. (org-export-with-special-strings (plist-get options :special-strings))
  4274. (re-sub
  4275. (cond
  4276. ((equal org-export-with-sub-superscripts '{})
  4277. (list org-match-substring-with-braces-regexp))
  4278. (org-export-with-sub-superscripts
  4279. (list org-match-substring-regexp))
  4280. (t nil)))
  4281. (re-latex
  4282. (if org-export-with-LaTeX-fragments
  4283. (mapcar (lambda (x) (nth 1 x)) latexs)))
  4284. (re-macros
  4285. (if org-export-with-TeX-macros
  4286. (list (concat "\\\\"
  4287. (regexp-opt
  4288. (append (mapcar 'car org-html-entities)
  4289. (if (boundp 'org-latex-entities)
  4290. (mapcar (lambda (x)
  4291. (or (car-safe x) x))
  4292. org-latex-entities)
  4293. nil))
  4294. 'words))) ; FIXME
  4295. ))
  4296. ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
  4297. (re-special (if org-export-with-special-strings
  4298. (mapcar (lambda (x) (car x))
  4299. org-export-html-special-string-regexps)))
  4300. (re-rest
  4301. (delq nil
  4302. (list
  4303. (if org-export-html-expand "@<[^>\n]+>")
  4304. ))))
  4305. (org-set-local
  4306. 'org-latex-and-specials-regexp
  4307. (mapconcat 'identity (append re-latex re-sub re-macros re-special
  4308. re-rest) "\\|")))))
  4309. (defun org-do-latex-and-special-faces (limit)
  4310. "Run through the buffer and add overlays to links."
  4311. (when org-latex-and-specials-regexp
  4312. (let (rtn d)
  4313. (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
  4314. limit t))
  4315. (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
  4316. 'face))
  4317. '(org-code org-verbatim underline)))
  4318. (progn
  4319. (setq rtn t
  4320. d (cond ((member (char-after (1+ (match-beginning 0)))
  4321. '(?_ ?^)) 1)
  4322. (t 0)))
  4323. (font-lock-prepend-text-property
  4324. (+ d (match-beginning 0)) (match-end 0)
  4325. 'face 'org-latex-and-export-specials)
  4326. (add-text-properties (+ d (match-beginning 0)) (match-end 0)
  4327. '(font-lock-multiline t)))))
  4328. rtn)))
  4329. (defun org-restart-font-lock ()
  4330. "Restart font-lock-mode, to force refontification."
  4331. (when (and (boundp 'font-lock-mode) font-lock-mode)
  4332. (font-lock-mode -1)
  4333. (font-lock-mode 1)))
  4334. (defun org-all-targets (&optional radio)
  4335. "Return a list of all targets in this file.
  4336. With optional argument RADIO, only find radio targets."
  4337. (let ((re (if radio org-radio-target-regexp org-target-regexp))
  4338. rtn)
  4339. (save-excursion
  4340. (goto-char (point-min))
  4341. (while (re-search-forward re nil t)
  4342. (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
  4343. rtn)))
  4344. (defun org-make-target-link-regexp (targets)
  4345. "Make regular expression matching all strings in TARGETS.
  4346. The regular expression finds the targets also if there is a line break
  4347. between words."
  4348. (and targets
  4349. (concat
  4350. "\\<\\("
  4351. (mapconcat
  4352. (lambda (x)
  4353. (while (string-match " +" x)
  4354. (setq x (replace-match "\\s-+" t t x)))
  4355. x)
  4356. targets
  4357. "\\|")
  4358. "\\)\\>")))
  4359. (defun org-activate-tags (limit)
  4360. (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \r\n]") limit t)
  4361. (progn
  4362. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  4363. (add-text-properties (match-beginning 1) (match-end 1)
  4364. (list 'mouse-face 'highlight
  4365. 'keymap org-mouse-map))
  4366. (org-rear-nonsticky-at (match-end 1))
  4367. t)))
  4368. (defun org-outline-level ()
  4369. "Compute the outline level of the heading at point.
  4370. This function assumes that the cursor is at the beginning of a line matched
  4371. by outline-regexp. Otherwise it returns garbage.
  4372. If this is called at a normal headline, the level is the number of stars.
  4373. Use `org-reduced-level' to remove the effect of `org-odd-levels'.
  4374. For plain list items, if they are matched by `outline-regexp', this returns
  4375. 1000 plus the line indentation."
  4376. (save-excursion
  4377. (looking-at outline-regexp)
  4378. (if (match-beginning 1)
  4379. (+ (org-get-string-indentation (match-string 1)) 1000)
  4380. (1- (- (match-end 0) (match-beginning 0))))))
  4381. (defvar org-font-lock-keywords nil)
  4382. (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
  4383. "Regular expression matching a property line.")
  4384. (defvar org-font-lock-hook nil
  4385. "Functions to be called for special font lock stuff.")
  4386. (defun org-font-lock-hook (limit)
  4387. (run-hook-with-args 'org-font-lock-hook limit))
  4388. (defun org-set-font-lock-defaults ()
  4389. (let* ((em org-fontify-emphasized-text)
  4390. (lk org-activate-links)
  4391. (org-font-lock-extra-keywords
  4392. (list
  4393. ;; Call the hook
  4394. '(org-font-lock-hook)
  4395. ;; Headlines
  4396. `(,(if org-fontify-whole-heading-line
  4397. "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
  4398. "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
  4399. (1 (org-get-level-face 1))
  4400. (2 (org-get-level-face 2))
  4401. (3 (org-get-level-face 3)))
  4402. ;; Table lines
  4403. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  4404. (1 'org-table t))
  4405. ;; Table internals
  4406. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  4407. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  4408. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  4409. '("| *\\(<[lr]?[0-9]*>\\)" (1 'org-formula t))
  4410. ;; Drawers
  4411. (list org-drawer-regexp '(0 'org-special-keyword t))
  4412. (list "^[ \t]*:END:" '(0 'org-special-keyword t))
  4413. ;; Properties
  4414. (list org-property-re
  4415. '(1 'org-special-keyword t)
  4416. '(3 'org-property-value t))
  4417. ;; Links
  4418. (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  4419. (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  4420. (if (memq 'plain lk) '(org-activate-plain-links))
  4421. (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
  4422. (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
  4423. (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  4424. (if (memq 'footnote lk) '(org-activate-footnote-links
  4425. (2 'org-footnote t)))
  4426. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  4427. '(org-hide-wide-columns (0 nil append))
  4428. ;; TODO lines
  4429. (list (concat "^\\*+[ \t]+" org-todo-regexp "\\([ \t]\\|$\\)")
  4430. '(1 (org-get-todo-face 1) t))
  4431. ;; DONE
  4432. (if org-fontify-done-headline
  4433. (list (concat "^[*]+ +\\<\\("
  4434. (mapconcat 'regexp-quote org-done-keywords "\\|")
  4435. "\\)\\(.*\\)")
  4436. '(2 'org-headline-done t))
  4437. nil)
  4438. ;; Priorities
  4439. '(org-font-lock-add-priority-faces)
  4440. ;; Tags
  4441. '(org-font-lock-add-tag-faces)
  4442. ;; Special keywords
  4443. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  4444. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  4445. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  4446. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  4447. ;; Emphasis
  4448. (if em
  4449. (if (featurep 'xemacs)
  4450. '(org-do-emphasis-faces (0 nil append))
  4451. '(org-do-emphasis-faces)))
  4452. ;; Checkboxes
  4453. '("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(\\[[- X]\\]\\)"
  4454. 2 'org-checkbox prepend)
  4455. (if org-provide-checkbox-statistics
  4456. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  4457. (0 (org-get-checkbox-statistics-face) t)))
  4458. ;; Description list items
  4459. '("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(.*? ::\\)"
  4460. 2 'bold prepend)
  4461. ;; ARCHIVEd headings
  4462. (list (concat "^\\*+ \\(.*:" org-archive-tag ":.*\\)")
  4463. '(1 'org-archived prepend))
  4464. ;; Specials
  4465. '(org-do-latex-and-special-faces)
  4466. ;; Code
  4467. '(org-activate-code (1 'org-code t))
  4468. ;; COMMENT
  4469. (list (concat "^\\*+[ \t]+\\<\\(" org-comment-string
  4470. "\\|" org-quote-string "\\)\\>")
  4471. '(1 'org-special-keyword t))
  4472. '("^#.*" (0 'font-lock-comment-face t))
  4473. ;; Blocks and meta lines
  4474. '(org-fontify-meta-lines-and-blocks)
  4475. )))
  4476. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  4477. ;; Now set the full font-lock-keywords
  4478. (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
  4479. (org-set-local 'font-lock-defaults
  4480. '(org-font-lock-keywords t nil nil backward-paragraph))
  4481. (kill-local-variable 'font-lock-keywords) nil))
  4482. (defun org-fontify-like-in-org-mode (s &optional odd-levels)
  4483. "Fontify string S like in Org-mode"
  4484. (with-temp-buffer
  4485. (insert s)
  4486. (let ((org-odd-levels-only odd-levels))
  4487. (org-mode)
  4488. (font-lock-fontify-buffer)
  4489. (buffer-string))))
  4490. (defvar org-m nil)
  4491. (defvar org-l nil)
  4492. (defvar org-f nil)
  4493. (defun org-get-level-face (n)
  4494. "Get the right face for match N in font-lock matching of headlines."
  4495. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  4496. (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  4497. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  4498. (cond
  4499. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  4500. ((eq n 2) org-f)
  4501. (t (if org-level-color-stars-only nil org-f))))
  4502. (defun org-get-todo-face (kwd)
  4503. "Get the right face for a TODO keyword KWD.
  4504. If KWD is a number, get the corresponding match group."
  4505. (if (numberp kwd) (setq kwd (match-string kwd)))
  4506. (or (cdr (assoc kwd org-todo-keyword-faces))
  4507. (and (member kwd org-done-keywords) 'org-done)
  4508. 'org-todo))
  4509. (defun org-font-lock-add-tag-faces (limit)
  4510. "Add the special tag faces."
  4511. (when (and org-tag-faces org-tags-special-faces-re)
  4512. (while (re-search-forward org-tags-special-faces-re limit t)
  4513. (add-text-properties (match-beginning 1) (match-end 1)
  4514. (list 'face (org-get-tag-face 1)
  4515. 'font-lock-fontified t))
  4516. (backward-char 1))))
  4517. (defun org-font-lock-add-priority-faces (limit)
  4518. "Add the special priority faces."
  4519. (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
  4520. (add-text-properties
  4521. (match-beginning 0) (match-end 0)
  4522. (list 'face (or (cdr (assoc (char-after (match-beginning 1))
  4523. org-priority-faces))
  4524. 'org-special-keyword)
  4525. 'font-lock-fontified t))))
  4526. (defun org-get-tag-face (kwd)
  4527. "Get the right face for a TODO keyword KWD.
  4528. If KWD is a number, get the corresponding match group."
  4529. (if (numberp kwd) (setq kwd (match-string kwd)))
  4530. (or (cdr (assoc kwd org-tag-faces))
  4531. 'org-tag))
  4532. (defun org-unfontify-region (beg end &optional maybe_loudly)
  4533. "Remove fontification and activation overlays from links."
  4534. (font-lock-default-unfontify-region beg end)
  4535. (let* ((buffer-undo-list t)
  4536. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  4537. (inhibit-modification-hooks t)
  4538. deactivate-mark buffer-file-name buffer-file-truename)
  4539. (remove-text-properties
  4540. beg end
  4541. (if org-indent-mode
  4542. ;; also remove line-prefix and wrap-prefix properties
  4543. '(mouse-face t keymap t org-linked-text t
  4544. invisible t intangible t
  4545. line-prefix t wrap-prefix t
  4546. org-no-flyspell t)
  4547. '(mouse-face t keymap t org-linked-text t
  4548. invisible t intangible t
  4549. org-no-flyspell t)))))
  4550. ;;;; Visibility cycling, including org-goto and indirect buffer
  4551. ;;; Cycling
  4552. (defvar org-cycle-global-status nil)
  4553. (make-variable-buffer-local 'org-cycle-global-status)
  4554. (defvar org-cycle-subtree-status nil)
  4555. (make-variable-buffer-local 'org-cycle-subtree-status)
  4556. ;;;###autoload
  4557. (defvar org-inlinetask-min-level)
  4558. (defun org-cycle (&optional arg)
  4559. "TAB-action and visibility cycling for Org-mode.
  4560. This is the command invoked in Org-mode by the TAB key. Its main purpose
  4561. is outline visibility cycling, but it also invokes other actions
  4562. in special contexts.
  4563. - When this function is called with a prefix argument, rotate the entire
  4564. buffer through 3 states (global cycling)
  4565. 1. OVERVIEW: Show only top-level headlines.
  4566. 2. CONTENTS: Show all headlines of all levels, but no body text.
  4567. 3. SHOW ALL: Show everything.
  4568. When called with two `C-u C-u' prefixes, switch to the startup visibility,
  4569. determined by the variable `org-startup-folded', and by any VISIBILITY
  4570. properties in the buffer.
  4571. When called with three `C-u C-u C-u' prefixed, show the entire buffer,
  4572. including any drawers.
  4573. - When inside a table, re-align the table and move to the next field.
  4574. - When point is at the beginning of a headline, rotate the subtree started
  4575. by this line through 3 different states (local cycling)
  4576. 1. FOLDED: Only the main headline is shown.
  4577. 2. CHILDREN: The main headline and the direct children are shown.
  4578. From this state, you can move to one of the children
  4579. and zoom in further.
  4580. 3. SUBTREE: Show the entire subtree, including body text.
  4581. If there is no subtree, switch directly from CHILDREN to FOLDED.
  4582. - When point is at the beginning of an empty headline and the variable
  4583. `org-cycle-level-after-item/entry-creation' is set, cycle the level
  4584. of the headline by demoting and promoting it to likely levels. This
  4585. speeds up creation document structure by presing TAB once or several
  4586. times right after creating a new headline.
  4587. - When there is a numeric prefix, go up to a heading with level ARG, do
  4588. a `show-subtree' and return to the previous cursor position. If ARG
  4589. is negative, go up that many levels.
  4590. - When point is not at the beginning of a headline, execute the global
  4591. binding for TAB, which is re-indenting the line. See the option
  4592. `org-cycle-emulate-tab' for details.
  4593. - Special case: if point is at the beginning of the buffer and there is
  4594. no headline in line 1, this function will act as if called with prefix arg.
  4595. But only if also the variable `org-cycle-global-at-bob' is t."
  4596. (interactive "P")
  4597. (org-load-modules-maybe)
  4598. (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
  4599. (and org-cycle-level-after-item/entry-creation
  4600. (or (org-cycle-level)
  4601. (org-cycle-item-indentation))))
  4602. (let* ((limit-level
  4603. (or org-cycle-max-level
  4604. (and (boundp 'org-inlinetask-min-level)
  4605. org-inlinetask-min-level
  4606. (1- org-inlinetask-min-level))))
  4607. (nstars (and limit-level
  4608. (if org-odd-levels-only
  4609. (and limit-level (1- (* limit-level 2)))
  4610. limit-level)))
  4611. (outline-regexp
  4612. (cond
  4613. ((not (org-mode-p)) outline-regexp)
  4614. ((or (eq org-cycle-include-plain-lists 'integrate)
  4615. (and org-cycle-include-plain-lists (org-at-item-p)))
  4616. (concat "\\(?:\\*"
  4617. (if nstars (format "\\{1,%d\\}" nstars) "+")
  4618. " \\|\\([ \t]*\\)\\([-+*]\\|[0-9]+[.)]\\) \\)"))
  4619. (t (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ ")))))
  4620. (bob-special (and org-cycle-global-at-bob (bobp)
  4621. (not (looking-at outline-regexp))))
  4622. (org-cycle-hook
  4623. (if bob-special
  4624. (delq 'org-optimize-window-after-visibility-change
  4625. (copy-sequence org-cycle-hook))
  4626. org-cycle-hook))
  4627. (pos (point)))
  4628. (if (or bob-special (equal arg '(4)))
  4629. ;; special case: use global cycling
  4630. (setq arg t))
  4631. (cond
  4632. ((equal arg '(16))
  4633. (org-set-startup-visibility)
  4634. (message "Startup visibility, plus VISIBILITY properties"))
  4635. ((equal arg '(64))
  4636. (show-all)
  4637. (message "Entire buffer visible, including drawers"))
  4638. ((org-at-table-p 'any)
  4639. ;; Enter the table or move to the next field in the table
  4640. (or (org-table-recognize-table.el)
  4641. (progn
  4642. (if arg (org-table-edit-field t)
  4643. (org-table-justify-field-maybe)
  4644. (call-interactively 'org-table-next-field)))))
  4645. ((run-hook-with-args-until-success
  4646. 'org-tab-after-check-for-table-hook))
  4647. ((eq arg t) ;; Global cycling
  4648. (org-cycle-internal-global))
  4649. ((and org-drawers org-drawer-regexp
  4650. (save-excursion
  4651. (beginning-of-line 1)
  4652. (looking-at org-drawer-regexp)))
  4653. ;; Toggle block visibility
  4654. (org-flag-drawer
  4655. (not (get-char-property (match-end 0) 'invisible))))
  4656. ((integerp arg)
  4657. ;; Show-subtree, ARG levels up from here.
  4658. (save-excursion
  4659. (org-back-to-heading)
  4660. (outline-up-heading (if (< arg 0) (- arg)
  4661. (- (funcall outline-level) arg)))
  4662. (org-show-subtree)))
  4663. ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
  4664. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  4665. (org-cycle-internal-local))
  4666. ;; TAB emulation and template completion
  4667. (buffer-read-only (org-back-to-heading))
  4668. ((run-hook-with-args-until-success
  4669. 'org-tab-after-check-for-cycling-hook))
  4670. ((org-try-structure-completion))
  4671. ((org-try-cdlatex-tab))
  4672. ((run-hook-with-args-until-success
  4673. 'org-tab-before-tab-emulation-hook))
  4674. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  4675. (or (not (bolp))
  4676. (not (looking-at outline-regexp))))
  4677. (call-interactively (global-key-binding "\t")))
  4678. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  4679. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  4680. (or (and (eq org-cycle-emulate-tab 'white)
  4681. (= (match-end 0) (point-at-eol)))
  4682. (and (eq org-cycle-emulate-tab 'whitestart)
  4683. (>= (match-end 0) pos))))
  4684. t
  4685. (eq org-cycle-emulate-tab t))
  4686. (call-interactively (global-key-binding "\t")))
  4687. (t (save-excursion
  4688. (org-back-to-heading)
  4689. (org-cycle)))))))
  4690. (defun org-cycle-internal-global ()
  4691. "Do the global cycling action."
  4692. (cond
  4693. ((and (eq last-command this-command)
  4694. (eq org-cycle-global-status 'overview))
  4695. ;; We just created the overview - now do table of contents
  4696. ;; This can be slow in very large buffers, so indicate action
  4697. (run-hook-with-args 'org-pre-cycle-hook 'contents)
  4698. (message "CONTENTS...")
  4699. (org-content)
  4700. (message "CONTENTS...done")
  4701. (setq org-cycle-global-status 'contents)
  4702. (run-hook-with-args 'org-cycle-hook 'contents))
  4703. ((and (eq last-command this-command)
  4704. (eq org-cycle-global-status 'contents))
  4705. ;; We just showed the table of contents - now show everything
  4706. (run-hook-with-args 'org-pre-cycle-hook 'all)
  4707. (show-all)
  4708. (message "SHOW ALL")
  4709. (setq org-cycle-global-status 'all)
  4710. (run-hook-with-args 'org-cycle-hook 'all))
  4711. (t
  4712. ;; Default action: go to overview
  4713. (run-hook-with-args 'org-pre-cycle-hook 'overview)
  4714. (org-overview)
  4715. (message "OVERVIEW")
  4716. (setq org-cycle-global-status 'overview)
  4717. (run-hook-with-args 'org-cycle-hook 'overview))))
  4718. (defun org-cycle-internal-local ()
  4719. "Do the local cycling action."
  4720. (org-back-to-heading)
  4721. (let ((goal-column 0) eoh eol eos level has-children children-skipped)
  4722. ;; First, some boundaries
  4723. (save-excursion
  4724. (org-back-to-heading)
  4725. (setq level (funcall outline-level))
  4726. (save-excursion
  4727. (beginning-of-line 2)
  4728. (if (or (featurep 'xemacs) (<= emacs-major-version 21))
  4729. ; XEmacs does not have `next-single-char-property-change'
  4730. ; I'm not sure about Emacs 21.
  4731. (while (and (not (eobp)) ;; this is like `next-line'
  4732. (get-char-property (1- (point)) 'invisible))
  4733. (beginning-of-line 2))
  4734. (while (and (not (eobp)) ;; this is like `next-line'
  4735. (get-char-property (1- (point)) 'invisible))
  4736. (goto-char (next-single-char-property-change (point) 'invisible))
  4737. ;;;??? (or (bolp) (beginning-of-line 2))))
  4738. (and (eolp) (beginning-of-line 2))))
  4739. (setq eol (point)))
  4740. (outline-end-of-heading) (setq eoh (point))
  4741. (save-excursion
  4742. (outline-next-heading)
  4743. (setq has-children (and (org-at-heading-p t)
  4744. (> (funcall outline-level) level))))
  4745. (org-end-of-subtree t)
  4746. (unless (eobp)
  4747. (skip-chars-forward " \t\n")
  4748. (beginning-of-line 1) ; in case this is an item
  4749. )
  4750. (setq eos (if (eobp) (point) (1- (point)))))
  4751. ;; Find out what to do next and set `this-command'
  4752. (cond
  4753. ((= eos eoh)
  4754. ;; Nothing is hidden behind this heading
  4755. (run-hook-with-args 'org-pre-cycle-hook 'empty)
  4756. (message "EMPTY ENTRY")
  4757. (setq org-cycle-subtree-status nil)
  4758. (save-excursion
  4759. (goto-char eos)
  4760. (outline-next-heading)
  4761. (if (org-invisible-p) (org-flag-heading nil))))
  4762. ((and (or (>= eol eos)
  4763. (not (string-match "\\S-" (buffer-substring eol eos))))
  4764. (or has-children
  4765. (not (setq children-skipped
  4766. org-cycle-skip-children-state-if-no-children))))
  4767. ;; Entire subtree is hidden in one line: children view
  4768. (run-hook-with-args 'org-pre-cycle-hook 'children)
  4769. (org-show-entry)
  4770. (show-children)
  4771. (message "CHILDREN")
  4772. (save-excursion
  4773. (goto-char eos)
  4774. (outline-next-heading)
  4775. (if (org-invisible-p) (org-flag-heading nil)))
  4776. (setq org-cycle-subtree-status 'children)
  4777. (run-hook-with-args 'org-cycle-hook 'children))
  4778. ((or children-skipped
  4779. (and (eq last-command this-command)
  4780. (eq org-cycle-subtree-status 'children)))
  4781. ;; We just showed the children, or no children are there,
  4782. ;; now show everything.
  4783. (run-hook-with-args 'org-pre-cycle-hook 'subtree)
  4784. (org-show-subtree)
  4785. (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
  4786. (setq org-cycle-subtree-status 'subtree)
  4787. (run-hook-with-args 'org-cycle-hook 'subtree))
  4788. (t
  4789. ;; Default action: hide the subtree.
  4790. (run-hook-with-args 'org-pre-cycle-hook 'folded)
  4791. (hide-subtree)
  4792. (message "FOLDED")
  4793. (setq org-cycle-subtree-status 'folded)
  4794. (run-hook-with-args 'org-cycle-hook 'folded)))))
  4795. ;;;###autoload
  4796. (defun org-global-cycle (&optional arg)
  4797. "Cycle the global visibility. For details see `org-cycle'.
  4798. With C-u prefix arg, switch to startup visibility.
  4799. With a numeric prefix, show all headlines up to that level."
  4800. (interactive "P")
  4801. (let ((org-cycle-include-plain-lists
  4802. (if (org-mode-p) org-cycle-include-plain-lists nil)))
  4803. (cond
  4804. ((integerp arg)
  4805. (show-all)
  4806. (hide-sublevels arg)
  4807. (setq org-cycle-global-status 'contents))
  4808. ((equal arg '(4))
  4809. (org-set-startup-visibility)
  4810. (message "Startup visibility, plus VISIBILITY properties."))
  4811. (t
  4812. (org-cycle '(4))))))
  4813. (defun org-set-startup-visibility ()
  4814. "Set the visibility required by startup options and properties."
  4815. (cond
  4816. ((eq org-startup-folded t)
  4817. (org-cycle '(4)))
  4818. ((eq org-startup-folded 'content)
  4819. (let ((this-command 'org-cycle) (last-command 'org-cycle))
  4820. (org-cycle '(4)) (org-cycle '(4)))))
  4821. (unless (eq org-startup-folded 'showeverything)
  4822. (if org-hide-block-startup (org-hide-block-all))
  4823. (org-set-visibility-according-to-property 'no-cleanup)
  4824. (org-cycle-hide-archived-subtrees 'all)
  4825. (org-cycle-hide-drawers 'all)
  4826. (org-cycle-show-empty-lines 'all)))
  4827. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  4828. "Switch subtree visibilities according to :VISIBILITY: property."
  4829. (interactive)
  4830. (let (org-show-entry-below state)
  4831. (save-excursion
  4832. (goto-char (point-min))
  4833. (while (re-search-forward
  4834. "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
  4835. nil t)
  4836. (setq state (match-string 1))
  4837. (save-excursion
  4838. (org-back-to-heading t)
  4839. (hide-subtree)
  4840. (org-reveal)
  4841. (cond
  4842. ((equal state '("fold" "folded"))
  4843. (hide-subtree))
  4844. ((equal state "children")
  4845. (org-show-hidden-entry)
  4846. (show-children))
  4847. ((equal state "content")
  4848. (save-excursion
  4849. (save-restriction
  4850. (org-narrow-to-subtree)
  4851. (org-content))))
  4852. ((member state '("all" "showall"))
  4853. (show-subtree)))))
  4854. (unless no-cleanup
  4855. (org-cycle-hide-archived-subtrees 'all)
  4856. (org-cycle-hide-drawers 'all)
  4857. (org-cycle-show-empty-lines 'all)))))
  4858. (defun org-overview ()
  4859. "Switch to overview mode, showing only top-level headlines.
  4860. Really, this shows all headlines with level equal or greater than the level
  4861. of the first headline in the buffer. This is important, because if the
  4862. first headline is not level one, then (hide-sublevels 1) gives confusing
  4863. results."
  4864. (interactive)
  4865. (let ((level (save-excursion
  4866. (goto-char (point-min))
  4867. (if (re-search-forward (concat "^" outline-regexp) nil t)
  4868. (progn
  4869. (goto-char (match-beginning 0))
  4870. (funcall outline-level))))))
  4871. (and level (hide-sublevels level))))
  4872. (defun org-content (&optional arg)
  4873. "Show all headlines in the buffer, like a table of contents.
  4874. With numerical argument N, show content up to level N."
  4875. (interactive "P")
  4876. (save-excursion
  4877. ;; Visit all headings and show their offspring
  4878. (and (integerp arg) (org-overview))
  4879. (goto-char (point-max))
  4880. (catch 'exit
  4881. (while (and (progn (condition-case nil
  4882. (outline-previous-visible-heading 1)
  4883. (error (goto-char (point-min))))
  4884. t)
  4885. (looking-at outline-regexp))
  4886. (if (integerp arg)
  4887. (show-children (1- arg))
  4888. (show-branches))
  4889. (if (bobp) (throw 'exit nil))))))
  4890. (defun org-optimize-window-after-visibility-change (state)
  4891. "Adjust the window after a change in outline visibility.
  4892. This function is the default value of the hook `org-cycle-hook'."
  4893. (when (get-buffer-window (current-buffer))
  4894. (cond
  4895. ((eq state 'content) nil)
  4896. ((eq state 'all) nil)
  4897. ((eq state 'folded) nil)
  4898. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  4899. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  4900. (defun org-remove-empty-overlays-at (pos)
  4901. "Remove outline overlays that do not contain non-white stuff."
  4902. (mapc
  4903. (lambda (o)
  4904. (and (eq 'outline (org-overlay-get o 'invisible))
  4905. (not (string-match "\\S-" (buffer-substring (org-overlay-start o)
  4906. (org-overlay-end o))))
  4907. (org-delete-overlay o)))
  4908. (org-overlays-at pos)))
  4909. (defun org-clean-visibility-after-subtree-move ()
  4910. "Fix visibility issues after moving a subtree."
  4911. ;; First, find a reasonable region to look at:
  4912. ;; Start two siblings above, end three below
  4913. (let* ((beg (save-excursion
  4914. (and (org-get-last-sibling)
  4915. (org-get-last-sibling))
  4916. (point)))
  4917. (end (save-excursion
  4918. (and (org-get-next-sibling)
  4919. (org-get-next-sibling)
  4920. (org-get-next-sibling))
  4921. (if (org-at-heading-p)
  4922. (point-at-eol)
  4923. (point))))
  4924. (level (looking-at "\\*+"))
  4925. (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
  4926. (save-excursion
  4927. (save-restriction
  4928. (narrow-to-region beg end)
  4929. (when re
  4930. ;; Properly fold already folded siblings
  4931. (goto-char (point-min))
  4932. (while (re-search-forward re nil t)
  4933. (if (and (not (org-invisible-p))
  4934. (save-excursion
  4935. (goto-char (point-at-eol)) (org-invisible-p)))
  4936. (hide-entry))))
  4937. (org-cycle-show-empty-lines 'overview)
  4938. (org-cycle-hide-drawers 'overview)))))
  4939. (defun org-cycle-show-empty-lines (state)
  4940. "Show empty lines above all visible headlines.
  4941. The region to be covered depends on STATE when called through
  4942. `org-cycle-hook'. Lisp program can use t for STATE to get the
  4943. entire buffer covered. Note that an empty line is only shown if there
  4944. are at least `org-cycle-separator-lines' empty lines before the headline."
  4945. (when (not (= org-cycle-separator-lines 0))
  4946. (save-excursion
  4947. (let* ((n (abs org-cycle-separator-lines))
  4948. (re (cond
  4949. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  4950. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  4951. (t (let ((ns (number-to-string (- n 2))))
  4952. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  4953. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  4954. beg end b e)
  4955. (cond
  4956. ((memq state '(overview contents t))
  4957. (setq beg (point-min) end (point-max)))
  4958. ((memq state '(children folded))
  4959. (setq beg (point) end (progn (org-end-of-subtree t t)
  4960. (beginning-of-line 2)
  4961. (point)))))
  4962. (when beg
  4963. (goto-char beg)
  4964. (while (re-search-forward re end t)
  4965. (unless (get-char-property (match-end 1) 'invisible)
  4966. (setq e (match-end 1))
  4967. (if (< org-cycle-separator-lines 0)
  4968. (setq b (save-excursion
  4969. (goto-char (match-beginning 0))
  4970. (org-back-over-empty-lines)
  4971. (if (save-excursion
  4972. (goto-char (max (point-min) (1- (point))))
  4973. (org-on-heading-p))
  4974. (1- (point))
  4975. (point))))
  4976. (setq b (match-beginning 1)))
  4977. (outline-flag-region b e nil)))))))
  4978. ;; Never hide empty lines at the end of the file.
  4979. (save-excursion
  4980. (goto-char (point-max))
  4981. (outline-previous-heading)
  4982. (outline-end-of-heading)
  4983. (if (and (looking-at "[ \t\n]+")
  4984. (= (match-end 0) (point-max)))
  4985. (outline-flag-region (point) (match-end 0) nil))))
  4986. (defun org-show-empty-lines-in-parent ()
  4987. "Move to the parent and re-show empty lines before visible headlines."
  4988. (save-excursion
  4989. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  4990. (org-cycle-show-empty-lines context))))
  4991. (defun org-files-list ()
  4992. "Return `org-agenda-files' list, plus all open org-mode files.
  4993. This is useful for operations that need to scan all of a user's
  4994. open and agenda-wise Org files."
  4995. (let ((files (mapcar 'expand-file-name (org-agenda-files))))
  4996. (dolist (buf (buffer-list))
  4997. (with-current-buffer buf
  4998. (if (and (eq major-mode 'org-mode) (buffer-file-name))
  4999. (let ((file (expand-file-name (buffer-file-name))))
  5000. (unless (member file files)
  5001. (push file files))))))
  5002. files))
  5003. (defsubst org-entry-beginning-position ()
  5004. "Return the beginning position of the current entry."
  5005. (save-excursion (outline-back-to-heading t) (point)))
  5006. (defsubst org-entry-end-position ()
  5007. "Return the end position of the current entry."
  5008. (save-excursion (outline-next-heading) (point)))
  5009. (defun org-cycle-hide-drawers (state)
  5010. "Re-hide all drawers after a visibility state change."
  5011. (when (and (org-mode-p)
  5012. (not (memq state '(overview folded contents))))
  5013. (save-excursion
  5014. (let* ((globalp (memq state '(contents all)))
  5015. (beg (if globalp (point-min) (point)))
  5016. (end (if globalp (point-max)
  5017. (if (eq state 'children)
  5018. (save-excursion (outline-next-heading) (point))
  5019. (org-end-of-subtree t)))))
  5020. (goto-char beg)
  5021. (while (re-search-forward org-drawer-regexp end t)
  5022. (org-flag-drawer t))))))
  5023. (defun org-flag-drawer (flag)
  5024. (save-excursion
  5025. (beginning-of-line 1)
  5026. (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
  5027. (let ((b (match-end 0))
  5028. (outline-regexp org-outline-regexp))
  5029. (if (re-search-forward
  5030. "^[ \t]*:END:"
  5031. (save-excursion (outline-next-heading) (point)) t)
  5032. (outline-flag-region b (point-at-eol) flag)
  5033. (error ":END: line missing at position %s" b))))))
  5034. (defun org-subtree-end-visible-p ()
  5035. "Is the end of the current subtree visible?"
  5036. (pos-visible-in-window-p
  5037. (save-excursion (org-end-of-subtree t) (point))))
  5038. (defun org-first-headline-recenter (&optional N)
  5039. "Move cursor to the first headline and recenter the headline.
  5040. Optional argument N means put the headline into the Nth line of the window."
  5041. (goto-char (point-min))
  5042. (when (re-search-forward (concat "^\\(" outline-regexp "\\)") nil t)
  5043. (beginning-of-line)
  5044. (recenter (prefix-numeric-value N))))
  5045. ;;; Saving and restoring visibility
  5046. (defun org-outline-overlay-data (&optional use-markers)
  5047. "Return a list of the locations of all outline overlays.
  5048. The are overlays with the `invisible' property value `outline'.
  5049. The return valus is a list of cons cells, with start and stop
  5050. positions for each overlay.
  5051. If USE-MARKERS is set, return the positions as markers."
  5052. (let (beg end)
  5053. (save-excursion
  5054. (save-restriction
  5055. (widen)
  5056. (delq nil
  5057. (mapcar (lambda (o)
  5058. (when (eq (org-overlay-get o 'invisible) 'outline)
  5059. (setq beg (org-overlay-start o)
  5060. end (org-overlay-end o))
  5061. (and beg end (> end beg)
  5062. (if use-markers
  5063. (cons (move-marker (make-marker) beg)
  5064. (move-marker (make-marker) end))
  5065. (cons beg end)))))
  5066. (org-overlays-in (point-min) (point-max))))))))
  5067. (defun org-set-outline-overlay-data (data)
  5068. "Create visibility overlays for all positions in DATA.
  5069. DATA should have been made by `org-outline-overlay-data'."
  5070. (let (o)
  5071. (save-excursion
  5072. (save-restriction
  5073. (widen)
  5074. (show-all)
  5075. (mapc (lambda (c)
  5076. (setq o (org-make-overlay (car c) (cdr c)))
  5077. (org-overlay-put o 'invisible 'outline))
  5078. data)))))
  5079. (defmacro org-save-outline-visibility (use-markers &rest body)
  5080. "Save and restore outline visibility around BODY.
  5081. If USE-MARKERS is non-nil, use markers for the positions.
  5082. This means that the buffer may change while running BODY,
  5083. but it also means that the buffer should stay alive
  5084. during the operation, because otherwise all these markers will
  5085. point nowhere."
  5086. `(let ((data (org-outline-overlay-data ,use-markers)))
  5087. (unwind-protect
  5088. (progn
  5089. ,@body
  5090. (org-set-outline-overlay-data data))
  5091. (when ,use-markers
  5092. (mapc (lambda (c)
  5093. (and (markerp (car c)) (move-marker (car c) nil))
  5094. (and (markerp (cdr c)) (move-marker (cdr c) nil)))
  5095. data)))))
  5096. ;;; Folding of blocks
  5097. (defconst org-block-regexp
  5098. "^[ \t]*#\\+begin_\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_\\1[ \t]*$"
  5099. "Regular expression for hiding blocks.")
  5100. (defvar org-hide-block-overlays nil
  5101. "Overlays hiding blocks.")
  5102. (make-variable-buffer-local 'org-hide-block-overlays)
  5103. (defun org-block-map (function &optional start end)
  5104. "Call func at the head of all source blocks in the current
  5105. buffer. Optional arguments START and END can be used to limit
  5106. the range."
  5107. (let ((start (or start (point-min)))
  5108. (end (or end (point-max))))
  5109. (save-excursion
  5110. (goto-char start)
  5111. (while (and (< (point) end) (re-search-forward org-block-regexp end t))
  5112. (save-excursion
  5113. (save-match-data
  5114. (goto-char (match-beginning 0))
  5115. (funcall function)))))))
  5116. (defun org-hide-block-toggle-all ()
  5117. "Toggle the visibility of all blocks in the current buffer."
  5118. (org-block-map #'org-hide-block-toggle))
  5119. (defun org-hide-block-all ()
  5120. "Fold all blocks in the current buffer."
  5121. (interactive)
  5122. (org-show-block-all)
  5123. (org-block-map #'org-hide-block-toggle-maybe))
  5124. (defun org-show-block-all ()
  5125. "Unfold all blocks in the current buffer."
  5126. (mapc 'org-delete-overlay org-hide-block-overlays)
  5127. (setq org-hide-block-overlays nil))
  5128. (defun org-hide-block-toggle-maybe ()
  5129. "Toggle visibility of block at point."
  5130. (interactive)
  5131. (let ((case-fold-search t))
  5132. (if (save-excursion
  5133. (beginning-of-line 1)
  5134. (looking-at org-block-regexp))
  5135. (progn (org-hide-block-toggle)
  5136. t) ;; to signal that we took action
  5137. nil))) ;; to signal that we did not
  5138. (defun org-hide-block-toggle (&optional force)
  5139. "Toggle the visibility of the current block."
  5140. (interactive)
  5141. (save-excursion
  5142. (beginning-of-line)
  5143. (if (re-search-forward org-block-regexp nil t)
  5144. (let ((start (- (match-beginning 4) 1)) ;; beginning of body
  5145. (end (match-end 0)) ;; end of entire body
  5146. ov)
  5147. (if (memq t (mapcar (lambda (overlay)
  5148. (eq (org-overlay-get overlay 'invisible)
  5149. 'org-hide-block))
  5150. (org-overlays-at start)))
  5151. (if (or (not force) (eq force 'off))
  5152. (mapc (lambda (ov)
  5153. (when (member ov org-hide-block-overlays)
  5154. (setq org-hide-block-overlays
  5155. (delq ov org-hide-block-overlays)))
  5156. (when (eq (org-overlay-get ov 'invisible)
  5157. 'org-hide-block)
  5158. (org-delete-overlay ov)))
  5159. (org-overlays-at start)))
  5160. (setq ov (org-make-overlay start end))
  5161. (org-overlay-put ov 'invisible 'org-hide-block)
  5162. ;; make the block accessible to isearch
  5163. (org-overlay-put
  5164. ov 'isearch-open-invisible
  5165. (lambda (ov)
  5166. (when (member ov org-hide-block-overlays)
  5167. (setq org-hide-block-overlays
  5168. (delq ov org-hide-block-overlays)))
  5169. (when (eq (org-overlay-get ov 'invisible)
  5170. 'org-hide-block)
  5171. (org-delete-overlay ov))))
  5172. (push ov org-hide-block-overlays)))
  5173. (error "Not looking at a source block"))))
  5174. ;; org-tab-after-check-for-cycling-hook
  5175. (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
  5176. ;; Remove overlays when changing major mode
  5177. (add-hook 'org-mode-hook
  5178. (lambda () (org-add-hook 'change-major-mode-hook
  5179. 'org-show-block-all 'append 'local)))
  5180. ;;; Org-goto
  5181. (defvar org-goto-window-configuration nil)
  5182. (defvar org-goto-marker nil)
  5183. (defvar org-goto-map
  5184. (let ((map (make-sparse-keymap)))
  5185. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
  5186. (while (setq cmd (pop cmds))
  5187. (substitute-key-definition cmd cmd map global-map)))
  5188. (suppress-keymap map)
  5189. (org-defkey map "\C-m" 'org-goto-ret)
  5190. (org-defkey map [(return)] 'org-goto-ret)
  5191. (org-defkey map [(left)] 'org-goto-left)
  5192. (org-defkey map [(right)] 'org-goto-right)
  5193. (org-defkey map [(control ?g)] 'org-goto-quit)
  5194. (org-defkey map "\C-i" 'org-cycle)
  5195. (org-defkey map [(tab)] 'org-cycle)
  5196. (org-defkey map [(down)] 'outline-next-visible-heading)
  5197. (org-defkey map [(up)] 'outline-previous-visible-heading)
  5198. (if org-goto-auto-isearch
  5199. (if (fboundp 'define-key-after)
  5200. (define-key-after map [t] 'org-goto-local-auto-isearch)
  5201. nil)
  5202. (org-defkey map "q" 'org-goto-quit)
  5203. (org-defkey map "n" 'outline-next-visible-heading)
  5204. (org-defkey map "p" 'outline-previous-visible-heading)
  5205. (org-defkey map "f" 'outline-forward-same-level)
  5206. (org-defkey map "b" 'outline-backward-same-level)
  5207. (org-defkey map "u" 'outline-up-heading))
  5208. (org-defkey map "/" 'org-occur)
  5209. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  5210. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  5211. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  5212. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  5213. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  5214. map))
  5215. (defconst org-goto-help
  5216. "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
  5217. RET=jump to location [Q]uit and return to previous location
  5218. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  5219. (defvar org-goto-start-pos) ; dynamically scoped parameter
  5220. ;; FIXME: Docstring does not mention both interfaces
  5221. (defun org-goto (&optional alternative-interface)
  5222. "Look up a different location in the current file, keeping current visibility.
  5223. When you want look-up or go to a different location in a document, the
  5224. fastest way is often to fold the entire buffer and then dive into the tree.
  5225. This method has the disadvantage, that the previous location will be folded,
  5226. which may not be what you want.
  5227. This command works around this by showing a copy of the current buffer
  5228. in an indirect buffer, in overview mode. You can dive into the tree in
  5229. that copy, use org-occur and incremental search to find a location.
  5230. When pressing RET or `Q', the command returns to the original buffer in
  5231. which the visibility is still unchanged. After RET is will also jump to
  5232. the location selected in the indirect buffer and expose the
  5233. the headline hierarchy above."
  5234. (interactive "P")
  5235. (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
  5236. (org-refile-use-outline-path t)
  5237. (org-refile-target-verify-function nil)
  5238. (interface
  5239. (if (not alternative-interface)
  5240. org-goto-interface
  5241. (if (eq org-goto-interface 'outline)
  5242. 'outline-path-completion
  5243. 'outline)))
  5244. (org-goto-start-pos (point))
  5245. (selected-point
  5246. (if (eq interface 'outline)
  5247. (car (org-get-location (current-buffer) org-goto-help))
  5248. (nth 3 (org-refile-get-location "Goto: ")))))
  5249. (if selected-point
  5250. (progn
  5251. (org-mark-ring-push org-goto-start-pos)
  5252. (goto-char selected-point)
  5253. (if (or (org-invisible-p) (org-invisible-p2))
  5254. (org-show-context 'org-goto)))
  5255. (message "Quit"))))
  5256. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  5257. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  5258. (defvar org-goto-local-auto-isearch-map) ; defined below
  5259. (defun org-get-location (buf help)
  5260. "Let the user select a location in the Org-mode buffer BUF.
  5261. This function uses a recursive edit. It returns the selected position
  5262. or nil."
  5263. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  5264. (isearch-hide-immediately nil)
  5265. (isearch-search-fun-function
  5266. (lambda () 'org-goto-local-search-headings))
  5267. (org-goto-selected-point org-goto-exit-command)
  5268. (pop-up-frames nil)
  5269. (special-display-buffer-names nil)
  5270. (special-display-regexps nil)
  5271. (special-display-function nil))
  5272. (save-excursion
  5273. (save-window-excursion
  5274. (delete-other-windows)
  5275. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  5276. (switch-to-buffer
  5277. (condition-case nil
  5278. (make-indirect-buffer (current-buffer) "*org-goto*")
  5279. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  5280. (with-output-to-temp-buffer "*Help*"
  5281. (princ help))
  5282. (org-fit-window-to-buffer (get-buffer-window "*Help*"))
  5283. (setq buffer-read-only nil)
  5284. (let ((org-startup-truncated t)
  5285. (org-startup-folded nil)
  5286. (org-startup-align-all-tables nil))
  5287. (org-mode)
  5288. (org-overview))
  5289. (setq buffer-read-only t)
  5290. (if (and (boundp 'org-goto-start-pos)
  5291. (integer-or-marker-p org-goto-start-pos))
  5292. (let ((org-show-hierarchy-above t)
  5293. (org-show-siblings t)
  5294. (org-show-following-heading t))
  5295. (goto-char org-goto-start-pos)
  5296. (and (org-invisible-p) (org-show-context)))
  5297. (goto-char (point-min)))
  5298. (let (org-special-ctrl-a/e) (org-beginning-of-line))
  5299. (message "Select location and press RET")
  5300. (use-local-map org-goto-map)
  5301. (recursive-edit)
  5302. ))
  5303. (kill-buffer "*org-goto*")
  5304. (cons org-goto-selected-point org-goto-exit-command)))
  5305. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  5306. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  5307. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  5308. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
  5309. (defun org-goto-local-search-headings (string bound noerror)
  5310. "Search and make sure that any matches are in headlines."
  5311. (catch 'return
  5312. (while (if isearch-forward
  5313. (search-forward string bound noerror)
  5314. (search-backward string bound noerror))
  5315. (when (let ((context (mapcar 'car (save-match-data (org-context)))))
  5316. (and (member :headline context)
  5317. (not (member :tags context))))
  5318. (throw 'return (point))))))
  5319. (defun org-goto-local-auto-isearch ()
  5320. "Start isearch."
  5321. (interactive)
  5322. (goto-char (point-min))
  5323. (let ((keys (this-command-keys)))
  5324. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  5325. (isearch-mode t)
  5326. (isearch-process-search-char (string-to-char keys)))))
  5327. (defun org-goto-ret (&optional arg)
  5328. "Finish `org-goto' by going to the new location."
  5329. (interactive "P")
  5330. (setq org-goto-selected-point (point)
  5331. org-goto-exit-command 'return)
  5332. (throw 'exit nil))
  5333. (defun org-goto-left ()
  5334. "Finish `org-goto' by going to the new location."
  5335. (interactive)
  5336. (if (org-on-heading-p)
  5337. (progn
  5338. (beginning-of-line 1)
  5339. (setq org-goto-selected-point (point)
  5340. org-goto-exit-command 'left)
  5341. (throw 'exit nil))
  5342. (error "Not on a heading")))
  5343. (defun org-goto-right ()
  5344. "Finish `org-goto' by going to the new location."
  5345. (interactive)
  5346. (if (org-on-heading-p)
  5347. (progn
  5348. (setq org-goto-selected-point (point)
  5349. org-goto-exit-command 'right)
  5350. (throw 'exit nil))
  5351. (error "Not on a heading")))
  5352. (defun org-goto-quit ()
  5353. "Finish `org-goto' without cursor motion."
  5354. (interactive)
  5355. (setq org-goto-selected-point nil)
  5356. (setq org-goto-exit-command 'quit)
  5357. (throw 'exit nil))
  5358. ;;; Indirect buffer display of subtrees
  5359. (defvar org-indirect-dedicated-frame nil
  5360. "This is the frame being used for indirect tree display.")
  5361. (defvar org-last-indirect-buffer nil)
  5362. (defun org-tree-to-indirect-buffer (&optional arg)
  5363. "Create indirect buffer and narrow it to current subtree.
  5364. With numerical prefix ARG, go up to this level and then take that tree.
  5365. If ARG is negative, go up that many levels.
  5366. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  5367. indirect buffer previously made with this command, to avoid proliferation of
  5368. indirect buffers. However, when you call the command with a `C-u' prefix, or
  5369. when `org-indirect-buffer-display' is `new-frame', the last buffer
  5370. is kept so that you can work with several indirect buffers at the same time.
  5371. If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
  5372. requests that a new frame be made for the new buffer, so that the dedicated
  5373. frame is not changed."
  5374. (interactive "P")
  5375. (let ((cbuf (current-buffer))
  5376. (cwin (selected-window))
  5377. (pos (point))
  5378. beg end level heading ibuf)
  5379. (save-excursion
  5380. (org-back-to-heading t)
  5381. (when (numberp arg)
  5382. (setq level (org-outline-level))
  5383. (if (< arg 0) (setq arg (+ level arg)))
  5384. (while (> (setq level (org-outline-level)) arg)
  5385. (outline-up-heading 1 t)))
  5386. (setq beg (point)
  5387. heading (org-get-heading))
  5388. (org-end-of-subtree t t)
  5389. (if (org-on-heading-p) (backward-char 1))
  5390. (setq end (point)))
  5391. (if (and (buffer-live-p org-last-indirect-buffer)
  5392. (not (eq org-indirect-buffer-display 'new-frame))
  5393. (not arg))
  5394. (kill-buffer org-last-indirect-buffer))
  5395. (setq ibuf (org-get-indirect-buffer cbuf)
  5396. org-last-indirect-buffer ibuf)
  5397. (cond
  5398. ((or (eq org-indirect-buffer-display 'new-frame)
  5399. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  5400. (select-frame (make-frame))
  5401. (delete-other-windows)
  5402. (switch-to-buffer ibuf)
  5403. (org-set-frame-title heading))
  5404. ((eq org-indirect-buffer-display 'dedicated-frame)
  5405. (raise-frame
  5406. (select-frame (or (and org-indirect-dedicated-frame
  5407. (frame-live-p org-indirect-dedicated-frame)
  5408. org-indirect-dedicated-frame)
  5409. (setq org-indirect-dedicated-frame (make-frame)))))
  5410. (delete-other-windows)
  5411. (switch-to-buffer ibuf)
  5412. (org-set-frame-title (concat "Indirect: " heading)))
  5413. ((eq org-indirect-buffer-display 'current-window)
  5414. (switch-to-buffer ibuf))
  5415. ((eq org-indirect-buffer-display 'other-window)
  5416. (pop-to-buffer ibuf))
  5417. (t (error "Invalid value")))
  5418. (if (featurep 'xemacs)
  5419. (save-excursion (org-mode) (turn-on-font-lock)))
  5420. (narrow-to-region beg end)
  5421. (show-all)
  5422. (goto-char pos)
  5423. (and (window-live-p cwin) (select-window cwin))))
  5424. (defun org-get-indirect-buffer (&optional buffer)
  5425. (setq buffer (or buffer (current-buffer)))
  5426. (let ((n 1) (base (buffer-name buffer)) bname)
  5427. (while (buffer-live-p
  5428. (get-buffer (setq bname (concat base "-" (number-to-string n)))))
  5429. (setq n (1+ n)))
  5430. (condition-case nil
  5431. (make-indirect-buffer buffer bname 'clone)
  5432. (error (make-indirect-buffer buffer bname)))))
  5433. (defun org-set-frame-title (title)
  5434. "Set the title of the current frame to the string TITLE."
  5435. ;; FIXME: how to name a single frame in XEmacs???
  5436. (unless (featurep 'xemacs)
  5437. (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
  5438. ;;;; Structure editing
  5439. ;;; Inserting headlines
  5440. (defun org-previous-line-empty-p ()
  5441. (save-excursion
  5442. (and (not (bobp))
  5443. (or (beginning-of-line 0) t)
  5444. (save-match-data
  5445. (looking-at "[ \t]*$")))))
  5446. (defun org-insert-heading (&optional force-heading invisible-ok)
  5447. "Insert a new heading or item with same depth at point.
  5448. If point is in a plain list and FORCE-HEADING is nil, create a new list item.
  5449. If point is at the beginning of a headline, insert a sibling before the
  5450. current headline. If point is not at the beginning, do not split the line,
  5451. but create the new headline after the current line.
  5452. When INVISIBLE-OK is set, stop at invisible headlines when going back.
  5453. This is important for non-interactive uses of the command."
  5454. (interactive "P")
  5455. (if (or (= (buffer-size) 0)
  5456. (and (not (save-excursion (and (ignore-errors (org-back-to-heading invisible-ok))
  5457. (org-on-heading-p))))
  5458. (not (org-in-item-p))))
  5459. (insert "\n* ")
  5460. (when (or force-heading (not (org-insert-item)))
  5461. (let* ((empty-line-p nil)
  5462. (head (save-excursion
  5463. (condition-case nil
  5464. (progn
  5465. (org-back-to-heading invisible-ok)
  5466. (setq empty-line-p (org-previous-line-empty-p))
  5467. (match-string 0))
  5468. (error "*"))))
  5469. (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
  5470. (blank (if (eq blank-a 'auto) empty-line-p blank-a))
  5471. pos hide-previous previous-pos)
  5472. (cond
  5473. ((and (org-on-heading-p) (bolp)
  5474. (or (bobp)
  5475. (save-excursion (backward-char 1) (not (org-invisible-p)))))
  5476. ;; insert before the current line
  5477. (open-line (if blank 2 1)))
  5478. ((and (bolp)
  5479. (not org-insert-heading-respect-content)
  5480. (or (bobp)
  5481. (save-excursion
  5482. (backward-char 1) (not (org-invisible-p)))))
  5483. ;; insert right here
  5484. nil)
  5485. (t
  5486. ;; somewhere in the line
  5487. (save-excursion
  5488. (setq previous-pos (point-at-bol))
  5489. (end-of-line)
  5490. (setq hide-previous (org-invisible-p)))
  5491. (and org-insert-heading-respect-content (org-show-subtree))
  5492. (let ((split
  5493. (and (org-get-alist-option org-M-RET-may-split-line 'headline)
  5494. (save-excursion
  5495. (let ((p (point)))
  5496. (goto-char (point-at-bol))
  5497. (and (looking-at org-complex-heading-regexp)
  5498. (> p (match-beginning 4)))))))
  5499. tags pos)
  5500. (cond
  5501. (org-insert-heading-respect-content
  5502. (org-end-of-subtree nil t)
  5503. (or (bolp) (newline))
  5504. (or (org-previous-line-empty-p)
  5505. (and blank (newline)))
  5506. (open-line 1))
  5507. ((org-on-heading-p)
  5508. (when hide-previous
  5509. (show-children)
  5510. (org-show-entry))
  5511. (looking-at ".*?\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)?[ \t]*$")
  5512. (setq tags (and (match-end 2) (match-string 2)))
  5513. (and (match-end 1)
  5514. (delete-region (match-beginning 1) (match-end 1)))
  5515. (setq pos (point-at-bol))
  5516. (or split (end-of-line 1))
  5517. (delete-horizontal-space)
  5518. (newline (if blank 2 1))
  5519. (when tags
  5520. (save-excursion
  5521. (goto-char pos)
  5522. (end-of-line 1)
  5523. (insert " " tags)
  5524. (org-set-tags nil 'align))))
  5525. (t
  5526. (or split (end-of-line 1))
  5527. (newline (if blank 2 1)))))))
  5528. (insert head) (just-one-space)
  5529. (setq pos (point))
  5530. (end-of-line 1)
  5531. (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
  5532. (when (and org-insert-heading-respect-content hide-previous)
  5533. (save-excursion
  5534. (goto-char previous-pos)
  5535. (hide-subtree)))
  5536. (run-hooks 'org-insert-heading-hook)))))
  5537. (defun org-get-heading (&optional no-tags)
  5538. "Return the heading of the current entry, without the stars."
  5539. (save-excursion
  5540. (org-back-to-heading t)
  5541. (if (looking-at
  5542. (if no-tags
  5543. (org-re "\\*+[ \t]+\\([^\n\r]*?\\)\\([ \t]+:[[:alnum:]:_@]+:[ \t]*\\)?$")
  5544. "\\*+[ \t]+\\([^\r\n]*\\)"))
  5545. (match-string 1) "")))
  5546. (defun org-heading-components ()
  5547. "Return the components of the current heading.
  5548. This is a list with the following elements:
  5549. - the level as an integer
  5550. - the reduced level, different if `org-odd-levels-only' is set.
  5551. - the TODO keyword, or nil
  5552. - the priority character, like ?A, or nil if no priority is given
  5553. - the headline text itself, or the tags string if no headline text
  5554. - the tags string, or nil."
  5555. (save-excursion
  5556. (org-back-to-heading t)
  5557. (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
  5558. (list (length (match-string 1))
  5559. (org-reduced-level (length (match-string 1)))
  5560. (org-match-string-no-properties 2)
  5561. (and (match-end 3) (aref (match-string 3) 2))
  5562. (org-match-string-no-properties 4)
  5563. (org-match-string-no-properties 5)))))
  5564. (defun org-get-entry ()
  5565. "Get the entry text, after heading, entire subtree."
  5566. (save-excursion
  5567. (org-back-to-heading t)
  5568. (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
  5569. (defun org-insert-heading-after-current ()
  5570. "Insert a new heading with same level as current, after current subtree."
  5571. (interactive)
  5572. (org-back-to-heading)
  5573. (org-insert-heading)
  5574. (org-move-subtree-down)
  5575. (end-of-line 1))
  5576. (defun org-insert-heading-respect-content ()
  5577. (interactive)
  5578. (let ((org-insert-heading-respect-content t))
  5579. (org-insert-heading t)))
  5580. (defun org-insert-todo-heading-respect-content (&optional force-state)
  5581. (interactive "P")
  5582. (let ((org-insert-heading-respect-content t))
  5583. (org-insert-todo-heading force-state t)))
  5584. (defun org-insert-todo-heading (arg &optional force-heading)
  5585. "Insert a new heading with the same level and TODO state as current heading.
  5586. If the heading has no TODO state, or if the state is DONE, use the first
  5587. state (TODO by default). Also with prefix arg, force first state."