Skip to content

Commit

Permalink
Improve comment escaping
Browse files Browse the repository at this point in the history
  • Loading branch information
@jdomnitz
jdomnitz committed Jan 7, 2025
1 parent 2d773e2 commit 1e31fdc
Show file tree
Hide file tree
Showing 10 changed files with 972 additions and 44 deletions.
22 changes: 3 additions & 19 deletions Generator/ClusterGenerator.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -299,22 +299,6 @@ private static void WriteStructType(bool optional, bool nullable, string type, s
}
switch (type)
{
case "array":
if (optional || nullable)
writer.WriteLine($"{totalIndent}if ({name} != null)");
writer.WriteLine($"{totalIndent}{{");
if (from != null || to != null)
writer.WriteLine($"{totalIndent} Constrain({name}, {from ?? 0}{(to == null ? "" : $", {to}")});");
writer.WriteLine($"{totalIndent} writer.StartArray({id});");
writer.WriteLine($"{totalIndent} foreach (var item in {name}) {{");
writer.Write(" ");
WriteStructType(false, false, entryType!, null, -1, null, null, "item", cluster, writer);
writer.WriteLine($"{totalIndent} }}");
writer.WriteLine($"{totalIndent} writer.EndContainer();");
writer.WriteLine($"{totalIndent}}}");
if (nullable)
writer.WriteLine($"{totalIndent}else\n{totalIndent} writer.WriteNull({id});");
return;
case "list":
if (optional || nullable)
writer.WriteLine($"{totalIndent}if ({name} != null)");
Expand Down Expand Up @@ -1091,7 +1075,7 @@ private static void WriteEnum(clusterDataTypesEnum enumType, TextWriter writer)
if (!string.IsNullOrWhiteSpace(item.value))
{
if (item.summary != null)
writer.WriteLine(" /// <summary>\n /// " + item.summary.Replace("[[ref_", "<see cref=\"").Replace("]]", "\"/>") + "\n /// </summary>");
writer.WriteLine(" /// <summary>\n /// " + GeneratorUtil.SanitizeComment(item.summary) + "\n /// </summary>");
writer.WriteLine(" " + GeneratorUtil.SanitizeName(item.name) + " = " + item.value + ",");
}
}
Expand All @@ -1108,7 +1092,7 @@ private static void WriteBitfield(clusterDataTypesBitfield enumType, TextWriter
foreach (clusterDataTypesBitfieldItem item in enumType.bitfield)
{
if (item.summary != null)
writer.WriteLine(" /// <summary>\n /// " + item.summary.Replace("[[ref_", "<see cref=\"").Replace("]]", "\"/>") + "\n /// </summary>");
writer.WriteLine(" /// <summary>\n /// " + GeneratorUtil.SanitizeComment(item.summary) + "\n /// </summary>");
writer.WriteLine(" " + GeneratorUtil.SanitizeName(item.name) + " = " + (1<<item.bit) + ",");
}
writer.WriteLine(" }");
Expand All @@ -1128,7 +1112,7 @@ private static void WriteFeatures(clusterFeature[] features, TextWriter writer)
writer.WriteLine(" public enum Feature {");
foreach (clusterFeature item in features)
{
writer.WriteLine(" /// <summary>\n /// " + item.summary.Replace("[[ref_", "<see cref=\"").Replace("]]", "\"/>") + "\n /// </summary>");
writer.WriteLine(" /// <summary>\n /// " + GeneratorUtil.SanitizeComment(item.summary) + "\n /// </summary>");
writer.WriteLine(" " + GeneratorUtil.SanitizeName(item.name) + " = " + (1 << item.bit) + ",");
}
writer.WriteLine(" }");
Expand Down
203 changes: 203 additions & 0 deletions Generator/Clusters/OTAProvider.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@
<?xml version="1.0"?>
<!--
Copyright (C) Connectivity Standards Alliance (2021). All rights reserved.
The information within this document is the property of the Connectivity
Standards Alliance and its use and disclosure are restricted, except as
expressly set forth herein.
Connectivity Standards Alliance hereby grants you a fully-paid, non-exclusive,
nontransferable, worldwide, limited and revocable license (without the right to
sublicense), under Connectivity Standards Alliance's applicable copyright
rights, to view, download, save, reproduce and use the document solely for your
own internal purposes and in accordance with the terms of the license set forth
herein. This license does not authorize you to, and you expressly warrant that
you shall not: (a) permit others (outside your organization) to use this
document; (b) post or publish this document; (c) modify, adapt, translate, or
otherwise change this document in any manner or create any derivative work
based on this document; (d) remove or modify any notice or label on this
document, including this Copyright Notice, License and Disclaimer. The
Connectivity Standards Alliance does not grant you any license hereunder other
than as expressly stated herein.
Elements of this document may be subject to third party intellectual property
rights, including without limitation, patent, copyright or trademark rights,
and any such third party may or may not be a member of the Connectivity
Standards Alliance. Connectivity Standards Alliance members grant other
Connectivity Standards Alliance members certain intellectual property rights as
set forth in the Connectivity Standards Alliance IPR Policy. Connectivity
Standards Alliance members do not grant you any rights under this license. The
Connectivity Standards Alliance is not responsible for, and shall not be held
responsible in any manner for, identifying or failing to identify any or all
such third party intellectual property rights. Please visit www.csa-iot.org for
more information on how to become a member of the Connectivity Standards
Alliance.
This document and the information contained herein are provided on an “AS IS”
basis and the Connectivity Standards Alliance DISCLAIMS ALL WARRANTIES EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO (A) ANY WARRANTY THAT THE USE OF THE
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OF THIRD PARTIES (INCLUDING
WITHOUT LIMITATION ANY INTELLECTUAL PROPERTY RIGHTS INCLUDING PATENT, COPYRIGHT
OR TRADEMARK RIGHTS); OR (B) ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE, TITLE OR NONINFRINGEMENT. IN NO EVENT WILL THE
CONNECTIVITY STANDARDS ALLIANCE BE LIABLE FOR ANY LOSS OF PROFITS, LOSS OF
BUSINESS, LOSS OF USE OF DATA, INTERRUPTION OF BUSINESS, OR FOR ANY OTHER
DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL
DAMAGES OF ANY KIND, IN CONTRACT OR IN TORT, IN CONNECTION WITH THIS DOCUMENT
OR THE INFORMATION CONTAINED HEREIN, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
LOSS OR DAMAGE.
All company, brand and product names in this document may be trademarks that
are the sole property of their respective owners.
This notice and disclaimer must be included on all copies of this document.
Connectivity Standards Alliance
508 Second Street, Suite 206
Davis, CA 95616, USA
-->
<cluster xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="types types.xsd cluster cluster.xsd" id="0x0029" name="OTA Software Update Provider Cluster" revision="1">
<revisionHistory>
<revision revision="1" summary="Initial Release"/>
</revisionHistory>
<clusterIds>
<clusterId id="0x0029" name="OTA Software Update Provider"/>
</clusterIds>
<classification hierarchy="base" role="utility" picsCode="OTAP" scope="Node"/>
<dataTypes>
<enum name="ApplyUpdateActionEnum">
<item value="0" name="Proceed" summary="Apply the update.">
<mandatoryConform/>
</item>
<item value="1" name="AwaitNextAction" summary="Wait at least the given delay time.">
<mandatoryConform/>
</item>
<item value="2" name="Discontinue" summary="The OTA Provider is conveying a desire to rescind a previously provided Software Image.">
<mandatoryConform/>
</item>
</enum>
<enum name="DownloadProtocolEnum">
<item value="0" name="BDXSynchronous" summary="Indicates support for synchronous BDX.">
<mandatoryConform/>
</item>
<item value="1" name="BDXAsynchronous" summary="Indicates support for asynchronous BDX.">
<optionalConform/>
</item>
<item value="2" name="HTTPS" summary="Indicates support for HTTPS.">
<optionalConform/>
</item>
<item value="3" name="VendorSpecific" summary="Indicates support for vendor specific protocol.">
<optionalConform/>
</item>
</enum>
<enum name="StatusEnum">
<item value="0" name="UpdateAvailable" summary="Indicates that the OTA Provider has an update available.">
<mandatoryConform/>
</item>
<item value="1" name="Busy" summary="Indicates OTA Provider may have an update, but it is not ready yet.">
<mandatoryConform/>
</item>
<item value="2" name="NotAvailable" summary="Indicates that there is definitely no update currently available from the OTA Provider.">
<mandatoryConform/>
</item>
<item value="3" name="DownloadProtocolNotSupported" summary="Indicates that the requested download protocol is not supported by the OTA Provider.">
<mandatoryConform/>
</item>
</enum>
</dataTypes>
<commands>
<command id="0x00" name="QueryImage" direction="commandToServer" response="QueryImageResponse">
<access invokePrivilege="operate"/>
<mandatoryConform/>
<field id="0" name="VendorID" type="vendor-id">
<mandatoryConform/>
</field>
<field id="1" name="ProductID" type="uint16">
<mandatoryConform/>
</field>
<field id="2" name="SoftwareVersion" type="uint32">
<mandatoryConform/>
</field>
<field id="3" name="ProtocolsSupported" type="list">
<entry type="DownloadProtocolEnum"/>
<mandatoryConform/>
<constraint type="maxCount" value="8"/>
</field>
<field id="4" name="HardwareVersion" type="uint16">
<optionalConform/>
</field>
<field id="5" name="Location" type="string">
<optionalConform/>
<constraint type="maxLength" value="2"/>
</field>
<field id="6" name="RequestorCanConsent" type="bool" default="False">
<optionalConform/>
</field>
<field id="7" name="MetadataForProvider" type="octstr">
<optionalConform/>
<constraint type="maxLength" value="512"/>
</field>
</command>
<command id="0x01" name="QueryImageResponse" direction="responseFromServer">
<mandatoryConform/>
<field id="0" name="Status" type="StatusEnum">
<mandatoryConform/>
</field>
<field id="1" name="DelayedActionTime" type="uint32">
<optionalConform/>
</field>
<field id="2" name="ImageURI" type="string">
<optionalConform/>
<constraint type="maxLength" value="256"/>
</field>
<field id="3" name="SoftwareVersion" type="uint32">
<optionalConform/>
</field>
<field id="4" name="SoftwareVersionString" type="string">
<optionalConform/>
<constraint type="lengthBetween" from="1" to="64"/>
</field>
<field id="5" name="UpdateToken" type="octstr">
<optionalConform/>
<constraint type="lengthBetween" from="8" to="32"/>
</field>
<field id="6" name="UserConsentNeeded" type="bool" default="False">
<optionalConform/>
</field>
<field id="7" name="MetadataForRequestor" type="octstr">
<optionalConform/>
<constraint type="maxLength" value="512"/>
</field>
</command>
<command id="0x02" name="ApplyUpdateRequest" direction="commandToServer" response="ApplyUpdateResponse">
<access invokePrivilege="operate"/>
<mandatoryConform/>
<field id="0" name="UpdateToken" type="octstr">
<mandatoryConform/>
<constraint type="lengthBetween" from="8" to="32"/>
</field>
<field id="1" name="NewVersion" type="uint32">
<mandatoryConform/>
</field>
</command>
<command id="0x03" name="ApplyUpdateResponse" direction="responseFromServer">
<mandatoryConform/>
<field id="0" name="Action" type="ApplyUpdateActionEnum">
<mandatoryConform/>
</field>
<field id="1" name="DelayedActionTime" type="uint32">
<mandatoryConform/>
</field>
</command>
<command id="0x04" name="NotifyUpdateApplied" direction="commandToServer" response="Y">
<access invokePrivilege="operate"/>
<mandatoryConform/>
<field id="0" name="UpdateToken" type="octstr">
<mandatoryConform/>
<constraint type="lengthBetween" from="8" to="32"/>
</field>
<field id="1" name="SoftwareVersion" type="uint32">
<mandatoryConform/>
</field>
</command>
</commands>
</cluster>
Loading

0 comments on commit 1e31fdc

Please sign in to comment.