Project Documentation Manager BRIGADOON-0002
Project Documentation Manager
Loading...
Searching...
No Matches
worker.h
Go to the documentation of this file.
1#ifndef WORKER_H
2#define WORKER_H
3
4#include <QObject>
5#include "logger.h"
6#include <QSqlDatabase>
8
13class Worker : public QObject
14{
15 Q_OBJECT
16public:
17
23 explicit Worker(QObject *parent = nullptr);
24
25public slots:
26
32 void DoWork(PROJECT_INFORMATION* ProjectInfo);
33
34private:
35 QString autodoc_dir;
36
45 void LogAdd (LOGGING_SEVERITY Severity, LOGGING_MODE Mode,
46 const QString Message);
47
53 void DoDoxygen (PROJECT_INFORMATION *ProjectInfo);
54
62 QString UpdateLine (PROJECT_INFORMATION *Project, QString SourceLine);
63
73 bool UpdateFile (PROJECT_INFORMATION *Project, QString SourceFile,
74 QString DestinationFile);
75
85 const QString &srcFilePath,
86 const QString &tgtFilePath);
87
95 bool CleanDirectory (QString Directory);
96
113 bool PreProcessProject (PROJECT_INFORMATION *ProjectInfo);
114
125 bool TrimDirectory (QString Directory, QStringList FileFilter);
126
127 /*1 \fn QString CountLines(PROJECT_INFORMATION* Store, QString Directory)
128 * \brief Count the Lines of Code in the Source Directory
129 * \param Store Pointer to Project's Information
130 * \param Directory Directory holding the Source Code
131 * \returns String holding a table containing the results of the count
132 *
133 */
134 QString CountLines (PROJECT_INFORMATION *Store, QString Directory);
135
145 QString FindLibraries (PROJECT_INFORMATION *Store);
146
153 QString ParserLddResults (QString ResultFilename);
154
162
169 QString CppCheck (PROJECT_INFORMATION *ProjectInfo);
170
180 bool CreateSourceListFile (const QString Directory,
181 const QString ResultFileName,
182 const QString DevLanguage);
183 bool RecursiveCopy (QString Source, QString Destination);
184 bool CreateInstallScript (PROJECT_INFORMATION *ProjectInfo);
185
186 QStringList source_dirs;
187 QStringList source_filter;
188 QStringList docs_dirs;
189 QStringList docs_filter;
190 QStringList all_filter;
193 QSqlDatabase db;
194
195signals:
196 void WorkDone(PROJECT_INFORMATION* ProjectInfo);
198};
199
200#endif // WORKER_H
Instantiate the Thread Worker Class.
Worker(QObject *parent=nullptr)
Worker Class Constructor.
Definition worker.cpp:9
QStringList source_filter
Definition worker.h:187
void DoWork(PROJECT_INFORMATION *ProjectInfo)
Process the Generation of Documentation by Doxygen & other processes.
Definition worker.cpp:36
void DoDoxygen(PROJECT_INFORMATION *ProjectInfo)
Run Doxygen to Generate the Source Documentaiton.
Definition worker.cpp:96
QString leadin_string
Definition worker.h:191
bool CreateSourceListFile(const QString Directory, const QString ResultFileName, const QString DevLanguage)
Create a List of Project Software Source Files.
Definition worker.cpp:697
QString ParserLddResults(QString ResultFilename)
Converts the Library List into an HTML compatible format.
Definition worker.cpp:520
QStringList docs_dirs
Definition worker.h:188
QString autodoc_dir
Definition worker.h:35
QStringList all_filter
Definition worker.h:190
QSqlDatabase db
Definition worker.h:193
bool TrimDirectory(QString Directory, QStringList FileFilter)
Remove files defined by the FileFilter from the Directory.
Definition worker.cpp:399
bool CreateInstallScript(PROJECT_INFORMATION *ProjectInfo)
Definition worker.cpp:924
bool CleanDirectory(QString Directory)
Clean a Directory Tree by recursively removing all files and subdirectories.
Definition worker.cpp:381
QString CountLines(PROJECT_INFORMATION *Store, QString Directory)
Definition worker.cpp:420
bool TranslateRecursively(PROJECT_INFORMATION *Store, const QString &srcFilePath, const QString &tgtFilePath)
Recursively process text substituition for a Directory Tree.
Definition worker.cpp:226
void LogAdd(LOGGING_SEVERITY Severity, LOGGING_MODE Mode, const QString Message)
Send Message to the Log.
Definition worker.cpp:25
QString CppCheck(PROJECT_INFORMATION *ProjectInfo)
Conduct Static Analysis of C++ code.
Definition worker.cpp:792
void SendLogEntry(REMOTE_LOG_ENTRY LogEntry)
QString UpdateLine(PROJECT_INFORMATION *Project, QString SourceLine)
Process text substitutions for a single line.
Definition worker.cpp:141
QStringList source_dirs
Definition worker.h:186
bool UpdateFile(PROJECT_INFORMATION *Project, QString SourceFile, QString DestinationFile)
Process text substituitions for a complete text file.
Definition worker.cpp:160
bool CreateSourceArchive(PROJECT_INFORMATION *Store)
Create an Archive using git.
Definition worker.cpp:644
QString leadout_string
Definition worker.h:192
bool RecursiveCopy(QString Source, QString Destination)
Definition worker.cpp:884
void WorkDone(PROJECT_INFORMATION *ProjectInfo)
QString FindLibraries(PROJECT_INFORMATION *Store)
Find the shared libraries the program needs to run.
Definition worker.cpp:545
QStringList docs_filter
Definition worker.h:189
bool PreProcessProject(PROJECT_INFORMATION *ProjectInfo)
Preprocess the Project's Documentation.
Definition worker.cpp:271
Common Structure Defintitions.
LOGGING_SEVERITY
Log Severity allow the selection of logging events based on Severity.
Definition logger.h:48
LOGGING_MODE
Log Severity allow the selection of logging events based on the mode.
Definition logger.h:21
Project Information Passed Between Functions.
Definition logger.h:60