From: Luca Fancellu <luca.fancellu@arm.com>
To: xen-devel@lists.xenproject.org
Cc: bertrand.marquis@arm.com, wei.chen@arm.com,
Andrew Cooper <andrew.cooper3@citrix.com>,
George Dunlap <george.dunlap@citrix.com>,
Ian Jackson <iwj@xenproject.org>, Jan Beulich <jbeulich@suse.com>,
Julien Grall <julien@xen.org>,
Stefano Stabellini <sstabellini@kernel.org>, Wei Liu <wl@xen.org>
Subject: [PATCH v6 6/9] docs: add doxygen preprocessor and related files
Date: Mon, 10 May 2021 09:41:02 +0100 [thread overview]
Message-ID: <20210510084105.17108-7-luca.fancellu@arm.com> (raw)
In-Reply-To: <20210510084105.17108-1-luca.fancellu@arm.com>
Add preprocessor called by doxygen before parsing headers,
it will include in every header a doxygen_include.h file
that provides missing defines and includes that are
usually passed by the compiler.
Add doxy_input.list that is a text file containing the
relative path to the source code file to be parsed by
doxygen. The path sould be relative to the xen folder:
E.g. xen/include/public/grant_table.h
Signed-off-by: Luca Fancellu <luca.fancellu@arm.com>
---
docs/xen-doxygen/doxy-preprocessor.py | 110 ++++++++++++++++++++++++++
docs/xen-doxygen/doxy_input.list | 0
docs/xen-doxygen/doxygen_include.h.in | 32 ++++++++
3 files changed, 142 insertions(+)
create mode 100755 docs/xen-doxygen/doxy-preprocessor.py
create mode 100644 docs/xen-doxygen/doxy_input.list
create mode 100644 docs/xen-doxygen/doxygen_include.h.in
diff --git a/docs/xen-doxygen/doxy-preprocessor.py b/docs/xen-doxygen/doxy-preprocessor.py
new file mode 100755
index 0000000000..496899d8e6
--- /dev/null
+++ b/docs/xen-doxygen/doxy-preprocessor.py
@@ -0,0 +1,110 @@
+#!/usr/bin/python3
+#
+# Copyright (c) 2021, Arm Limited.
+#
+# SPDX-License-Identifier: GPL-2.0
+#
+
+import os, sys, re
+
+
+# Variables that holds the preprocessed header text
+output_text = ""
+header_file_name = ""
+
+# Variables to enumerate the anonymous structs/unions
+anonymous_struct_count = 0
+anonymous_union_count = 0
+
+
+def error(text):
+ sys.stderr.write("{}\n".format(text))
+ sys.exit(1)
+
+
+def write_to_output(text):
+ sys.stdout.write(text)
+
+
+def insert_doxygen_header(text):
+ # Here the strategy is to insert the #include <doxygen_include.h> in the
+ # first line of the header
+ abspath = os.path.dirname(os.path.abspath(__file__))
+ text += "#include \"{}/doxygen_include.h\"\n".format(abspath)
+
+ return text
+
+
+def enumerate_anonymous(match):
+ global anonymous_struct_count
+ global anonymous_union_count
+
+ if "struct" in match.group(1):
+ label = "anonymous_struct_%d" % anonymous_struct_count
+ anonymous_struct_count += 1
+ else:
+ label = "anonymous_union_%d" % anonymous_union_count
+ anonymous_union_count += 1
+
+ return match.group(1) + " " + label + " {"
+
+
+def manage_anonymous_structs_unions(text):
+ # Match anonymous unions/structs with this pattern:
+ # struct/union {
+ # [...]
+ #
+ # and substitute it in this way:
+ #
+ # struct anonymous_struct_# {
+ # [...]
+ # or
+ # union anonymous_union_# {
+ # [...]
+ # where # is a counter starting from zero, different between structs and
+ # unions
+ #
+ # We don't count anonymous union/struct that are part of a typedef because
+ # they don't create any issue for doxygen
+ text = re.sub(
+ "(?<!typedef\s)(struct|union)\s+?\{",
+ enumerate_anonymous,
+ text,
+ flags=re.S
+ )
+
+ return text
+
+
+def main(argv):
+ global output_text
+ global header_file_name
+
+ if len(argv) != 1:
+ error("Script called without arguments!")
+
+ header_file_name = argv[0]
+
+ # Open header file
+ input_header_file = open(header_file_name, 'r')
+ # Read all lines
+ lines = input_header_file.readlines()
+
+ # Inject config.h and some defines in the current header, during compilation
+ # this job is done by the -include argument passed to the compiler.
+ output_text = insert_doxygen_header(output_text)
+
+ # Load file content in a variable
+ for line in lines:
+ output_text += "{}".format(line)
+
+ # Try to get rid of any anonymous union/struct
+ output_text = manage_anonymous_structs_unions(output_text)
+
+ # Final stage of the preprocessor, print the output to stdout
+ write_to_output(output_text)
+
+
+if __name__ == "__main__":
+ main(sys.argv[1:])
+ sys.exit(0)
diff --git a/docs/xen-doxygen/doxy_input.list b/docs/xen-doxygen/doxy_input.list
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/docs/xen-doxygen/doxygen_include.h.in b/docs/xen-doxygen/doxygen_include.h.in
new file mode 100644
index 0000000000..df284f3931
--- /dev/null
+++ b/docs/xen-doxygen/doxygen_include.h.in
@@ -0,0 +1,32 @@
+/*
+ * Doxygen include header
+ * It supplies the xen/include/xen/config.h that is included using the -include
+ * argument of the compiler in Xen Makefile.
+ * Other macros are defined because they are usually provided by the compiler.
+ *
+ * Copyright (C) 2021 ARM Limited
+ *
+ * Author: Luca Fancellu <luca.fancellu@arm.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0
+ */
+
+#include "@XEN_BASE@/xen/include/xen/config.h"
+
+#if defined(CONFIG_X86_64)
+
+#define __x86_64__ 1
+
+#elif defined(CONFIG_ARM_64)
+
+#define __aarch64__ 1
+
+#elif defined(CONFIG_ARM_32)
+
+#define __arm__ 1
+
+#else
+
+#error Architecture not supported/recognized.
+
+#endif
--
2.17.1
next prev parent reply other threads:[~2021-05-10 8:41 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-10 8:40 [PATCH v6 0/9] Use Doxygen and sphinx for html documentation Luca Fancellu
2021-05-10 8:40 ` [PATCH v6 1/9] docs: add doxygen configuration file Luca Fancellu
2021-05-10 8:40 ` [PATCH v6 2/9] docs: add Xen png logo for the doxygen documentation Luca Fancellu
2021-05-10 8:40 ` [PATCH v6 3/9] docs: add doxygen templates Luca Fancellu
2021-05-10 8:41 ` [PATCH v6 4/9] m4/python: add function to docs_tool.m4 and new m4 module Luca Fancellu
2021-07-02 22:22 ` Stefano Stabellini
2021-05-10 8:41 ` [PATCH v6 5/9] docs: add checks to configure for sphinx and doxygen Luca Fancellu
2021-07-02 22:22 ` Stefano Stabellini
2021-05-10 8:41 ` Luca Fancellu [this message]
2021-06-23 22:03 ` [PATCH v6 6/9] docs: add doxygen preprocessor and related files Stefano Stabellini
2021-07-01 13:04 ` Luca Fancellu
2021-07-01 17:36 ` Stefano Stabellini
2021-05-10 8:41 ` [PATCH v6 7/9] docs: Change Makefile and sphinx configuration for doxygen Luca Fancellu
2021-06-23 23:33 ` Stefano Stabellini
2021-07-01 13:36 ` Luca Fancellu
2021-07-01 17:43 ` Stefano Stabellini
2021-07-02 9:30 ` Luca Fancellu
2021-07-02 22:23 ` Stefano Stabellini
2021-07-05 9:41 ` Luca Fancellu
2021-05-10 8:41 ` [PATCH v6 8/9] docs: hypercalls sphinx skeleton for generated html Luca Fancellu
2021-06-23 23:34 ` Stefano Stabellini
2021-07-01 14:06 ` Luca Fancellu
2021-07-01 17:24 ` Stefano Stabellini
2021-05-10 8:41 ` [PATCH v6 9/9] docs/doxygen: doxygen documentation for grant_table.h Luca Fancellu
2021-06-23 23:34 ` Stefano Stabellini
2021-07-01 14:19 ` Luca Fancellu
2021-07-01 17:44 ` Stefano Stabellini
2021-07-02 11:01 ` Luca Fancellu
2021-07-02 20:21 ` Stefano Stabellini
2021-06-07 16:24 ` [PATCH v6 0/9] Use Doxygen and sphinx for html documentation Luca Fancellu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210510084105.17108-7-luca.fancellu@arm.com \
--to=luca.fancellu@arm.com \
--cc=andrew.cooper3@citrix.com \
--cc=bertrand.marquis@arm.com \
--cc=george.dunlap@citrix.com \
--cc=iwj@xenproject.org \
--cc=jbeulich@suse.com \
--cc=julien@xen.org \
--cc=sstabellini@kernel.org \
--cc=wei.chen@arm.com \
--cc=wl@xen.org \
--cc=xen-devel@lists.xenproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).