Merge pull request #1151 from mesonbuild/tingping/gtk-doc

gnome: Various improvements to gtkdoc

mesonbuild/modules/gnome.py

@@ -653,25 +653,39 @@ can not be used with the current version of glib-compiled-resources, due to
             if main_file != '':
                 raise MesonException('You can only specify main_xml or main_sgml, not both.')
             main_file = main_xml
-        src_dir = kwargs['src_dir']
         targetname = modulename + '-doc'
         command = [state.environment.get_build_command(), '--internal', 'gtkdoc']
-        if hasattr(src_dir, 'held_object'):
-            src_dir= src_dir.held_object
-            if not isinstance(src_dir, build.IncludeDirs):
-                raise MesonException('Invalid keyword argument for src_dir.')
-            incdirs = src_dir.get_incdirs()
-            if len(incdirs) != 1:
-                raise MesonException('Argument src_dir has more than one directory specified.')
-            header_dir = os.path.join(state.environment.get_source_dir(), src_dir.get_curdir(), incdirs[0])
-        else:
-            header_dir = os.path.normpath(os.path.join(state.subdir, src_dir))
+
+        namespace = kwargs.get('namespace', '')
+        mode = kwargs.get('mode', 'auto')
+        VALID_MODES = ('xml', 'sgml', 'none', 'auto')
+        if not mode in VALID_MODES:
+            raise MesonException('gtkdoc: Mode {} is not a valid mode: {}'.format(mode, VALID_MODES))
+
+        src_dirs = kwargs['src_dir']
+        if not isinstance(src_dirs, list):
+            src_dirs = [src_dirs]
+        header_dirs = []
+        for src_dir in src_dirs:
+            if hasattr(src_dir, 'held_object'):
+                src_dir = src_dir.held_object
+                if not isinstance(src_dir, build.IncludeDirs):
+                    raise MesonException('Invalid keyword argument for src_dir.')
+                for inc_dir in src_dir.get_incdirs():
+                    header_dirs.append(os.path.join(state.environment.get_source_dir(),
+                                                    src_dir.get_curdir(), inc_dir))
+            else:
+                header_dirs.append(os.path.normpath(os.path.join(state.subdir, src_dir)))
+
         args = ['--sourcedir=' + state.environment.get_source_dir(),
                 '--builddir=' + state.environment.get_build_dir(),
                 '--subdir=' + state.subdir,
-                '--headerdir=' + header_dir,
+                '--headerdirs=' + '@@'.join(header_dirs),
                 '--mainfile=' + main_file,
-                '--modulename=' + modulename]
+                '--modulename=' + modulename,
+                '--mode=' + mode]
+        if namespace:
+            args.append('--namespace=' + namespace)
         args += self._unpack_args('--htmlargs=', 'html_args', kwargs)
         args += self._unpack_args('--scanargs=', 'scan_args', kwargs)
         args += self._unpack_args('--scanobjsargs=', 'scanobjs_args', kwargs)
@@ -679,6 +693,7 @@ can not be used with the current version of glib-compiled-resources, due to
         args += self._unpack_args('--fixxrefargs=', 'fixxref_args', kwargs)
         args += self._unpack_args('--html-assets=', 'html_assets', kwargs, state)
         args += self._unpack_args('--content-files=', 'content_files', kwargs, state)
+        args += self._unpack_args('--expand-content-files=', 'expand_content_files', kwargs, state)
         args += self._unpack_args('--ignore-headers=', 'ignore_headers', kwargs)
         args += self._unpack_args('--installdir=', 'install_dir', kwargs, state)
         args += self._get_build_args(kwargs, state)

mesonbuild/scripts/gtkdochelper.py

@@ -25,7 +25,7 @@ parser = argparse.ArgumentParser()
 parser.add_argument('--sourcedir', dest='sourcedir')
 parser.add_argument('--builddir', dest='builddir')
 parser.add_argument('--subdir', dest='subdir')
-parser.add_argument('--headerdir', dest='headerdir')
+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='')
@@ -38,8 +38,11 @@ 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):
@@ -54,13 +57,14 @@ def gtkdoc_run_check(cmd, cwd):
             err_msg.append(stdo.decode(errors='ignore'))
         raise MesonException('\n'.join(err_msg))
 
-def build_gtkdoc(source_root, build_root, doc_subdir, src_subdir,
+def build_gtkdoc(source_root, build_root, doc_subdir, src_subdirs,
                  main_file, module, html_args, scan_args, fixxref_args,
                  gobject_typesfile, scanobjs_args, ld, cc, ldflags, cflags,
-                 html_assets, content_files, ignore_headers):
+                 html_assets, content_files, ignore_headers, namespace,
+                 expand_content_files, mode):
     print("Building documentation for %s" % module)
 
-    abs_src = os.path.join(source_root, src_subdir)
+    src_dir_args = ['--source-dir=' + os.path.join(source_root, src_dir) for src_dir in src_subdirs]
     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')
@@ -90,7 +94,7 @@ def build_gtkdoc(source_root, build_root, doc_subdir, src_subdir,
         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, '--source-dir=' + abs_src]
+    scan_cmd = ['gtkdoc-scan', '--module=' + module] + src_dir_args
     if ignore_headers:
         scan_cmd.append('--ignore-headers=' + ' '.join(ignore_headers))
     # Add user-specified arguments
@@ -105,16 +109,29 @@ def build_gtkdoc(source_root, build_root, doc_subdir, src_subdir,
 
 
     # Make docbook files
-    if main_file.endswith('sgml'):
-        modeflag = '--sgml-mode'
-    else:
+    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=',
-                modeflag,
-                '--source-dir=' + abs_src]
+                '--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)
@@ -122,7 +139,7 @@ def build_gtkdoc(source_root, build_root, doc_subdir, src_subdir,
 
     # Make HTML documentation
     mkhtml_cmd = ['gtkdoc-mkhtml',
-                  '--path=' + ':'.join((abs_src, abs_out)),
+                  '--path=' + ':'.join((doc_src, abs_out)),
                   module,
                   ] + html_args
     if len(main_file) > 0:
@@ -166,7 +183,7 @@ def run(args):
         options.sourcedir,
         options.builddir,
         options.subdir,
-        options.headerdir,
+        options.headerdirs.split('@@'),
         options.mainfile,
         options.modulename,
         htmlargs,
@@ -180,7 +197,10 @@ def run(args):
         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.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:
         install_dir = options.install_dir if options.install_dir else options.modulename