summaryrefslogtreecommitdiffstats
path: root/docs/includes_renderer.py
diff options
context:
space:
mode:
authorPaul Vinciguerra <pvinci@vinciconsulting.com>2020-03-24 16:37:40 -0400
committerDave Wallace <dwallacelf@gmail.com>2020-12-21 23:23:33 +0000
commitf097300c2bd980abdc485e008628aec987340990 (patch)
tree5c4890704ac0b0b6ba10ec25d43d1692a9e5ad71 /docs/includes_renderer.py
parentda45810ce92dd69dfaf0ac933fb6ed81cf2ed86c (diff)
docs: update list of plugins
The list of plugins is outdated. This change introduces a dynamically generated list of the plugins along with their descriptions, extracted directly from the sources. Type: docs Change-Id: Icb7b65e6b45289e257d71a1c18d10f62ced59cbe Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com> (cherry picked from commit 630ca994e0ff210a3de80d73bb395c931d2fd83f)
Diffstat (limited to 'docs/includes_renderer.py')
-rw-r--r--docs/includes_renderer.py77
1 files changed, 77 insertions, 0 deletions
diff --git a/docs/includes_renderer.py b/docs/includes_renderer.py
new file mode 100644
index 00000000000..d36752dd882
--- /dev/null
+++ b/docs/includes_renderer.py
@@ -0,0 +1,77 @@
+#!/usr/bin/env python3
+# Copyright (c) 2020. Vinci Consulting Corp. All Rights Reserved.
+#
+# 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 glob
+import inspect
+import os.path
+import re
+
+
+class ContentRenderer:
+ name = ""
+ curr_path = os.path.abspath(inspect.getsourcefile(lambda: 0))
+ vpp_root = curr_path.rsplit("/", 2)[0]
+ output_dir = f"{vpp_root}/docs/dynamic_includes/"
+
+ def render(self):
+ raise NotImplementedError
+
+
+class PluginRenderer(ContentRenderer):
+ name = "plugin_list.inc"
+
+ plugin_dir = f"{ContentRenderer.vpp_root}/src/plugins"
+
+ pattern = r'VLIB_PLUGIN_REGISTER\s?\(\)\s*=\s*{.*\.description\s?=\s?"([^"]*)".*};' # noqa: 501
+ regex = re.compile(pattern, re.MULTILINE | re.DOTALL)
+
+ def render(self):
+ with open(f"{self.__class__.output_dir}{self.__class__.name}",
+ "w") as output:
+ with os.scandir(self.__class__.plugin_dir) as pdir:
+ for entry in sorted(pdir, key=lambda entry: entry.name):
+ if not entry.name.startswith('.') and entry.is_dir():
+ description = "<no-description-found>"
+ # we use glob because a plugin can (ioam for now)
+ # define the plugin definition in
+ # a further subdirectory.
+ for f in glob.iglob(f'{self.__class__.plugin_dir}/'
+ f'{entry.name}/**',
+ recursive=True):
+ if f.endswith('.c'):
+ with open(f, "r", encoding="utf-8") \
+ as src:
+ for match in self.__class__.regex.finditer(
+ src.read()):
+ description = "%s" % (match.group(1))
+
+ output.write(f"* {entry.name} - {description}\n")
+
+
+# if this list grows substantially, we can move the classes to
+# a folder and import them.
+renderers = [PluginRenderer,
+ ]
+
+
+def main():
+ print("rendering dynamic includes...")
+ for renderer in renderers:
+ renderer().render()
+ print("done.")
+
+
+if __name__ == "__main__":
+ main()