-
Notifications
You must be signed in to change notification settings - Fork 82
/
DebugEngine.h
executable file
·134 lines (122 loc) · 5.06 KB
/
DebugEngine.h
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
/** \file DebugEngine.h
\brief Define the class for the debug
\author alpha_one_x86
\note This class don't need be thread safe because ultracopier is done with one thread, but I have implement some basic thread protection
\licence GPL3, see the file COPYING */
#ifndef DEBUG_ENGINE_H
#define DEBUG_ENGINE_H
#include <QObject>
#include <QString>
#include <string>
#include <QFile>
#include <QMutex>
#include <QTimer>
#include <QElapsedTimer>
#include <QList>
#include <QCoreApplication>
#include <QAbstractTableModel>
#include <QRegularExpression>
#include <regex>
#include "Variable.h"
#include "PlatformMacro.h"
#include "StructEnumDefinition.h"
#include "StructEnumDefinition_UltracopierSpecific.h"
#ifdef ULTRACOPIER_DEBUG
class DebugModel : public QAbstractTableModel
{
Q_OBJECT
public:
/// \brief the transfer item displayed
struct DebugItem
{
unsigned int time;
DebugLevel_custom level;
std::string function;
std::string text;
std::string file;
std::string location;
};
static DebugModel *debugModel;
DebugModel();
~DebugModel();
virtual int columnCount(const QModelIndex& parent = QModelIndex()) const;
virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const;
virtual int rowCount(const QModelIndex& parent = QModelIndex()) const;
virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const;
virtual bool setData(const QModelIndex&, const QVariant&, int = Qt::EditRole);
void addDebugInformation(const int &time, const DebugLevel_custom &level, const std::string& function, const std::string& text, const std::string &file="", const unsigned int& ligne=0, const std::string& location="Core");
void setupTheTimer();
QString toString();
QTimer *updateDisplayTimer;
bool displayed;
bool inWaitOfDisplay;
private:
std::vector<DebugItem> list;
private slots:
void updateDisplay();
};
/** \brief Define the class for the debug
This class provide all needed for the debug mode of ultracopier */
class DebugEngine : public QObject
{
Q_OBJECT
public:
/// \brief Initiate the ultracopier event dispatcher and check if no other session is running
DebugEngine();
/** \brief Destroy the ultracopier event dispatcher
\note This function is thread safe */
~DebugEngine();
/** \brief Get the html text info for re-show it
\note This function is thread safe */
std::string getTheDebugHtml();
/// \brief Enumeration of backend
enum Backend
{
Memory, //Do intensive usage of memory, used only if the file backend is not available
File //Store all directly into file, at crash the backtrace is into the file
};
/// \brief return the current backend
Backend getCurrentBackend();
/// \brief Get the html end
std::string getTheDebugEnd();
/** \brief For add message info, this function
\note This function is reentrant */
static std::string debugInformationToHtml(const unsigned int &t,const DebugLevel_custom &level, const std::string& fonction, const std::string& text, std::string file="", const int& ligne=-1, const std::string& location="Core");
static void addDebugInformationStatic(const Ultracopier::DebugLevel &level,const std::string& function,const std::string& text,const std::string& file="",const int& ligne=-1,const std::string& location="Core");
static void addDebugNote(const std::string& text);
static DebugEngine *debugEngine;
public slots:
/** \brief ask to the user where save the bug report
\warning This function can be only call by the graphical thread */
void saveBugReport();
void addDebugInformation(const DebugLevel_custom &level,const std::string& fonction,const std::string& text,std::string file="",const int& ligne=-1,const std::string& location="Core");
private:
/// \brief Path for log file
QFile logFile;
/// \brief Path for lock file
QFile lockFile;
/// \brief Internal function to remove the lock file
bool removeTheLockFile();
/** \brief Do thread safe part for the addDebugInformation()
\see addDebugInformation() */
QMutex mutex;
QMutex mutexList;
/// \brief For record the start time
QElapsedTimer startTime;
/// \brief String for the end of log file
std::string endOfLogFile;
/// \brief Drop the html entities
static std::string htmlEntities(const std::string &text);
/// \brief To store the debug informations
std::string debugHtmlContent;
std::string htmlHeaderContent;
/// \brief The current backend
Backend currentBackend;
/// try connect to send to the current running instance the arguements
bool tryConnect();
int addDebugInformationCallNumber;
bool quit;
//std::regex fileNameCleaner;don't clean, too many performance heart
};
#endif // ULTRACOPIER_DEBUG
#endif // DEBUG_ENGINE_H