interpreter.py 185 KB

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