| # Copyright (c) 2022 Project CHIP Authors |
| # |
| # 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 typing import Optional |
| |
| from matter_idl.generators.type_definitions import GetDataTypeSizeInBits, IsSignedDataType |
| from matter_idl.matter_idl_types import AccessPrivilege, Attribute, AttributeQuality, DataType, Field, FieldQuality |
| |
| |
| def ParseInt(value: str, data_type: Optional[DataType] = None) -> int: |
| """ |
| Convert a string that is a known integer into an actual number. |
| |
| Supports decimal or hex values prefixed with '0x' |
| """ |
| if value.startswith('0x'): |
| value = int(value[2:], 16) |
| if data_type and IsSignedDataType(data_type): |
| bits = GetDataTypeSizeInBits(data_type) |
| if value & (1 << (bits - 1)): |
| value -= 1 << bits |
| return value |
| else: |
| return int(value) |
| |
| |
| def AttrsToAccessPrivilege(attrs) -> AccessPrivilege: |
| """Given attributes of an '<access .../>' tag, generate the underlying |
| access privilege by looking at the role/privilege attribute. |
| """ |
| |
| # XML seems to use both role and privilege to mean the same thing |
| # they are used interchangeably |
| if 'role' in attrs: |
| role = attrs['role'] |
| else: |
| role = attrs['privilege'] |
| |
| if role.lower() == 'view': |
| return AccessPrivilege.VIEW |
| elif role.lower() == 'operate': |
| return AccessPrivilege.OPERATE |
| elif role.lower() == 'manage': |
| return AccessPrivilege.MANAGE |
| elif role.lower() == 'administer': |
| return AccessPrivilege.ADMINISTER |
| else: |
| raise Exception('Unknown ACL role: %r' % role) |
| |
| |
| def AttrsToAttribute(attrs) -> Attribute: |
| """Given the attributes of an '<attribute .../>' tag, generate the |
| underlying IDL Attribute dataclass. |
| """ |
| |
| if attrs['type'].lower() == 'array': |
| data_type = DataType(name=attrs['entryType']) |
| else: |
| data_type = DataType(name=attrs['type']) |
| |
| if 'minLength' in attrs: |
| data_type.min_length = ParseInt(attrs['minLength']) |
| |
| if 'length' in attrs: |
| data_type.max_length = ParseInt(attrs['length']) |
| |
| if 'min' in attrs: |
| data_type.min_value = ParseInt(attrs['min'], data_type) |
| |
| if 'max' in attrs: |
| data_type.max_value = ParseInt(attrs['max'], data_type) |
| |
| field = Field( |
| data_type=data_type, |
| code=ParseInt(attrs['code']), |
| name='', |
| is_list=(attrs['type'].lower() == 'array') |
| ) |
| |
| attribute = Attribute(definition=field) |
| |
| if attrs.get('optional', "false").lower() == 'true': |
| attribute.definition.qualities |= FieldQuality.OPTIONAL |
| |
| if attrs.get('isNullable', "false").lower() == 'true': |
| attribute.definition.qualities |= FieldQuality.NULLABLE |
| |
| if attrs.get('readable', "true").lower() == 'true': |
| attribute.qualities |= AttributeQuality.READABLE |
| |
| if attrs.get('writable', "false").lower() == 'true': |
| attribute.qualities |= AttributeQuality.WRITABLE |
| |
| # TODO(#22937): NOSUBSCRIBE attribute tag is not available - could find no |
| # clear source to get this info. |
| |
| # NOTE: default values are also present in this XML, however generally IDL |
| # **DATA** definitions would not care about the defaults. The |
| # defaults should be used to initializ storage for devices, hence |
| # they are part of endpoint definition/composition. We are not doing |
| # that here, so defaults are ignored. |
| |
| return attribute |
