summaryrefslogtreecommitdiff
path: root/AudioManagerUtilities/include/IAmLogger.h
blob: 4517657089aa1d3f3df2078632e2406db34940d6 (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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
/**
 * SPDX license identifier: MPL-2.0
 *
 * Copyright (C) 2015, ADIT GmbH
 *
 * \author Jens Lorenz, jlorenz@de.adit-jv.com ADIT 2015
 *
 * This file is part of GENIVI Project AudioManager.
 *
 * Contributions are licensed to the GENIVI Alliance under one or more
 * Contribution License Agreements.
 *
 * \copyright
 * This Source Code Form is subject to the terms of the
 * Mozilla Public License, v. 2.0. If a  copy of the MPL was not distributed with
 * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * \file IAmLogger.h
 * For further information see http://www.genivi.org/.
 */

#ifndef LOGGER_H_
#define LOGGER_H_

#include <pthread.h>
#include <stdint.h>
#include <sstream>
#include <vector>
#include <cassert>
#include "audiomanagertypes.h"


namespace am
{

#define DEFAULT_CONTEXT     "DEF"
#define DEFAULT_DESCRIPTION "default Context registered by DLT Logger Class"

#define DEFAULT_LOG_SERVICE static_cast<am_LogService_e>(0)

enum am_LogService_e
{
    LOG_SERVICE_DLT,
    LOG_SERVICE_STDOUT,
    LOG_SERVICE_FILE,
    LOG_SERVICE_OFF
};

enum am_LogLevel_e
{
    LL_OFF     = 0x00, /**< Log level off */
    LL_FATAL   = 0x01, /**< fatal system error */
    LL_ERROR   = 0x02, /**< error with impact to correct functionality */
    LL_WARN    = 0x03, /**< warning, correct behavior could not be ensured */
    LL_INFO    = 0x04, /**< informational */
    LL_DEBUG   = 0x05, /**< debug  */
    LL_VERBOSE = 0x06  /**< highest grade of information */
};

enum am_LogStatus_e
{
    LS_OFF = 0x00,
    LS_ON  = 0x01
};

class IAmLogContext
{
    // enable cooperation with legacy class CAmDltWrapper
    friend class CAmDltWrapper;

public:
    virtual ~IAmLogContext() {}

    /**
     * logs given loglevel and given values
     * @param loglevel
     * @param ...
     */
    template<typename... TArgs>
    void off(const TArgs & ... args)
    {
        this->log(LL_OFF, args...);
    }

    template<typename... TArgs>
    void fatal(const TArgs & ... args)
    {
        this->log(LL_FATAL, args...);
    }

    template<typename... TArgs>
    void error(const TArgs & ... args)
    {
        this->log(LL_ERROR, args...);
    }

    template<typename... TArgs>
    void warn(const TArgs & ... args)
    {
        this->log(LL_WARN, args...);
    }

    template<typename... TArgs>
    void info(const TArgs & ... args)
    {
        this->log(LL_INFO, args...);
    }

    template<typename... TArgs>
    void debug(const TArgs & ... args)
    {
        this->log(LL_DEBUG, args...);
    }

    template<typename... TArgs>
    void verbose(const TArgs & ... args)
    {
        this->log(LL_VERBOSE, args...);
    }

    template<typename... TArgs>
    void log(const am_LogLevel_e loglevel, const TArgs & ... args)
    {
        if (!this->configure(loglevel))
        {
            return;
        }

        this->append(args...);
        this->send();
    }

    virtual bool checkLogLevel(const am_LogLevel_e logLevel) = 0;

    virtual bool configure(const am_LogLevel_e loglevel) = 0;

private:
    virtual void send() = 0;

    virtual void append(const int8_t value)               = 0;
    virtual void append(const uint8_t value)              = 0;
    virtual void append(const int16_t value)              = 0;
    virtual void append(const uint16_t value)             = 0;
    virtual void append(const int32_t value)              = 0;
    virtual void append(const uint32_t value)             = 0;
    virtual void append(const uint64_t value)             = 0;
    virtual void append(const int64_t value)              = 0;
    virtual void append(const bool value)                 = 0;
    virtual void append(const std::vector<uint8_t> &data) = 0;
    virtual void append(const char *value)                = 0;

    template<typename T = std::string &>
    void append(const std::string &value)
    {
        this->append(value.c_str());
    }

    template<typename T>
    void append_enum(const T &value, const T &tmax, const std::vector<const char *> &text)
    {
        assert(tmax == text.size());
        try
        {
            this->append(text.at(value));
        }
        catch (const std::out_of_range &)
        {
            this->append(__PRETTY_FUNCTION__);
            this->append(static_cast<int32_t>(value));
            this->append("out of range!");
        }
    }

    template<typename T = am_Error_e>
    void append(const am_Error_e value)
    {
        this->append_enum(value, E_MAX, std::vector<const char *> {
                "E_OK",
                "E_UNKNOWN",
                "E_OUT_OF_RANGE",
                "E_NOT_USED",
                "E_DATABASE_ERROR",
                "E_ALREADY_EXISTS",
                "E_NO_CHANGE",
                "E_NOT_POSSIBLE",
                "E_NON_EXISTENT",
                "E_ABORTED",
                "E_WRONG_FORMAT",
                "E_COMMUNICATION"
            }
            );
    }

    template<typename T = am_SourceState_e>
    void append(const am_SourceState_e value)
    {
        this->append_enum(value, SS_MAX, std::vector<const char *> {
                "SS_UNKNNOWN",
                "SS_ON",
                "SS_OFF",
                "SS_PAUSED"
            }
            );
    }

    template<typename T = am_MuteState_e>
    void append(const am_MuteState_e value)
    {
        this->append_enum(value, MS_MAX, std::vector<const char *> {
                "MS_UNKNOWN",
                "MS_MUTED",
                "MS_UNMUTED"
            }
            );
    }

    template<typename T = am_DomainState_e>
    void append(const am_DomainState_e value)
    {
        this->append_enum(value, DS_MAX, std::vector<const char *> {
                "DS_UNKNOWN",
                "DS_CONTROLLED",
                "DS_INDEPENDENT_STARTUP",
                "DS_INDEPENDENT_RUNDOWN"
            }
            );
    }

    template<typename T = am_ConnectionState_e>
    void append(const am_ConnectionState_e value)
    {
        this->append_enum(value, CS_MAX, std::vector<const char *> {
                "CS_UNKNOWN",
                "CS_CONNECTING",
                "CS_CONNECTED",
                "CS_DISCONNECTING",
                "CS_DISCONNECTED",
                "CS_SUSPENDED"
            }
            );
    }

    template<typename T = am_Availability_e>
    void append(const am_Availability_e value)
    {
        this->append_enum(value, A_MAX, std::vector<const char *> {
                "A_UNKNOWN",
                "A_AVAILABLE",
                "A_UNAVAILABLE"
            }
            );
    }

    template<typename T = am_InterruptState_e>
    void append(const am_InterruptState_e value)
    {
        this->append_enum(value, IS_MAX, std::vector<const char *> {
                "IS_UNKNOWN",
                "IS_OFF",
                "IS_INTERRUPTED"
            }
            );
    }

    template<typename T = am_Handle_e>
    void append(const am_Handle_e value)
    {
        this->append_enum(value, H_MAX, std::vector<const char *> {
                "H_UNKNOWN",
                "H_CONNECT",
                "H_DISCONNECT",
                "H_SETSOURCESTATE",
                "H_SETSINKVOLUME",
                "H_SETSOURCEVOLUME",
                "H_SETSINKSOUNDPROPERTY",
                "H_SETSOURCESOUNDPROPERTY",
                "H_SETSINKSOUNDPROPERTIES",
                "H_SETSOURCESOUNDPROPERTIES",
                "H_CROSSFADE",
                "H_SETVOLUMES",
                "H_SETSINKNOTIFICATION",
                "H_SETSOURCENOTIFICATION"
            }
            );
    }

    template<typename T = am_Handle_s>
    void append(const am_Handle_s value)
    {
        this->append(value.handle);
        this->append(value.handleType);
    }

    // Template to print unknown pointer types with their address
    template<typename T>
    void append(T *value)
    {
        std::ostringstream ss;
        ss << "0x" << std::hex << (uint64_t)value;
        this->append(ss.str().c_str());
    }

    // Template to print unknown types
    template<typename T>
    void append(T value)
    {
        std::ostringstream ss;
        ss << std::dec << value;
        this->append(ss.str().c_str());
    }

    // Template parameter pack to generate recursive code
    void append(void) {}
    template<typename T, typename... TArgs>
    void append(const T &value, const TArgs & ... args)
    {
        this->append(value);
        this->append(args...);
    }

};

class IAmLogger
{
public:
    virtual ~IAmLogger() {}
    virtual void registerApp(const char *appid, const char *description) = 0;
    virtual void unregisterApp() = 0;
    virtual IAmLogContext &registerContext(const char *contextid, const char *description) = 0;
    virtual IAmLogContext &registerContext(const char *contextid, const char *description,
        const am_LogLevel_e level, const am_LogStatus_e status) = 0;
    virtual IAmLogContext &importContext(const char *contextid = NULL) = 0;
    virtual void unregisterContext(const char *contextid)      = 0;

    template<typename T, typename... TArgs>
    void logToDefaultContext(const am_LogLevel_e loglevel, const T &value, const TArgs & ... args)
    {
        this->importContext().log(loglevel, value, args...);
    }

};

}

#endif // LOGGER_H_