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 | f79f358 | 2016-10-09 16:12:26 -0500 | [diff] [blame] | 7 | def __init__(self, **kwargs): |
| 8 | self.typeName = kwargs.pop('type', None) |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 9 | self.cppTypeName = self.parse_cpp_type(self.typeName) |
Patrick Williams | f79f358 | 2016-10-09 16:12:26 -0500 | [diff] [blame] | 10 | self.defaultValue = kwargs.pop('default', None) |
Adriana Kobylak | 69425eb | 2018-08-17 13:55:19 -0500 | [diff] [blame^] | 11 | self.flags = kwargs.pop('flags', []) |
Adriana Kobylak | 75a2e25 | 2018-06-06 10:49:24 -0500 | [diff] [blame] | 12 | self.errors = kwargs.pop('errors', []) |
Patrick Williams | f79f358 | 2016-10-09 16:12:26 -0500 | [diff] [blame] | 13 | |
| 14 | super(Property, self).__init__(**kwargs) |
Patrick Williams | 62c3f27 | 2016-10-09 16:21:34 -0500 | [diff] [blame] | 15 | |
Patrick Williams | 2adcefa | 2016-11-16 08:23:12 -0600 | [diff] [blame] | 16 | def is_enum(self): |
| 17 | if not self.cppTypeName: |
| 18 | return False |
| 19 | if self.cppTypeName.startswith("enum<"): |
| 20 | return True |
| 21 | return False |
| 22 | |
Patrick Williams | 0aa0dde | 2016-11-16 08:14:33 -0600 | [diff] [blame] | 23 | """ Return a conversion of the cppTypeName valid as a function parameter. |
| 24 | Currently only 'enum' requires conversion. |
| 25 | """ |
| 26 | def cppTypeParam(self, interface, server=True): |
Patrick Williams | 2adcefa | 2016-11-16 08:23:12 -0600 | [diff] [blame] | 27 | if self.is_enum(): |
Patrick Williams | 0aa0dde | 2016-11-16 08:14:33 -0600 | [diff] [blame] | 28 | # strip off 'enum<' and '>' |
| 29 | r = self.cppTypeName.split('>')[0].split('<')[1] |
| 30 | |
| 31 | # self. means local type. |
| 32 | if r.startswith("self."): |
| 33 | return r.split('self.')[1] |
| 34 | |
| 35 | r = r.split('.') |
| 36 | r.insert(-2, "server" if server else "client") |
| 37 | r = "::".join(r) |
| 38 | return r |
| 39 | return self.cppTypeName |
| 40 | |
| 41 | """ Return a conversion of the cppTypeName valid as it is read out of a |
| 42 | message. Currently only 'enum' requires conversion. |
| 43 | """ |
| 44 | def cppTypeMessage(self, interface): |
Patrick Williams | 2adcefa | 2016-11-16 08:23:12 -0600 | [diff] [blame] | 45 | if self.is_enum(): |
Patrick Williams | 0aa0dde | 2016-11-16 08:14:33 -0600 | [diff] [blame] | 46 | return "std::string" |
| 47 | return self.cppTypeName |
| 48 | |
Patrick Williams | 0ad505c | 2016-11-16 16:17:02 -0600 | [diff] [blame] | 49 | def enum_namespace(self, interface): |
| 50 | if not self.is_enum(): |
| 51 | return "" |
| 52 | l = self.cppTypeParam(interface).split("::")[0:-1] |
| 53 | if len(l) != 0: |
| 54 | return "::".join(l) + "::" |
| 55 | return "" |
| 56 | |
| 57 | def enum_name(self, interface): |
| 58 | if not self.is_enum(): |
| 59 | return "" |
| 60 | return self.cppTypeParam(interface).split("::")[-1] |
| 61 | |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 62 | def parse_cpp_type(self, typeName): |
| 63 | if not typeName: |
| 64 | return None |
| 65 | |
| 66 | """ typeNames are _almost_ valid YAML. Insert a , before each [ |
| 67 | and then wrap it in a [ ] and it becomes valid YAML. (assuming |
| 68 | the user gave us a valid typename) |
| 69 | """ |
Christian Andersen | e416398 | 2016-12-09 11:24:03 +0100 | [diff] [blame] | 70 | typeArray = yaml.safe_load("[" + ",[".join(typeName.split("[")) + "]") |
| 71 | typeTuple = self.__preprocess_yaml_type_array(typeArray).pop(0) |
| 72 | return self.__parse_cpp_type__(typeTuple) |
| 73 | |
| 74 | """ Take a list of dbus types from YAML and convert it to a recursive data |
| 75 | structure. Each entry of the original list gets converted into a tuple |
| 76 | consisting of the type name and a list with the params for this type, |
| 77 | e.g. |
| 78 | ['dict', ['string', 'dict', ['string', 'int64']]] |
| 79 | is converted to |
Patrick Williams | 3f67eed | 2016-12-12 12:22:03 -0600 | [diff] [blame] | 80 | [('dict', [('string', []), ('dict', [('string', []), |
| 81 | ('int64', [])]]] |
Christian Andersen | e416398 | 2016-12-09 11:24:03 +0100 | [diff] [blame] | 82 | """ |
| 83 | def __preprocess_yaml_type_array(self, typeArray): |
| 84 | result = [] |
| 85 | |
| 86 | for i in range(len(typeArray)): |
| 87 | # Ignore lists because we merge them with the previous element |
| 88 | if type(typeArray[i]) is list: |
| 89 | continue |
| 90 | |
Patrick Williams | 3f67eed | 2016-12-12 12:22:03 -0600 | [diff] [blame] | 91 | # If there is a next element and it is a list, merge it with the |
| 92 | # current element. |
Christian Andersen | e416398 | 2016-12-09 11:24:03 +0100 | [diff] [blame] | 93 | if i < len(typeArray)-1 and type(typeArray[i+1]) is list: |
Patrick Williams | 3f67eed | 2016-12-12 12:22:03 -0600 | [diff] [blame] | 94 | result.append( |
| 95 | (typeArray[i], |
| 96 | self.__preprocess_yaml_type_array(typeArray[i+1]))) |
Christian Andersen | e416398 | 2016-12-09 11:24:03 +0100 | [diff] [blame] | 97 | else: |
| 98 | result.append((typeArray[i], [])) |
| 99 | |
| 100 | return result |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 101 | |
| 102 | """ Take a list of dbus types and perform validity checking, such as: |
| 103 | [ variant [ dict [ int32, int32 ], double ] ] |
| 104 | This function then converts the type-list into a C++ type string. |
| 105 | """ |
Christian Andersen | e416398 | 2016-12-09 11:24:03 +0100 | [diff] [blame] | 106 | def __parse_cpp_type__(self, typeTuple): |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 107 | propertyMap = { |
| 108 | 'byte': {'cppName': 'uint8_t', 'params': 0}, |
| 109 | 'boolean': {'cppName': 'bool', 'params': 0}, |
| 110 | 'int16': {'cppName': 'int16_t', 'params': 0}, |
| 111 | 'uint16': {'cppName': 'uint16_t', 'params': 0}, |
| 112 | 'int32': {'cppName': 'int32_t', 'params': 0}, |
| 113 | 'uint32': {'cppName': 'uint32_t', 'params': 0}, |
| 114 | 'int64': {'cppName': 'int64_t', 'params': 0}, |
| 115 | 'uint64': {'cppName': 'uint64_t', 'params': 0}, |
| 116 | 'double': {'cppName': 'double', 'params': 0}, |
| 117 | 'string': {'cppName': 'std::string', 'params': 0}, |
Patrick Williams | 8a30a8f | 2017-01-06 16:29:05 -0600 | [diff] [blame] | 118 | 'path': {'cppName': 'sdbusplus::message::object_path', |
| 119 | 'params': 0}, |
| 120 | 'signature': {'cppName': 'sdbusplus::message::signature', |
| 121 | 'params': 0}, |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 122 | 'array': {'cppName': 'std::vector', 'params': 1}, |
| 123 | 'struct': {'cppName': 'std::tuple', 'params': -1}, |
Patrick Williams | abf5f78 | 2016-12-12 12:13:40 -0600 | [diff] [blame] | 124 | 'variant': {'cppName': 'sdbusplus::message::variant', |
| 125 | 'params': -1}, |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 126 | 'dict': {'cppName': 'std::map', 'params': 2}, |
| 127 | 'enum': {'cppName': 'enum', 'params': 1, 'noparse': True}} |
| 128 | |
Christian Andersen | e416398 | 2016-12-09 11:24:03 +0100 | [diff] [blame] | 129 | if len(typeTuple) != 2: |
| 130 | raise RuntimeError("Invalid typeTuple %s" % typeTuple) |
| 131 | |
| 132 | first = typeTuple[0] |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 133 | entry = propertyMap[first] |
| 134 | |
| 135 | result = entry['cppName'] |
| 136 | |
| 137 | # Handle 0-entry parameter lists. |
| 138 | if (entry['params'] == 0): |
Christian Andersen | e416398 | 2016-12-09 11:24:03 +0100 | [diff] [blame] | 139 | if (len(typeTuple[1]) != 0): |
| 140 | raise RuntimeError("Invalid typeTuple %s" % typeTuple) |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 141 | else: |
| 142 | return result |
| 143 | |
Christian Andersen | e416398 | 2016-12-09 11:24:03 +0100 | [diff] [blame] | 144 | # Get the parameter list |
| 145 | rest = typeTuple[1] |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 146 | |
| 147 | # Confirm parameter count matches. |
| 148 | if (entry['params'] != -1) and (entry['params'] != len(rest)): |
| 149 | raise RuntimeError("Invalid entry count for %s : %s" % |
| 150 | (first, rest)) |
| 151 | |
| 152 | # Parse each parameter entry, if appropriate, and create C++ template |
| 153 | # syntax. |
| 154 | result += '<' |
| 155 | if entry.get('noparse'): |
Christian Andersen | 768f128 | 2016-12-09 15:48:50 +0100 | [diff] [blame] | 156 | # Do not parse the parameter list, just use the first element |
| 157 | # of each tuple and ignore possible parameters |
| 158 | result += ", ".join([e[0] for e in rest]) |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 159 | else: |
Christian Andersen | e416398 | 2016-12-09 11:24:03 +0100 | [diff] [blame] | 160 | result += ", ".join(map(lambda e: self.__parse_cpp_type__(e), |
Patrick Williams | d0cd966 | 2016-11-14 21:55:07 -0600 | [diff] [blame] | 161 | rest)) |
| 162 | result += '>' |
| 163 | |
| 164 | return result |
| 165 | |
Patrick Williams | 62c3f27 | 2016-10-09 16:21:34 -0500 | [diff] [blame] | 166 | def markdown(self, loader): |
Patrick Williams | e70f0e8 | 2016-10-14 22:24:17 -0500 | [diff] [blame] | 167 | return self.render(loader, "property.mako.md", property=self, |
Patrick Williams | f5c3cde | 2016-10-21 11:49:01 -0500 | [diff] [blame] | 168 | post=str.strip) |
Adriana Kobylak | ee6ac69 | 2018-06-06 09:36:51 -0500 | [diff] [blame] | 169 | |
| 170 | def cpp_prototype(self, loader, interface, ptype): |
| 171 | return self.render(loader, "property.mako.prototype.hpp", property=self, |
| 172 | interface=interface, ptype=ptype, post=str.rstrip) |