nat: use correct data types for memory sizes
[vpp.git] / doxygen / 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     ( re.compile("(?P<m>VLIB_CLI_COMMAND)\s*[(](?P<name>[a-zA-Z0-9_]+)[)]"),
27         r"/** @brief (@em constructor) \g<m> (\g<name>) */ vlib_cli_command_t \g<name>"),
28     ( re.compile("(?P<m>VLIB_CLI_COMMAND)\s*[(](?P<name>[a-zA-Z0-9_]+),\s*(?P<qual>[^)]*)[)]"),
29         r"/** @brief (@em constructor) \g<m> (\g<name>) */ \g<qual> vlib_cli_command_t \g<name>"),
30
31     # Search for VLIB_REGISTER_NODE, extract its parameters and add a docblock for it
32     ( re.compile("(?P<m>VLIB_REGISTER_NODE)\s*[(](?P<name>[a-zA-Z0-9_]+)[)]"),
33         r"/** @brief (@em constructor) \g<m> (\g<name>) */ vlib_node_registration_t \g<name>"),
34     ( re.compile("(?P<m>VLIB_REGISTER_NODE)\s*[(](?P<name>[a-zA-Z0-9_]+),\s*(?P<qual>[^)]*)[)]"),
35         r"/** @brief (@em constructor) \g<m> (\g<name>) */ \g<qual> vlib_node_registration_t \g<name>"),
36
37     # Search for VLIB_INIT_FUNCTION, extract its parameter and add a docblock for it
38     ( re.compile("(?P<m>VLIB_INIT_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+)[)]"),
39         r"/** @brief (@em constructor) \g<m> (@ref \g<name>) */ vlib_init_function_t * _vlib_init_function_\g<name>"),
40     ( re.compile("(?P<m>VLIB_DECLARE_INIT_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+)[)]"),
41         r"/** @brief (@em constructor) \g<m> (@ref \g<name>) */ vlib_init_function_t * _vlib_init_function_\g<name>"),
42
43     # Search for VLIB_LOOP_ENTER_FUNCTION, extract the parameters and add a docblock for it
44     ( re.compile("(?P<m>VLIB_MAIN_LOOP_ENTER_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+)(,[^)]*)?[)]"),
45         r"/** @brief (@em constructor) \g<m> (@ref \g<name>) */ _vlib_main_loop_enter_\g<name>"),
46     ( re.compile("(?P<m>VLIB_MAIN_LOOP_EXIT_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+)(,[^)]*)?[)]"),
47         r"/** @brief (@em constructor) \g<m> (@ref \g<name>) */ _vlib_main_loop_exit_\g<name>"),
48
49     # Search for VLIB_CONFIG_FUNCTION, extract the parameters and add a docblock for it
50     ( re.compile("(?P<m>VLIB_CONFIG_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+),\s*(?P<n>\"[^\"]+\")(,[^)]*)?[)]"),
51         r"/** @brief (@em constructor) \g<m> (\g<name>, \g<n>) */ vlib_config_function_runtime_t _vlib_config_function_\g<name>"),
52     ( re.compile("(?P<m>VLIB_EARLY_CONFIG_FUNCTION)\s*[(](?P<name>[a-zA-Z0-9_]+),\s*(?P<n>\"[^\"]+\")(,[^)]*)?[)]"),
53         r"/** @brief (@em constructor) \g<m> (\g<name>, \g<n>) */ vlib_config_function_runtime_t _vlib_config_function_\g<name>"),
54
55     # Search for "format_thing" and "unformat_thing" when used as a function pointer and add parens
56     ( re.compile("(?P<pre>(^|,)\s*)(?P<name>(un)?format_[a-zA-Z0-9_]+)(?P<post>\s*(,|$))"),
57         r"\g<pre>\g<name>()\g<post>" ),
58
59     # Search for CLIB_PAD_FROM_TO(...); and replace with padding
60     # #define CLIB_PAD_FROM_TO(from,to) u8 pad_##from[(to) - (from)]
61     ( re.compile("(?P<m>CLIB_PAD_FROM_TO)\s*[(](?P<from>[^,]+),\s*(?P<to>[^)]+)[)]"),
62         r"/** Padding. */ u8 pad_\g<from>[(\g<to>) - (\g<from>)]" ),
63
64 ]
65
66
67 filename = sys.argv[1]
68 cwd = os.getcwd()
69 if filename[0:len(cwd)] == cwd:
70     filename = filename[len(cwd):]
71     if filename[0] == "/":
72         filename = filename[1:]
73
74 with open(filename) as fd:
75     line_num = 0
76
77     for line in fd:
78         line_num += 1
79         str = line[:-1] # filter \n
80
81         # Look for search/replace patterns
82         for p in replace_patterns:
83             str = p[0].sub(p[1], str)
84
85         sys.stdout.write(str+"\n")
86
87 # All done