Apply PR feedback

- Drop legacy function `writeBytes1()`
  #195 (comment)
- Add superfluous comment as requested
  #195 (comment)
- Also change all the other `write..` related calls to `int`
  #195 (comment)

(wip @ ff8ede7)

Author: hiddenalpha

src/main/cpp/_nix_based/jssc.cpp

@@ -60,17 +60,6 @@
 #include <jssc_SerialNativeInterface.h>
 #include "version.h"
 
-#if defined(_MSC_VER) && _MSC_VER < 1800
-#   define PRIsz "Iu"
-#   define PRIssz "Id"
-#elif defined(__MINGW32__) && !defined(__MINGW64__)
-#   define PRIsz "u"
-#   define PRIssz "d"
-#else
-#   define PRIsz "zu"
-#   define PRIssz "zd"
-#endif
-
 /*
  * Get native library version
  */
@@ -681,7 +670,7 @@ JNIEXPORT jbyteArray JNICALL Java_jssc_SerialNativeInterface_readBytes
     lpBuffer = (jbyte*)malloc(byteCount*sizeof*lpBuffer);
     if( !lpBuffer ){
         char emsg[32]; emsg[0] = '\0';
-        snprintf(emsg, sizeof emsg, "malloc(%" PRIsz ") failed", byteCount*sizeof*lpBuffer);
+        snprintf(emsg, sizeof emsg, "malloc(%zu) failed", byteCount*sizeof*lpBuffer);
         jclass exClz = env->FindClass("java/lang/RuntimeException");
         if( exClz ) env->ThrowNew(exClz, emsg);
         returnArray = NULL; goto Finally;

src/main/cpp/windows/jssc.cpp

@@ -29,15 +29,15 @@
 #include <jssc_SerialNativeInterface.h>
 #include "version.h"
 
+// For snprintf formatting
 #if defined(_MSC_VER) && _MSC_VER < 1800
 #   define PRIsz "Iu"
 #   define PRIssz "Id"
 #elif defined(__MINGW32__) && !defined(__MINGW64__)
 #   define PRIsz "u"
 #   define PRIssz "d"
 #else
-#   define PRIsz "zu"
-#   define PRIssz "zd"
+#   error "PRIsz and PRIssz definitions not configured for this target"
 #endif
 
 #define MAX_PORT_NAME_STR_LEN 32

src/main/java/jssc/SerialPort.java

@@ -398,25 +398,6 @@ public boolean setDTR(boolean enabled) throws SerialPortException {
         return serialInterface.setDTR(portHandle, enabled);
     }
 
-    /**
-     * Write byte array to port
-     *
-     * @param buffer <code>byte[]</code> array to write
-     *
-     * @return If the operation is successfully completed, the method returns true, otherwise false
-     * 
-     * @throws SerialPortException if exception occurred
-     *
-     * @deprecated use {@link #writeBytes(byte[])}.
-     */
-    @Deprecated
-    public boolean writeBytes1(byte[] buffer) throws SerialPortException {
-        /* Delegate to new method and translate result to what original method
-         * did return. */
-        int numWrittenBytes = writeBytes(buffer);
-        return numWrittenBytes == buffer.length;
-    }
-
     /**
      * Write byte array to port.
      *
@@ -440,86 +421,105 @@ public int writeBytes(byte[] buffer) throws SerialPortException {
      *
      * @param singleByte single <code>byte</code> value to write
      *
-     * @return If the operation is successfully completed, the method returns true, otherwise false
+     * @return Number of bytes written.
      *
      * @throws SerialPortException if exception occurred
      *
      * @since 0.8
      */
-    public boolean writeByte(byte singleByte) throws SerialPortException {
+    public int writeByte(byte singleByte) throws SerialPortException {
         checkPortOpened("writeByte()");
-        return writeBytes(new byte[]{singleByte}) == 1;
+        return writeBytes(new byte[]{singleByte});
     }
 
     /**
      * Write String to port
      *
      * @param string <code>String</code> value to write
      *
-     * @return If the operation is successfully completed, the method returns true, otherwise false
+     * @return
+     *      Number of bytes written. WARN: Number of BYTES, NOT number of CHARS!
+     *      This may differ from <code>string.length()</code> if passed in string
+     *      contains chars outside the english alphabeth. If you need reliable
+     *      return lengths, consider calling
+     *      {@link java.lang.String#getBytes(java.nio.charset.Charset)}
+     *      yourself and then passing result to
+     *      {@link #writeBytes(byte[])}
+     *      instead. This gives you the chance to verify the expected return
+     *      value correctly.
      *
      * @throws SerialPortException if exception occurred
      *
      * @since 0.8
      */
-    public boolean writeString(String string) throws SerialPortException {
+    public int writeString(String string) throws SerialPortException {
         checkPortOpened("writeString()");
         byte[] bytes = string.getBytes();
-        return writeBytes(bytes) == bytes.length;
+        return writeBytes(bytes);
     }
 
     /**
      * Write String to port
      *
      * @param string <code>String</code> value to write
      * @param charsetName valid <code>Charset</code> name, e.g. <code>"UTF-8"</code>
-     * @return If the operation is successfully completed, the method returns true, otherwise false
+     *
+     * @return
+     *      Number of bytes written. WARN: Number of BYTES, NOT number of CHARS!
+     *      This may differ from <code>string.length()</code> if passed in string
+     *      contains chars outside the english alphabeth. If you need reliable
+     *      return lengths, consider calling
+     *      {@link java.lang.String#getBytes(java.nio.charset.Charset)}
+     *      yourself and then passing result to
+     *      {@link #writeBytes(byte[])}
+     *      instead. This gives you the chance to verify the expected return
+     *      value correctly.
      *
      * @throws SerialPortException if exception occurred
      * @throws UnsupportedEncodingException if encoding exception occurred
      *
      * @since 2.8.0
      */
-    public boolean writeString(String string, String charsetName) throws SerialPortException, UnsupportedEncodingException {
+    public int writeString(String string, String charsetName) throws SerialPortException, UnsupportedEncodingException {
         checkPortOpened("writeString()");
         byte[] bytes = string.getBytes(charsetName);
-        return writeBytes(bytes) == bytes.length;
+        return writeBytes(bytes);
     }
 
     /**
      * Write int value (in range from 0 to 255 (0x00 - 0xFF)) to port
      *
      * @param singleInt single <code>int</code> value to write
      *
-     * @return If the operation is successfully completed, the method returns true, otherwise false
+     * @return Number of bytes written.
      *
      * @throws SerialPortException if exception occurred
      *
      * @since 0.8
      */
-    public boolean writeInt(int singleInt) throws SerialPortException {
+    public int writeInt(int singleInt) throws SerialPortException {
         checkPortOpened("writeInt()");
-        return writeBytes(new byte[]{(byte)singleInt}) == 1;
+        return writeBytes(new byte[]{(byte)singleInt});
     }
 
     /**
      * Write int array (in range from 0 to 255 (0x00 - 0xFF)) to port
      *
      * @param buffer <code>int[]</code> array to write
      *
-     * @return If the operation is successfully completed, the method returns true, otherwise false
+     * @return Number of bytes written.
      *
      * @throws SerialPortException if exception occurred
      *
      * @since 0.8
      */
-    public boolean writeIntArray(int[] buffer) throws SerialPortException {
+    public int writeIntArray(int[] buffer) throws SerialPortException {
         checkPortOpened("writeIntArray()");
         byte[] byteArray = new byte[buffer.length];
         for(int i = 0; i < buffer.length; i++){
             byteArray[i] = (byte)buffer[i];
         }
-        return writeBytes(byteArray) == byteArray.length;
+        return writeBytes(byteArray);
     }
 
     /**