123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235 |
- # Copyright 2015-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.
- import sys, os
- import subprocess
- import shutil
- import argparse
- from ..mesonlib import MesonException, Popen_safe
- from . import destdir_join
- parser = argparse.ArgumentParser()
- parser.add_argument('--sourcedir', dest='sourcedir')
- parser.add_argument('--builddir', dest='builddir')
- parser.add_argument('--subdir', dest='subdir')
- parser.add_argument('--headerdirs', dest='headerdirs')
- parser.add_argument('--mainfile', dest='mainfile')
- parser.add_argument('--modulename', dest='modulename')
- parser.add_argument('--htmlargs', dest='htmlargs', default='')
- parser.add_argument('--scanargs', dest='scanargs', default='')
- parser.add_argument('--scanobjsargs', dest='scanobjsargs', default='')
- parser.add_argument('--gobjects-types-file', dest='gobject_typesfile', default='')
- parser.add_argument('--fixxrefargs', dest='fixxrefargs', default='')
- parser.add_argument('--mkdbargs', dest='mkdbargs', default='')
- parser.add_argument('--ld', dest='ld', default='')
- parser.add_argument('--cc', dest='cc', default='')
- parser.add_argument('--ldflags', dest='ldflags', default='')
- parser.add_argument('--cflags', dest='cflags', default='')
- parser.add_argument('--content-files', dest='content_files', default='')
- parser.add_argument('--expand-content-files', dest='expand_content_files', default='')
- parser.add_argument('--html-assets', dest='html_assets', default='')
- parser.add_argument('--ignore-headers', dest='ignore_headers', default='')
- parser.add_argument('--namespace', dest='namespace', default='')
- parser.add_argument('--mode', dest='mode', default='')
- parser.add_argument('--installdir', dest='install_dir')
- def gtkdoc_run_check(cmd, cwd):
- # Put stderr into stdout since we want to print it out anyway.
- # This preserves the order of messages.
- p, out = Popen_safe(cmd, cwd=cwd, stderr=subprocess.STDOUT)[0:2]
- if p.returncode != 0:
- err_msg = ["{!r} failed with status {:d}".format(cmd[0], p.returncode)]
- if out:
- err_msg.append(out)
- raise MesonException('\n'.join(err_msg))
- def build_gtkdoc(source_root, build_root, doc_subdir, src_subdirs,
- main_file, module,
- html_args, scan_args, fixxref_args, mkdb_args,
- gobject_typesfile, scanobjs_args, ld, cc, ldflags, cflags,
- html_assets, content_files, ignore_headers, namespace,
- expand_content_files, mode):
- print("Building documentation for %s" % module)
- src_dir_args = []
- for src_dir in src_subdirs:
- if not os.path.isabs(src_dir):
- dirs = [os.path.join(source_root, src_dir),
- os.path.join(build_root, src_dir)]
- else:
- dirs = [src_dir]
- src_dir_args += ['--source-dir=' + d for d in dirs]
- doc_src = os.path.join(source_root, doc_subdir)
- abs_out = os.path.join(build_root, doc_subdir)
- htmldir = os.path.join(abs_out, 'html')
- content_files += [main_file]
- sections = os.path.join(doc_src, module + "-sections.txt")
- if os.path.exists(sections):
- content_files.append(sections)
- overrides = os.path.join(doc_src, module + "-overrides.txt")
- if os.path.exists(overrides):
- content_files.append(overrides)
- # Copy files to build directory
- for f in content_files:
- f_abs = os.path.join(doc_src, f)
- shutil.copyfile(f_abs, os.path.join(
- abs_out, os.path.basename(f_abs)))
- shutil.rmtree(htmldir, ignore_errors=True)
- try:
- os.mkdir(htmldir)
- except Exception:
- pass
- for f in html_assets:
- f_abs = os.path.join(doc_src, f)
- shutil.copyfile(f_abs, os.path.join(htmldir, os.path.basename(f_abs)))
- scan_cmd = ['gtkdoc-scan', '--module=' + module] + src_dir_args
- if ignore_headers:
- scan_cmd.append('--ignore-headers=' + ' '.join(ignore_headers))
- # Add user-specified arguments
- scan_cmd += scan_args
- gtkdoc_run_check(scan_cmd, abs_out)
- if gobject_typesfile:
- scanobjs_cmd = ['gtkdoc-scangobj'] + scanobjs_args + ['--types=' + gobject_typesfile,
- '--module=' + module,
- '--cflags=' + cflags,
- '--ldflags=' + ldflags]
- gtkdoc_run_check(scanobjs_cmd, abs_out)
- # Make docbook files
- if mode == 'auto':
- # Guessing is probably a poor idea but these keeps compat
- # with previous behavior
- if main_file.endswith('sgml'):
- modeflag = '--sgml-mode'
- else:
- modeflag = '--xml-mode'
- elif mode == 'xml':
- modeflag = '--xml-mode'
- elif mode == 'sgml':
- modeflag = '--sgml-mode'
- else: # none
- modeflag = None
- mkdb_cmd = ['gtkdoc-mkdb',
- '--module=' + module,
- '--output-format=xml',
- '--expand-content-files=' + ' '.join(expand_content_files),
- ] + src_dir_args
- if namespace:
- mkdb_cmd.append('--name-space=' + namespace)
- if modeflag:
- mkdb_cmd.append(modeflag)
- if len(main_file) > 0:
- # Yes, this is the flag even if the file is in xml.
- mkdb_cmd.append('--main-sgml-file=' + main_file)
- # Add user-specified arguments
- mkdb_cmd += mkdb_args
- gtkdoc_run_check(mkdb_cmd, abs_out)
- # Make HTML documentation
- mkhtml_cmd = ['gtkdoc-mkhtml',
- '--path=' + ':'.join((doc_src, abs_out)),
- module,
- ] + html_args
- if len(main_file) > 0:
- mkhtml_cmd.append('../' + main_file)
- else:
- mkhtml_cmd.append('%s-docs.xml' % module)
- # html gen must be run in the HTML dir
- gtkdoc_run_check(mkhtml_cmd, os.path.join(abs_out, 'html'))
- # Fix cross-references in HTML files
- fixref_cmd = ['gtkdoc-fixxref',
- '--module=' + module,
- '--module-dir=html'] + fixxref_args
- gtkdoc_run_check(fixref_cmd, abs_out)
- def install_gtkdoc(build_root, doc_subdir, install_prefix, datadir, module):
- source = os.path.join(build_root, doc_subdir, 'html')
- final_destination = os.path.join(install_prefix, datadir, module)
- shutil.rmtree(final_destination, ignore_errors=True)
- shutil.copytree(source, final_destination)
- def run(args):
- options = parser.parse_args(args)
- if len(options.htmlargs) > 0:
- htmlargs = options.htmlargs.split('@@')
- else:
- htmlargs = []
- if len(options.scanargs) > 0:
- scanargs = options.scanargs.split('@@')
- else:
- scanargs = []
- if len(options.scanobjsargs) > 0:
- scanobjsargs = options.scanobjsargs.split('@@')
- else:
- scanobjsargs = []
- if len(options.fixxrefargs) > 0:
- fixxrefargs = options.fixxrefargs.split('@@')
- else:
- fixxrefargs = []
- if len(options.mkdbargs) > 0:
- mkdbargs = options.mkdbargs.split('@@')
- else:
- mkdbargs = []
- build_gtkdoc(
- options.sourcedir,
- options.builddir,
- options.subdir,
- options.headerdirs.split('@@'),
- options.mainfile,
- options.modulename,
- htmlargs,
- scanargs,
- fixxrefargs,
- mkdbargs,
- options.gobject_typesfile,
- scanobjsargs,
- options.ld,
- options.cc,
- options.ldflags,
- options.cflags,
- options.html_assets.split('@@') if options.html_assets else [],
- options.content_files.split('@@') if options.content_files else [],
- options.ignore_headers.split('@@') if options.ignore_headers else [],
- options.namespace,
- options.expand_content_files.split('@@') if options.expand_content_files else [],
- options.mode)
- if 'MESON_INSTALL_PREFIX' in os.environ:
- destdir = os.environ.get('DESTDIR', '')
- install_prefix = destdir_join(destdir, os.environ['MESON_INSTALL_PREFIX'])
- install_dir = options.install_dir if options.install_dir else options.modulename
- if os.path.isabs(install_dir):
- install_dir = destdir_join(destdir, install_dir)
- install_gtkdoc(options.builddir,
- options.subdir,
- install_prefix,
- 'share/gtk-doc/html',
- install_dir)
- return 0
- if __name__ == '__main__':
- sys.exit(run(sys.argv[1:]))
|