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
44 void LogAdd(LOGGING_SEVERITY Severity, LOGGING_MODE Mode, const QString Message);
45
51 void DoDoxygen(PROJECT_INFORMATION* ProjectInfo);
52
60 QString UpdateLine( PROJECT_INFORMATION* Project, QString SourceLine );
61
70 bool UpdateFile( PROJECT_INFORMATION* Project, QString SourceFile, QString DestinationFile );
71
79 bool TranslateRecursively(PROJECT_INFORMATION* Store, const QString &srcFilePath, const QString &tgtFilePath);
80
87 bool CleanDirectory( QString Directory);
88
103 bool PreProcessProject(PROJECT_INFORMATION* ProjectInfo);
104
115 bool TrimDirectory(QString Directory, QStringList FileFilter);
116
117 /*1 \fn QString CountLines(PROJECT_INFORMATION* Store, QString Directory)
118 * \brief Count the Lines of Code in the Source Directory
119 * \param Store Pointer to Project's Information
120 * \param Directory Directory holding the Source Code
121 * \returns String holding a table containing the results of the count
122 *
123 */
124 QString CountLines(PROJECT_INFORMATION* Store, QString Directory);
125
135 QString FindLibraries(PROJECT_INFORMATION* Store);
136
143 QString ParserLddResults( QString ResultFilename );
144
152
159 QString CppCheck(PROJECT_INFORMATION* ProjectInfo);
160
169 bool CreateSourceListFile( const QString Directory, const QString ResultFileName, const QString DevLanguage );
170 bool RecursiveCopy(QString Source, QString Destination);
171 bool CreateInstallScript(PROJECT_INFORMATION* ProjectInfo);
172
173 QStringList source_dirs;
174 QStringList source_filter;
175 QStringList docs_dirs;
176 QStringList docs_filter;
177 QStringList all_filter;
180 QSqlDatabase db;
181
182signals:
183 void WorkDone(PROJECT_INFORMATION* ProjectInfo);
185};
186
187#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:174
void DoWork(PROJECT_INFORMATION *ProjectInfo)
Process the Generation of Documentation by Doxygen & other processes.
Definition worker.cpp:37
void DoDoxygen(PROJECT_INFORMATION *ProjectInfo)
Run Doxygen to Generate the Source Documentaiton.
Definition worker.cpp:97
QString leadin_string
Definition worker.h:178
bool CreateSourceListFile(const QString Directory, const QString ResultFileName, const QString DevLanguage)
Create a List of Project Software Source Files.
Definition worker.cpp:699
QString ParserLddResults(QString ResultFilename)
Converts the Library List into an HTML compatible format.
Definition worker.cpp:522
QStringList docs_dirs
Definition worker.h:175
QString autodoc_dir
Definition worker.h:35
QStringList all_filter
Definition worker.h:177
QSqlDatabase db
Definition worker.h:180
bool TrimDirectory(QString Directory, QStringList FileFilter)
Remove files defined by the FileFilter from the Directory.
Definition worker.cpp:401
bool CreateInstallScript(PROJECT_INFORMATION *ProjectInfo)
Definition worker.cpp:926
bool CleanDirectory(QString Directory)
Clean a Directory Tree by recursively removing all files and subdirectories.
Definition worker.cpp:383
QString CountLines(PROJECT_INFORMATION *Store, QString Directory)
Definition worker.cpp:422
bool TranslateRecursively(PROJECT_INFORMATION *Store, const QString &srcFilePath, const QString &tgtFilePath)
Recursively process text substituition for a Directory Tree.
Definition worker.cpp:229
void LogAdd(LOGGING_SEVERITY Severity, LOGGING_MODE Mode, const QString Message)
Send Message to the Log.
Definition worker.cpp:27
QString CppCheck(PROJECT_INFORMATION *ProjectInfo)
Conduct Static Analysis of C++ code.
Definition worker.cpp:794
void SendLogEntry(REMOTE_LOG_ENTRY LogEntry)
QString UpdateLine(PROJECT_INFORMATION *Project, QString SourceLine)
Process text substitutions for a single line.
Definition worker.cpp:144
QStringList source_dirs
Definition worker.h:173
bool UpdateFile(PROJECT_INFORMATION *Project, QString SourceFile, QString DestinationFile)
Process text substituitions for a complete text file.
Definition worker.cpp:163
bool CreateSourceArchive(PROJECT_INFORMATION *Store)
Create an Archive using git.
Definition worker.cpp:646
QString leadout_string
Definition worker.h:179
bool RecursiveCopy(QString Source, QString Destination)
Definition worker.cpp:886
void WorkDone(PROJECT_INFORMATION *ProjectInfo)
QString FindLibraries(PROJECT_INFORMATION *Store)
Find the shared libraries the program needs to run.
Definition worker.cpp:547
QStringList docs_filter
Definition worker.h:176
bool PreProcessProject(PROJECT_INFORMATION *ProjectInfo)
Preprocess the Project's Documentation.
Definition worker.cpp:274
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