summaryrefslogtreecommitdiff
path: root/digital/ucoolib/ucoolib/base/proto/proto.hh
blob: 3ac4d1d1c40c2fb6e172bda03031775318c19f83 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
#ifndef ucoolib_base_proto_proto_hh
#define ucoolib_base_proto_proto_hh
// ucoolib - Microcontroller object oriented library. {{{
//
// Copyright (C) 2013 Nicolas Schodet
//
// APBTeam:
//        Web: http://apbteam.org/
//      Email: team AT apbteam DOT org
//
// 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 2 of the License, or
// (at your option) any later version.
//
// 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.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// }}}
#include "ucoolib/common.hh"
#include "ucoolib/intf/stream.hh"

#include "config/base/proto.hh"

namespace ucoo {

/// Support for old proto protocol.
class Proto
{
  public:
    /// Receivers should implement this interface.
    class Handler
    {
      public:
        /// Handle a received message.
        virtual void proto_handle (Proto &proto, char cmd,
                                   const uint8_t *args, int size) = 0;
    };
  public:
    /// Constructor.
    Proto (Handler &handler, Stream &stream);
    /// Read from stream and handle any received message.
    void accept ();
    /// Send a message with no argument.
    void send (char cmd);
    /// Send a message with one argument.
    void send (char cmd, const char *fmt, int a0);
    /// Send a message with two arguments.
    void send (char cmd, const char *fmt, int a0, int a1);
    /// Send a message with three arguments.
    void send (char cmd, const char *fmt, int a0, int a1, int a2);
    /// Send a message with four arguments.
    void send (char cmd, const char *fmt, int a0, int a1, int a2, int a3);
    /// Send a message, with a byte buffer.
    void send_buf (char cmd, const uint8_t *args, int size);
  private:
    /// Accept a digit to be used for args.
    void accept_digit (int c);
    /// Accept a quoted char to be used for args.
    void accept_char (int c);
  private:
    /// Handler interface.
    Handler &handler_;
    /// Connected stream.
    Stream &stream_;
    /// Decoding step.
    enum Step
    {
        /// Nothing received yet.
        IDLE,
        /// Exclamation mark received.
        BANG,
        /// Expecting argument or end of frame.
        COMMAND,
        /// Expecting second hex digit of an argument.
        ARG_DIGIT,
        /// Quote received, expect any char.
        ARG_CHAR,
        /// Double quote received, read a string.
        ARG_STRING,
    };
    Step step_;
    /// Received message current size.
    int size_;
    /// Message arguments being received.
    uint8_t args_[UCOO_CONFIG_BASE_PROTO_ARGS_MAX_SIZE];
    /// Command being received.
    char cmd_;
};

} // namespace ucoo

#endif // ucoolib_base_proto_proto_hh