1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
# Copyright 2017 Open Source Robotics Foundation, Inc.
#
# 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.
from collections import OrderedDict
severities = ('DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL')
default_args = OrderedDict((
('condition_before', 'RCUTILS_LOG_CONDITION_EMPTY'),
('condition_after', 'RCUTILS_LOG_CONDITION_EMPTY'),
# This is NULL and not an empty string to distinguish between nameless loggers and those with
# empty names.
('name', 'NULL'),
))
name_params = OrderedDict((
('name', 'The name of the logger'),
))
name_args = {'name': 'name'}
name_doc_lines = []
once_args = {
'condition_before': 'RCUTILS_LOG_CONDITION_ONCE_BEFORE',
'condition_after': 'RCUTILS_LOG_CONDITION_ONCE_AFTER'}
once_doc_lines = [
'All subsequent log calls except the first one are being ignored.']
expression_params = OrderedDict((
('expression', 'The expression determining if the message should be logged'),
))
expression_args = {
'condition_before': 'RCUTILS_LOG_CONDITION_EXPRESSION_BEFORE(expression)',
'condition_after': 'RCUTILS_LOG_CONDITION_EXPRESSION_AFTER'}
expression_doc_lines = [
'Log calls are being ignored when the expression evaluates to false.']
function_params = OrderedDict((
('function', 'The functions return value determines if the message should be logged'),
))
function_args = {
'condition_before': 'RCUTILS_LOG_CONDITION_FUNCTION_BEFORE(function)',
'condition_after': 'RCUTILS_LOG_CONDITION_FUNCTION_AFTER'}
function_doc_lines = [
'Log calls are being ignored when the function returns false.']
skipfirst_args = {
'condition_before': 'RCUTILS_LOG_CONDITION_SKIPFIRST_BEFORE',
'condition_after': 'RCUTILS_LOG_CONDITION_SKIPFIRST_AFTER'}
skipfirst_doc_lines = [
'The first log call is being ignored but all subsequent calls are being processed.']
throttle_params = OrderedDict((
('get_time_point_value', 'Function that returns rcutils_ret_t and expects a '
'rcutils_time_point_value_t pointer.'),
('duration', 'The duration of the throttle interval as an integral value in milliseconds.'),
))
throttle_args = {
'condition_before': 'RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration)',
'condition_after': 'RCUTILS_LOG_CONDITION_THROTTLE_AFTER'}
throttle_doc_lines = [
'Log calls are being ignored if the last logged message is not longer ago than the specified '
'duration.']
def get_suffix_from_features(features):
# Build up the suffix in a particular order
suffix = ''
if 'expression' in features:
suffix += '_EXPRESSION'
if 'function' in features:
suffix += '_FUNCTION'
if 'skip_first' in features:
suffix += '_SKIPFIRST'
if 'throttle' in features:
suffix += '_THROTTLE'
if 'once' in features:
suffix += '_ONCE'
if 'named' in features:
suffix += '_NAMED'
return suffix
class Feature:
__slots__ = ('params', 'args', 'doc_lines')
def __init__(self, *, params=None, args=None, doc_lines=None):
if params is None:
params = {}
self.params = params
if args is None:
args = {}
self.args = args
if doc_lines is None:
doc_lines = []
self.doc_lines = doc_lines
feature_combinations = OrderedDict((
((), Feature()),
(('named', ), Feature(
params=name_params,
args=name_args,
doc_lines=name_doc_lines)),
(('once', ), Feature(
params=None,
args=once_args,
doc_lines=once_doc_lines)),
(('once', 'named'), Feature(
params=name_params,
args={**once_args, **name_args},
doc_lines=once_doc_lines + name_doc_lines)),
(('expression', ), Feature(
params=expression_params,
args=expression_args,
doc_lines=expression_doc_lines)),
(('expression', 'named'), Feature(
params=OrderedDict((*expression_params.items(), *name_params.items())),
args={**expression_args, **name_args},
doc_lines=expression_doc_lines + name_doc_lines)),
(('function', ), Feature(
params=function_params,
args=function_args,
doc_lines=function_doc_lines)),
(('function', 'named'), Feature(
params=OrderedDict((*function_params.items(), *name_params.items())),
args={**function_args, **name_args},
doc_lines=function_doc_lines + name_doc_lines)),
(('skip_first', ), Feature(
params=None,
args=skipfirst_args,
doc_lines=skipfirst_doc_lines)),
(('skip_first', 'named'), Feature(
params=name_params,
args={**skipfirst_args, **name_args},
doc_lines=skipfirst_doc_lines + name_doc_lines)),
(('throttle', ), Feature(
params=throttle_params,
args=throttle_args,
doc_lines=throttle_doc_lines)),
(('skip_first', 'throttle'), Feature(
params=throttle_params,
args={
'condition_before': ' '.join([
throttle_args['condition_before'],
skipfirst_args['condition_before']]),
'condition_after': ' '.join([
throttle_args['condition_after'], skipfirst_args['condition_after']]),
},
doc_lines=skipfirst_doc_lines + throttle_doc_lines)),
(('throttle', 'named'), Feature(
params=OrderedDict((*throttle_params.items(), *name_params.items())),
args={**throttle_args, **name_args},
doc_lines=throttle_doc_lines + name_doc_lines)),
(('skip_first', 'throttle', 'named'), Feature(
params=OrderedDict((*throttle_params.items(), *name_params.items())),
args={
**{
'condition_before': ' '.join([
throttle_args['condition_before'],
skipfirst_args['condition_before']]),
'condition_after': ' '.join([
throttle_args['condition_after'],
skipfirst_args['condition_after']]),
}, **name_args
},
doc_lines=skipfirst_doc_lines + throttle_doc_lines + name_doc_lines)),
))
def get_macro_parameters(feature_combination):
return feature_combinations[feature_combination].params
def get_macro_arguments(feature_combination):
args = []
for k, default_value in default_args.items():
value = feature_combinations[feature_combination].args.get(k, default_value)
args.append(value)
return args
|
