docs/_scripts/filter_c.py

   1 #!/usr/bin/env python3
   2 # Copyright (c) 2016 Comcast Cable Communications Management, LLC.
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at:
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 # Filter for .c files to make various preprocessor tricks Doxygenish
  17
  18 import os, sys, re
  19
  20 if len(sys.argv) < 2:
  21     sys.stderr.write("Usage: %s <filename>\n" % (sys.argv[0]))
  22     sys.exit(1)
  23
  24 replace_patterns = [
  25     # Search for VLIB_CLI_COMMAND, extract its parameters and add a docblock for it
  26     (
  27         re.compile("(?P<m>VLIB_CLI_COMMAND)\s*[(](?P<name>[a-zA-Z0-9_]+)[)]"),
  28         r"/** @brief (@em constructor) \g<m> (\g<name>) */ vlib_cli_command_t \g<name>",
  29     ),
  30     (
  31         re.compile(
  32             "(?P<m>VLIB_CLI_COMMAND)\s*[(](?P<name>[a-zA-Z0-9_]+),\s*(?P<qual>[^)]*)[)]"
  33         ),
  34         r"/** @brief (@em constructor) \g<m> (\g<name>) */ \g<qual> vlib_cli_command_t \g<name>",
  35     ),
  36     # Search for VLIB_REGISTER_NODE, extract its parameters and add a docblock for it
  37     (
  38         re.compile("(?P<m>VLIB_REGISTER_NODE)\s*[(](?P<name>[a-zA-Z0-9_]+)[)]"),
  39         r"/** @brief (@em constructor) \g<m> (\g<name>) */ vlib_node_registration_t \g<name>",
  40     ),
  41     (
  42         re.compile(
  43             "(?P<m>VLIB_REGISTER_NODE)\s*[(](?P<name>[a-zA-Z0-9_]+),\s*(?P<qual>[^)]*)[)]"
  44         ),
  45         r"/** @brief (@em constructor) \g<m> (\g<name>) */ \g<qual> vlib_node_registration_t \g<name>",
  46     ),
  47     # Search for VLIB_INIT_FUNCTION, extract its parameter and add a docblock for it
  48     (
  49         re.compile("(?P<m>VLIB_INIT_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+)[)]"),
  50         r"/** @brief (@em constructor) \g<m> (@ref \g<name>) */ vlib_init_function_t * _vlib_init_function_\g<name>",
  51     ),
  52     (
  53         re.compile("(?P<m>VLIB_DECLARE_INIT_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+)[)]"),
  54         r"/** @brief (@em constructor) \g<m> (@ref \g<name>) */ vlib_init_function_t * _vlib_init_function_\g<name>",
  55     ),
  56     # Search for VLIB_LOOP_ENTER_FUNCTION, extract the parameters and add a docblock for it
  57     (
  58         re.compile(
  59             "(?P<m>VLIB_MAIN_LOOP_ENTER_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+)(,[^)]*)?[)]"
  60         ),
  61         r"/** @brief (@em constructor) \g<m> (@ref \g<name>) */ _vlib_main_loop_enter_\g<name>",
  62     ),
  63     (
  64         re.compile(
  65             "(?P<m>VLIB_MAIN_LOOP_EXIT_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+)(,[^)]*)?[)]"
  66         ),
  67         r"/** @brief (@em constructor) \g<m> (@ref \g<name>) */ _vlib_main_loop_exit_\g<name>",
  68     ),
  69     # Search for VLIB_CONFIG_FUNCTION, extract the parameters and add a docblock for it
  70     (
  71         re.compile(
  72             '(?P<m>VLIB_CONFIG_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+),\s*(?P<n>"[^"]+")(,[^)]*)?[)]'
  73         ),
  74         r"/** @brief (@em constructor) \g<m> (\g<name>, \g<n>) */ vlib_config_function_runtime_t _vlib_config_function_\g<name>",
  75     ),
  76     (
  77         re.compile(
  78             '(?P<m>VLIB_EARLY_CONFIG_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+),\s*(?P<n>"[^"]+")(,[^)]*)?[)]'
  79         ),
  80         r"/** @brief (@em constructor) \g<m> (\g<name>, \g<n>) */ vlib_config_function_runtime_t _vlib_config_function_\g<name>",
  81     ),
  82     # Search for "format_thing" and "unformat_thing" when used as a function pointer and add parens
  83     (
  84         re.compile(
  85             "(?P<pre>(^|,)\s*)(?P<name>(un)?format_[a-zA-Z0-9_]+)(?P<post>\s*(,|$))"
  86         ),
  87         r"\g<pre>\g<name>()\g<post>",
  88     ),
  89     # Search for CLIB_PAD_FROM_TO(...); and replace with padding
  90     # #define CLIB_PAD_FROM_TO(from,to) u8 pad_##from[(to) - (from)]
  91     (
  92         re.compile("(?P<m>CLIB_PAD_FROM_TO)\s*[(](?P<from>[^,]+),\s*(?P<to>[^)]+)[)]"),
  93         r"/** Padding. */ u8 pad_\g<from>[(\g<to>) - (\g<from>)]",
  94     ),
  95 ]
  96
  97
  98 filename = sys.argv[1]
  99 cwd = os.getcwd()
 100 if filename[0 : len(cwd)] == cwd:
 101     filename = filename[len(cwd) :]
 102     if filename[0] == "/":
 103         filename = filename[1:]
 104
 105 with open(filename) as fd:
 106     line_num = 0
 107
 108     for line in fd:
 109         line_num += 1
 110         str = line[:-1]  # filter \n
 111
 112         # Look for search/replace patterns
 113         for p in replace_patterns:
 114             str = p[0].sub(p[1], str)
 115
 116         sys.stdout.write(str + "\n")
 117
 118 # All done