]> git.mxchange.org Git - flightgear.git/blob - src/Network/generic.cxx
Quick fix for ascii generic input line separator problem
[flightgear.git] / src / Network / generic.cxx
1 // generic.cxx -- generic protocal class
2 //
3 // Written by Curtis Olson, started November 1999.
4 //
5 // Copyright (C) 1999  Curtis L. Olson - http://www.flightgear.org/~curt
6 //
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
11 //
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15 // General Public License for more details.
16 //
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
20 //
21 // $Id$
22
23 #ifdef HAVE_CONFIG_H
24 #  include "config.h"
25 #endif
26
27 #include <string.h>                // strstr()
28 #include <stdlib.h>                // strtod(), atoi()
29
30 #include <simgear/debug/logstream.hxx>
31 #include <simgear/io/iochannel.hxx>
32 #include <simgear/structure/exception.hxx>
33 #include <simgear/misc/sg_path.hxx>
34 #include <simgear/misc/stdint.hxx>
35 #include <simgear/props/props.hxx>
36 #include <simgear/props/props_io.hxx>
37
38 #include <Main/globals.hxx>
39 #include <Main/fg_props.hxx>
40 #include <Main/fg_os.hxx>
41 #include <Main/util.hxx>
42 #include "generic.hxx"
43
44
45
46 FGGeneric::FGGeneric(vector<string> tokens) : exitOnError(false)
47 {
48     size_t configToken;
49     if (tokens[1] == "socket") {
50         configToken = 7;
51     } else if (tokens[1] == "file") {
52         configToken = 5;
53     } else {
54         configToken = 6; 
55     }
56
57     if (configToken >= tokens.size()) {
58        SG_LOG(SG_GENERAL, SG_ALERT,
59               "Not enough tokens passed for generic protocol");
60        return;
61     }
62
63     string config = tokens[ configToken ];
64     file_name = config+".xml";
65     direction = tokens[2];
66
67     if (direction != "in" && direction != "out") {
68         SG_LOG(SG_GENERAL, SG_ALERT, "Unsuported protocol direction: "
69                << direction);
70     }
71
72     reinit();
73 }
74
75 FGGeneric::~FGGeneric() {
76 }
77
78 union u32 {
79     uint32_t intVal;
80     float floatVal;
81 };
82
83 union u64 {
84     uint64_t longVal;
85     double doubleVal;
86 };
87
88 // generate the message
89 bool FGGeneric::gen_message_binary() {
90     string generic_sentence;
91     length = 0;
92
93     double val;
94     for (unsigned int i = 0; i < _out_message.size(); i++) {
95
96         switch (_out_message[i].type) {
97         case FG_INT:
98         {
99             val = _out_message[i].offset +
100                   _out_message[i].prop->getIntValue() * _out_message[i].factor;
101             int32_t intVal = val;
102             if (binary_byte_order != BYTE_ORDER_MATCHES_NETWORK_ORDER) {
103                 intVal = (int32_t) sg_bswap_32((uint32_t)intVal);
104             }
105             memcpy(&buf[length], &intVal, sizeof(int32_t));
106             length += sizeof(int32_t);
107             break;
108         }
109
110         case FG_BOOL:
111             buf[length] = (char) (_out_message[i].prop->getBoolValue() ? true : false);
112             length += 1;
113             break;
114
115         case FG_FIXED:
116         {
117             val = _out_message[i].offset +
118                  _out_message[i].prop->getFloatValue() * _out_message[i].factor;
119
120             int32_t fixed = (int)(val * 65536.0f);
121             if (binary_byte_order != BYTE_ORDER_MATCHES_NETWORK_ORDER) {
122                 fixed = (int32_t) sg_bswap_32((uint32_t)fixed);
123             } 
124             memcpy(&buf[length], &fixed, sizeof(int32_t));
125             length += sizeof(int32_t);
126             break;
127         }
128
129         case FG_FLOAT:
130         {
131             val = _out_message[i].offset +
132                  _out_message[i].prop->getFloatValue() * _out_message[i].factor;
133             u32 tmpun32;
134             tmpun32.floatVal = static_cast<float>(val);
135
136             if (binary_byte_order != BYTE_ORDER_MATCHES_NETWORK_ORDER) {
137                 tmpun32.intVal = sg_bswap_32(tmpun32.intVal);
138             }
139             memcpy(&buf[length], &tmpun32.intVal, sizeof(uint32_t));
140             length += sizeof(uint32_t);
141             break;
142         }
143
144         case FG_DOUBLE:
145         {
146             val = _out_message[i].offset +
147                  _out_message[i].prop->getFloatValue() * _out_message[i].factor;
148             u64 tmpun64;
149             tmpun64.doubleVal = val;
150
151             if (binary_byte_order != BYTE_ORDER_MATCHES_NETWORK_ORDER) {
152                 tmpun64.longVal = sg_bswap_64(tmpun64.longVal);
153             }
154             memcpy(&buf[length], &tmpun64.longVal, sizeof(uint64_t));
155             length += sizeof(uint64_t);
156             break;
157         }
158
159         default: // SG_STRING
160             const char *strdata = _out_message[i].prop->getStringValue();
161             int32_t strlength = strlen(strdata);
162
163             if (binary_byte_order == BYTE_ORDER_NEEDS_CONVERSION) {
164                 SG_LOG( SG_IO, SG_ALERT, "Generic protocol: "
165                         "FG_STRING will be written in host byte order.");
166             }
167             /* Format for strings is 
168              * [length as int, 4 bytes][ASCII data, length bytes]
169              */
170             if (binary_byte_order != BYTE_ORDER_MATCHES_NETWORK_ORDER) {
171                 strlength = sg_bswap_32(strlength);
172             }
173             memcpy(&buf[length], &strlength, sizeof(int32_t));
174             length += sizeof(int32_t);
175             strncpy(&buf[length], strdata, strlength);
176             length += strlength; 
177             /* FIXME padding for alignment? Something like: 
178              * length += (strlength % 4 > 0 ? sizeof(int32_t) - strlength % 4 : 0;
179              */
180         }
181     }
182
183     // add the footer to the packet ("line")
184     switch (binary_footer_type) {
185         case FOOTER_LENGTH:
186             binary_footer_value = length;
187             break;
188
189         case FOOTER_MAGIC:
190         case FOOTER_NONE:
191             break;
192     }
193
194     if (binary_footer_type != FOOTER_NONE) {
195         int32_t intValue = binary_footer_value;
196         if (binary_byte_order != BYTE_ORDER_MATCHES_NETWORK_ORDER) {
197             intValue = sg_bswap_32(binary_footer_value);
198         }
199         memcpy(&buf[length], &intValue, sizeof(int32_t));
200         length += sizeof(int32_t);
201     }
202
203     return true;
204 }
205
206 bool FGGeneric::gen_message_ascii() {
207     string generic_sentence;
208     char tmp[255];
209     length = 0;
210
211     double val;
212     for (unsigned int i = 0; i < _out_message.size(); i++) {
213
214         if (i > 0) {
215             generic_sentence += var_separator;
216         }
217
218         switch (_out_message[i].type) {
219         case FG_INT:
220             val = _out_message[i].offset +
221                   _out_message[i].prop->getIntValue() * _out_message[i].factor;
222             snprintf(tmp, 255, _out_message[i].format.c_str(), (int)val);
223             break;
224
225         case FG_BOOL:
226             snprintf(tmp, 255, _out_message[i].format.c_str(),
227                                _out_message[i].prop->getBoolValue());
228             break;
229
230         case FG_FIXED:
231             val = _out_message[i].offset +
232                 _out_message[i].prop->getFloatValue() * _out_message[i].factor;
233             snprintf(tmp, 255, _out_message[i].format.c_str(), (float)val);
234             break;
235
236         case FG_FLOAT:
237             val = _out_message[i].offset +
238                 _out_message[i].prop->getFloatValue() * _out_message[i].factor;
239             snprintf(tmp, 255, _out_message[i].format.c_str(), (float)val);
240             break;
241
242         case FG_DOUBLE:
243             val = _out_message[i].offset +
244                 _out_message[i].prop->getDoubleValue() * _out_message[i].factor;
245             snprintf(tmp, 255, _out_message[i].format.c_str(), (double)val);
246             break;
247
248         default: // SG_STRING
249             snprintf(tmp, 255, _out_message[i].format.c_str(),
250                                    _out_message[i].prop->getStringValue());
251         }
252
253         generic_sentence += tmp;
254     }
255
256     /* After each lot of variables has been added, put the line separator
257      * char/string
258      */
259     generic_sentence += line_separator;
260
261     length =  generic_sentence.length();
262     strncpy( buf, generic_sentence.c_str(), length );
263
264     return true;
265 }
266
267 bool FGGeneric::gen_message() {
268     if (binary_mode) {
269         return gen_message_binary();
270     } else {
271         return gen_message_ascii();
272     }
273 }
274
275 bool FGGeneric::parse_message_binary(int length) {
276     char *p2, *p1 = buf;
277     int32_t tmp32;
278     double val;
279     int i = -1;
280
281     p2 = p1 + length;
282     while ((++i < (int)_in_message.size()) && (p1  < p2)) {
283
284         switch (_in_message[i].type) {
285         case FG_INT:
286             if (binary_byte_order == BYTE_ORDER_NEEDS_CONVERSION) {
287                 tmp32 = sg_bswap_32(*(int32_t *)p1);
288             } else {
289                 tmp32 = *(int32_t *)p1;
290             }
291
292             val = _in_message[i].offset + (double)tmp32 * _in_message[i].factor;
293
294             _in_message[i].prop->setIntValue((int)val);
295             p1 += sizeof(int32_t);
296             break;
297
298         case FG_BOOL:
299             _in_message[i].prop->setBoolValue( p1[0] != 0 );
300             p1 += 1;
301             break;
302
303         case FG_FIXED:
304             if (binary_byte_order == BYTE_ORDER_NEEDS_CONVERSION) {
305                 tmp32 = sg_bswap_32(*(int32_t *)p1);
306             } else {
307                 tmp32 = *(int32_t *)p1;
308             }
309
310             val = _in_message[i].offset +
311                   ((double)tmp32 / 65536.0f) * _in_message[i].factor;
312
313             _in_message[i].prop->setFloatValue(val);
314             p1 += sizeof(int32_t);
315             break;
316
317         case FG_FLOAT:
318             u32 tmpun32;
319             if (binary_byte_order == BYTE_ORDER_NEEDS_CONVERSION) {
320                 tmpun32.intVal = sg_bswap_32(*(uint32_t *)p1);
321             } else {
322                 tmpun32.floatVal = *(float *)p1;
323             }
324
325             val = _in_message[i].offset +
326                   tmpun32.floatVal * _in_message[i].factor;
327
328             _in_message[i].prop->setFloatValue(val);
329             p1 += sizeof(int32_t);
330             break;
331
332         case FG_DOUBLE:
333             u64 tmpun64;
334             if (binary_byte_order == BYTE_ORDER_NEEDS_CONVERSION) {
335                 tmpun64.longVal = sg_bswap_64(*(uint64_t *)p1);
336             } else {
337                 tmpun64.doubleVal = *(double *)p1;
338             }
339
340             val = _in_message[i].offset +
341                    tmpun64.doubleVal * _in_message[i].factor;
342
343             _in_message[i].prop->setDoubleValue(val);
344             p1 += sizeof(int64_t);
345             break;
346
347         default: // SG_STRING
348             SG_LOG( SG_IO, SG_ALERT, "Generic protocol: "
349                     "Ignoring unsupported binary input chunk type.");
350         }
351     }
352     
353     return true;
354 }
355
356 bool FGGeneric::parse_message_ascii(int length) {
357     char *p2, *p1 = buf;
358     double val;
359     int i = -1;
360     int chunks = _in_message.size();
361     int line_separator_size = line_separator.size();
362
363     if (length < line_separator_size ||
364         line_separator.compare(buf + length - line_separator_size) != 0) {
365
366         SG_LOG(SG_IO, SG_WARN,
367                "Input line does not end with expected line separator." );
368     } else {
369         buf[length - line_separator_size] = 0;
370     }
371
372     while ((++i < chunks) && p1) {
373         p2 = strstr(p1, var_separator.c_str());
374         if (p2) {
375             *p2 = 0;
376             p2 += var_separator.length();
377         }
378
379         switch (_in_message[i].type) {
380         case FG_INT:
381             val = _in_message[i].offset + atoi(p1) * _in_message[i].factor;
382             _in_message[i].prop->setIntValue((int)val);
383             break;
384
385         case FG_BOOL:
386             _in_message[i].prop->setBoolValue( atof(p1) != 0.0 );
387             break;
388
389         case FG_FIXED:
390         case FG_FLOAT:
391             val = _in_message[i].offset + strtod(p1, 0) * _in_message[i].factor;
392             _in_message[i].prop->setFloatValue((float)val);
393             break;
394
395         case FG_DOUBLE:
396             val = _in_message[i].offset + strtod(p1, 0) * _in_message[i].factor;
397             _in_message[i].prop->setDoubleValue(val);
398             break;
399
400         default: // SG_STRING
401             _in_message[i].prop->setStringValue(p1);
402         }
403
404         p1 = p2;
405     }
406
407     return true;
408 }
409
410 bool FGGeneric::parse_message(int length) {
411     if (binary_mode) {
412         return parse_message_binary(length);
413     } else {
414         return parse_message_ascii(length);
415     }
416 }
417
418
419 // open hailing frequencies
420 bool FGGeneric::open() {
421     if ( is_enabled() ) {
422         SG_LOG( SG_IO, SG_ALERT, "This shouldn't happen, but the channel " 
423                 << "is already in use, ignoring" );
424         return false;
425     }
426
427     SGIOChannel *io = get_io_channel();
428
429     if ( ! io->open( get_direction() ) ) {
430         SG_LOG( SG_IO, SG_ALERT, "Error opening channel communication layer." );
431         return false;
432     }
433
434     set_enabled( true );
435
436     if ( get_direction() == SG_IO_OUT && ! preamble.empty() ) {
437         if ( ! io->write( preamble.c_str(), preamble.size() ) ) {
438             SG_LOG( SG_IO, SG_WARN, "Error writing preamble." );
439             return false;
440         }
441     }
442
443     return true;
444 }
445
446
447 // process work for this port
448 bool FGGeneric::process() {
449     SGIOChannel *io = get_io_channel();
450
451     if ( get_direction() == SG_IO_OUT ) {
452         gen_message();
453         if ( ! io->write( buf, length ) ) {
454             SG_LOG( SG_IO, SG_WARN, "Error writing data." );
455             goto error_out;
456         }
457     } else if ( get_direction() == SG_IO_IN ) {
458         if ( io->get_type() == sgFileType ) {
459             if (!binary_mode) {
460                 length = io->readline( buf, FG_MAX_MSG_SIZE );
461                 if ( length > 0 ) {
462                     parse_message( length );
463                 } else {
464                     SG_LOG( SG_IO, SG_ALERT, "Error reading data." );
465                     return false;
466                 }
467             } else {
468                 length = io->read( buf, binary_record_length );
469                 if ( length == binary_record_length ) {
470                     parse_message( length );
471                 } else {
472                     SG_LOG( SG_IO, SG_ALERT,
473                             "Generic protocol: Received binary "
474                             "record of unexpected size, expected: "
475                             << binary_record_length << " but received: "
476                             << length);
477                 }
478             }
479         } else {
480             if (!binary_mode) {
481                 while ((length = io->readline( buf, FG_MAX_MSG_SIZE )) > 0 ) {
482                     parse_message( length );
483                 }
484             } else {
485                 while ((length = io->read( buf, binary_record_length )) 
486                           == binary_record_length ) {
487                     parse_message( length );
488                 }
489
490                 if ( length > 0 ) {
491                     SG_LOG( SG_IO, SG_ALERT,
492                         "Generic protocol: Received binary "
493                         "record of unexpected size, expected: "
494                         << binary_record_length << " but received: "
495                         << length);
496                 }
497             }
498         }
499     }
500     return true;
501 error_out:
502     if (exitOnError) {
503         fgOSExit(1);
504         return true; // should not get there, but please the compiler
505     } else
506         return false;
507 }
508
509
510 // close the channel
511 bool FGGeneric::close() {
512     SGIOChannel *io = get_io_channel();
513
514     if ( get_direction() == SG_IO_OUT && ! postamble.empty() ) {
515         if ( ! io->write( postamble.c_str(), postamble.size() ) ) {
516             SG_LOG( SG_IO, SG_ALERT, "Error writing postamble." );
517             return false;
518         }
519     }
520
521     set_enabled( false );
522
523     if ( ! io->close() ) {
524         return false;
525     }
526
527     return true;
528 }
529
530
531 void
532 FGGeneric::reinit()
533 {
534     SGPath path( globals->get_fg_root() );
535     path.append("Protocol");
536     path.append(file_name.c_str());
537
538     SG_LOG(SG_GENERAL, SG_INFO, "Reading communication protocol from "
539                                 << path.str());
540
541     SGPropertyNode root;
542     try {
543         readProperties(path.str(), &root);
544     } catch (const sg_exception &) {
545         SG_LOG(SG_GENERAL, SG_ALERT,
546          "Unable to load the protocol configuration file");
547          return;
548     }
549
550     if (direction == "out") {
551         SGPropertyNode *output = root.getNode("generic/output");
552         if (output) {
553             _out_message.clear();
554             read_config(output, _out_message);
555         }
556     } else if (direction == "in") {
557         SGPropertyNode *input = root.getNode("generic/input");
558         if (input) {
559             _in_message.clear();
560             read_config(input, _in_message);
561             if (!binary_mode && (line_separator.size() == 0 ||
562                 *line_separator.rbegin() != '\n')) {
563
564                 SG_LOG(SG_IO, SG_WARN,
565                     "Warning: Appending newline to line separator in generic input.");
566                 line_separator.push_back('\n');
567             }
568         }
569     }
570 }
571
572
573 void
574 FGGeneric::read_config(SGPropertyNode *root, vector<_serial_prot> &msg)
575 {
576     binary_mode = root->getBoolValue("binary_mode");
577
578     if (!binary_mode) {
579         /* These variables specified in the $FG_ROOT/data/Protocol/xxx.xml
580          * file for each format
581          *
582          * var_sep_string  = the string/charachter to place between variables
583          * line_sep_string = the string/charachter to place at the end of each
584          *                   lot of variables
585          */
586         preamble = fgUnescape(root->getStringValue("preamble"));
587         postamble = fgUnescape(root->getStringValue("postamble"));
588         var_sep_string = fgUnescape(root->getStringValue("var_separator"));
589         line_sep_string = fgUnescape(root->getStringValue("line_separator"));
590
591         if ( var_sep_string == "newline" ) {
592             var_separator = '\n';
593         } else if ( var_sep_string == "tab" ) {
594             var_separator = '\t';
595         } else if ( var_sep_string == "space" ) {
596             var_separator = ' ';
597         } else if ( var_sep_string == "formfeed" ) {
598             var_separator = '\f';
599         } else if ( var_sep_string == "carriagereturn" ) {
600             var_sep_string = '\r';
601         } else if ( var_sep_string == "verticaltab" ) {
602             var_separator = '\v';
603         } else {
604             var_separator = var_sep_string;
605         }
606
607         if ( line_sep_string == "newline" ) {
608             line_separator = '\n';
609         } else if ( line_sep_string == "tab" ) {
610             line_separator = '\t';
611         } else if ( line_sep_string == "space" ) {
612             line_separator = ' ';
613         } else if ( line_sep_string == "formfeed" ) {
614             line_separator = '\f';
615         } else if ( line_sep_string == "carriagereturn" ) {
616             line_separator = '\r';
617         } else if ( line_sep_string == "verticaltab" ) {
618             line_separator = '\v';
619         } else {
620             line_separator = line_sep_string;
621         }
622     } else {
623         // default values: no footer and record_length = sizeof(representation)
624         binary_footer_type = FOOTER_NONE;
625         binary_record_length = -1;
626
627         // default choice is network byte order (big endian)
628         if (sgIsLittleEndian()) {
629            binary_byte_order = BYTE_ORDER_NEEDS_CONVERSION;
630         } else {
631            binary_byte_order = BYTE_ORDER_MATCHES_NETWORK_ORDER;
632         }
633
634         if ( root->hasValue("binary_footer") ) {
635             string footer_type = root->getStringValue("binary_footer");
636             if ( footer_type == "length" ) {
637                 binary_footer_type = FOOTER_LENGTH;
638             } else if ( footer_type.substr(0, 5) == "magic" ) {
639                 binary_footer_type = FOOTER_MAGIC;
640                 binary_footer_value = strtol(footer_type.substr(6, 
641                             footer_type.length() - 6).c_str(), (char**)0, 0);
642             } else if ( footer_type != "none" ) {
643                 SG_LOG(SG_IO, SG_ALERT,
644                        "generic protocol: Unknown generic binary protocol "
645                        "footer '" << footer_type << "', using no footer.");
646             }
647         }
648
649         if ( root->hasValue("record_length") ) {
650             binary_record_length = root->getIntValue("record_length");
651         }
652
653         if ( root->hasValue("byte_order") ) {
654             string byte_order = root->getStringValue("byte_order");
655             if (byte_order == "network" ) {
656                 if ( sgIsLittleEndian() ) {
657                     binary_byte_order = BYTE_ORDER_NEEDS_CONVERSION;
658                 } else {
659                     binary_byte_order = BYTE_ORDER_MATCHES_NETWORK_ORDER;
660                 }
661             } else if ( byte_order == "host" ) {
662                 binary_byte_order = BYTE_ORDER_MATCHES_NETWORK_ORDER;
663             } else {
664                 SG_LOG(SG_IO, SG_ALERT,
665                        "generic protocol: Undefined generic binary protocol"
666                        "byte order, using HOST byte order.");
667             }
668         }
669     }
670
671     int record_length = 0; // Only used for binary protocols.
672     vector<SGPropertyNode_ptr> chunks = root->getChildren("chunk");
673     for (unsigned int i = 0; i < chunks.size(); i++) {
674
675         _serial_prot chunk;
676
677         // chunk.name = chunks[i]->getStringValue("name");
678         chunk.format = fgUnescape(chunks[i]->getStringValue("format", "%d"));
679         chunk.offset = chunks[i]->getDoubleValue("offset");
680         chunk.factor = chunks[i]->getDoubleValue("factor", 1.0);
681
682         string node = chunks[i]->getStringValue("node", "/null");
683         chunk.prop = fgGetNode(node.c_str(), true);
684
685         string type = chunks[i]->getStringValue("type");
686
687         // Note: officially the type is called 'bool' but for backward
688         //       compatibility 'boolean' will also be supported.
689         if (type == "bool" || type == "boolean") {
690             chunk.type = FG_BOOL;
691             record_length += 1;
692         } else if (type == "float") {
693             chunk.type = FG_FLOAT;
694             record_length += sizeof(int32_t);
695         } else if (type == "double") {
696             chunk.type = FG_DOUBLE;
697             record_length += sizeof(int64_t);
698         } else if (type == "fixed") {
699             chunk.type = FG_FIXED;
700             record_length += sizeof(int32_t);
701         } else if (type == "string")
702             chunk.type = FG_STRING;
703         else {
704             chunk.type = FG_INT;
705             record_length += sizeof(int32_t);
706         }
707         msg.push_back(chunk);
708
709     }
710
711     if( binary_mode ) {
712         if (binary_record_length == -1) {
713             binary_record_length = record_length;
714         } else if (binary_record_length < record_length) {
715             SG_LOG(SG_IO, SG_ALERT,
716                    "generic protocol: Requested binary record length shorter than "
717                    " requested record representation.");
718             binary_record_length = record_length;
719         }
720     }
721 }