Petras Saduikis
DebugTrace provides the facilities to dump debug output to either serial or a log file, and to turn it on/off as required. Now supports fully supports printf style logging and creates a running backup log. 03/01/2010 - Potential memory leak fixed.
DebugTrace.h@0:153a2086d828, 2010-01-03 (annotated)
- Committer:
- snatch59
- Date:
- Sun Jan 03 11:51:51 2010 +0000
- Revision:
- 0:153a2086d828
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| snatch59 | 0:153a2086d828 | 1 | /* |
| snatch59 | 0:153a2086d828 | 2 | * DebugTrace. Allows dumping debug messages/values to serial or |
| snatch59 | 0:153a2086d828 | 3 | * to file. |
| snatch59 | 0:153a2086d828 | 4 | * |
| snatch59 | 0:153a2086d828 | 5 | * Copyright (C) <2009> Petras Saduikis <petras@petras.co.uk> |
| snatch59 | 0:153a2086d828 | 6 | * |
| snatch59 | 0:153a2086d828 | 7 | * This file is part of DebugTrace. |
| snatch59 | 0:153a2086d828 | 8 | * |
| snatch59 | 0:153a2086d828 | 9 | * DebugTrace is free software: you can redistribute it and/or modify |
| snatch59 | 0:153a2086d828 | 10 | * it under the terms of the GNU General Public License as published by |
| snatch59 | 0:153a2086d828 | 11 | * the Free Software Foundation, either version 3 of the License, or |
| snatch59 | 0:153a2086d828 | 12 | * (at your option) any later version. |
| snatch59 | 0:153a2086d828 | 13 | * |
| snatch59 | 0:153a2086d828 | 14 | * DebugTrace is distributed in the hope that it will be useful, |
| snatch59 | 0:153a2086d828 | 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| snatch59 | 0:153a2086d828 | 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| snatch59 | 0:153a2086d828 | 17 | * GNU General Public License for more details. |
| snatch59 | 0:153a2086d828 | 18 | * |
| snatch59 | 0:153a2086d828 | 19 | * You should have received a copy of the GNU General Public License |
| snatch59 | 0:153a2086d828 | 20 | * along with DebugTrace. If not, see <http://www.gnu.org/licenses/>. |
| snatch59 | 0:153a2086d828 | 21 | */ |
| snatch59 | 0:153a2086d828 | 22 | |
| snatch59 | 0:153a2086d828 | 23 | #ifndef SNATCH59_DEBUGTRACE_H |
| snatch59 | 0:153a2086d828 | 24 | #define SNATCH59_DEBUGTRACE_H |
| snatch59 | 0:153a2086d828 | 25 | |
| snatch59 | 0:153a2086d828 | 26 | enum eLog {OFF, ON}; |
| snatch59 | 0:153a2086d828 | 27 | enum eLogTarget {TO_SERIAL, TO_FILE}; |
| snatch59 | 0:153a2086d828 | 28 | |
| snatch59 | 0:153a2086d828 | 29 | class DebugTrace |
| snatch59 | 0:153a2086d828 | 30 | { |
| snatch59 | 0:153a2086d828 | 31 | public: |
| snatch59 | 0:153a2086d828 | 32 | DebugTrace(eLog on, eLogTarget mode, const char* fileName = "log.txt", const int maxSize = 1024); |
| snatch59 | 0:153a2086d828 | 33 | ~DebugTrace(); |
| snatch59 | 0:153a2086d828 | 34 | |
| snatch59 | 0:153a2086d828 | 35 | void clear(); |
| snatch59 | 0:153a2086d828 | 36 | void traceOut(const char* fmt, ...); |
| snatch59 | 0:153a2086d828 | 37 | |
| snatch59 | 0:153a2086d828 | 38 | private: |
| snatch59 | 0:153a2086d828 | 39 | eLog enabled; |
| snatch59 | 0:153a2086d828 | 40 | eLogTarget logMode; |
| snatch59 | 0:153a2086d828 | 41 | int maxFileSize; |
| snatch59 | 0:153a2086d828 | 42 | int currentFileSize; |
| snatch59 | 0:153a2086d828 | 43 | char* logFile; |
| snatch59 | 0:153a2086d828 | 44 | char* logFileBackup; |
| snatch59 | 0:153a2086d828 | 45 | int logFileStatus; // if things go wrong, don't write any more data to file |
| snatch59 | 0:153a2086d828 | 46 | |
| snatch59 | 0:153a2086d828 | 47 | void backupLog(); |
| snatch59 | 0:153a2086d828 | 48 | }; |
| snatch59 | 0:153a2086d828 | 49 | |
| snatch59 | 0:153a2086d828 | 50 | #endif |