]> git.mxchange.org Git - flightgear.git/blobdiff - src/Network/generic.cxx
fix a typo
[flightgear.git] / src / Network / generic.cxx
index f74c954fe60d8d149f36059e8d15ff27b299da1c..09cefa4a6a4f20087f5c1b28869c6d8b717c060a 100644 (file)
 
 
 
-FGGeneric::FGGeneric(string& config) {
+FGGeneric::FGGeneric(vector<string> tokens) : exitOnError(false)
+{
+    int configToken;
+    if (tokens[1] == "socket") {
+        configToken = 7;
+    } else if (tokens[1] == "file") {
+        configToken = 5;
+    } else {
+        configToken = 6; 
+    }
 
+    string config = tokens[ configToken ];
     string file = config+".xml";
 
     SGPath path( globals->get_fg_root() );
@@ -56,19 +66,26 @@ FGGeneric::FGGeneric(string& config) {
     SGPropertyNode root;
     try {
         readProperties(path.str(), &root);
-     } catch (const sg_exception &e) {
+    } catch (const sg_exception &e) {
         SG_LOG(SG_GENERAL, SG_ALERT,
          "Unable to load the protocol configuration file");
          return;
     }
 
-    SGPropertyNode *output = root.getNode("generic/output");
-    if (output)
-        read_config(output, _out_message);
-
-    SGPropertyNode *input = root.getNode("generic/input");
-    if (input)
-        read_config(input, _in_message);
+    if (tokens[2] == "out") {
+        SGPropertyNode *output = root.getNode("generic/output");
+        if (output) {
+            read_config(output, _out_message);
+        }
+    } else if (tokens[2] == "in") {
+        SGPropertyNode *input = root.getNode("generic/input");
+        if (input) {
+            read_config(input, _in_message);
+        }
+    } else {
+        SG_LOG(SG_GENERAL, SG_ALERT, "Unsuported protocol direction: "
+               << tokens[2]);
+    }
 }
 
 FGGeneric::~FGGeneric() {
@@ -82,7 +99,6 @@ bool FGGeneric::gen_message() {
     length = 0;
 
     double val;
-
     for (unsigned int i = 0; i < _out_message.size(); i++) {
 
         if (i > 0 && !binary_mode)
@@ -93,7 +109,11 @@ bool FGGeneric::gen_message() {
             val = _out_message[i].offset +
                   _out_message[i].prop->getIntValue() * _out_message[i].factor;
             if (binary_mode) {
-                *((int32_t*)&buf[length]) = (int32_t)val;
+                if (binary_byte_order == BYTE_ORDER_MATCHES_NETWORK_ORDER) {
+                    *((int32_t*)&buf[length]) = (int32_t)val;
+                } else {
+                    *((uint32_t*)&buf[length]) = sg_bswap_32((uint32_t)val);
+                }
                 length += sizeof(int32_t);
             } else {
                 snprintf(tmp, 255, _out_message[i].format.c_str(), (int)val);
@@ -104,19 +124,54 @@ bool FGGeneric::gen_message() {
             if (binary_mode) {
                 *((int8_t*)&buf[length])
                           = _out_message[i].prop->getBoolValue() ? true : false;
-                length += sizeof(int8_t);
+                length += 1;
             } else {
                 snprintf(tmp, 255, _out_message[i].format.c_str(),
                                    _out_message[i].prop->getBoolValue());
             }
             break;
 
+        case FG_FIXED:
+            val = _out_message[i].offset +
+                _out_message[i].prop->getFloatValue() * _out_message[i].factor;
+            if (binary_mode) {
+                int fixed = (int)(val * 65536.0f); 
+                if (binary_byte_order == BYTE_ORDER_MATCHES_NETWORK_ORDER) {
+                    *((int32_t*)&buf[length]) = (int32_t)fixed;
+                } else {
+                    *((uint32_t*)&buf[length]) = sg_bswap_32((uint32_t)val);
+                } 
+                length += sizeof(int32_t);
+            } else {
+                snprintf(tmp, 255, _out_message[i].format.c_str(), (float)val);
+            }
+            break;
+
+        case FG_FLOAT:
+            val = _out_message[i].offset +
+                _out_message[i].prop->getFloatValue() * _out_message[i].factor;
+            if (binary_mode) {
+                if (binary_byte_order == BYTE_ORDER_MATCHES_NETWORK_ORDER) {
+                    *((float*)&buf[length]) = val;
+                } else {
+                    *((float*)&buf[length]) = sg_bswap_32(*(uint32_t*)&val);
+                }
+                length += sizeof(int32_t);
+            } else {
+                snprintf(tmp, 255, _out_message[i].format.c_str(), (float)val);
+            }
+            break;
+
         case FG_DOUBLE:
             val = _out_message[i].offset +
                 _out_message[i].prop->getFloatValue() * _out_message[i].factor;
             if (binary_mode) {
-                *((double*)&buf[length]) = val;
-                length += sizeof(double);
+                if (binary_byte_order == BYTE_ORDER_MATCHES_NETWORK_ORDER) {
+                    *((double*)&buf[length]) = val;
+                } else {
+                    *((double*)&buf[length]) = sg_bswap_64(*(uint64_t*)&val);
+                }
+                length += sizeof(int64_t);
             } else {
                 snprintf(tmp, 255, _out_message[i].format.c_str(), (float)val);
             }
@@ -127,13 +182,21 @@ bool FGGeneric::gen_message() {
                 const char *strdata = _out_message[i].prop->getStringValue();
                 int strlength = strlen(strdata);
 
+                if (binary_byte_order == BYTE_ORDER_NEEDS_CONVERSION) {
+                    SG_LOG( SG_IO, SG_ALERT, "Generic protocol: "
+                            "FG_STRING will be written in host byte order.");
+                }
                 /* Format for strings is 
                  * [length as int, 4 bytes][ASCII data, length bytes]
                  */
-                *((int32_t*)&buf[length]) = strlength;
-                                length += sizeof(int32_t);
-                                strncpy(&buf[length], strdata, strlength);
-                                length += strlength; 
+                if (binary_byte_order == BYTE_ORDER_MATCHES_NETWORK_ORDER) {
+                    *((int32_t*)&buf[length]) = strlength;
+                } else {
+                    *((int32_t*)&buf[length]) = sg_bswap_32(strlength);
+                }
+                length += sizeof(int32_t);
+                strncpy(&buf[length], strdata, strlength);
+                length += strlength; 
                 /* FIXME padding for alignment? Something like: 
                  * length += (strlength % 4 > 0 ? sizeof(int32_t) - strlength % 4 : 0;
                  */
@@ -167,7 +230,11 @@ bool FGGeneric::gen_message() {
                 break;
         }
         if (binary_footer_type != FOOTER_NONE) {
-            *((int32_t*)&buf[length]) = binary_footer_value;
+            if (binary_byte_order == BYTE_ORDER_MATCHES_NETWORK_ORDER) {
+                *((int32_t*)&buf[length]) = binary_footer_value;
+            } else {
+                *((int32_t*)&buf[length]) = sg_bswap_32(binary_footer_value);
+            }
             length += sizeof(int32_t);
         }
     }
@@ -180,39 +247,105 @@ bool FGGeneric::parse_message() {
     double val;
     int i = -1;
 
-    if (binary_mode)
-        SG_LOG( SG_IO, SG_ALERT,
-                "generic protocol: binary mode input is not yet implemented.");
-        
-    while ((++i < (int)_in_message.size()) &&
-            p1 && strcmp(p1, line_separator.c_str())) {
-
-        p2 = strstr(p1, var_separator.c_str());
-        if (p2) {
-            *p2 = 0;
-            p2 += var_separator.length();
-        }
+    if (!binary_mode) {
+        while ((++i < (int)_in_message.size()) &&
+               p1 && strcmp(p1, line_separator.c_str())) {
 
-        switch (_in_message[i].type) {
-        case FG_INT:
-            val = _in_message[i].offset + atoi(p1) * _in_message[i].factor;
-            _in_message[i].prop->setIntValue((int)val);
-            break;
+            p2 = strstr(p1, var_separator.c_str());
+            if (p2) {
+                *p2 = 0;
+                p2 += var_separator.length();
+            }
 
-        case FG_BOOL:
-            _in_message[i].prop->setBoolValue( atof(p1) != 0.0 );
-            break;
+            switch (_in_message[i].type) {
+            case FG_INT:
+                val = _in_message[i].offset + atoi(p1) * _in_message[i].factor;
+                _in_message[i].prop->setIntValue((int)val);
+                break;
 
-        case FG_DOUBLE:
-            val = _in_message[i].offset + strtod(p1, 0) * _in_message[i].factor;
-            _in_message[i].prop->setFloatValue((float)val);
-            break;
+            case FG_BOOL:
+                _in_message[i].prop->setBoolValue( atof(p1) != 0.0 );
+                break;
 
-        default: // SG_STRING
-             _in_message[i].prop->setStringValue(p1);
+            case FG_FIXED:
+            case FG_DOUBLE:
+                val = _in_message[i].offset + strtod(p1, 0) * _in_message[i].factor;
+                _in_message[i].prop->setFloatValue((float)val);
+                break;
+
+            default: // SG_STRING
+                _in_message[i].prop->setStringValue(p1);
+            }
+
+            p1 = p2;
         }
+    } else {
+        /* Binary mode */
+        int64_t tmp;
+
+        while ((++i < (int)_in_message.size()) &&
+               (p1 - buf < FG_MAX_MSG_SIZE)) {
+
+            switch (_in_message[i].type) {
+            case FG_INT:
+                if (binary_byte_order == BYTE_ORDER_NEEDS_CONVERSION) {
+                    tmp = sg_bswap_32(*(int32_t *)p1);
+                } else {
+                    tmp = *(int32_t *)p1;
+                }
+                val = _in_message[i].offset +
+                  (double)tmp *
+                  _in_message[i].factor;
+                _in_message[i].prop->setIntValue((int)val);
+                p1 += sizeof(int32_t);
+                break;
+
+            case FG_BOOL:
+                _in_message[i].prop->setBoolValue( p1[0] != 0 );
+                p1 += 1;
+                break;
+
+            case FG_FIXED:
+                if (binary_byte_order == BYTE_ORDER_NEEDS_CONVERSION) {
+                    tmp = sg_bswap_32(*(int32_t *)p1);
+                } else {
+                    tmp = *(int32_t *)p1;
+                }
+                val = _in_message[i].offset +
+                  ((double)tmp / 65536.0f) * _in_message[i].factor;
+                _in_message[i].prop->setFloatValue(val);
+                p1 += sizeof(int32_t);
+                break;
 
-        p1 = p2;
+            case FG_FLOAT:
+                if (binary_byte_order == BYTE_ORDER_NEEDS_CONVERSION) {
+                    tmp = sg_bswap_32(*(int32_t *)p1);
+                } else {
+                    tmp = *(int32_t *)p1;
+                }
+                val = _in_message[i].offset +
+                  *(float *)&tmp * _in_message[i].factor;
+                _in_message[i].prop->setFloatValue(val);
+                p1 += sizeof(int32_t);
+                break;
+
+            case FG_DOUBLE:
+                if (binary_byte_order == BYTE_ORDER_NEEDS_CONVERSION) {
+                    tmp = sg_bswap_64(*(int64_t *)p1);
+                } else {
+                    tmp = *(int64_t *)p1;
+                }
+                val = _in_message[i].offset +
+                  *(double *)&tmp * _in_message[i].factor;
+                _in_message[i].prop->setDoubleValue(val);
+                p1 += sizeof(int64_t);
+                break;
+
+            default: // SG_STRING
+                SG_LOG( SG_IO, SG_ALERT, "Generic protocol: "
+                        "Ignoring unsupported binary input chunk type.");
+            }
+        }
     }
     
     return true;
@@ -256,18 +389,43 @@ bool FGGeneric::process() {
         gen_message();
         if ( ! io->write( buf, length ) ) {
             SG_LOG( SG_IO, SG_WARN, "Error writing data." );
-            return false;
+            goto error_out;
         }
     } else if ( get_direction() == SG_IO_IN ) {
-        if ( (length = io->readline( buf, FG_MAX_MSG_SIZE )) > 0 ) {
-            parse_message();
+        if (!binary_mode) {
+            if ( (length = io->readline( buf, FG_MAX_MSG_SIZE )) > 0 ) {
+                parse_message();
+            } else {
+                SG_LOG( SG_IO, SG_ALERT, "Error reading data." );
+                return false;
+            }
         } else {
-            SG_LOG( SG_IO, SG_ALERT, "Error reading data." );
-            return false;
+            if ( (length = io->read( buf, binary_record_length )) > 0 ) {
+                if (length != binary_record_length) {
+                    SG_LOG( SG_IO, SG_ALERT,
+                            "Generic protocol: Received binary "
+                            "record of unexpected size, expected: "
+                            << binary_record_length << "received: "
+                            << length);
+                } else {
+                    SG_LOG( SG_IO, SG_DEBUG,
+                           "Generic protocol: received record of " << length <<
+                           " bytes.");
+                    parse_message();
+                }
+            } else {
+                SG_LOG( SG_IO, SG_INFO,
+                        "Generic protocol: Error reading data." );
+                return false;
+            }
         }
     }
-
     return true;
+error_out:
+    if (exitOnError)
+        fgExit(1);
+    else
+        return false;
 }
 
 
@@ -341,6 +499,15 @@ FGGeneric::read_config(SGPropertyNode *root, vector<_serial_prot> &msg)
                 line_separator = line_sep_string;
     } else {
         binary_footer_type = FOOTER_NONE; // default choice
+        binary_record_length = -1;           // default choice = sizeof(representation)
+
+        // default choice is network byte order (big endian)
+        if (sgIsLittleEndian()) {
+           binary_byte_order = BYTE_ORDER_NEEDS_CONVERSION;
+        } else {
+           binary_byte_order = BYTE_ORDER_MATCHES_NETWORK_ORDER;
+        }
+
         if ( root->hasValue("binary_footer") ) {
             string footer_type = root->getStringValue("binary_footer");
             if ( footer_type == "length" )
@@ -354,8 +521,28 @@ FGGeneric::read_config(SGPropertyNode *root, vector<_serial_prot> &msg)
                        "generic protocol: Undefined generic binary protocol"
                                            "footer, using no footer.");
         }
+        if ( root->hasValue("record_length") ) {
+            binary_record_length = root->getIntValue("record_length");
+        }
+        if ( root->hasValue("byte_order") ) {
+            string byte_order = root->getStringValue("byte_order");
+            if (byte_order == "network" ) {
+                if ( sgIsLittleEndian() ) {
+                    binary_byte_order = BYTE_ORDER_NEEDS_CONVERSION;
+                } else {
+                    binary_byte_order = BYTE_ORDER_MATCHES_NETWORK_ORDER;
+                }
+            } else if ( byte_order == "host" ) {
+                binary_byte_order = BYTE_ORDER_MATCHES_NETWORK_ORDER;
+            } else {
+                SG_LOG(SG_IO, SG_ALERT,
+                       "generic protocol: Undefined generic binary protocol"
+                       "byte order, using HOST byte order.");
+            }
+        }
     }
 
+    int record_length = 0; // Only used for binary protocols.
     vector<SGPropertyNode_ptr> chunks = root->getChildren("chunk");
     for (unsigned int i = 0; i < chunks.size(); i++) {
 
@@ -370,18 +557,34 @@ FGGeneric::read_config(SGPropertyNode *root, vector<_serial_prot> &msg)
         chunk.prop = fgGetNode(node.c_str(), true);
 
         string type = chunks[i]->getStringValue("type");
-        if (type == "bool")
+        if (type == "bool") {
             chunk.type = FG_BOOL;
-        else if (type == "float")
+            record_length += 1;
+        } else if (type == "float") {
+            chunk.type = FG_FLOAT;
+            record_length += sizeof(int32_t);
+        } else if (type == "double") {
             chunk.type = FG_DOUBLE;
-        else if (type == "string")
+            record_length += sizeof(int64_t);
+        } else if (type == "fixed") {
+            chunk.type = FG_FIXED;
+            record_length += sizeof(int32_t);
+        } else if (type == "string")
             chunk.type = FG_STRING;
-        else
+        else {
             chunk.type = FG_INT;
-
+            record_length += sizeof(int32_t);
+        }
         msg.push_back(chunk);
 
     }
 
+    if (binary_record_length == -1) {
+        binary_record_length = record_length;
+    } else if (binary_record_length < record_length) {
+        SG_LOG(SG_IO, SG_ALERT,
+               "generic protocol: Requested binary record length shorter than"
+               " requested record representation.");
+        binary_record_length = record_length;
+    }
 }
-