Skip to content

Commit 1597804

Browse files
committed
Rename "structure_member" to field since that seems easier to type and is a good term
1 parent f826b76 commit 1597804

File tree

4 files changed

+37
-37
lines changed

4 files changed

+37
-37
lines changed

scripts/idl/matter_grammar.lark

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
struct: "struct"i id "{" struct_member* "}"
1+
struct: "struct"i id "{" struct_field* "}"
22
enum: "enum"i id ":" type "{" enum_entry* "}"
33

4-
event: event_priority "event"i id "=" number "{" struct_member* "}"
4+
event: event_priority "event"i id "=" number "{" struct_field* "}"
55

66
?event_priority: "critical"i -> critical_priority
77
| "info"i -> info_priority
88
| "debug"i -> debug_priority
99

10-
attribute: "attribute"i "(" attribute_access ")" named_member
10+
attribute: "attribute"i "(" attribute_access ")" field
1111
attribute_access: "readonly"i -> readonly
1212
| "writable"i -> writable
1313

@@ -29,12 +29,12 @@ endpoint_cluster: endpoint_cluster_type "cluster"i id ";"
2929
enum_entry: id "=" number ";"
3030
number: POSITIVE_INTEGER | HEX_INTEGER
3131

32-
struct_member: member_attribute* named_member
32+
struct_field: member_attribute* field
3333

3434
member_attribute: "optional"i -> optional
3535
| "nullable"i -> nullable
3636

37-
named_member: type id list_marker? "=" number ";"
37+
field: type id list_marker? "=" number ";"
3838
list_marker: "[" "]"
3939

4040
id: ID

scripts/idl/matter_idl_types.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
from typing import List, Set
55

66

7-
class MemberAttribute(enum.Enum):
7+
class FieldAttribute(enum.Enum):
88
OPTIONAL = enum.auto()
99
NULLABLE = enum.auto()
1010

@@ -36,24 +36,24 @@ class EndpointContentType(enum.Enum):
3636

3737

3838
@dataclass
39-
class StructureMember:
39+
class Field:
4040
data_type: str
4141
code: int
4242
name: str
4343
is_list: bool = False
44-
attributes: Set[MemberAttribute] = field(default_factory=set)
44+
attributes: Set[FieldAttribute] = field(default_factory=set)
4545

4646

4747
@dataclass
4848
class Attribute:
4949
access: AttributeAccess
50-
definition: StructureMember
50+
definition: Field
5151

5252

5353
@dataclass
5454
class Struct:
5555
name: str
56-
members: List[StructureMember]
56+
fields: List[Field]
5757
tag: StructTag = None
5858

5959

@@ -62,7 +62,7 @@ class Event:
6262
priority: EventPriority
6363
name: str
6464
code: int
65-
members: List[StructureMember]
65+
fields: List[Field]
6666

6767

6868
@dataclass

scripts/idl/parser.py

+11-11
Original file line numberDiff line numberDiff line change
@@ -54,18 +54,18 @@ def enum_entry(self, id, number):
5454
def enum(self, id, type, *entries):
5555
return Enum(name=id, base_type=type, entries=list(entries))
5656

57-
def named_member(self, args):
57+
def field(self, args):
5858
data_type, name = args[0], args[1]
5959
is_list = (len(args) == 4)
6060
code = args[-1]
6161

62-
return StructureMember(data_type=data_type, name=name, code=code, is_list=is_list)
62+
return Field(data_type=data_type, name=name, code=code, is_list=is_list)
6363

6464
def optional(self, _):
65-
return MemberAttribute.OPTIONAL
65+
return FieldAttribute.OPTIONAL
6666

6767
def nullable(self, _):
68-
return MemberAttribute.NULLABLE
68+
return FieldAttribute.NULLABLE
6969

7070
def readonly(self, _):
7171
return AttributeAccess.READONLY
@@ -88,12 +88,12 @@ def endpoint_server_cluster(self, _):
8888
def endpoint_binding_to_cluster(self, _):
8989
return EndpointContentType.CLIENT_BINDING
9090

91-
def struct_member(self, args):
91+
def struct_field(self, args):
9292
# Last argument is the named_member, the rest
9393
# are attributes
94-
member = args[-1]
95-
member.attributes = set(args[:-1])
96-
return member
94+
field = args[-1]
95+
field.attributes = set(args[:-1])
96+
return field
9797

9898
def server_cluster(self, _):
9999
return ClusterSide.SERVER
@@ -110,15 +110,15 @@ def command(self, args):
110110
return Command(name=args[0], input_param=param_in, output_param=args[-2], code=args[-1])
111111

112112
def event(self, args):
113-
return Event(priority=args[0], name=args[1], code=args[2], members=args[3:], )
113+
return Event(priority=args[0], name=args[1], code=args[2], fields=args[3:], )
114114

115115
@v_args(inline=True)
116116
def attribute(self, attribute_access, named_member):
117117
return Attribute(access=attribute_access, definition=named_member)
118118

119119
@v_args(inline=True)
120-
def struct(self, id, *members):
121-
return Struct(name=id, members=list(members))
120+
def struct(self, id, *fields):
121+
return Struct(name=id, fields=list(fields))
122122

123123
@v_args(inline=True)
124124
def request_struct(self, value):

scripts/idl/test_parsing.py

+15-15
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,13 @@ def test_global_struct(self):
6767

6868
expected = Idl(structs=[
6969
Struct(name='Something',
70-
members=[
71-
StructureMember(
70+
fields=[
71+
Field(
7272
data_type="CHAR_STRING", code=1, name="astring", ),
73-
StructureMember(data_type="CLUSTER_ID", code=2, name="idlist", is_list=True, attributes=set(
74-
[MemberAttribute.OPTIONAL])),
75-
StructureMember(data_type="int", code=0x123, name="valueThatIsNullable", attributes=set(
76-
[MemberAttribute.NULLABLE])),
73+
Field(data_type="CLUSTER_ID", code=2, name="idlist", is_list=True, attributes=set(
74+
[FieldAttribute.OPTIONAL])),
75+
Field(data_type="int", code=0x123, name="valueThatIsNullable", attributes=set(
76+
[FieldAttribute.NULLABLE])),
7777
])]
7878
)
7979
self.assertEqual(actual, expected)
@@ -91,9 +91,9 @@ def test_cluster_attribute(self):
9191
name="MyCluster",
9292
code=0x321,
9393
attributes=[
94-
Attribute(access=AttributeAccess.READONLY, definition=StructureMember(
94+
Attribute(access=AttributeAccess.READONLY, definition=Field(
9595
data_type="int8u", code=1, name="roAttr")),
96-
Attribute(access=AttributeAccess.READWRITE, definition=StructureMember(
96+
Attribute(access=AttributeAccess.READWRITE, definition=Field(
9797
data_type="int32u", code=123, name="rwAttr", is_list=True)),
9898
]
9999
)])
@@ -115,10 +115,10 @@ def test_cluster_commands(self):
115115
name="WithCommands",
116116
code=1,
117117
structs=[
118-
Struct(name="FreeStruct", members=[]),
119-
Struct(name="InParam", members=[],
118+
Struct(name="FreeStruct", fields=[]),
119+
Struct(name="InParam", fields=[],
120120
tag=StructTag.REQUEST),
121-
Struct(name="OutParam", members=[],
121+
Struct(name="OutParam", fields=[],
122122
tag=StructTag.RESPONSE),
123123
],
124124
commands=[
@@ -167,14 +167,14 @@ def test_cluster_events(self):
167167
name="EventTester",
168168
code=0x123,
169169
events=[
170-
Event(priority=EventPriority.CRITICAL, name="StartUp", code=0, members=[
171-
StructureMember(data_type="INT32U",
170+
Event(priority=EventPriority.CRITICAL, name="StartUp", code=0, fields=[
171+
Field(data_type="INT32U",
172172
code=0, name="softwareVersion"),
173173
]),
174174
Event(priority=EventPriority.INFO,
175-
name="Hello", code=1, members=[]),
175+
name="Hello", code=1, fields=[]),
176176
Event(priority=EventPriority.DEBUG,
177-
name="GoodBye", code=2, members=[]),
177+
name="GoodBye", code=2, fields=[]),
178178
])])
179179
self.assertEqual(actual, expected)
180180

0 commit comments

Comments
 (0)