text: # Copyright 2014-2016 The Meson development team
  
  # Licensed under the Apache License, Version 2.0 (the "License");
  # you may not use this file except in compliance with the License.
  # You may obtain a copy of the License at
  
  #     http://www.apache.org/licenses/LICENSE-2.0
  
  # Unless required by applicable law or agreed to in writing, software
  # distributed under the License is distributed on an "AS IS" BASIS,
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  # See the License for the specific language governing permissions and
  # limitations under the License.
  
  """This is a helper script for IDE developers. It allows you to
  extract information such as list of targets, files, compiler flags,
  tests and so on. All output is in JSON for simple parsing.
  
  Currently only works for the Ninja backend. Others use generated
  project files and don't need this info."""
  
  import json, pickle
  from . import coredata, build
  import argparse
  import sys, os
  import pathlib
  
  parser = argparse.ArgumentParser(prog='meson introspect')
  parser.add_argument('--targets', action='store_true', dest='list_targets', default=False,
                      help='List top level targets.')
  parser.add_argument('--installed', action='store_true', dest='list_installed', default=False,
                      help='List all installed files and directories.')
  parser.add_argument('--target-files', action='store', dest='target_files', default=None,
                      help='List source files for a given target.')
  parser.add_argument('--buildsystem-files', action='store_true', dest='buildsystem_files', default=False,
                      help='List files that make up the build system.')
  parser.add_argument('--buildoptions', action='store_true', dest='buildoptions', default=False,
                      help='List all build options.')
  parser.add_argument('--tests', action='store_true', dest='tests', default=False,
                      help='List all unit tests.')
  parser.add_argument('--benchmarks', action='store_true', dest='benchmarks', default=False,
                      help='List all benchmarks.')
  parser.add_argument('--dependencies', action='store_true', dest='dependencies', default=False,
                      help='List external dependencies.')
  parser.add_argument('--projectinfo', action='store_true', dest='projectinfo', default=False,
                      help='Information about projects.')
  parser.add_argument('builddir', nargs='?', help='The build directory')
  
  def determine_installed_path(target, installdata):
      install_target = None
      for i in installdata.targets:
          if os.path.split(i[0])[1] == target.get_filename(): # FIXME, might clash due to subprojects.
              install_target = i
              break
      if install_target is None:
          raise RuntimeError('Something weird happened. File a bug.')
      fname = i[0]
      outdir = i[1]
      outname = os.path.join(installdata.prefix, outdir, os.path.split(fname)[-1])
      # Normalize the path by using os.path.sep consistently, etc.
      # Does not change the effective path.
      return str(pathlib.PurePath(outname))
  
  
  def list_installed(installdata):
      res = {}
      if installdata is not None:
          for path, installdir, aliases, unknown1, unknown2 in installdata.targets:
              res[os.path.join(installdata.build_dir, path)] = os.path.join(installdata.prefix, installdir, os.path.basename(path))
          for path, installpath, unused_prefix in installdata.data:
              res[path] = os.path.join(installdata.prefix, installpath)
          for path, installdir in installdata.headers:
              res[path] = os.path.join(installdata.prefix, installdir, os.path.basename(path))
          for path, installpath in installdata.man:
              res[path] = os.path.join(installdata.prefix, installpath)
      print(json.dumps(res))
  
  
  def list_targets(coredata, builddata, installdata):
      tlist = []
      for (idname, target) in builddata.get_targets().items():
          t = {'name': target.get_basename(), 'id': idname}
          fname = target.get_filename()
          if isinstance(fname, list):
              fname = [os.path.join(target.subdir, x) for x in fname]
          else:
              fname = os.path.join(target.subdir, fname)
          t['filename'] = fname
          if isinstance(target, build.Executable):
              typename = 'executable'
          elif isinstance(target, build.SharedLibrary):
              typename = 'shared library'
          elif isinstance(target, build.StaticLibrary):
              typename = 'static library'
          elif isinstance(target, build.CustomTarget):
              typename = 'custom'
          elif isinstance(target, build.RunTarget):
              typename = 'run'
          else:
              typename = 'unknown'
          t['type'] = typename
          if installdata and target.should_install():
              t['installed'] = True
              t['install_filename'] = determine_installed_path(target, installdata)
          else:
              t['installed'] = False
          t['build_by_default'] = target.build_by_default
          tlist.append(t)
      print(json.dumps(tlist))
  
  def list_target_files(target_name, coredata, builddata):
      try:
          t = builddata.targets[target_name]
          sources = t.sources + t.extra_files
      except KeyError:
          print("Unknown target %s." % target_name)
          sys.exit(1)
      sources = [os.path.join(i.subdir, i.fname) for i in sources]
      print(json.dumps(sources))
  
  def list_buildoptions(coredata, builddata):
      optlist = []
      add_keys(optlist, coredata.user_options)
      add_keys(optlist, coredata.compiler_options)
      add_keys(optlist, coredata.base_options)
      add_keys(optlist, coredata.builtins)
      print(json.dumps(optlist))
  
  def add_keys(optlist, options):
      keys = list(options.keys())
      keys.sort()
      for key in keys:
          opt = options[key]
          optdict = {'name': key, 'value': opt.value}
          if isinstance(opt, coredata.UserStringOption):
              typestr = 'string'
          elif isinstance(opt, coredata.UserBooleanOption):
              typestr = 'boolean'
          elif isinstance(opt, coredata.UserComboOption):
              optdict['choices'] = opt.choices
              typestr = 'combo'
          elif isinstance(opt, coredata.UserStringArrayOption):
              typestr = 'stringarray'
          else:
              raise RuntimeError("Unknown option type")
          optdict['type'] = typestr
          optdict['description'] = opt.description
          optlist.append(optdict)
  
  def list_buildsystem_files(coredata, builddata):
      src_dir = builddata.environment.get_source_dir()
      # I feel dirty about this. But only slightly.
      filelist = []
      for root, _, files in os.walk(src_dir):
          for f in files:
              if f == 'meson.build' or f == 'meson_options.txt':
                  filelist.append(os.path.relpath(os.path.join(root, f), src_dir))
      print(json.dumps(filelist))
  
  def list_deps(coredata):
      result = []
      for d in coredata.deps.values():
          if d.found():
              result += [{'name': d.name,
                          'compile_args': d.get_compile_args(),
                          'link_args': d.get_link_args()}]
      print(json.dumps(result))
  
  def list_tests(testdata):
      result = []
      for t in testdata:
          to = {}
          if isinstance(t.fname, str):
              fname = [t.fname]
          else:
              fname = t.fname
          to['cmd'] = fname + t.cmd_args
          if isinstance(t.env, build.EnvironmentVariables):
              to['env'] = t.env.get_env(os.environ)
          else:
              to['env'] = t.env
          to['name'] = t.name
          to['workdir'] = t.workdir
          to['timeout'] = t.timeout
          to['suite'] = t.suite
          result.append(to)
      print(json.dumps(result))
  
  def list_projinfo(builddata):
      result = {'name': builddata.project_name, 'version': builddata.project_version}
      subprojects = []
      for k, v in builddata.subprojects.items():
          c = {'name': k,
               'version': v}
          subprojects.append(c)
      result['subprojects'] = subprojects
      print(json.dumps(result))
  
  def run(args):
      datadir = 'meson-private'
      options = parser.parse_args(args)
      if options.builddir is not None:
          datadir = os.path.join(options.builddir, datadir)
      if not os.path.isdir(datadir):
          print('Current directory is not a build dir. Please specify it or '
                'change the working directory to it.')
          return 1
  
      corefile = os.path.join(datadir, 'coredata.dat')
      buildfile = os.path.join(datadir, 'build.dat')
      installfile = os.path.join(datadir, 'install.dat')
      testfile = os.path.join(datadir, 'meson_test_setup.dat')
      benchmarkfile = os.path.join(datadir, 'meson_benchmark_setup.dat')
  
      # Load all data files
      with open(corefile, 'rb') as f:
          coredata = pickle.load(f)
      with open(buildfile, 'rb') as f:
          builddata = pickle.load(f)
      with open(testfile, 'rb') as f:
          testdata = pickle.load(f)
      with open(benchmarkfile, 'rb') as f:
          benchmarkdata = pickle.load(f)
      # Install data is only available with the Ninja backend
      if os.path.isfile(installfile):
          with open(installfile, 'rb') as f:
              installdata = pickle.load(f)
      else:
          installdata = None
  
      if options.list_targets:
          list_targets(coredata, builddata, installdata)
      elif options.list_installed:
          list_installed(installdata)
      elif options.target_files is not None:
          list_target_files(options.target_files, coredata, builddata)
      elif options.buildsystem_files:
          list_buildsystem_files(coredata, builddata)
      elif options.buildoptions:
          list_buildoptions(coredata, builddata)
      elif options.tests:
          list_tests(testdata)
      elif options.benchmarks:
          list_tests(benchmarkdata)
      elif options.dependencies:
          list_deps(coredata)
      elif options.projectinfo:
          list_projinfo(builddata)
      else:
          print('No command specified')
          return 1
      return 0
  
  if __name__ == '__main__':
      sys.exit(run(sys.argv[1:]))
  