Class for utilising the Doxygen tool. More...

#include <doxygenmanager.h>

Inheritance diagram for DoxygenManager:

Collaboration diagram for DoxygenManager:

Public Slots
void	ReceiveResult (PROJECT_INFORMATION *ProjectInfo)
	Receive the Result of the Worker Function.

Signals
void	SendLogEntry (REMOTE_LOG_ENTRY LogEntry)
	Send Log Entry to the Log \LogEntry Structure holding Log information.
void	DoxygenDone (void)
	Signal Doxgen has finished a task.
void	PrStateChange (PROJECT_INFORMATION *ProjectInfo)
	Signal that State of the Project has changed.
void	DoWork (PROJECT_INFORMATION *ProjectInfo)
	Signal the Work task to process this Project.
void	ProduceProjectLists (void)

Public Member Functions
	DoxygenManager ()
	Class Constructor.
	~DoxygenManager ()
	Class Deconstructor.
void	ProcessProject (PROJECT_INFORMATION *ProjectInfo)
	Process documentation for a Project.

Private Slots
void	RemoteLogger (REMOTE_LOG_ENTRY LogEntry)

Private Member Functions
void	LogAdd (LOGGING_SEVERITY Severity, LOGGING_MODE Mode, QString Message)
	Add a Log Entry.
bool	LockProject (int ProjectIndex)
	Lock the Project to prevent alterations.
void	DoProject (void)
	Take the next Project in the Queue and process.

Private Attributes
QThread	doxy_thread
QList< PROJECT_INFORMATION * >	project_list
	Queue of Projects to be processed.
Worker	worker
bool	project_working = false
	Flag showing is a project is being processed.

Detailed Description

Class for utilising the Doxygen tool.

Definition at line 23 of file doxygenmanager.h.

Constructor & Destructor Documentation

◆ DoxygenManager()

DoxygenManager::DoxygenManager ( )

Class Constructor.

Definition at line 9 of file doxygenmanager.cpp.

{
    worker.moveToThread(&doxy_thread);
    QObject::connect(&doxy_thread, &QThread::finished, &worker, &QObject::deleteLater);
    QObject::connect(this, SIGNAL(DoWork(PROJECT_INFORMATION*)), &worker, SLOT(DoWork(PROJECT_INFORMATION*)));
 
    QObject::connect (&worker, &Worker::WorkDone, this,
                      &DoxygenManager::ReceiveResult);
 
    QObject::connect (&worker, &Worker::SendLogEntry, this,
                      &DoxygenManager::RemoteLogger);
 
    doxy_thread.start();
}

References DoWork(), doxy_thread, ReceiveResult(), RemoteLogger(), Worker::SendLogEntry(), Worker::WorkDone(), and worker.

Here is the call graph for this function:

◆ ~DoxygenManager()

DoxygenManager::~DoxygenManager ( )

Class Deconstructor.

Definition at line 24 of file doxygenmanager.cpp.

{
    doxy_thread.quit();
    doxy_thread.wait();
}

References doxy_thread.

Member Function Documentation

◆ DoProject()

void DoxygenManager::DoProject ( void )

private

Take the next Project in the Queue and process.

Definition at line 92 of file doxygenmanager.cpp.

{
    if (!project_working)
    {
        if (!project_list.empty())
        {
            PROJECT_INFORMATION* project_info = project_list.takeFirst();
            if (LockProject(project_info->ProjectDesc.ProjectIndex))
            {
                project_working = true;
                project_info->ProjectLock = true;
                project_info->ProjectQueued = false;
                read_project_info->SetProjectStatus(project_info->ProjectDesc.ProjectIndex, project_info->ProjectLock, project_info->ProjectQueued);
 
                emit PrStateChange(project_info);
                emit DoWork(project_info);
                LogAdd(LOG_DEBUG, MODE_GENERAL, QString("Project %1 sent to Doxygen program.").arg(project_info->ProjectDesc.ProjectIdent));
            }
            else
            {
                project_info->ProjectLock = false;
                LogAdd(LOG_INFO, MODE_GENERAL, QString("Project %1 update cancelled as Project already locked.").arg(project_info->ProjectDesc.ProjectIdent));
            }
 
        }
        else
        {
            LogAdd(LOG_DEBUG, MODE_GENERAL, "No new projects to be processed.");
        }
    }
    else
    {
        LogAdd(LOG_DEBUG, MODE_GENERAL, "Project processing under way - New Project Start deferred.");
    }
}

References DoWork(), LockProject(), LOG_DEBUG, LOG_INFO, LogAdd(), MODE_GENERAL, project_list, project_working, PROJECT_INFORMATION::ProjectDesc, PROJECT_DESCRIPTION::ProjectIdent, PROJECT_DESCRIPTION::ProjectIndex, PROJECT_INFORMATION::ProjectLock, PROJECT_INFORMATION::ProjectQueued, PrStateChange(), and read_project_info.

Referenced by ProcessProject(), and ReceiveResult().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoWork

void DoxygenManager::DoWork ( PROJECT_INFORMATION * ProjectInfo )

signal

Signal the Work task to process this Project.

Parameters

ProjectInfo Structure holding the Project's Information

Referenced by DoProject(), and DoxygenManager().

Here is the caller graph for this function:

◆ DoxygenDone

void DoxygenManager::DoxygenDone ( void )

signal

Signal Doxgen has finished a task.

◆ LockProject()

bool DoxygenManager::LockProject ( int ProjectIndex )

private

Lock the Project to prevent alterations.

Parameters

The	Project's Index

Returns: Returns Success or Failure in Locking the Project

Definition at line 128 of file doxygenmanager.cpp.

{
    return( read_project_info->SetProjectStatus(ProjectIndex, true, false) );
}

References read_project_info.

Referenced by DoProject().

Here is the caller graph for this function:

◆ LogAdd()

void DoxygenManager::LogAdd	(	LOGGING_SEVERITY	Severity,
		LOGGING_MODE	Mode,
		QString	Message )

private

Add a Log Entry.

Parameters

Severity	Severity of the Logged Event
Mode	Part of the Program being Logged
Message	Description of the Log Event

Definition at line 41 of file doxygenmanager.cpp.

{
    REMOTE_LOG_ENTRY log_entry;
    log_entry.Severity = Severity;
    log_entry.Mode = Mode;
    log_entry.Message = Message;
    emit SendLogEntry(log_entry);
}

References REMOTE_LOG_ENTRY::Message, REMOTE_LOG_ENTRY::Mode, SendLogEntry(), and REMOTE_LOG_ENTRY::Severity.

Referenced by DoProject(), ProcessProject(), and ReceiveResult().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessProject()

void DoxygenManager::ProcessProject ( PROJECT_INFORMATION * ProjectInfo )

Process documentation for a Project.

Parameters

ProjectInfo Information about the Project

Definition at line 30 of file doxygenmanager.cpp.

{
    ProjectInfo->ProjectLock = true;
    ProjectInfo->ProjectQueued = true;
    read_project_info->SetProjectStatus(ProjectInfo->ProjectDesc.ProjectIndex, ProjectInfo->ProjectLock, ProjectInfo->ProjectQueued);
    //  project_list_manager->PrStateChange(ProjectInfo);
    LogAdd( LOG_INFO, MODE_FILE, QString("Project %1 Queued for documentation generation.").arg(ProjectInfo->ProjectDesc.ProjectIdent));
    project_list.append(ProjectInfo);
    DoProject();
}

References DoProject(), LOG_INFO, LogAdd(), MODE_FILE, project_list, PROJECT_INFORMATION::ProjectDesc, PROJECT_DESCRIPTION::ProjectIdent, PROJECT_DESCRIPTION::ProjectIndex, PROJECT_INFORMATION::ProjectLock, PROJECT_INFORMATION::ProjectQueued, and read_project_info.

Here is the call graph for this function:

◆ ProduceProjectLists

void DoxygenManager::ProduceProjectLists ( void )

signal

Referenced by ReceiveResult().

Here is the caller graph for this function:

◆ PrStateChange

void DoxygenManager::PrStateChange ( PROJECT_INFORMATION * project_info )

signal

Signal that State of the Project has changed.

Parameters

ProjectInfo Structure holding the Project's Information

Referenced by DoProject(), and ReceiveResult().

Here is the caller graph for this function:

◆ ReceiveResult

void DoxygenManager::ReceiveResult ( PROJECT_INFORMATION * ProjectInfo )

slot

Receive the Result of the Worker Function.

Definition at line 50 of file doxygenmanager.cpp.

{
  // Create the Extrnal text and HTML Project List Files
  emit ProduceProjectLists ();
 
  // Copy the Appropriate .htaccess form into the website if Document Control
  // iS active and Only Group Access if active
  if (!(ProjectInfo->InAssocInfo.HtaccessFileName == "")
      && (ProjectInfo->ProjectDesc.ProjectOptions & CONTROL_DOC_ACCESS)
      && (ProjectInfo->ProjectDesc.ProjectOptions & GROUP_ACCESS_ONLY))
    {
        QString htaccess_file = ProjectInfo->ProgramInformation.SharedTemplateDirectory + "/access_template/" + ProjectInfo->InAssocInfo.HtaccessFileName;
        QString destin_file   = ProjectInfo->ProgramInformation.PrimaryWebsiteDirectory + "/projects/" + ProjectInfo->ProjectDesc.ProjectIdent + "/html/.htaccess";
        QFile ht_file(htaccess_file);
        if (ht_file.copy(destin_file))
        {
            LogAdd( LOG_DEBUG, MODE_FILE, QString(".htaccess File %1 copied to %2.").arg(htaccess_file, ProjectInfo->ProjectDesc.ProjectIdent));
        }
        else
        {
            LogAdd( LOG_ERROR, MODE_FILE, QString(".htaccess File %1 FAILED TO COPY to %2.").arg(htaccess_file, ProjectInfo->ProjectDesc.ProjectIdent));
        }
        // delete ProjectInfo;
    }
 
  // Release Lock and release Structure
  ProjectInfo->ProjectLock = false;
  ProjectInfo->ProjectQueued = false;
  read_project_info->SetProjectStatus (ProjectInfo->ProjectDesc.ProjectIndex,
                                       ProjectInfo->ProjectLock,
                                       ProjectInfo->ProjectQueued);
  emit PrStateChange (ProjectInfo);
 
  project_working = false;
  DoProject ();
}

References CONTROL_DOC_ACCESS, DoProject(), GROUP_ACCESS_ONLY, ASSOCIATED_GROUP_INFO::HtaccessFileName, PROJECT_INFORMATION::InAssocInfo, LOG_DEBUG, LOG_ERROR, LogAdd(), MODE_FILE, PROGRAM_INFORMATION::PrimaryWebsiteDirectory, ProduceProjectLists(), PROJECT_INFORMATION::ProgramInformation, project_working, PROJECT_INFORMATION::ProjectDesc, PROJECT_DESCRIPTION::ProjectIdent, PROJECT_DESCRIPTION::ProjectIndex, PROJECT_INFORMATION::ProjectLock, PROJECT_DESCRIPTION::ProjectOptions, PROJECT_INFORMATION::ProjectQueued, PrStateChange(), read_project_info, and PROGRAM_INFORMATION::SharedTemplateDirectory.

Referenced by DoxygenManager().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemoteLogger

void DoxygenManager::RemoteLogger ( REMOTE_LOG_ENTRY LogEntry )

privateslot

Definition at line 87 of file doxygenmanager.cpp.

{
    emit SendLogEntry(LogEntry);
}

References SendLogEntry().

Referenced by DoxygenManager().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendLogEntry

void DoxygenManager::SendLogEntry ( REMOTE_LOG_ENTRY LogEntry )

signal

Send Log Entry to the Log \LogEntry Structure holding Log information.

Referenced by LogAdd(), and RemoteLogger().

Here is the caller graph for this function:

Field Documentation

◆ doxy_thread

QThread DoxygenManager::doxy_thread

private

Definition at line 31 of file doxygenmanager.h.

Referenced by DoxygenManager(), and ~DoxygenManager().

◆ project_list

QList<PROJECT_INFORMATION*> DoxygenManager::project_list

private

Queue of Projects to be processed.

Definition at line 75 of file doxygenmanager.h.

Referenced by DoProject(), and ProcessProject().

◆ project_working

bool DoxygenManager::project_working = false

private

Flag showing is a project is being processed.

Definition at line 100 of file doxygenmanager.h.

Referenced by DoProject(), and ReceiveResult().

◆ worker

Worker DoxygenManager::worker

private

Definition at line 94 of file doxygenmanager.h.

Referenced by DoxygenManager().

The documentation for this class was generated from the following files:

Public Slots

Signals

Public Member Functions

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DoxygenManager()

◆ ~DoxygenManager()

Member Function Documentation

◆ DoProject()

◆ DoWork

◆ DoxygenDone

◆ LockProject()

◆ LogAdd()

◆ ProcessProject()

◆ ProduceProjectLists

◆ PrStateChange

◆ ReceiveResult

◆ RemoteLogger

◆ SendLogEntry

Field Documentation

◆ doxy_thread

◆ project_list

◆ project_working

◆ worker