make GIR documentation engine use custom targets

- Make GIR documentation work with generated GIRs by allowing projects
  to specify additional dirs to look for GIRs in. This is especially
  useful with Meson subprojects.
- Enable GIR documentation by default now. The feature is stable.

Author: Prince781

meson_options.txt

@@ -1,4 +1,3 @@
-option('parse_system_girs', type: 'boolean', value: true, description: 'Parse system GIRs for symbol documentation')
 option('active_parameter', type: 'boolean', value: false, description: 'Support activeParameter in signatureHelp')
 option('debug_mem', type: 'boolean', value: false, description: 'Debug memory usage')
 option('builder_abi', type: 'string', value: 'auto', description: 'Builder ABI version. Use a value like \'3.38\'')

src/documentation/doccomment.vala

@@ -48,7 +48,6 @@ class Vls.DocComment {
         body = markdown_doc;
     }
 
-#if PARSE_SYSTEM_GIRS
     /**
      * Render a GTK-Doc-formatted comment into Markdown.
      *
@@ -68,7 +67,6 @@ class Vls.DocComment {
                 return_body = documentation.render_gtk_doc_comment (gir_comment.return_content, compilation);
         }
     }
-#endif
 
     /**
      * Render a ValaDoc-formatted comment into Markdown.

src/documentation/girdocumentation.vala

@@ -43,14 +43,20 @@ class Vls.GirDocumentation {
         if (girpath != null) {
             context.add_source_file (new Vala.SourceFile (context, Vala.SourceFileType.PACKAGE, girpath));
             added[gir_package] = vapi_package;
+            debug ("adding GIR %s for package %s", gir_package, vapi_package);
         }
     }
 
     /**
      * Create a new holder for GIR docs by adding all GIRs found in
-     * `/usr/share/gir-1.0` and `/usr/local/share/gir-1.0`
+     * `/usr/share/gir-1.0` and `/usr/local/share/gir-1.0`, as well as
+     * additional directories in `custom_gir_dirs`.
+     *
+     * @param vala_packages     set of VAPIs to find matching GIRs for
+     * @param custom_gir_dirs   set of directories to search for additional GIRs in
      */
-    public GirDocumentation (Gee.Collection<Vala.SourceFile> packages) {
+    public GirDocumentation (Gee.Collection<Vala.SourceFile> vala_packages,
+                             Gee.Collection<File> custom_gir_dirs) {
         context = new Vala.CodeContext ();
         context.report = new Sink ();
         Vala.CodeContext.push (context);
@@ -61,41 +67,23 @@ class Vls.GirDocumentation {
         context.add_define ("GOBJECT");
 #endif
 
+        // add additional dirs
+        string[] gir_directories = context.gir_directories;
+        foreach (var additional_gir_dir in custom_gir_dirs)
+            gir_directories += additional_gir_dir.get_path ();
+        context.gir_directories = gir_directories;
+
         // add packages
         add_gir ("GLib-2.0", "glib-2.0");
         add_gir ("GObject-2.0", "gobject-2.0");
 
-        foreach (string data_dir in Environment.get_system_data_dirs ()) {
-            File dir = File.new_for_path (Path.build_filename (data_dir, "gir-1.0"));
-            if (!dir.query_exists ())
-                continue;
-            try {
-                var enumerator = dir.enumerate_children (
-                    "standard::*",
-                    FileQueryInfoFlags.NONE);
-                FileInfo? file_info;
-                while ((file_info = enumerator.next_file ()) != null) {
-                    if ((file_info.get_file_type () != FileType.REGULAR &&
-                        file_info.get_file_type () != FileType.SYMBOLIC_LINK) ||
-                        file_info.get_is_backup () || file_info.get_is_hidden () ||
-                        !file_info.get_name ().has_suffix (".gir"))
-                        continue;
-                    string gir_pkg = Path.get_basename (file_info.get_name ());
-                    gir_pkg = gir_pkg.substring (0, gir_pkg.length - ".gir".length);
-                    Vala.SourceFile? vapi_pkg_match = packages.first_match (
-                        pkg => pkg.gir_version != null && @"$(pkg.gir_namespace)-$(pkg.gir_version)" == gir_pkg);
-                    if (!added.has_key (gir_pkg) && vapi_pkg_match != null) {
-                        debug (@"adding GIR $gir_pkg for package $(vapi_pkg_match.package_name)");
-                        add_gir (gir_pkg, vapi_pkg_match.package_name);
-                    }
-                }
-            } catch (Error e) {
-                debug (@"could not enumerate $(dir.get_uri ()): $(e.message)");
-            }
+        foreach (var vapi_pkg in vala_packages) {
+            if (vapi_pkg.gir_namespace != null && vapi_pkg.gir_version != null)
+                add_gir (@"$(vapi_pkg.gir_namespace)-$(vapi_pkg.gir_version)", vapi_pkg.package_name);
         }
 
         string missed = "";
-        packages.filter (pkg => !added.keys.any_match (pkg_name => pkg.gir_version != null && pkg_name == @"$(pkg.gir_namespace)-$(pkg.gir_version)"))
+        vala_packages.filter (pkg => !added.keys.any_match (pkg_name => pkg.gir_version != null && pkg_name == @"$(pkg.gir_namespace)-$(pkg.gir_version)"))
             .foreach (vapi_pkg => {
                 if (missed.length > 0)
                     missed += ", ";

src/meson.build

@@ -10,6 +10,7 @@ vls_src = files([
   'codehelp/symbolvisitor.vala',
   'documentation/cnamemapper.vala',
   'documentation/doccomment.vala',
+  'documentation/girdocumentation.vala',
   'projects/buildtarget.vala',
   'projects/buildtask.vala',
   'projects/ccproject.vala',
@@ -25,11 +26,6 @@ vls_src = files([
   'servertypes.vala',
 ])
 
-if get_option('parse_system_girs')
-  vls_src += 'documentation/girdocumentation.vala'
-  add_project_arguments(['--define=PARSE_SYSTEM_GIRS'], language: 'vala')
-endif
-
 if get_option('active_parameter')
   add_project_arguments(['--define=VALA_FEATURE_INITIAL_ARGUMENT_COUNT'], language: 'vala')
 endif

src/projects/project.vala

@@ -337,7 +337,6 @@ abstract class Vls.Project : Object {
         return modified;
     }
 
-#if PARSE_SYSTEM_GIRS
     /**
      * Get all unique packages used in this project
      */
@@ -353,7 +352,24 @@ abstract class Vls.Project : Object {
         }
         return results;
     }
-#endif
+    
+    /**
+     * Gets a list of all directories containing GIRs that are generated by a
+     * target.
+     */
+    public Collection<File> get_custom_gir_dirs () {
+        var results = new HashSet<File> (Util.file_hash, Util.file_equal);
+        foreach (var btarget in build_targets) {
+            foreach (var output_file in btarget.output) {
+                if (output_file.get_path ().has_suffix (".gir")) {
+                    var parent = output_file.get_parent ();
+                    if (parent != null)
+                        results.add (parent);
+                }
+            }
+        }
+        return results;
+    }
 
     /**
      * Get all source files used in this project.

src/server.vala

@@ -34,12 +34,11 @@ class Vls.Server : Object {
     const int64 update_context_delay_max_us = 1000 * 1000;
     const uint wait_for_context_update_delay_ms = 200;
 
-#if PARSE_SYSTEM_GIRS
     /**
      * Contains documentation from found GIR files.
      */
     GirDocumentation documentation;
-#endif
+
     HashSet<Request> pending_requests;
 
     bool shutting_down = false;
@@ -329,13 +328,14 @@ class Vls.Server : Object {
             }
         }
 
-#if PARSE_SYSTEM_GIRS
         // create documentation (compiles GIR files too)
         var packages = new HashSet<Vala.SourceFile> ();
-        foreach (var project in new_projects)
+        var custom_gir_dirs = new HashSet<File> (Util.file_hash, Util.file_equal);
+        foreach (var project in new_projects) {
             packages.add_all (project.get_packages ());
-        documentation = new GirDocumentation (packages);
-#endif
+            custom_gir_dirs.add_all (project.get_custom_gir_dirs ());
+        }
+        documentation = new GirDocumentation (packages, custom_gir_dirs);
 
         // build and publish diagnostics
         foreach (var project in new_projects) {
@@ -1004,21 +1004,17 @@ class Vls.Server : Object {
 
         Vala.Comment? comment = null;
         DocComment? doc_comment = null;
-#if PARSE_SYSTEM_GIRS
         var gir_sym = documentation.find_gir_symbol (sym);
         if (gir_sym != null && gir_sym.comment != null)
             comment = gir_sym.comment;
         else
-#endif
             comment = sym.comment;
 
         if (comment != null) {
             try {
-#if PARSE_SYSTEM_GIRS
                 if (comment is Vala.GirComment || gir_sym != null && gir_sym.comment == comment)
                     doc_comment = new DocComment.from_gir_comment (comment, documentation, compilation);
                 else
-#endif
                     doc_comment = new DocComment.from_valadoc_comment (comment, sym, compilation);
             } catch (RegexError e) {
                 warning ("failed to render comment - %s", e.message);