waflib/Scripting.py

   1 #!/usr/bin/env python
   2 # encoding: utf-8
   3 # Thomas Nagy, 2005-2018 (ita)
   4
   5 "Module called for configuring, compiling and installing targets"
   6
   7 from __future__ import with_statement
   8
   9 import os, shlex, shutil, traceback, errno, sys, stat
  10 from waflib import Utils, Configure, Logs, Options, ConfigSet, Context, Errors, Build, Node
  11
  12 build_dir_override = None
  13
  14 no_climb_commands = ['configure']
  15
  16 default_cmd = "build"
  17
  18 def waf_entry_point(current_directory, version, wafdir):
  19         """
  20         This is the main entry point, all Waf execution starts here.
  21
  22         :param current_directory: absolute path representing the current directory
  23         :type current_directory: string
  24         :param version: version number
  25         :type version: string
  26         :param wafdir: absolute path representing the directory of the waf library
  27         :type wafdir: string
  28         """
  29         Logs.init_log()
  30
  31         if Context.WAFVERSION != version:
  32                 Logs.error('Waf script %r and library %r do not match (directory %r)', version, Context.WAFVERSION, wafdir)
  33                 sys.exit(1)
  34
  35         # Store current directory before any chdir
  36         Context.waf_dir = wafdir
  37         Context.run_dir = Context.launch_dir = current_directory
  38         start_dir = current_directory
  39         no_climb = os.environ.get('NOCLIMB')
  40
  41         if len(sys.argv) > 1:
  42                 # os.path.join handles absolute paths
  43                 # if sys.argv[1] is not an absolute path, then it is relative to the current working directory
  44                 potential_wscript = os.path.join(current_directory, sys.argv[1])
  45                 if os.path.basename(potential_wscript) == Context.WSCRIPT_FILE and os.path.isfile(potential_wscript):
  46                         # need to explicitly normalize the path, as it may contain extra '/.'
  47                         path = os.path.normpath(os.path.dirname(potential_wscript))
  48                         start_dir = os.path.abspath(path)
  49                         no_climb = True
  50                         sys.argv.pop(1)
  51
  52         ctx = Context.create_context('options')
  53         (options, commands, env) = ctx.parse_cmd_args(allow_unknown=True)
  54         if options.top:
  55                 start_dir = Context.run_dir = Context.top_dir = options.top
  56                 no_climb = True
  57         if options.out:
  58                 Context.out_dir = options.out
  59
  60         # if 'configure' is in the commands, do not search any further
  61         if not no_climb:
  62                 for k in no_climb_commands:
  63                         for y in commands:
  64                                 if y.startswith(k):
  65                                         no_climb = True
  66                                         break
  67
  68         # try to find a lock file (if the project was configured)
  69         # at the same time, store the first wscript file seen
  70         cur = start_dir
  71         while cur:
  72                 try:
  73                         lst = os.listdir(cur)
  74                 except OSError:
  75                         lst = []
  76                         Logs.error('Directory %r is unreadable!', cur)
  77                 if Options.lockfile in lst:
  78                         env = ConfigSet.ConfigSet()
  79                         try:
  80                                 env.load(os.path.join(cur, Options.lockfile))
  81                                 ino = os.stat(cur)[stat.ST_INO]
  82                         except EnvironmentError:
  83                                 pass
  84                         else:
  85                                 # check if the folder was not moved
  86                                 for x in (env.run_dir, env.top_dir, env.out_dir):
  87                                         if not x:
  88                                                 continue
  89                                         if Utils.is_win32:
  90                                                 if cur == x:
  91                                                         load = True
  92                                                         break
  93                                         else:
  94                                                 # if the filesystem features symlinks, compare the inode numbers
  95                                                 try:
  96                                                         ino2 = os.stat(x)[stat.ST_INO]
  97                                                 except OSError:
  98                                                         pass
  99                                                 else:
 100                                                         if ino == ino2:
 101                                                                 load = True
 102                                                                 break
 103                                 else:
 104                                         Logs.warn('invalid lock file in %s', cur)
 105                                         load = False
 106
 107                                 if load:
 108                                         Context.run_dir = env.run_dir
 109                                         Context.top_dir = env.top_dir
 110                                         Context.out_dir = env.out_dir
 111                                         break
 112
 113                 if not Context.run_dir:
 114                         if Context.WSCRIPT_FILE in lst:
 115                                 Context.run_dir = cur
 116
 117                 next = os.path.dirname(cur)
 118                 if next == cur:
 119                         break
 120                 cur = next
 121
 122                 if no_climb:
 123                         break
 124
 125         wscript = os.path.normpath(os.path.join(Context.run_dir, Context.WSCRIPT_FILE))
 126         if not os.path.exists(wscript):
 127                 if options.whelp:
 128                         Logs.warn('These are the generic options (no wscript/project found)')
 129                         ctx.parser.print_help()
 130                         sys.exit(0)
 131                 Logs.error('Waf: Run from a folder containing a %r file (or try -h for the generic options)', Context.WSCRIPT_FILE)
 132                 sys.exit(1)
 133
 134         try:
 135                 os.chdir(Context.run_dir)
 136         except OSError:
 137                 Logs.error('Waf: The folder %r is unreadable', Context.run_dir)
 138                 sys.exit(1)
 139
 140         try:
 141                 set_main_module(wscript)
 142         except Errors.WafError as e:
 143                 Logs.pprint('RED', e.verbose_msg)
 144                 Logs.error(str(e))
 145                 sys.exit(1)
 146         except Exception as e:
 147                 Logs.error('Waf: The wscript in %r is unreadable', Context.run_dir)
 148                 traceback.print_exc(file=sys.stdout)
 149                 sys.exit(2)
 150
 151         if options.profile:
 152                 import cProfile, pstats
 153                 cProfile.runctx('from waflib import Scripting; Scripting.run_commands()', {}, {}, 'profi.txt')
 154                 p = pstats.Stats('profi.txt')
 155                 p.sort_stats('time').print_stats(75) # or 'cumulative'
 156         else:
 157                 try:
 158                         try:
 159                                 run_commands()
 160                         except:
 161                                 if options.pdb:
 162                                         import pdb
 163                                         type, value, tb = sys.exc_info()
 164                                         traceback.print_exc()
 165                                         pdb.post_mortem(tb)
 166                                 else:
 167                                         raise
 168                 except Errors.WafError as e:
 169                         if Logs.verbose > 1:
 170                                 Logs.pprint('RED', e.verbose_msg)
 171                         Logs.error(e.msg)
 172                         sys.exit(1)
 173                 except SystemExit:
 174                         raise
 175                 except Exception as e:
 176                         traceback.print_exc(file=sys.stdout)
 177                         sys.exit(2)
 178                 except KeyboardInterrupt:
 179                         Logs.pprint('RED', 'Interrupted')
 180                         sys.exit(68)
 181
 182 def set_main_module(file_path):
 183         """
 184         Read the main wscript file into :py:const:`waflib.Context.Context.g_module` and
 185         bind default functions such as ``init``, ``dist``, ``distclean`` if not defined.
 186         Called by :py:func:`waflib.Scripting.waf_entry_point` during the initialization.
 187
 188         :param file_path: absolute path representing the top-level wscript file
 189         :type file_path: string
 190         """
 191         Context.g_module = Context.load_module(file_path)
 192         Context.g_module.root_path = file_path
 193
 194         # note: to register the module globally, use the following:
 195         # sys.modules['wscript_main'] = g_module
 196
 197         def set_def(obj):
 198                 name = obj.__name__
 199                 if not name in Context.g_module.__dict__:
 200                         setattr(Context.g_module, name, obj)
 201         for k in (dist, distclean, distcheck):
 202                 set_def(k)
 203         # add dummy init and shutdown functions if they're not defined
 204         if not 'init' in Context.g_module.__dict__:
 205                 Context.g_module.init = Utils.nada
 206         if not 'shutdown' in Context.g_module.__dict__:
 207                 Context.g_module.shutdown = Utils.nada
 208         if not 'options' in Context.g_module.__dict__:
 209                 Context.g_module.options = Utils.nada
 210
 211 def parse_options():
 212         """
 213         Parses the command-line options and initialize the logging system.
 214         Called by :py:func:`waflib.Scripting.waf_entry_point` during the initialization.
 215         """
 216         ctx = Context.create_context('options')
 217         ctx.execute()
 218         if not Options.commands:
 219                 Options.commands.append(default_cmd)
 220         if Options.options.whelp:
 221                 ctx.parser.print_help()
 222                 sys.exit(0)
 223
 224 def run_command(cmd_name):
 225         """
 226         Executes a single Waf command. Called by :py:func:`waflib.Scripting.run_commands`.
 227
 228         :param cmd_name: command to execute, like ``build``
 229         :type cmd_name: string
 230         """
 231         ctx = Context.create_context(cmd_name)
 232         ctx.log_timer = Utils.Timer()
 233         ctx.options = Options.options # provided for convenience
 234         ctx.cmd = cmd_name
 235         try:
 236                 ctx.execute()
 237         finally:
 238                 # Issue 1374
 239                 ctx.finalize()
 240         return ctx
 241
 242 def run_commands():
 243         """
 244         Execute the Waf commands that were given on the command-line, and the other options
 245         Called by :py:func:`waflib.Scripting.waf_entry_point` during the initialization, and executed
 246         after :py:func:`waflib.Scripting.parse_options`.
 247         """
 248         parse_options()
 249         run_command('init')
 250         while Options.commands:
 251                 cmd_name = Options.commands.pop(0)
 252                 ctx = run_command(cmd_name)
 253                 Logs.info('%r finished successfully (%s)', cmd_name, ctx.log_timer)
 254         run_command('shutdown')
 255
 256 ###########################################################################################
 257
 258 def distclean_dir(dirname):
 259         """
 260         Distclean function called in the particular case when::
 261
 262                 top == out
 263
 264         :param dirname: absolute path of the folder to clean
 265         :type dirname: string
 266         """
 267         for (root, dirs, files) in os.walk(dirname):
 268                 for f in files:
 269                         if f.endswith(('.o', '.moc', '.exe')):
 270                                 fname = os.path.join(root, f)
 271                                 try:
 272                                         os.remove(fname)
 273                                 except OSError:
 274                                         Logs.warn('Could not remove %r', fname)
 275
 276         for x in (Context.DBFILE, 'config.log'):
 277                 try:
 278                         os.remove(x)
 279                 except OSError:
 280                         pass
 281
 282         try:
 283                 shutil.rmtree('c4che')
 284         except OSError:
 285                 pass
 286
 287 def distclean(ctx):
 288         '''removes build folders and data'''
 289
 290         def remove_and_log(k, fun):
 291                 try:
 292                         fun(k)
 293                 except EnvironmentError as e:
 294                         if e.errno != errno.ENOENT:
 295                                 Logs.warn('Could not remove %r', k)
 296
 297         # remove waf cache folders on the top-level
 298         if not Options.commands:
 299                 for k in os.listdir('.'):
 300                         for x in '.waf-2 waf-2 .waf3-2 waf3-2'.split():
 301                                 if k.startswith(x):
 302                                         remove_and_log(k, shutil.rmtree)
 303
 304         # remove a build folder, if any
 305         cur = '.'
 306         if ctx.options.no_lock_in_top:
 307                 cur = ctx.options.out
 308
 309         try:
 310                 lst = os.listdir(cur)
 311         except OSError:
 312                 Logs.warn('Could not read %r', cur)
 313                 return
 314
 315         if Options.lockfile in lst:
 316                 f = os.path.join(cur, Options.lockfile)
 317                 try:
 318                         env = ConfigSet.ConfigSet(f)
 319                 except EnvironmentError:
 320                         Logs.warn('Could not read %r', f)
 321                         return
 322
 323                 if not env.out_dir or not env.top_dir:
 324                         Logs.warn('Invalid lock file %r', f)
 325                         return
 326
 327                 if env.out_dir == env.top_dir:
 328                         distclean_dir(env.out_dir)
 329                 else:
 330                         remove_and_log(env.out_dir, shutil.rmtree)
 331
 332                 for k in (env.out_dir, env.top_dir, env.run_dir):
 333                         p = os.path.join(k, Options.lockfile)
 334                         remove_and_log(p, os.remove)
 335
 336 class Dist(Context.Context):
 337         '''creates an archive containing the project source code'''
 338         cmd = 'dist'
 339         fun = 'dist'
 340         algo = 'tar.bz2'
 341         ext_algo = {}
 342
 343         def execute(self):
 344                 """
 345                 See :py:func:`waflib.Context.Context.execute`
 346                 """
 347                 self.recurse([os.path.dirname(Context.g_module.root_path)])
 348                 self.archive()
 349
 350         def archive(self):
 351                 """
 352                 Creates the source archive.
 353                 """
 354                 import tarfile
 355
 356                 arch_name = self.get_arch_name()
 357
 358                 try:
 359                         self.base_path
 360                 except AttributeError:
 361                         self.base_path = self.path
 362
 363                 node = self.base_path.make_node(arch_name)
 364                 try:
 365                         node.delete()
 366                 except OSError:
 367                         pass
 368
 369                 files = self.get_files()
 370
 371                 if self.algo.startswith('tar.'):
 372                         tar = tarfile.open(node.abspath(), 'w:' + self.algo.replace('tar.', ''))
 373
 374                         for x in files:
 375                                 self.add_tar_file(x, tar)
 376                         tar.close()
 377                 elif self.algo == 'zip':
 378                         import zipfile
 379                         zip = zipfile.ZipFile(node.abspath(), 'w', compression=zipfile.ZIP_DEFLATED)
 380
 381                         for x in files:
 382                                 archive_name = self.get_base_name() + '/' + x.path_from(self.base_path)
 383                                 zip.write(x.abspath(), archive_name, zipfile.ZIP_DEFLATED)
 384                         zip.close()
 385                 else:
 386                         self.fatal('Valid algo types are tar.bz2, tar.gz, tar.xz or zip')
 387
 388                 try:
 389                         from hashlib import sha256
 390                 except ImportError:
 391                         digest = ''
 392                 else:
 393                         digest = ' (sha256=%r)' % sha256(node.read(flags='rb')).hexdigest()
 394
 395                 Logs.info('New archive created: %s%s', self.arch_name, digest)
 396
 397         def get_tar_path(self, node):
 398                 """
 399                 Return the path to use for a node in the tar archive, the purpose of this
 400                 is to let subclases resolve symbolic links or to change file names
 401
 402                 :return: absolute path
 403                 :rtype: string
 404                 """
 405                 return node.abspath()
 406
 407         def add_tar_file(self, x, tar):
 408                 """
 409                 Adds a file to the tar archive. Symlinks are not verified.
 410
 411                 :param x: file path
 412                 :param tar: tar file object
 413                 """
 414                 p = self.get_tar_path(x)
 415                 tinfo = tar.gettarinfo(name=p, arcname=self.get_tar_prefix() + '/' + x.path_from(self.base_path))
 416                 tinfo.uid   = 0
 417                 tinfo.gid   = 0
 418                 tinfo.uname = 'root'
 419                 tinfo.gname = 'root'
 420
 421                 if os.path.isfile(p):
 422                         with open(p, 'rb') as f:
 423                                 tar.addfile(tinfo, fileobj=f)
 424                 else:
 425                         tar.addfile(tinfo)
 426
 427         def get_tar_prefix(self):
 428                 """
 429                 Returns the base path for files added into the archive tar file
 430
 431                 :rtype: string
 432                 """
 433                 try:
 434                         return self.tar_prefix
 435                 except AttributeError:
 436                         return self.get_base_name()
 437
 438         def get_arch_name(self):
 439                 """
 440                 Returns the archive file name.
 441                 Set the attribute *arch_name* to change the default value::
 442
 443                         def dist(ctx):
 444                                 ctx.arch_name = 'ctx.tar.bz2'
 445
 446                 :rtype: string
 447                 """
 448                 try:
 449                         self.arch_name
 450                 except AttributeError:
 451                         self.arch_name = self.get_base_name() + '.' + self.ext_algo.get(self.algo, self.algo)
 452                 return self.arch_name
 453
 454         def get_base_name(self):
 455                 """
 456                 Returns the default name of the main directory in the archive, which is set to *appname-version*.
 457                 Set the attribute *base_name* to change the default value::
 458
 459                         def dist(ctx):
 460                                 ctx.base_name = 'files'
 461
 462                 :rtype: string
 463                 """
 464                 try:
 465                         self.base_name
 466                 except AttributeError:
 467                         appname = getattr(Context.g_module, Context.APPNAME, 'noname')
 468                         version = getattr(Context.g_module, Context.VERSION, '1.0')
 469                         self.base_name = appname + '-' + version
 470                 return self.base_name
 471
 472         def get_excl(self):
 473                 """
 474                 Returns the patterns to exclude for finding the files in the top-level directory.
 475                 Set the attribute *excl* to change the default value::
 476
 477                         def dist(ctx):
 478                                 ctx.excl = 'build **/*.o **/*.class'
 479
 480                 :rtype: string
 481                 """
 482                 try:
 483                         return self.excl
 484                 except AttributeError:
 485                         self.excl = Node.exclude_regs + ' **/waf-2.* **/.waf-2.* **/waf3-2.* **/.waf3-2.* **/*~ **/*.rej **/*.orig **/*.pyc **/*.pyo **/*.bak **/*.swp **/.lock-w*'
 486                         if Context.out_dir:
 487                                 nd = self.root.find_node(Context.out_dir)
 488                                 if nd:
 489                                         self.excl += ' ' + nd.path_from(self.base_path)
 490                         return self.excl
 491
 492         def get_files(self):
 493                 """
 494                 Files to package are searched automatically by :py:func:`waflib.Node.Node.ant_glob`.
 495                 Set *files* to prevent this behaviour::
 496
 497                         def dist(ctx):
 498                                 ctx.files = ctx.path.find_node('wscript')
 499
 500                 Files are also searched from the directory 'base_path', to change it, set::
 501
 502                         def dist(ctx):
 503                                 ctx.base_path = path
 504
 505                 :rtype: list of :py:class:`waflib.Node.Node`
 506                 """
 507                 try:
 508                         files = self.files
 509                 except AttributeError:
 510                         files = self.base_path.ant_glob('**/*', excl=self.get_excl())
 511                 return files
 512
 513 def dist(ctx):
 514         '''makes a tarball for redistributing the sources'''
 515         pass
 516
 517 class DistCheck(Dist):
 518         """creates an archive with dist, then tries to build it"""
 519         fun = 'distcheck'
 520         cmd = 'distcheck'
 521
 522         def execute(self):
 523                 """
 524                 See :py:func:`waflib.Context.Context.execute`
 525                 """
 526                 self.recurse([os.path.dirname(Context.g_module.root_path)])
 527                 self.archive()
 528                 self.check()
 529
 530         def make_distcheck_cmd(self, tmpdir):
 531                 cfg = []
 532                 if Options.options.distcheck_args:
 533                         cfg = shlex.split(Options.options.distcheck_args)
 534                 else:
 535                         cfg = [x for x in sys.argv if x.startswith('-')]
 536                 cmd = [sys.executable, sys.argv[0], 'configure', 'build', 'install', 'uninstall', '--destdir=' + tmpdir] + cfg
 537                 return cmd
 538
 539         def check(self):
 540                 """
 541                 Creates the archive, uncompresses it and tries to build the project
 542                 """
 543                 import tempfile, tarfile
 544
 545                 with tarfile.open(self.get_arch_name()) as t:
 546                         for x in t:
 547                                 t.extract(x)
 548
 549                 instdir = tempfile.mkdtemp('.inst', self.get_base_name())
 550                 cmd = self.make_distcheck_cmd(instdir)
 551                 ret = Utils.subprocess.Popen(cmd, cwd=self.get_base_name()).wait()
 552                 if ret:
 553                         raise Errors.WafError('distcheck failed with code %r' % ret)
 554
 555                 if os.path.exists(instdir):
 556                         raise Errors.WafError('distcheck succeeded, but files were left in %s' % instdir)
 557
 558                 shutil.rmtree(self.get_base_name())
 559
 560
 561 def distcheck(ctx):
 562         '''checks if the project compiles (tarball from 'dist')'''
 563         pass
 564
 565 def autoconfigure(execute_method):
 566         """
 567         Decorator that enables context commands to run *configure* as needed.
 568         """
 569         def execute(self):
 570                 """
 571                 Wraps :py:func:`waflib.Context.Context.execute` on the context class
 572                 """
 573                 if not Configure.autoconfig:
 574                         return execute_method(self)
 575
 576                 env = ConfigSet.ConfigSet()
 577                 do_config = False
 578                 try:
 579                         env.load(os.path.join(Context.top_dir, Options.lockfile))
 580                 except EnvironmentError:
 581                         Logs.warn('Configuring the project')
 582                         do_config = True
 583                 else:
 584                         if env.run_dir != Context.run_dir:
 585                                 do_config = True
 586                         else:
 587                                 h = 0
 588                                 for f in env.files:
 589                                         try:
 590                                                 h = Utils.h_list((h, Utils.readf(f, 'rb')))
 591                                         except EnvironmentError:
 592                                                 do_config = True
 593                                                 break
 594                                 else:
 595                                         do_config = h != env.hash
 596
 597                 if do_config:
 598                         cmd = env.config_cmd or 'configure'
 599                         if Configure.autoconfig == 'clobber':
 600                                 tmp = Options.options.__dict__
 601                                 if env.options:
 602                                         Options.options.__dict__ = env.options
 603                                 try:
 604                                         run_command(cmd)
 605                                 finally:
 606                                         Options.options.__dict__ = tmp
 607                         else:
 608                                 run_command(cmd)
 609                         run_command(self.cmd)
 610                 else:
 611                         return execute_method(self)
 612         return execute
 613 Build.BuildContext.execute = autoconfigure(Build.BuildContext.execute)
 614