Added getZeroTerminatedString method to DataRequest class.

Added variable, enumeration, get and set methods to StringRequest class. When using the getValue() function, the class now by default will convert the contents of the underlying byte buffer up to first zero byte. But thi can be changed by added methods.

Updated release files and started some real versioning. This is now version 1.0.2.

Author: Mouseviator

CHANGELOG.txt

@@ -1,3 +1,13 @@
+27.8.2021
+
+The oficial version number is now: 1.0.2
+
+Added: The ValueRetrieveMethod enumeration to the StringRequest class, the variable and the respective get and set methods for this enumeration. It now drives how the underlying byte buffer will be converted to string. Either: TO_FIRST_ZERO_BYTE - will use the added getZeroTerminatedString function, or: WHOLE_BUFFER - which will return the content of the whole buffer. By default, the StringRequest class uses TO_FIRST_ZERO_BYTE. You can change this using the new setValueRetrieveMethod(ValueRetrieveMethod valueRetrieveMethod) function, or by using getValue(ValueRetrieveMethod valueRetrieveMethod), which will not change the stored behavior of the class.
+Added: The getZeroTerminatedString(Charset charset) function to DataRequest class that will return the contents of the underlying byte buffer up to first zero byte converted to String. 
+Changed: Modified build.xml so for the Netbeans project, so it now generates jar files with version number.
+Updates: The respective archives and folders with ready to distributon (compiled) files.
+
+
 3.1.2021
 
 Added: Some Junit tests.

FSUIPC/build.xml

@@ -70,9 +70,14 @@
     nbproject/build-impl.xml file. 
 
     -->
+    <target name="-pre-init">
+        <property file="version.properties"/>
+        <property name="dist.jar" value="dist/${ant.project.name}-${project.version}.jar"/>
+    </target>
+    
     <target name="-post-jar" description="bundle sources and javadoc in a jar" depends="javadoc">
-        <jar compress="${jar.compress}" basedir="${src.dir}" jarfile="${dist.dir}/${application.title}-sources.jar"/>
-        <jar compress="${jar.compress}" basedir="${test.src.dir}" jarfile="${dist.dir}/${application.title}-test.jar"/>
-        <jar compress="${jar.compress}" basedir="${dist.javadoc.dir}" jarfile="${dist.dir}/${application.title}-javadoc.jar"/>
+        <jar compress="${jar.compress}" basedir="${src.dir}" jarfile="${dist.dir}/${application.title}-${project.version}-sources.jar"/>
+        <jar compress="${jar.compress}" basedir="${test.src.dir}" jarfile="${dist.dir}/${application.title}-${project.version}-test.jar"/>
+        <jar compress="${jar.compress}" basedir="${dist.javadoc.dir}" jarfile="${dist.dir}/${application.title}-${project.version}-javadoc.jar"/>
     </target>
 </project>

FSUIPC/build/built-jar.properties

@@ -0,0 +1,4 @@
+#Fri, 27 Aug 2021 18:59:51 +0200
+
+
+P\:\\Java\\Murdock_FSUIPC\\FSUIPC=

FSUIPC/nbproject/private/private.properties

@@ -1,8 +1,8 @@
-compile.on.save=true
+compile.on.save=false
 do.depend=false
 do.jar=true
 do.jlink=false
 javac.debug=true
 javadoc.preview=true
 jlink.strip=false
-user.properties.file=C:\\Users\\Murdock\\AppData\\Roaming\\NetBeans\\12.2\\build.properties
+user.properties.file=C:\\Users\\Murdock\\AppData\\Roaming\\NetBeans\\12.4\\build.properties

FSUIPC/nbproject/private/private.xml

@@ -2,6 +2,8 @@
 <project-private xmlns="http://www.netbeans.org/ns/project-private/1">
     <editor-bookmarks xmlns="http://www.netbeans.org/ns/editor-bookmarks/2" lastBookmarkId="0"/>
     <open-files xmlns="http://www.netbeans.org/ns/projectui-open-files/2">
-        <group/>
+        <group>
+            <file>file:/P:/Java/Murdock_FSUIPC/FSUIPC/src/com/mouseviator/fsuipc/datarequest/primitives/StringRequest.java</file>
+        </group>
     </open-files>
 </project-private>

FSUIPC/src/com/mouseviator/fsuipc/datarequest/DataRequest.java

@@ -371,6 +371,30 @@ protected void convertStringToByteArray(String value, int max_size, Charset char
         //put zero at the end
         dataBuffer[bufferLength - 1] = (byte) 0;
     }
+    
+    /**
+     * This function will convert byte array to string ending at first zero byte.
+     * 
+     * @param charset Charset to use when encoding the string.
+     * @return The contents of underlying byte up to first zero byte buffer converted to String.
+     */
+    protected String getZeroTerminatedString(Charset charset) {        
+        int firstZeroBytePos = dataBuffer.length;
+        for (int i = 0; i < dataBuffer.length; i++) {
+            if (dataBuffer[i] == 0) {
+                firstZeroBytePos = i;
+                break;
+            }
+        }        
+        
+        //check if empty string...
+        if (firstZeroBytePos == 0) {
+            firstZeroBytePos = 1;
+        }
+        
+        String result = new String(dataBuffer, 0, firstZeroBytePos, charset);
+        return result;
+    }
 
     /**
      * This helper function will copy the given byte array into the internal byte array. This will be copy of the

FSUIPC/src/com/mouseviator/fsuipc/datarequest/primitives/StringRequest.java

@@ -18,34 +18,28 @@
 import java.security.InvalidParameterException;
 
 /**
- * This class implements string data request for use with
- * {@link com.mouseviator.fsuipc.FSUIPC} class. Well, FSUIPC will read/write
- * string values as series of bytes, usually terminated as classic C string, by
- * 0 byte. But with Strings we always have this problem with encoding... so to
- * keep the scalability, this data request allows you to set encoding that will
- * be used to convert the internal byte data buffer holding the string to the
- * actual Java string. You can set this encoding using various constructors or
- * by the {@link #setCharset(java.nio.charset.Charset) } method. The charset for
- * encoding/decoding the string will be initialized to the system default,
- * which, mostly, will be UTF-8.
+ * This class implements string data request for use with {@link com.mouseviator.fsuipc.FSUIPC} class. Well, FSUIPC will
+ * read/write string values as series of bytes, usually terminated as classic C string, by 0 byte. But with Strings we
+ * always have this problem with encoding... so to keep the scalability, this data request allows you to set encoding
+ * that will be used to convert the internal byte data buffer holding the string to the actual Java string. You can set
+ * this encoding using various constructors or by the {@link #setCharset(java.nio.charset.Charset) } method. The charset
+ * for encoding/decoding the string will be initialized to the system default, which, mostly, will be UTF-8.
  *
  *
  * @author Mouseviator
  */
 public class StringRequest extends DataRequest implements IDataRequest<String> {
 
     private Charset charset = Charset.defaultCharset();
+    private ValueRetrieveMethod valueRetrieveMethod = ValueRetrieveMethod.WHOLE_BUFFER;
 
     /**
-     * Creates a new string data request associated with given offset and the
-     * byte data buffer initialized to given size. Note that this is only useful
-     * for READ type request. If you use the {@link #setValue(java.lang.String)
-     * } method later on this object, the byte array created by this constructor
-     * will be discarded.
+     * Creates a new string data request associated with given offset and the byte data buffer initialized to given
+     * size. Note that this is only useful for READ type request. If you use the {@link #setValue(java.lang.String)
+     * } method later on this object, the byte array created by this constructor will be discarded.
      *
      * @param offset An offset to associate this data request with.
-     * @param size The size of the byte data buffer to hold the string
-     * characters.
+     * @param size The size of the byte data buffer to hold the string characters.
      */
     public StringRequest(int offset, int size) throws InvalidParameterException {
         if (offset >= MIN_OFFSET_VALUE && offset <= MAX_OFFSET_VALUE && size > 0) {
@@ -57,10 +51,9 @@ public StringRequest(int offset, int size) throws InvalidParameterException {
     }
 
     /**
-     * Creates a new string data request associated with given offset and
-     * initialized to given string value. The conversion of the string to byte
-     * data buffer will happen using the system default charset. The data
-     * request type will be set to WRITE.
+     * Creates a new string data request associated with given offset and initialized to given string value. The
+     * conversion of the string to byte data buffer will happen using the system default charset. The data request type
+     * will be set to WRITE.
      *
      * @param offset An offset to associate this data request with.
      * @param value A string to set for this data request value.
@@ -77,13 +70,10 @@ public StringRequest(int offset, String value) throws InvalidParameterException
     }
 
     /**
-     * Creates a new string data request associated with given offset and
-     * initialized to given string value. If the byte data buffer, that will be
-     * result of converting given string value to byte array, is longer than
-     * max_size, it will be trimmed to the (max_size - 1) - the last byte will
-     * be set to 0. The conversion of the string to byte data buffer will happen
-     * using the system default charset. The data request type will be set to
-     * WRITE.
+     * Creates a new string data request associated with given offset and initialized to given string value. If the byte
+     * data buffer, that will be result of converting given string value to byte array, is longer than max_size, it will
+     * be trimmed to the (max_size - 1) - the last byte will be set to 0. The conversion of the string to byte data
+     * buffer will happen using the system default charset. The data request type will be set to WRITE.
      *
      * @param offset An offset to associate this data request with.
      * @param max_size Maximum size of the resulting byte data buffer.
@@ -102,10 +92,9 @@ public StringRequest(int offset, int max_size, String value) throws InvalidParam
     }
 
     /**
-     * Creates a new string data request associated with given offset and
-     * initialized to given string value.The conversion of the string to byte
-     * data buffer will happen using the provided charset. The data request type
-     * will be set to WRITE.
+     * Creates a new string data request associated with given offset and initialized to given string value.The
+     * conversion of the string to byte data buffer will happen using the provided charset. The data request type will
+     * be set to WRITE.
      *
      * @param offset An offset to associate this data request with.
      * @param value A string to set for this data request value.
@@ -115,7 +104,7 @@ public StringRequest(int offset, String value, Charset charset) throws InvalidPa
         if (offset >= MIN_OFFSET_VALUE && offset <= MAX_OFFSET_VALUE) {
             //convert to internal byte array
             convertStringToByteArray(value, 0, charset);
-            
+
             this.charset = charset;
             this.offset = offset;
             this.type = RequestType.WRITE;
@@ -125,12 +114,10 @@ public StringRequest(int offset, String value, Charset charset) throws InvalidPa
     }
 
     /**
-     * Creates a new string data request associated with given offset and
-     * initialized to given string value.If the byte data buffer, that will be
-     * result of converting given string value to byte array, is longer than
-     * max_size, it will be trimmed to the (max_size - 1) - the last byte will
-     * be set to 0. The conversion of the string to byte data buffer will happen
-     * using the provided charset. The data request type will be set to WRITE.
+     * Creates a new string data request associated with given offset and initialized to given string value.If the byte
+     * data buffer, that will be result of converting given string value to byte array, is longer than max_size, it will
+     * be trimmed to the (max_size - 1) - the last byte will be set to 0. The conversion of the string to byte data
+     * buffer will happen using the provided charset. The data request type will be set to WRITE.
      *
      * @param offset An offset to associate this data request with.
      * @param max_size Maximum size of the resulting byte data buffer.
@@ -151,9 +138,8 @@ public StringRequest(int offset, int max_size, String value, Charset charset) th
     }
 
     /**
-     * This function will allocate the internat byte data buffer to specified
-     * size, creating new buffer, thus, throwing away any data that this data
-     * request held before.
+     * This function will allocate the internat byte data buffer to specified size, creating new buffer, thus, throwing
+     * away any data that this data request held before.
      *
      * @param size The required size of the byte data buffer.
      */
@@ -164,19 +150,40 @@ public void allocate(int size) {
     }
 
     @Override
+    /**
+     * This function will return underlying byte data buffer as String. How the value will be retrieved depends on what value is set 
+     * {@link #getValueRetrieveMethod()}. 
+     *
+     * @return String representation of the underlying byte data buffer.
+     */
     public String getValue() {
-        return new String(dataBuffer, charset).trim();
+        return getValue(valueRetrieveMethod);
+    }
+
+    /**
+     * This function will return underlying byte data buffer as String. You have to specify how the value will be retrieved
+     * by <code>valueRetrieveMethod</code> parameter.
+     *
+     * @param valueRetrieveMethod The method to retrieve the value.
+     * @return String representation of the underlying byte data buffer.
+     */
+    public String getValue(ValueRetrieveMethod valueRetrieveMethod) {
+        if (valueRetrieveMethod == ValueRetrieveMethod.WHOLE_BUFFER) {
+            return new String(dataBuffer, charset).trim();
+        } else {
+            return getZeroTerminatedString(charset);
+        }
     }
 
     @Override
     public void setValue(String value) {
         convertStringToByteArray(value, 0, charset);
     }
-    
+
     /**
-     * This function will set value of this StringRequest to given string, but the resulting length
-     * of the byte array of the converted string will be max_size.
-     * 
+     * This function will set value of this StringRequest to given string, but the resulting length of the byte array of
+     * the converted string will be max_size.
+     *
      * @param value A string value to set.
      * @param max_size The maximum length of the byte buffer of the converted string.
      */
@@ -195,14 +202,46 @@ public void setCharset(Charset charset) {
             this.charset = charset;
         }
     }
-    
+
     /**
      * Return the charset that the {@link #getValue() } and {@link #setValue(java.lang.String)
      * } functions will use to convert to/from string/byte data buffer.
-     * 
+     *
      * @return The charset.
      */
     public Charset getCharset() {
         return this.charset;
     }
+
+    /**
+     * Return the value retrieve method used by this String data request.
+     *
+     * @return Value retrieve method.
+     */
+    public ValueRetrieveMethod getValueRetrieveMethod() {
+        return valueRetrieveMethod;
+    }
+
+    /**
+     * Sets the value retrieve method for this String data request.
+     *
+     * @param valueRetrieveMethod Value retrieve method.
+     */
+    public void setValueRetrieveMethod(ValueRetrieveMethod valueRetrieveMethod) {
+        this.valueRetrieveMethod = valueRetrieveMethod;
+    }
+
+    /**
+     * This enumeration defines values retrieve method that will be used by {@link #getValue() } method.
+     */
+    public enum ValueRetrieveMethod {
+        /**
+         * Retrieve the content of whole underlying byte buffer when converting it to String.
+         */
+        WHOLE_BUFFER,
+        /**
+         * Retrieve the content of underlying byte buffer up to first zero byte when converting it to String.
+         */
+        TO_FIRST_ZERO_BYTE
+    }
 }

FSUIPC/src/com/mouseviator/fsuipc/helpers/LuaHelper.java

@@ -547,6 +547,9 @@ private LuaResult runLuaCommandOnce(FSUIPC fsuipc, String luaProgram, int luaPar
      */
     public static class LuaControlRequest extends DataRequest implements IWriteOnlyRequest<String> {
 
+        /**
+         * This character si used to separate command and arguments when working with lua programs via FSUIPC
+         */
         public static final String COMMAND_SEPARATOR = ":";
 
         private LuaControlRequestCommand command;

FSUIPC/src/com/mouseviator/fsuipc/helpers/MacroHelper.java

@@ -380,6 +380,9 @@ public MacroResult executeMacro(String macroFile, String macroName, int macroPar
      */
     public static class MacroExecuteRequest extends DataRequest implements IWriteOnlyRequest<String> {
 
+        /**
+         * This character is used to separate macro file name and macro name when calling macro using FSUIPC
+         */
         public static final char MACRO_SEPARATOR = ':';
         private static final byte MAX_MACRO_FILE_LENGHT = 16;
         private static final byte MAX_MACRO_NAME_LENGTH = 16;

FSUIPC/version.properties

@@ -0,0 +1,16 @@
+#  Copyright 2009 Richard Nichols.
+# 
+#  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.
+#  under the License.
+
+project.version=1.0.2