interpreter.py 138 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087
  1. # Copyright 2012-2017 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, Popen_safe, listify, extract_as_list
  22. from .dependencies import ExternalProgram
  23. from .dependencies import InternalDependency, Dependency, DependencyException
  24. from .interpreterbase import InterpreterBase
  25. from .interpreterbase import check_stringlist, noPosargs, noKwargs, stringArgs, permittedKwargs
  26. from .interpreterbase import InterpreterException, InvalidArguments, InvalidCode
  27. from .interpreterbase import InterpreterObject, MutableInterpreterObject, Disabler
  28. from .modules import ModuleReturnValue
  29. import os, sys, shutil, uuid
  30. import re, shlex
  31. from collections import namedtuple
  32. import importlib
  33. run_depr_printed = False
  34. def stringifyUserArguments(args):
  35. if isinstance(args, list):
  36. return '[%s]' % ', '.join([stringifyUserArguments(x) for x in args])
  37. elif isinstance(args, int):
  38. return str(args)
  39. elif isinstance(args, str):
  40. return "'%s'" % args
  41. raise InvalidArguments('Function accepts only strings, integers, lists and lists thereof.')
  42. class ObjectHolder:
  43. def __init__(self, obj):
  44. self.held_object = obj
  45. def __repr__(self):
  46. return '<Holder: {!r}>'.format(self.held_object)
  47. class TryRunResultHolder(InterpreterObject):
  48. def __init__(self, res):
  49. super().__init__()
  50. self.res = res
  51. self.methods.update({'returncode': self.returncode_method,
  52. 'compiled': self.compiled_method,
  53. 'stdout': self.stdout_method,
  54. 'stderr': self.stderr_method,
  55. })
  56. def returncode_method(self, args, kwargs):
  57. return self.res.returncode
  58. def compiled_method(self, args, kwargs):
  59. return self.res.compiled
  60. def stdout_method(self, args, kwargs):
  61. return self.res.stdout
  62. def stderr_method(self, args, kwargs):
  63. return self.res.stderr
  64. class RunProcess(InterpreterObject):
  65. def __init__(self, cmd, args, source_dir, build_dir, subdir, mesonintrospect, in_builddir=False):
  66. super().__init__()
  67. if not isinstance(cmd, ExternalProgram):
  68. raise AssertionError('BUG: RunProcess must be passed an ExternalProgram')
  69. pc, self.stdout, self.stderr = self.run_command(cmd, args, source_dir, build_dir, subdir, mesonintrospect, in_builddir)
  70. self.returncode = pc.returncode
  71. self.methods.update({'returncode': self.returncode_method,
  72. 'stdout': self.stdout_method,
  73. 'stderr': self.stderr_method,
  74. })
  75. def run_command(self, cmd, args, source_dir, build_dir, subdir, mesonintrospect, in_builddir):
  76. command_array = cmd.get_command() + args
  77. env = {'MESON_SOURCE_ROOT': source_dir,
  78. 'MESON_BUILD_ROOT': build_dir,
  79. 'MESON_SUBDIR': subdir,
  80. 'MESONINTROSPECT': ' '.join([shlex.quote(x) for x in mesonintrospect]),
  81. }
  82. if in_builddir:
  83. cwd = os.path.join(build_dir, subdir)
  84. else:
  85. cwd = os.path.join(source_dir, subdir)
  86. child_env = os.environ.copy()
  87. child_env.update(env)
  88. mlog.debug('Running command:', ' '.join(command_array))
  89. try:
  90. p, o, e = Popen_safe(command_array, env=child_env, cwd=cwd)
  91. mlog.debug('--- stdout----')
  92. mlog.debug(o)
  93. mlog.debug('----stderr----')
  94. mlog.debug(e)
  95. mlog.debug('')
  96. return p, o, e
  97. except FileNotFoundError:
  98. raise InterpreterException('Could not execute command "%s".' % ' '.join(command_array))
  99. def returncode_method(self, args, kwargs):
  100. return self.returncode
  101. def stdout_method(self, args, kwargs):
  102. return self.stdout
  103. def stderr_method(self, args, kwargs):
  104. return self.stderr
  105. class ConfigureFileHolder(InterpreterObject, ObjectHolder):
  106. def __init__(self, subdir, sourcename, targetname, configuration_data):
  107. InterpreterObject.__init__(self)
  108. ObjectHolder.__init__(self, build.ConfigureFile(subdir, sourcename,
  109. targetname, configuration_data))
  110. class EnvironmentVariablesHolder(MutableInterpreterObject, ObjectHolder):
  111. def __init__(self):
  112. MutableInterpreterObject.__init__(self)
  113. ObjectHolder.__init__(self, build.EnvironmentVariables())
  114. self.methods.update({'set': self.set_method,
  115. 'append': self.append_method,
  116. 'prepend': self.prepend_method,
  117. })
  118. def __repr__(self):
  119. repr_str = "<{0}: {1}>"
  120. return repr_str.format(self.__class__.__name__, self.held_object.envvars)
  121. @stringArgs
  122. def add_var(self, method, args, kwargs):
  123. if not isinstance(kwargs.get("separator", ""), str):
  124. raise InterpreterException("EnvironmentVariablesHolder methods 'separator'"
  125. " argument needs to be a string.")
  126. if len(args) < 2:
  127. raise InterpreterException("EnvironmentVariablesHolder methods require at least"
  128. "2 arguments, first is the name of the variable and"
  129. " following one are values")
  130. self.held_object.envvars.append((method, args[0], args[1:], kwargs))
  131. def set_method(self, args, kwargs):
  132. self.add_var(self.held_object.set, args, kwargs)
  133. def append_method(self, args, kwargs):
  134. self.add_var(self.held_object.append, args, kwargs)
  135. def prepend_method(self, args, kwargs):
  136. self.add_var(self.held_object.prepend, args, kwargs)
  137. class ConfigurationDataHolder(MutableInterpreterObject, ObjectHolder):
  138. def __init__(self):
  139. MutableInterpreterObject.__init__(self)
  140. self.used = False # These objects become immutable after use in configure_file.
  141. ObjectHolder.__init__(self, build.ConfigurationData())
  142. self.methods.update({'set': self.set_method,
  143. 'set10': self.set10_method,
  144. 'set_quoted': self.set_quoted_method,
  145. 'has': self.has_method,
  146. 'get': self.get_method,
  147. 'get_unquoted': self.get_unquoted_method,
  148. 'merge_from': self.merge_from_method,
  149. })
  150. def is_used(self):
  151. return self.used
  152. def mark_used(self):
  153. self.used = True
  154. def validate_args(self, args, kwargs):
  155. if len(args) != 2:
  156. raise InterpreterException("Configuration set requires 2 arguments.")
  157. if self.used:
  158. raise InterpreterException("Can not set values on configuration object that has been used.")
  159. name = args[0]
  160. val = args[1]
  161. desc = kwargs.get('description', None)
  162. if not isinstance(name, str):
  163. raise InterpreterException("First argument to set must be a string.")
  164. if desc is not None and not isinstance(desc, str):
  165. raise InterpreterException('Description must be a string.')
  166. return name, val, desc
  167. def set_method(self, args, kwargs):
  168. (name, val, desc) = self.validate_args(args, kwargs)
  169. self.held_object.values[name] = (val, desc)
  170. def set_quoted_method(self, args, kwargs):
  171. (name, val, desc) = self.validate_args(args, kwargs)
  172. if not isinstance(val, str):
  173. raise InterpreterException("Second argument to set_quoted must be a string.")
  174. escaped_val = '\\"'.join(val.split('"'))
  175. self.held_object.values[name] = ('"' + escaped_val + '"', desc)
  176. def set10_method(self, args, kwargs):
  177. (name, val, desc) = self.validate_args(args, kwargs)
  178. if val:
  179. self.held_object.values[name] = (1, desc)
  180. else:
  181. self.held_object.values[name] = (0, desc)
  182. def has_method(self, args, kwargs):
  183. return args[0] in self.held_object.values
  184. def get_method(self, args, kwargs):
  185. if len(args) < 1 or len(args) > 2:
  186. raise InterpreterException('Get method takes one or two arguments.')
  187. name = args[0]
  188. if name in self.held_object:
  189. return self.held_object.get(name)[0]
  190. if len(args) > 1:
  191. return args[1]
  192. raise InterpreterException('Entry %s not in configuration data.' % name)
  193. def get_unquoted_method(self, args, kwargs):
  194. if len(args) < 1 or len(args) > 2:
  195. raise InterpreterException('Get method takes one or two arguments.')
  196. name = args[0]
  197. if name in self.held_object:
  198. val = self.held_object.get(name)[0]
  199. elif len(args) > 1:
  200. val = args[1]
  201. else:
  202. raise InterpreterException('Entry %s not in configuration data.' % name)
  203. if val[0] == '"' and val[-1] == '"':
  204. return val[1:-1]
  205. return val
  206. def get(self, name):
  207. return self.held_object.values[name] # (val, desc)
  208. def keys(self):
  209. return self.held_object.values.keys()
  210. def merge_from_method(self, args, kwargs):
  211. if len(args) != 1:
  212. raise InterpreterException('Merge_from takes one positional argument.')
  213. from_object = args[0]
  214. if not isinstance(from_object, ConfigurationDataHolder):
  215. raise InterpreterException('Merge_from argument must be a configuration data object.')
  216. from_object = from_object.held_object
  217. for k, v in from_object.values.items():
  218. self.held_object.values[k] = v
  219. # Interpreter objects can not be pickled so we must have
  220. # these wrappers.
  221. class DependencyHolder(InterpreterObject, ObjectHolder):
  222. def __init__(self, dep):
  223. InterpreterObject.__init__(self)
  224. ObjectHolder.__init__(self, dep)
  225. self.methods.update({'found': self.found_method,
  226. 'type_name': self.type_name_method,
  227. 'version': self.version_method,
  228. 'get_pkgconfig_variable': self.pkgconfig_method,
  229. 'get_configtool_variable': self.configtool_method,
  230. })
  231. def type_name_method(self, args, kwargs):
  232. return self.held_object.type_name
  233. def found_method(self, args, kwargs):
  234. if self.held_object.type_name == 'internal':
  235. return True
  236. return self.held_object.found()
  237. def version_method(self, args, kwargs):
  238. return self.held_object.get_version()
  239. def pkgconfig_method(self, args, kwargs):
  240. args = listify(args)
  241. if len(args) != 1:
  242. raise InterpreterException('get_pkgconfig_variable takes exactly one argument.')
  243. varname = args[0]
  244. if not isinstance(varname, str):
  245. raise InterpreterException('Variable name must be a string.')
  246. return self.held_object.get_pkgconfig_variable(varname, kwargs)
  247. def configtool_method(self, args, kwargs):
  248. args = listify(args)
  249. if len(args) != 1:
  250. raise InterpreterException('get_configtool_variable takes exactly one argument.')
  251. varname = args[0]
  252. if not isinstance(varname, str):
  253. raise InterpreterException('Variable name must be a string.')
  254. return self.held_object.get_configtool_variable(varname)
  255. class InternalDependencyHolder(InterpreterObject, ObjectHolder):
  256. def __init__(self, dep):
  257. InterpreterObject.__init__(self)
  258. ObjectHolder.__init__(self, dep)
  259. self.methods.update({'found': self.found_method,
  260. 'version': self.version_method,
  261. })
  262. def found_method(self, args, kwargs):
  263. return True
  264. def version_method(self, args, kwargs):
  265. return self.held_object.get_version()
  266. class ExternalProgramHolder(InterpreterObject, ObjectHolder):
  267. def __init__(self, ep):
  268. InterpreterObject.__init__(self)
  269. ObjectHolder.__init__(self, ep)
  270. self.methods.update({'found': self.found_method,
  271. 'path': self.path_method})
  272. def found_method(self, args, kwargs):
  273. return self.found()
  274. def path_method(self, args, kwargs):
  275. return self.held_object.get_path()
  276. def found(self):
  277. return self.held_object.found()
  278. def get_command(self):
  279. return self.held_object.get_command()
  280. def get_name(self):
  281. return self.held_object.get_name()
  282. class ExternalLibraryHolder(InterpreterObject, ObjectHolder):
  283. def __init__(self, el):
  284. InterpreterObject.__init__(self)
  285. ObjectHolder.__init__(self, el)
  286. self.methods.update({'found': self.found_method})
  287. def found(self):
  288. return self.held_object.found()
  289. def found_method(self, args, kwargs):
  290. return self.found()
  291. def get_name(self):
  292. return self.held_object.name
  293. def get_compile_args(self):
  294. return self.held_object.get_compile_args()
  295. def get_link_args(self):
  296. return self.held_object.get_link_args()
  297. def get_exe_args(self):
  298. return self.held_object.get_exe_args()
  299. class GeneratorHolder(InterpreterObject, ObjectHolder):
  300. def __init__(self, interpreter, args, kwargs):
  301. InterpreterObject.__init__(self)
  302. self.interpreter = interpreter
  303. ObjectHolder.__init__(self, build.Generator(args, kwargs))
  304. self.methods.update({'process': self.process_method})
  305. def process_method(self, args, kwargs):
  306. extras = mesonlib.stringlistify(kwargs.get('extra_args', []))
  307. gl = self.held_object.process_files('Generator', args, self.interpreter, extra_args=extras)
  308. return GeneratedListHolder(gl)
  309. class GeneratedListHolder(InterpreterObject, ObjectHolder):
  310. def __init__(self, arg1, extra_args=[]):
  311. InterpreterObject.__init__(self)
  312. if isinstance(arg1, GeneratorHolder):
  313. ObjectHolder.__init__(self, build.GeneratedList(arg1.held_object, extra_args))
  314. else:
  315. ObjectHolder.__init__(self, arg1)
  316. def __repr__(self):
  317. r = '<{}: {!r}>'
  318. return r.format(self.__class__.__name__, self.held_object.get_outputs())
  319. def add_file(self, a):
  320. self.held_object.add_file(a)
  321. class BuildMachine(InterpreterObject, ObjectHolder):
  322. def __init__(self, compilers):
  323. self.compilers = compilers
  324. InterpreterObject.__init__(self)
  325. held_object = environment.MachineInfo(environment.detect_system(),
  326. environment.detect_cpu_family(self.compilers),
  327. environment.detect_cpu(self.compilers),
  328. sys.byteorder)
  329. ObjectHolder.__init__(self, held_object)
  330. self.methods.update({'system': self.system_method,
  331. 'cpu_family': self.cpu_family_method,
  332. 'cpu': self.cpu_method,
  333. 'endian': self.endian_method,
  334. })
  335. def cpu_family_method(self, args, kwargs):
  336. return self.held_object.cpu_family
  337. def cpu_method(self, args, kwargs):
  338. return self.held_object.cpu
  339. def system_method(self, args, kwargs):
  340. return self.held_object.system
  341. def endian_method(self, args, kwargs):
  342. return self.held_object.endian
  343. # This class will provide both host_machine and
  344. # target_machine
  345. class CrossMachineInfo(InterpreterObject, ObjectHolder):
  346. def __init__(self, cross_info):
  347. InterpreterObject.__init__(self)
  348. minimum_cross_info = {'cpu', 'cpu_family', 'endian', 'system'}
  349. if set(cross_info) < minimum_cross_info:
  350. raise InterpreterException(
  351. 'Machine info is currently {}\n'.format(cross_info) +
  352. 'but is missing {}.'.format(minimum_cross_info - set(cross_info)))
  353. self.info = cross_info
  354. minfo = environment.MachineInfo(cross_info['system'],
  355. cross_info['cpu_family'],
  356. cross_info['cpu'],
  357. cross_info['endian'])
  358. ObjectHolder.__init__(self, minfo)
  359. self.methods.update({'system': self.system_method,
  360. 'cpu': self.cpu_method,
  361. 'cpu_family': self.cpu_family_method,
  362. 'endian': self.endian_method,
  363. })
  364. def cpu_family_method(self, args, kwargs):
  365. return self.held_object.cpu_family
  366. def cpu_method(self, args, kwargs):
  367. return self.held_object.cpu
  368. def system_method(self, args, kwargs):
  369. return self.held_object.system
  370. def endian_method(self, args, kwargs):
  371. return self.held_object.endian
  372. class IncludeDirsHolder(InterpreterObject, ObjectHolder):
  373. def __init__(self, idobj):
  374. InterpreterObject.__init__(self)
  375. ObjectHolder.__init__(self, idobj)
  376. class Headers(InterpreterObject):
  377. def __init__(self, sources, kwargs):
  378. InterpreterObject.__init__(self)
  379. self.sources = sources
  380. self.install_subdir = kwargs.get('subdir', '')
  381. self.custom_install_dir = kwargs.get('install_dir', None)
  382. if self.custom_install_dir is not None:
  383. if not isinstance(self.custom_install_dir, str):
  384. raise InterpreterException('Custom_install_dir must be a string.')
  385. def set_install_subdir(self, subdir):
  386. self.install_subdir = subdir
  387. def get_install_subdir(self):
  388. return self.install_subdir
  389. def get_sources(self):
  390. return self.sources
  391. def get_custom_install_dir(self):
  392. return self.custom_install_dir
  393. class DataHolder(InterpreterObject, ObjectHolder):
  394. def __init__(self, data):
  395. InterpreterObject.__init__(self)
  396. ObjectHolder.__init__(self, data)
  397. def get_source_subdir(self):
  398. return self.held_object.source_subdir
  399. def get_sources(self):
  400. return self.held_object.sources
  401. def get_install_dir(self):
  402. return self.held_object.install_dir
  403. class InstallDir(InterpreterObject):
  404. def __init__(self, src_subdir, inst_subdir, install_dir, install_mode, exclude):
  405. InterpreterObject.__init__(self)
  406. self.source_subdir = src_subdir
  407. self.installable_subdir = inst_subdir
  408. self.install_dir = install_dir
  409. self.install_mode = install_mode
  410. self.exclude = exclude
  411. class Man(InterpreterObject):
  412. def __init__(self, sources, kwargs):
  413. InterpreterObject.__init__(self)
  414. self.sources = sources
  415. self.validate_sources()
  416. self.custom_install_dir = kwargs.get('install_dir', None)
  417. if self.custom_install_dir is not None and not isinstance(self.custom_install_dir, str):
  418. raise InterpreterException('Custom_install_dir must be a string.')
  419. def validate_sources(self):
  420. for s in self.sources:
  421. try:
  422. num = int(s.split('.')[-1])
  423. except (IndexError, ValueError):
  424. num = 0
  425. if num < 1 or num > 8:
  426. raise InvalidArguments('Man file must have a file extension of a number between 1 and 8')
  427. def get_custom_install_dir(self):
  428. return self.custom_install_dir
  429. def get_sources(self):
  430. return self.sources
  431. class GeneratedObjectsHolder(InterpreterObject, ObjectHolder):
  432. def __init__(self, held_object):
  433. InterpreterObject.__init__(self)
  434. ObjectHolder.__init__(self, held_object)
  435. class TargetHolder(InterpreterObject, ObjectHolder):
  436. def __init__(self, target, interp):
  437. InterpreterObject.__init__(self)
  438. ObjectHolder.__init__(self, target)
  439. self.interpreter = interp
  440. class BuildTargetHolder(TargetHolder):
  441. def __init__(self, target, interp):
  442. super().__init__(target, interp)
  443. self.methods.update({'extract_objects': self.extract_objects_method,
  444. 'extract_all_objects': self.extract_all_objects_method,
  445. 'get_id': self.get_id_method,
  446. 'outdir': self.outdir_method,
  447. 'full_path': self.full_path_method,
  448. 'private_dir_include': self.private_dir_include_method,
  449. })
  450. def __repr__(self):
  451. r = '<{} {}: {}>'
  452. h = self.held_object
  453. return r.format(self.__class__.__name__, h.get_id(), h.filename)
  454. def is_cross(self):
  455. return self.held_object.is_cross()
  456. def private_dir_include_method(self, args, kwargs):
  457. return IncludeDirsHolder(build.IncludeDirs('', [], False,
  458. [self.interpreter.backend.get_target_private_dir(self.held_object)]))
  459. def full_path_method(self, args, kwargs):
  460. return self.interpreter.backend.get_target_filename_abs(self.held_object)
  461. def outdir_method(self, args, kwargs):
  462. return self.interpreter.backend.get_target_dir(self.held_object)
  463. def extract_objects_method(self, args, kwargs):
  464. gobjs = self.held_object.extract_objects(args)
  465. return GeneratedObjectsHolder(gobjs)
  466. def extract_all_objects_method(self, args, kwargs):
  467. gobjs = self.held_object.extract_all_objects()
  468. return GeneratedObjectsHolder(gobjs)
  469. def get_id_method(self, args, kwargs):
  470. return self.held_object.get_id()
  471. class ExecutableHolder(BuildTargetHolder):
  472. def __init__(self, target, interp):
  473. super().__init__(target, interp)
  474. class StaticLibraryHolder(BuildTargetHolder):
  475. def __init__(self, target, interp):
  476. super().__init__(target, interp)
  477. class SharedLibraryHolder(BuildTargetHolder):
  478. def __init__(self, target, interp):
  479. super().__init__(target, interp)
  480. class SharedModuleHolder(BuildTargetHolder):
  481. def __init__(self, target, interp):
  482. super().__init__(target, interp)
  483. class JarHolder(BuildTargetHolder):
  484. def __init__(self, target, interp):
  485. super().__init__(target, interp)
  486. class CustomTargetIndexHolder(InterpreterObject, ObjectHolder):
  487. def __init__(self, object_to_hold):
  488. InterpreterObject.__init__(self)
  489. ObjectHolder.__init__(self, object_to_hold)
  490. class CustomTargetHolder(TargetHolder):
  491. def __init__(self, target, interp):
  492. super().__init__(target, interp)
  493. self.methods.update({'full_path': self.full_path_method,
  494. })
  495. def __repr__(self):
  496. r = '<{} {}: {}>'
  497. h = self.held_object
  498. return r.format(self.__class__.__name__, h.get_id(), h.command)
  499. def full_path_method(self, args, kwargs):
  500. return self.interpreter.backend.get_target_filename_abs(self.held_object)
  501. def __getitem__(self, index):
  502. return CustomTargetIndexHolder(self.held_object[index])
  503. def __setitem__(self, index, value):
  504. raise InterpreterException('Cannot set a member of a CustomTarget')
  505. def __delitem__(self, index):
  506. raise InterpreterException('Cannot delete a member of a CustomTarget')
  507. class RunTargetHolder(InterpreterObject, ObjectHolder):
  508. def __init__(self, name, command, args, dependencies, subdir, subproject):
  509. InterpreterObject.__init__(self)
  510. ObjectHolder.__init__(self, build.RunTarget(name, command, args, dependencies, subdir, subproject))
  511. def __repr__(self):
  512. r = '<{} {}: {}>'
  513. h = self.held_object
  514. return r.format(self.__class__.__name__, h.get_id(), h.command)
  515. class Test(InterpreterObject):
  516. def __init__(self, name, suite, exe, is_parallel, cmd_args, env, should_fail, timeout, workdir):
  517. InterpreterObject.__init__(self)
  518. self.name = name
  519. self.suite = suite
  520. self.exe = exe
  521. self.is_parallel = is_parallel
  522. self.cmd_args = cmd_args
  523. self.env = env
  524. self.should_fail = should_fail
  525. self.timeout = timeout
  526. self.workdir = workdir
  527. def get_exe(self):
  528. return self.exe
  529. def get_name(self):
  530. return self.name
  531. class SubprojectHolder(InterpreterObject, ObjectHolder):
  532. def __init__(self, subinterpreter):
  533. InterpreterObject.__init__(self)
  534. ObjectHolder.__init__(self, subinterpreter)
  535. self.methods.update({'get_variable': self.get_variable_method,
  536. })
  537. def get_variable_method(self, args, kwargs):
  538. if len(args) != 1:
  539. raise InterpreterException('Get_variable takes one argument.')
  540. varname = args[0]
  541. if not isinstance(varname, str):
  542. raise InterpreterException('Get_variable takes a string argument.')
  543. return self.held_object.variables[varname]
  544. class CompilerHolder(InterpreterObject):
  545. def __init__(self, compiler, env):
  546. InterpreterObject.__init__(self)
  547. self.compiler = compiler
  548. self.environment = env
  549. self.methods.update({'compiles': self.compiles_method,
  550. 'links': self.links_method,
  551. 'get_id': self.get_id_method,
  552. 'compute_int': self.compute_int_method,
  553. 'sizeof': self.sizeof_method,
  554. 'get_define': self.get_define_method,
  555. 'has_header': self.has_header_method,
  556. 'has_header_symbol': self.has_header_symbol_method,
  557. 'run': self.run_method,
  558. 'has_function': self.has_function_method,
  559. 'has_member': self.has_member_method,
  560. 'has_members': self.has_members_method,
  561. 'has_type': self.has_type_method,
  562. 'alignment': self.alignment_method,
  563. 'version': self.version_method,
  564. 'cmd_array': self.cmd_array_method,
  565. 'find_library': self.find_library_method,
  566. 'has_argument': self.has_argument_method,
  567. 'has_multi_arguments': self.has_multi_arguments_method,
  568. 'get_supported_arguments': self.get_supported_arguments_method,
  569. 'first_supported_argument': self.first_supported_argument_method,
  570. 'unittest_args': self.unittest_args_method,
  571. 'symbols_have_underscore_prefix': self.symbols_have_underscore_prefix_method,
  572. })
  573. def version_method(self, args, kwargs):
  574. return self.compiler.version
  575. def cmd_array_method(self, args, kwargs):
  576. return self.compiler.exelist
  577. def determine_args(self, kwargs):
  578. nobuiltins = kwargs.get('no_builtin_args', False)
  579. if not isinstance(nobuiltins, bool):
  580. raise InterpreterException('Type of no_builtin_args not a boolean.')
  581. args = []
  582. incdirs = extract_as_list(kwargs, 'include_directories')
  583. for i in incdirs:
  584. if not isinstance(i, IncludeDirsHolder):
  585. raise InterpreterException('Include directories argument must be an include_directories object.')
  586. for idir in i.held_object.get_incdirs():
  587. idir = os.path.join(self.environment.get_source_dir(),
  588. i.held_object.get_curdir(), idir)
  589. args += self.compiler.get_include_args(idir, False)
  590. if not nobuiltins:
  591. opts = self.environment.coredata.compiler_options
  592. args += self.compiler.get_option_compile_args(opts)
  593. args += self.compiler.get_option_link_args(opts)
  594. args += mesonlib.stringlistify(kwargs.get('args', []))
  595. return args
  596. def determine_dependencies(self, kwargs):
  597. deps = kwargs.get('dependencies', None)
  598. if deps is not None:
  599. deps = listify(deps)
  600. final_deps = []
  601. for d in deps:
  602. try:
  603. d = d.held_object
  604. except Exception:
  605. pass
  606. if isinstance(d, InternalDependency) or not isinstance(d, Dependency):
  607. raise InterpreterException('Dependencies must be external dependencies')
  608. final_deps.append(d)
  609. deps = final_deps
  610. return deps
  611. def alignment_method(self, args, kwargs):
  612. if len(args) != 1:
  613. raise InterpreterException('Alignment method takes exactly one positional argument.')
  614. check_stringlist(args)
  615. typename = args[0]
  616. prefix = kwargs.get('prefix', '')
  617. if not isinstance(prefix, str):
  618. raise InterpreterException('Prefix argument of sizeof must be a string.')
  619. extra_args = mesonlib.stringlistify(kwargs.get('args', []))
  620. deps = self.determine_dependencies(kwargs)
  621. result = self.compiler.alignment(typename, prefix, self.environment, extra_args, deps)
  622. mlog.log('Checking for alignment of "', mlog.bold(typename), '": ', result, sep='')
  623. return result
  624. def run_method(self, args, kwargs):
  625. if len(args) != 1:
  626. raise InterpreterException('Run method takes exactly one positional argument.')
  627. code = args[0]
  628. if isinstance(code, mesonlib.File):
  629. code = mesonlib.File.from_absolute_file(
  630. code.rel_to_builddir(self.environment.source_dir))
  631. elif not isinstance(code, str):
  632. raise InvalidArguments('Argument must be string or file.')
  633. testname = kwargs.get('name', '')
  634. if not isinstance(testname, str):
  635. raise InterpreterException('Testname argument must be a string.')
  636. extra_args = self.determine_args(kwargs)
  637. deps = self.determine_dependencies(kwargs)
  638. result = self.compiler.run(code, self.environment, extra_args, deps)
  639. if len(testname) > 0:
  640. if not result.compiled:
  641. h = mlog.red('DID NOT COMPILE')
  642. elif result.returncode == 0:
  643. h = mlog.green('YES')
  644. else:
  645. h = mlog.red('NO (%d)' % result.returncode)
  646. mlog.log('Checking if "', mlog.bold(testname), '" runs: ', h, sep='')
  647. return TryRunResultHolder(result)
  648. def get_id_method(self, args, kwargs):
  649. return self.compiler.get_id()
  650. def symbols_have_underscore_prefix_method(self, args, kwargs):
  651. '''
  652. Check if the compiler prefixes _ (underscore) to global C symbols
  653. See: https://en.wikipedia.org/wiki/Name_mangling#C
  654. '''
  655. return self.compiler.symbols_have_underscore_prefix(self.environment)
  656. def unittest_args_method(self, args, kwargs):
  657. '''
  658. This function is deprecated and should not be used.
  659. It can be removed in a future version of Meson.
  660. '''
  661. if not hasattr(self.compiler, 'get_feature_args'):
  662. raise InterpreterException('This {} compiler has no feature arguments.'.format(self.compiler.get_display_language()))
  663. return self.compiler.get_feature_args({'unittest': 'true'})
  664. def has_member_method(self, args, kwargs):
  665. if len(args) != 2:
  666. raise InterpreterException('Has_member takes exactly two arguments.')
  667. check_stringlist(args)
  668. typename = args[0]
  669. membername = args[1]
  670. prefix = kwargs.get('prefix', '')
  671. if not isinstance(prefix, str):
  672. raise InterpreterException('Prefix argument of has_member must be a string.')
  673. extra_args = self.determine_args(kwargs)
  674. deps = self.determine_dependencies(kwargs)
  675. had = self.compiler.has_members(typename, [membername], prefix,
  676. self.environment, extra_args, deps)
  677. if had:
  678. hadtxt = mlog.green('YES')
  679. else:
  680. hadtxt = mlog.red('NO')
  681. mlog.log('Checking whether type "', mlog.bold(typename),
  682. '" has member "', mlog.bold(membername), '": ', hadtxt, sep='')
  683. return had
  684. def has_members_method(self, args, kwargs):
  685. check_stringlist(args)
  686. typename = args[0]
  687. membernames = args[1:]
  688. prefix = kwargs.get('prefix', '')
  689. if not isinstance(prefix, str):
  690. raise InterpreterException('Prefix argument of has_members must be a string.')
  691. extra_args = self.determine_args(kwargs)
  692. deps = self.determine_dependencies(kwargs)
  693. had = self.compiler.has_members(typename, membernames, prefix,
  694. self.environment, extra_args, deps)
  695. if had:
  696. hadtxt = mlog.green('YES')
  697. else:
  698. hadtxt = mlog.red('NO')
  699. members = mlog.bold(', '.join(['"{}"'.format(m) for m in membernames]))
  700. mlog.log('Checking whether type "', mlog.bold(typename),
  701. '" has members ', members, ': ', hadtxt, sep='')
  702. return had
  703. def has_function_method(self, args, kwargs):
  704. if len(args) != 1:
  705. raise InterpreterException('Has_function takes exactly one argument.')
  706. check_stringlist(args)
  707. funcname = args[0]
  708. prefix = kwargs.get('prefix', '')
  709. if not isinstance(prefix, str):
  710. raise InterpreterException('Prefix argument of has_function must be a string.')
  711. extra_args = self.determine_args(kwargs)
  712. deps = self.determine_dependencies(kwargs)
  713. had = self.compiler.has_function(funcname, prefix, self.environment, extra_args, deps)
  714. if had:
  715. hadtxt = mlog.green('YES')
  716. else:
  717. hadtxt = mlog.red('NO')
  718. mlog.log('Checking for function "', mlog.bold(funcname), '": ', hadtxt, sep='')
  719. return had
  720. def has_type_method(self, args, kwargs):
  721. if len(args) != 1:
  722. raise InterpreterException('Has_type takes exactly one argument.')
  723. check_stringlist(args)
  724. typename = args[0]
  725. prefix = kwargs.get('prefix', '')
  726. if not isinstance(prefix, str):
  727. raise InterpreterException('Prefix argument of has_type must be a string.')
  728. extra_args = self.determine_args(kwargs)
  729. deps = self.determine_dependencies(kwargs)
  730. had = self.compiler.has_type(typename, prefix, self.environment, extra_args, deps)
  731. if had:
  732. hadtxt = mlog.green('YES')
  733. else:
  734. hadtxt = mlog.red('NO')
  735. mlog.log('Checking for type "', mlog.bold(typename), '": ', hadtxt, sep='')
  736. return had
  737. def compute_int_method(self, args, kwargs):
  738. if len(args) != 1:
  739. raise InterpreterException('Compute_int takes exactly one argument.')
  740. check_stringlist(args)
  741. expression = args[0]
  742. prefix = kwargs.get('prefix', '')
  743. l = kwargs.get('low', -1024)
  744. h = kwargs.get('high', 1024)
  745. guess = kwargs.get('guess', None)
  746. if not isinstance(prefix, str):
  747. raise InterpreterException('Prefix argument of compute_int must be a string.')
  748. if not isinstance(l, int):
  749. raise InterpreterException('Low argument of compute_int must be an int.')
  750. if not isinstance(h, int):
  751. raise InterpreterException('High argument of compute_int must be an int.')
  752. if guess is not None and not isinstance(guess, int):
  753. raise InterpreterException('Guess argument of compute_int must be an int.')
  754. extra_args = self.determine_args(kwargs)
  755. deps = self.determine_dependencies(kwargs)
  756. res = self.compiler.compute_int(expression, l, h, guess, prefix, self.environment, extra_args, deps)
  757. mlog.log('Computing int of "%s": %d' % (expression, res))
  758. return res
  759. def sizeof_method(self, args, kwargs):
  760. if len(args) != 1:
  761. raise InterpreterException('Sizeof takes exactly one argument.')
  762. check_stringlist(args)
  763. element = args[0]
  764. prefix = kwargs.get('prefix', '')
  765. if not isinstance(prefix, str):
  766. raise InterpreterException('Prefix argument of sizeof must be a string.')
  767. extra_args = self.determine_args(kwargs)
  768. deps = self.determine_dependencies(kwargs)
  769. esize = self.compiler.sizeof(element, prefix, self.environment, extra_args, deps)
  770. mlog.log('Checking for size of "%s": %d' % (element, esize))
  771. return esize
  772. def get_define_method(self, args, kwargs):
  773. if len(args) != 1:
  774. raise InterpreterException('get_define() takes exactly one argument.')
  775. check_stringlist(args)
  776. element = args[0]
  777. prefix = kwargs.get('prefix', '')
  778. if not isinstance(prefix, str):
  779. raise InterpreterException('Prefix argument of get_define() must be a string.')
  780. extra_args = self.determine_args(kwargs)
  781. deps = self.determine_dependencies(kwargs)
  782. value = self.compiler.get_define(element, prefix, self.environment, extra_args, deps)
  783. mlog.log('Fetching value of define "%s": %s' % (element, value))
  784. return value
  785. def compiles_method(self, args, kwargs):
  786. if len(args) != 1:
  787. raise InterpreterException('compiles method takes exactly one argument.')
  788. code = args[0]
  789. if isinstance(code, mesonlib.File):
  790. code = mesonlib.File.from_absolute_file(
  791. code.rel_to_builddir(self.environment.source_dir))
  792. elif not isinstance(code, str):
  793. raise InvalidArguments('Argument must be string or file.')
  794. testname = kwargs.get('name', '')
  795. if not isinstance(testname, str):
  796. raise InterpreterException('Testname argument must be a string.')
  797. extra_args = self.determine_args(kwargs)
  798. deps = self.determine_dependencies(kwargs)
  799. result = self.compiler.compiles(code, self.environment, extra_args, deps)
  800. if len(testname) > 0:
  801. if result:
  802. h = mlog.green('YES')
  803. else:
  804. h = mlog.red('NO')
  805. mlog.log('Checking if "', mlog.bold(testname), '" compiles: ', h, sep='')
  806. return result
  807. def links_method(self, args, kwargs):
  808. if len(args) != 1:
  809. raise InterpreterException('links method takes exactly one argument.')
  810. code = args[0]
  811. if isinstance(code, mesonlib.File):
  812. code = mesonlib.File.from_absolute_file(
  813. code.rel_to_builddir(self.environment.source_dir))
  814. elif not isinstance(code, str):
  815. raise InvalidArguments('Argument must be string or file.')
  816. testname = kwargs.get('name', '')
  817. if not isinstance(testname, str):
  818. raise InterpreterException('Testname argument must be a string.')
  819. extra_args = self.determine_args(kwargs)
  820. deps = self.determine_dependencies(kwargs)
  821. result = self.compiler.links(code, self.environment, extra_args, deps)
  822. if len(testname) > 0:
  823. if result:
  824. h = mlog.green('YES')
  825. else:
  826. h = mlog.red('NO')
  827. mlog.log('Checking if "', mlog.bold(testname), '" links: ', h, sep='')
  828. return result
  829. def has_header_method(self, args, kwargs):
  830. if len(args) != 1:
  831. raise InterpreterException('has_header method takes exactly one argument.')
  832. check_stringlist(args)
  833. hname = args[0]
  834. prefix = kwargs.get('prefix', '')
  835. if not isinstance(prefix, str):
  836. raise InterpreterException('Prefix argument of has_header must be a string.')
  837. extra_args = self.determine_args(kwargs)
  838. deps = self.determine_dependencies(kwargs)
  839. haz = self.compiler.has_header(hname, prefix, self.environment, extra_args, deps)
  840. if haz:
  841. h = mlog.green('YES')
  842. else:
  843. h = mlog.red('NO')
  844. mlog.log('Has header "%s":' % hname, h)
  845. return haz
  846. def has_header_symbol_method(self, args, kwargs):
  847. if len(args) != 2:
  848. raise InterpreterException('has_header_symbol method takes exactly two arguments.')
  849. check_stringlist(args)
  850. hname = args[0]
  851. symbol = args[1]
  852. prefix = kwargs.get('prefix', '')
  853. if not isinstance(prefix, str):
  854. raise InterpreterException('Prefix argument of has_header_symbol must be a string.')
  855. extra_args = self.determine_args(kwargs)
  856. deps = self.determine_dependencies(kwargs)
  857. haz = self.compiler.has_header_symbol(hname, symbol, prefix, self.environment, extra_args, deps)
  858. if haz:
  859. h = mlog.green('YES')
  860. else:
  861. h = mlog.red('NO')
  862. mlog.log('Header <{0}> has symbol "{1}":'.format(hname, symbol), h)
  863. return haz
  864. def find_library_method(self, args, kwargs):
  865. # TODO add dependencies support?
  866. if len(args) != 1:
  867. raise InterpreterException('find_library method takes one argument.')
  868. libname = args[0]
  869. if not isinstance(libname, str):
  870. raise InterpreterException('Library name not a string.')
  871. required = kwargs.get('required', True)
  872. if not isinstance(required, bool):
  873. raise InterpreterException('required must be boolean.')
  874. search_dirs = mesonlib.stringlistify(kwargs.get('dirs', []))
  875. for i in search_dirs:
  876. if not os.path.isabs(i):
  877. raise InvalidCode('Search directory %s is not an absolute path.' % i)
  878. linkargs = self.compiler.find_library(libname, self.environment, search_dirs)
  879. if required and not linkargs:
  880. raise InterpreterException('{} library {!r} not found'.format(self.compiler.get_display_language(), libname))
  881. lib = dependencies.ExternalLibrary(libname, linkargs, self.environment,
  882. self.compiler.language)
  883. return ExternalLibraryHolder(lib)
  884. def has_argument_method(self, args, kwargs):
  885. args = mesonlib.stringlistify(args)
  886. if len(args) != 1:
  887. raise InterpreterException('Has_arg takes exactly one argument.')
  888. result = self.compiler.has_argument(args[0], self.environment)
  889. if result:
  890. h = mlog.green('YES')
  891. else:
  892. h = mlog.red('NO')
  893. mlog.log('Compiler for {} supports argument {}:'.format(self.compiler.get_display_language(), args[0]), h)
  894. return result
  895. def has_multi_arguments_method(self, args, kwargs):
  896. args = mesonlib.stringlistify(args)
  897. result = self.compiler.has_multi_arguments(args, self.environment)
  898. if result:
  899. h = mlog.green('YES')
  900. else:
  901. h = mlog.red('NO')
  902. mlog.log(
  903. 'Compiler for {} supports arguments {}:'.format(
  904. self.compiler.get_display_language(), ' '.join(args)),
  905. h)
  906. return result
  907. def get_supported_arguments_method(self, args, kwargs):
  908. args = mesonlib.stringlistify(args)
  909. result = self.compiler.get_supported_arguments(args, self.environment)
  910. if len(result) == len(args):
  911. h = mlog.green('YES')
  912. elif len(result) > 0:
  913. h = mlog.yellow('SOME')
  914. else:
  915. h = mlog.red('NO')
  916. mlog.log(
  917. 'Compiler for {} supports arguments {}:'.format(
  918. self.compiler.get_display_language(), ' '.join(args)),
  919. h)
  920. return result
  921. def first_supported_argument_method(self, args, kwargs):
  922. for i in mesonlib.stringlistify(args):
  923. if self.compiler.has_argument(i, self.environment):
  924. mlog.log('First supported argument:', mlog.bold(i))
  925. return [i]
  926. mlog.log('First supported argument:', mlog.red('None'))
  927. return []
  928. ModuleState = namedtuple('ModuleState', [
  929. 'build_to_src', 'subproject', 'subdir', 'current_lineno', 'environment',
  930. 'project_name', 'project_version', 'backend', 'compilers', 'targets',
  931. 'data', 'headers', 'man', 'global_args', 'project_args', 'build_machine',
  932. 'host_machine', 'target_machine'])
  933. class ModuleHolder(InterpreterObject, ObjectHolder):
  934. def __init__(self, modname, module, interpreter):
  935. InterpreterObject.__init__(self)
  936. ObjectHolder.__init__(self, module)
  937. self.modname = modname
  938. self.interpreter = interpreter
  939. def method_call(self, method_name, args, kwargs):
  940. try:
  941. fn = getattr(self.held_object, method_name)
  942. except AttributeError:
  943. raise InvalidArguments('Module %s does not have method %s.' % (self.modname, method_name))
  944. if method_name.startswith('_'):
  945. raise InvalidArguments('Function {!r} in module {!r} is private.'.format(method_name, self.modname))
  946. # This is not 100% reliable but we can't use hash()
  947. # because the Build object contains dicts and lists.
  948. num_targets = len(self.interpreter.build.targets)
  949. state = ModuleState(
  950. build_to_src=os.path.relpath(self.interpreter.environment.get_source_dir(),
  951. self.interpreter.environment.get_build_dir()),
  952. subproject=self.interpreter.subproject,
  953. subdir=self.interpreter.subdir,
  954. current_lineno=self.interpreter.current_lineno,
  955. environment=self.interpreter.environment,
  956. project_name=self.interpreter.build.project_name,
  957. project_version=self.interpreter.build.dep_manifest[self.interpreter.active_projectname],
  958. # The backend object is under-used right now, but we will need it:
  959. # https://github.com/mesonbuild/meson/issues/1419
  960. backend=self.interpreter.backend,
  961. compilers=self.interpreter.build.compilers,
  962. targets=self.interpreter.build.targets,
  963. data=self.interpreter.build.data,
  964. headers=self.interpreter.build.get_headers(),
  965. man=self.interpreter.build.get_man(),
  966. global_args=self.interpreter.build.global_args,
  967. project_args=self.interpreter.build.projects_args.get(self.interpreter.subproject, {}),
  968. build_machine=self.interpreter.builtin['build_machine'].held_object,
  969. host_machine=self.interpreter.builtin['host_machine'].held_object,
  970. target_machine=self.interpreter.builtin['target_machine'].held_object,
  971. )
  972. if self.held_object.is_snippet(method_name):
  973. value = fn(self.interpreter, state, args, kwargs)
  974. return self.interpreter.holderify(value)
  975. else:
  976. value = fn(state, args, kwargs)
  977. if num_targets != len(self.interpreter.build.targets):
  978. raise InterpreterException('Extension module altered internal state illegally.')
  979. return self.interpreter.module_method_callback(value)
  980. class MesonMain(InterpreterObject):
  981. def __init__(self, build, interpreter):
  982. InterpreterObject.__init__(self)
  983. self.build = build
  984. self.interpreter = interpreter
  985. self._found_source_scripts = {}
  986. self.methods.update({'get_compiler': self.get_compiler_method,
  987. 'is_cross_build': self.is_cross_build_method,
  988. 'has_exe_wrapper': self.has_exe_wrapper_method,
  989. 'is_unity': self.is_unity_method,
  990. 'is_subproject': self.is_subproject_method,
  991. 'current_source_dir': self.current_source_dir_method,
  992. 'current_build_dir': self.current_build_dir_method,
  993. 'source_root': self.source_root_method,
  994. 'build_root': self.build_root_method,
  995. 'add_install_script': self.add_install_script_method,
  996. 'add_postconf_script': self.add_postconf_script_method,
  997. 'install_dependency_manifest': self.install_dependency_manifest_method,
  998. 'project_version': self.project_version_method,
  999. 'version': self.version_method,
  1000. 'project_name': self.project_name_method,
  1001. 'get_cross_property': self.get_cross_property_method,
  1002. 'backend': self.backend_method,
  1003. })
  1004. def _find_source_script(self, name, args):
  1005. # Prefer scripts in the current source directory
  1006. search_dir = os.path.join(self.interpreter.environment.source_dir,
  1007. self.interpreter.subdir)
  1008. key = (name, search_dir)
  1009. if key in self._found_source_scripts:
  1010. found = self._found_source_scripts[key]
  1011. else:
  1012. found = dependencies.ExternalProgram(name, search_dir=search_dir)
  1013. if found.found():
  1014. self._found_source_scripts[key] = found
  1015. else:
  1016. m = 'Script or command {!r} not found or not executable'
  1017. raise InterpreterException(m.format(name))
  1018. return build.RunScript(found.get_command(), args)
  1019. def add_install_script_method(self, args, kwargs):
  1020. if len(args) < 1:
  1021. raise InterpreterException('add_install_script takes one or more arguments')
  1022. check_stringlist(args, 'add_install_script args must be strings')
  1023. script = self._find_source_script(args[0], args[1:])
  1024. self.build.install_scripts.append(script)
  1025. def add_postconf_script_method(self, args, kwargs):
  1026. if len(args) < 1:
  1027. raise InterpreterException('add_postconf_script takes one or more arguments')
  1028. check_stringlist(args, 'add_postconf_script arguments must be strings')
  1029. script = self._find_source_script(args[0], args[1:])
  1030. self.build.postconf_scripts.append(script)
  1031. def current_source_dir_method(self, args, kwargs):
  1032. src = self.interpreter.environment.source_dir
  1033. sub = self.interpreter.subdir
  1034. if sub == '':
  1035. return src
  1036. return os.path.join(src, sub)
  1037. def current_build_dir_method(self, args, kwargs):
  1038. src = self.interpreter.environment.build_dir
  1039. sub = self.interpreter.subdir
  1040. if sub == '':
  1041. return src
  1042. return os.path.join(src, sub)
  1043. def backend_method(self, args, kwargs):
  1044. return self.interpreter.backend.name
  1045. def source_root_method(self, args, kwargs):
  1046. return self.interpreter.environment.source_dir
  1047. def build_root_method(self, args, kwargs):
  1048. return self.interpreter.environment.build_dir
  1049. def has_exe_wrapper_method(self, args, kwargs):
  1050. if self.is_cross_build_method(None, None) and \
  1051. 'binaries' in self.build.environment.cross_info.config and \
  1052. self.build.environment.cross_info.need_exe_wrapper():
  1053. exe_wrap = self.build.environment.cross_info.config['binaries'].get('exe_wrapper', None)
  1054. if exe_wrap is None:
  1055. return False
  1056. # We return True when exe_wrap is defined, when it's not needed, and
  1057. # when we're compiling natively. The last two are semantically confusing.
  1058. # Need to revisit this.
  1059. return True
  1060. def is_cross_build_method(self, args, kwargs):
  1061. return self.build.environment.is_cross_build()
  1062. def get_compiler_method(self, args, kwargs):
  1063. if len(args) != 1:
  1064. raise InterpreterException('get_compiler_method must have one and only one argument.')
  1065. cname = args[0]
  1066. native = kwargs.get('native', None)
  1067. if native is None:
  1068. if self.build.environment.is_cross_build():
  1069. native = False
  1070. else:
  1071. native = True
  1072. if not isinstance(native, bool):
  1073. raise InterpreterException('Type of "native" must be a boolean.')
  1074. if native:
  1075. clist = self.build.compilers
  1076. else:
  1077. clist = self.build.cross_compilers
  1078. if cname in clist:
  1079. return CompilerHolder(clist[cname], self.build.environment)
  1080. raise InterpreterException('Tried to access compiler for unspecified language "%s".' % cname)
  1081. def is_unity_method(self, args, kwargs):
  1082. optval = self.interpreter.environment.coredata.get_builtin_option('unity')
  1083. if optval == 'on' or (optval == 'subprojects' and self.interpreter.subproject != ''):
  1084. return True
  1085. return False
  1086. def is_subproject_method(self, args, kwargs):
  1087. return self.interpreter.is_subproject()
  1088. def install_dependency_manifest_method(self, args, kwargs):
  1089. if len(args) != 1:
  1090. raise InterpreterException('Must specify manifest install file name')
  1091. if not isinstance(args[0], str):
  1092. raise InterpreterException('Argument must be a string.')
  1093. self.build.dep_manifest_name = args[0]
  1094. def project_version_method(self, args, kwargs):
  1095. return self.build.dep_manifest[self.interpreter.active_projectname]['version']
  1096. def version_method(self, args, kwargs):
  1097. return coredata.version
  1098. def project_name_method(self, args, kwargs):
  1099. return self.interpreter.active_projectname
  1100. def get_cross_property_method(self, args, kwargs):
  1101. if len(args) < 1 or len(args) > 2:
  1102. raise InterpreterException('Must have one or two arguments.')
  1103. propname = args[0]
  1104. if not isinstance(propname, str):
  1105. raise InterpreterException('Property name must be string.')
  1106. try:
  1107. props = self.interpreter.environment.cross_info.get_properties()
  1108. return props[propname]
  1109. except Exception:
  1110. if len(args) == 2:
  1111. return args[1]
  1112. raise InterpreterException('Unknown cross property: %s.' % propname)
  1113. pch_kwargs = set(['c_pch', 'cpp_pch'])
  1114. lang_arg_kwargs = set([
  1115. 'c_args',
  1116. 'cpp_args',
  1117. 'd_args',
  1118. 'd_import_dirs',
  1119. 'd_unittest',
  1120. 'd_module_versions',
  1121. 'fortran_args',
  1122. 'java_args',
  1123. 'objc_args',
  1124. 'objcpp_args',
  1125. 'rust_args',
  1126. 'vala_args',
  1127. 'cs_args',
  1128. ])
  1129. vala_kwargs = set(['vala_header', 'vala_gir', 'vala_vapi'])
  1130. rust_kwargs = set(['rust_crate_type'])
  1131. cs_kwargs = set(['resources', 'cs_args'])
  1132. buildtarget_kwargs = set([
  1133. 'build_by_default',
  1134. 'build_rpath',
  1135. 'dependencies',
  1136. 'extra_files',
  1137. 'gui_app',
  1138. 'link_with',
  1139. 'link_whole',
  1140. 'link_args',
  1141. 'link_depends',
  1142. 'implicit_include_directories',
  1143. 'include_directories',
  1144. 'install',
  1145. 'install_rpath',
  1146. 'install_dir',
  1147. 'name_prefix',
  1148. 'name_suffix',
  1149. 'native',
  1150. 'objects',
  1151. 'override_options',
  1152. 'pic',
  1153. 'sources',
  1154. 'vs_module_defs',
  1155. ])
  1156. build_target_common_kwargs = (
  1157. buildtarget_kwargs |
  1158. lang_arg_kwargs |
  1159. pch_kwargs |
  1160. vala_kwargs |
  1161. rust_kwargs |
  1162. cs_kwargs)
  1163. exe_kwargs = (build_target_common_kwargs) | {'implib'}
  1164. shlib_kwargs = (build_target_common_kwargs) | {'version', 'soversion'}
  1165. shmod_kwargs = shlib_kwargs
  1166. stlib_kwargs = shlib_kwargs
  1167. jar_kwargs = exe_kwargs.copy()
  1168. jar_kwargs.update(['main_class'])
  1169. build_target_kwargs = exe_kwargs.copy()
  1170. build_target_kwargs.update(['target_type'])
  1171. permitted_kwargs = {'add_global_arguments': {'language'},
  1172. 'add_global_link_arguments': {'language'},
  1173. 'add_project_link_arguments': {'language'},
  1174. 'add_languages': {'required'},
  1175. 'add_project_arguments': {'language'},
  1176. 'add_test_setup': {'exe_wrapper', 'gdb', 'timeout_multiplier', 'env'},
  1177. 'benchmark': {'args', 'env', 'should_fail', 'timeout', 'workdir', 'suite'},
  1178. 'build_target': build_target_kwargs,
  1179. 'configure_file': {'input', 'output', 'configuration', 'command', 'install_dir', 'capture', 'install'},
  1180. 'custom_target': {'input', 'output', 'command', 'install', 'install_dir', 'build_always', 'capture', 'depends', 'depend_files', 'depfile', 'build_by_default'},
  1181. 'dependency': {'default_options', 'fallback', 'language', 'method', 'modules', 'optional_modules', 'native', 'required', 'static', 'version'},
  1182. 'declare_dependency': {'include_directories', 'link_with', 'sources', 'dependencies', 'compile_args', 'link_args', 'version'},
  1183. 'executable': exe_kwargs,
  1184. 'find_program': {'required', 'native'},
  1185. 'generator': {'arguments', 'output', 'depfile', 'capture'},
  1186. 'include_directories': {'is_system'},
  1187. 'install_data': {'install_dir', 'install_mode', 'sources'},
  1188. 'install_headers': {'install_dir', 'subdir'},
  1189. 'install_man': {'install_dir'},
  1190. 'install_subdir': {'exclude_files', 'exclude_directories', 'install_dir', 'install_mode'},
  1191. 'jar': jar_kwargs,
  1192. 'project': {'version', 'meson_version', 'default_options', 'license', 'subproject_dir'},
  1193. 'run_target': {'command', 'depends'},
  1194. 'shared_library': shlib_kwargs,
  1195. 'shared_module': shmod_kwargs,
  1196. 'static_library': stlib_kwargs,
  1197. 'subdir': {'if_found'},
  1198. 'subproject': {'version', 'default_options'},
  1199. 'test': {'args', 'env', 'is_parallel', 'should_fail', 'timeout', 'workdir', 'suite'},
  1200. 'vcs_tag': {'input', 'output', 'fallback', 'command', 'replace_string'},
  1201. }
  1202. class Interpreter(InterpreterBase):
  1203. def __init__(self, build, backend, subproject='', subdir='', subproject_dir='subprojects',
  1204. default_project_options=[]):
  1205. super().__init__(build.environment.get_source_dir(), subdir)
  1206. self.an_unpicklable_object = mesonlib.an_unpicklable_object
  1207. self.build = build
  1208. self.environment = build.environment
  1209. self.coredata = self.environment.get_coredata()
  1210. self.backend = backend
  1211. self.subproject = subproject
  1212. # Subproject directory is usually the name of the subproject, but can
  1213. # be different for dependencies provided by wrap files.
  1214. self.subproject_directory_name = subdir.split(os.path.sep)[-1]
  1215. self.subproject_dir = subproject_dir
  1216. self.option_file = os.path.join(self.source_root, self.subdir, 'meson_options.txt')
  1217. self.load_root_meson_file()
  1218. self.sanity_check_ast()
  1219. self.builtin.update({'meson': MesonMain(build, self)})
  1220. self.generators = []
  1221. self.visited_subdirs = {}
  1222. self.project_args_frozen = False
  1223. self.global_args_frozen = False # implies self.project_args_frozen
  1224. self.subprojects = {}
  1225. self.subproject_stack = []
  1226. self.default_project_options = default_project_options[:] # Passed from the outside, only used in subprojects.
  1227. self.build_func_dict()
  1228. # build_def_files needs to be defined before parse_project is called
  1229. self.build_def_files = [os.path.join(self.subdir, environment.build_filename)]
  1230. self.parse_project()
  1231. self.builtin['build_machine'] = BuildMachine(self.coredata.compilers)
  1232. if not self.build.environment.is_cross_build():
  1233. self.builtin['host_machine'] = self.builtin['build_machine']
  1234. self.builtin['target_machine'] = self.builtin['build_machine']
  1235. else:
  1236. cross_info = self.build.environment.cross_info
  1237. if cross_info.has_host():
  1238. self.builtin['host_machine'] = CrossMachineInfo(cross_info.config['host_machine'])
  1239. else:
  1240. self.builtin['host_machine'] = self.builtin['build_machine']
  1241. if cross_info.has_target():
  1242. self.builtin['target_machine'] = CrossMachineInfo(cross_info.config['target_machine'])
  1243. else:
  1244. self.builtin['target_machine'] = self.builtin['host_machine']
  1245. def build_func_dict(self):
  1246. self.funcs.update({'add_global_arguments': self.func_add_global_arguments,
  1247. 'add_project_arguments': self.func_add_project_arguments,
  1248. 'add_global_link_arguments': self.func_add_global_link_arguments,
  1249. 'add_project_link_arguments': self.func_add_project_link_arguments,
  1250. 'add_test_setup': self.func_add_test_setup,
  1251. 'add_languages': self.func_add_languages,
  1252. 'assert': self.func_assert,
  1253. 'benchmark': self.func_benchmark,
  1254. 'build_target': self.func_build_target,
  1255. 'configuration_data': self.func_configuration_data,
  1256. 'configure_file': self.func_configure_file,
  1257. 'custom_target': self.func_custom_target,
  1258. 'declare_dependency': self.func_declare_dependency,
  1259. 'dependency': self.func_dependency,
  1260. 'disabler': self.func_disabler,
  1261. 'environment': self.func_environment,
  1262. 'error': self.func_error,
  1263. 'executable': self.func_executable,
  1264. 'generator': self.func_generator,
  1265. 'gettext': self.func_gettext,
  1266. 'get_option': self.func_get_option,
  1267. 'get_variable': self.func_get_variable,
  1268. 'files': self.func_files,
  1269. 'find_library': self.func_find_library,
  1270. 'find_program': self.func_find_program,
  1271. 'include_directories': self.func_include_directories,
  1272. 'import': self.func_import,
  1273. 'install_data': self.func_install_data,
  1274. 'install_headers': self.func_install_headers,
  1275. 'install_man': self.func_install_man,
  1276. 'install_subdir': self.func_install_subdir,
  1277. 'is_variable': self.func_is_variable,
  1278. 'jar': self.func_jar,
  1279. 'join_paths': self.func_join_paths,
  1280. 'library': self.func_library,
  1281. 'message': self.func_message,
  1282. 'warning': self.func_warning,
  1283. 'option': self.func_option,
  1284. 'project': self.func_project,
  1285. 'run_target': self.func_run_target,
  1286. 'run_command': self.func_run_command,
  1287. 'set_variable': self.func_set_variable,
  1288. 'subdir': self.func_subdir,
  1289. 'subproject': self.func_subproject,
  1290. 'shared_library': self.func_shared_lib,
  1291. 'shared_module': self.func_shared_module,
  1292. 'static_library': self.func_static_lib,
  1293. 'test': self.func_test,
  1294. 'vcs_tag': self.func_vcs_tag,
  1295. })
  1296. def holderify(self, item):
  1297. if isinstance(item, list):
  1298. return [self.holderify(x) for x in item]
  1299. if isinstance(item, build.CustomTarget):
  1300. return CustomTargetHolder(item, self)
  1301. elif isinstance(item, (int, str)) or item is None:
  1302. return item
  1303. elif isinstance(item, build.Executable):
  1304. return ExecutableHolder(item, self)
  1305. elif isinstance(item, build.GeneratedList):
  1306. return GeneratedListHolder(item)
  1307. elif isinstance(item, build.RunTarget):
  1308. raise RuntimeError('This is not a pipe.')
  1309. elif isinstance(item, build.RunScript):
  1310. raise RuntimeError('Do not do this.')
  1311. elif isinstance(item, build.Data):
  1312. return DataHolder(item)
  1313. elif isinstance(item, dependencies.InternalDependency):
  1314. return InternalDependencyHolder(item)
  1315. elif isinstance(item, dependencies.ExternalProgram):
  1316. return ExternalProgramHolder(item)
  1317. elif hasattr(item, 'held_object'):
  1318. return item
  1319. else:
  1320. raise InterpreterException('Module returned a value of unknown type.')
  1321. def process_new_values(self, invalues):
  1322. invalues = listify(invalues)
  1323. for v in invalues:
  1324. if isinstance(v, (build.BuildTarget, build.CustomTarget, build.RunTarget)):
  1325. self.add_target(v.name, v)
  1326. elif isinstance(v, list):
  1327. self.module_method_callback(v)
  1328. elif isinstance(v, build.GeneratedList):
  1329. pass
  1330. elif isinstance(v, build.RunScript):
  1331. self.build.install_scripts.append(v)
  1332. elif isinstance(v, build.Data):
  1333. self.build.data.append(v)
  1334. elif isinstance(v, dependencies.ExternalProgram):
  1335. return ExternalProgramHolder(v)
  1336. elif isinstance(v, dependencies.InternalDependency):
  1337. # FIXME: This is special cased and not ideal:
  1338. # The first source is our new VapiTarget, the rest are deps
  1339. self.process_new_values(v.sources[0])
  1340. elif hasattr(v, 'held_object'):
  1341. pass
  1342. else:
  1343. raise InterpreterException('Module returned a value of unknown type.')
  1344. def module_method_callback(self, return_object):
  1345. if not isinstance(return_object, ModuleReturnValue):
  1346. raise InterpreterException('Bug in module, it returned an invalid object')
  1347. invalues = return_object.new_objects
  1348. self.process_new_values(invalues)
  1349. return self.holderify(return_object.return_value)
  1350. def get_build_def_files(self):
  1351. return self.build_def_files
  1352. def get_variables(self):
  1353. return self.variables
  1354. def check_cross_stdlibs(self):
  1355. if self.build.environment.is_cross_build():
  1356. cross_info = self.build.environment.cross_info
  1357. for l, c in self.build.cross_compilers.items():
  1358. try:
  1359. di = mesonlib.stringlistify(cross_info.get_stdlib(l))
  1360. if len(di) != 2:
  1361. raise InterpreterException('Stdlib definition for %s should have exactly two elements.'
  1362. % l)
  1363. projname, depname = di
  1364. subproj = self.do_subproject(projname, {})
  1365. self.build.cross_stdlibs[l] = subproj.get_variable_method([depname], {})
  1366. except KeyError:
  1367. pass
  1368. @stringArgs
  1369. @noKwargs
  1370. def func_import(self, node, args, kwargs):
  1371. if len(args) != 1:
  1372. raise InvalidCode('Import takes one argument.')
  1373. modname = args[0]
  1374. if modname.startswith('unstable-'):
  1375. plainname = modname.split('-', 1)[1]
  1376. mlog.warning('Module %s has no backwards or forwards compatibility and might not exist in future releases.' % modname)
  1377. modname = 'unstable_' + plainname
  1378. if modname not in self.environment.coredata.modules:
  1379. try:
  1380. module = importlib.import_module('mesonbuild.modules.' + modname)
  1381. except ImportError:
  1382. raise InvalidArguments('Module "%s" does not exist' % (modname, ))
  1383. self.environment.coredata.modules[modname] = module.initialize()
  1384. return ModuleHolder(modname, self.environment.coredata.modules[modname], self)
  1385. @stringArgs
  1386. @noKwargs
  1387. def func_files(self, node, args, kwargs):
  1388. return [mesonlib.File.from_source_file(self.environment.source_dir, self.subdir, fname) for fname in args]
  1389. @permittedKwargs(permitted_kwargs['declare_dependency'])
  1390. @noPosargs
  1391. def func_declare_dependency(self, node, args, kwargs):
  1392. version = kwargs.get('version', self.project_version)
  1393. if not isinstance(version, str):
  1394. raise InterpreterException('Version must be a string.')
  1395. incs = extract_as_list(kwargs, 'include_directories', unholder=True)
  1396. libs = extract_as_list(kwargs, 'link_with', unholder=True)
  1397. sources = extract_as_list(kwargs, 'sources')
  1398. sources = listify(self.source_strings_to_files(sources), unholder=True)
  1399. deps = extract_as_list(kwargs, 'dependencies', unholder=True)
  1400. compile_args = mesonlib.stringlistify(kwargs.get('compile_args', []))
  1401. link_args = mesonlib.stringlistify(kwargs.get('link_args', []))
  1402. final_deps = []
  1403. for d in deps:
  1404. try:
  1405. d = d.held_object
  1406. except Exception:
  1407. pass
  1408. if not isinstance(d, (dependencies.Dependency, dependencies.ExternalLibrary, dependencies.InternalDependency)):
  1409. raise InterpreterException('Dependencies must be external deps')
  1410. final_deps.append(d)
  1411. for l in libs:
  1412. if isinstance(l, dependencies.Dependency):
  1413. raise InterpreterException('''Entries in "link_with" may only be self-built targets,
  1414. external dependencies (including libraries) must go to "dependencies".''')
  1415. dep = dependencies.InternalDependency(version, incs, compile_args,
  1416. link_args, libs, sources, final_deps)
  1417. return DependencyHolder(dep)
  1418. @noKwargs
  1419. def func_assert(self, node, args, kwargs):
  1420. if len(args) != 2:
  1421. raise InterpreterException('Assert takes exactly two arguments')
  1422. value, message = args
  1423. if not isinstance(value, bool):
  1424. raise InterpreterException('Assert value not bool.')
  1425. if not isinstance(message, str):
  1426. raise InterpreterException('Assert message not a string.')
  1427. if not value:
  1428. raise InterpreterException('Assert failed: ' + message)
  1429. def validate_arguments(self, args, argcount, arg_types):
  1430. if argcount is not None:
  1431. if argcount != len(args):
  1432. raise InvalidArguments('Expected %d arguments, got %d.' %
  1433. (argcount, len(args)))
  1434. for i in range(min(len(args), len(arg_types))):
  1435. wanted = arg_types[i]
  1436. actual = args[i]
  1437. if wanted is not None:
  1438. if not isinstance(actual, wanted):
  1439. raise InvalidArguments('Incorrect argument type.')
  1440. @noKwargs
  1441. def func_run_command(self, node, args, kwargs):
  1442. return self.run_command_impl(node, args, kwargs)
  1443. def run_command_impl(self, node, args, kwargs, in_builddir=False):
  1444. if len(args) < 1:
  1445. raise InterpreterException('Not enough arguments')
  1446. cmd = args[0]
  1447. cargs = args[1:]
  1448. srcdir = self.environment.get_source_dir()
  1449. builddir = self.environment.get_build_dir()
  1450. m = 'must be a string, or the output of find_program(), files(), or ' \
  1451. 'configure_file(); not {!r}'
  1452. if isinstance(cmd, ExternalProgramHolder):
  1453. cmd = cmd.held_object
  1454. else:
  1455. if isinstance(cmd, mesonlib.File):
  1456. cmd = cmd.absolute_path(srcdir, builddir)
  1457. elif not isinstance(cmd, str):
  1458. raise InterpreterException('First argument ' + m.format(cmd))
  1459. # Prefer scripts in the current source directory
  1460. search_dir = os.path.join(srcdir, self.subdir)
  1461. prog = ExternalProgram(cmd, silent=True, search_dir=search_dir)
  1462. if not prog.found():
  1463. raise InterpreterException('Program or command {!r} not found'
  1464. 'or not executable'.format(cmd))
  1465. cmd = prog
  1466. cmd_path = os.path.relpath(cmd.get_path(), start=srcdir)
  1467. if not cmd_path.startswith('..') and cmd_path not in self.build_def_files:
  1468. self.build_def_files.append(cmd_path)
  1469. expanded_args = []
  1470. for a in listify(cargs):
  1471. if isinstance(a, str):
  1472. expanded_args.append(a)
  1473. elif isinstance(a, mesonlib.File):
  1474. expanded_args.append(a.absolute_path(srcdir, builddir))
  1475. elif isinstance(a, ExternalProgramHolder):
  1476. expanded_args.append(a.held_object.get_path())
  1477. else:
  1478. raise InterpreterException('Arguments ' + m.format(a))
  1479. for a in expanded_args:
  1480. if not os.path.isabs(a):
  1481. a = os.path.join(builddir if in_builddir else srcdir, self.subdir, a)
  1482. if os.path.exists(a):
  1483. a = os.path.relpath(a, start=srcdir)
  1484. if not a.startswith('..'):
  1485. if a not in self.build_def_files:
  1486. self.build_def_files.append(a)
  1487. return RunProcess(cmd, expanded_args, srcdir, builddir, self.subdir,
  1488. self.environment.get_build_command() + ['introspect'], in_builddir)
  1489. @stringArgs
  1490. def func_gettext(self, nodes, args, kwargs):
  1491. raise InterpreterException('Gettext() function has been moved to module i18n. Import it and use i18n.gettext() instead')
  1492. def func_option(self, nodes, args, kwargs):
  1493. raise InterpreterException('Tried to call option() in build description file. All options must be in the option file.')
  1494. @permittedKwargs(permitted_kwargs['subproject'])
  1495. @stringArgs
  1496. def func_subproject(self, nodes, args, kwargs):
  1497. if len(args) != 1:
  1498. raise InterpreterException('Subproject takes exactly one argument')
  1499. dirname = args[0]
  1500. return self.do_subproject(dirname, kwargs)
  1501. def do_subproject(self, dirname, kwargs):
  1502. if '/' in dirname or '\\' in dirname:
  1503. raise InterpreterException('Subproject name must not contain a path separator.')
  1504. if dirname in self.subproject_stack:
  1505. fullstack = self.subproject_stack + [dirname]
  1506. incpath = ' => '.join(fullstack)
  1507. raise InvalidCode('Recursive include of subprojects: %s.' % incpath)
  1508. if dirname in self.subprojects:
  1509. return self.subprojects[dirname]
  1510. subproject_dir_abs = os.path.join(self.environment.get_source_dir(), self.subproject_dir)
  1511. r = wrap.Resolver(subproject_dir_abs, self.coredata.wrap_mode)
  1512. try:
  1513. resolved = r.resolve(dirname)
  1514. except RuntimeError as e:
  1515. msg = 'Subproject directory {!r} does not exist and cannot be downloaded:\n{}'
  1516. raise InterpreterException(msg.format(os.path.join(self.subproject_dir, dirname), e))
  1517. subdir = os.path.join(self.subproject_dir, resolved)
  1518. os.makedirs(os.path.join(self.build.environment.get_build_dir(), subdir), exist_ok=True)
  1519. self.global_args_frozen = True
  1520. mlog.log('\nExecuting subproject ', mlog.bold(dirname), '.\n', sep='')
  1521. subi = Interpreter(self.build, self.backend, dirname, subdir, self.subproject_dir,
  1522. mesonlib.stringlistify(kwargs.get('default_options', [])))
  1523. subi.subprojects = self.subprojects
  1524. subi.subproject_stack = self.subproject_stack + [dirname]
  1525. current_active = self.active_projectname
  1526. subi.run()
  1527. if 'version' in kwargs:
  1528. pv = subi.project_version
  1529. wanted = kwargs['version']
  1530. if pv == 'undefined' or not mesonlib.version_compare(pv, wanted):
  1531. raise InterpreterException('Subproject %s version is %s but %s required.' % (dirname, pv, wanted))
  1532. self.active_projectname = current_active
  1533. mlog.log('\nSubproject', mlog.bold(dirname), 'finished.')
  1534. self.build.subprojects[dirname] = subi.project_version
  1535. self.subprojects.update(subi.subprojects)
  1536. self.subprojects[dirname] = SubprojectHolder(subi)
  1537. self.build_def_files += subi.build_def_files
  1538. return self.subprojects[dirname]
  1539. @stringArgs
  1540. @noKwargs
  1541. def func_get_option(self, nodes, args, kwargs):
  1542. if len(args) != 1:
  1543. raise InterpreterException('Argument required for get_option.')
  1544. optname = args[0]
  1545. if ':' in optname:
  1546. raise InterpreterException('''Having a colon in option name is forbidden, projects are not allowed
  1547. to directly access options of other subprojects.''')
  1548. try:
  1549. return self.environment.get_coredata().base_options[optname].value
  1550. except KeyError:
  1551. pass
  1552. try:
  1553. return self.environment.coredata.get_builtin_option(optname)
  1554. except RuntimeError:
  1555. pass
  1556. try:
  1557. return self.environment.coredata.compiler_options[optname].value
  1558. except KeyError:
  1559. pass
  1560. if not coredata.is_builtin_option(optname) and self.is_subproject():
  1561. optname = self.subproject + ':' + optname
  1562. try:
  1563. return self.environment.coredata.user_options[optname].value
  1564. except KeyError:
  1565. pass
  1566. if optname.endswith('_link_args'):
  1567. try:
  1568. lang = optname[:-10]
  1569. return self.coredata.external_link_args[lang]
  1570. except KeyError:
  1571. pass
  1572. if optname.endswith('_args'):
  1573. try:
  1574. lang = optname[:-5]
  1575. return self.coredata.external_args[lang]
  1576. except KeyError:
  1577. pass
  1578. # Some base options are not defined in some environments, return the default value.
  1579. try:
  1580. return compilers.base_options[optname].value
  1581. except KeyError:
  1582. pass
  1583. raise InterpreterException('Tried to access unknown option "%s".' % optname)
  1584. @noKwargs
  1585. def func_configuration_data(self, node, args, kwargs):
  1586. if args:
  1587. raise InterpreterException('configuration_data takes no arguments')
  1588. return ConfigurationDataHolder()
  1589. def parse_default_options(self, default_options):
  1590. default_options = listify(default_options)
  1591. for option in default_options:
  1592. if not isinstance(option, str):
  1593. mlog.debug(option)
  1594. raise InterpreterException('Default options must be strings')
  1595. if '=' not in option:
  1596. raise InterpreterException('All default options must be of type key=value.')
  1597. key, value = option.split('=', 1)
  1598. if coredata.is_builtin_option(key):
  1599. if self.subproject != '':
  1600. continue # Only the master project is allowed to set global options.
  1601. if not self.environment.had_argument_for(key):
  1602. self.coredata.set_builtin_option(key, value)
  1603. # If this was set on the command line, do not override.
  1604. else:
  1605. # Option values set with subproject() default_options override those
  1606. # set in project() default_options.
  1607. pref = key + '='
  1608. for i in self.default_project_options:
  1609. if i.startswith(pref):
  1610. option = i
  1611. break
  1612. # If we are in a subproject, add the subproject prefix to option
  1613. # name.
  1614. if self.subproject != '':
  1615. option = self.subproject + ':' + option
  1616. newoptions = [option] + self.environment.cmd_line_options.projectoptions
  1617. self.environment.cmd_line_options.projectoptions = newoptions
  1618. # Add options that are only in default_options.
  1619. for defopt in self.default_project_options:
  1620. key, value = defopt.split('=')
  1621. pref = key + '='
  1622. for i in default_options:
  1623. if i.startswith(pref):
  1624. break
  1625. else:
  1626. defopt = self.subproject + ':' + defopt
  1627. newoptions = [defopt] + self.environment.cmd_line_options.projectoptions
  1628. self.environment.cmd_line_options.projectoptions = newoptions
  1629. @stringArgs
  1630. @permittedKwargs(permitted_kwargs['project'])
  1631. def func_project(self, node, args, kwargs):
  1632. if len(args) < 1:
  1633. raise InvalidArguments('Not enough arguments to project(). Needs at least the project name.')
  1634. proj_name = args[0]
  1635. proj_langs = args[1:]
  1636. if ':' in proj_name:
  1637. raise InvalidArguments("Project name {!r} must not contain ':'".format(proj_name))
  1638. default_options = kwargs.get('default_options', [])
  1639. if self.environment.first_invocation and (len(default_options) > 0 or
  1640. len(self.default_project_options) > 0):
  1641. self.parse_default_options(default_options)
  1642. if not self.is_subproject():
  1643. self.build.project_name = proj_name
  1644. if os.path.exists(self.option_file):
  1645. oi = optinterpreter.OptionInterpreter(self.subproject,
  1646. self.build.environment.cmd_line_options.projectoptions,
  1647. )
  1648. oi.process(self.option_file)
  1649. self.build.environment.merge_options(oi.options)
  1650. self.active_projectname = proj_name
  1651. self.project_version = kwargs.get('version', 'undefined')
  1652. if self.build.project_version is None:
  1653. self.build.project_version = self.project_version
  1654. proj_license = mesonlib.stringlistify(kwargs.get('license', 'unknown'))
  1655. self.build.dep_manifest[proj_name] = {'version': self.project_version,
  1656. 'license': proj_license}
  1657. if self.subproject in self.build.projects:
  1658. raise InvalidCode('Second call to project().')
  1659. if not self.is_subproject() and 'subproject_dir' in kwargs:
  1660. spdirname = kwargs['subproject_dir']
  1661. if '/' in spdirname or '\\' in spdirname:
  1662. raise InterpreterException('Subproject_dir must not contain a path segment.')
  1663. if spdirname.startswith('.'):
  1664. raise InterpreterException('Subproject_dir must not begin with a period.')
  1665. self.subproject_dir = spdirname
  1666. if 'meson_version' in kwargs:
  1667. cv = coredata.version
  1668. pv = kwargs['meson_version']
  1669. if not mesonlib.version_compare(cv, pv):
  1670. raise InterpreterException('Meson version is %s but project requires %s.' % (cv, pv))
  1671. self.build.projects[self.subproject] = proj_name
  1672. mlog.log('Project name: ', mlog.bold(proj_name), sep='')
  1673. self.add_languages(proj_langs, True)
  1674. langs = self.coredata.compilers.keys()
  1675. if 'vala' in langs:
  1676. if 'c' not in langs:
  1677. raise InterpreterException('Compiling Vala requires C. Add C to your project languages and rerun Meson.')
  1678. if not self.is_subproject():
  1679. self.check_cross_stdlibs()
  1680. @permittedKwargs(permitted_kwargs['add_languages'])
  1681. @stringArgs
  1682. def func_add_languages(self, node, args, kwargs):
  1683. return self.add_languages(args, kwargs.get('required', True))
  1684. def get_message_string_arg(self, node):
  1685. # reduce arguments again to avoid flattening posargs
  1686. (posargs, _) = self.reduce_arguments(node.args)
  1687. if len(posargs) != 1:
  1688. raise InvalidArguments('Expected 1 argument, got %d' % len(posargs))
  1689. arg = posargs[0]
  1690. if isinstance(arg, list):
  1691. argstr = stringifyUserArguments(arg)
  1692. elif isinstance(arg, str):
  1693. argstr = arg
  1694. elif isinstance(arg, int):
  1695. argstr = str(arg)
  1696. else:
  1697. raise InvalidArguments('Function accepts only strings, integers, lists and lists thereof.')
  1698. return argstr
  1699. @noKwargs
  1700. def func_message(self, node, args, kwargs):
  1701. argstr = self.get_message_string_arg(node)
  1702. mlog.log(mlog.bold('Message:'), argstr)
  1703. @noKwargs
  1704. def func_warning(self, node, args, kwargs):
  1705. argstr = self.get_message_string_arg(node)
  1706. mlog.warning(argstr)
  1707. @noKwargs
  1708. def func_error(self, node, args, kwargs):
  1709. self.validate_arguments(args, 1, [str])
  1710. raise InterpreterException('Error encountered: ' + args[0])
  1711. def detect_compilers(self, lang, need_cross_compiler):
  1712. cross_comp = None
  1713. if lang == 'c':
  1714. comp = self.environment.detect_c_compiler(False)
  1715. if need_cross_compiler:
  1716. cross_comp = self.environment.detect_c_compiler(True)
  1717. elif lang == 'cpp':
  1718. comp = self.environment.detect_cpp_compiler(False)
  1719. if need_cross_compiler:
  1720. cross_comp = self.environment.detect_cpp_compiler(True)
  1721. elif lang == 'objc':
  1722. comp = self.environment.detect_objc_compiler(False)
  1723. if need_cross_compiler:
  1724. cross_comp = self.environment.detect_objc_compiler(True)
  1725. elif lang == 'objcpp':
  1726. comp = self.environment.detect_objcpp_compiler(False)
  1727. if need_cross_compiler:
  1728. cross_comp = self.environment.detect_objcpp_compiler(True)
  1729. elif lang == 'java':
  1730. comp = self.environment.detect_java_compiler()
  1731. if need_cross_compiler:
  1732. cross_comp = comp # Java is platform independent.
  1733. elif lang == 'cs':
  1734. comp = self.environment.detect_cs_compiler()
  1735. if need_cross_compiler:
  1736. cross_comp = comp # C# is platform independent.
  1737. elif lang == 'vala':
  1738. comp = self.environment.detect_vala_compiler()
  1739. if need_cross_compiler:
  1740. cross_comp = comp # Vala compiles to platform-independent C
  1741. elif lang == 'd':
  1742. comp = self.environment.detect_d_compiler(False)
  1743. if need_cross_compiler:
  1744. cross_comp = self.environment.detect_d_compiler(True)
  1745. elif lang == 'rust':
  1746. comp = self.environment.detect_rust_compiler()
  1747. if need_cross_compiler:
  1748. cross_comp = comp # FIXME, not correct.
  1749. elif lang == 'fortran':
  1750. comp = self.environment.detect_fortran_compiler(False)
  1751. if need_cross_compiler:
  1752. cross_comp = self.environment.detect_fortran_compiler(True)
  1753. elif lang == 'swift':
  1754. comp = self.environment.detect_swift_compiler()
  1755. if need_cross_compiler:
  1756. raise InterpreterException('Cross compilation with Swift is not working yet.')
  1757. # cross_comp = self.environment.detect_fortran_compiler(True)
  1758. else:
  1759. raise InvalidCode('Tried to use unknown language "%s".' % lang)
  1760. comp.sanity_check(self.environment.get_scratch_dir(), self.environment)
  1761. self.coredata.compilers[lang] = comp
  1762. # Native compiler always exist so always add its options.
  1763. new_options = comp.get_options()
  1764. if cross_comp is not None:
  1765. cross_comp.sanity_check(self.environment.get_scratch_dir(), self.environment)
  1766. self.coredata.cross_compilers[lang] = cross_comp
  1767. new_options.update(cross_comp.get_options())
  1768. optprefix = lang + '_'
  1769. for i in new_options:
  1770. if not i.startswith(optprefix):
  1771. raise InterpreterException('Internal error, %s has incorrect prefix.' % i)
  1772. cmd_prefix = i + '='
  1773. for cmd_arg in self.environment.cmd_line_options.projectoptions:
  1774. if cmd_arg.startswith(cmd_prefix):
  1775. value = cmd_arg.split('=', 1)[1]
  1776. new_options[i].set_value(value)
  1777. new_options.update(self.coredata.compiler_options)
  1778. self.coredata.compiler_options = new_options
  1779. return comp, cross_comp
  1780. def add_languages(self, args, required):
  1781. success = True
  1782. need_cross_compiler = self.environment.is_cross_build() and self.environment.cross_info.need_cross_compiler()
  1783. for lang in sorted(args, key=compilers.sort_clike):
  1784. lang = lang.lower()
  1785. if lang in self.coredata.compilers:
  1786. comp = self.coredata.compilers[lang]
  1787. cross_comp = self.coredata.cross_compilers.get(lang, None)
  1788. else:
  1789. try:
  1790. (comp, cross_comp) = self.detect_compilers(lang, need_cross_compiler)
  1791. except Exception:
  1792. if not required:
  1793. mlog.log('Compiler for language', mlog.bold(lang), 'not found.')
  1794. success = False
  1795. continue
  1796. else:
  1797. raise
  1798. mlog.log('Native %s compiler: ' % comp.get_display_language(), mlog.bold(' '.join(comp.get_exelist())), ' (%s %s)' % (comp.id, comp.version), sep='')
  1799. if not comp.get_language() in self.coredata.external_args:
  1800. (preproc_args, compile_args, link_args) = environment.get_args_from_envvars(comp)
  1801. self.coredata.external_preprocess_args[comp.get_language()] = preproc_args
  1802. self.coredata.external_args[comp.get_language()] = compile_args
  1803. self.coredata.external_link_args[comp.get_language()] = link_args
  1804. self.build.add_compiler(comp)
  1805. if need_cross_compiler:
  1806. mlog.log('Cross %s compiler: ' % cross_comp.get_display_language(), mlog.bold(' '.join(cross_comp.get_exelist())), ' (%s %s)' % (cross_comp.id, cross_comp.version), sep='')
  1807. self.build.add_cross_compiler(cross_comp)
  1808. if self.environment.is_cross_build() and not need_cross_compiler:
  1809. self.build.add_cross_compiler(comp)
  1810. self.add_base_options(comp)
  1811. return success
  1812. def add_base_options(self, compiler):
  1813. proj_opt = self.environment.cmd_line_options.projectoptions
  1814. for optname in compiler.base_options:
  1815. if optname in self.coredata.base_options:
  1816. continue
  1817. oobj = compilers.base_options[optname]
  1818. for po in proj_opt:
  1819. if po.startswith(optname + '='):
  1820. oobj.set_value(po.split('=', 1)[1])
  1821. break
  1822. self.coredata.base_options[optname] = oobj
  1823. def program_from_cross_file(self, prognames):
  1824. bins = self.environment.cross_info.config['binaries']
  1825. for p in prognames:
  1826. if hasattr(p, 'held_object'):
  1827. p = p.held_object
  1828. if isinstance(p, mesonlib.File):
  1829. continue # Always points to a local (i.e. self generated) file.
  1830. if not isinstance(p, str):
  1831. raise InterpreterException('Executable name must be a string.')
  1832. if p in bins:
  1833. exename = bins[p]
  1834. extprog = dependencies.ExternalProgram(exename)
  1835. progobj = ExternalProgramHolder(extprog)
  1836. return progobj
  1837. def program_from_system(self, args):
  1838. # Search for scripts relative to current subdir.
  1839. # Do not cache found programs because find_program('foobar')
  1840. # might give different results when run from different source dirs.
  1841. source_dir = os.path.join(self.environment.get_source_dir(), self.subdir)
  1842. for exename in args:
  1843. if isinstance(exename, mesonlib.File):
  1844. if exename.is_built:
  1845. search_dir = os.path.join(self.environment.get_build_dir(),
  1846. exename.subdir)
  1847. else:
  1848. search_dir = os.path.join(self.environment.get_source_dir(),
  1849. exename.subdir)
  1850. exename = exename.fname
  1851. elif isinstance(exename, str):
  1852. search_dir = source_dir
  1853. else:
  1854. raise InvalidArguments('find_program only accepts strings and '
  1855. 'files, not {!r}'.format(exename))
  1856. extprog = dependencies.ExternalProgram(exename, search_dir=search_dir)
  1857. progobj = ExternalProgramHolder(extprog)
  1858. if progobj.found():
  1859. return progobj
  1860. @permittedKwargs(permitted_kwargs['find_program'])
  1861. def func_find_program(self, node, args, kwargs):
  1862. if not args:
  1863. raise InterpreterException('No program name specified.')
  1864. required = kwargs.get('required', True)
  1865. if not isinstance(required, bool):
  1866. raise InvalidArguments('"required" argument must be a boolean.')
  1867. progobj = None
  1868. if self.build.environment.is_cross_build():
  1869. use_native = kwargs.get('native', False)
  1870. if not isinstance(use_native, bool):
  1871. raise InvalidArguments('Argument to "native" must be a boolean.')
  1872. if not use_native:
  1873. progobj = self.program_from_cross_file(args)
  1874. if progobj is None:
  1875. progobj = self.program_from_system(args)
  1876. if required and (progobj is None or not progobj.found()):
  1877. raise InvalidArguments('Program "%s" not found or not executable' % args[0])
  1878. if progobj is None:
  1879. return ExternalProgramHolder(dependencies.ExternalProgram('nonexistingprogram'))
  1880. return progobj
  1881. def func_find_library(self, node, args, kwargs):
  1882. mlog.log(mlog.red('DEPRECATION:'), 'find_library() is removed, use the corresponding method in compiler object instead.')
  1883. def _find_cached_dep(self, name, kwargs):
  1884. # Check if we want this as a cross-dep or a native-dep
  1885. # FIXME: Not all dependencies support such a distinction right now,
  1886. # and we repeat this check inside dependencies that do. We need to
  1887. # consolidate this somehow.
  1888. is_cross = self.environment.is_cross_build()
  1889. if 'native' in kwargs and is_cross:
  1890. want_cross = not kwargs['native']
  1891. else:
  1892. want_cross = is_cross
  1893. identifier = dependencies.get_dep_identifier(name, kwargs, want_cross)
  1894. cached_dep = None
  1895. # Check if we've already searched for and found this dep
  1896. if identifier in self.coredata.deps:
  1897. cached_dep = self.coredata.deps[identifier]
  1898. else:
  1899. # Check if exactly the same dep with different version requirements
  1900. # was found already.
  1901. wanted = identifier[1]
  1902. for trial, trial_dep in self.coredata.deps.items():
  1903. # trial[1], identifier[1] are the version requirements
  1904. if trial[0] != identifier[0] or trial[2:] != identifier[2:]:
  1905. continue
  1906. found = trial_dep.get_version()
  1907. if not wanted or mesonlib.version_compare_many(found, wanted)[0]:
  1908. # We either don't care about the version, or our
  1909. # version requirements matched the trial dep's version.
  1910. cached_dep = trial_dep
  1911. break
  1912. return identifier, cached_dep
  1913. @permittedKwargs(permitted_kwargs['dependency'])
  1914. def func_dependency(self, node, args, kwargs):
  1915. self.validate_arguments(args, 1, [str])
  1916. name = args[0]
  1917. if name == '':
  1918. if kwargs.get('required', True):
  1919. raise InvalidArguments('Dependency is both required and not-found')
  1920. return DependencyHolder(Dependency('not-found', {}))
  1921. if '<' in name or '>' in name or '=' in name:
  1922. raise InvalidArguments('Characters <, > and = are forbidden in dependency names. To specify'
  1923. 'version\n requirements use the \'version\' keyword argument instead.')
  1924. identifier, cached_dep = self._find_cached_dep(name, kwargs)
  1925. if cached_dep:
  1926. if kwargs.get('required', True) and not cached_dep.found():
  1927. m = 'Dependency {!r} was already checked and was not found'
  1928. raise DependencyException(m.format(name))
  1929. dep = cached_dep
  1930. else:
  1931. # If the dependency has already been configured, possibly by
  1932. # a higher level project, try to use it first.
  1933. if 'fallback' in kwargs:
  1934. dirname, varname = self.get_subproject_infos(kwargs)
  1935. if dirname in self.subprojects:
  1936. subproject = self.subprojects[dirname]
  1937. try:
  1938. # Never add fallback deps to self.coredata.deps
  1939. return subproject.get_variable_method([varname], {})
  1940. except KeyError:
  1941. pass
  1942. # We need to actually search for this dep
  1943. exception = None
  1944. dep = None
  1945. # Search for it outside the project
  1946. try:
  1947. dep = dependencies.find_external_dependency(name, self.environment, kwargs)
  1948. except DependencyException as e:
  1949. exception = e
  1950. # Search inside the projects list
  1951. if not dep or not dep.found():
  1952. if 'fallback' in kwargs:
  1953. fallback_dep = self.dependency_fallback(name, kwargs)
  1954. if fallback_dep:
  1955. # Never add fallback deps to self.coredata.deps since we
  1956. # cannot cache them. They must always be evaluated else
  1957. # we won't actually read all the build files.
  1958. return fallback_dep
  1959. if not dep:
  1960. assert(exception is not None)
  1961. raise exception
  1962. # Only store found-deps in the cache
  1963. if dep.found():
  1964. self.coredata.deps[identifier] = dep
  1965. return DependencyHolder(dep)
  1966. @noKwargs
  1967. @noPosargs
  1968. def func_disabler(self, node, args, kwargs):
  1969. return Disabler()
  1970. def get_subproject_infos(self, kwargs):
  1971. fbinfo = kwargs['fallback']
  1972. check_stringlist(fbinfo)
  1973. if len(fbinfo) != 2:
  1974. raise InterpreterException('Fallback info must have exactly two items.')
  1975. return fbinfo
  1976. def dependency_fallback(self, name, kwargs):
  1977. if self.coredata.wrap_mode in (WrapMode.nofallback, WrapMode.nodownload):
  1978. mlog.log('Not looking for a fallback subproject for the dependency',
  1979. mlog.bold(name), 'because:\nAutomatic wrap-based fallback '
  1980. 'dependency downloading is disabled.')
  1981. return None
  1982. dirname, varname = self.get_subproject_infos(kwargs)
  1983. # Try to execute the subproject
  1984. try:
  1985. sp_kwargs = {}
  1986. try:
  1987. sp_kwargs['default_options'] = kwargs['default_options']
  1988. except KeyError:
  1989. pass
  1990. self.do_subproject(dirname, sp_kwargs)
  1991. # Invalid code is always an error
  1992. except InvalidCode:
  1993. raise
  1994. # If the subproject execution failed in a non-fatal way, don't raise an
  1995. # exception; let the caller handle things.
  1996. except:
  1997. mlog.log('Also couldn\'t find a fallback subproject in',
  1998. mlog.bold(os.path.join(self.subproject_dir, dirname)),
  1999. 'for the dependency', mlog.bold(name))
  2000. return None
  2001. try:
  2002. dep = self.subprojects[dirname].get_variable_method([varname], {})
  2003. except KeyError:
  2004. if kwargs.get('required', True):
  2005. m = 'Fallback variable {!r} in the subproject {!r} does not exist'
  2006. raise DependencyException(m.format(varname, dirname))
  2007. # If the dependency is not required, don't raise an exception
  2008. mlog.log('Also couldn\'t find the dependency', mlog.bold(name),
  2009. 'in the fallback subproject',
  2010. mlog.bold(os.path.join(self.subproject_dir, dirname)))
  2011. return None
  2012. if not isinstance(dep, DependencyHolder):
  2013. raise InvalidCode('Fallback variable {!r} in the subproject {!r} is '
  2014. 'not a dependency object.'.format(varname, dirname))
  2015. # Check if the version of the declared dependency matches what we want
  2016. if 'version' in kwargs:
  2017. wanted = kwargs['version']
  2018. found = dep.version_method([], {})
  2019. if found == 'undefined' or not mesonlib.version_compare(found, wanted):
  2020. mlog.log('Subproject', mlog.bold(dirname), 'dependency',
  2021. mlog.bold(varname), 'version is', mlog.bold(found),
  2022. 'but', mlog.bold(wanted), 'is required.')
  2023. return None
  2024. mlog.log('Found a', mlog.green('fallback'), 'subproject',
  2025. mlog.bold(os.path.join(self.subproject_dir, dirname)), 'for',
  2026. mlog.bold(name))
  2027. return dep
  2028. @permittedKwargs(permitted_kwargs['executable'])
  2029. def func_executable(self, node, args, kwargs):
  2030. return self.build_target(node, args, kwargs, ExecutableHolder)
  2031. @permittedKwargs(permitted_kwargs['static_library'])
  2032. def func_static_lib(self, node, args, kwargs):
  2033. return self.build_target(node, args, kwargs, StaticLibraryHolder)
  2034. @permittedKwargs(permitted_kwargs['shared_library'])
  2035. def func_shared_lib(self, node, args, kwargs):
  2036. return self.build_target(node, args, kwargs, SharedLibraryHolder)
  2037. @permittedKwargs(permitted_kwargs['shared_module'])
  2038. def func_shared_module(self, node, args, kwargs):
  2039. return self.build_target(node, args, kwargs, SharedModuleHolder)
  2040. def func_library(self, node, args, kwargs):
  2041. if self.coredata.get_builtin_option('default_library') == 'shared':
  2042. return self.func_shared_lib(node, args, kwargs)
  2043. return self.func_static_lib(node, args, kwargs)
  2044. @permittedKwargs(permitted_kwargs['jar'])
  2045. def func_jar(self, node, args, kwargs):
  2046. kwargs['target_type'] = 'jar'
  2047. return self.build_target(node, args, kwargs, JarHolder)
  2048. @permittedKwargs(permitted_kwargs['build_target'])
  2049. def func_build_target(self, node, args, kwargs):
  2050. if 'target_type' not in kwargs:
  2051. raise InterpreterException('Missing target_type keyword argument')
  2052. target_type = kwargs.pop('target_type')
  2053. if target_type == 'executable':
  2054. return self.func_executable(node, args, kwargs)
  2055. elif target_type == 'shared_library':
  2056. return self.func_shared_lib(node, args, kwargs)
  2057. elif target_type == 'static_library':
  2058. return self.func_static_lib(node, args, kwargs)
  2059. elif target_type == 'library':
  2060. return self.func_library(node, args, kwargs)
  2061. elif target_type == 'jar':
  2062. return self.func_jar(node, args, kwargs)
  2063. else:
  2064. raise InterpreterException('Unknown target_type.')
  2065. @permittedKwargs(permitted_kwargs['vcs_tag'])
  2066. def func_vcs_tag(self, node, args, kwargs):
  2067. if 'input' not in kwargs or 'output' not in kwargs:
  2068. raise InterpreterException('Keyword arguments input and output must exist')
  2069. fallback = kwargs.pop('fallback', self.project_version)
  2070. if not isinstance(fallback, str):
  2071. raise InterpreterException('Keyword argument fallback must be a string.')
  2072. replace_string = kwargs.pop('replace_string', '@VCS_TAG@')
  2073. regex_selector = '(.*)' # default regex selector for custom command: use complete output
  2074. vcs_cmd = kwargs.get('command', None)
  2075. if vcs_cmd and not isinstance(vcs_cmd, list):
  2076. vcs_cmd = [vcs_cmd]
  2077. source_dir = os.path.normpath(os.path.join(self.environment.get_source_dir(), self.subdir))
  2078. if vcs_cmd:
  2079. # Is the command an executable in path or maybe a script in the source tree?
  2080. vcs_cmd[0] = shutil.which(vcs_cmd[0]) or os.path.join(source_dir, vcs_cmd[0])
  2081. else:
  2082. vcs = mesonlib.detect_vcs(source_dir)
  2083. if vcs:
  2084. mlog.log('Found %s repository at %s' % (vcs['name'], vcs['wc_dir']))
  2085. vcs_cmd = vcs['get_rev'].split()
  2086. regex_selector = vcs['rev_regex']
  2087. else:
  2088. vcs_cmd = [' '] # executing this cmd will fail in vcstagger.py and force to use the fallback string
  2089. # vcstagger.py parameters: infile, outfile, fallback, source_dir, replace_string, regex_selector, command...
  2090. kwargs['command'] = self.environment.get_build_command() + \
  2091. ['--internal',
  2092. 'vcstagger',
  2093. '@INPUT0@',
  2094. '@OUTPUT0@',
  2095. fallback,
  2096. source_dir,
  2097. replace_string,
  2098. regex_selector] + vcs_cmd
  2099. kwargs.setdefault('build_always', True)
  2100. return self.func_custom_target(node, [kwargs['output']], kwargs)
  2101. @stringArgs
  2102. @permittedKwargs(permitted_kwargs['custom_target'])
  2103. def func_custom_target(self, node, args, kwargs):
  2104. if len(args) != 1:
  2105. raise InterpreterException('custom_target: Only one positional argument is allowed, and it must be a string name')
  2106. name = args[0]
  2107. tg = CustomTargetHolder(build.CustomTarget(name, self.subdir, self.subproject, kwargs), self)
  2108. self.add_target(name, tg.held_object)
  2109. return tg
  2110. @permittedKwargs(permitted_kwargs['run_target'])
  2111. def func_run_target(self, node, args, kwargs):
  2112. global run_depr_printed
  2113. if len(args) > 1:
  2114. if not run_depr_printed:
  2115. mlog.log(mlog.red('DEPRECATION'), 'positional version of run_target is deprecated, use the keyword version instead.')
  2116. run_depr_printed = True
  2117. if 'command' in kwargs:
  2118. raise InterpreterException('Can not have command both in positional and keyword arguments.')
  2119. all_args = args[1:]
  2120. deps = []
  2121. elif len(args) == 1:
  2122. if 'command' not in kwargs:
  2123. raise InterpreterException('Missing "command" keyword argument')
  2124. all_args = extract_as_list(kwargs, 'command')
  2125. deps = extract_as_list(kwargs, 'depends')
  2126. else:
  2127. raise InterpreterException('Run_target needs at least one positional argument.')
  2128. cleaned_args = []
  2129. for i in listify(all_args, unholder=True):
  2130. if not isinstance(i, (str, build.BuildTarget, build.CustomTarget, dependencies.ExternalProgram, mesonlib.File)):
  2131. mlog.debug('Wrong type:', str(i))
  2132. raise InterpreterException('Invalid argument to run_target.')
  2133. cleaned_args.append(i)
  2134. name = args[0]
  2135. if not isinstance(name, str):
  2136. raise InterpreterException('First argument must be a string.')
  2137. cleaned_deps = []
  2138. for d in deps:
  2139. try:
  2140. d = d.held_object
  2141. except AttributeError:
  2142. pass
  2143. if not isinstance(d, (build.BuildTarget, build.CustomTarget)):
  2144. raise InterpreterException('Depends items must be build targets.')
  2145. cleaned_deps.append(d)
  2146. command = cleaned_args[0]
  2147. cmd_args = cleaned_args[1:]
  2148. tg = RunTargetHolder(name, command, cmd_args, cleaned_deps, self.subdir, self.subproject)
  2149. self.add_target(name, tg.held_object)
  2150. return tg
  2151. @permittedKwargs(permitted_kwargs['generator'])
  2152. def func_generator(self, node, args, kwargs):
  2153. gen = GeneratorHolder(self, args, kwargs)
  2154. self.generators.append(gen)
  2155. return gen
  2156. @permittedKwargs(permitted_kwargs['benchmark'])
  2157. def func_benchmark(self, node, args, kwargs):
  2158. self.add_test(node, args, kwargs, False)
  2159. @permittedKwargs(permitted_kwargs['test'])
  2160. def func_test(self, node, args, kwargs):
  2161. self.add_test(node, args, kwargs, True)
  2162. def unpack_env_kwarg(self, kwargs):
  2163. envlist = kwargs.get('env', EnvironmentVariablesHolder())
  2164. if isinstance(envlist, EnvironmentVariablesHolder):
  2165. env = envlist.held_object
  2166. else:
  2167. envlist = listify(envlist)
  2168. # Convert from array to environment object
  2169. env = EnvironmentVariablesHolder()
  2170. for e in envlist:
  2171. if '=' not in e:
  2172. raise InterpreterException('Env var definition must be of type key=val.')
  2173. (k, val) = e.split('=', 1)
  2174. k = k.strip()
  2175. val = val.strip()
  2176. if ' ' in k:
  2177. raise InterpreterException('Env var key must not have spaces in it.')
  2178. env.set_method([k, val], {})
  2179. env = env.held_object
  2180. return env
  2181. def add_test(self, node, args, kwargs, is_base_test):
  2182. if len(args) != 2:
  2183. raise InterpreterException('Incorrect number of arguments')
  2184. if not isinstance(args[0], str):
  2185. raise InterpreterException('First argument of test must be a string.')
  2186. exe = args[1]
  2187. if not isinstance(exe, (ExecutableHolder, JarHolder, ExternalProgramHolder)):
  2188. if isinstance(exe, mesonlib.File):
  2189. exe = self.func_find_program(node, (args[1], ), {})
  2190. else:
  2191. raise InterpreterException('Second argument must be executable.')
  2192. par = kwargs.get('is_parallel', True)
  2193. if not isinstance(par, bool):
  2194. raise InterpreterException('Keyword argument is_parallel must be a boolean.')
  2195. cmd_args = extract_as_list(kwargs, 'args', unholder=True)
  2196. for i in cmd_args:
  2197. if not isinstance(i, (str, mesonlib.File, build.Target)):
  2198. raise InterpreterException('Command line arguments must be strings, files or targets.')
  2199. env = self.unpack_env_kwarg(kwargs)
  2200. should_fail = kwargs.get('should_fail', False)
  2201. if not isinstance(should_fail, bool):
  2202. raise InterpreterException('Keyword argument should_fail must be a boolean.')
  2203. timeout = kwargs.get('timeout', 30)
  2204. if 'workdir' in kwargs:
  2205. workdir = kwargs['workdir']
  2206. if not isinstance(workdir, str):
  2207. raise InterpreterException('Workdir keyword argument must be a string.')
  2208. if not os.path.isabs(workdir):
  2209. raise InterpreterException('Workdir keyword argument must be an absolute path.')
  2210. else:
  2211. workdir = None
  2212. if not isinstance(timeout, int):
  2213. raise InterpreterException('Timeout must be an integer.')
  2214. suite = []
  2215. for s in mesonlib.stringlistify(kwargs.get('suite', '')):
  2216. if len(s) > 0:
  2217. s = ':' + s
  2218. if self.is_subproject():
  2219. suite.append(self.subproject.replace(' ', '_').replace(':', '_') + s)
  2220. else:
  2221. suite.append(self.build.project_name.replace(' ', '_').replace(':', '_') + s)
  2222. t = Test(args[0], suite, exe.held_object, par, cmd_args, env, should_fail, timeout, workdir)
  2223. if is_base_test:
  2224. self.build.tests.append(t)
  2225. mlog.debug('Adding test "', mlog.bold(args[0]), '".', sep='')
  2226. else:
  2227. self.build.benchmarks.append(t)
  2228. mlog.debug('Adding benchmark "', mlog.bold(args[0]), '".', sep='')
  2229. @permittedKwargs(permitted_kwargs['install_headers'])
  2230. def func_install_headers(self, node, args, kwargs):
  2231. source_files = self.source_strings_to_files(args)
  2232. h = Headers(source_files, kwargs)
  2233. self.build.headers.append(h)
  2234. return h
  2235. @permittedKwargs(permitted_kwargs['install_man'])
  2236. def func_install_man(self, node, args, kwargs):
  2237. fargs = self.source_strings_to_files(args)
  2238. m = Man(fargs, kwargs)
  2239. self.build.man.append(m)
  2240. return m
  2241. @permittedKwargs(permitted_kwargs['subdir'])
  2242. def func_subdir(self, node, args, kwargs):
  2243. self.validate_arguments(args, 1, [str])
  2244. mesonlib.check_direntry_issues(args)
  2245. if '..' in args[0]:
  2246. raise InvalidArguments('Subdir contains ..')
  2247. if self.subdir == '' and args[0] == self.subproject_dir:
  2248. raise InvalidArguments('Must not go into subprojects dir with subdir(), use subproject() instead.')
  2249. if self.subdir == '' and args[0].startswith('meson-'):
  2250. raise InvalidArguments('The "meson-" prefix is reserved and cannot be used for top-level subdir().')
  2251. for i in mesonlib.extract_as_list(kwargs, 'if_found'):
  2252. if not hasattr(i, 'found_method'):
  2253. raise InterpreterException('Object used in if_found does not have a found method.')
  2254. if not i.found_method([], {}):
  2255. return
  2256. prev_subdir = self.subdir
  2257. subdir = os.path.join(prev_subdir, args[0])
  2258. if os.path.isabs(subdir):
  2259. raise InvalidArguments('Subdir argument must be a relative path.')
  2260. absdir = os.path.join(self.environment.get_source_dir(), subdir)
  2261. symlinkless_dir = os.path.realpath(absdir)
  2262. if symlinkless_dir in self.visited_subdirs:
  2263. raise InvalidArguments('Tried to enter directory "%s", which has already been visited.'
  2264. % subdir)
  2265. self.visited_subdirs[symlinkless_dir] = True
  2266. self.subdir = subdir
  2267. os.makedirs(os.path.join(self.environment.build_dir, subdir), exist_ok=True)
  2268. buildfilename = os.path.join(self.subdir, environment.build_filename)
  2269. self.build_def_files.append(buildfilename)
  2270. absname = os.path.join(self.environment.get_source_dir(), buildfilename)
  2271. if not os.path.isfile(absname):
  2272. self.subdir = prev_subdir
  2273. raise InterpreterException('Non-existent build file {!r}'.format(buildfilename))
  2274. with open(absname, encoding='utf8') as f:
  2275. code = f.read()
  2276. assert(isinstance(code, str))
  2277. try:
  2278. codeblock = mparser.Parser(code, self.subdir).parse()
  2279. except mesonlib.MesonException as me:
  2280. me.file = buildfilename
  2281. raise me
  2282. self.evaluate_codeblock(codeblock)
  2283. self.subdir = prev_subdir
  2284. def _get_kwarg_install_mode(self, kwargs):
  2285. if 'install_mode' not in kwargs:
  2286. return None
  2287. install_mode = []
  2288. mode = mesonlib.typeslistify(kwargs.get('install_mode', []), (str, int))
  2289. for m in mode:
  2290. # We skip any arguments that are set to `false`
  2291. if m is False:
  2292. m = None
  2293. install_mode.append(m)
  2294. if len(install_mode) > 3:
  2295. raise InvalidArguments('Keyword argument install_mode takes at '
  2296. 'most 3 arguments.')
  2297. if len(install_mode) > 0 and install_mode[0] is not None and \
  2298. not isinstance(install_mode[0], str):
  2299. raise InvalidArguments('Keyword argument install_mode requires the '
  2300. 'permissions arg to be a string or false')
  2301. return FileMode(*install_mode)
  2302. @permittedKwargs(permitted_kwargs['install_data'])
  2303. def func_install_data(self, node, args, kwargs):
  2304. kwsource = mesonlib.stringlistify(kwargs.get('sources', []))
  2305. raw_sources = args + kwsource
  2306. sources = []
  2307. source_strings = []
  2308. for s in raw_sources:
  2309. if isinstance(s, mesonlib.File):
  2310. sources.append(s)
  2311. else:
  2312. source_strings.append(s)
  2313. sources += self.source_strings_to_files(source_strings)
  2314. install_dir = kwargs.get('install_dir', None)
  2315. if not isinstance(install_dir, (str, type(None))):
  2316. raise InvalidArguments('Keyword argument install_dir not a string.')
  2317. install_mode = self._get_kwarg_install_mode(kwargs)
  2318. data = DataHolder(build.Data(sources, install_dir, install_mode))
  2319. self.build.data.append(data.held_object)
  2320. return data
  2321. @permittedKwargs(permitted_kwargs['install_subdir'])
  2322. @stringArgs
  2323. def func_install_subdir(self, node, args, kwargs):
  2324. if len(args) != 1:
  2325. raise InvalidArguments('Install_subdir requires exactly one argument.')
  2326. subdir = args[0]
  2327. if 'install_dir' not in kwargs:
  2328. raise InvalidArguments('Missing keyword argument install_dir')
  2329. install_dir = kwargs['install_dir']
  2330. if not isinstance(install_dir, str):
  2331. raise InvalidArguments('Keyword argument install_dir not a string.')
  2332. if 'exclude_files' in kwargs:
  2333. exclude = extract_as_list(kwargs, 'exclude_files')
  2334. for f in exclude:
  2335. if not isinstance(f, str):
  2336. raise InvalidArguments('Exclude argument not a string.')
  2337. elif os.path.isabs(f):
  2338. raise InvalidArguments('Exclude argument cannot be absolute.')
  2339. exclude_files = {os.path.join(subdir, f) for f in exclude}
  2340. else:
  2341. exclude_files = set()
  2342. if 'exclude_directories' in kwargs:
  2343. exclude = extract_as_list(kwargs, 'exclude_directories')
  2344. for d in exclude:
  2345. if not isinstance(d, str):
  2346. raise InvalidArguments('Exclude argument not a string.')
  2347. elif os.path.isabs(d):
  2348. raise InvalidArguments('Exclude argument cannot be absolute.')
  2349. exclude_directories = {os.path.join(subdir, f) for f in exclude}
  2350. else:
  2351. exclude_directories = set()
  2352. exclude = (exclude_files, exclude_directories)
  2353. install_mode = self._get_kwarg_install_mode(kwargs)
  2354. idir = InstallDir(self.subdir, subdir, install_dir, install_mode, exclude)
  2355. self.build.install_dirs.append(idir)
  2356. return idir
  2357. @permittedKwargs(permitted_kwargs['configure_file'])
  2358. def func_configure_file(self, node, args, kwargs):
  2359. if len(args) > 0:
  2360. raise InterpreterException("configure_file takes only keyword arguments.")
  2361. if 'output' not in kwargs:
  2362. raise InterpreterException('Required keyword argument "output" not defined.')
  2363. if 'configuration' in kwargs and 'command' in kwargs:
  2364. raise InterpreterException('Must not specify both "configuration" '
  2365. 'and "command" keyword arguments since '
  2366. 'they are mutually exclusive.')
  2367. if 'capture' in kwargs:
  2368. if not isinstance(kwargs['capture'], bool):
  2369. raise InterpreterException('"capture" keyword must be a boolean.')
  2370. if 'command' not in kwargs:
  2371. raise InterpreterException('"capture" keyword requires "command" keyword.')
  2372. # Validate input
  2373. inputfile = None
  2374. ifile_abs = None
  2375. if 'input' in kwargs:
  2376. inputfile = kwargs['input']
  2377. if isinstance(inputfile, list):
  2378. if len(inputfile) != 1:
  2379. m = "Keyword argument 'input' requires exactly one file"
  2380. raise InterpreterException(m)
  2381. inputfile = inputfile[0]
  2382. if not isinstance(inputfile, (str, mesonlib.File)):
  2383. raise InterpreterException('Input must be a string or a file')
  2384. if isinstance(inputfile, str):
  2385. inputfile = mesonlib.File.from_source_file(self.environment.source_dir,
  2386. self.subdir, inputfile)
  2387. ifile_abs = inputfile.absolute_path(self.environment.source_dir,
  2388. self.environment.build_dir)
  2389. elif 'command' in kwargs and '@INPUT@' in kwargs['command']:
  2390. raise InterpreterException('@INPUT@ used as command argument, but no input file specified.')
  2391. # Validate output
  2392. output = kwargs['output']
  2393. if not isinstance(output, str):
  2394. raise InterpreterException('Output file name must be a string')
  2395. if ifile_abs:
  2396. values = mesonlib.get_filenames_templates_dict([ifile_abs], None)
  2397. outputs = mesonlib.substitute_values([output], values)
  2398. output = outputs[0]
  2399. if os.path.split(output)[0] != '':
  2400. raise InterpreterException('Output file name must not contain a subdirectory.')
  2401. (ofile_path, ofile_fname) = os.path.split(os.path.join(self.subdir, output))
  2402. ofile_abs = os.path.join(self.environment.build_dir, ofile_path, ofile_fname)
  2403. if 'configuration' in kwargs:
  2404. conf = kwargs['configuration']
  2405. if not isinstance(conf, ConfigurationDataHolder):
  2406. raise InterpreterException('Argument "configuration" is not of type configuration_data')
  2407. mlog.log('Configuring', mlog.bold(output), 'using configuration')
  2408. if inputfile is not None:
  2409. os.makedirs(os.path.join(self.environment.build_dir, self.subdir), exist_ok=True)
  2410. missing_variables = mesonlib.do_conf_file(ifile_abs, ofile_abs,
  2411. conf.held_object)
  2412. if missing_variables:
  2413. var_list = ", ".join(map(repr, sorted(missing_variables)))
  2414. mlog.warning(
  2415. "The variable(s) %s in the input file %s are not "
  2416. "present in the given configuration data" % (
  2417. var_list, inputfile))
  2418. else:
  2419. mesonlib.dump_conf_header(ofile_abs, conf.held_object)
  2420. conf.mark_used()
  2421. elif 'command' in kwargs:
  2422. # We use absolute paths for input and output here because the cwd
  2423. # that the command is run from is 'unspecified', so it could change.
  2424. # Currently it's builddir/subdir for in_builddir else srcdir/subdir.
  2425. if ifile_abs:
  2426. values = mesonlib.get_filenames_templates_dict([ifile_abs], [ofile_abs])
  2427. else:
  2428. values = mesonlib.get_filenames_templates_dict(None, [ofile_abs])
  2429. # Substitute @INPUT@, @OUTPUT@, etc here.
  2430. cmd = mesonlib.substitute_values(kwargs['command'], values)
  2431. mlog.log('Configuring', mlog.bold(output), 'with command')
  2432. res = self.run_command_impl(node, cmd, {}, True)
  2433. if res.returncode != 0:
  2434. raise InterpreterException('Running configure command failed.\n%s\n%s' %
  2435. (res.stdout, res.stderr))
  2436. if 'capture' in kwargs and kwargs['capture']:
  2437. dst_tmp = ofile_abs + '~'
  2438. with open(dst_tmp, 'w', encoding='utf-8') as f:
  2439. f.writelines(res.stdout)
  2440. if ifile_abs:
  2441. shutil.copymode(ifile_abs, dst_tmp)
  2442. mesonlib.replace_if_different(ofile_abs, dst_tmp)
  2443. else:
  2444. raise InterpreterException('Configure_file must have either "configuration" or "command".')
  2445. # If the input is a source file, add it to the list of files that we
  2446. # need to reconfigure on when they change. FIXME: Do the same for
  2447. # files() objects in the command: kwarg.
  2448. if inputfile and not inputfile.is_built:
  2449. # Normalize the path of the conffile (relative to the
  2450. # source root) to avoid duplicates. This is especially
  2451. # important to convert '/' to '\' on Windows
  2452. conffile = os.path.normpath(inputfile.relative_name())
  2453. if conffile not in self.build_def_files:
  2454. self.build_def_files.append(conffile)
  2455. # Install file if requested
  2456. idir = kwargs.get('install_dir', None)
  2457. if isinstance(idir, str):
  2458. cfile = mesonlib.File.from_built_file(ofile_path, ofile_fname)
  2459. self.build.data.append(build.Data([cfile], idir))
  2460. return mesonlib.File.from_built_file(self.subdir, output)
  2461. @permittedKwargs(permitted_kwargs['include_directories'])
  2462. @stringArgs
  2463. def func_include_directories(self, node, args, kwargs):
  2464. src_root = self.environment.get_source_dir()
  2465. build_root = self.environment.get_build_dir()
  2466. absbase_src = os.path.join(src_root, self.subdir)
  2467. absbase_build = os.path.join(build_root, self.subdir)
  2468. for a in args:
  2469. if a.startswith(src_root):
  2470. raise InvalidArguments('''Tried to form an absolute path to a source dir. You should not do that but use
  2471. relative paths instead.
  2472. To get include path to any directory relative to the current dir do
  2473. incdir = include_directories(dirname)
  2474. After this incdir will contain both the current source dir as well as the
  2475. corresponding build dir. It can then be used in any subdirectory and
  2476. Meson will take care of all the busywork to make paths work.
  2477. Dirname can even be '.' to mark the current directory. Though you should
  2478. remember that the current source and build directories are always
  2479. put in the include directories by default so you only need to do
  2480. include_directories('.') if you intend to use the result in a
  2481. different subdirectory.
  2482. ''')
  2483. absdir_src = os.path.join(absbase_src, a)
  2484. absdir_build = os.path.join(absbase_build, a)
  2485. if not os.path.isdir(absdir_src) and not os.path.isdir(absdir_build):
  2486. raise InvalidArguments('Include dir %s does not exist.' % a)
  2487. is_system = kwargs.get('is_system', False)
  2488. if not isinstance(is_system, bool):
  2489. raise InvalidArguments('Is_system must be boolean.')
  2490. i = IncludeDirsHolder(build.IncludeDirs(self.subdir, args, is_system))
  2491. return i
  2492. @permittedKwargs(permitted_kwargs['add_test_setup'])
  2493. @stringArgs
  2494. def func_add_test_setup(self, node, args, kwargs):
  2495. if len(args) != 1:
  2496. raise InterpreterException('Add_test_setup needs one argument for the setup name.')
  2497. setup_name = args[0]
  2498. if re.fullmatch('[_a-zA-Z][_0-9a-zA-Z]*', setup_name) is None:
  2499. raise InterpreterException('Setup name may only contain alphanumeric characters.')
  2500. try:
  2501. inp = extract_as_list(kwargs, 'exe_wrapper')
  2502. exe_wrapper = []
  2503. for i in inp:
  2504. if hasattr(i, 'held_object'):
  2505. i = i.held_object
  2506. if isinstance(i, str):
  2507. exe_wrapper.append(i)
  2508. elif isinstance(i, dependencies.ExternalProgram):
  2509. if not i.found():
  2510. raise InterpreterException('Tried to use non-found executable.')
  2511. exe_wrapper += i.get_command()
  2512. else:
  2513. raise InterpreterException('Exe wrapper can only contain strings or external binaries.')
  2514. except KeyError:
  2515. exe_wrapper = None
  2516. gdb = kwargs.get('gdb', False)
  2517. if not isinstance(gdb, bool):
  2518. raise InterpreterException('Gdb option must be a boolean')
  2519. timeout_multiplier = kwargs.get('timeout_multiplier', 1)
  2520. if not isinstance(timeout_multiplier, int):
  2521. raise InterpreterException('Timeout multiplier must be a number.')
  2522. env = self.unpack_env_kwarg(kwargs)
  2523. setupobj = build.TestSetup(exe_wrapper=exe_wrapper,
  2524. gdb=gdb,
  2525. timeout_multiplier=timeout_multiplier,
  2526. env=env)
  2527. if self.subproject == '':
  2528. # Dunno what we should do with subprojects really. Let's start simple
  2529. # and just use the master project ones.
  2530. self.build.test_setups[setup_name] = setupobj
  2531. @permittedKwargs(permitted_kwargs['add_global_arguments'])
  2532. @stringArgs
  2533. def func_add_global_arguments(self, node, args, kwargs):
  2534. self.add_global_arguments(node, self.build.global_args, args, kwargs)
  2535. @permittedKwargs(permitted_kwargs['add_global_link_arguments'])
  2536. @stringArgs
  2537. def func_add_global_link_arguments(self, node, args, kwargs):
  2538. self.add_global_arguments(node, self.build.global_link_args, args, kwargs)
  2539. @permittedKwargs(permitted_kwargs['add_project_arguments'])
  2540. @stringArgs
  2541. def func_add_project_arguments(self, node, args, kwargs):
  2542. self.add_project_arguments(node, self.build.projects_args, args, kwargs)
  2543. @permittedKwargs(permitted_kwargs['add_project_link_arguments'])
  2544. @stringArgs
  2545. def func_add_project_link_arguments(self, node, args, kwargs):
  2546. self.add_project_arguments(node, self.build.projects_link_args, args, kwargs)
  2547. def add_global_arguments(self, node, argsdict, args, kwargs):
  2548. if self.subproject != '':
  2549. msg = 'Function \'{}\' cannot be used in subprojects because ' \
  2550. 'there is no way to make that reliable.\nPlease only call ' \
  2551. 'this if is_subproject() returns false. Alternatively, ' \
  2552. 'define a variable that\ncontains your language-specific ' \
  2553. 'arguments and add it to the appropriate *_args kwarg ' \
  2554. 'in each target.'.format(node.func_name)
  2555. raise InvalidCode(msg)
  2556. frozen = self.project_args_frozen or self.global_args_frozen
  2557. self.add_arguments(node, argsdict, frozen, args, kwargs)
  2558. def add_project_arguments(self, node, argsdict, args, kwargs):
  2559. if self.subproject not in argsdict:
  2560. argsdict[self.subproject] = {}
  2561. self.add_arguments(node, argsdict[self.subproject],
  2562. self.project_args_frozen, args, kwargs)
  2563. def add_arguments(self, node, argsdict, args_frozen, args, kwargs):
  2564. if args_frozen:
  2565. msg = 'Tried to use \'{}\' after a build target has been declared.\n' \
  2566. 'This is not permitted. Please declare all ' \
  2567. 'arguments before your targets.'.format(node.func_name)
  2568. raise InvalidCode(msg)
  2569. if 'language' not in kwargs:
  2570. raise InvalidCode('Missing language definition in {}'.format(node.func_name))
  2571. for lang in mesonlib.stringlistify(kwargs['language']):
  2572. lang = lang.lower()
  2573. argsdict[lang] = argsdict.get(lang, []) + args
  2574. @noKwargs
  2575. @noPosargs
  2576. def func_environment(self, node, args, kwargs):
  2577. return EnvironmentVariablesHolder()
  2578. @stringArgs
  2579. @noKwargs
  2580. def func_join_paths(self, node, args, kwargs):
  2581. return os.path.join(*args).replace('\\', '/')
  2582. def run(self):
  2583. super().run()
  2584. mlog.log('Build targets in project:', mlog.bold(str(len(self.build.targets))))
  2585. def evaluate_subproject_info(self, path_from_source_root, subproject_dirname):
  2586. depth = 0
  2587. subproj_name = ''
  2588. segs = path_from_source_root.split(os.path.sep)
  2589. while segs and segs[0] == subproject_dirname:
  2590. depth += 1
  2591. subproj_name = segs[1]
  2592. segs = segs[2:]
  2593. return (depth, subproj_name)
  2594. # Check that the indicated file is within the same subproject
  2595. # as we currently are. This is to stop people doing
  2596. # nasty things like:
  2597. #
  2598. # f = files('../../master_src/file.c')
  2599. #
  2600. # Note that this is validated only when the file
  2601. # object is generated. The result can be used in a different
  2602. # subproject than it is defined in (due to e.g. a
  2603. # declare_dependency).
  2604. def validate_within_subproject(self, subdir, fname):
  2605. norm = os.path.normpath(os.path.join(subdir, fname))
  2606. if os.path.isabs(norm):
  2607. if not norm.startswith(self.environment.source_dir):
  2608. # Grabbing files outside the source tree is ok.
  2609. # This is for vendor stuff like:
  2610. #
  2611. # /opt/vendorsdk/src/file_with_license_restrictions.c
  2612. return
  2613. norm = os.path.relpath(norm, self.environment.source_dir)
  2614. assert(not os.path.isabs(norm))
  2615. (num_sps, sproj_name) = self.evaluate_subproject_info(norm, self.subproject_dir)
  2616. plain_filename = os.path.split(norm)[-1]
  2617. if num_sps == 0:
  2618. if self.subproject == '':
  2619. return
  2620. raise InterpreterException('Sandbox violation: Tried to grab file %s from a different subproject.' % plain_filename)
  2621. if num_sps > 1:
  2622. raise InterpreterException('Sandbox violation: Tried to grab file %s from a nested subproject.' % plain_filename)
  2623. if sproj_name != self.subproject_directory_name:
  2624. raise InterpreterException('Sandbox violation: Tried to grab file %s from a different subproject.' % plain_filename)
  2625. def source_strings_to_files(self, sources):
  2626. results = []
  2627. mesonlib.check_direntry_issues(sources)
  2628. for s in sources:
  2629. if isinstance(s, (mesonlib.File, GeneratedListHolder,
  2630. CustomTargetHolder, CustomTargetIndexHolder)):
  2631. pass
  2632. elif isinstance(s, str):
  2633. self.validate_within_subproject(self.subdir, s)
  2634. s = mesonlib.File.from_source_file(self.environment.source_dir, self.subdir, s)
  2635. else:
  2636. raise InterpreterException('Source item is {!r} instead of '
  2637. 'string or File-type object'.format(s))
  2638. results.append(s)
  2639. return results
  2640. def add_target(self, name, tobj):
  2641. if name == '':
  2642. raise InterpreterException('Target name must not be empty.')
  2643. if name.startswith('meson-'):
  2644. raise InvalidArguments("Target names starting with 'meson-' are reserved "
  2645. "for Meson's internal use. Please rename.")
  2646. if name in coredata.forbidden_target_names:
  2647. raise InvalidArguments("Target name '%s' is reserved for Meson's "
  2648. "internal use. Please rename." % name)
  2649. # To permit an executable and a shared library to have the
  2650. # same name, such as "foo.exe" and "libfoo.a".
  2651. idname = tobj.get_id()
  2652. if idname in self.build.targets:
  2653. raise InvalidCode('Tried to create target "%s", but a target of that name already exists.' % name)
  2654. self.build.targets[idname] = tobj
  2655. if idname not in self.coredata.target_guids:
  2656. self.coredata.target_guids[idname] = str(uuid.uuid4()).upper()
  2657. def build_target(self, node, args, kwargs, targetholder):
  2658. if not args:
  2659. raise InterpreterException('Target does not have a name.')
  2660. name = args[0]
  2661. sources = listify(args[1:])
  2662. if self.environment.is_cross_build():
  2663. if kwargs.get('native', False):
  2664. is_cross = False
  2665. else:
  2666. is_cross = True
  2667. else:
  2668. is_cross = False
  2669. if 'sources' in kwargs:
  2670. sources += listify(kwargs['sources'])
  2671. sources = self.source_strings_to_files(sources)
  2672. objs = extract_as_list(kwargs, 'objects')
  2673. kwargs['dependencies'] = extract_as_list(kwargs, 'dependencies')
  2674. if 'extra_files' in kwargs:
  2675. ef = extract_as_list(kwargs, 'extra_files')
  2676. kwargs['extra_files'] = self.source_strings_to_files(ef)
  2677. self.check_sources_exist(os.path.join(self.source_root, self.subdir), sources)
  2678. if targetholder is ExecutableHolder:
  2679. targetclass = build.Executable
  2680. elif targetholder is SharedLibraryHolder:
  2681. targetclass = build.SharedLibrary
  2682. elif targetholder is SharedModuleHolder:
  2683. targetclass = build.SharedModule
  2684. elif targetholder is StaticLibraryHolder:
  2685. targetclass = build.StaticLibrary
  2686. elif targetholder is JarHolder:
  2687. targetclass = build.Jar
  2688. else:
  2689. mlog.debug('Unknown target type:', str(targetholder))
  2690. raise RuntimeError('Unreachable code')
  2691. target = targetclass(name, self.subdir, self.subproject, is_cross, sources, objs, self.environment, kwargs)
  2692. if is_cross:
  2693. self.add_cross_stdlib_info(target)
  2694. l = targetholder(target, self)
  2695. self.add_target(name, l.held_object)
  2696. self.project_args_frozen = True
  2697. return l
  2698. def get_used_languages(self, target):
  2699. result = {}
  2700. for i in target.sources:
  2701. for lang, c in self.build.compilers.items():
  2702. if c.can_compile(i):
  2703. result[lang] = True
  2704. break
  2705. return result
  2706. def add_cross_stdlib_info(self, target):
  2707. for l in self.get_used_languages(target):
  2708. if self.environment.cross_info.has_stdlib(l) \
  2709. and self.subproject != self.environment.cross_info.get_stdlib(l)[0]:
  2710. target.add_deps(self.build.cross_stdlibs[l])
  2711. def check_sources_exist(self, subdir, sources):
  2712. for s in sources:
  2713. if not isinstance(s, str):
  2714. continue # This means a generated source and they always exist.
  2715. fname = os.path.join(subdir, s)
  2716. if not os.path.isfile(fname):
  2717. raise InterpreterException('Tried to add non-existing source file %s.' % s)
  2718. def format_string(self, templ, args):
  2719. if isinstance(args, mparser.ArgumentNode):
  2720. args = args.arguments
  2721. arg_strings = []
  2722. for arg in args:
  2723. arg = self.evaluate_statement(arg)
  2724. if isinstance(arg, bool): # Python boolean is upper case.
  2725. arg = str(arg).lower()
  2726. arg_strings.append(str(arg))
  2727. def arg_replace(match):
  2728. idx = int(match.group(1))
  2729. if idx >= len(arg_strings):
  2730. raise InterpreterException('Format placeholder @{}@ out of range.'.format(idx))
  2731. return arg_strings[idx]
  2732. return re.sub(r'@(\d+)@', arg_replace, templ)
  2733. # Only permit object extraction from the same subproject
  2734. def validate_extraction(self, buildtarget):
  2735. if not self.subdir.startswith(self.subproject_dir):
  2736. if buildtarget.subdir.startswith(self.subproject_dir):
  2737. raise InterpreterException('Tried to extract objects from a subproject target.')
  2738. else:
  2739. if not buildtarget.subdir.startswith(self.subproject_dir):
  2740. raise InterpreterException('Tried to extract objects from the main project from a subproject.')
  2741. if self.subdir.split('/')[1] != buildtarget.subdir.split('/')[1]:
  2742. raise InterpreterException('Tried to extract objects from a different subproject.')
  2743. def check_contains(self, obj, args):
  2744. if len(args) != 1:
  2745. raise InterpreterException('Contains method takes exactly one argument.')
  2746. item = args[0]
  2747. for element in obj:
  2748. if isinstance(element, list):
  2749. found = self.check_contains(element, args)
  2750. if found:
  2751. return True
  2752. if element == item:
  2753. return True
  2754. return False
  2755. def is_subproject(self):
  2756. return self.subproject != ''
  2757. @noKwargs
  2758. def func_set_variable(self, node, args, kwargs):
  2759. if len(args) != 2:
  2760. raise InvalidCode('Set_variable takes two arguments.')
  2761. varname = args[0]
  2762. value = args[1]
  2763. self.set_variable(varname, value)
  2764. @noKwargs
  2765. def func_get_variable(self, node, args, kwargs):
  2766. if len(args) < 1 or len(args) > 2:
  2767. raise InvalidCode('Get_variable takes one or two arguments.')
  2768. varname = args[0]
  2769. if not isinstance(varname, str):
  2770. raise InterpreterException('First argument must be a string.')
  2771. try:
  2772. return self.variables[varname]
  2773. except KeyError:
  2774. pass
  2775. if len(args) == 2:
  2776. return args[1]
  2777. raise InterpreterException('Tried to get unknown variable "%s".' % varname)
  2778. @stringArgs
  2779. @noKwargs
  2780. def func_is_variable(self, node, args, kwargs):
  2781. if len(args) != 1:
  2782. raise InvalidCode('Is_variable takes two arguments.')
  2783. varname = args[0]
  2784. return varname in self.variables