Patrick Williams | f79f358 | 2016-10-09 16:12:26 -0500 | [diff] [blame] | 1 | from .namedelement import NamedElement |
Patrick Williams | 52dd41e | 2016-10-14 18:41:27 -0500 | [diff] [blame] | 2 | from .renderer import Renderer |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 3 | import yaml |
Patrick Williams | f79f358 | 2016-10-09 16:12:26 -0500 | [diff] [blame] | 4 | |
Patrick Williams | f5c3cde | 2016-10-21 11:49:01 -0500 | [diff] [blame] | 5 | |
Patrick Williams | 52dd41e | 2016-10-14 18:41:27 -0500 | [diff] [blame] | 6 | class Property(NamedElement, Renderer): |
Patrick Williams | 7eb0d25 | 2020-03-13 14:33:34 -0500 | [diff] [blame] | 7 | |
| 8 | LOCAL_ENUM_MAGIC = "<LOCAL_ENUM>" |
| 9 | NONLOCAL_ENUM_MAGIC = "<NONLOCAL_ENUM>" |
| 10 | |
Patrick Williams | f79f358 | 2016-10-09 16:12:26 -0500 | [diff] [blame] | 11 | def __init__(self, **kwargs): |
Patrick Williams | 18b29ba | 2020-01-24 16:09:06 -0600 | [diff] [blame] | 12 | self.enum = False |
Patrick Williams | f79f358 | 2016-10-09 16:12:26 -0500 | [diff] [blame] | 13 | self.typeName = kwargs.pop('type', None) |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 14 | self.cppTypeName = self.parse_cpp_type(self.typeName) |
Patrick Williams | f79f358 | 2016-10-09 16:12:26 -0500 | [diff] [blame] | 15 | self.defaultValue = kwargs.pop('default', None) |
Adriana Kobylak | 69425eb | 2018-08-17 13:55:19 -0500 | [diff] [blame] | 16 | self.flags = kwargs.pop('flags', []) |
Waqar Hameed | 20255a5 | 2020-06-04 12:38:48 +0200 | [diff] [blame] | 17 | self.cpp_flags = self.or_cpp_flags(self.flags) |
Adriana Kobylak | 75a2e25 | 2018-06-06 10:49:24 -0500 | [diff] [blame] | 18 | self.errors = kwargs.pop('errors', []) |
Patrick Williams | f79f358 | 2016-10-09 16:12:26 -0500 | [diff] [blame] | 19 | |
Matthew Barth | f0dd3b5 | 2019-02-07 11:08:15 -0600 | [diff] [blame] | 20 | if (self.defaultValue is not None): |
| 21 | if (isinstance(self.defaultValue, bool)): |
| 22 | # Convert True/False to 'true'/'false' |
| 23 | # because it will be rendered as C++ code |
| 24 | self.defaultValue = 'true' if self.defaultValue else 'false' |
| 25 | elif(isinstance(self.defaultValue, str) and |
| 26 | self.typeName.lower() == "string"): |
| 27 | # Wrap string type default values with double-quotes |
| 28 | self.defaultValue = "\"" + self.defaultValue + "\"" |
Lei YU | 4d74189 | 2019-01-14 09:59:10 +0800 | [diff] [blame] | 29 | |
Patrick Williams | f79f358 | 2016-10-09 16:12:26 -0500 | [diff] [blame] | 30 | super(Property, self).__init__(**kwargs) |
Patrick Williams | 62c3f27 | 2016-10-09 16:21:34 -0500 | [diff] [blame] | 31 | |
Patrick Williams | 2adcefa | 2016-11-16 08:23:12 -0600 | [diff] [blame] | 32 | def is_enum(self): |
Patrick Williams | 18b29ba | 2020-01-24 16:09:06 -0600 | [diff] [blame] | 33 | return self.enum |
Patrick Williams | 2adcefa | 2016-11-16 08:23:12 -0600 | [diff] [blame] | 34 | |
Patrick Williams | 0aa0dde | 2016-11-16 08:14:33 -0600 | [diff] [blame] | 35 | """ Return a conversion of the cppTypeName valid as a function parameter. |
| 36 | Currently only 'enum' requires conversion. |
| 37 | """ |
Patrick Williams | f7e2159 | 2020-01-24 15:43:08 -0600 | [diff] [blame] | 38 | def cppTypeParam(self, interface, full=False, server=True): |
Patrick Williams | 7eb0d25 | 2020-03-13 14:33:34 -0500 | [diff] [blame] | 39 | |
| 40 | ns_type = "server" if server else "client" |
| 41 | |
| 42 | iface = interface.split(".") |
| 43 | iface.insert(-1, ns_type) |
| 44 | iface = "::".join(iface) |
| 45 | |
Patrick Williams | a163b17 | 2020-01-24 16:34:02 -0600 | [diff] [blame] | 46 | r = self.cppTypeName |
Patrick Williams | 0aa0dde | 2016-11-16 08:14:33 -0600 | [diff] [blame] | 47 | |
Patrick Williams | 7eb0d25 | 2020-03-13 14:33:34 -0500 | [diff] [blame] | 48 | # Fix up local enum placeholders. |
| 49 | if full: |
| 50 | r = r.replace(self.LOCAL_ENUM_MAGIC, iface) |
| 51 | else: |
| 52 | r = r.replace(self.LOCAL_ENUM_MAGIC + "::", "") |
| 53 | |
| 54 | # Fix up non-local enum placeholders. |
| 55 | r = r.replace(self.NONLOCAL_ENUM_MAGIC, ns_type) |
Patrick Williams | a163b17 | 2020-01-24 16:34:02 -0600 | [diff] [blame] | 56 | |
| 57 | return r |
Patrick Williams | 0aa0dde | 2016-11-16 08:14:33 -0600 | [diff] [blame] | 58 | |
Patrick Williams | 0ad505c | 2016-11-16 16:17:02 -0600 | [diff] [blame] | 59 | def enum_namespace(self, interface): |
| 60 | if not self.is_enum(): |
| 61 | return "" |
| 62 | l = self.cppTypeParam(interface).split("::")[0:-1] |
| 63 | if len(l) != 0: |
| 64 | return "::".join(l) + "::" |
| 65 | return "" |
| 66 | |
| 67 | def enum_name(self, interface): |
| 68 | if not self.is_enum(): |
| 69 | return "" |
| 70 | return self.cppTypeParam(interface).split("::")[-1] |
| 71 | |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 72 | def parse_cpp_type(self, typeName): |
| 73 | if not typeName: |
| 74 | return None |
| 75 | |
| 76 | """ typeNames are _almost_ valid YAML. Insert a , before each [ |
| 77 | and then wrap it in a [ ] and it becomes valid YAML. (assuming |
| 78 | the user gave us a valid typename) |
| 79 | """ |
Christian Andersen | e416398 | 2016-12-09 11:24:03 +0100 | [diff] [blame] | 80 | typeArray = yaml.safe_load("[" + ",[".join(typeName.split("[")) + "]") |
| 81 | typeTuple = self.__preprocess_yaml_type_array(typeArray).pop(0) |
Patrick Williams | 18b29ba | 2020-01-24 16:09:06 -0600 | [diff] [blame] | 82 | return self.__parse_cpp_type__(typeTuple, top_type=True) |
Christian Andersen | e416398 | 2016-12-09 11:24:03 +0100 | [diff] [blame] | 83 | |
| 84 | """ Take a list of dbus types from YAML and convert it to a recursive data |
| 85 | structure. Each entry of the original list gets converted into a tuple |
| 86 | consisting of the type name and a list with the params for this type, |
| 87 | e.g. |
| 88 | ['dict', ['string', 'dict', ['string', 'int64']]] |
| 89 | is converted to |
Patrick Williams | 3f67eed | 2016-12-12 12:22:03 -0600 | [diff] [blame] | 90 | [('dict', [('string', []), ('dict', [('string', []), |
| 91 | ('int64', [])]]] |
Christian Andersen | e416398 | 2016-12-09 11:24:03 +0100 | [diff] [blame] | 92 | """ |
| 93 | def __preprocess_yaml_type_array(self, typeArray): |
| 94 | result = [] |
| 95 | |
| 96 | for i in range(len(typeArray)): |
| 97 | # Ignore lists because we merge them with the previous element |
| 98 | if type(typeArray[i]) is list: |
| 99 | continue |
| 100 | |
Patrick Williams | 3f67eed | 2016-12-12 12:22:03 -0600 | [diff] [blame] | 101 | # If there is a next element and it is a list, merge it with the |
| 102 | # current element. |
Christian Andersen | e416398 | 2016-12-09 11:24:03 +0100 | [diff] [blame] | 103 | if i < len(typeArray)-1 and type(typeArray[i+1]) is list: |
Patrick Williams | 3f67eed | 2016-12-12 12:22:03 -0600 | [diff] [blame] | 104 | result.append( |
| 105 | (typeArray[i], |
| 106 | self.__preprocess_yaml_type_array(typeArray[i+1]))) |
Christian Andersen | e416398 | 2016-12-09 11:24:03 +0100 | [diff] [blame] | 107 | else: |
| 108 | result.append((typeArray[i], [])) |
| 109 | |
| 110 | return result |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 111 | |
| 112 | """ Take a list of dbus types and perform validity checking, such as: |
| 113 | [ variant [ dict [ int32, int32 ], double ] ] |
| 114 | This function then converts the type-list into a C++ type string. |
| 115 | """ |
Patrick Williams | 18b29ba | 2020-01-24 16:09:06 -0600 | [diff] [blame] | 116 | def __parse_cpp_type__(self, typeTuple, top_type=False): |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 117 | propertyMap = { |
| 118 | 'byte': {'cppName': 'uint8_t', 'params': 0}, |
| 119 | 'boolean': {'cppName': 'bool', 'params': 0}, |
| 120 | 'int16': {'cppName': 'int16_t', 'params': 0}, |
| 121 | 'uint16': {'cppName': 'uint16_t', 'params': 0}, |
| 122 | 'int32': {'cppName': 'int32_t', 'params': 0}, |
| 123 | 'uint32': {'cppName': 'uint32_t', 'params': 0}, |
| 124 | 'int64': {'cppName': 'int64_t', 'params': 0}, |
| 125 | 'uint64': {'cppName': 'uint64_t', 'params': 0}, |
| 126 | 'double': {'cppName': 'double', 'params': 0}, |
Waqar Hameed | 596a223 | 2018-10-05 15:42:20 +0200 | [diff] [blame] | 127 | 'unixfd': {'cppName': 'sdbusplus::message::unix_fd', 'params': 0}, |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 128 | 'string': {'cppName': 'std::string', 'params': 0}, |
Patrick Williams | 8a30a8f | 2017-01-06 16:29:05 -0600 | [diff] [blame] | 129 | 'path': {'cppName': 'sdbusplus::message::object_path', |
| 130 | 'params': 0}, |
| 131 | 'signature': {'cppName': 'sdbusplus::message::signature', |
| 132 | 'params': 0}, |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 133 | 'array': {'cppName': 'std::vector', 'params': 1}, |
Patrick Williams | b98bdc6 | 2020-06-16 16:15:40 -0500 | [diff] [blame] | 134 | 'set': {'cppName': 'std::set', 'params': 1}, |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 135 | 'struct': {'cppName': 'std::tuple', 'params': -1}, |
William A. Kennington III | 4274c11 | 2018-11-26 09:50:13 -0800 | [diff] [blame] | 136 | 'variant': {'cppName': 'std::variant', 'params': -1}, |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 137 | 'dict': {'cppName': 'std::map', 'params': 2}, |
Patrick Williams | 18b29ba | 2020-01-24 16:09:06 -0600 | [diff] [blame] | 138 | 'enum': {'cppName': 'enum', 'params': 1}} |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 139 | |
Christian Andersen | e416398 | 2016-12-09 11:24:03 +0100 | [diff] [blame] | 140 | if len(typeTuple) != 2: |
| 141 | raise RuntimeError("Invalid typeTuple %s" % typeTuple) |
| 142 | |
| 143 | first = typeTuple[0] |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 144 | entry = propertyMap[first] |
| 145 | |
| 146 | result = entry['cppName'] |
| 147 | |
| 148 | # Handle 0-entry parameter lists. |
| 149 | if (entry['params'] == 0): |
Christian Andersen | e416398 | 2016-12-09 11:24:03 +0100 | [diff] [blame] | 150 | if (len(typeTuple[1]) != 0): |
| 151 | raise RuntimeError("Invalid typeTuple %s" % typeTuple) |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 152 | else: |
| 153 | return result |
| 154 | |
Christian Andersen | e416398 | 2016-12-09 11:24:03 +0100 | [diff] [blame] | 155 | # Get the parameter list |
| 156 | rest = typeTuple[1] |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 157 | |
| 158 | # Confirm parameter count matches. |
| 159 | if (entry['params'] != -1) and (entry['params'] != len(rest)): |
| 160 | raise RuntimeError("Invalid entry count for %s : %s" % |
| 161 | (first, rest)) |
| 162 | |
Patrick Williams | 18b29ba | 2020-01-24 16:09:06 -0600 | [diff] [blame] | 163 | # Switch enum for proper type. |
| 164 | if result == 'enum': |
| 165 | if top_type: |
| 166 | self.enum = True |
Patrick Williams | a163b17 | 2020-01-24 16:34:02 -0600 | [diff] [blame] | 167 | result = rest[0][0] |
| 168 | |
| 169 | # self. means local type. |
| 170 | if result.startswith("self."): |
Patrick Williams | 7eb0d25 | 2020-03-13 14:33:34 -0500 | [diff] [blame] | 171 | return result.replace("self.", self.LOCAL_ENUM_MAGIC + "::") |
| 172 | |
| 173 | # Insert place-holder for header-type namespace (ex. "server") |
| 174 | result = result.split('.') |
| 175 | result.insert(-2, self.NONLOCAL_ENUM_MAGIC) |
| 176 | result = "::".join(result) |
Patrick Williams | a163b17 | 2020-01-24 16:34:02 -0600 | [diff] [blame] | 177 | return result |
Patrick Williams | 18b29ba | 2020-01-24 16:09:06 -0600 | [diff] [blame] | 178 | |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 179 | # Parse each parameter entry, if appropriate, and create C++ template |
| 180 | # syntax. |
| 181 | result += '<' |
Waqar Hameed | 67c79b0 | 2020-02-19 23:25:14 +0100 | [diff] [blame] | 182 | result += ", ".join([self.__parse_cpp_type__(e) for e in rest]) |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 183 | result += '>' |
| 184 | |
| 185 | return result |
| 186 | |
Patrick Williams | 62c3f27 | 2016-10-09 16:21:34 -0500 | [diff] [blame] | 187 | def markdown(self, loader): |
Patrick Williams | 5621624 | 2020-05-21 15:33:50 -0500 | [diff] [blame] | 188 | return self.render(loader, "property.md.mako", property=self, |
Patrick Williams | f5c3cde | 2016-10-21 11:49:01 -0500 | [diff] [blame] | 189 | post=str.strip) |
Adriana Kobylak | ee6ac69 | 2018-06-06 09:36:51 -0500 | [diff] [blame] | 190 | |
| 191 | def cpp_prototype(self, loader, interface, ptype): |
Patrick Williams | 5621624 | 2020-05-21 15:33:50 -0500 | [diff] [blame] | 192 | return self.render(loader, "property.prototype.hpp.mako", property=self, |
Adriana Kobylak | ee6ac69 | 2018-06-06 09:36:51 -0500 | [diff] [blame] | 193 | interface=interface, ptype=ptype, post=str.rstrip) |
Waqar Hameed | 20255a5 | 2020-06-04 12:38:48 +0200 | [diff] [blame] | 194 | |
| 195 | def or_cpp_flags(self, flags): |
| 196 | """Return the corresponding ORed cpp flags.""" |
| 197 | flags_dict = { |
Waqar Hameed | 20255a5 | 2020-06-04 12:38:48 +0200 | [diff] [blame] | 198 | "const": "vtable::property_::const_", |
Patrick Williams | e1c73d3 | 2020-07-10 16:02:27 -0500 | [diff] [blame^] | 199 | "deprecated": "vtable::common_::deprecated", |
Waqar Hameed | 20255a5 | 2020-06-04 12:38:48 +0200 | [diff] [blame] | 200 | "emits_change": "vtable::property_::emits_change", |
| 201 | "emits_invalidation": "vtable::property_::emits_invalidation", |
Patrick Williams | e1c73d3 | 2020-07-10 16:02:27 -0500 | [diff] [blame^] | 202 | "explicit": "vtable::property_::explicit_", |
| 203 | "hidden": "vtable::common_::hidden", |
| 204 | "readonly": False, |
| 205 | "unprivileged": "vtable::common_::unprivileged", |
| 206 | } |
Waqar Hameed | 20255a5 | 2020-06-04 12:38:48 +0200 | [diff] [blame] | 207 | |
| 208 | cpp_flags = [] |
| 209 | for flag in flags: |
| 210 | try: |
Patrick Williams | e1c73d3 | 2020-07-10 16:02:27 -0500 | [diff] [blame^] | 211 | if flags_dict[flag]: |
| 212 | cpp_flags.append(flags_dict[flag]) |
Waqar Hameed | 20255a5 | 2020-06-04 12:38:48 +0200 | [diff] [blame] | 213 | except KeyError: |
| 214 | raise ValueError("Invalid flag \"{}\"".format(flag)) |
| 215 | |
| 216 | return " | ".join(cpp_flags) |