Minor administrative changes preparing for the release.

bengtmartensson · Jan 8, 2024 · 7160240 · 7160240
1 parent a2800b9
commit 7160240
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 8 deletions.
diff --git a/src/main/doc/Checklist.txt b/src/main/doc/Checklist.txt
@@ -1,9 +1,10 @@
 Checklist for release (for maintainer)
 
 0. Check in good code ;-). Check that tests run ok, javadoc is ok.
+   If necessary, merge rmProtocols.xml from rmir.
    (Ideally) update documentation IrpTransmogrifier,xml.
    Update subtree common. (git subtree pull --prefix common [email protected]:bengtmartensson/HarctoolboxCommon.git master)
-   Make sure that all relevant source files are checked in.
+   Make sure that all source files are checked in.
 1. Update pom.xml: Bump version; can use make setversion NEWVERSION=x.y.z.)
    Check/update version of IrpProtocols.xml.
    Update releasenotes. Update copyright year(?).

diff --git a/src/main/doc/IrpTransmogrifier.releasenotes.txt b/src/main/doc/IrpTransmogrifier.releasenotes.txt
@@ -3,6 +3,22 @@ Release Notes for IrpTransmogrifier.
 The notation #n refers to issues number n at
 https://github.com/bengtmartensson/IrpTransmogrifier/issues
 
+===============================================================================
+2024-01-08: Version 1.2.13.
+
+Although many lines of code has changed through refactorizations, the
+present version consists of a few bug fixes and clarifications of medium importance.
+Thanks to Sean Young for some non-trivial challenges (in particular #239!) ;-).
+
+* Protocols: Amazon_fan, Roku-8bit new protocols. Renamed Pioneer->Pioneer-2Part, tweaks to NECx1, NECX-f16 and TCL_AC.
+* Normal-form-IRP now uses +, not *. See #245.
+* Robustness fix for BracketedIrSignalParser (frequency).
+* Misc. code cleanup.
+* Minor documentation update/clarification.
+* Major refactoring for extraction bug. See #239.
+* Do not nuke variants-intros that are equal to the repeats any more. #241.
+* Changed error handling when parsing/lexing: Unknown tokens now stops parsing. #238.
+
 ===============================================================================
 2023-03-01: Version 1.2.12.
 

diff --git a/src/main/resources/IrpProtocols.xml b/src/main/resources/IrpProtocols.xml
@@ -47,7 +47,14 @@ List of parameters recognized by IrpTransmogrifier:
 
 prefer-over
     If a signal has multiple decodes, the present protocol is preferred over the one mentioned as prefer-over.
-May be given several times. (Normally, a specialized protocol should be preferred over a more general one.)
+May be given several times.
+Alternatively, the content of the element may have two parts: a predicate and a protocol name,
+separated by a semi colon (";").
+The predicate is evaluated for the current, to be preferred, protocol and its parameters.
+Only if the predicate (which is an <code>expression</code> in the sense of IRP) evaluates to non-zero,
+the preferance takes effect.
+(See the protocol Pioneer for an example.)
+(Normally, a specialized protocol should be preferred over a more general one.)
 
 alt_name
     Alternative name, ("alias", "synonym") for the present protocol.
@@ -180,7 +187,7 @@ ordering is not required but it improves the readability of the entry.
                xmlns:rm="https://sourceforge.net/projects/controlremote/files/RemoteMaster"
                xmlns:xi="http://www.w3.org/2001/XInclude"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-               version="2024-01-06"
+               version="2024-01-07"
                xsi:schemaLocation="http://www.harctoolbox.org/irp-protocols http://www.harctoolbox.org/schemas/irp-protocols.xsd"
                xmlns:irp="http://www.harctoolbox.org/irp-protocols">
 
@@ -237,13 +244,25 @@ ordering is not required but it improves the readability of the entry.
     </irp:protocol>
 
     <irp:protocol name="Akord">
-        <irp:irp>
+       <irp:irp>
             <![CDATA[{37.0k,477,msb}<1,-1|1,-2>(18,-8,D:8,S:8,F:8,~F:8,1,-40m,(18,-5,1,-78m)*)[D:0..255,S:0..255,F:0..255]]]>
         </irp:irp>
         <irp:documentation xml:space="preserve">Protocol found in Akord HDMI switches. Similar to <a href="#NEC1">NEC1</a>, but with different timing.
             See <a href="http://www.hifi-remote.com/forums/viewtopic.php?p=137873">forum thread</a>.</irp:documentation>
     </irp:protocol>
 
+    <irp:protocol name="Amazon_Fan">
+        <irp:irp>
+            <![CDATA[{38.5k,520,msb}<1,-3|1,-5>(9,-9,D:8,F:8,0:1,9,-9,D:8,F:8,1,-13.7m,(9074u,-5,1,-52m)*)[D:0..255,F:0..255]]]>
+        </irp:irp>
+        <irp:documentation>This protocol was discovered/invented and discussed in <a href="http://www.hifi-remote.com/forums/viewtopic.php?t=103390">this thread</a>.</irp:documentation>
+        <irp:parameter name="uei-executor" type="xml">
+            <rm:deployment executor="01FF:JP1Amazon[D;F]">
+                <rm:protocolName>Amazon Fan</rm:protocolName>
+            </rm:deployment>
+        </irp:parameter>
+    </irp:protocol>
+
     <irp:protocol name="Amino">
         <irp:irp>
             <![CDATA[{37.3k,268,msb}<-1,1|1,-1>(T=1,(7,-6,3,D:4,1:1,T:1,1:2,0:8,F:8,15:4,C:4,-79m,T=0)+){C =(D:4+4*T+9+F:4+F:4:4+15)&15} [D:0..15,F:0..255]]]>

diff --git a/src/main/xdocs/IrpTransmogrifier.xml b/src/main/xdocs/IrpTransmogrifier.xml
@@ -47,6 +47,10 @@
                 <td>2022-05-07</td>
                 <td>Update for version 1.2.11: Spelling fixes etc.</td>
             </tr>
+            <tr>
+                <td>2024-01-08</td>
+                <td>Minor clarifications: Described predicates in prefer-overs and non-emptyness requirement for repeats.</td>
+            </tr>
         </table>
 
         <section>
@@ -564,7 +568,14 @@
                             </dt>
                             <dd>If a signal has multiple decodes,
                                 the present protocol is preferred over the one mentioned as <code>prefer-over</code>.
-                                May be given several times. (Normally, a special protol should be preferred over a more general one.)
+                                May be given several times.
+                                Alternatively, the content of the element may have two parts: a predicate and a protocol name,
+                                separated by a semi colon ("<code>;</code>").
+                                The predicate is evaluated for the current, to be preferred, protocol and its parameters.
+                                Only if the predicate (which is an <code>expression</code> in the sense of IRP) evaluates to non-zero,
+                                the preferance takes effect.
+                                (See the protocol <code>Pioneer</code> for an example.)
+                                (Normally, a special protol should be preferred over a more general one.)
                             </dd>
 
                             <dt id="alt_name">
@@ -934,7 +945,9 @@
                     Probably 99% of all IR signals fit into the intro/repetition scheme,
                     allowing ending sequence in addition should leave very few practically
                     used IR signals left. In "abstract" IRP notation, these are of the form
-                    A,(B)*,C with A, B, and C being (possibly empty) <code>bare irstream</code>s.</p>
+                    A,(B)*,C with A, B, and C being (possibly empty) <code>bare irstream</code>s.
+                    Not all three may be empty; if B is empty, then C must also be empty.
+                </p>
                 <p>
                     In contrast, the IRP notation reminds of they syntax and
                     semantics of regular expressions: There may be any numbers of (infinite) repeats, and they

diff --git a/src/main/xml/Version.xml b/src/main/xml/Version.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE version PUBLIC  "-//harctoolbox.org//version//en" "http://www.harctoolbox.org/dtds/version.dtd">
 <!--
-Copyright (C) 2017, 2018, 2019, 2020, 2021, 2022, 2023 Bengt Martensson.
+Copyright (C) 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024 Bengt Martensson.
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -19,7 +19,7 @@ this program. If not, see http://www.gnu.org/licenses/.
 <version appName="IrpTransmogrifier" package = "org.harctoolbox.irp">
 
     <!-- Verbal description of the license of the current work. -->
-    <licenseString>Copyright (C) 2017, 2018, 2019, 2020, 2021, 2022, 2023 Bengt Martensson.\n\n
+    <licenseString>Copyright (C) 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024 Bengt Martensson.\n\n
 This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.\n\n
 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.\n\n
 You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.</licenseString>