interpreter.py 217 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751
  1. # Copyright 2012-2019 The Meson development team
  2. # Licensed under the Apache License, Version 2.0 (the "License");
  3. # you may not use this file except in compliance with the License.
  4. # You may obtain a copy of the License at
  5. # http://www.apache.org/licenses/LICENSE-2.0
  6. # Unless required by applicable law or agreed to in writing, software
  7. # distributed under the License is distributed on an "AS IS" BASIS,
  8. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  9. # See the License for the specific language governing permissions and
  10. # limitations under the License.
  11. from . import mparser
  12. from . import environment
  13. from . import coredata
  14. from . import dependencies
  15. from . import mlog
  16. from . import build
  17. from . import optinterpreter
  18. from . import compilers
  19. from .wrap import wrap, WrapMode
  20. from . import mesonlib
  21. from .mesonlib import FileMode, MachineChoice, Popen_safe, listify, extract_as_list, has_path_sep, unholder
  22. from .dependencies import ExternalProgram
  23. from .dependencies import InternalDependency, Dependency, NotFoundDependency, DependencyException
  24. from .depfile import DepFile
  25. from .interpreterbase import InterpreterBase
  26. from .interpreterbase import check_stringlist, flatten, noPosargs, noKwargs, stringArgs, permittedKwargs, noArgsFlattening
  27. from .interpreterbase import InterpreterException, InvalidArguments, InvalidCode, SubdirDoneRequest
  28. from .interpreterbase import InterpreterObject, MutableInterpreterObject, Disabler, disablerIfNotFound
  29. from .interpreterbase import FeatureNew, FeatureDeprecated, FeatureNewKwargs
  30. from .interpreterbase import ObjectHolder
  31. from .modules import ModuleReturnValue
  32. from .cmake import CMakeInterpreter
  33. from .backend.backends import TestProtocol
  34. from pathlib import Path, PurePath
  35. import os
  36. import shutil
  37. import uuid
  38. import re
  39. import shlex
  40. import subprocess
  41. import collections
  42. import functools
  43. import typing as T
  44. import importlib
  45. permitted_method_kwargs = {
  46. 'partial_dependency': {'compile_args', 'link_args', 'links', 'includes',
  47. 'sources'},
  48. }
  49. def stringifyUserArguments(args):
  50. if isinstance(args, list):
  51. return '[%s]' % ', '.join([stringifyUserArguments(x) for x in args])
  52. elif isinstance(args, dict):
  53. return '{%s}' % ', '.join(['%s : %s' % (stringifyUserArguments(k), stringifyUserArguments(v)) for k, v in args.items()])
  54. elif isinstance(args, int):
  55. return str(args)
  56. elif isinstance(args, str):
  57. return "'%s'" % args
  58. raise InvalidArguments('Function accepts only strings, integers, lists and lists thereof.')
  59. class OverrideProgram(dependencies.ExternalProgram):
  60. pass
  61. class FeatureOptionHolder(InterpreterObject, ObjectHolder):
  62. def __init__(self, env, name, option):
  63. InterpreterObject.__init__(self)
  64. ObjectHolder.__init__(self, option)
  65. if option.is_auto():
  66. self.held_object = env.coredata.builtins['auto_features']
  67. self.name = name
  68. self.methods.update({'enabled': self.enabled_method,
  69. 'disabled': self.disabled_method,
  70. 'auto': self.auto_method,
  71. })
  72. @noPosargs
  73. @permittedKwargs({})
  74. def enabled_method(self, args, kwargs):
  75. return self.held_object.is_enabled()
  76. @noPosargs
  77. @permittedKwargs({})
  78. def disabled_method(self, args, kwargs):
  79. return self.held_object.is_disabled()
  80. @noPosargs
  81. @permittedKwargs({})
  82. def auto_method(self, args, kwargs):
  83. return self.held_object.is_auto()
  84. def extract_required_kwarg(kwargs, subproject, feature_check=None, default=True):
  85. val = kwargs.get('required', default)
  86. disabled = False
  87. required = False
  88. feature = None
  89. if isinstance(val, FeatureOptionHolder):
  90. if not feature_check:
  91. feature_check = FeatureNew('User option "feature"', '0.47.0')
  92. feature_check.use(subproject)
  93. option = val.held_object
  94. feature = val.name
  95. if option.is_disabled():
  96. disabled = True
  97. elif option.is_enabled():
  98. required = True
  99. elif isinstance(val, bool):
  100. required = val
  101. else:
  102. raise InterpreterException('required keyword argument must be boolean or a feature option')
  103. # Keep boolean value in kwargs to simplify other places where this kwarg is
  104. # checked.
  105. kwargs['required'] = required
  106. return disabled, required, feature
  107. def extract_search_dirs(kwargs):
  108. search_dirs = mesonlib.stringlistify(kwargs.get('dirs', []))
  109. search_dirs = [Path(d).expanduser() for d in search_dirs]
  110. for d in search_dirs:
  111. if mesonlib.is_windows() and d.root.startswith('\\'):
  112. # a Unix-path starting with `/` that is not absolute on Windows.
  113. # discard without failing for end-user ease of cross-platform directory arrays
  114. continue
  115. if not d.is_absolute():
  116. raise InvalidCode('Search directory {} is not an absolute path.'.format(d))
  117. return list(map(str, search_dirs))
  118. class TryRunResultHolder(InterpreterObject):
  119. def __init__(self, res):
  120. super().__init__()
  121. self.res = res
  122. self.methods.update({'returncode': self.returncode_method,
  123. 'compiled': self.compiled_method,
  124. 'stdout': self.stdout_method,
  125. 'stderr': self.stderr_method,
  126. })
  127. @noPosargs
  128. @permittedKwargs({})
  129. def returncode_method(self, args, kwargs):
  130. return self.res.returncode
  131. @noPosargs
  132. @permittedKwargs({})
  133. def compiled_method(self, args, kwargs):
  134. return self.res.compiled
  135. @noPosargs
  136. @permittedKwargs({})
  137. def stdout_method(self, args, kwargs):
  138. return self.res.stdout
  139. @noPosargs
  140. @permittedKwargs({})
  141. def stderr_method(self, args, kwargs):
  142. return self.res.stderr
  143. class RunProcess(InterpreterObject):
  144. def __init__(self, cmd, args, env, source_dir, build_dir, subdir, mesonintrospect, in_builddir=False, check=False, capture=True):
  145. super().__init__()
  146. if not isinstance(cmd, ExternalProgram):
  147. raise AssertionError('BUG: RunProcess must be passed an ExternalProgram')
  148. self.capture = capture
  149. pc, self.stdout, self.stderr = self.run_command(cmd, args, env, source_dir, build_dir, subdir, mesonintrospect, in_builddir, check)
  150. self.returncode = pc.returncode
  151. self.methods.update({'returncode': self.returncode_method,
  152. 'stdout': self.stdout_method,
  153. 'stderr': self.stderr_method,
  154. })
  155. def run_command(self, cmd, args, env, source_dir, build_dir, subdir, mesonintrospect, in_builddir, check=False):
  156. command_array = cmd.get_command() + args
  157. menv = {'MESON_SOURCE_ROOT': source_dir,
  158. 'MESON_BUILD_ROOT': build_dir,
  159. 'MESON_SUBDIR': subdir,
  160. 'MESONINTROSPECT': ' '.join([shlex.quote(x) for x in mesonintrospect]),
  161. }
  162. if in_builddir:
  163. cwd = os.path.join(build_dir, subdir)
  164. else:
  165. cwd = os.path.join(source_dir, subdir)
  166. child_env = os.environ.copy()
  167. child_env.update(menv)
  168. child_env = env.get_env(child_env)
  169. stdout = subprocess.PIPE if self.capture else subprocess.DEVNULL
  170. mlog.debug('Running command:', ' '.join(command_array))
  171. try:
  172. p, o, e = Popen_safe(command_array, stdout=stdout, env=child_env, cwd=cwd)
  173. if self.capture:
  174. mlog.debug('--- stdout ---')
  175. mlog.debug(o)
  176. else:
  177. o = ''
  178. mlog.debug('--- stdout disabled ---')
  179. mlog.debug('--- stderr ---')
  180. mlog.debug(e)
  181. mlog.debug('')
  182. if check and p.returncode != 0:
  183. raise InterpreterException('Command "{}" failed with status {}.'.format(' '.join(command_array), p.returncode))
  184. return p, o, e
  185. except FileNotFoundError:
  186. raise InterpreterException('Could not execute command "%s".' % ' '.join(command_array))
  187. @noPosargs
  188. @permittedKwargs({})
  189. def returncode_method(self, args, kwargs):
  190. return self.returncode
  191. @noPosargs
  192. @permittedKwargs({})
  193. def stdout_method(self, args, kwargs):
  194. return self.stdout
  195. @noPosargs
  196. @permittedKwargs({})
  197. def stderr_method(self, args, kwargs):
  198. return self.stderr
  199. class ConfigureFileHolder(InterpreterObject, ObjectHolder):
  200. def __init__(self, subdir, sourcename, targetname, configuration_data):
  201. InterpreterObject.__init__(self)
  202. obj = build.ConfigureFile(subdir, sourcename, targetname, configuration_data)
  203. ObjectHolder.__init__(self, obj)
  204. class EnvironmentVariablesHolder(MutableInterpreterObject, ObjectHolder):
  205. def __init__(self, initial_values=None):
  206. MutableInterpreterObject.__init__(self)
  207. ObjectHolder.__init__(self, build.EnvironmentVariables())
  208. self.methods.update({'set': self.set_method,
  209. 'append': self.append_method,
  210. 'prepend': self.prepend_method,
  211. })
  212. if isinstance(initial_values, dict):
  213. for k, v in initial_values.items():
  214. self.set_method([k, v], {})
  215. elif isinstance(initial_values, list):
  216. for e in initial_values:
  217. if '=' not in e:
  218. raise InterpreterException('Env var definition must be of type key=val.')
  219. (k, val) = e.split('=', 1)
  220. k = k.strip()
  221. val = val.strip()
  222. if ' ' in k:
  223. raise InterpreterException('Env var key must not have spaces in it.')
  224. self.set_method([k, val], {})
  225. elif initial_values:
  226. raise AssertionError('Unsupported EnvironmentVariablesHolder initial_values')
  227. def __repr__(self):
  228. repr_str = "<{0}: {1}>"
  229. return repr_str.format(self.__class__.__name__, self.held_object.envvars)
  230. def add_var(self, method, args, kwargs):
  231. if not isinstance(kwargs.get("separator", ""), str):
  232. raise InterpreterException("EnvironmentVariablesHolder methods 'separator'"
  233. " argument needs to be a string.")
  234. if len(args) < 2:
  235. raise InterpreterException("EnvironmentVariablesHolder methods require at least"
  236. "2 arguments, first is the name of the variable and"
  237. " following one are values")
  238. # Warn when someone tries to use append() or prepend() on an env var
  239. # which already has an operation set on it. People seem to think that
  240. # multiple append/prepend operations stack, but they don't.
  241. if method != self.held_object.set and self.held_object.has_name(args[0]):
  242. mlog.warning('Overriding previous value of environment variable {!r} with a new one'
  243. .format(args[0]), location=self.current_node)
  244. self.held_object.add_var(method, args[0], args[1:], kwargs)
  245. @stringArgs
  246. @permittedKwargs({'separator'})
  247. def set_method(self, args, kwargs):
  248. self.add_var(self.held_object.set, args, kwargs)
  249. @stringArgs
  250. @permittedKwargs({'separator'})
  251. def append_method(self, args, kwargs):
  252. self.add_var(self.held_object.append, args, kwargs)
  253. @stringArgs
  254. @permittedKwargs({'separator'})
  255. def prepend_method(self, args, kwargs):
  256. self.add_var(self.held_object.prepend, args, kwargs)
  257. class ConfigurationDataHolder(MutableInterpreterObject, ObjectHolder):
  258. def __init__(self, pv, initial_values=None):
  259. MutableInterpreterObject.__init__(self)
  260. self.used = False # These objects become immutable after use in configure_file.
  261. ObjectHolder.__init__(self, build.ConfigurationData(), pv)
  262. self.methods.update({'set': self.set_method,
  263. 'set10': self.set10_method,
  264. 'set_quoted': self.set_quoted_method,
  265. 'has': self.has_method,
  266. 'get': self.get_method,
  267. 'get_unquoted': self.get_unquoted_method,
  268. 'merge_from': self.merge_from_method,
  269. })
  270. if isinstance(initial_values, dict):
  271. for k, v in initial_values.items():
  272. self.set_method([k, v], {})
  273. elif initial_values:
  274. raise AssertionError('Unsupported ConfigurationDataHolder initial_values')
  275. def is_used(self):
  276. return self.used
  277. def mark_used(self):
  278. self.used = True
  279. def validate_args(self, args, kwargs):
  280. if len(args) == 1 and isinstance(args[0], list) and len(args[0]) == 2:
  281. mlog.deprecation('Passing a list as the single argument to '
  282. 'configuration_data.set is deprecated. This will '
  283. 'become a hard error in the future.',
  284. location=self.current_node)
  285. args = args[0]
  286. if len(args) != 2:
  287. raise InterpreterException("Configuration set requires 2 arguments.")
  288. if self.used:
  289. raise InterpreterException("Can not set values on configuration object that has been used.")
  290. name, val = args
  291. if not isinstance(val, (int, str)):
  292. msg = 'Setting a configuration data value to {!r} is invalid, ' \
  293. 'and will fail at configure_file(). If you are using it ' \
  294. 'just to store some values, please use a dict instead.'
  295. mlog.deprecation(msg.format(val), location=self.current_node)
  296. desc = kwargs.get('description', None)
  297. if not isinstance(name, str):
  298. raise InterpreterException("First argument to set must be a string.")
  299. if desc is not None and not isinstance(desc, str):
  300. raise InterpreterException('Description must be a string.')
  301. return name, val, desc
  302. @noArgsFlattening
  303. def set_method(self, args, kwargs):
  304. (name, val, desc) = self.validate_args(args, kwargs)
  305. self.held_object.values[name] = (val, desc)
  306. def set_quoted_method(self, args, kwargs):
  307. (name, val, desc) = self.validate_args(args, kwargs)
  308. if not isinstance(val, str):
  309. raise InterpreterException("Second argument to set_quoted must be a string.")
  310. escaped_val = '\\"'.join(val.split('"'))
  311. self.held_object.values[name] = ('"' + escaped_val + '"', desc)
  312. def set10_method(self, args, kwargs):
  313. (name, val, desc) = self.validate_args(args, kwargs)
  314. if val:
  315. self.held_object.values[name] = (1, desc)
  316. else:
  317. self.held_object.values[name] = (0, desc)
  318. def has_method(self, args, kwargs):
  319. return args[0] in self.held_object.values
  320. @FeatureNew('configuration_data.get()', '0.38.0')
  321. @noArgsFlattening
  322. def get_method(self, args, kwargs):
  323. if len(args) < 1 or len(args) > 2:
  324. raise InterpreterException('Get method takes one or two arguments.')
  325. name = args[0]
  326. if name in self.held_object:
  327. return self.held_object.get(name)[0]
  328. if len(args) > 1:
  329. return args[1]
  330. raise InterpreterException('Entry %s not in configuration data.' % name)
  331. @FeatureNew('configuration_data.get_unquoted()', '0.44.0')
  332. def get_unquoted_method(self, args, kwargs):
  333. if len(args) < 1 or len(args) > 2:
  334. raise InterpreterException('Get method takes one or two arguments.')
  335. name = args[0]
  336. if name in self.held_object:
  337. val = self.held_object.get(name)[0]
  338. elif len(args) > 1:
  339. val = args[1]
  340. else:
  341. raise InterpreterException('Entry %s not in configuration data.' % name)
  342. if val[0] == '"' and val[-1] == '"':
  343. return val[1:-1]
  344. return val
  345. def get(self, name):
  346. return self.held_object.values[name] # (val, desc)
  347. def keys(self):
  348. return self.held_object.values.keys()
  349. def merge_from_method(self, args, kwargs):
  350. if len(args) != 1:
  351. raise InterpreterException('Merge_from takes one positional argument.')
  352. from_object = args[0]
  353. if not isinstance(from_object, ConfigurationDataHolder):
  354. raise InterpreterException('Merge_from argument must be a configuration data object.')
  355. from_object = from_object.held_object
  356. for k, v in from_object.values.items():
  357. self.held_object.values[k] = v
  358. # Interpreter objects can not be pickled so we must have
  359. # these wrappers.
  360. class DependencyHolder(InterpreterObject, ObjectHolder):
  361. def __init__(self, dep, pv):
  362. InterpreterObject.__init__(self)
  363. ObjectHolder.__init__(self, dep, pv)
  364. self.methods.update({'found': self.found_method,
  365. 'type_name': self.type_name_method,
  366. 'version': self.version_method,
  367. 'name': self.name_method,
  368. 'get_pkgconfig_variable': self.pkgconfig_method,
  369. 'get_configtool_variable': self.configtool_method,
  370. 'get_variable': self.variable_method,
  371. 'partial_dependency': self.partial_dependency_method,
  372. 'include_type': self.include_type_method,
  373. 'as_system': self.as_system_method,
  374. })
  375. def found(self):
  376. return self.found_method([], {})
  377. @noPosargs
  378. @permittedKwargs({})
  379. def type_name_method(self, args, kwargs):
  380. return self.held_object.type_name
  381. @noPosargs
  382. @permittedKwargs({})
  383. def found_method(self, args, kwargs):
  384. if self.held_object.type_name == 'internal':
  385. return True
  386. return self.held_object.found()
  387. @noPosargs
  388. @permittedKwargs({})
  389. def version_method(self, args, kwargs):
  390. return self.held_object.get_version()
  391. @noPosargs
  392. @permittedKwargs({})
  393. def name_method(self, args, kwargs):
  394. return self.held_object.get_name()
  395. @permittedKwargs({'define_variable', 'default'})
  396. def pkgconfig_method(self, args, kwargs):
  397. args = listify(args)
  398. if len(args) != 1:
  399. raise InterpreterException('get_pkgconfig_variable takes exactly one argument.')
  400. varname = args[0]
  401. if not isinstance(varname, str):
  402. raise InterpreterException('Variable name must be a string.')
  403. return self.held_object.get_pkgconfig_variable(varname, kwargs)
  404. @FeatureNew('dep.get_configtool_variable', '0.44.0')
  405. @permittedKwargs({})
  406. def configtool_method(self, args, kwargs):
  407. args = listify(args)
  408. if len(args) != 1:
  409. raise InterpreterException('get_configtool_variable takes exactly one argument.')
  410. varname = args[0]
  411. if not isinstance(varname, str):
  412. raise InterpreterException('Variable name must be a string.')
  413. return self.held_object.get_configtool_variable(varname)
  414. @FeatureNew('dep.partial_dependency', '0.46.0')
  415. @noPosargs
  416. @permittedKwargs(permitted_method_kwargs['partial_dependency'])
  417. def partial_dependency_method(self, args, kwargs):
  418. pdep = self.held_object.get_partial_dependency(**kwargs)
  419. return DependencyHolder(pdep, self.subproject)
  420. @FeatureNew('dep.get_variable', '0.51.0')
  421. @noPosargs
  422. @permittedKwargs({'cmake', 'pkgconfig', 'configtool', 'internal', 'default_value', 'pkgconfig_define'})
  423. @FeatureNewKwargs('dep.get_variable', '0.54.0', ['internal'])
  424. def variable_method(self, args, kwargs):
  425. return self.held_object.get_variable(**kwargs)
  426. @FeatureNew('dep.include_type', '0.52.0')
  427. @noPosargs
  428. @permittedKwargs({})
  429. def include_type_method(self, args, kwargs):
  430. return self.held_object.get_include_type()
  431. @FeatureNew('dep.as_system', '0.52.0')
  432. @permittedKwargs({})
  433. def as_system_method(self, args, kwargs):
  434. args = listify(args)
  435. new_is_system = 'system'
  436. if len(args) > 1:
  437. raise InterpreterException('as_system takes only one optional value')
  438. if len(args) == 1:
  439. new_is_system = args[0]
  440. new_dep = self.held_object.generate_system_dependency(new_is_system)
  441. return DependencyHolder(new_dep, self.subproject)
  442. class ExternalProgramHolder(InterpreterObject, ObjectHolder):
  443. def __init__(self, ep, subproject, backend=None):
  444. InterpreterObject.__init__(self)
  445. ObjectHolder.__init__(self, ep)
  446. self.subproject = subproject
  447. self.backend = backend
  448. self.methods.update({'found': self.found_method,
  449. 'path': self.path_method,
  450. 'full_path': self.full_path_method})
  451. self.cached_version = None
  452. @noPosargs
  453. @permittedKwargs({})
  454. def found_method(self, args, kwargs):
  455. return self.found()
  456. @noPosargs
  457. @permittedKwargs({})
  458. def path_method(self, args, kwargs):
  459. mlog.deprecation('path() method is deprecated and replaced by full_path()')
  460. return self._full_path()
  461. @noPosargs
  462. @permittedKwargs({})
  463. @FeatureNew('ExternalProgram.full_path', '0.55.0')
  464. def full_path_method(self, args, kwargs):
  465. return self._full_path()
  466. def _full_path(self):
  467. exe = self.held_object
  468. if isinstance(exe, build.Executable):
  469. return self.backend.get_target_filename_abs(exe)
  470. return exe.get_path()
  471. def found(self):
  472. return isinstance(self.held_object, build.Executable) or self.held_object.found()
  473. def get_command(self):
  474. return self.held_object.get_command()
  475. def get_name(self):
  476. exe = self.held_object
  477. if isinstance(exe, build.Executable):
  478. return exe.name
  479. return exe.get_name()
  480. def get_version(self, interpreter):
  481. if isinstance(self.held_object, build.Executable):
  482. return self.held_object.project_version
  483. if not self.cached_version:
  484. raw_cmd = self.get_command() + ['--version']
  485. cmd = [self, '--version']
  486. res = interpreter.run_command_impl(interpreter.current_node, cmd, {}, True)
  487. if res.returncode != 0:
  488. m = 'Running {!r} failed'
  489. raise InterpreterException(m.format(raw_cmd))
  490. output = res.stdout.strip()
  491. if not output:
  492. output = res.stderr.strip()
  493. match = re.search(r'([0-9][0-9\.]+)', output)
  494. if not match:
  495. m = 'Could not find a version number in output of {!r}'
  496. raise InterpreterException(m.format(raw_cmd))
  497. self.cached_version = match.group(1)
  498. return self.cached_version
  499. class ExternalLibraryHolder(InterpreterObject, ObjectHolder):
  500. def __init__(self, el, pv):
  501. InterpreterObject.__init__(self)
  502. ObjectHolder.__init__(self, el, pv)
  503. self.methods.update({'found': self.found_method,
  504. 'type_name': self.type_name_method,
  505. 'partial_dependency': self.partial_dependency_method,
  506. })
  507. def found(self):
  508. return self.held_object.found()
  509. @noPosargs
  510. @permittedKwargs({})
  511. def type_name_method(self, args, kwargs):
  512. return self.held_object.type_name
  513. @noPosargs
  514. @permittedKwargs({})
  515. def found_method(self, args, kwargs):
  516. return self.found()
  517. def get_name(self):
  518. return self.held_object.name
  519. def get_compile_args(self):
  520. return self.held_object.get_compile_args()
  521. def get_link_args(self):
  522. return self.held_object.get_link_args()
  523. def get_exe_args(self):
  524. return self.held_object.get_exe_args()
  525. @FeatureNew('dep.partial_dependency', '0.46.0')
  526. @noPosargs
  527. @permittedKwargs(permitted_method_kwargs['partial_dependency'])
  528. def partial_dependency_method(self, args, kwargs):
  529. pdep = self.held_object.get_partial_dependency(**kwargs)
  530. return DependencyHolder(pdep, self.subproject)
  531. class GeneratorHolder(InterpreterObject, ObjectHolder):
  532. @FeatureNewKwargs('generator', '0.43.0', ['capture'])
  533. def __init__(self, interp, args, kwargs):
  534. self.interpreter = interp
  535. InterpreterObject.__init__(self)
  536. ObjectHolder.__init__(self, build.Generator(args, kwargs), interp.subproject)
  537. self.methods.update({'process': self.process_method})
  538. @FeatureNewKwargs('generator.process', '0.45.0', ['preserve_path_from'])
  539. @permittedKwargs({'extra_args', 'preserve_path_from'})
  540. def process_method(self, args, kwargs):
  541. extras = mesonlib.stringlistify(kwargs.get('extra_args', []))
  542. if 'preserve_path_from' in kwargs:
  543. preserve_path_from = kwargs['preserve_path_from']
  544. if not isinstance(preserve_path_from, str):
  545. raise InvalidArguments('Preserve_path_from must be a string.')
  546. preserve_path_from = os.path.normpath(preserve_path_from)
  547. if not os.path.isabs(preserve_path_from):
  548. # This is a bit of a hack. Fix properly before merging.
  549. raise InvalidArguments('Preserve_path_from must be an absolute path for now. Sorry.')
  550. else:
  551. preserve_path_from = None
  552. gl = self.held_object.process_files('Generator', args, self.interpreter,
  553. preserve_path_from, extra_args=extras)
  554. return GeneratedListHolder(gl)
  555. class GeneratedListHolder(InterpreterObject, ObjectHolder):
  556. def __init__(self, arg1, extra_args=None):
  557. InterpreterObject.__init__(self)
  558. if isinstance(arg1, GeneratorHolder):
  559. ObjectHolder.__init__(self, build.GeneratedList(arg1.held_object, extra_args if extra_args is not None else []))
  560. else:
  561. ObjectHolder.__init__(self, arg1)
  562. def __repr__(self):
  563. r = '<{}: {!r}>'
  564. return r.format(self.__class__.__name__, self.held_object.get_outputs())
  565. def add_file(self, a):
  566. self.held_object.add_file(a)
  567. # A machine that's statically known from the cross file
  568. class MachineHolder(InterpreterObject, ObjectHolder):
  569. def __init__(self, machine_info):
  570. InterpreterObject.__init__(self)
  571. ObjectHolder.__init__(self, machine_info)
  572. self.methods.update({'system': self.system_method,
  573. 'cpu': self.cpu_method,
  574. 'cpu_family': self.cpu_family_method,
  575. 'endian': self.endian_method,
  576. })
  577. @noPosargs
  578. @permittedKwargs({})
  579. def cpu_family_method(self, args, kwargs):
  580. return self.held_object.cpu_family
  581. @noPosargs
  582. @permittedKwargs({})
  583. def cpu_method(self, args, kwargs):
  584. return self.held_object.cpu
  585. @noPosargs
  586. @permittedKwargs({})
  587. def system_method(self, args, kwargs):
  588. return self.held_object.system
  589. @noPosargs
  590. @permittedKwargs({})
  591. def endian_method(self, args, kwargs):
  592. return self.held_object.endian
  593. class IncludeDirsHolder(InterpreterObject, ObjectHolder):
  594. def __init__(self, idobj):
  595. InterpreterObject.__init__(self)
  596. ObjectHolder.__init__(self, idobj)
  597. class Headers(InterpreterObject):
  598. def __init__(self, sources, kwargs):
  599. InterpreterObject.__init__(self)
  600. self.sources = sources
  601. self.install_subdir = kwargs.get('subdir', '')
  602. if os.path.isabs(self.install_subdir):
  603. mlog.deprecation('Subdir keyword must not be an absolute path. This will be a hard error in the next release.')
  604. self.custom_install_dir = kwargs.get('install_dir', None)
  605. self.custom_install_mode = kwargs.get('install_mode', None)
  606. if self.custom_install_dir is not None:
  607. if not isinstance(self.custom_install_dir, str):
  608. raise InterpreterException('Custom_install_dir must be a string.')
  609. def set_install_subdir(self, subdir):
  610. self.install_subdir = subdir
  611. def get_install_subdir(self):
  612. return self.install_subdir
  613. def get_sources(self):
  614. return self.sources
  615. def get_custom_install_dir(self):
  616. return self.custom_install_dir
  617. def get_custom_install_mode(self):
  618. return self.custom_install_mode
  619. class DataHolder(InterpreterObject, ObjectHolder):
  620. def __init__(self, data):
  621. InterpreterObject.__init__(self)
  622. ObjectHolder.__init__(self, data)
  623. def get_source_subdir(self):
  624. return self.held_object.source_subdir
  625. def get_sources(self):
  626. return self.held_object.sources
  627. def get_install_dir(self):
  628. return self.held_object.install_dir
  629. class InstallDir(InterpreterObject):
  630. def __init__(self, src_subdir, inst_subdir, install_dir, install_mode, exclude, strip_directory):
  631. InterpreterObject.__init__(self)
  632. self.source_subdir = src_subdir
  633. self.installable_subdir = inst_subdir
  634. self.install_dir = install_dir
  635. self.install_mode = install_mode
  636. self.exclude = exclude
  637. self.strip_directory = strip_directory
  638. class Man(InterpreterObject):
  639. def __init__(self, sources, kwargs):
  640. InterpreterObject.__init__(self)
  641. self.sources = sources
  642. self.validate_sources()
  643. self.custom_install_dir = kwargs.get('install_dir', None)
  644. self.custom_install_mode = kwargs.get('install_mode', None)
  645. if self.custom_install_dir is not None and not isinstance(self.custom_install_dir, str):
  646. raise InterpreterException('Custom_install_dir must be a string.')
  647. def validate_sources(self):
  648. for s in self.sources:
  649. try:
  650. num = int(s.split('.')[-1])
  651. except (IndexError, ValueError):
  652. num = 0
  653. if num < 1 or num > 8:
  654. raise InvalidArguments('Man file must have a file extension of a number between 1 and 8')
  655. def get_custom_install_dir(self):
  656. return self.custom_install_dir
  657. def get_custom_install_mode(self):
  658. return self.custom_install_mode
  659. def get_sources(self):
  660. return self.sources
  661. class GeneratedObjectsHolder(InterpreterObject, ObjectHolder):
  662. def __init__(self, held_object):
  663. InterpreterObject.__init__(self)
  664. ObjectHolder.__init__(self, held_object)
  665. class TargetHolder(InterpreterObject, ObjectHolder):
  666. def __init__(self, target, interp):
  667. InterpreterObject.__init__(self)
  668. ObjectHolder.__init__(self, target, interp.subproject)
  669. self.interpreter = interp
  670. class BuildTargetHolder(TargetHolder):
  671. def __init__(self, target, interp):
  672. super().__init__(target, interp)
  673. self.methods.update({'extract_objects': self.extract_objects_method,
  674. 'extract_all_objects': self.extract_all_objects_method,
  675. 'name': self.name_method,
  676. 'get_id': self.get_id_method,
  677. 'outdir': self.outdir_method,
  678. 'full_path': self.full_path_method,
  679. 'private_dir_include': self.private_dir_include_method,
  680. })
  681. def __repr__(self):
  682. r = '<{} {}: {}>'
  683. h = self.held_object
  684. return r.format(self.__class__.__name__, h.get_id(), h.filename)
  685. def is_cross(self):
  686. return not self.held_object.environment.machines.matches_build_machine(self.held_object.for_machine)
  687. @noPosargs
  688. @permittedKwargs({})
  689. def private_dir_include_method(self, args, kwargs):
  690. return IncludeDirsHolder(build.IncludeDirs('', [], False,
  691. [self.interpreter.backend.get_target_private_dir(self.held_object)]))
  692. @noPosargs
  693. @permittedKwargs({})
  694. def full_path_method(self, args, kwargs):
  695. return self.interpreter.backend.get_target_filename_abs(self.held_object)
  696. @noPosargs
  697. @permittedKwargs({})
  698. def outdir_method(self, args, kwargs):
  699. return self.interpreter.backend.get_target_dir(self.held_object)
  700. @permittedKwargs({})
  701. def extract_objects_method(self, args, kwargs):
  702. gobjs = self.held_object.extract_objects(args)
  703. return GeneratedObjectsHolder(gobjs)
  704. @FeatureNewKwargs('extract_all_objects', '0.46.0', ['recursive'])
  705. @noPosargs
  706. @permittedKwargs({'recursive'})
  707. def extract_all_objects_method(self, args, kwargs):
  708. recursive = kwargs.get('recursive', False)
  709. gobjs = self.held_object.extract_all_objects(recursive)
  710. if gobjs.objlist and 'recursive' not in kwargs:
  711. mlog.warning('extract_all_objects called without setting recursive '
  712. 'keyword argument. Meson currently defaults to '
  713. 'non-recursive to maintain backward compatibility but '
  714. 'the default will be changed in the future.',
  715. location=self.current_node)
  716. return GeneratedObjectsHolder(gobjs)
  717. @noPosargs
  718. @permittedKwargs({})
  719. def get_id_method(self, args, kwargs):
  720. return self.held_object.get_id()
  721. @FeatureNew('name', '0.54.0')
  722. @noPosargs
  723. @permittedKwargs({})
  724. def name_method(self, args, kwargs):
  725. return self.held_object.name
  726. class ExecutableHolder(BuildTargetHolder):
  727. def __init__(self, target, interp):
  728. super().__init__(target, interp)
  729. class StaticLibraryHolder(BuildTargetHolder):
  730. def __init__(self, target, interp):
  731. super().__init__(target, interp)
  732. class SharedLibraryHolder(BuildTargetHolder):
  733. def __init__(self, target, interp):
  734. super().__init__(target, interp)
  735. # Set to True only when called from self.func_shared_lib().
  736. target.shared_library_only = False
  737. class BothLibrariesHolder(BuildTargetHolder):
  738. def __init__(self, shared_holder, static_holder, interp):
  739. # FIXME: This build target always represents the shared library, but
  740. # that should be configurable.
  741. super().__init__(shared_holder.held_object, interp)
  742. self.shared_holder = shared_holder
  743. self.static_holder = static_holder
  744. self.methods.update({'get_shared_lib': self.get_shared_lib_method,
  745. 'get_static_lib': self.get_static_lib_method,
  746. })
  747. def __repr__(self):
  748. r = '<{} {}: {}, {}: {}>'
  749. h1 = self.shared_holder.held_object
  750. h2 = self.static_holder.held_object
  751. return r.format(self.__class__.__name__, h1.get_id(), h1.filename, h2.get_id(), h2.filename)
  752. @noPosargs
  753. @permittedKwargs({})
  754. def get_shared_lib_method(self, args, kwargs):
  755. return self.shared_holder
  756. @noPosargs
  757. @permittedKwargs({})
  758. def get_static_lib_method(self, args, kwargs):
  759. return self.static_holder
  760. class SharedModuleHolder(BuildTargetHolder):
  761. def __init__(self, target, interp):
  762. super().__init__(target, interp)
  763. class JarHolder(BuildTargetHolder):
  764. def __init__(self, target, interp):
  765. super().__init__(target, interp)
  766. class CustomTargetIndexHolder(TargetHolder):
  767. def __init__(self, target, interp):
  768. super().__init__(target, interp)
  769. self.methods.update({'full_path': self.full_path_method,
  770. })
  771. @FeatureNew('custom_target[i].full_path', '0.54.0')
  772. @noPosargs
  773. @permittedKwargs({})
  774. def full_path_method(self, args, kwargs):
  775. return self.interpreter.backend.get_target_filename_abs(self.held_object)
  776. class CustomTargetHolder(TargetHolder):
  777. def __init__(self, target, interp):
  778. super().__init__(target, interp)
  779. self.methods.update({'full_path': self.full_path_method,
  780. 'to_list': self.to_list_method,
  781. })
  782. def __repr__(self):
  783. r = '<{} {}: {}>'
  784. h = self.held_object
  785. return r.format(self.__class__.__name__, h.get_id(), h.command)
  786. @noPosargs
  787. @permittedKwargs({})
  788. def full_path_method(self, args, kwargs):
  789. return self.interpreter.backend.get_target_filename_abs(self.held_object)
  790. @FeatureNew('custom_target.to_list', '0.54.0')
  791. @noPosargs
  792. @permittedKwargs({})
  793. def to_list_method(self, args, kwargs):
  794. result = []
  795. for i in self.held_object:
  796. result.append(CustomTargetIndexHolder(i, self.interpreter))
  797. return result
  798. def __getitem__(self, index):
  799. return CustomTargetIndexHolder(self.held_object[index], self.interpreter)
  800. def __setitem__(self, index, value): # lgtm[py/unexpected-raise-in-special-method]
  801. raise InterpreterException('Cannot set a member of a CustomTarget')
  802. def __delitem__(self, index): # lgtm[py/unexpected-raise-in-special-method]
  803. raise InterpreterException('Cannot delete a member of a CustomTarget')
  804. def outdir_include(self):
  805. return IncludeDirsHolder(build.IncludeDirs('', [], False,
  806. [os.path.join('@BUILD_ROOT@', self.interpreter.backend.get_target_dir(self.held_object))]))
  807. class RunTargetHolder(TargetHolder):
  808. def __init__(self, target, interp):
  809. super().__init__(target, interp)
  810. def __repr__(self):
  811. r = '<{} {}: {}>'
  812. h = self.held_object
  813. return r.format(self.__class__.__name__, h.get_id(), h.command)
  814. class Test(InterpreterObject):
  815. def __init__(self, name: str, project: str, suite: T.List[str], exe: build.Executable,
  816. depends: T.List[T.Union[build.CustomTarget, build.BuildTarget]],
  817. is_parallel: bool, cmd_args: T.List[str], env: build.EnvironmentVariables,
  818. should_fail: bool, timeout: int, workdir: T.Optional[str], protocol: str,
  819. priority: int):
  820. InterpreterObject.__init__(self)
  821. self.name = name
  822. self.suite = suite
  823. self.project_name = project
  824. self.exe = exe
  825. self.depends = depends
  826. self.is_parallel = is_parallel
  827. self.cmd_args = cmd_args
  828. self.env = env
  829. self.should_fail = should_fail
  830. self.timeout = timeout
  831. self.workdir = workdir
  832. self.protocol = TestProtocol.from_str(protocol)
  833. self.priority = priority
  834. def get_exe(self):
  835. return self.exe
  836. def get_name(self):
  837. return self.name
  838. class SubprojectHolder(InterpreterObject, ObjectHolder):
  839. def __init__(self, subinterpreter, subproject_dir, name, warnings=0, disabled_feature=None,
  840. exception=None):
  841. InterpreterObject.__init__(self)
  842. ObjectHolder.__init__(self, subinterpreter)
  843. self.name = name
  844. self.warnings = warnings
  845. self.disabled_feature = disabled_feature
  846. self.exception = exception
  847. self.subproject_dir = subproject_dir
  848. self.methods.update({'get_variable': self.get_variable_method,
  849. 'found': self.found_method,
  850. })
  851. @noPosargs
  852. @permittedKwargs({})
  853. def found_method(self, args, kwargs):
  854. return self.found()
  855. def found(self):
  856. return self.held_object is not None
  857. @permittedKwargs({})
  858. @noArgsFlattening
  859. def get_variable_method(self, args, kwargs):
  860. if len(args) < 1 or len(args) > 2:
  861. raise InterpreterException('Get_variable takes one or two arguments.')
  862. if not self.found():
  863. raise InterpreterException('Subproject "%s/%s" disabled can\'t get_variable on it.' % (
  864. self.subproject_dir, self.name))
  865. varname = args[0]
  866. if not isinstance(varname, str):
  867. raise InterpreterException('Get_variable first argument must be a string.')
  868. try:
  869. return self.held_object.variables[varname]
  870. except KeyError:
  871. pass
  872. if len(args) == 2:
  873. return args[1]
  874. raise InvalidArguments('Requested variable "{0}" not found.'.format(varname))
  875. header_permitted_kwargs = set([
  876. 'required',
  877. 'prefix',
  878. 'no_builtin_args',
  879. 'include_directories',
  880. 'args',
  881. 'dependencies',
  882. ])
  883. find_library_permitted_kwargs = set([
  884. 'has_headers',
  885. 'required',
  886. 'dirs',
  887. 'static',
  888. ])
  889. find_library_permitted_kwargs |= set(['header_' + k for k in header_permitted_kwargs])
  890. class CompilerHolder(InterpreterObject):
  891. def __init__(self, compiler, env, subproject):
  892. InterpreterObject.__init__(self)
  893. self.compiler = compiler
  894. self.environment = env
  895. self.subproject = subproject
  896. self.methods.update({'compiles': self.compiles_method,
  897. 'links': self.links_method,
  898. 'get_id': self.get_id_method,
  899. 'get_linker_id': self.get_linker_id_method,
  900. 'compute_int': self.compute_int_method,
  901. 'sizeof': self.sizeof_method,
  902. 'get_define': self.get_define_method,
  903. 'check_header': self.check_header_method,
  904. 'has_header': self.has_header_method,
  905. 'has_header_symbol': self.has_header_symbol_method,
  906. 'run': self.run_method,
  907. 'has_function': self.has_function_method,
  908. 'has_member': self.has_member_method,
  909. 'has_members': self.has_members_method,
  910. 'has_type': self.has_type_method,
  911. 'alignment': self.alignment_method,
  912. 'version': self.version_method,
  913. 'cmd_array': self.cmd_array_method,
  914. 'find_library': self.find_library_method,
  915. 'has_argument': self.has_argument_method,
  916. 'has_function_attribute': self.has_func_attribute_method,
  917. 'get_supported_function_attributes': self.get_supported_function_attributes_method,
  918. 'has_multi_arguments': self.has_multi_arguments_method,
  919. 'get_supported_arguments': self.get_supported_arguments_method,
  920. 'first_supported_argument': self.first_supported_argument_method,
  921. 'has_link_argument': self.has_link_argument_method,
  922. 'has_multi_link_arguments': self.has_multi_link_arguments_method,
  923. 'get_supported_link_arguments': self.get_supported_link_arguments_method,
  924. 'first_supported_link_argument': self.first_supported_link_argument_method,
  925. 'unittest_args': self.unittest_args_method,
  926. 'symbols_have_underscore_prefix': self.symbols_have_underscore_prefix_method,
  927. 'get_argument_syntax': self.get_argument_syntax_method,
  928. })
  929. def _dep_msg(self, deps, endl):
  930. msg_single = 'with dependency {}'
  931. msg_many = 'with dependencies {}'
  932. if not deps:
  933. return endl
  934. if endl is None:
  935. endl = ''
  936. tpl = msg_many if len(deps) > 1 else msg_single
  937. names = []
  938. for d in deps:
  939. if isinstance(d, dependencies.ExternalLibrary):
  940. name = '-l' + d.name
  941. else:
  942. name = d.name
  943. names.append(name)
  944. return tpl.format(', '.join(names)) + endl
  945. @noPosargs
  946. @permittedKwargs({})
  947. def version_method(self, args, kwargs):
  948. return self.compiler.version
  949. @noPosargs
  950. @permittedKwargs({})
  951. def cmd_array_method(self, args, kwargs):
  952. return self.compiler.exelist
  953. def determine_args(self, kwargs, mode='link'):
  954. nobuiltins = kwargs.get('no_builtin_args', False)
  955. if not isinstance(nobuiltins, bool):
  956. raise InterpreterException('Type of no_builtin_args not a boolean.')
  957. args = []
  958. incdirs = extract_as_list(kwargs, 'include_directories')
  959. for i in incdirs:
  960. if not isinstance(i, IncludeDirsHolder):
  961. raise InterpreterException('Include directories argument must be an include_directories object.')
  962. for idir in i.held_object.get_incdirs():
  963. idir = os.path.join(self.environment.get_source_dir(),
  964. i.held_object.get_curdir(), idir)
  965. args += self.compiler.get_include_args(idir, False)
  966. if not nobuiltins:
  967. for_machine = Interpreter.machine_from_native_kwarg(kwargs)
  968. opts = self.environment.coredata.compiler_options[for_machine][self.compiler.language]
  969. args += self.compiler.get_option_compile_args(opts)
  970. if mode == 'link':
  971. args += self.compiler.get_option_link_args(opts)
  972. args += mesonlib.stringlistify(kwargs.get('args', []))
  973. return args
  974. def determine_dependencies(self, kwargs, endl=':'):
  975. deps = kwargs.get('dependencies', None)
  976. if deps is not None:
  977. deps = listify(deps)
  978. final_deps = []
  979. for d in deps:
  980. try:
  981. d = d.held_object
  982. except Exception:
  983. pass
  984. if isinstance(d, InternalDependency) or not isinstance(d, Dependency):
  985. raise InterpreterException('Dependencies must be external dependencies')
  986. final_deps.append(d)
  987. deps = final_deps
  988. return deps, self._dep_msg(deps, endl)
  989. @permittedKwargs({
  990. 'prefix',
  991. 'args',
  992. 'dependencies',
  993. })
  994. def alignment_method(self, args, kwargs):
  995. if len(args) != 1:
  996. raise InterpreterException('Alignment method takes exactly one positional argument.')
  997. check_stringlist(args)
  998. typename = args[0]
  999. prefix = kwargs.get('prefix', '')
  1000. if not isinstance(prefix, str):
  1001. raise InterpreterException('Prefix argument of alignment must be a string.')
  1002. extra_args = mesonlib.stringlistify(kwargs.get('args', []))
  1003. deps, msg = self.determine_dependencies(kwargs)
  1004. result = self.compiler.alignment(typename, prefix, self.environment,
  1005. extra_args=extra_args,
  1006. dependencies=deps)
  1007. mlog.log('Checking for alignment of', mlog.bold(typename, True), msg, result)
  1008. return result
  1009. @permittedKwargs({
  1010. 'name',
  1011. 'no_builtin_args',
  1012. 'include_directories',
  1013. 'args',
  1014. 'dependencies',
  1015. })
  1016. def run_method(self, args, kwargs):
  1017. if len(args) != 1:
  1018. raise InterpreterException('Run method takes exactly one positional argument.')
  1019. code = args[0]
  1020. if isinstance(code, mesonlib.File):
  1021. code = mesonlib.File.from_absolute_file(
  1022. code.rel_to_builddir(self.environment.source_dir))
  1023. elif not isinstance(code, str):
  1024. raise InvalidArguments('Argument must be string or file.')
  1025. testname = kwargs.get('name', '')
  1026. if not isinstance(testname, str):
  1027. raise InterpreterException('Testname argument must be a string.')
  1028. extra_args = functools.partial(self.determine_args, kwargs)
  1029. deps, msg = self.determine_dependencies(kwargs, endl=None)
  1030. result = self.compiler.run(code, self.environment, extra_args=extra_args,
  1031. dependencies=deps)
  1032. if len(testname) > 0:
  1033. if not result.compiled:
  1034. h = mlog.red('DID NOT COMPILE')
  1035. elif result.returncode == 0:
  1036. h = mlog.green('YES')
  1037. else:
  1038. h = mlog.red('NO (%d)' % result.returncode)
  1039. mlog.log('Checking if', mlog.bold(testname, True), msg, 'runs:', h)
  1040. return TryRunResultHolder(result)
  1041. @noPosargs
  1042. @permittedKwargs({})
  1043. def get_id_method(self, args, kwargs):
  1044. return self.compiler.get_id()
  1045. @noPosargs
  1046. @permittedKwargs({})
  1047. @FeatureNew('compiler.get_linker_id', '0.53.0')
  1048. def get_linker_id_method(self, args, kwargs):
  1049. return self.compiler.get_linker_id()
  1050. @noPosargs
  1051. @permittedKwargs({})
  1052. def symbols_have_underscore_prefix_method(self, args, kwargs):
  1053. '''
  1054. Check if the compiler prefixes _ (underscore) to global C symbols
  1055. See: https://en.wikipedia.org/wiki/Name_mangling#C
  1056. '''
  1057. return self.compiler.symbols_have_underscore_prefix(self.environment)
  1058. @noPosargs
  1059. @permittedKwargs({})
  1060. def unittest_args_method(self, args, kwargs):
  1061. '''
  1062. This function is deprecated and should not be used.
  1063. It can be removed in a future version of Meson.
  1064. '''
  1065. if not hasattr(self.compiler, 'get_feature_args'):
  1066. raise InterpreterException('This {} compiler has no feature arguments.'.format(self.compiler.get_display_language()))
  1067. build_to_src = os.path.relpath(self.environment.get_source_dir(), self.environment.get_build_dir())
  1068. return self.compiler.get_feature_args({'unittest': 'true'}, build_to_src)
  1069. @permittedKwargs({
  1070. 'prefix',
  1071. 'no_builtin_args',
  1072. 'include_directories',
  1073. 'args',
  1074. 'dependencies',
  1075. })
  1076. def has_member_method(self, args, kwargs):
  1077. if len(args) != 2:
  1078. raise InterpreterException('Has_member takes exactly two arguments.')
  1079. check_stringlist(args)
  1080. typename, membername = args
  1081. prefix = kwargs.get('prefix', '')
  1082. if not isinstance(prefix, str):
  1083. raise InterpreterException('Prefix argument of has_member must be a string.')
  1084. extra_args = functools.partial(self.determine_args, kwargs)
  1085. deps, msg = self.determine_dependencies(kwargs)
  1086. had, cached = self.compiler.has_members(typename, [membername], prefix,
  1087. self.environment,
  1088. extra_args=extra_args,
  1089. dependencies=deps)
  1090. cached = mlog.blue('(cached)') if cached else ''
  1091. if had:
  1092. hadtxt = mlog.green('YES')
  1093. else:
  1094. hadtxt = mlog.red('NO')
  1095. mlog.log('Checking whether type', mlog.bold(typename, True),
  1096. 'has member', mlog.bold(membername, True), msg, hadtxt, cached)
  1097. return had
  1098. @permittedKwargs({
  1099. 'prefix',
  1100. 'no_builtin_args',
  1101. 'include_directories',
  1102. 'args',
  1103. 'dependencies',
  1104. })
  1105. def has_members_method(self, args, kwargs):
  1106. if len(args) < 2:
  1107. raise InterpreterException('Has_members needs at least two arguments.')
  1108. check_stringlist(args)
  1109. typename, *membernames = args
  1110. prefix = kwargs.get('prefix', '')
  1111. if not isinstance(prefix, str):
  1112. raise InterpreterException('Prefix argument of has_members must be a string.')
  1113. extra_args = functools.partial(self.determine_args, kwargs)
  1114. deps, msg = self.determine_dependencies(kwargs)
  1115. had, cached = self.compiler.has_members(typename, membernames, prefix,
  1116. self.environment,
  1117. extra_args=extra_args,
  1118. dependencies=deps)
  1119. cached = mlog.blue('(cached)') if cached else ''
  1120. if had:
  1121. hadtxt = mlog.green('YES')
  1122. else:
  1123. hadtxt = mlog.red('NO')
  1124. members = mlog.bold(', '.join(['"{}"'.format(m) for m in membernames]))
  1125. mlog.log('Checking whether type', mlog.bold(typename, True),
  1126. 'has members', members, msg, hadtxt, cached)
  1127. return had
  1128. @permittedKwargs({
  1129. 'prefix',
  1130. 'no_builtin_args',
  1131. 'include_directories',
  1132. 'args',
  1133. 'dependencies',
  1134. })
  1135. def has_function_method(self, args, kwargs):
  1136. if len(args) != 1:
  1137. raise InterpreterException('Has_function takes exactly one argument.')
  1138. check_stringlist(args)
  1139. funcname = args[0]
  1140. prefix = kwargs.get('prefix', '')
  1141. if not isinstance(prefix, str):
  1142. raise InterpreterException('Prefix argument of has_function must be a string.')
  1143. extra_args = self.determine_args(kwargs)
  1144. deps, msg = self.determine_dependencies(kwargs)
  1145. had, cached = self.compiler.has_function(funcname, prefix, self.environment,
  1146. extra_args=extra_args,
  1147. dependencies=deps)
  1148. cached = mlog.blue('(cached)') if cached else ''
  1149. if had:
  1150. hadtxt = mlog.green('YES')
  1151. else:
  1152. hadtxt = mlog.red('NO')
  1153. mlog.log('Checking for function', mlog.bold(funcname, True), msg, hadtxt, cached)
  1154. return had
  1155. @permittedKwargs({
  1156. 'prefix',
  1157. 'no_builtin_args',
  1158. 'include_directories',
  1159. 'args',
  1160. 'dependencies',
  1161. })
  1162. def has_type_method(self, args, kwargs):
  1163. if len(args) != 1:
  1164. raise InterpreterException('Has_type takes exactly one argument.')
  1165. check_stringlist(args)
  1166. typename = args[0]
  1167. prefix = kwargs.get('prefix', '')
  1168. if not isinstance(prefix, str):
  1169. raise InterpreterException('Prefix argument of has_type must be a string.')
  1170. extra_args = functools.partial(self.determine_args, kwargs)
  1171. deps, msg = self.determine_dependencies(kwargs)
  1172. had, cached = self.compiler.has_type(typename, prefix, self.environment,
  1173. extra_args=extra_args, dependencies=deps)
  1174. cached = mlog.blue('(cached)') if cached else ''
  1175. if had:
  1176. hadtxt = mlog.green('YES')
  1177. else:
  1178. hadtxt = mlog.red('NO')
  1179. mlog.log('Checking for type', mlog.bold(typename, True), msg, hadtxt, cached)
  1180. return had
  1181. @FeatureNew('compiler.compute_int', '0.40.0')
  1182. @permittedKwargs({
  1183. 'prefix',
  1184. 'low',
  1185. 'high',
  1186. 'guess',
  1187. 'no_builtin_args',
  1188. 'include_directories',
  1189. 'args',
  1190. 'dependencies',
  1191. })
  1192. def compute_int_method(self, args, kwargs):
  1193. if len(args) != 1:
  1194. raise InterpreterException('Compute_int takes exactly one argument.')
  1195. check_stringlist(args)
  1196. expression = args[0]
  1197. prefix = kwargs.get('prefix', '')
  1198. low = kwargs.get('low', None)
  1199. high = kwargs.get('high', None)
  1200. guess = kwargs.get('guess', None)
  1201. if not isinstance(prefix, str):
  1202. raise InterpreterException('Prefix argument of compute_int must be a string.')
  1203. if low is not None and not isinstance(low, int):
  1204. raise InterpreterException('Low argument of compute_int must be an int.')
  1205. if high is not None and not isinstance(high, int):
  1206. raise InterpreterException('High argument of compute_int must be an int.')
  1207. if guess is not None and not isinstance(guess, int):
  1208. raise InterpreterException('Guess argument of compute_int must be an int.')
  1209. extra_args = functools.partial(self.determine_args, kwargs)
  1210. deps, msg = self.determine_dependencies(kwargs)
  1211. res = self.compiler.compute_int(expression, low, high, guess, prefix,
  1212. self.environment, extra_args=extra_args,
  1213. dependencies=deps)
  1214. mlog.log('Computing int of', mlog.bold(expression, True), msg, res)
  1215. return res
  1216. @permittedKwargs({
  1217. 'prefix',
  1218. 'no_builtin_args',
  1219. 'include_directories',
  1220. 'args',
  1221. 'dependencies',
  1222. })
  1223. def sizeof_method(self, args, kwargs):
  1224. if len(args) != 1:
  1225. raise InterpreterException('Sizeof takes exactly one argument.')
  1226. check_stringlist(args)
  1227. element = args[0]
  1228. prefix = kwargs.get('prefix', '')
  1229. if not isinstance(prefix, str):
  1230. raise InterpreterException('Prefix argument of sizeof must be a string.')
  1231. extra_args = functools.partial(self.determine_args, kwargs)
  1232. deps, msg = self.determine_dependencies(kwargs)
  1233. esize = self.compiler.sizeof(element, prefix, self.environment,
  1234. extra_args=extra_args, dependencies=deps)
  1235. mlog.log('Checking for size of', mlog.bold(element, True), msg, esize)
  1236. return esize
  1237. @FeatureNew('compiler.get_define', '0.40.0')
  1238. @permittedKwargs({
  1239. 'prefix',
  1240. 'no_builtin_args',
  1241. 'include_directories',
  1242. 'args',
  1243. 'dependencies',
  1244. })
  1245. def get_define_method(self, args, kwargs):
  1246. if len(args) != 1:
  1247. raise InterpreterException('get_define() takes exactly one argument.')
  1248. check_stringlist(args)
  1249. element = args[0]
  1250. prefix = kwargs.get('prefix', '')
  1251. if not isinstance(prefix, str):
  1252. raise InterpreterException('Prefix argument of get_define() must be a string.')
  1253. extra_args = functools.partial(self.determine_args, kwargs)
  1254. deps, msg = self.determine_dependencies(kwargs)
  1255. value, cached = self.compiler.get_define(element, prefix, self.environment,
  1256. extra_args=extra_args,
  1257. dependencies=deps)
  1258. cached = mlog.blue('(cached)') if cached else ''
  1259. mlog.log('Fetching value of define', mlog.bold(element, True), msg, value, cached)
  1260. return value
  1261. @permittedKwargs({
  1262. 'name',
  1263. 'no_builtin_args',
  1264. 'include_directories',
  1265. 'args',
  1266. 'dependencies',
  1267. })
  1268. def compiles_method(self, args, kwargs):
  1269. if len(args) != 1:
  1270. raise InterpreterException('compiles method takes exactly one argument.')
  1271. code = args[0]
  1272. if isinstance(code, mesonlib.File):
  1273. code = mesonlib.File.from_absolute_file(
  1274. code.rel_to_builddir(self.environment.source_dir))
  1275. elif not isinstance(code, str):
  1276. raise InvalidArguments('Argument must be string or file.')
  1277. testname = kwargs.get('name', '')
  1278. if not isinstance(testname, str):
  1279. raise InterpreterException('Testname argument must be a string.')
  1280. extra_args = functools.partial(self.determine_args, kwargs)
  1281. deps, msg = self.determine_dependencies(kwargs, endl=None)
  1282. result, cached = self.compiler.compiles(code, self.environment,
  1283. extra_args=extra_args,
  1284. dependencies=deps)
  1285. if len(testname) > 0:
  1286. if result:
  1287. h = mlog.green('YES')
  1288. else:
  1289. h = mlog.red('NO')
  1290. cached = mlog.blue('(cached)') if cached else ''
  1291. mlog.log('Checking if', mlog.bold(testname, True), msg, 'compiles:', h, cached)
  1292. return result
  1293. @permittedKwargs({
  1294. 'name',
  1295. 'no_builtin_args',
  1296. 'include_directories',
  1297. 'args',
  1298. 'dependencies',
  1299. })
  1300. def links_method(self, args, kwargs):
  1301. if len(args) != 1:
  1302. raise InterpreterException('links method takes exactly one argument.')
  1303. code = args[0]
  1304. if isinstance(code, mesonlib.File):
  1305. code = mesonlib.File.from_absolute_file(
  1306. code.rel_to_builddir(self.environment.source_dir))
  1307. elif not isinstance(code, str):
  1308. raise InvalidArguments('Argument must be string or file.')
  1309. testname = kwargs.get('name', '')
  1310. if not isinstance(testname, str):
  1311. raise InterpreterException('Testname argument must be a string.')
  1312. extra_args = functools.partial(self.determine_args, kwargs)
  1313. deps, msg = self.determine_dependencies(kwargs, endl=None)
  1314. result, cached = self.compiler.links(code, self.environment,
  1315. extra_args=extra_args,
  1316. dependencies=deps)
  1317. cached = mlog.blue('(cached)') if cached else ''
  1318. if len(testname) > 0:
  1319. if result:
  1320. h = mlog.green('YES')
  1321. else:
  1322. h = mlog.red('NO')
  1323. mlog.log('Checking if', mlog.bold(testname, True), msg, 'links:', h, cached)
  1324. return result
  1325. @FeatureNew('compiler.check_header', '0.47.0')
  1326. @FeatureNewKwargs('compiler.check_header', '0.50.0', ['required'])
  1327. @permittedKwargs(header_permitted_kwargs)
  1328. def check_header_method(self, args, kwargs):
  1329. if len(args) != 1:
  1330. raise InterpreterException('check_header method takes exactly one argument.')
  1331. check_stringlist(args)
  1332. hname = args[0]
  1333. prefix = kwargs.get('prefix', '')
  1334. if not isinstance(prefix, str):
  1335. raise InterpreterException('Prefix argument of has_header must be a string.')
  1336. disabled, required, feature = extract_required_kwarg(kwargs, self.subproject, default=False)
  1337. if disabled:
  1338. mlog.log('Check usable header', mlog.bold(hname, True), 'skipped: feature', mlog.bold(feature), 'disabled')
  1339. return False
  1340. extra_args = functools.partial(self.determine_args, kwargs)
  1341. deps, msg = self.determine_dependencies(kwargs)
  1342. haz, cached = self.compiler.check_header(hname, prefix, self.environment,
  1343. extra_args=extra_args,
  1344. dependencies=deps)
  1345. cached = mlog.blue('(cached)') if cached else ''
  1346. if required and not haz:
  1347. raise InterpreterException('{} header {!r} not usable'.format(self.compiler.get_display_language(), hname))
  1348. elif haz:
  1349. h = mlog.green('YES')
  1350. else:
  1351. h = mlog.red('NO')
  1352. mlog.log('Check usable header', mlog.bold(hname, True), msg, h, cached)
  1353. return haz
  1354. @FeatureNewKwargs('compiler.has_header', '0.50.0', ['required'])
  1355. @permittedKwargs(header_permitted_kwargs)
  1356. def has_header_method(self, args, kwargs):
  1357. if len(args) != 1:
  1358. raise InterpreterException('has_header method takes exactly one argument.')
  1359. check_stringlist(args)
  1360. hname = args[0]
  1361. prefix = kwargs.get('prefix', '')
  1362. if not isinstance(prefix, str):
  1363. raise InterpreterException('Prefix argument of has_header must be a string.')
  1364. disabled, required, feature = extract_required_kwarg(kwargs, self.subproject, default=False)
  1365. if disabled:
  1366. mlog.log('Has header', mlog.bold(hname, True), 'skipped: feature', mlog.bold(feature), 'disabled')
  1367. return False
  1368. extra_args = functools.partial(self.determine_args, kwargs)
  1369. deps, msg = self.determine_dependencies(kwargs)
  1370. haz, cached = self.compiler.has_header(hname, prefix, self.environment,
  1371. extra_args=extra_args, dependencies=deps)
  1372. cached = mlog.blue('(cached)') if cached else ''
  1373. if required and not haz:
  1374. raise InterpreterException('{} header {!r} not found'.format(self.compiler.get_display_language(), hname))
  1375. elif haz:
  1376. h = mlog.green('YES')
  1377. else:
  1378. h = mlog.red('NO')
  1379. mlog.log('Has header', mlog.bold(hname, True), msg, h, cached)
  1380. return haz
  1381. @FeatureNewKwargs('compiler.has_header_symbol', '0.50.0', ['required'])
  1382. @permittedKwargs(header_permitted_kwargs)
  1383. def has_header_symbol_method(self, args, kwargs):
  1384. if len(args) != 2:
  1385. raise InterpreterException('has_header_symbol method takes exactly two arguments.')
  1386. check_stringlist(args)
  1387. hname, symbol = args
  1388. prefix = kwargs.get('prefix', '')
  1389. if not isinstance(prefix, str):
  1390. raise InterpreterException('Prefix argument of has_header_symbol must be a string.')
  1391. disabled, required, feature = extract_required_kwarg(kwargs, self.subproject, default=False)
  1392. if disabled:
  1393. mlog.log('Header <{0}> has symbol'.format(hname), mlog.bold(symbol, True), 'skipped: feature', mlog.bold(feature), 'disabled')
  1394. return False
  1395. extra_args = functools.partial(self.determine_args, kwargs)
  1396. deps, msg = self.determine_dependencies(kwargs)
  1397. haz, cached = self.compiler.has_header_symbol(hname, symbol, prefix, self.environment,
  1398. extra_args=extra_args,
  1399. dependencies=deps)
  1400. if required and not haz:
  1401. raise InterpreterException('{} symbol {} not found in header {}'.format(self.compiler.get_display_language(), symbol, hname))
  1402. elif haz:
  1403. h = mlog.green('YES')
  1404. else:
  1405. h = mlog.red('NO')
  1406. cached = mlog.blue('(cached)') if cached else ''
  1407. mlog.log('Header <{0}> has symbol'.format(hname), mlog.bold(symbol, True), msg, h, cached)
  1408. return haz
  1409. def notfound_library(self, libname):
  1410. lib = dependencies.ExternalLibrary(libname, None,
  1411. self.environment,
  1412. self.compiler.language,
  1413. silent=True)
  1414. return ExternalLibraryHolder(lib, self.subproject)
  1415. @FeatureNewKwargs('compiler.find_library', '0.51.0', ['static'])
  1416. @FeatureNewKwargs('compiler.find_library', '0.50.0', ['has_headers'])
  1417. @FeatureNewKwargs('compiler.find_library', '0.49.0', ['disabler'])
  1418. @disablerIfNotFound
  1419. @permittedKwargs(find_library_permitted_kwargs)
  1420. def find_library_method(self, args, kwargs):
  1421. # TODO add dependencies support?
  1422. if len(args) != 1:
  1423. raise InterpreterException('find_library method takes one argument.')
  1424. libname = args[0]
  1425. if not isinstance(libname, str):
  1426. raise InterpreterException('Library name not a string.')
  1427. disabled, required, feature = extract_required_kwarg(kwargs, self.subproject)
  1428. if disabled:
  1429. mlog.log('Library', mlog.bold(libname), 'skipped: feature', mlog.bold(feature), 'disabled')
  1430. return self.notfound_library(libname)
  1431. has_header_kwargs = {k[7:]: v for k, v in kwargs.items() if k.startswith('header_')}
  1432. has_header_kwargs['required'] = required
  1433. headers = mesonlib.stringlistify(kwargs.get('has_headers', []))
  1434. for h in headers:
  1435. if not self.has_header_method([h], has_header_kwargs):
  1436. return self.notfound_library(libname)
  1437. search_dirs = extract_search_dirs(kwargs)
  1438. libtype = mesonlib.LibType.PREFER_SHARED
  1439. if 'static' in kwargs:
  1440. if not isinstance(kwargs['static'], bool):
  1441. raise InterpreterException('static must be a boolean')
  1442. libtype = mesonlib.LibType.STATIC if kwargs['static'] else mesonlib.LibType.SHARED
  1443. linkargs = self.compiler.find_library(libname, self.environment, search_dirs, libtype)
  1444. if required and not linkargs:
  1445. raise InterpreterException(
  1446. '{} library {!r} not found'.format(self.compiler.get_display_language(), libname))
  1447. lib = dependencies.ExternalLibrary(libname, linkargs, self.environment,
  1448. self.compiler.language)
  1449. return ExternalLibraryHolder(lib, self.subproject)
  1450. @permittedKwargs({})
  1451. def has_argument_method(self, args: T.Sequence[str], kwargs) -> bool:
  1452. args = mesonlib.stringlistify(args)
  1453. if len(args) != 1:
  1454. raise InterpreterException('has_argument takes exactly one argument.')
  1455. return self.has_multi_arguments_method(args, kwargs)
  1456. @permittedKwargs({})
  1457. def has_multi_arguments_method(self, args: T.Sequence[str], kwargs: dict):
  1458. args = mesonlib.stringlistify(args)
  1459. result, cached = self.compiler.has_multi_arguments(args, self.environment)
  1460. if result:
  1461. h = mlog.green('YES')
  1462. else:
  1463. h = mlog.red('NO')
  1464. cached = mlog.blue('(cached)') if cached else ''
  1465. mlog.log(
  1466. 'Compiler for {} supports arguments {}:'.format(
  1467. self.compiler.get_display_language(), ' '.join(args)),
  1468. h, cached)
  1469. return result
  1470. @FeatureNew('compiler.get_supported_arguments', '0.43.0')
  1471. @permittedKwargs({})
  1472. def get_supported_arguments_method(self, args, kwargs):
  1473. args = mesonlib.stringlistify(args)
  1474. supported_args = []
  1475. for arg in args:
  1476. if self.has_argument_method(arg, kwargs):
  1477. supported_args.append(arg)
  1478. return supported_args
  1479. @permittedKwargs({})
  1480. def first_supported_argument_method(self, args: T.Sequence[str], kwargs: dict) -> T.List[str]:
  1481. for arg in mesonlib.stringlistify(args):
  1482. if self.has_argument_method(arg, kwargs):
  1483. mlog.log('First supported argument:', mlog.bold(arg))
  1484. return [arg]
  1485. mlog.log('First supported argument:', mlog.red('None'))
  1486. return []
  1487. @FeatureNew('compiler.has_link_argument', '0.46.0')
  1488. @permittedKwargs({})
  1489. def has_link_argument_method(self, args, kwargs):
  1490. args = mesonlib.stringlistify(args)
  1491. if len(args) != 1:
  1492. raise InterpreterException('has_link_argument takes exactly one argument.')
  1493. return self.has_multi_link_arguments_method(args, kwargs)
  1494. @FeatureNew('compiler.has_multi_link_argument', '0.46.0')
  1495. @permittedKwargs({})
  1496. def has_multi_link_arguments_method(self, args, kwargs):
  1497. args = mesonlib.stringlistify(args)
  1498. result, cached = self.compiler.has_multi_link_arguments(args, self.environment)
  1499. cached = mlog.blue('(cached)') if cached else ''
  1500. if result:
  1501. h = mlog.green('YES')
  1502. else:
  1503. h = mlog.red('NO')
  1504. mlog.log(
  1505. 'Compiler for {} supports link arguments {}:'.format(
  1506. self.compiler.get_display_language(), ' '.join(args)),
  1507. h, cached)
  1508. return result
  1509. @FeatureNew('compiler.get_supported_link_arguments_method', '0.46.0')
  1510. @permittedKwargs({})
  1511. def get_supported_link_arguments_method(self, args, kwargs):
  1512. args = mesonlib.stringlistify(args)
  1513. supported_args = []
  1514. for arg in args:
  1515. if self.has_link_argument_method(arg, kwargs):
  1516. supported_args.append(arg)
  1517. return supported_args
  1518. @FeatureNew('compiler.first_supported_link_argument_method', '0.46.0')
  1519. @permittedKwargs({})
  1520. def first_supported_link_argument_method(self, args, kwargs):
  1521. for i in mesonlib.stringlistify(args):
  1522. if self.has_link_argument_method(i, kwargs):
  1523. mlog.log('First supported link argument:', mlog.bold(i))
  1524. return [i]
  1525. mlog.log('First supported link argument:', mlog.red('None'))
  1526. return []
  1527. @FeatureNew('compiler.has_function_attribute', '0.48.0')
  1528. @permittedKwargs({})
  1529. def has_func_attribute_method(self, args, kwargs):
  1530. args = mesonlib.stringlistify(args)
  1531. if len(args) != 1:
  1532. raise InterpreterException('has_func_attribute takes exactly one argument.')
  1533. result, cached = self.compiler.has_func_attribute(args[0], self.environment)
  1534. cached = mlog.blue('(cached)') if cached else ''
  1535. h = mlog.green('YES') if result else mlog.red('NO')
  1536. mlog.log('Compiler for {} supports function attribute {}:'.format(self.compiler.get_display_language(), args[0]), h, cached)
  1537. return result
  1538. @FeatureNew('compiler.get_supported_function_attributes', '0.48.0')
  1539. @permittedKwargs({})
  1540. def get_supported_function_attributes_method(self, args, kwargs):
  1541. args = mesonlib.stringlistify(args)
  1542. return [a for a in args if self.has_func_attribute_method(a, kwargs)]
  1543. @FeatureNew('compiler.get_argument_syntax_method', '0.49.0')
  1544. @noPosargs
  1545. @noKwargs
  1546. def get_argument_syntax_method(self, args, kwargs):
  1547. return self.compiler.get_argument_syntax()
  1548. ModuleState = collections.namedtuple('ModuleState', [
  1549. 'source_root', 'build_to_src', 'subproject', 'subdir', 'current_lineno', 'environment',
  1550. 'project_name', 'project_version', 'backend', 'targets',
  1551. 'data', 'headers', 'man', 'global_args', 'project_args', 'build_machine',
  1552. 'host_machine', 'target_machine', 'current_node'])
  1553. class ModuleHolder(InterpreterObject, ObjectHolder):
  1554. def __init__(self, modname, module, interpreter):
  1555. InterpreterObject.__init__(self)
  1556. ObjectHolder.__init__(self, module)
  1557. self.modname = modname
  1558. self.interpreter = interpreter
  1559. def method_call(self, method_name, args, kwargs):
  1560. try:
  1561. fn = getattr(self.held_object, method_name)
  1562. except AttributeError:
  1563. raise InvalidArguments('Module %s does not have method %s.' % (self.modname, method_name))
  1564. if method_name.startswith('_'):
  1565. raise InvalidArguments('Function {!r} in module {!r} is private.'.format(method_name, self.modname))
  1566. if not getattr(fn, 'no-args-flattening', False):
  1567. args = flatten(args)
  1568. # This is not 100% reliable but we can't use hash()
  1569. # because the Build object contains dicts and lists.
  1570. num_targets = len(self.interpreter.build.targets)
  1571. state = ModuleState(
  1572. source_root = self.interpreter.environment.get_source_dir(),
  1573. build_to_src=mesonlib.relpath(self.interpreter.environment.get_source_dir(),
  1574. self.interpreter.environment.get_build_dir()),
  1575. subproject=self.interpreter.subproject,
  1576. subdir=self.interpreter.subdir,
  1577. current_lineno=self.interpreter.current_lineno,
  1578. environment=self.interpreter.environment,
  1579. project_name=self.interpreter.build.project_name,
  1580. project_version=self.interpreter.build.dep_manifest[self.interpreter.active_projectname],
  1581. # The backend object is under-used right now, but we will need it:
  1582. # https://github.com/mesonbuild/meson/issues/1419
  1583. backend=self.interpreter.backend,
  1584. targets=self.interpreter.build.targets,
  1585. data=self.interpreter.build.data,
  1586. headers=self.interpreter.build.get_headers(),
  1587. man=self.interpreter.build.get_man(),
  1588. #global_args_for_build = self.interpreter.build.global_args.build,
  1589. global_args = self.interpreter.build.global_args.host,
  1590. #project_args_for_build = self.interpreter.build.projects_args.build.get(self.interpreter.subproject, {}),
  1591. project_args = self.interpreter.build.projects_args.host.get(self.interpreter.subproject, {}),
  1592. build_machine=self.interpreter.builtin['build_machine'].held_object,
  1593. host_machine=self.interpreter.builtin['host_machine'].held_object,
  1594. target_machine=self.interpreter.builtin['target_machine'].held_object,
  1595. current_node=self.current_node
  1596. )
  1597. # Many modules do for example self.interpreter.find_program_impl(),
  1598. # so we have to ensure they use the current interpreter and not the one
  1599. # that first imported that module, otherwise it will use outdated
  1600. # overrides.
  1601. self.held_object.interpreter = self.interpreter
  1602. if self.held_object.is_snippet(method_name):
  1603. value = fn(self.interpreter, state, args, kwargs)
  1604. return self.interpreter.holderify(value)
  1605. else:
  1606. value = fn(state, args, kwargs)
  1607. if num_targets != len(self.interpreter.build.targets):
  1608. raise InterpreterException('Extension module altered internal state illegally.')
  1609. return self.interpreter.module_method_callback(value)
  1610. class Summary:
  1611. def __init__(self, project_name, project_version):
  1612. self.project_name = project_name
  1613. self.project_version = project_version
  1614. self.sections = collections.defaultdict(dict)
  1615. self.max_key_len = 0
  1616. def add_section(self, section, values, kwargs):
  1617. bool_yn = kwargs.get('bool_yn', False)
  1618. if not isinstance(bool_yn, bool):
  1619. raise InterpreterException('bool_yn keyword argument must be boolean')
  1620. list_sep = kwargs.get('list_sep')
  1621. if list_sep is not None and not isinstance(list_sep, str):
  1622. raise InterpreterException('list_sep keyword argument must be string')
  1623. for k, v in values.items():
  1624. if k in self.sections[section]:
  1625. raise InterpreterException('Summary section {!r} already have key {!r}'.format(section, k))
  1626. formatted_values = []
  1627. for i in listify(v):
  1628. if not isinstance(i, (str, int)):
  1629. m = 'Summary value in section {!r}, key {!r}, must be string, integer or boolean'
  1630. raise InterpreterException(m.format(section, k))
  1631. if bool_yn and isinstance(i, bool):
  1632. formatted_values.append(mlog.green('YES') if i else mlog.red('NO'))
  1633. else:
  1634. formatted_values.append(i)
  1635. self.sections[section][k] = (formatted_values, list_sep)
  1636. self.max_key_len = max(self.max_key_len, len(k))
  1637. def dump(self):
  1638. mlog.log(self.project_name, mlog.normal_cyan(self.project_version))
  1639. for section, values in self.sections.items():
  1640. mlog.log('') # newline
  1641. if section:
  1642. mlog.log(' ', mlog.bold(section))
  1643. for k, v in values.items():
  1644. v, list_sep = v
  1645. indent = self.max_key_len - len(k) + 3
  1646. end = ' ' if v else ''
  1647. mlog.log(' ' * indent, k + ':', end=end)
  1648. if list_sep is None:
  1649. indent = self.max_key_len + 6
  1650. list_sep = '\n' + ' ' * indent
  1651. mlog.log(*v, sep=list_sep)
  1652. mlog.log('') # newline
  1653. class MesonMain(InterpreterObject):
  1654. def __init__(self, build, interpreter):
  1655. InterpreterObject.__init__(self)
  1656. self.build = build
  1657. self.interpreter = interpreter
  1658. self._found_source_scripts = {}
  1659. self.methods.update({'get_compiler': self.get_compiler_method,
  1660. 'is_cross_build': self.is_cross_build_method,
  1661. 'has_exe_wrapper': self.has_exe_wrapper_method,
  1662. 'is_unity': self.is_unity_method,
  1663. 'is_subproject': self.is_subproject_method,
  1664. 'current_source_dir': self.current_source_dir_method,
  1665. 'current_build_dir': self.current_build_dir_method,
  1666. 'source_root': self.source_root_method,
  1667. 'build_root': self.build_root_method,
  1668. 'add_install_script': self.add_install_script_method,
  1669. 'add_postconf_script': self.add_postconf_script_method,
  1670. 'add_dist_script': self.add_dist_script_method,
  1671. 'install_dependency_manifest': self.install_dependency_manifest_method,
  1672. 'override_dependency': self.override_dependency_method,
  1673. 'override_find_program': self.override_find_program_method,
  1674. 'project_version': self.project_version_method,
  1675. 'project_license': self.project_license_method,
  1676. 'version': self.version_method,
  1677. 'project_name': self.project_name_method,
  1678. 'get_cross_property': self.get_cross_property_method,
  1679. 'get_external_property': self.get_external_property_method,
  1680. 'backend': self.backend_method,
  1681. })
  1682. def _find_source_script(self, prog: T.Union[str, ExecutableHolder], args):
  1683. if isinstance(prog, ExecutableHolder):
  1684. prog_path = self.interpreter.backend.get_target_filename(prog.held_object)
  1685. return build.RunScript([prog_path], args)
  1686. elif isinstance(prog, ExternalProgramHolder):
  1687. return build.RunScript(prog.get_command(), args)
  1688. # Prefer scripts in the current source directory
  1689. search_dir = os.path.join(self.interpreter.environment.source_dir,
  1690. self.interpreter.subdir)
  1691. key = (prog, search_dir)
  1692. if key in self._found_source_scripts:
  1693. found = self._found_source_scripts[key]
  1694. else:
  1695. found = dependencies.ExternalProgram(prog, search_dir=search_dir)
  1696. if found.found():
  1697. self._found_source_scripts[key] = found
  1698. else:
  1699. m = 'Script or command {!r} not found or not executable'
  1700. raise InterpreterException(m.format(prog))
  1701. return build.RunScript(found.get_command(), args)
  1702. def _process_script_args(
  1703. self, name: str, args: T.List[T.Union[
  1704. str, mesonlib.File, CustomTargetHolder,
  1705. CustomTargetIndexHolder, ConfigureFileHolder,
  1706. ExternalProgramHolder, ExecutableHolder,
  1707. ]], allow_built: bool = False) -> T.List[str]:
  1708. script_args = [] # T.List[str]
  1709. new = False
  1710. for a in args:
  1711. a = unholder(a)
  1712. if isinstance(a, str):
  1713. script_args.append(a)
  1714. elif isinstance(a, mesonlib.File):
  1715. new = True
  1716. script_args.append(a.rel_to_builddir(self.interpreter.environment.source_dir))
  1717. elif isinstance(a, (build.BuildTarget, build.CustomTarget, build.CustomTargetIndex)):
  1718. if not allow_built:
  1719. raise InterpreterException('Arguments to {} cannot be built'.format(name))
  1720. new = True
  1721. script_args.extend([os.path.join(a.get_subdir(), o) for o in a.get_outputs()])
  1722. # This feels really hacky, but I'm not sure how else to fix
  1723. # this without completely rewriting install script handling.
  1724. # This is complicated by the fact that the install target
  1725. # depends on all.
  1726. if isinstance(a, build.CustomTargetIndex):
  1727. a.target.build_by_default = True
  1728. else:
  1729. a.build_by_default = True
  1730. elif isinstance(a, build.ConfigureFile):
  1731. new = True
  1732. script_args.append(os.path.join(a.subdir, a.targetname))
  1733. elif isinstance(a, dependencies.ExternalProgram):
  1734. script_args.extend(a.command)
  1735. new = True
  1736. else:
  1737. raise InterpreterException(
  1738. 'Arguments to {} must be strings, Files, CustomTargets, '
  1739. 'Indexes of CustomTargets, or ConfigureFiles'.format(name))
  1740. if new:
  1741. FeatureNew('Calling "{}" with File, CustomTaget, Index of CustomTarget, ConfigureFile, Executable, or ExternalProgram'.format(name), '0.55.0').use(
  1742. self.interpreter.subproject)
  1743. return script_args
  1744. @permittedKwargs(set())
  1745. def add_install_script_method(self, args: 'T.Tuple[T.Union[str, ExecutableHolder], T.Union[str, mesonlib.File, CustomTargetHolder, CustomTargetIndexHolder, ConfigureFileHolder], ...]', kwargs):
  1746. if len(args) < 1:
  1747. raise InterpreterException('add_install_script takes one or more arguments')
  1748. script_args = self._process_script_args('add_install_script', args[1:], allow_built=True)
  1749. script = self._find_source_script(args[0], script_args)
  1750. self.build.install_scripts.append(script)
  1751. @permittedKwargs(set())
  1752. def add_postconf_script_method(self, args, kwargs):
  1753. if len(args) < 1:
  1754. raise InterpreterException('add_postconf_script takes one or more arguments')
  1755. script_args = self._process_script_args('add_postconf_script', args[1:], allow_built=True)
  1756. script = self._find_source_script(args[0], script_args)
  1757. self.build.postconf_scripts.append(script)
  1758. @permittedKwargs(set())
  1759. def add_dist_script_method(self, args, kwargs):
  1760. if len(args) < 1:
  1761. raise InterpreterException('add_dist_script takes one or more arguments')
  1762. if len(args) > 1:
  1763. FeatureNew('Calling "add_dist_script" with multiple arguments', '0.49.0').use(self.interpreter.subproject)
  1764. if self.interpreter.subproject != '':
  1765. raise InterpreterException('add_dist_script may not be used in a subproject.')
  1766. script_args = self._process_script_args('add_dist_script', args[1:], allow_built=True)
  1767. script = self._find_source_script(args[0], script_args)
  1768. self.build.dist_scripts.append(script)
  1769. @noPosargs
  1770. @permittedKwargs({})
  1771. def current_source_dir_method(self, args, kwargs):
  1772. src = self.interpreter.environment.source_dir
  1773. sub = self.interpreter.subdir
  1774. if sub == '':
  1775. return src
  1776. return os.path.join(src, sub)
  1777. @noPosargs
  1778. @permittedKwargs({})
  1779. def current_build_dir_method(self, args, kwargs):
  1780. src = self.interpreter.environment.build_dir
  1781. sub = self.interpreter.subdir
  1782. if sub == '':
  1783. return src
  1784. return os.path.join(src, sub)
  1785. @noPosargs
  1786. @permittedKwargs({})
  1787. def backend_method(self, args, kwargs):
  1788. return self.interpreter.backend.name
  1789. @noPosargs
  1790. @permittedKwargs({})
  1791. def source_root_method(self, args, kwargs):
  1792. return self.interpreter.environment.source_dir
  1793. @noPosargs
  1794. @permittedKwargs({})
  1795. def build_root_method(self, args, kwargs):
  1796. return self.interpreter.environment.build_dir
  1797. @noPosargs
  1798. @permittedKwargs({})
  1799. def has_exe_wrapper_method(self, args, kwargs):
  1800. if self.is_cross_build_method(None, None) and \
  1801. self.build.environment.need_exe_wrapper():
  1802. if self.build.environment.exe_wrapper is None:
  1803. return False
  1804. # We return True when exe_wrap is defined, when it's not needed, and
  1805. # when we're compiling natively. The last two are semantically confusing.
  1806. # Need to revisit this.
  1807. return True
  1808. @noPosargs
  1809. @permittedKwargs({})
  1810. def is_cross_build_method(self, args, kwargs):
  1811. return self.build.environment.is_cross_build()
  1812. @permittedKwargs({'native'})
  1813. def get_compiler_method(self, args, kwargs):
  1814. if len(args) != 1:
  1815. raise InterpreterException('get_compiler_method must have one and only one argument.')
  1816. cname = args[0]
  1817. for_machine = Interpreter.machine_from_native_kwarg(kwargs)
  1818. clist = self.interpreter.coredata.compilers[for_machine]
  1819. if cname in clist:
  1820. return CompilerHolder(clist[cname], self.build.environment, self.interpreter.subproject)
  1821. raise InterpreterException('Tried to access compiler for unspecified language "%s".' % cname)
  1822. @noPosargs
  1823. @permittedKwargs({})
  1824. def is_unity_method(self, args, kwargs):
  1825. optval = self.interpreter.environment.coredata.get_builtin_option('unity')
  1826. if optval == 'on' or (optval == 'subprojects' and self.interpreter.is_subproject()):
  1827. return True
  1828. return False
  1829. @noPosargs
  1830. @permittedKwargs({})
  1831. def is_subproject_method(self, args, kwargs):
  1832. return self.interpreter.is_subproject()
  1833. @permittedKwargs({})
  1834. def install_dependency_manifest_method(self, args, kwargs):
  1835. if len(args) != 1:
  1836. raise InterpreterException('Must specify manifest install file name')
  1837. if not isinstance(args[0], str):
  1838. raise InterpreterException('Argument must be a string.')
  1839. self.build.dep_manifest_name = args[0]
  1840. @FeatureNew('meson.override_find_program', '0.46.0')
  1841. @permittedKwargs({})
  1842. def override_find_program_method(self, args, kwargs):
  1843. if len(args) != 2:
  1844. raise InterpreterException('Override needs two arguments')
  1845. name, exe = args
  1846. if not isinstance(name, str):
  1847. raise InterpreterException('First argument must be a string')
  1848. if hasattr(exe, 'held_object'):
  1849. exe = exe.held_object
  1850. if isinstance(exe, mesonlib.File):
  1851. abspath = exe.absolute_path(self.interpreter.environment.source_dir,
  1852. self.interpreter.environment.build_dir)
  1853. if not os.path.exists(abspath):
  1854. raise InterpreterException('Tried to override %s with a file that does not exist.' % name)
  1855. exe = OverrideProgram(abspath)
  1856. if not isinstance(exe, (dependencies.ExternalProgram, build.Executable)):
  1857. raise InterpreterException('Second argument must be an external program or executable.')
  1858. self.interpreter.add_find_program_override(name, exe)
  1859. @FeatureNew('meson.override_dependency', '0.54.0')
  1860. @permittedKwargs({'native'})
  1861. def override_dependency_method(self, args, kwargs):
  1862. if len(args) != 2:
  1863. raise InterpreterException('Override needs two arguments')
  1864. name = args[0]
  1865. dep = args[1]
  1866. if not isinstance(name, str) or not name:
  1867. raise InterpreterException('First argument must be a string and cannot be empty')
  1868. if hasattr(dep, 'held_object'):
  1869. dep = dep.held_object
  1870. if not isinstance(dep, dependencies.Dependency):
  1871. raise InterpreterException('Second argument must be a dependency object')
  1872. identifier = dependencies.get_dep_identifier(name, kwargs)
  1873. for_machine = self.interpreter.machine_from_native_kwarg(kwargs)
  1874. override = self.build.dependency_overrides[for_machine].get(identifier)
  1875. if override:
  1876. m = 'Tried to override dependency {!r} which has already been resolved or overridden at {}'
  1877. location = mlog.get_error_location_string(override.node.filename, override.node.lineno)
  1878. raise InterpreterException(m.format(name, location))
  1879. self.build.dependency_overrides[for_machine][identifier] = \
  1880. build.DependencyOverride(dep, self.interpreter.current_node)
  1881. @noPosargs
  1882. @permittedKwargs({})
  1883. def project_version_method(self, args, kwargs):
  1884. return self.build.dep_manifest[self.interpreter.active_projectname]['version']
  1885. @FeatureNew('meson.project_license()', '0.45.0')
  1886. @noPosargs
  1887. @permittedKwargs({})
  1888. def project_license_method(self, args, kwargs):
  1889. return self.build.dep_manifest[self.interpreter.active_projectname]['license']
  1890. @noPosargs
  1891. @permittedKwargs({})
  1892. def version_method(self, args, kwargs):
  1893. return coredata.version
  1894. @noPosargs
  1895. @permittedKwargs({})
  1896. def project_name_method(self, args, kwargs):
  1897. return self.interpreter.active_projectname
  1898. @noArgsFlattening
  1899. @permittedKwargs({})
  1900. def get_cross_property_method(self, args, kwargs) -> str:
  1901. if len(args) < 1 or len(args) > 2:
  1902. raise InterpreterException('Must have one or two arguments.')
  1903. propname = args[0]
  1904. if not isinstance(propname, str):
  1905. raise InterpreterException('Property name must be string.')
  1906. try:
  1907. props = self.interpreter.environment.properties.host
  1908. return props[propname]
  1909. except Exception:
  1910. if len(args) == 2:
  1911. return args[1]
  1912. raise InterpreterException('Unknown cross property: %s.' % propname)
  1913. @noArgsFlattening
  1914. @permittedKwargs({'native'})
  1915. @FeatureNew('meson.get_external_property', '0.54.0')
  1916. def get_external_property_method(self, args: T.Sequence[str], kwargs: dict) -> str:
  1917. if len(args) < 1 or len(args) > 2:
  1918. raise InterpreterException('Must have one or two positional arguments.')
  1919. propname = args[0]
  1920. if not isinstance(propname, str):
  1921. raise InterpreterException('Property name must be string.')
  1922. def _get_native() -> str:
  1923. try:
  1924. props = self.interpreter.environment.properties.build
  1925. return props[propname]
  1926. except Exception:
  1927. if len(args) == 2:
  1928. return args[1]
  1929. raise InterpreterException('Unknown native property: %s.' % propname)
  1930. if 'native' in kwargs:
  1931. if kwargs['native']:
  1932. return _get_native()
  1933. else:
  1934. return self.get_cross_property_method(args, {})
  1935. else: # native: not specified
  1936. if self.build.environment.is_cross_build():
  1937. return self.get_cross_property_method(args, kwargs)
  1938. else:
  1939. return _get_native()
  1940. known_library_kwargs = (
  1941. build.known_shlib_kwargs |
  1942. build.known_stlib_kwargs
  1943. )
  1944. known_build_target_kwargs = (
  1945. known_library_kwargs |
  1946. build.known_exe_kwargs |
  1947. build.known_jar_kwargs |
  1948. {'target_type'}
  1949. )
  1950. _base_test_args = {'args', 'depends', 'env', 'should_fail', 'timeout', 'workdir', 'suite', 'priority', 'protocol'}
  1951. permitted_kwargs = {'add_global_arguments': {'language', 'native'},
  1952. 'add_global_link_arguments': {'language', 'native'},
  1953. 'add_languages': {'required', 'native'},
  1954. 'add_project_link_arguments': {'language', 'native'},
  1955. 'add_project_arguments': {'language', 'native'},
  1956. 'add_test_setup': {'exe_wrapper', 'gdb', 'timeout_multiplier', 'env', 'is_default'},
  1957. 'benchmark': _base_test_args,
  1958. 'build_target': known_build_target_kwargs,
  1959. 'configure_file': {'input',
  1960. 'output',
  1961. 'configuration',
  1962. 'command',
  1963. 'copy',
  1964. 'depfile',
  1965. 'install_dir',
  1966. 'install_mode',
  1967. 'capture',
  1968. 'install',
  1969. 'format',
  1970. 'output_format',
  1971. 'encoding'},
  1972. 'custom_target': {'input',
  1973. 'output',
  1974. 'command',
  1975. 'install',
  1976. 'install_dir',
  1977. 'install_mode',
  1978. 'build_always',
  1979. 'capture',
  1980. 'depends',
  1981. 'depend_files',
  1982. 'depfile',
  1983. 'build_by_default',
  1984. 'build_always_stale',
  1985. 'console'},
  1986. 'dependency': {'default_options',
  1987. 'embed',
  1988. 'fallback',
  1989. 'language',
  1990. 'main',
  1991. 'method',
  1992. 'modules',
  1993. 'components',
  1994. 'cmake_module_path',
  1995. 'optional_modules',
  1996. 'native',
  1997. 'not_found_message',
  1998. 'required',
  1999. 'static',
  2000. 'version',
  2001. 'private_headers',
  2002. 'cmake_args',
  2003. 'include_type',
  2004. },
  2005. 'declare_dependency': {'include_directories',
  2006. 'link_with',
  2007. 'sources',
  2008. 'dependencies',
  2009. 'compile_args',
  2010. 'link_args',
  2011. 'link_whole',
  2012. 'version',
  2013. 'variables',
  2014. },
  2015. 'executable': build.known_exe_kwargs,
  2016. 'find_program': {'required', 'native', 'version', 'dirs'},
  2017. 'generator': {'arguments',
  2018. 'output',
  2019. 'depends',
  2020. 'depfile',
  2021. 'capture',
  2022. 'preserve_path_from'},
  2023. 'include_directories': {'is_system'},
  2024. 'install_data': {'install_dir', 'install_mode', 'rename', 'sources'},
  2025. 'install_headers': {'install_dir', 'install_mode', 'subdir'},
  2026. 'install_man': {'install_dir', 'install_mode'},
  2027. 'install_subdir': {'exclude_files', 'exclude_directories', 'install_dir', 'install_mode', 'strip_directory'},
  2028. 'jar': build.known_jar_kwargs,
  2029. 'project': {'version', 'meson_version', 'default_options', 'license', 'subproject_dir'},
  2030. 'run_command': {'check', 'capture', 'env'},
  2031. 'run_target': {'command', 'depends'},
  2032. 'shared_library': build.known_shlib_kwargs,
  2033. 'shared_module': build.known_shmod_kwargs,
  2034. 'static_library': build.known_stlib_kwargs,
  2035. 'both_libraries': known_library_kwargs,
  2036. 'library': known_library_kwargs,
  2037. 'subdir': {'if_found'},
  2038. 'subproject': {'version', 'default_options', 'required'},
  2039. 'test': set.union(_base_test_args, {'is_parallel'}),
  2040. 'vcs_tag': {'input', 'output', 'fallback', 'command', 'replace_string'},
  2041. }
  2042. class Interpreter(InterpreterBase):
  2043. def __init__(self, build, backend=None, subproject='', subdir='', subproject_dir='subprojects',
  2044. modules = None, default_project_options=None, mock=False, ast=None):
  2045. super().__init__(build.environment.get_source_dir(), subdir, subproject)
  2046. self.an_unpicklable_object = mesonlib.an_unpicklable_object
  2047. self.build = build
  2048. self.environment = build.environment
  2049. self.coredata = self.environment.get_coredata()
  2050. self.backend = backend
  2051. self.summary = {}
  2052. if modules is None:
  2053. self.modules = {}
  2054. else:
  2055. self.modules = modules
  2056. # Subproject directory is usually the name of the subproject, but can
  2057. # be different for dependencies provided by wrap files.
  2058. self.subproject_directory_name = subdir.split(os.path.sep)[-1]
  2059. self.subproject_dir = subproject_dir
  2060. self.option_file = os.path.join(self.source_root, self.subdir, 'meson_options.txt')
  2061. if not mock and ast is None:
  2062. self.load_root_meson_file()
  2063. self.sanity_check_ast()
  2064. elif ast is not None:
  2065. self.ast = ast
  2066. self.sanity_check_ast()
  2067. self.builtin.update({'meson': MesonMain(build, self)})
  2068. self.generators = []
  2069. self.visited_subdirs = {}
  2070. self.project_args_frozen = False
  2071. self.global_args_frozen = False # implies self.project_args_frozen
  2072. self.subprojects = {}
  2073. self.subproject_stack = []
  2074. self.configure_file_outputs = {}
  2075. # Passed from the outside, only used in subprojects.
  2076. if default_project_options:
  2077. self.default_project_options = default_project_options.copy()
  2078. else:
  2079. self.default_project_options = {}
  2080. self.project_default_options = {}
  2081. self.build_func_dict()
  2082. # build_def_files needs to be defined before parse_project is called
  2083. self.build_def_files = [os.path.join(self.subdir, environment.build_filename)]
  2084. if not mock:
  2085. self.parse_project()
  2086. self._redetect_machines()
  2087. def _redetect_machines(self):
  2088. # Re-initialize machine descriptions. We can do a better job now because we
  2089. # have the compilers needed to gain more knowledge, so wipe out old
  2090. # inference and start over.
  2091. machines = self.build.environment.machines.miss_defaulting()
  2092. machines.build = environment.detect_machine_info(self.coredata.compilers.build)
  2093. self.build.environment.machines = machines.default_missing()
  2094. assert self.build.environment.machines.build.cpu is not None
  2095. assert self.build.environment.machines.host.cpu is not None
  2096. assert self.build.environment.machines.target.cpu is not None
  2097. self.builtin['build_machine'] = \
  2098. MachineHolder(self.build.environment.machines.build)
  2099. self.builtin['host_machine'] = \
  2100. MachineHolder(self.build.environment.machines.host)
  2101. self.builtin['target_machine'] = \
  2102. MachineHolder(self.build.environment.machines.target)
  2103. def get_non_matching_default_options(self):
  2104. env = self.environment
  2105. for def_opt_name, def_opt_value in self.project_default_options.items():
  2106. for opts in env.coredata.get_all_options():
  2107. cur_opt_value = opts.get(def_opt_name)
  2108. if cur_opt_value is not None:
  2109. def_opt_value = env.coredata.validate_option_value(def_opt_name, def_opt_value)
  2110. if def_opt_value != cur_opt_value.value:
  2111. yield (def_opt_name, def_opt_value, cur_opt_value)
  2112. def build_func_dict(self):
  2113. self.funcs.update({'add_global_arguments': self.func_add_global_arguments,
  2114. 'add_project_arguments': self.func_add_project_arguments,
  2115. 'add_global_link_arguments': self.func_add_global_link_arguments,
  2116. 'add_project_link_arguments': self.func_add_project_link_arguments,
  2117. 'add_test_setup': self.func_add_test_setup,
  2118. 'add_languages': self.func_add_languages,
  2119. 'alias_target': self.func_alias_target,
  2120. 'assert': self.func_assert,
  2121. 'benchmark': self.func_benchmark,
  2122. 'build_target': self.func_build_target,
  2123. 'configuration_data': self.func_configuration_data,
  2124. 'configure_file': self.func_configure_file,
  2125. 'custom_target': self.func_custom_target,
  2126. 'declare_dependency': self.func_declare_dependency,
  2127. 'dependency': self.func_dependency,
  2128. 'disabler': self.func_disabler,
  2129. 'environment': self.func_environment,
  2130. 'error': self.func_error,
  2131. 'executable': self.func_executable,
  2132. 'generator': self.func_generator,
  2133. 'gettext': self.func_gettext,
  2134. 'get_option': self.func_get_option,
  2135. 'get_variable': self.func_get_variable,
  2136. 'files': self.func_files,
  2137. 'find_library': self.func_find_library,
  2138. 'find_program': self.func_find_program,
  2139. 'include_directories': self.func_include_directories,
  2140. 'import': self.func_import,
  2141. 'install_data': self.func_install_data,
  2142. 'install_headers': self.func_install_headers,
  2143. 'install_man': self.func_install_man,
  2144. 'install_subdir': self.func_install_subdir,
  2145. 'is_disabler': self.func_is_disabler,
  2146. 'is_variable': self.func_is_variable,
  2147. 'jar': self.func_jar,
  2148. 'join_paths': self.func_join_paths,
  2149. 'library': self.func_library,
  2150. 'message': self.func_message,
  2151. 'warning': self.func_warning,
  2152. 'option': self.func_option,
  2153. 'project': self.func_project,
  2154. 'run_target': self.func_run_target,
  2155. 'run_command': self.func_run_command,
  2156. 'set_variable': self.func_set_variable,
  2157. 'subdir': self.func_subdir,
  2158. 'subdir_done': self.func_subdir_done,
  2159. 'subproject': self.func_subproject,
  2160. 'summary': self.func_summary,
  2161. 'shared_library': self.func_shared_lib,
  2162. 'shared_module': self.func_shared_module,
  2163. 'static_library': self.func_static_lib,
  2164. 'both_libraries': self.func_both_lib,
  2165. 'test': self.func_test,
  2166. 'vcs_tag': self.func_vcs_tag
  2167. })
  2168. if 'MESON_UNIT_TEST' in os.environ:
  2169. self.funcs.update({'exception': self.func_exception})
  2170. def holderify(self, item):
  2171. if isinstance(item, list):
  2172. return [self.holderify(x) for x in item]
  2173. if isinstance(item, dict):
  2174. return {k: self.holderify(v) for k, v in item.items()}
  2175. if isinstance(item, build.CustomTarget):
  2176. return CustomTargetHolder(item, self)
  2177. elif isinstance(item, (int, str, bool, Disabler)) or item is None:
  2178. return item
  2179. elif isinstance(item, build.Executable):
  2180. return ExecutableHolder(item, self)
  2181. elif isinstance(item, build.GeneratedList):
  2182. return GeneratedListHolder(item)
  2183. elif isinstance(item, build.RunTarget):
  2184. raise RuntimeError('This is not a pipe.')
  2185. elif isinstance(item, build.RunScript):
  2186. raise RuntimeError('Do not do this.')
  2187. elif isinstance(item, build.Data):
  2188. return DataHolder(item)
  2189. elif isinstance(item, dependencies.Dependency):
  2190. return DependencyHolder(item, self.subproject)
  2191. elif isinstance(item, dependencies.ExternalProgram):
  2192. return ExternalProgramHolder(item, self.subproject)
  2193. elif hasattr(item, 'held_object'):
  2194. return item
  2195. else:
  2196. raise InterpreterException('Module returned a value of unknown type.')
  2197. def process_new_values(self, invalues):
  2198. invalues = listify(invalues)
  2199. for v in invalues:
  2200. if isinstance(v, (RunTargetHolder, CustomTargetHolder, BuildTargetHolder)):
  2201. v = v.held_object
  2202. if isinstance(v, (build.BuildTarget, build.CustomTarget, build.RunTarget)):
  2203. self.add_target(v.name, v)
  2204. elif isinstance(v, list):
  2205. self.module_method_callback(v)
  2206. elif isinstance(v, build.GeneratedList):
  2207. pass
  2208. elif isinstance(v, build.RunScript):
  2209. self.build.install_scripts.append(v)
  2210. elif isinstance(v, build.Data):
  2211. self.build.data.append(v)
  2212. elif isinstance(v, dependencies.ExternalProgram):
  2213. return ExternalProgramHolder(v, self.subproject)
  2214. elif isinstance(v, dependencies.InternalDependency):
  2215. # FIXME: This is special cased and not ideal:
  2216. # The first source is our new VapiTarget, the rest are deps
  2217. self.process_new_values(v.sources[0])
  2218. elif hasattr(v, 'held_object'):
  2219. pass
  2220. elif isinstance(v, (int, str, bool, Disabler)):
  2221. pass
  2222. else:
  2223. raise InterpreterException('Module returned a value of unknown type.')
  2224. def module_method_callback(self, return_object):
  2225. if not isinstance(return_object, ModuleReturnValue):
  2226. raise InterpreterException('Bug in module, it returned an invalid object')
  2227. invalues = return_object.new_objects
  2228. self.process_new_values(invalues)
  2229. return self.holderify(return_object.return_value)
  2230. def get_build_def_files(self):
  2231. return self.build_def_files
  2232. def add_build_def_file(self, f):
  2233. # Use relative path for files within source directory, and absolute path
  2234. # for system files. Skip files within build directory. Also skip not regular
  2235. # files (e.g. /dev/stdout) Normalize the path to avoid duplicates, this
  2236. # is especially important to convert '/' to '\' on Windows.
  2237. if isinstance(f, mesonlib.File):
  2238. if f.is_built:
  2239. return
  2240. f = os.path.normpath(f.relative_name())
  2241. elif os.path.isfile(f) and not f.startswith('/dev'):
  2242. srcdir = Path(self.environment.get_source_dir())
  2243. builddir = Path(self.environment.get_build_dir())
  2244. f = Path(f).resolve()
  2245. if builddir in f.parents:
  2246. return
  2247. if srcdir in f.parents:
  2248. f = f.relative_to(srcdir)
  2249. f = str(f)
  2250. else:
  2251. return
  2252. if f not in self.build_def_files:
  2253. self.build_def_files.append(f)
  2254. def get_variables(self):
  2255. return self.variables
  2256. def check_stdlibs(self):
  2257. for for_machine in MachineChoice:
  2258. props = self.build.environment.properties[for_machine]
  2259. for l in self.coredata.compilers[for_machine].keys():
  2260. try:
  2261. di = mesonlib.stringlistify(props.get_stdlib(l))
  2262. if len(di) != 2:
  2263. raise InterpreterException('Stdlib definition for %s should have exactly two elements.'
  2264. % l)
  2265. projname, depname = di
  2266. subproj = self.do_subproject(projname, 'meson', {})
  2267. self.build.stdlibs.host[l] = subproj.get_variable_method([depname], {})
  2268. except KeyError:
  2269. pass
  2270. except InvalidArguments:
  2271. pass
  2272. @stringArgs
  2273. @noKwargs
  2274. def func_import(self, node, args, kwargs):
  2275. if len(args) != 1:
  2276. raise InvalidCode('Import takes one argument.')
  2277. modname = args[0]
  2278. if modname.startswith('unstable-'):
  2279. plainname = modname.split('-', 1)[1]
  2280. mlog.warning('Module %s has no backwards or forwards compatibility and might not exist in future releases.' % modname, location=node)
  2281. modname = 'unstable_' + plainname
  2282. if modname not in self.modules:
  2283. try:
  2284. module = importlib.import_module('mesonbuild.modules.' + modname)
  2285. except ImportError:
  2286. raise InvalidArguments('Module "%s" does not exist' % (modname, ))
  2287. self.modules[modname] = module.initialize(self)
  2288. return ModuleHolder(modname, self.modules[modname], self)
  2289. @stringArgs
  2290. @noKwargs
  2291. def func_files(self, node, args, kwargs):
  2292. return [mesonlib.File.from_source_file(self.environment.source_dir, self.subdir, fname) for fname in args]
  2293. @FeatureNewKwargs('declare_dependency', '0.46.0', ['link_whole'])
  2294. @FeatureNewKwargs('declare_dependency', '0.54.0', ['variables'])
  2295. @permittedKwargs(permitted_kwargs['declare_dependency'])
  2296. @noPosargs
  2297. def func_declare_dependency(self, node, args, kwargs):
  2298. version = kwargs.get('version', self.project_version)
  2299. if not isinstance(version, str):
  2300. raise InterpreterException('Version must be a string.')
  2301. incs = self.extract_incdirs(kwargs)
  2302. libs = unholder(extract_as_list(kwargs, 'link_with'))
  2303. libs_whole = unholder(extract_as_list(kwargs, 'link_whole'))
  2304. sources = extract_as_list(kwargs, 'sources')
  2305. sources = unholder(listify(self.source_strings_to_files(sources)))
  2306. deps = unholder(extract_as_list(kwargs, 'dependencies'))
  2307. compile_args = mesonlib.stringlistify(kwargs.get('compile_args', []))
  2308. link_args = mesonlib.stringlistify(kwargs.get('link_args', []))
  2309. variables = kwargs.get('variables', {})
  2310. if not isinstance(variables, dict):
  2311. raise InterpreterException('variables must be a dict.')
  2312. if not all(isinstance(v, str) for v in variables.values()):
  2313. # Because that is how they will come from pkg-config and cmake
  2314. raise InterpreterException('variables values be strings.')
  2315. final_deps = []
  2316. for d in deps:
  2317. try:
  2318. d = d.held_object
  2319. except Exception:
  2320. pass
  2321. if not isinstance(d, (dependencies.Dependency, dependencies.ExternalLibrary, dependencies.InternalDependency)):
  2322. raise InterpreterException('Dependencies must be external deps')
  2323. final_deps.append(d)
  2324. for l in libs:
  2325. if isinstance(l, dependencies.Dependency):
  2326. raise InterpreterException('''Entries in "link_with" may only be self-built targets,
  2327. external dependencies (including libraries) must go to "dependencies".''')
  2328. dep = dependencies.InternalDependency(version, incs, compile_args,
  2329. link_args, libs, libs_whole, sources, final_deps,
  2330. variables)
  2331. return DependencyHolder(dep, self.subproject)
  2332. @noKwargs
  2333. def func_assert(self, node, args, kwargs):
  2334. if len(args) == 1:
  2335. FeatureNew('assert function without message argument', '0.53.0').use(self.subproject)
  2336. value = args[0]
  2337. message = None
  2338. elif len(args) == 2:
  2339. value, message = args
  2340. if not isinstance(message, str):
  2341. raise InterpreterException('Assert message not a string.')
  2342. else:
  2343. raise InterpreterException('Assert takes between one and two arguments')
  2344. if not isinstance(value, bool):
  2345. raise InterpreterException('Assert value not bool.')
  2346. if not value:
  2347. if message is None:
  2348. from .ast import AstPrinter
  2349. printer = AstPrinter()
  2350. node.args.arguments[0].accept(printer)
  2351. message = printer.result
  2352. raise InterpreterException('Assert failed: ' + message)
  2353. def validate_arguments(self, args, argcount, arg_types):
  2354. if argcount is not None:
  2355. if argcount != len(args):
  2356. raise InvalidArguments('Expected %d arguments, got %d.' %
  2357. (argcount, len(args)))
  2358. for actual, wanted in zip(args, arg_types):
  2359. if wanted is not None:
  2360. if not isinstance(actual, wanted):
  2361. raise InvalidArguments('Incorrect argument type.')
  2362. @FeatureNewKwargs('run_command', '0.50.0', ['env'])
  2363. @FeatureNewKwargs('run_command', '0.47.0', ['check', 'capture'])
  2364. @permittedKwargs(permitted_kwargs['run_command'])
  2365. def func_run_command(self, node, args, kwargs):
  2366. return self.run_command_impl(node, args, kwargs)
  2367. def run_command_impl(self, node, args, kwargs, in_builddir=False):
  2368. if len(args) < 1:
  2369. raise InterpreterException('Not enough arguments')
  2370. cmd, *cargs = args
  2371. capture = kwargs.get('capture', True)
  2372. srcdir = self.environment.get_source_dir()
  2373. builddir = self.environment.get_build_dir()
  2374. check = kwargs.get('check', False)
  2375. if not isinstance(check, bool):
  2376. raise InterpreterException('Check must be boolean.')
  2377. env = self.unpack_env_kwarg(kwargs)
  2378. m = 'must be a string, or the output of find_program(), files() '\
  2379. 'or configure_file(), or a compiler object; not {!r}'
  2380. expanded_args = []
  2381. if isinstance(cmd, ExternalProgramHolder):
  2382. cmd = cmd.held_object
  2383. if isinstance(cmd, build.Executable):
  2384. progname = node.args.arguments[0].value
  2385. msg = 'Program {!r} was overridden with the compiled executable {!r}'\
  2386. ' and therefore cannot be used during configuration'
  2387. raise InterpreterException(msg.format(progname, cmd.description()))
  2388. if not cmd.found():
  2389. raise InterpreterException('command {!r} not found or not executable'.format(cmd.get_name()))
  2390. elif isinstance(cmd, CompilerHolder):
  2391. exelist = cmd.compiler.get_exelist()
  2392. cmd = exelist[0]
  2393. prog = ExternalProgram(cmd, silent=True)
  2394. if not prog.found():
  2395. raise InterpreterException('Program {!r} not found '
  2396. 'or not executable'.format(cmd))
  2397. cmd = prog
  2398. expanded_args = exelist[1:]
  2399. else:
  2400. if isinstance(cmd, mesonlib.File):
  2401. cmd = cmd.absolute_path(srcdir, builddir)
  2402. elif not isinstance(cmd, str):
  2403. raise InterpreterException('First argument ' + m.format(cmd))
  2404. # Prefer scripts in the current source directory
  2405. search_dir = os.path.join(srcdir, self.subdir)
  2406. prog = ExternalProgram(cmd, silent=True, search_dir=search_dir)
  2407. if not prog.found():
  2408. raise InterpreterException('Program or command {!r} not found '
  2409. 'or not executable'.format(cmd))
  2410. cmd = prog
  2411. for a in listify(cargs):
  2412. if isinstance(a, str):
  2413. expanded_args.append(a)
  2414. elif isinstance(a, mesonlib.File):
  2415. expanded_args.append(a.absolute_path(srcdir, builddir))
  2416. elif isinstance(a, ExternalProgramHolder):
  2417. expanded_args.append(a.held_object.get_path())
  2418. else:
  2419. raise InterpreterException('Arguments ' + m.format(a))
  2420. # If any file that was used as an argument to the command
  2421. # changes, we must re-run the configuration step.
  2422. self.add_build_def_file(cmd.get_path())
  2423. for a in expanded_args:
  2424. if not os.path.isabs(a):
  2425. a = os.path.join(builddir if in_builddir else srcdir, self.subdir, a)
  2426. self.add_build_def_file(a)
  2427. return RunProcess(cmd, expanded_args, env, srcdir, builddir, self.subdir,
  2428. self.environment.get_build_command() + ['introspect'],
  2429. in_builddir=in_builddir, check=check, capture=capture)
  2430. @stringArgs
  2431. def func_gettext(self, nodes, args, kwargs):
  2432. raise InterpreterException('Gettext() function has been moved to module i18n. Import it and use i18n.gettext() instead')
  2433. def func_option(self, nodes, args, kwargs):
  2434. raise InterpreterException('Tried to call option() in build description file. All options must be in the option file.')
  2435. @FeatureNewKwargs('subproject', '0.38.0', ['default_options'])
  2436. @permittedKwargs(permitted_kwargs['subproject'])
  2437. @stringArgs
  2438. def func_subproject(self, nodes, args, kwargs):
  2439. if len(args) != 1:
  2440. raise InterpreterException('Subproject takes exactly one argument')
  2441. dirname = args[0]
  2442. return self.do_subproject(dirname, 'meson', kwargs)
  2443. def disabled_subproject(self, dirname, disabled_feature=None, exception=None):
  2444. sub = SubprojectHolder(None, self.subproject_dir, dirname,
  2445. disabled_feature=disabled_feature, exception=exception)
  2446. self.subprojects[dirname] = sub
  2447. return sub
  2448. def do_subproject(self, dirname: str, method: str, kwargs):
  2449. disabled, required, feature = extract_required_kwarg(kwargs, self.subproject)
  2450. if disabled:
  2451. mlog.log('Subproject', mlog.bold(dirname), ':', 'skipped: feature', mlog.bold(feature), 'disabled')
  2452. return self.disabled_subproject(dirname, disabled_feature=feature)
  2453. default_options = mesonlib.stringlistify(kwargs.get('default_options', []))
  2454. default_options = coredata.create_options_dict(default_options)
  2455. if dirname == '':
  2456. raise InterpreterException('Subproject dir name must not be empty.')
  2457. if dirname[0] == '.':
  2458. raise InterpreterException('Subproject dir name must not start with a period.')
  2459. if '..' in dirname:
  2460. raise InterpreterException('Subproject name must not contain a ".." path segment.')
  2461. if os.path.isabs(dirname):
  2462. raise InterpreterException('Subproject name must not be an absolute path.')
  2463. if has_path_sep(dirname):
  2464. mlog.warning('Subproject name has a path separator. This may cause unexpected behaviour.',
  2465. location=self.current_node)
  2466. if dirname in self.subproject_stack:
  2467. fullstack = self.subproject_stack + [dirname]
  2468. incpath = ' => '.join(fullstack)
  2469. raise InvalidCode('Recursive include of subprojects: %s.' % incpath)
  2470. if dirname in self.subprojects:
  2471. subproject = self.subprojects[dirname]
  2472. if required and not subproject.found():
  2473. raise InterpreterException('Subproject "%s/%s" required but not found.' % (
  2474. self.subproject_dir, dirname))
  2475. return subproject
  2476. subproject_dir_abs = os.path.join(self.environment.get_source_dir(), self.subproject_dir)
  2477. r = wrap.Resolver(subproject_dir_abs, self.coredata.get_builtin_option('wrap_mode'))
  2478. try:
  2479. resolved = r.resolve(dirname, method)
  2480. except wrap.WrapException as e:
  2481. subprojdir = os.path.join(self.subproject_dir, r.directory)
  2482. if isinstance(e, wrap.WrapNotFoundException):
  2483. # if the reason subproject execution failed was because
  2484. # the directory doesn't exist, try to give some helpful
  2485. # advice if it's a nested subproject that needs
  2486. # promotion...
  2487. self.print_nested_info(dirname)
  2488. if not required:
  2489. mlog.log(e)
  2490. mlog.log('Subproject ', mlog.bold(subprojdir), 'is buildable:', mlog.red('NO'), '(disabling)')
  2491. return self.disabled_subproject(dirname, exception=e)
  2492. raise e
  2493. subdir = os.path.join(self.subproject_dir, resolved)
  2494. subdir_abs = os.path.join(subproject_dir_abs, resolved)
  2495. os.makedirs(os.path.join(self.build.environment.get_build_dir(), subdir), exist_ok=True)
  2496. self.global_args_frozen = True
  2497. mlog.log()
  2498. with mlog.nested():
  2499. mlog.log('Executing subproject', mlog.bold(dirname), 'method', mlog.bold(method), '\n')
  2500. try:
  2501. if method == 'meson':
  2502. return self._do_subproject_meson(dirname, subdir, default_options, kwargs)
  2503. elif method == 'cmake':
  2504. return self._do_subproject_cmake(dirname, subdir, subdir_abs, default_options, kwargs)
  2505. else:
  2506. raise InterpreterException('The method {} is invalid for the subproject {}'.format(method, dirname))
  2507. # Invalid code is always an error
  2508. except InvalidCode:
  2509. raise
  2510. except Exception as e:
  2511. if not required:
  2512. with mlog.nested():
  2513. # Suppress the 'ERROR:' prefix because this exception is not
  2514. # fatal and VS CI treat any logs with "ERROR:" as fatal.
  2515. mlog.exception(e, prefix=mlog.yellow('Exception:'))
  2516. mlog.log('\nSubproject', mlog.bold(dirname), 'is buildable:', mlog.red('NO'), '(disabling)')
  2517. return self.disabled_subproject(dirname, exception=e)
  2518. raise e
  2519. def _do_subproject_meson(self, dirname, subdir, default_options, kwargs, ast=None, build_def_files=None):
  2520. with mlog.nested():
  2521. new_build = self.build.copy()
  2522. subi = Interpreter(new_build, self.backend, dirname, subdir, self.subproject_dir,
  2523. self.modules, default_options, ast=ast)
  2524. subi.subprojects = self.subprojects
  2525. subi.subproject_stack = self.subproject_stack + [dirname]
  2526. current_active = self.active_projectname
  2527. current_warnings_counter = mlog.log_warnings_counter
  2528. mlog.log_warnings_counter = 0
  2529. subi.run()
  2530. subi_warnings = mlog.log_warnings_counter
  2531. mlog.log_warnings_counter = current_warnings_counter
  2532. mlog.log('Subproject', mlog.bold(dirname), 'finished.')
  2533. mlog.log()
  2534. if 'version' in kwargs:
  2535. pv = subi.project_version
  2536. wanted = kwargs['version']
  2537. if pv == 'undefined' or not mesonlib.version_compare_many(pv, wanted)[0]:
  2538. raise InterpreterException('Subproject %s version is %s but %s required.' % (dirname, pv, wanted))
  2539. self.active_projectname = current_active
  2540. self.subprojects.update(subi.subprojects)
  2541. self.subprojects[dirname] = SubprojectHolder(subi, self.subproject_dir, dirname,
  2542. warnings=subi_warnings)
  2543. # Duplicates are possible when subproject uses files from project root
  2544. if build_def_files:
  2545. self.build_def_files = list(set(self.build_def_files + build_def_files))
  2546. else:
  2547. self.build_def_files = list(set(self.build_def_files + subi.build_def_files))
  2548. self.build.merge(subi.build)
  2549. self.build.subprojects[dirname] = subi.project_version
  2550. self.summary.update(subi.summary)
  2551. return self.subprojects[dirname]
  2552. def _do_subproject_cmake(self, dirname, subdir, subdir_abs, default_options, kwargs):
  2553. with mlog.nested():
  2554. new_build = self.build.copy()
  2555. prefix = self.coredata.builtins['prefix'].value
  2556. cmake_options = mesonlib.stringlistify(kwargs.get('cmake_options', []))
  2557. cm_int = CMakeInterpreter(new_build, subdir, subdir_abs, prefix, new_build.environment, self.backend)
  2558. cm_int.initialise(cmake_options)
  2559. cm_int.analyse()
  2560. # Generate a meson ast and execute it with the normal do_subproject_meson
  2561. ast = cm_int.pretend_to_be_meson()
  2562. mlog.log()
  2563. with mlog.nested():
  2564. mlog.log('Processing generated meson AST')
  2565. # Debug print the generated meson file
  2566. from .ast import AstIndentationGenerator, AstPrinter
  2567. printer = AstPrinter()
  2568. ast.accept(AstIndentationGenerator())
  2569. ast.accept(printer)
  2570. printer.post_process()
  2571. meson_filename = os.path.join(self.build.environment.get_build_dir(), subdir, 'meson.build')
  2572. with open(meson_filename, "w") as f:
  2573. f.write(printer.result)
  2574. mlog.log('Build file:', meson_filename)
  2575. mlog.cmd_ci_include(meson_filename)
  2576. mlog.log()
  2577. result = self._do_subproject_meson(dirname, subdir, default_options, kwargs, ast, cm_int.bs_files)
  2578. result.cm_interpreter = cm_int
  2579. mlog.log()
  2580. return result
  2581. def get_option_internal(self, optname):
  2582. raw_optname = optname
  2583. if self.is_subproject():
  2584. optname = self.subproject + ':' + optname
  2585. for opts in [
  2586. self.coredata.base_options, compilers.base_options, self.coredata.builtins,
  2587. dict(self.coredata.get_prefixed_options_per_machine(self.coredata.builtins_per_machine)),
  2588. dict(self.coredata.flatten_lang_iterator(
  2589. self.coredata.get_prefixed_options_per_machine(self.coredata.compiler_options))),
  2590. ]:
  2591. v = opts.get(optname)
  2592. if v is None or v.yielding:
  2593. v = opts.get(raw_optname)
  2594. if v is not None:
  2595. return v
  2596. try:
  2597. opt = self.coredata.user_options[optname]
  2598. if opt.yielding and ':' in optname and raw_optname in self.coredata.user_options:
  2599. popt = self.coredata.user_options[raw_optname]
  2600. if type(opt) is type(popt):
  2601. opt = popt
  2602. else:
  2603. # Get class name, then option type as a string
  2604. opt_type = opt.__class__.__name__[4:][:-6].lower()
  2605. popt_type = popt.__class__.__name__[4:][:-6].lower()
  2606. # This is not a hard error to avoid dependency hell, the workaround
  2607. # when this happens is to simply set the subproject's option directly.
  2608. mlog.warning('Option {0!r} of type {1!r} in subproject {2!r} cannot yield '
  2609. 'to parent option of type {3!r}, ignoring parent value. '
  2610. 'Use -D{2}:{0}=value to set the value for this option manually'
  2611. '.'.format(raw_optname, opt_type, self.subproject, popt_type),
  2612. location=self.current_node)
  2613. return opt
  2614. except KeyError:
  2615. pass
  2616. raise InterpreterException('Tried to access unknown option "%s".' % optname)
  2617. @stringArgs
  2618. @noKwargs
  2619. def func_get_option(self, nodes, args, kwargs):
  2620. if len(args) != 1:
  2621. raise InterpreterException('Argument required for get_option.')
  2622. optname = args[0]
  2623. if ':' in optname:
  2624. raise InterpreterException('Having a colon in option name is forbidden, '
  2625. 'projects are not allowed to directly access '
  2626. 'options of other subprojects.')
  2627. opt = self.get_option_internal(optname)
  2628. if isinstance(opt, coredata.UserFeatureOption):
  2629. return FeatureOptionHolder(self.environment, optname, opt)
  2630. elif isinstance(opt, coredata.UserOption):
  2631. return opt.value
  2632. return opt
  2633. @noKwargs
  2634. def func_configuration_data(self, node, args, kwargs):
  2635. if len(args) > 1:
  2636. raise InterpreterException('configuration_data takes only one optional positional arguments')
  2637. elif len(args) == 1:
  2638. FeatureNew('configuration_data dictionary', '0.49.0').use(self.subproject)
  2639. initial_values = args[0]
  2640. if not isinstance(initial_values, dict):
  2641. raise InterpreterException('configuration_data first argument must be a dictionary')
  2642. else:
  2643. initial_values = {}
  2644. return ConfigurationDataHolder(self.subproject, initial_values)
  2645. def set_backend(self):
  2646. # The backend is already set when parsing subprojects
  2647. if self.backend is not None:
  2648. return
  2649. backend = self.coredata.get_builtin_option('backend')
  2650. from .backend import backends
  2651. self.backend = backends.get_backend_from_name(backend, self.build, self)
  2652. if self.backend is None:
  2653. raise InterpreterException('Unknown backend "%s".' % backend)
  2654. if backend != self.backend.name:
  2655. if self.backend.name.startswith('vs'):
  2656. mlog.log('Auto detected Visual Studio backend:', mlog.bold(self.backend.name))
  2657. self.coredata.set_builtin_option('backend', self.backend.name)
  2658. # Only init backend options on first invocation otherwise it would
  2659. # override values previously set from command line.
  2660. if self.environment.first_invocation:
  2661. self.coredata.init_backend_options(backend)
  2662. options = {k: v for k, v in self.environment.cmd_line_options.items() if k.startswith('backend_')}
  2663. self.coredata.set_options(options)
  2664. @stringArgs
  2665. @permittedKwargs(permitted_kwargs['project'])
  2666. def func_project(self, node, args, kwargs):
  2667. if len(args) < 1:
  2668. raise InvalidArguments('Not enough arguments to project(). Needs at least the project name.')
  2669. proj_name, *proj_langs = args
  2670. if ':' in proj_name:
  2671. raise InvalidArguments("Project name {!r} must not contain ':'".format(proj_name))
  2672. if 'meson_version' in kwargs:
  2673. cv = coredata.version
  2674. pv = kwargs['meson_version']
  2675. if not mesonlib.version_compare(cv, pv):
  2676. raise InterpreterException('Meson version is %s but project requires %s' % (cv, pv))
  2677. if os.path.exists(self.option_file):
  2678. oi = optinterpreter.OptionInterpreter(self.subproject)
  2679. oi.process(self.option_file)
  2680. self.coredata.merge_user_options(oi.options)
  2681. self.add_build_def_file(self.option_file)
  2682. # Do not set default_options on reconfigure otherwise it would override
  2683. # values previously set from command line. That means that changing
  2684. # default_options in a project will trigger a reconfigure but won't
  2685. # have any effect.
  2686. self.project_default_options = mesonlib.stringlistify(kwargs.get('default_options', []))
  2687. self.project_default_options = coredata.create_options_dict(self.project_default_options)
  2688. if self.environment.first_invocation:
  2689. default_options = self.project_default_options
  2690. default_options.update(self.default_project_options)
  2691. self.coredata.init_builtins(self.subproject)
  2692. else:
  2693. default_options = {}
  2694. self.coredata.set_default_options(default_options, self.subproject, self.environment)
  2695. if not self.is_subproject():
  2696. self.build.project_name = proj_name
  2697. self.active_projectname = proj_name
  2698. self.project_version = kwargs.get('version', 'undefined')
  2699. if self.build.project_version is None:
  2700. self.build.project_version = self.project_version
  2701. proj_license = mesonlib.stringlistify(kwargs.get('license', 'unknown'))
  2702. self.build.dep_manifest[proj_name] = {'version': self.project_version,
  2703. 'license': proj_license}
  2704. if self.subproject in self.build.projects:
  2705. raise InvalidCode('Second call to project().')
  2706. if not self.is_subproject() and 'subproject_dir' in kwargs:
  2707. spdirname = kwargs['subproject_dir']
  2708. if not isinstance(spdirname, str):
  2709. raise InterpreterException('Subproject_dir must be a string')
  2710. if os.path.isabs(spdirname):
  2711. raise InterpreterException('Subproject_dir must not be an absolute path.')
  2712. if spdirname.startswith('.'):
  2713. raise InterpreterException('Subproject_dir must not begin with a period.')
  2714. if '..' in spdirname:
  2715. raise InterpreterException('Subproject_dir must not contain a ".." segment.')
  2716. self.subproject_dir = spdirname
  2717. self.build.subproject_dir = self.subproject_dir
  2718. mesonlib.project_meson_versions[self.subproject] = ''
  2719. if 'meson_version' in kwargs:
  2720. mesonlib.project_meson_versions[self.subproject] = kwargs['meson_version']
  2721. self.build.projects[self.subproject] = proj_name
  2722. mlog.log('Project name:', mlog.bold(proj_name))
  2723. mlog.log('Project version:', mlog.bold(self.project_version))
  2724. self.add_languages(proj_langs, True, MachineChoice.BUILD)
  2725. self.add_languages(proj_langs, True, MachineChoice.HOST)
  2726. self.set_backend()
  2727. if not self.is_subproject():
  2728. self.check_stdlibs()
  2729. @FeatureNewKwargs('add_languages', '0.54.0', ['native'])
  2730. @permittedKwargs(permitted_kwargs['add_languages'])
  2731. @stringArgs
  2732. def func_add_languages(self, node, args, kwargs):
  2733. disabled, required, feature = extract_required_kwarg(kwargs, self.subproject)
  2734. if disabled:
  2735. for lang in sorted(args, key=compilers.sort_clink):
  2736. mlog.log('Compiler for language', mlog.bold(lang), 'skipped: feature', mlog.bold(feature), 'disabled')
  2737. return False
  2738. if 'native' in kwargs:
  2739. return self.add_languages(args, required, self.machine_from_native_kwarg(kwargs))
  2740. else:
  2741. # absent 'native' means 'both' for backwards compatibility
  2742. mlog.warning('add_languages is missing native:, assuming languages are wanted for both host and build.',
  2743. location=self.current_node)
  2744. success = self.add_languages(args, False, MachineChoice.BUILD)
  2745. success &= self.add_languages(args, required, MachineChoice.HOST)
  2746. return success
  2747. def get_message_string_arg(self, arg):
  2748. if isinstance(arg, list):
  2749. argstr = stringifyUserArguments(arg)
  2750. elif isinstance(arg, dict):
  2751. argstr = stringifyUserArguments(arg)
  2752. elif isinstance(arg, str):
  2753. argstr = arg
  2754. elif isinstance(arg, int):
  2755. argstr = str(arg)
  2756. else:
  2757. raise InvalidArguments('Function accepts only strings, integers, lists and lists thereof.')
  2758. return argstr
  2759. @noArgsFlattening
  2760. @noKwargs
  2761. def func_message(self, node, args, kwargs):
  2762. if len(args) > 1:
  2763. FeatureNew('message with more than one argument', '0.54.0').use(self.subproject)
  2764. args_str = [self.get_message_string_arg(i) for i in args]
  2765. self.message_impl(args_str)
  2766. def message_impl(self, args):
  2767. mlog.log(mlog.bold('Message:'), *args)
  2768. @noArgsFlattening
  2769. @FeatureNewKwargs('summary', '0.54.0', ['list_sep'])
  2770. @permittedKwargs({'section', 'bool_yn', 'list_sep'})
  2771. @FeatureNew('summary', '0.53.0')
  2772. def func_summary(self, node, args, kwargs):
  2773. if len(args) == 1:
  2774. if not isinstance(args[0], dict):
  2775. raise InterpreterException('Summary first argument must be dictionary.')
  2776. values = args[0]
  2777. elif len(args) == 2:
  2778. if not isinstance(args[0], str):
  2779. raise InterpreterException('Summary first argument must be string.')
  2780. values = {args[0]: args[1]}
  2781. else:
  2782. raise InterpreterException('Summary accepts at most 2 arguments.')
  2783. section = kwargs.get('section', '')
  2784. if not isinstance(section, str):
  2785. raise InterpreterException('Summary\'s section keyword argument must be string.')
  2786. self.summary_impl(section, values, kwargs)
  2787. def summary_impl(self, section, values, kwargs):
  2788. if self.subproject not in self.summary:
  2789. self.summary[self.subproject] = Summary(self.active_projectname, self.project_version)
  2790. self.summary[self.subproject].add_section(section, values, kwargs)
  2791. def _print_summary(self):
  2792. # Add automatic 'Supbrojects' section in main project.
  2793. all_subprojects = collections.OrderedDict()
  2794. for name, subp in sorted(self.subprojects.items()):
  2795. value = subp.found()
  2796. if subp.disabled_feature:
  2797. value = [value, 'Feature {!r} disabled'.format(subp.disabled_feature)]
  2798. elif subp.exception:
  2799. value = [value, str(subp.exception)]
  2800. elif subp.warnings > 0:
  2801. value = [value, '{} warnings'.format(subp.warnings)]
  2802. all_subprojects[name] = value
  2803. if all_subprojects:
  2804. self.summary_impl('Subprojects', all_subprojects,
  2805. {'bool_yn': True,
  2806. 'list_sep': ' ',
  2807. })
  2808. # Print all summaries, main project last.
  2809. mlog.log('') # newline
  2810. main_summary = self.summary.pop('', None)
  2811. for _, summary in sorted(self.summary.items()):
  2812. summary.dump()
  2813. if main_summary:
  2814. main_summary.dump()
  2815. @noArgsFlattening
  2816. @FeatureNew('warning', '0.44.0')
  2817. @noKwargs
  2818. def func_warning(self, node, args, kwargs):
  2819. if len(args) > 1:
  2820. FeatureNew('warning with more than one argument', '0.54.0').use(self.subproject)
  2821. args_str = [self.get_message_string_arg(i) for i in args]
  2822. mlog.warning(*args_str, location=node)
  2823. @noKwargs
  2824. def func_error(self, node, args, kwargs):
  2825. self.validate_arguments(args, 1, [str])
  2826. raise InterpreterException('Problem encountered: ' + args[0])
  2827. @noKwargs
  2828. def func_exception(self, node, args, kwargs):
  2829. self.validate_arguments(args, 0, [])
  2830. raise Exception()
  2831. def add_languages(self, args: T.Sequence[str], required: bool, for_machine: MachineChoice) -> bool:
  2832. success = self.add_languages_for(args, required, for_machine)
  2833. if not self.coredata.is_cross_build():
  2834. self.coredata.copy_build_options_from_regular_ones()
  2835. self._redetect_machines()
  2836. return success
  2837. def should_skip_sanity_check(self, for_machine: MachineChoice) -> bool:
  2838. if for_machine != MachineChoice.HOST:
  2839. return False
  2840. if not self.environment.is_cross_build():
  2841. return False
  2842. should = self.environment.properties.host.get('skip_sanity_check', False)
  2843. if not isinstance(should, bool):
  2844. raise InterpreterException('Option skip_sanity_check must be a boolean.')
  2845. return should
  2846. def add_languages_for(self, args, required, for_machine: MachineChoice):
  2847. success = True
  2848. for lang in sorted(args, key=compilers.sort_clink):
  2849. lang = lang.lower()
  2850. clist = self.coredata.compilers[for_machine]
  2851. machine_name = for_machine.get_lower_case_name()
  2852. if lang in clist:
  2853. comp = clist[lang]
  2854. else:
  2855. try:
  2856. comp = self.environment.detect_compiler_for(lang, for_machine)
  2857. if comp is None:
  2858. raise InvalidArguments('Tried to use unknown language "%s".' % lang)
  2859. if self.should_skip_sanity_check(for_machine):
  2860. mlog.log_once('Cross compiler sanity tests disabled via the cross file.')
  2861. else:
  2862. comp.sanity_check(self.environment.get_scratch_dir(), self.environment)
  2863. except Exception:
  2864. if not required:
  2865. mlog.log('Compiler for language',
  2866. mlog.bold(lang), 'for the', machine_name,
  2867. 'machine not found.')
  2868. success = False
  2869. continue
  2870. else:
  2871. raise
  2872. if for_machine == MachineChoice.HOST or self.environment.is_cross_build():
  2873. logger_fun = mlog.log
  2874. else:
  2875. logger_fun = mlog.debug
  2876. logger_fun(comp.get_display_language(), 'compiler for the', machine_name, 'machine:',
  2877. mlog.bold(' '.join(comp.get_exelist())), comp.get_version_string())
  2878. if comp.linker is not None:
  2879. logger_fun(comp.get_display_language(), 'linker for the', machine_name, 'machine:',
  2880. mlog.bold(' '.join(comp.linker.get_exelist())), comp.linker.id, comp.linker.version)
  2881. self.build.ensure_static_linker(comp)
  2882. langs = self.coredata.compilers[for_machine].keys()
  2883. if 'vala' in langs:
  2884. if 'c' not in langs:
  2885. raise InterpreterException('Compiling Vala requires C. Add C to your project languages and rerun Meson.')
  2886. return success
  2887. def program_from_file_for(self, for_machine, prognames, silent):
  2888. for p in unholder(prognames):
  2889. if isinstance(p, mesonlib.File):
  2890. continue # Always points to a local (i.e. self generated) file.
  2891. if not isinstance(p, str):
  2892. raise InterpreterException('Executable name must be a string')
  2893. prog = ExternalProgram.from_bin_list(self.environment, for_machine, p)
  2894. if prog.found():
  2895. return ExternalProgramHolder(prog, self.subproject)
  2896. return None
  2897. def program_from_system(self, args, search_dirs, silent=False):
  2898. # Search for scripts relative to current subdir.
  2899. # Do not cache found programs because find_program('foobar')
  2900. # might give different results when run from different source dirs.
  2901. source_dir = os.path.join(self.environment.get_source_dir(), self.subdir)
  2902. for exename in args:
  2903. if isinstance(exename, mesonlib.File):
  2904. if exename.is_built:
  2905. search_dir = os.path.join(self.environment.get_build_dir(),
  2906. exename.subdir)
  2907. else:
  2908. search_dir = os.path.join(self.environment.get_source_dir(),
  2909. exename.subdir)
  2910. exename = exename.fname
  2911. extra_search_dirs = []
  2912. elif isinstance(exename, str):
  2913. search_dir = source_dir
  2914. extra_search_dirs = search_dirs
  2915. else:
  2916. raise InvalidArguments('find_program only accepts strings and '
  2917. 'files, not {!r}'.format(exename))
  2918. extprog = dependencies.ExternalProgram(exename, search_dir=search_dir,
  2919. extra_search_dirs=extra_search_dirs,
  2920. silent=silent)
  2921. progobj = ExternalProgramHolder(extprog, self.subproject)
  2922. if progobj.found():
  2923. return progobj
  2924. def program_from_overrides(self, command_names, silent=False):
  2925. for name in command_names:
  2926. if not isinstance(name, str):
  2927. continue
  2928. if name in self.build.find_overrides:
  2929. exe = self.build.find_overrides[name]
  2930. if not silent:
  2931. mlog.log('Program', mlog.bold(name), 'found:', mlog.green('YES'),
  2932. '(overridden: %s)' % exe.description())
  2933. return ExternalProgramHolder(exe, self.subproject, self.backend)
  2934. return None
  2935. def store_name_lookups(self, command_names):
  2936. for name in command_names:
  2937. if isinstance(name, str):
  2938. self.build.searched_programs.add(name)
  2939. def add_find_program_override(self, name, exe):
  2940. if name in self.build.searched_programs:
  2941. raise InterpreterException('Tried to override finding of executable "%s" which has already been found.'
  2942. % name)
  2943. if name in self.build.find_overrides:
  2944. raise InterpreterException('Tried to override executable "%s" which has already been overridden.'
  2945. % name)
  2946. self.build.find_overrides[name] = exe
  2947. # TODO update modules to always pass `for_machine`. It is bad-form to assume
  2948. # the host machine.
  2949. def find_program_impl(self, args, for_machine: MachineChoice = MachineChoice.HOST,
  2950. required=True, silent=True, wanted='', search_dirs=None):
  2951. if not isinstance(args, list):
  2952. args = [args]
  2953. progobj = self.program_from_overrides(args, silent=silent)
  2954. if progobj is None:
  2955. progobj = self.program_from_file_for(for_machine, args, silent=silent)
  2956. if progobj is None:
  2957. progobj = self.program_from_system(args, search_dirs, silent=silent)
  2958. if progobj is None and args[0].endswith('python3'):
  2959. prog = dependencies.ExternalProgram('python3', mesonlib.python_command, silent=True)
  2960. progobj = ExternalProgramHolder(prog, self.subproject)
  2961. if required and (progobj is None or not progobj.found()):
  2962. raise InvalidArguments('Program(s) {!r} not found or not executable'.format(args))
  2963. if progobj is None:
  2964. return ExternalProgramHolder(dependencies.NonExistingExternalProgram(' '.join(args)), self.subproject)
  2965. # Only store successful lookups
  2966. self.store_name_lookups(args)
  2967. if wanted:
  2968. version = progobj.get_version(self)
  2969. is_found, not_found, found = mesonlib.version_compare_many(version, wanted)
  2970. if not is_found:
  2971. mlog.log('Program', mlog.bold(progobj.get_name()), 'found:', mlog.red('NO'),
  2972. 'found {!r} but need:'.format(version),
  2973. ', '.join(["'{}'".format(e) for e in not_found]))
  2974. if required:
  2975. m = 'Invalid version of program, need {!r} {!r} found {!r}.'
  2976. raise InvalidArguments(m.format(progobj.get_name(), not_found, version))
  2977. return ExternalProgramHolder(dependencies.NonExistingExternalProgram(' '.join(args)), self.subproject)
  2978. return progobj
  2979. @FeatureNewKwargs('find_program', '0.53.0', ['dirs'])
  2980. @FeatureNewKwargs('find_program', '0.52.0', ['version'])
  2981. @FeatureNewKwargs('find_program', '0.49.0', ['disabler'])
  2982. @disablerIfNotFound
  2983. @permittedKwargs(permitted_kwargs['find_program'])
  2984. def func_find_program(self, node, args, kwargs):
  2985. if not args:
  2986. raise InterpreterException('No program name specified.')
  2987. disabled, required, feature = extract_required_kwarg(kwargs, self.subproject)
  2988. if disabled:
  2989. mlog.log('Program', mlog.bold(' '.join(args)), 'skipped: feature', mlog.bold(feature), 'disabled')
  2990. return ExternalProgramHolder(dependencies.NonExistingExternalProgram(' '.join(args)), self.subproject)
  2991. search_dirs = extract_search_dirs(kwargs)
  2992. wanted = mesonlib.stringlistify(kwargs.get('version', []))
  2993. for_machine = self.machine_from_native_kwarg(kwargs)
  2994. return self.find_program_impl(args, for_machine, required=required,
  2995. silent=False, wanted=wanted,
  2996. search_dirs=search_dirs)
  2997. def func_find_library(self, node, args, kwargs):
  2998. raise InvalidCode('find_library() is removed, use meson.get_compiler(\'name\').find_library() instead.\n'
  2999. 'Look here for documentation: http://mesonbuild.com/Reference-manual.html#compiler-object\n'
  3000. 'Look here for example: http://mesonbuild.com/howtox.html#add-math-library-lm-portably\n'
  3001. )
  3002. def _find_cached_dep(self, name, display_name, kwargs):
  3003. # Check if we want this as a build-time / build machine or runt-time /
  3004. # host machine dep.
  3005. for_machine = self.machine_from_native_kwarg(kwargs)
  3006. identifier = dependencies.get_dep_identifier(name, kwargs)
  3007. wanted_vers = mesonlib.stringlistify(kwargs.get('version', []))
  3008. override = self.build.dependency_overrides[for_machine].get(identifier)
  3009. if override:
  3010. info = [mlog.blue('(overridden)' if override.explicit else '(cached)')]
  3011. cached_dep = override.dep
  3012. # We don't implicitly override not-found dependencies, but user could
  3013. # have explicitly called meson.override_dependency() with a not-found
  3014. # dep.
  3015. if not cached_dep.found():
  3016. mlog.log('Dependency', mlog.bold(display_name),
  3017. 'found:', mlog.red('NO'), *info)
  3018. return identifier, cached_dep
  3019. found_vers = cached_dep.get_version()
  3020. if not self.check_version(wanted_vers, found_vers):
  3021. mlog.log('Dependency', mlog.bold(name),
  3022. 'found:', mlog.red('NO'),
  3023. 'found', mlog.normal_cyan(found_vers), 'but need:',
  3024. mlog.bold(', '.join(["'{}'".format(e) for e in wanted_vers])),
  3025. *info)
  3026. return identifier, NotFoundDependency(self.environment)
  3027. else:
  3028. info = [mlog.blue('(cached)')]
  3029. cached_dep = self.coredata.deps[for_machine].get(identifier)
  3030. if cached_dep:
  3031. found_vers = cached_dep.get_version()
  3032. if not self.check_version(wanted_vers, found_vers):
  3033. return identifier, None
  3034. if cached_dep:
  3035. if found_vers:
  3036. info = [mlog.normal_cyan(found_vers), *info]
  3037. mlog.log('Dependency', mlog.bold(display_name),
  3038. 'found:', mlog.green('YES'), *info)
  3039. return identifier, cached_dep
  3040. return identifier, None
  3041. @staticmethod
  3042. def check_version(wanted, found):
  3043. if not wanted:
  3044. return True
  3045. if found == 'undefined' or not mesonlib.version_compare_many(found, wanted)[0]:
  3046. return False
  3047. return True
  3048. def notfound_dependency(self):
  3049. return DependencyHolder(NotFoundDependency(self.environment), self.subproject)
  3050. def verify_fallback_consistency(self, dirname, varname, cached_dep):
  3051. subi = self.subprojects.get(dirname)
  3052. if not cached_dep or not varname or not subi or not cached_dep.found():
  3053. return
  3054. dep = subi.get_variable_method([varname], {})
  3055. if dep.held_object != cached_dep:
  3056. m = 'Inconsistency: Subproject has overridden the dependency with another variable than {!r}'
  3057. raise DependencyException(m.format(varname))
  3058. def get_subproject_dep(self, name, display_name, dirname, varname, kwargs):
  3059. required = kwargs.get('required', True)
  3060. wanted = mesonlib.stringlistify(kwargs.get('version', []))
  3061. subproj_path = os.path.join(self.subproject_dir, dirname)
  3062. dep = self.notfound_dependency()
  3063. try:
  3064. subproject = self.subprojects[dirname]
  3065. _, cached_dep = self._find_cached_dep(name, display_name, kwargs)
  3066. if varname is None:
  3067. # Assuming the subproject overridden the dependency we want
  3068. if cached_dep:
  3069. if required and not cached_dep.found():
  3070. m = 'Dependency {!r} is not satisfied'
  3071. raise DependencyException(m.format(display_name))
  3072. return DependencyHolder(cached_dep, self.subproject)
  3073. else:
  3074. m = 'Subproject {} did not override dependency {}'
  3075. raise DependencyException(m.format(subproj_path, display_name))
  3076. if subproject.found():
  3077. self.verify_fallback_consistency(dirname, varname, cached_dep)
  3078. dep = self.subprojects[dirname].get_variable_method([varname], {})
  3079. except InvalidArguments:
  3080. pass
  3081. if not isinstance(dep, DependencyHolder):
  3082. raise InvalidCode('Fetched variable {!r} in the subproject {!r} is '
  3083. 'not a dependency object.'.format(varname, dirname))
  3084. if not dep.found():
  3085. if required:
  3086. raise DependencyException('Could not find dependency {} in subproject {}'
  3087. ''.format(varname, dirname))
  3088. # If the dependency is not required, don't raise an exception
  3089. mlog.log('Dependency', mlog.bold(display_name), 'from subproject',
  3090. mlog.bold(subproj_path), 'found:', mlog.red('NO'))
  3091. return dep
  3092. found = dep.held_object.get_version()
  3093. if not self.check_version(wanted, found):
  3094. if required:
  3095. raise DependencyException('Version {} of subproject dependency {} already '
  3096. 'cached, requested incompatible version {} for '
  3097. 'dep {}'.format(found, dirname, wanted, display_name))
  3098. mlog.log('Dependency', mlog.bold(display_name), 'from subproject',
  3099. mlog.bold(subproj_path), 'found:', mlog.red('NO'),
  3100. 'found', mlog.normal_cyan(found), 'but need:',
  3101. mlog.bold(', '.join(["'{}'".format(e) for e in wanted])))
  3102. return self.notfound_dependency()
  3103. found = mlog.normal_cyan(found) if found else None
  3104. mlog.log('Dependency', mlog.bold(display_name), 'from subproject',
  3105. mlog.bold(subproj_path), 'found:', mlog.green('YES'), found)
  3106. return dep
  3107. def _handle_featurenew_dependencies(self, name):
  3108. 'Do a feature check on dependencies used by this subproject'
  3109. if name == 'mpi':
  3110. FeatureNew('MPI Dependency', '0.42.0').use(self.subproject)
  3111. elif name == 'pcap':
  3112. FeatureNew('Pcap Dependency', '0.42.0').use(self.subproject)
  3113. elif name == 'vulkan':
  3114. FeatureNew('Vulkan Dependency', '0.42.0').use(self.subproject)
  3115. elif name == 'libwmf':
  3116. FeatureNew('LibWMF Dependency', '0.44.0').use(self.subproject)
  3117. elif name == 'openmp':
  3118. FeatureNew('OpenMP Dependency', '0.46.0').use(self.subproject)
  3119. @FeatureNewKwargs('dependency', '0.54.0', ['components'])
  3120. @FeatureNewKwargs('dependency', '0.52.0', ['include_type'])
  3121. @FeatureNewKwargs('dependency', '0.50.0', ['not_found_message', 'cmake_module_path', 'cmake_args'])
  3122. @FeatureNewKwargs('dependency', '0.49.0', ['disabler'])
  3123. @FeatureNewKwargs('dependency', '0.40.0', ['method'])
  3124. @FeatureNewKwargs('dependency', '0.38.0', ['default_options'])
  3125. @disablerIfNotFound
  3126. @permittedKwargs(permitted_kwargs['dependency'])
  3127. def func_dependency(self, node, args, kwargs):
  3128. self.validate_arguments(args, 1, [str])
  3129. name = args[0]
  3130. display_name = name if name else '(anonymous)'
  3131. mods = extract_as_list(kwargs, 'modules')
  3132. if mods:
  3133. display_name += ' (modules: {})'.format(', '.join(str(i) for i in mods))
  3134. not_found_message = kwargs.get('not_found_message', '')
  3135. if not isinstance(not_found_message, str):
  3136. raise InvalidArguments('The not_found_message must be a string.')
  3137. try:
  3138. d = self.dependency_impl(name, display_name, kwargs)
  3139. except Exception:
  3140. if not_found_message:
  3141. self.message_impl([not_found_message])
  3142. raise
  3143. if not d.found() and not_found_message:
  3144. self.message_impl([not_found_message])
  3145. self.message_impl([not_found_message])
  3146. # Override this dependency to have consistent results in subsequent
  3147. # dependency lookups.
  3148. if name and d.found():
  3149. for_machine = self.machine_from_native_kwarg(kwargs)
  3150. identifier = dependencies.get_dep_identifier(name, kwargs)
  3151. if identifier not in self.build.dependency_overrides[for_machine]:
  3152. self.build.dependency_overrides[for_machine][identifier] = \
  3153. build.DependencyOverride(d.held_object, node, explicit=False)
  3154. return d
  3155. def dependency_impl(self, name, display_name, kwargs):
  3156. disabled, required, feature = extract_required_kwarg(kwargs, self.subproject)
  3157. if disabled:
  3158. mlog.log('Dependency', mlog.bold(display_name), 'skipped: feature', mlog.bold(feature), 'disabled')
  3159. return self.notfound_dependency()
  3160. has_fallback = 'fallback' in kwargs
  3161. if 'default_options' in kwargs and not has_fallback:
  3162. mlog.warning('The "default_options" keyworg argument does nothing without a "fallback" keyword argument.',
  3163. location=self.current_node)
  3164. # writing just "dependency('')" is an error, because it can only fail
  3165. if name == '' and required and not has_fallback:
  3166. raise InvalidArguments('Dependency is both required and not-found')
  3167. if '<' in name or '>' in name or '=' in name:
  3168. raise InvalidArguments('Characters <, > and = are forbidden in dependency names. To specify'
  3169. 'version\n requirements use the \'version\' keyword argument instead.')
  3170. identifier, cached_dep = self._find_cached_dep(name, display_name, kwargs)
  3171. if cached_dep:
  3172. if has_fallback:
  3173. dirname, varname = self.get_subproject_infos(kwargs)
  3174. self.verify_fallback_consistency(dirname, varname, cached_dep)
  3175. if required and not cached_dep.found():
  3176. m = 'Dependency {!r} was already checked and was not found'
  3177. raise DependencyException(m.format(display_name))
  3178. return DependencyHolder(cached_dep, self.subproject)
  3179. # If the dependency has already been configured, possibly by
  3180. # a higher level project, try to use it first.
  3181. if has_fallback:
  3182. dirname, varname = self.get_subproject_infos(kwargs)
  3183. if dirname in self.subprojects:
  3184. return self.get_subproject_dep(name, display_name, dirname, varname, kwargs)
  3185. wrap_mode = self.coredata.get_builtin_option('wrap_mode')
  3186. forcefallback = wrap_mode == WrapMode.forcefallback and has_fallback
  3187. if name != '' and not forcefallback:
  3188. self._handle_featurenew_dependencies(name)
  3189. kwargs['required'] = required and not has_fallback
  3190. dep = dependencies.find_external_dependency(name, self.environment, kwargs)
  3191. kwargs['required'] = required
  3192. # Only store found-deps in the cache
  3193. # Never add fallback deps to self.coredata.deps since we
  3194. # cannot cache them. They must always be evaluated else
  3195. # we won't actually read all the build files.
  3196. if dep.found():
  3197. for_machine = self.machine_from_native_kwarg(kwargs)
  3198. self.coredata.deps[for_machine].put(identifier, dep)
  3199. return DependencyHolder(dep, self.subproject)
  3200. if has_fallback:
  3201. return self.dependency_fallback(name, display_name, kwargs)
  3202. return self.notfound_dependency()
  3203. @FeatureNew('disabler', '0.44.0')
  3204. @noKwargs
  3205. @noPosargs
  3206. def func_disabler(self, node, args, kwargs):
  3207. return Disabler()
  3208. def print_nested_info(self, dependency_name):
  3209. message = ['Dependency', mlog.bold(dependency_name), 'not found but it is available in a sub-subproject.\n' +
  3210. 'To use it in the current project, promote it by going in the project source\n'
  3211. 'root and issuing']
  3212. sprojs = mesonlib.detect_subprojects('subprojects', self.source_root)
  3213. if dependency_name not in sprojs:
  3214. return
  3215. found = sprojs[dependency_name]
  3216. if len(found) > 1:
  3217. message.append('one of the following commands:')
  3218. else:
  3219. message.append('the following command:')
  3220. command_templ = '\nmeson wrap promote {}'
  3221. for l in found:
  3222. message.append(mlog.bold(command_templ.format(l[len(self.source_root) + 1:])))
  3223. mlog.warning(*message, location=self.current_node)
  3224. def get_subproject_infos(self, kwargs):
  3225. fbinfo = mesonlib.stringlistify(kwargs['fallback'])
  3226. if len(fbinfo) == 1:
  3227. FeatureNew('Fallback without variable name', '0.53.0').use(self.subproject)
  3228. return fbinfo[0], None
  3229. elif len(fbinfo) != 2:
  3230. raise InterpreterException('Fallback info must have one or two items.')
  3231. return fbinfo
  3232. def dependency_fallback(self, name, display_name, kwargs):
  3233. required = kwargs.get('required', True)
  3234. if self.coredata.get_builtin_option('wrap_mode') == WrapMode.nofallback:
  3235. mlog.log('Not looking for a fallback subproject for the dependency',
  3236. mlog.bold(display_name), 'because:\nUse of fallback '
  3237. 'dependencies is disabled.')
  3238. if required:
  3239. m = 'Dependency {!r} not found and fallback is disabled'
  3240. raise DependencyException(m.format(display_name))
  3241. return self.notfound_dependency()
  3242. elif self.coredata.get_builtin_option('wrap_mode') == WrapMode.forcefallback:
  3243. mlog.log('Looking for a fallback subproject for the dependency',
  3244. mlog.bold(display_name), 'because:\nUse of fallback dependencies is forced.')
  3245. else:
  3246. mlog.log('Looking for a fallback subproject for the dependency',
  3247. mlog.bold(display_name))
  3248. dirname, varname = self.get_subproject_infos(kwargs)
  3249. sp_kwargs = {
  3250. 'default_options': kwargs.get('default_options', []),
  3251. 'required': required,
  3252. }
  3253. self.do_subproject(dirname, 'meson', sp_kwargs)
  3254. return self.get_subproject_dep(name, display_name, dirname, varname, kwargs)
  3255. @FeatureNewKwargs('executable', '0.42.0', ['implib'])
  3256. @permittedKwargs(permitted_kwargs['executable'])
  3257. def func_executable(self, node, args, kwargs):
  3258. return self.build_target(node, args, kwargs, ExecutableHolder)
  3259. @permittedKwargs(permitted_kwargs['static_library'])
  3260. def func_static_lib(self, node, args, kwargs):
  3261. return self.build_target(node, args, kwargs, StaticLibraryHolder)
  3262. @permittedKwargs(permitted_kwargs['shared_library'])
  3263. def func_shared_lib(self, node, args, kwargs):
  3264. holder = self.build_target(node, args, kwargs, SharedLibraryHolder)
  3265. holder.held_object.shared_library_only = True
  3266. return holder
  3267. @permittedKwargs(permitted_kwargs['both_libraries'])
  3268. def func_both_lib(self, node, args, kwargs):
  3269. return self.build_both_libraries(node, args, kwargs)
  3270. @FeatureNew('shared_module', '0.37.0')
  3271. @permittedKwargs(permitted_kwargs['shared_module'])
  3272. def func_shared_module(self, node, args, kwargs):
  3273. return self.build_target(node, args, kwargs, SharedModuleHolder)
  3274. @permittedKwargs(permitted_kwargs['library'])
  3275. def func_library(self, node, args, kwargs):
  3276. return self.build_library(node, args, kwargs)
  3277. @permittedKwargs(permitted_kwargs['jar'])
  3278. def func_jar(self, node, args, kwargs):
  3279. return self.build_target(node, args, kwargs, JarHolder)
  3280. @FeatureNewKwargs('build_target', '0.40.0', ['link_whole', 'override_options'])
  3281. @permittedKwargs(permitted_kwargs['build_target'])
  3282. def func_build_target(self, node, args, kwargs):
  3283. if 'target_type' not in kwargs:
  3284. raise InterpreterException('Missing target_type keyword argument')
  3285. target_type = kwargs.pop('target_type')
  3286. if target_type == 'executable':
  3287. return self.build_target(node, args, kwargs, ExecutableHolder)
  3288. elif target_type == 'shared_library':
  3289. return self.build_target(node, args, kwargs, SharedLibraryHolder)
  3290. elif target_type == 'shared_module':
  3291. FeatureNew('build_target(target_type: \'shared_module\')',
  3292. '0.51.0').use(self.subproject)
  3293. return self.build_target(node, args, kwargs, SharedModuleHolder)
  3294. elif target_type == 'static_library':
  3295. return self.build_target(node, args, kwargs, StaticLibraryHolder)
  3296. elif target_type == 'both_libraries':
  3297. return self.build_both_libraries(node, args, kwargs)
  3298. elif target_type == 'library':
  3299. return self.build_library(node, args, kwargs)
  3300. elif target_type == 'jar':
  3301. return self.build_target(node, args, kwargs, JarHolder)
  3302. else:
  3303. raise InterpreterException('Unknown target_type.')
  3304. @permittedKwargs(permitted_kwargs['vcs_tag'])
  3305. def func_vcs_tag(self, node, args, kwargs):
  3306. if 'input' not in kwargs or 'output' not in kwargs:
  3307. raise InterpreterException('Keyword arguments input and output must exist')
  3308. if 'fallback' not in kwargs:
  3309. FeatureNew('Optional fallback in vcs_tag', '0.41.0').use(self.subproject)
  3310. fallback = kwargs.pop('fallback', self.project_version)
  3311. if not isinstance(fallback, str):
  3312. raise InterpreterException('Keyword argument fallback must be a string.')
  3313. replace_string = kwargs.pop('replace_string', '@VCS_TAG@')
  3314. regex_selector = '(.*)' # default regex selector for custom command: use complete output
  3315. vcs_cmd = kwargs.get('command', None)
  3316. if vcs_cmd and not isinstance(vcs_cmd, list):
  3317. vcs_cmd = [vcs_cmd]
  3318. source_dir = os.path.normpath(os.path.join(self.environment.get_source_dir(), self.subdir))
  3319. if vcs_cmd:
  3320. # Is the command an executable in path or maybe a script in the source tree?
  3321. vcs_cmd[0] = shutil.which(vcs_cmd[0]) or os.path.join(source_dir, vcs_cmd[0])
  3322. else:
  3323. vcs = mesonlib.detect_vcs(source_dir)
  3324. if vcs:
  3325. mlog.log('Found %s repository at %s' % (vcs['name'], vcs['wc_dir']))
  3326. vcs_cmd = vcs['get_rev'].split()
  3327. regex_selector = vcs['rev_regex']
  3328. else:
  3329. vcs_cmd = [' '] # executing this cmd will fail in vcstagger.py and force to use the fallback string
  3330. # vcstagger.py parameters: infile, outfile, fallback, source_dir, replace_string, regex_selector, command...
  3331. kwargs['command'] = self.environment.get_build_command() + \
  3332. ['--internal',
  3333. 'vcstagger',
  3334. '@INPUT0@',
  3335. '@OUTPUT0@',
  3336. fallback,
  3337. source_dir,
  3338. replace_string,
  3339. regex_selector] + vcs_cmd
  3340. kwargs.setdefault('build_by_default', True)
  3341. kwargs.setdefault('build_always_stale', True)
  3342. return self._func_custom_target_impl(node, [kwargs['output']], kwargs)
  3343. @FeatureNew('subdir_done', '0.46.0')
  3344. @stringArgs
  3345. def func_subdir_done(self, node, args, kwargs):
  3346. if len(kwargs) > 0:
  3347. raise InterpreterException('exit does not take named arguments')
  3348. if len(args) > 0:
  3349. raise InterpreterException('exit does not take any arguments')
  3350. raise SubdirDoneRequest()
  3351. @stringArgs
  3352. @FeatureNewKwargs('custom_target', '0.48.0', ['console'])
  3353. @FeatureNewKwargs('custom_target', '0.47.0', ['install_mode', 'build_always_stale'])
  3354. @FeatureNewKwargs('custom_target', '0.40.0', ['build_by_default'])
  3355. @permittedKwargs(permitted_kwargs['custom_target'])
  3356. def func_custom_target(self, node, args, kwargs):
  3357. if len(args) != 1:
  3358. raise InterpreterException('custom_target: Only one positional argument is allowed, and it must be a string name')
  3359. if 'depfile' in kwargs and ('@BASENAME@' in kwargs['depfile'] or '@PLAINNAME@' in kwargs['depfile']):
  3360. FeatureNew('substitutions in custom_target depfile', '0.47.0').use(self.subproject)
  3361. return self._func_custom_target_impl(node, args, kwargs)
  3362. def _func_custom_target_impl(self, node, args, kwargs):
  3363. 'Implementation-only, without FeatureNew checks, for internal use'
  3364. name = args[0]
  3365. kwargs['install_mode'] = self._get_kwarg_install_mode(kwargs)
  3366. if 'input' in kwargs:
  3367. try:
  3368. kwargs['input'] = self.source_strings_to_files(extract_as_list(kwargs, 'input'))
  3369. except mesonlib.MesonException:
  3370. mlog.warning('''Custom target input \'%s\' can\'t be converted to File object(s).
  3371. This will become a hard error in the future.''' % kwargs['input'], location=self.current_node)
  3372. tg = CustomTargetHolder(build.CustomTarget(name, self.subdir, self.subproject, kwargs, backend=self.backend), self)
  3373. self.add_target(name, tg.held_object)
  3374. return tg
  3375. @permittedKwargs(permitted_kwargs['run_target'])
  3376. def func_run_target(self, node, args, kwargs):
  3377. if len(args) > 1:
  3378. raise InvalidCode('Run_target takes only one positional argument: the target name.')
  3379. elif len(args) == 1:
  3380. if 'command' not in kwargs:
  3381. raise InterpreterException('Missing "command" keyword argument')
  3382. all_args = extract_as_list(kwargs, 'command')
  3383. deps = unholder(extract_as_list(kwargs, 'depends'))
  3384. else:
  3385. raise InterpreterException('Run_target needs at least one positional argument.')
  3386. cleaned_args = []
  3387. for i in unholder(listify(all_args)):
  3388. if not isinstance(i, (str, build.BuildTarget, build.CustomTarget, dependencies.ExternalProgram, mesonlib.File)):
  3389. mlog.debug('Wrong type:', str(i))
  3390. raise InterpreterException('Invalid argument to run_target.')
  3391. if isinstance(i, dependencies.ExternalProgram) and not i.found():
  3392. raise InterpreterException('Tried to use non-existing executable {!r}'.format(i.name))
  3393. cleaned_args.append(i)
  3394. name = args[0]
  3395. if not isinstance(name, str):
  3396. raise InterpreterException('First argument must be a string.')
  3397. cleaned_deps = []
  3398. for d in deps:
  3399. if not isinstance(d, (build.BuildTarget, build.CustomTarget)):
  3400. raise InterpreterException('Depends items must be build targets.')
  3401. cleaned_deps.append(d)
  3402. command, *cmd_args = cleaned_args
  3403. tg = RunTargetHolder(build.RunTarget(name, command, cmd_args, cleaned_deps, self.subdir, self.subproject), self)
  3404. self.add_target(name, tg.held_object)
  3405. full_name = (self.subproject, name)
  3406. assert(full_name not in self.build.run_target_names)
  3407. self.build.run_target_names.add(full_name)
  3408. return tg
  3409. @FeatureNew('alias_target', '0.52.0')
  3410. @noKwargs
  3411. def func_alias_target(self, node, args, kwargs):
  3412. if len(args) < 2:
  3413. raise InvalidCode('alias_target takes at least 2 arguments.')
  3414. name = args[0]
  3415. if not isinstance(name, str):
  3416. raise InterpreterException('First argument must be a string.')
  3417. deps = unholder(listify(args[1:]))
  3418. for d in deps:
  3419. if not isinstance(d, (build.BuildTarget, build.CustomTarget)):
  3420. raise InterpreterException('Depends items must be build targets.')
  3421. tg = RunTargetHolder(build.AliasTarget(name, deps, self.subdir, self.subproject), self)
  3422. self.add_target(name, tg.held_object)
  3423. return tg
  3424. @permittedKwargs(permitted_kwargs['generator'])
  3425. def func_generator(self, node, args, kwargs):
  3426. gen = GeneratorHolder(self, args, kwargs)
  3427. self.generators.append(gen)
  3428. return gen
  3429. @FeatureNewKwargs('benchmark', '0.46.0', ['depends'])
  3430. @FeatureNewKwargs('benchmark', '0.52.0', ['priority'])
  3431. @permittedKwargs(permitted_kwargs['benchmark'])
  3432. def func_benchmark(self, node, args, kwargs):
  3433. # is_parallel isn't valid here, so make sure it isn't passed
  3434. if 'is_parallel' in kwargs:
  3435. del kwargs['is_parallel']
  3436. self.add_test(node, args, kwargs, False)
  3437. @FeatureNewKwargs('test', '0.46.0', ['depends'])
  3438. @FeatureNewKwargs('test', '0.52.0', ['priority'])
  3439. @permittedKwargs(permitted_kwargs['test'])
  3440. def func_test(self, node, args, kwargs):
  3441. if kwargs.get('protocol') == 'gtest':
  3442. FeatureNew('"gtest" protocol for tests', '0.55.0').use(self.subproject)
  3443. self.add_test(node, args, kwargs, True)
  3444. def unpack_env_kwarg(self, kwargs) -> build.EnvironmentVariables:
  3445. envlist = kwargs.get('env', EnvironmentVariablesHolder())
  3446. if isinstance(envlist, EnvironmentVariablesHolder):
  3447. env = envlist.held_object
  3448. elif isinstance(envlist, dict):
  3449. FeatureNew('environment dictionary', '0.52.0').use(self.subproject)
  3450. env = EnvironmentVariablesHolder(envlist)
  3451. env = env.held_object
  3452. else:
  3453. envlist = listify(envlist)
  3454. # Convert from array to environment object
  3455. env = EnvironmentVariablesHolder(envlist)
  3456. env = env.held_object
  3457. return env
  3458. def add_test(self, node, args, kwargs, is_base_test):
  3459. if len(args) != 2:
  3460. raise InterpreterException('test expects 2 arguments, {} given'.format(len(args)))
  3461. if not isinstance(args[0], str):
  3462. raise InterpreterException('First argument of test must be a string.')
  3463. exe = args[1]
  3464. if not isinstance(exe, (ExecutableHolder, JarHolder, ExternalProgramHolder)):
  3465. if isinstance(exe, mesonlib.File):
  3466. exe = self.func_find_program(node, args[1], {})
  3467. else:
  3468. raise InterpreterException('Second argument must be executable.')
  3469. par = kwargs.get('is_parallel', True)
  3470. if not isinstance(par, bool):
  3471. raise InterpreterException('Keyword argument is_parallel must be a boolean.')
  3472. cmd_args = unholder(extract_as_list(kwargs, 'args'))
  3473. for i in cmd_args:
  3474. if not isinstance(i, (str, mesonlib.File, build.Target)):
  3475. raise InterpreterException('Command line arguments must be strings, files or targets.')
  3476. env = self.unpack_env_kwarg(kwargs)
  3477. should_fail = kwargs.get('should_fail', False)
  3478. if not isinstance(should_fail, bool):
  3479. raise InterpreterException('Keyword argument should_fail must be a boolean.')
  3480. timeout = kwargs.get('timeout', 30)
  3481. if 'workdir' in kwargs:
  3482. workdir = kwargs['workdir']
  3483. if not isinstance(workdir, str):
  3484. raise InterpreterException('Workdir keyword argument must be a string.')
  3485. if not os.path.isabs(workdir):
  3486. raise InterpreterException('Workdir keyword argument must be an absolute path.')
  3487. else:
  3488. workdir = None
  3489. if not isinstance(timeout, int):
  3490. raise InterpreterException('Timeout must be an integer.')
  3491. protocol = kwargs.get('protocol', 'exitcode')
  3492. if protocol not in {'exitcode', 'tap', 'gtest'}:
  3493. raise InterpreterException('Protocol must be "exitcode", "tap", or "gtest".')
  3494. suite = []
  3495. prj = self.subproject if self.is_subproject() else self.build.project_name
  3496. for s in mesonlib.stringlistify(kwargs.get('suite', '')):
  3497. if len(s) > 0:
  3498. s = ':' + s
  3499. suite.append(prj.replace(' ', '_').replace(':', '_') + s)
  3500. depends = unholder(extract_as_list(kwargs, 'depends'))
  3501. for dep in depends:
  3502. if not isinstance(dep, (build.CustomTarget, build.BuildTarget)):
  3503. raise InterpreterException('Depends items must be build targets.')
  3504. priority = kwargs.get('priority', 0)
  3505. if not isinstance(priority, int):
  3506. raise InterpreterException('Keyword argument priority must be an integer.')
  3507. t = Test(args[0], prj, suite, exe.held_object, depends, par, cmd_args,
  3508. env, should_fail, timeout, workdir, protocol, priority)
  3509. if is_base_test:
  3510. self.build.tests.append(t)
  3511. mlog.debug('Adding test', mlog.bold(args[0], True))
  3512. else:
  3513. self.build.benchmarks.append(t)
  3514. mlog.debug('Adding benchmark', mlog.bold(args[0], True))
  3515. @FeatureNewKwargs('install_headers', '0.47.0', ['install_mode'])
  3516. @permittedKwargs(permitted_kwargs['install_headers'])
  3517. def func_install_headers(self, node, args, kwargs):
  3518. source_files = self.source_strings_to_files(args)
  3519. kwargs['install_mode'] = self._get_kwarg_install_mode(kwargs)
  3520. h = Headers(source_files, kwargs)
  3521. self.build.headers.append(h)
  3522. return h
  3523. @FeatureNewKwargs('install_man', '0.47.0', ['install_mode'])
  3524. @permittedKwargs(permitted_kwargs['install_man'])
  3525. def func_install_man(self, node, args, kwargs):
  3526. fargs = self.source_strings_to_files(args)
  3527. kwargs['install_mode'] = self._get_kwarg_install_mode(kwargs)
  3528. m = Man(fargs, kwargs)
  3529. self.build.man.append(m)
  3530. return m
  3531. @FeatureNewKwargs('subdir', '0.44.0', ['if_found'])
  3532. @permittedKwargs(permitted_kwargs['subdir'])
  3533. def func_subdir(self, node, args, kwargs):
  3534. self.validate_arguments(args, 1, [str])
  3535. mesonlib.check_direntry_issues(args)
  3536. if '..' in args[0]:
  3537. raise InvalidArguments('Subdir contains ..')
  3538. if self.subdir == '' and args[0] == self.subproject_dir:
  3539. raise InvalidArguments('Must not go into subprojects dir with subdir(), use subproject() instead.')
  3540. if self.subdir == '' and args[0].startswith('meson-'):
  3541. raise InvalidArguments('The "meson-" prefix is reserved and cannot be used for top-level subdir().')
  3542. for i in mesonlib.extract_as_list(kwargs, 'if_found'):
  3543. if not hasattr(i, 'found_method'):
  3544. raise InterpreterException('Object used in if_found does not have a found method.')
  3545. if not i.found_method([], {}):
  3546. return
  3547. prev_subdir = self.subdir
  3548. subdir = os.path.join(prev_subdir, args[0])
  3549. if os.path.isabs(subdir):
  3550. raise InvalidArguments('Subdir argument must be a relative path.')
  3551. absdir = os.path.join(self.environment.get_source_dir(), subdir)
  3552. symlinkless_dir = os.path.realpath(absdir)
  3553. if symlinkless_dir in self.visited_subdirs:
  3554. raise InvalidArguments('Tried to enter directory "%s", which has already been visited.'
  3555. % subdir)
  3556. self.visited_subdirs[symlinkless_dir] = True
  3557. self.subdir = subdir
  3558. os.makedirs(os.path.join(self.environment.build_dir, subdir), exist_ok=True)
  3559. buildfilename = os.path.join(self.subdir, environment.build_filename)
  3560. self.build_def_files.append(buildfilename)
  3561. absname = os.path.join(self.environment.get_source_dir(), buildfilename)
  3562. if not os.path.isfile(absname):
  3563. self.subdir = prev_subdir
  3564. raise InterpreterException('Non-existent build file {!r}'.format(buildfilename))
  3565. with open(absname, encoding='utf8') as f:
  3566. code = f.read()
  3567. assert(isinstance(code, str))
  3568. try:
  3569. codeblock = mparser.Parser(code, absname).parse()
  3570. except mesonlib.MesonException as me:
  3571. me.file = absname
  3572. raise me
  3573. try:
  3574. self.evaluate_codeblock(codeblock)
  3575. except SubdirDoneRequest:
  3576. pass
  3577. self.subdir = prev_subdir
  3578. def _get_kwarg_install_mode(self, kwargs):
  3579. if kwargs.get('install_mode', None) is None:
  3580. return None
  3581. install_mode = []
  3582. mode = mesonlib.typeslistify(kwargs.get('install_mode', []), (str, int))
  3583. for m in mode:
  3584. # We skip any arguments that are set to `false`
  3585. if m is False:
  3586. m = None
  3587. install_mode.append(m)
  3588. if len(install_mode) > 3:
  3589. raise InvalidArguments('Keyword argument install_mode takes at '
  3590. 'most 3 arguments.')
  3591. if len(install_mode) > 0 and install_mode[0] is not None and \
  3592. not isinstance(install_mode[0], str):
  3593. raise InvalidArguments('Keyword argument install_mode requires the '
  3594. 'permissions arg to be a string or false')
  3595. return FileMode(*install_mode)
  3596. @FeatureNewKwargs('install_data', '0.46.0', ['rename'])
  3597. @FeatureNewKwargs('install_data', '0.38.0', ['install_mode'])
  3598. @permittedKwargs(permitted_kwargs['install_data'])
  3599. def func_install_data(self, node, args, kwargs):
  3600. kwsource = mesonlib.stringlistify(kwargs.get('sources', []))
  3601. raw_sources = args + kwsource
  3602. sources = []
  3603. source_strings = []
  3604. for s in raw_sources:
  3605. if isinstance(s, mesonlib.File):
  3606. sources.append(s)
  3607. elif isinstance(s, str):
  3608. source_strings.append(s)
  3609. else:
  3610. raise InvalidArguments('Argument {!r} must be string or file.'.format(s))
  3611. sources += self.source_strings_to_files(source_strings)
  3612. install_dir = kwargs.get('install_dir', None)
  3613. if not isinstance(install_dir, (str, type(None))):
  3614. raise InvalidArguments('Keyword argument install_dir not a string.')
  3615. install_mode = self._get_kwarg_install_mode(kwargs)
  3616. rename = kwargs.get('rename', None)
  3617. data = DataHolder(build.Data(sources, install_dir, install_mode, rename))
  3618. self.build.data.append(data.held_object)
  3619. return data
  3620. @FeatureNewKwargs('install_subdir', '0.42.0', ['exclude_files', 'exclude_directories'])
  3621. @FeatureNewKwargs('install_subdir', '0.38.0', ['install_mode'])
  3622. @permittedKwargs(permitted_kwargs['install_subdir'])
  3623. @stringArgs
  3624. def func_install_subdir(self, node, args, kwargs):
  3625. if len(args) != 1:
  3626. raise InvalidArguments('Install_subdir requires exactly one argument.')
  3627. subdir = args[0]
  3628. if 'install_dir' not in kwargs:
  3629. raise InvalidArguments('Missing keyword argument install_dir')
  3630. install_dir = kwargs['install_dir']
  3631. if not isinstance(install_dir, str):
  3632. raise InvalidArguments('Keyword argument install_dir not a string.')
  3633. if 'strip_directory' in kwargs:
  3634. if not isinstance(kwargs['strip_directory'], bool):
  3635. raise InterpreterException('"strip_directory" keyword must be a boolean.')
  3636. strip_directory = kwargs['strip_directory']
  3637. else:
  3638. strip_directory = False
  3639. if 'exclude_files' in kwargs:
  3640. exclude = extract_as_list(kwargs, 'exclude_files')
  3641. for f in exclude:
  3642. if not isinstance(f, str):
  3643. raise InvalidArguments('Exclude argument not a string.')
  3644. elif os.path.isabs(f):
  3645. raise InvalidArguments('Exclude argument cannot be absolute.')
  3646. exclude_files = set(exclude)
  3647. else:
  3648. exclude_files = set()
  3649. if 'exclude_directories' in kwargs:
  3650. exclude = extract_as_list(kwargs, 'exclude_directories')
  3651. for d in exclude:
  3652. if not isinstance(d, str):
  3653. raise InvalidArguments('Exclude argument not a string.')
  3654. elif os.path.isabs(d):
  3655. raise InvalidArguments('Exclude argument cannot be absolute.')
  3656. exclude_directories = set(exclude)
  3657. else:
  3658. exclude_directories = set()
  3659. exclude = (exclude_files, exclude_directories)
  3660. install_mode = self._get_kwarg_install_mode(kwargs)
  3661. idir = InstallDir(self.subdir, subdir, install_dir, install_mode, exclude, strip_directory)
  3662. self.build.install_dirs.append(idir)
  3663. return idir
  3664. @FeatureNewKwargs('configure_file', '0.47.0', ['copy', 'output_format', 'install_mode', 'encoding'])
  3665. @FeatureNewKwargs('configure_file', '0.46.0', ['format'])
  3666. @FeatureNewKwargs('configure_file', '0.41.0', ['capture'])
  3667. @FeatureNewKwargs('configure_file', '0.50.0', ['install'])
  3668. @FeatureNewKwargs('configure_file', '0.52.0', ['depfile'])
  3669. @permittedKwargs(permitted_kwargs['configure_file'])
  3670. def func_configure_file(self, node, args, kwargs):
  3671. if len(args) > 0:
  3672. raise InterpreterException("configure_file takes only keyword arguments.")
  3673. if 'output' not in kwargs:
  3674. raise InterpreterException('Required keyword argument "output" not defined.')
  3675. actions = set(['configuration', 'command', 'copy']).intersection(kwargs.keys())
  3676. if len(actions) == 0:
  3677. raise InterpreterException('Must specify an action with one of these '
  3678. 'keyword arguments: \'configuration\', '
  3679. '\'command\', or \'copy\'.')
  3680. elif len(actions) == 2:
  3681. raise InterpreterException('Must not specify both {!r} and {!r} '
  3682. 'keyword arguments since they are '
  3683. 'mutually exclusive.'.format(*actions))
  3684. elif len(actions) == 3:
  3685. raise InterpreterException('Must specify one of {!r}, {!r}, and '
  3686. '{!r} keyword arguments since they are '
  3687. 'mutually exclusive.'.format(*actions))
  3688. if 'capture' in kwargs:
  3689. if not isinstance(kwargs['capture'], bool):
  3690. raise InterpreterException('"capture" keyword must be a boolean.')
  3691. if 'command' not in kwargs:
  3692. raise InterpreterException('"capture" keyword requires "command" keyword.')
  3693. if 'format' in kwargs:
  3694. fmt = kwargs['format']
  3695. if not isinstance(fmt, str):
  3696. raise InterpreterException('"format" keyword must be a string.')
  3697. else:
  3698. fmt = 'meson'
  3699. if fmt not in ('meson', 'cmake', 'cmake@'):
  3700. raise InterpreterException('"format" possible values are "meson", "cmake" or "cmake@".')
  3701. if 'output_format' in kwargs:
  3702. output_format = kwargs['output_format']
  3703. if not isinstance(output_format, str):
  3704. raise InterpreterException('"output_format" keyword must be a string.')
  3705. else:
  3706. output_format = 'c'
  3707. if output_format not in ('c', 'nasm'):
  3708. raise InterpreterException('"format" possible values are "c" or "nasm".')
  3709. if 'depfile' in kwargs:
  3710. depfile = kwargs['depfile']
  3711. if not isinstance(depfile, str):
  3712. raise InterpreterException('depfile file name must be a string')
  3713. else:
  3714. depfile = None
  3715. # Validate input
  3716. inputs = self.source_strings_to_files(extract_as_list(kwargs, 'input'))
  3717. inputs_abs = []
  3718. for f in inputs:
  3719. if isinstance(f, mesonlib.File):
  3720. inputs_abs.append(f.absolute_path(self.environment.source_dir,
  3721. self.environment.build_dir))
  3722. self.add_build_def_file(f)
  3723. else:
  3724. raise InterpreterException('Inputs can only be strings or file objects')
  3725. # Validate output
  3726. output = kwargs['output']
  3727. if not isinstance(output, str):
  3728. raise InterpreterException('Output file name must be a string')
  3729. if inputs_abs:
  3730. values = mesonlib.get_filenames_templates_dict(inputs_abs, None)
  3731. outputs = mesonlib.substitute_values([output], values)
  3732. output = outputs[0]
  3733. if depfile:
  3734. depfile = mesonlib.substitute_values([depfile], values)[0]
  3735. ofile_rpath = os.path.join(self.subdir, output)
  3736. if ofile_rpath in self.configure_file_outputs:
  3737. mesonbuildfile = os.path.join(self.subdir, 'meson.build')
  3738. current_call = "{}:{}".format(mesonbuildfile, self.current_lineno)
  3739. first_call = "{}:{}".format(mesonbuildfile, self.configure_file_outputs[ofile_rpath])
  3740. mlog.warning('Output file', mlog.bold(ofile_rpath, True), 'for configure_file() at', current_call, 'overwrites configure_file() output at', first_call)
  3741. else:
  3742. self.configure_file_outputs[ofile_rpath] = self.current_lineno
  3743. if os.path.dirname(output) != '':
  3744. raise InterpreterException('Output file name must not contain a subdirectory.')
  3745. (ofile_path, ofile_fname) = os.path.split(os.path.join(self.subdir, output))
  3746. ofile_abs = os.path.join(self.environment.build_dir, ofile_path, ofile_fname)
  3747. # Perform the appropriate action
  3748. if 'configuration' in kwargs:
  3749. conf = kwargs['configuration']
  3750. if isinstance(conf, dict):
  3751. FeatureNew('configure_file.configuration dictionary', '0.49.0').use(self.subproject)
  3752. conf = ConfigurationDataHolder(self.subproject, conf)
  3753. elif not isinstance(conf, ConfigurationDataHolder):
  3754. raise InterpreterException('Argument "configuration" is not of type configuration_data')
  3755. mlog.log('Configuring', mlog.bold(output), 'using configuration')
  3756. if len(inputs) > 1:
  3757. raise InterpreterException('At most one input file can given in configuration mode')
  3758. if inputs:
  3759. os.makedirs(os.path.join(self.environment.build_dir, self.subdir), exist_ok=True)
  3760. file_encoding = kwargs.setdefault('encoding', 'utf-8')
  3761. missing_variables, confdata_useless = \
  3762. mesonlib.do_conf_file(inputs_abs[0], ofile_abs, conf.held_object,
  3763. fmt, file_encoding)
  3764. if missing_variables:
  3765. var_list = ", ".join(map(repr, sorted(missing_variables)))
  3766. mlog.warning(
  3767. "The variable(s) %s in the input file '%s' are not "
  3768. "present in the given configuration data." % (
  3769. var_list, inputs[0]), location=node)
  3770. if confdata_useless:
  3771. ifbase = os.path.basename(inputs_abs[0])
  3772. mlog.warning('Got an empty configuration_data() object and found no '
  3773. 'substitutions in the input file {!r}. If you want to '
  3774. 'copy a file to the build dir, use the \'copy:\' keyword '
  3775. 'argument added in 0.47.0'.format(ifbase), location=node)
  3776. else:
  3777. mesonlib.dump_conf_header(ofile_abs, conf.held_object, output_format)
  3778. conf.mark_used()
  3779. elif 'command' in kwargs:
  3780. if len(inputs) > 1:
  3781. FeatureNew('multiple inputs in configure_file()', '0.52.0').use(self.subproject)
  3782. # We use absolute paths for input and output here because the cwd
  3783. # that the command is run from is 'unspecified', so it could change.
  3784. # Currently it's builddir/subdir for in_builddir else srcdir/subdir.
  3785. values = mesonlib.get_filenames_templates_dict(inputs_abs, [ofile_abs])
  3786. if depfile:
  3787. depfile = os.path.join(self.environment.get_scratch_dir(), depfile)
  3788. values['@DEPFILE@'] = depfile
  3789. # Substitute @INPUT@, @OUTPUT@, etc here.
  3790. cmd = mesonlib.substitute_values(kwargs['command'], values)
  3791. mlog.log('Configuring', mlog.bold(output), 'with command')
  3792. res = self.run_command_impl(node, cmd, {}, True)
  3793. if res.returncode != 0:
  3794. raise InterpreterException('Running configure command failed.\n%s\n%s' %
  3795. (res.stdout, res.stderr))
  3796. if 'capture' in kwargs and kwargs['capture']:
  3797. dst_tmp = ofile_abs + '~'
  3798. file_encoding = kwargs.setdefault('encoding', 'utf-8')
  3799. with open(dst_tmp, 'w', encoding=file_encoding) as f:
  3800. f.writelines(res.stdout)
  3801. if inputs_abs:
  3802. shutil.copymode(inputs_abs[0], dst_tmp)
  3803. mesonlib.replace_if_different(ofile_abs, dst_tmp)
  3804. if depfile:
  3805. mlog.log('Reading depfile:', mlog.bold(depfile))
  3806. with open(depfile, 'r') as f:
  3807. df = DepFile(f.readlines())
  3808. deps = df.get_all_dependencies(ofile_fname)
  3809. for dep in deps:
  3810. self.add_build_def_file(dep)
  3811. elif 'copy' in kwargs:
  3812. if len(inputs_abs) != 1:
  3813. raise InterpreterException('Exactly one input file must be given in copy mode')
  3814. os.makedirs(os.path.join(self.environment.build_dir, self.subdir), exist_ok=True)
  3815. shutil.copyfile(inputs_abs[0], ofile_abs)
  3816. shutil.copystat(inputs_abs[0], ofile_abs)
  3817. else:
  3818. # Not reachable
  3819. raise AssertionError
  3820. # Install file if requested, we check for the empty string
  3821. # for backwards compatibility. That was the behaviour before
  3822. # 0.45.0 so preserve it.
  3823. idir = kwargs.get('install_dir', '')
  3824. if idir is False:
  3825. idir = ''
  3826. mlog.deprecation('Please use the new `install:` kwarg instead of passing '
  3827. '`false` to `install_dir:`', location=node)
  3828. if not isinstance(idir, str):
  3829. if isinstance(idir, list) and len(idir) == 0:
  3830. mlog.deprecation('install_dir: kwarg must be a string and not an empty array. '
  3831. 'Please use the install: kwarg to enable or disable installation. '
  3832. 'This will be a hard error in the next release.')
  3833. else:
  3834. raise InterpreterException('"install_dir" must be a string')
  3835. install = kwargs.get('install', idir != '')
  3836. if not isinstance(install, bool):
  3837. raise InterpreterException('"install" must be a boolean')
  3838. if install:
  3839. if not idir:
  3840. raise InterpreterException('"install_dir" must be specified '
  3841. 'when "install" in a configure_file '
  3842. 'is true')
  3843. cfile = mesonlib.File.from_built_file(ofile_path, ofile_fname)
  3844. install_mode = self._get_kwarg_install_mode(kwargs)
  3845. self.build.data.append(build.Data([cfile], idir, install_mode))
  3846. return mesonlib.File.from_built_file(self.subdir, output)
  3847. def extract_incdirs(self, kwargs):
  3848. prospectives = unholder(extract_as_list(kwargs, 'include_directories'))
  3849. result = []
  3850. for p in prospectives:
  3851. if isinstance(p, build.IncludeDirs):
  3852. result.append(p)
  3853. elif isinstance(p, str):
  3854. result.append(self.build_incdir_object([p]).held_object)
  3855. else:
  3856. raise InterpreterException('Include directory objects can only be created from strings or include directories.')
  3857. return result
  3858. @permittedKwargs(permitted_kwargs['include_directories'])
  3859. @stringArgs
  3860. def func_include_directories(self, node, args, kwargs):
  3861. return self.build_incdir_object(args, kwargs.get('is_system', False))
  3862. def build_incdir_object(self, incdir_strings, is_system=False):
  3863. if not isinstance(is_system, bool):
  3864. raise InvalidArguments('Is_system must be boolean.')
  3865. src_root = self.environment.get_source_dir()
  3866. build_root = self.environment.get_build_dir()
  3867. absbase_src = os.path.join(src_root, self.subdir)
  3868. absbase_build = os.path.join(build_root, self.subdir)
  3869. for a in incdir_strings:
  3870. if a.startswith(src_root):
  3871. raise InvalidArguments('''Tried to form an absolute path to a source dir. You should not do that but use
  3872. relative paths instead.
  3873. To get include path to any directory relative to the current dir do
  3874. incdir = include_directories(dirname)
  3875. After this incdir will contain both the current source dir as well as the
  3876. corresponding build dir. It can then be used in any subdirectory and
  3877. Meson will take care of all the busywork to make paths work.
  3878. Dirname can even be '.' to mark the current directory. Though you should
  3879. remember that the current source and build directories are always
  3880. put in the include directories by default so you only need to do
  3881. include_directories('.') if you intend to use the result in a
  3882. different subdirectory.
  3883. ''')
  3884. absdir_src = os.path.join(absbase_src, a)
  3885. absdir_build = os.path.join(absbase_build, a)
  3886. if not os.path.isdir(absdir_src) and not os.path.isdir(absdir_build):
  3887. raise InvalidArguments('Include dir %s does not exist.' % a)
  3888. i = IncludeDirsHolder(build.IncludeDirs(self.subdir, incdir_strings, is_system))
  3889. return i
  3890. @permittedKwargs(permitted_kwargs['add_test_setup'])
  3891. @stringArgs
  3892. def func_add_test_setup(self, node, args, kwargs):
  3893. if len(args) != 1:
  3894. raise InterpreterException('Add_test_setup needs one argument for the setup name.')
  3895. setup_name = args[0]
  3896. if re.fullmatch('([_a-zA-Z][_0-9a-zA-Z]*:)?[_a-zA-Z][_0-9a-zA-Z]*', setup_name) is None:
  3897. raise InterpreterException('Setup name may only contain alphanumeric characters.')
  3898. if ":" not in setup_name:
  3899. setup_name = (self.subproject if self.subproject else self.build.project_name) + ":" + setup_name
  3900. try:
  3901. inp = unholder(extract_as_list(kwargs, 'exe_wrapper'))
  3902. exe_wrapper = []
  3903. for i in inp:
  3904. if isinstance(i, str):
  3905. exe_wrapper.append(i)
  3906. elif isinstance(i, dependencies.ExternalProgram):
  3907. if not i.found():
  3908. raise InterpreterException('Tried to use non-found executable.')
  3909. exe_wrapper += i.get_command()
  3910. else:
  3911. raise InterpreterException('Exe wrapper can only contain strings or external binaries.')
  3912. except KeyError:
  3913. exe_wrapper = None
  3914. gdb = kwargs.get('gdb', False)
  3915. if not isinstance(gdb, bool):
  3916. raise InterpreterException('Gdb option must be a boolean')
  3917. timeout_multiplier = kwargs.get('timeout_multiplier', 1)
  3918. if not isinstance(timeout_multiplier, int):
  3919. raise InterpreterException('Timeout multiplier must be a number.')
  3920. is_default = kwargs.get('is_default', False)
  3921. if not isinstance(is_default, bool):
  3922. raise InterpreterException('is_default option must be a boolean')
  3923. if is_default:
  3924. if self.build.test_setup_default_name is not None:
  3925. raise InterpreterException('\'%s\' is already set as default. '
  3926. 'is_default can be set to true only once' % self.build.test_setup_default_name)
  3927. self.build.test_setup_default_name = setup_name
  3928. env = self.unpack_env_kwarg(kwargs)
  3929. self.build.test_setups[setup_name] = build.TestSetup(exe_wrapper, gdb, timeout_multiplier, env)
  3930. @permittedKwargs(permitted_kwargs['add_global_arguments'])
  3931. @stringArgs
  3932. def func_add_global_arguments(self, node, args, kwargs):
  3933. for_machine = self.machine_from_native_kwarg(kwargs)
  3934. self.add_global_arguments(node, self.build.global_args[for_machine], args, kwargs)
  3935. @permittedKwargs(permitted_kwargs['add_global_link_arguments'])
  3936. @stringArgs
  3937. def func_add_global_link_arguments(self, node, args, kwargs):
  3938. for_machine = self.machine_from_native_kwarg(kwargs)
  3939. self.add_global_arguments(node, self.build.global_link_args[for_machine], args, kwargs)
  3940. @permittedKwargs(permitted_kwargs['add_project_arguments'])
  3941. @stringArgs
  3942. def func_add_project_arguments(self, node, args, kwargs):
  3943. for_machine = self.machine_from_native_kwarg(kwargs)
  3944. self.add_project_arguments(node, self.build.projects_args[for_machine], args, kwargs)
  3945. @permittedKwargs(permitted_kwargs['add_project_link_arguments'])
  3946. @stringArgs
  3947. def func_add_project_link_arguments(self, node, args, kwargs):
  3948. for_machine = self.machine_from_native_kwarg(kwargs)
  3949. self.add_project_arguments(node, self.build.projects_link_args[for_machine], args, kwargs)
  3950. def warn_about_builtin_args(self, args):
  3951. warnargs = ('/W1', '/W2', '/W3', '/W4', '/Wall', '-Wall', '-Wextra', '-Wpedantic')
  3952. optargs = ('-O0', '-O2', '-O3', '-Os', '/O1', '/O2', '/Os')
  3953. for arg in args:
  3954. if arg in warnargs:
  3955. mlog.warning('Consider using the built-in warning_level option instead of using "{}".'.format(arg),
  3956. location=self.current_node)
  3957. elif arg in optargs:
  3958. mlog.warning('Consider using the built-in optimization level instead of using "{}".'.format(arg),
  3959. location=self.current_node)
  3960. elif arg == '-g':
  3961. mlog.warning('Consider using the built-in debug option instead of using "{}".'.format(arg),
  3962. location=self.current_node)
  3963. elif arg == '-pipe':
  3964. mlog.warning("You don't need to add -pipe, Meson will use it automatically when it is available.",
  3965. location=self.current_node)
  3966. elif arg.startswith('-fsanitize'):
  3967. mlog.warning('Consider using the built-in option for sanitizers instead of using "{}".'.format(arg),
  3968. location=self.current_node)
  3969. elif arg.startswith('-std=') or arg.startswith('/std:'):
  3970. mlog.warning('Consider using the built-in option for language standard version instead of using "{}".'.format(arg),
  3971. location=self.current_node)
  3972. def add_global_arguments(self, node, argsdict, args, kwargs):
  3973. if self.is_subproject():
  3974. msg = 'Function \'{}\' cannot be used in subprojects because ' \
  3975. 'there is no way to make that reliable.\nPlease only call ' \
  3976. 'this if is_subproject() returns false. Alternatively, ' \
  3977. 'define a variable that\ncontains your language-specific ' \
  3978. 'arguments and add it to the appropriate *_args kwarg ' \
  3979. 'in each target.'.format(node.func_name)
  3980. raise InvalidCode(msg)
  3981. frozen = self.project_args_frozen or self.global_args_frozen
  3982. self.add_arguments(node, argsdict, frozen, args, kwargs)
  3983. def add_project_arguments(self, node, argsdict, args, kwargs):
  3984. if self.subproject not in argsdict:
  3985. argsdict[self.subproject] = {}
  3986. self.add_arguments(node, argsdict[self.subproject],
  3987. self.project_args_frozen, args, kwargs)
  3988. def add_arguments(self, node, argsdict, args_frozen, args, kwargs):
  3989. if args_frozen:
  3990. msg = 'Tried to use \'{}\' after a build target has been declared.\n' \
  3991. 'This is not permitted. Please declare all ' \
  3992. 'arguments before your targets.'.format(node.func_name)
  3993. raise InvalidCode(msg)
  3994. if 'language' not in kwargs:
  3995. raise InvalidCode('Missing language definition in {}'.format(node.func_name))
  3996. self.warn_about_builtin_args(args)
  3997. for lang in mesonlib.stringlistify(kwargs['language']):
  3998. lang = lang.lower()
  3999. argsdict[lang] = argsdict.get(lang, []) + args
  4000. @noKwargs
  4001. @noArgsFlattening
  4002. def func_environment(self, node, args, kwargs):
  4003. if len(args) > 1:
  4004. raise InterpreterException('environment takes only one optional positional arguments')
  4005. elif len(args) == 1:
  4006. FeatureNew('environment positional arguments', '0.52.0').use(self.subproject)
  4007. initial_values = args[0]
  4008. if not isinstance(initial_values, dict) and not isinstance(initial_values, list):
  4009. raise InterpreterException('environment first argument must be a dictionary or a list')
  4010. else:
  4011. initial_values = {}
  4012. return EnvironmentVariablesHolder(initial_values)
  4013. @stringArgs
  4014. @noKwargs
  4015. def func_join_paths(self, node, args, kwargs):
  4016. return self.join_path_strings(args)
  4017. def run(self):
  4018. super().run()
  4019. mlog.log('Build targets in project:', mlog.bold(str(len(self.build.targets))))
  4020. FeatureNew.report(self.subproject)
  4021. FeatureDeprecated.report(self.subproject)
  4022. if not self.is_subproject():
  4023. self.print_extra_warnings()
  4024. if self.subproject == '':
  4025. self._print_summary()
  4026. def print_extra_warnings(self):
  4027. # TODO cross compilation
  4028. for c in self.coredata.compilers.host.values():
  4029. if c.get_id() == 'clang':
  4030. self.check_clang_asan_lundef()
  4031. break
  4032. def check_clang_asan_lundef(self):
  4033. if 'b_lundef' not in self.coredata.base_options:
  4034. return
  4035. if 'b_sanitize' not in self.coredata.base_options:
  4036. return
  4037. if (self.coredata.base_options['b_lundef'].value and
  4038. self.coredata.base_options['b_sanitize'].value != 'none'):
  4039. mlog.warning('''Trying to use {} sanitizer on Clang with b_lundef.
  4040. This will probably not work.
  4041. Try setting b_lundef to false instead.'''.format(self.coredata.base_options['b_sanitize'].value),
  4042. location=self.current_node)
  4043. def evaluate_subproject_info(self, path_from_source_root, subproject_dirname):
  4044. depth = 0
  4045. subproj_name = ''
  4046. segs = PurePath(path_from_source_root).parts
  4047. segs_spd = PurePath(subproject_dirname).parts
  4048. while segs and segs[0] == segs_spd[0]:
  4049. if len(segs_spd) == 1:
  4050. subproj_name = segs[1]
  4051. segs = segs[2:]
  4052. depth += 1
  4053. else:
  4054. segs_spd = segs_spd[1:]
  4055. segs = segs[1:]
  4056. return (depth, subproj_name)
  4057. # Check that the indicated file is within the same subproject
  4058. # as we currently are. This is to stop people doing
  4059. # nasty things like:
  4060. #
  4061. # f = files('../../master_src/file.c')
  4062. #
  4063. # Note that this is validated only when the file
  4064. # object is generated. The result can be used in a different
  4065. # subproject than it is defined in (due to e.g. a
  4066. # declare_dependency).
  4067. def validate_within_subproject(self, subdir, fname):
  4068. norm = os.path.normpath(os.path.join(subdir, fname))
  4069. if os.path.isabs(norm):
  4070. if not norm.startswith(self.environment.source_dir):
  4071. # Grabbing files outside the source tree is ok.
  4072. # This is for vendor stuff like:
  4073. #
  4074. # /opt/vendorsdk/src/file_with_license_restrictions.c
  4075. return
  4076. norm = os.path.relpath(norm, self.environment.source_dir)
  4077. assert(not os.path.isabs(norm))
  4078. (num_sps, sproj_name) = self.evaluate_subproject_info(norm, self.subproject_dir)
  4079. plain_filename = os.path.basename(norm)
  4080. if num_sps == 0:
  4081. if not self.is_subproject():
  4082. return
  4083. raise InterpreterException('Sandbox violation: Tried to grab file %s from a different subproject.' % plain_filename)
  4084. if num_sps > 1:
  4085. raise InterpreterException('Sandbox violation: Tried to grab file %s from a nested subproject.' % plain_filename)
  4086. if sproj_name != self.subproject_directory_name:
  4087. raise InterpreterException('Sandbox violation: Tried to grab file %s from a different subproject.' % plain_filename)
  4088. def source_strings_to_files(self, sources):
  4089. results = []
  4090. mesonlib.check_direntry_issues(sources)
  4091. if not isinstance(sources, list):
  4092. sources = [sources]
  4093. for s in sources:
  4094. if isinstance(s, (mesonlib.File, GeneratedListHolder,
  4095. TargetHolder, CustomTargetIndexHolder,
  4096. GeneratedObjectsHolder)):
  4097. pass
  4098. elif isinstance(s, str):
  4099. self.validate_within_subproject(self.subdir, s)
  4100. s = mesonlib.File.from_source_file(self.environment.source_dir, self.subdir, s)
  4101. else:
  4102. raise InterpreterException('Source item is {!r} instead of '
  4103. 'string or File-type object'.format(s))
  4104. results.append(s)
  4105. return results
  4106. def add_target(self, name, tobj):
  4107. if name == '':
  4108. raise InterpreterException('Target name must not be empty.')
  4109. if name.strip() == '':
  4110. raise InterpreterException('Target name must not consist only of whitespace.')
  4111. if name.startswith('meson-'):
  4112. raise InvalidArguments("Target names starting with 'meson-' are reserved "
  4113. "for Meson's internal use. Please rename.")
  4114. if name in coredata.forbidden_target_names:
  4115. raise InvalidArguments("Target name '%s' is reserved for Meson's "
  4116. "internal use. Please rename." % name)
  4117. # To permit an executable and a shared library to have the
  4118. # same name, such as "foo.exe" and "libfoo.a".
  4119. idname = tobj.get_id()
  4120. if idname in self.build.targets:
  4121. raise InvalidCode('Tried to create target "%s", but a target of that name already exists.' % name)
  4122. self.build.targets[idname] = tobj
  4123. if idname not in self.coredata.target_guids:
  4124. self.coredata.target_guids[idname] = str(uuid.uuid4()).upper()
  4125. @FeatureNew('both_libraries', '0.46.0')
  4126. def build_both_libraries(self, node, args, kwargs):
  4127. shared_holder = self.build_target(node, args, kwargs, SharedLibraryHolder)
  4128. # Check if user forces non-PIC static library.
  4129. pic = True
  4130. if 'pic' in kwargs:
  4131. pic = kwargs['pic']
  4132. elif 'b_staticpic' in self.environment.coredata.base_options:
  4133. pic = self.environment.coredata.base_options['b_staticpic'].value
  4134. if pic:
  4135. # Exclude sources from args and kwargs to avoid building them twice
  4136. static_args = [args[0]]
  4137. static_kwargs = kwargs.copy()
  4138. static_kwargs['sources'] = []
  4139. static_kwargs['objects'] = shared_holder.held_object.extract_all_objects()
  4140. else:
  4141. static_args = args
  4142. static_kwargs = kwargs
  4143. static_holder = self.build_target(node, static_args, static_kwargs, StaticLibraryHolder)
  4144. return BothLibrariesHolder(shared_holder, static_holder, self)
  4145. def build_library(self, node, args, kwargs):
  4146. default_library = self.coredata.get_builtin_option('default_library', self.subproject)
  4147. if default_library == 'shared':
  4148. return self.build_target(node, args, kwargs, SharedLibraryHolder)
  4149. elif default_library == 'static':
  4150. return self.build_target(node, args, kwargs, StaticLibraryHolder)
  4151. elif default_library == 'both':
  4152. return self.build_both_libraries(node, args, kwargs)
  4153. else:
  4154. raise InterpreterException('Unknown default_library value: %s.', default_library)
  4155. def build_target(self, node, args, kwargs, targetholder):
  4156. @FeatureNewKwargs('build target', '0.42.0', ['rust_crate_type', 'build_rpath', 'implicit_include_directories'])
  4157. @FeatureNewKwargs('build target', '0.41.0', ['rust_args'])
  4158. @FeatureNewKwargs('build target', '0.40.0', ['build_by_default'])
  4159. @FeatureNewKwargs('build target', '0.48.0', ['gnu_symbol_visibility'])
  4160. def build_target_decorator_caller(self, node, args, kwargs):
  4161. return True
  4162. build_target_decorator_caller(self, node, args, kwargs)
  4163. if not args:
  4164. raise InterpreterException('Target does not have a name.')
  4165. name, *sources = args
  4166. for_machine = self.machine_from_native_kwarg(kwargs)
  4167. if 'sources' in kwargs:
  4168. sources += listify(kwargs['sources'])
  4169. sources = self.source_strings_to_files(sources)
  4170. objs = extract_as_list(kwargs, 'objects')
  4171. kwargs['dependencies'] = extract_as_list(kwargs, 'dependencies')
  4172. kwargs['install_mode'] = self._get_kwarg_install_mode(kwargs)
  4173. if 'extra_files' in kwargs:
  4174. ef = extract_as_list(kwargs, 'extra_files')
  4175. kwargs['extra_files'] = self.source_strings_to_files(ef)
  4176. self.check_sources_exist(os.path.join(self.source_root, self.subdir), sources)
  4177. if targetholder == ExecutableHolder:
  4178. targetclass = build.Executable
  4179. elif targetholder == SharedLibraryHolder:
  4180. targetclass = build.SharedLibrary
  4181. elif targetholder == SharedModuleHolder:
  4182. targetclass = build.SharedModule
  4183. elif targetholder == StaticLibraryHolder:
  4184. targetclass = build.StaticLibrary
  4185. elif targetholder == JarHolder:
  4186. targetclass = build.Jar
  4187. else:
  4188. mlog.debug('Unknown target type:', str(targetholder))
  4189. raise RuntimeError('Unreachable code')
  4190. self.kwarg_strings_to_includedirs(kwargs)
  4191. # Filter out kwargs from other target types. For example 'soversion'
  4192. # passed to library() when default_library == 'static'.
  4193. kwargs = {k: v for k, v in kwargs.items() if k in targetclass.known_kwargs}
  4194. kwargs['include_directories'] = self.extract_incdirs(kwargs)
  4195. target = targetclass(name, self.subdir, self.subproject, for_machine, sources, objs, self.environment, kwargs)
  4196. target.project_version = self.project_version
  4197. if not self.environment.machines.matches_build_machine(for_machine):
  4198. self.add_cross_stdlib_info(target)
  4199. l = targetholder(target, self)
  4200. self.add_target(name, l.held_object)
  4201. self.project_args_frozen = True
  4202. return l
  4203. def kwarg_strings_to_includedirs(self, kwargs):
  4204. if 'd_import_dirs' in kwargs:
  4205. items = mesonlib.extract_as_list(kwargs, 'd_import_dirs')
  4206. cleaned_items = []
  4207. for i in items:
  4208. if isinstance(i, str):
  4209. # BW compatibility. This was permitted so we must support it
  4210. # for a few releases so people can transition to "correct"
  4211. # path declarations.
  4212. if os.path.normpath(i).startswith(self.environment.get_source_dir()):
  4213. mlog.warning('''Building a path to the source dir is not supported. Use a relative path instead.
  4214. This will become a hard error in the future.''', location=self.current_node)
  4215. i = os.path.relpath(i, os.path.join(self.environment.get_source_dir(), self.subdir))
  4216. i = self.build_incdir_object([i])
  4217. cleaned_items.append(i)
  4218. kwargs['d_import_dirs'] = cleaned_items
  4219. def get_used_languages(self, target):
  4220. result = {}
  4221. for i in target.sources:
  4222. # TODO other platforms
  4223. for lang, c in self.coredata.compilers.host.items():
  4224. if c.can_compile(i):
  4225. result[lang] = True
  4226. break
  4227. return result
  4228. def add_cross_stdlib_info(self, target):
  4229. if target.for_machine != MachineChoice.HOST:
  4230. return
  4231. for l in self.get_used_languages(target):
  4232. props = self.environment.properties.host
  4233. if props.has_stdlib(l) \
  4234. and self.subproject != props.get_stdlib(l)[0]:
  4235. target.add_deps(self.build.stdlibs.host[l])
  4236. def check_sources_exist(self, subdir, sources):
  4237. for s in sources:
  4238. if not isinstance(s, str):
  4239. continue # This means a generated source and they always exist.
  4240. fname = os.path.join(subdir, s)
  4241. if not os.path.isfile(fname):
  4242. raise InterpreterException('Tried to add non-existing source file %s.' % s)
  4243. # Only permit object extraction from the same subproject
  4244. def validate_extraction(self, buildtarget: InterpreterObject) -> None:
  4245. if not self.subdir.startswith(self.subproject_dir):
  4246. if buildtarget.subdir.startswith(self.subproject_dir):
  4247. raise InterpreterException('Tried to extract objects from a subproject target.')
  4248. else:
  4249. if not buildtarget.subdir.startswith(self.subproject_dir):
  4250. raise InterpreterException('Tried to extract objects from the main project from a subproject.')
  4251. if self.subdir.split('/')[1] != buildtarget.subdir.split('/')[1]:
  4252. raise InterpreterException('Tried to extract objects from a different subproject.')
  4253. def is_subproject(self):
  4254. return self.subproject != ''
  4255. @noKwargs
  4256. @noArgsFlattening
  4257. def func_set_variable(self, node, args, kwargs):
  4258. if len(args) != 2:
  4259. raise InvalidCode('Set_variable takes two arguments.')
  4260. varname, value = args
  4261. self.set_variable(varname, value)
  4262. @noKwargs
  4263. @noArgsFlattening
  4264. def func_get_variable(self, node, args, kwargs):
  4265. if len(args) < 1 or len(args) > 2:
  4266. raise InvalidCode('Get_variable takes one or two arguments.')
  4267. varname = args[0]
  4268. if isinstance(varname, Disabler):
  4269. return varname
  4270. if not isinstance(varname, str):
  4271. raise InterpreterException('First argument must be a string.')
  4272. try:
  4273. return self.variables[varname]
  4274. except KeyError:
  4275. pass
  4276. if len(args) == 2:
  4277. return args[1]
  4278. raise InterpreterException('Tried to get unknown variable "%s".' % varname)
  4279. @stringArgs
  4280. @noKwargs
  4281. def func_is_variable(self, node, args, kwargs):
  4282. if len(args) != 1:
  4283. raise InvalidCode('Is_variable takes two arguments.')
  4284. varname = args[0]
  4285. return varname in self.variables
  4286. @staticmethod
  4287. def machine_from_native_kwarg(kwargs: T.Dict[str, T.Any]) -> MachineChoice:
  4288. native = kwargs.get('native', False)
  4289. if not isinstance(native, bool):
  4290. raise InvalidArguments('Argument to "native" must be a boolean.')
  4291. return MachineChoice.BUILD if native else MachineChoice.HOST
  4292. @FeatureNew('is_disabler', '0.52.0')
  4293. @noKwargs
  4294. def func_is_disabler(self, node, args, kwargs):
  4295. if len(args) != 1:
  4296. raise InvalidCode('Is_disabler takes one argument.')
  4297. varname = args[0]
  4298. return isinstance(varname, Disabler)