Add doxygen rule [BUILD-450] (#42)

* Add doxygen rule [BUILD-450]

* Fix

* Add tag manual

* Small fix

* Fix

* Add support for plantuml

* Add .srcs and .hdrs targets and remove doxygen_output_directory

* Move doxygen rule to doxygen directory

* Fix typo

* Get visibility for .srcs and .hdrs from swift_cc_library

* Add comment

* Introduce defaults in configure_file_impl

Author: krisukox

cc/defs.bzl

@@ -89,6 +89,20 @@ def _test_compatible_with():
         "//conditions:default": [],
     })
 
+def _create_srcs(**kwargs):
+    native.filegroup(
+        name = kwargs.get("name") + ".srcs",
+        srcs = kwargs.get("srcs", []),
+        visibility = kwargs.get("visibility", ["//visibility:private"]),
+    )
+
+def _create_hdrs(**kwargs):
+    native.filegroup(
+        name = kwargs.get("name") + ".hdrs",
+        srcs = kwargs.get("hdrs", []),
+        visibility = kwargs.get("visibility", ["//visibility:private"]),
+    )
+
 def cc_stamped_library(name, out, template, hdrs, includes, defaults, visibility = None):
     """Creates a cc_library stamped with non-hermetic build metadata.
 
@@ -138,7 +152,9 @@ def swift_c_library(**kwargs):
     """Wraps cc_library to enforce standards for a production c library.
 
     Primarily this consists of a default set of compiler options and
-    language standards.
+    language standards. This rule also creates 'target_name.srcs' and
+    'target_name.hdrs' targets that contain sources and headers,
+    respectively.
 
     Production targets (swift_cc*), are compiled with the -pedantic flag.
 
@@ -159,6 +175,9 @@ def swift_c_library(**kwargs):
             nocopts: List of flags to remove from the default compile
             options. Use judiciously.
     """
+    _create_srcs(**kwargs)
+    _create_hdrs(**kwargs)
+
     local_includes = _construct_local_includes(kwargs.pop("local_includes", []))
 
     nocopts = kwargs.pop("nocopts", [])  # pop because nocopts is a deprecated cc* attr.
@@ -183,7 +202,9 @@ def swift_cc_library(**kwargs):
     """Wraps cc_library to enforce standards for a production c++ library.
 
     Primarily this consists of a default set of compiler options and
-    language standards.
+    language standards. This rule also creates 'target_name.srcs' and
+    'target_name.hdrs' targets that contain sources and headers,
+    respectively.
 
     Production targets (swift_cc*), are compiled with the -pedantic flag.
 
@@ -206,6 +227,9 @@ def swift_cc_library(**kwargs):
             nocopts: List of flags to remove from the default compile
             options. Use judiciously.
     """
+    _create_srcs(**kwargs)
+    _create_hdrs(**kwargs)
+
     local_includes = _construct_local_includes(kwargs.pop("local_includes", []))
 
     nocopts = kwargs.pop("nocopts", [])  # pop because nocopts is a deprecated cc* attr.
@@ -524,7 +548,7 @@ def swift_cc_test(name, type, **kwargs):
     """Wraps cc_test to enforce Swift testing conventions.
 
     This rule creates a test target along with a target that contains the sources
-    of the test. The name of the sources is created with the '_src' suffix.
+    of the test. The name of the sources is created with the '.srcs' suffix.
 
     Args:
         name: A unique name for this rule.
@@ -544,7 +568,7 @@ def swift_cc_test(name, type, **kwargs):
 
     _ = kwargs.pop("nocopts", [])  # To handle API compatibility.
 
-    srcs_name = name + "_srcs"
+    srcs_name = name + ".srcs"
     srcs = kwargs.get("srcs", [])
 
     native.filegroup(

doxygen/doxygen.bzl

@@ -0,0 +1,61 @@
+# Copyright (C) 2022 Swift Navigation Inc.
+# Contact: Swift Navigation <dev@swift-nav.com>
+#
+# This source is subject to the license found in the file 'LICENSE' which must
+# be be distributed together with this source. All other rights reserved.
+#
+# THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
+# EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
+
+load("//tools:configure_file.bzl", "configure_file_impl")
+
+def _swift_doxygen_impl(ctx):
+    vars = ctx.attr.vars | {}  # copy dict instead of referencing it
+    vars["DOXYGEN_SOURCE_DIRECTORIES"] = '" "'.join(ctx.attr.doxygen_source_directories)
+
+    doxygen_out = ctx.actions.declare_directory(ctx.attr.name + "_doxygen")
+    vars["DOXYGEN_OUTPUT_DIRECTORY"] = doxygen_out.path
+
+    config = configure_file_impl(ctx, vars, ctx.attr.name + "_Doxyfile")[0].files.to_list()[0]
+
+    ctx.actions.run_shell(
+        inputs = [config] + ctx.files.deps,
+        outputs = [doxygen_out],
+        command = """
+        DOXYGEN_DOT_FOUND=NO
+        DOXYGEN_DOT_PATH=
+
+        if command -v dot &> /dev/null
+        then
+            DOXYGEN_DOT_FOUND=YES
+            DOXYGEN_DOT_PATH=$(which dot)
+        fi
+
+        sed -i "s|@DOXYGEN_DOT_FOUND@|$DOXYGEN_DOT_FOUND|g" {config}
+        sed -i "s|@DOXYGEN_DOT_PATH@|$DOXYGEN_DOT_PATH|g" {config}
+        sed -i "s|@PLANTUML_JAR_PATH@|/usr/local/bin/plantuml.jar|g" {config}
+
+        doxygen {config}
+        """.format(config = config.path),
+    )
+
+    return [DefaultInfo(files = depset([doxygen_out, config]))]
+
+_swift_doxygen = rule(
+    implementation = _swift_doxygen_impl,
+    attrs = {
+        "vars": attr.string_dict(),
+        "template": attr.label(
+            allow_single_file = [".in"],
+            mandatory = True,
+        ),
+        "deps": attr.label_list(),
+        "doxygen_source_directories": attr.string_list(),
+    },
+)
+
+def swift_doxygen(**kwargs):
+    kwargs["tags"] = ["manual"] + kwargs.get("tags", [])
+
+    _swift_doxygen(**kwargs)

tools/configure_file.bzl

@@ -10,7 +10,13 @@
 
 CMAKE_FALSE_CONSTANTS = ["0", "OFF", "NO", "FALSE", "N", "IGNORE", "NOTFOUND"]
 
-def configure_file_impl(ctx, vars):
+def configure_file_impl(ctx, vars = None, out = None):
+    if vars == None:
+        vars = ctx.attr.vars
+
+    if out == None:
+        out = ctx.attr.out
+
     subs = {}
     for (key, val) in vars.items():
         cmake_define_nl = "#cmakedefine {}\n".format(key)
@@ -31,19 +37,16 @@ def configure_file_impl(ctx, vars):
         subs["@{}@".format(key)] = val
         subs["${" + key + "}"] = val
 
-    out = ctx.actions.declare_file(ctx.attr.out)
+    out = ctx.actions.declare_file(out)
     ctx.actions.expand_template(
         output = out,
         template = ctx.file.template,
         substitutions = subs,
     )
     return [DefaultInfo(files = depset([out]))]
 
-def _configure_file_impl(ctx):
-    return configure_file_impl(ctx, ctx.attr.vars)
-
 configure_file = rule(
-    implementation = _configure_file_impl,
+    implementation = configure_file_impl,
     attrs = {
         "vars": attr.string_dict(),
         "out": attr.string(),