#include <projectsubstitute.h>

Inheritance diagram for ProjectSubstitute:

Collaboration diagram for ProjectSubstitute:

Public Slots
void	DoClear (void)
	Clear the Substitution lists and display.
void	LoadSubsTable (int ProjectNo)
void	ReadProjectId (PROJECT_INFORMATION *ProjectInfo)
	Load the Substitution Table for th Project.
void	UpdateVersion (REMOTE_VERSION_ENTRY Version)
	Update the Version Information in the Substitute Table.
void	UpdateDevFamily (DEVELOPMENT_FAMILY DevelopmentTypes)
	Update the Dev Families Information in the Substitute Table.
void	UpdateStatus (STATUS_INFO StatusInfo)
	Update the Deve Families Information in the Substitute Table.
void	SaveLocalSubstitutes (void)
	Save the Local Substitutes to the Database.
void	UpdateSoftwareLicence (QString LicenceName)
	Update the Software Licence Information in the Substitute Table.
void	UpdateHardwareLicence (QString LicenceName)
	Update the Hardware Licence Information in the Substitute Table.
void	UpdateDocumentationLicence (QString LicenceName)
	Update the Documentation Licence Information in the Substitute Table.
void	UpdateFullDescription (QString FullDescription)
	Update the Full Description in the Substitute Table.
void	ReadMajorVersion (int MajorVersion)
	Update the Major Version in the Substitute Table.
void	ReadMinorVersion (int MinorVersion)
	Update the Minor Version in the Substitute Table.
void	ReadRevision (int Revision)
	Update the Revision in the Substitute Table.
void	UpdateProjectName (QString Name)
	Update Project Name in Substitute Table.
void	UpdateDepartureURL (QString Name)
	Update Exit URL in Substitute Table.
void	UpdateProjectIcon (QString Name)
void	UpdateProjectBrief (QString Text)
	Update Project Brief in Substitute Table.
void	UpdateProjectContact (QString ContactName)
void	UpdateProjectDateTime (QString ProjectDateTime)
	Update Project's DateTime in Substitute Table.
void	UpdateDoxyProjectLogo (QString DoxyProjectLogo)
	Update Doxygen's Project Logo Filename in Substitute Table.
void	UpdateDoxyHeader (QString DoxyHeader)
	Update Doxygen's Header Filename in Substitute Table.
void	UpdateDoxyFooter (QString DoxyFooter)
	Update Doxygen's Footer Filename in Substitute Table.
void	UpdateDoxyStylesheet (QString DoxyStylesheet)
	Update Doxygen's Stylesheet Filename in Substitute Table.
void	UpdateInAssocation (QString Association)
void	LoadPresets (void)
	Load the Substitution Table.

Signals
void	SendLogEntry (REMOTE_LOG_ENTRY LogEntry)

Public Member Functions
	ProjectSubstitute (Ui::MainWindow UI_Window, ProjectOptionsManager ProjectOptsManager)
	LicenceManager Construction routine.
void	LoadFileSubsList (PROJECT_INFORMATION *Project)
	Load the Substitution table from the Project Information.

Private Slots
void	ReloadSubstituteTable (void)
	Reload the Substituition Table & Display.
void	ClearSubstituteEntry (void)
	Clear the Select Substitution Row & data.
void	SetSubstituteState (bool State)
void	SetOptionState (uint Options)
void	SetEditableState (QTableWidgetItem *Item)

Private Member Functions
QTableWidgetItem *	FindItemByKey (QString Key)
	Find a Substitution Entry in the Substitution List by Name.
bool	UpdateItem (QString Key, QString Value)
	Update the Value of an Entry in the Substitution List.
void	LogAdd (LOGGING_SEVERITY Severity, LOGGING_MODE Mode, QString Message)
	Add a Log Entry.
void	AddKeyValue (QString Key, QString Value, int RowIndex)
	Add a New Key-Value pair to the Substitution List.
int	DecodeProjectOptions (uint Options, int RowIndex, bool NewProject)
	Add Key-Value items for all Project Options.
bool	SaveKeyValuePair (int ProjectId, QString Key, QString Value, bool Lock)
void	LoadBasePresets (int RowIndex, int ProjectNo)
QString	GetProjectEmail (int Index)
void	LoadUserSubstitutes (PROJECT_INFORMATION *Project)

Private Attributes
Ui::MainWindow *	ui
	Pointer to the Main Window.
PROJECT_INFORMATION *	project_info
	Structure to hold Project Information.
QString	leadin_string
	Lead in Characters for substitution blocks.
QString	leadout_string
	Lead out Characters for substitution blocks.
QColor	system_colour
	table Background Colour
ProjectOptionsManager *	project_opts_manager
	Pointer the Project Options Manager Class.
QStringList	option_name
	List of Option Names for Subtitution process.
QStringList	sys_item_name
	List of System Names for Subtitution process.

Detailed Description

Definition at line 80 of file projectsubstitute.h.

Constructor & Destructor Documentation

◆ ProjectSubstitute()

ProjectSubstitute::ProjectSubstitute	(	Ui::MainWindow *	UI_Window,
		ProjectOptionsManager *	ProjectOptsManager )

explicit

LicenceManager Construction routine.

Parameters

UI_Window	POinter to the main window
ProjectOptsManager	Pointer to the Project Options Manager Class

Definition at line 7 of file projectsubstitute.cpp.

{
    ui = UI_Window;
    leadin_string = "[#";
    leadout_string = "#]";
    system_colour = QColor(255, 255, 220);
 
    project_opts_manager = ProjectOptsManager;
    option_name     << "EXCLUDE_FROM_LIST"
                    << "CONTROL_DOC_ACCESS"
                    << "ONLY_DEFAULT_PAGE"
                    << "GROUP_ACCESS_ONLY"
                    << "ENABLE_CUSTOM_DOXY"
                    << "CAVEAT_LECTOR"
                    << "POTENTIAL_HAZARD"
                    << "ASSISTANCE_WELCOME"
                    << "DONATIONS_WELCOME"
                    << "OFFER_PAYPAL_DONATION";
 
    sys_item_name   << "PROJECT_NAME"
                    << "PROJECT_IDENT"
                    << "MAJOR_VERSION"
                    << "MINOR_VERSION"
                    << "REVISION"
                    << "BRIEF_DESCRIPTION"
                    << "DEV_FAMILY"
                    << "LANGUAGE_FAMILY"
                    << "PRIMARY_TOOL"
                    << "SYSTEM_FAMILY"
                    << "PROJECT_STATUS"
                    << "PROJECT_HISTORY"
                    << "STATUS_DATE"
                    << "DOCUMENT_LICENCE"
                    << "SOFTWARE_LICENCE"
                    << "HARDWARE_LICENCE"
                    << "PROJECT_CONTACT"
                    << "PROJECT_EMAIL"
                    << "FULL_DESCRIPTION"
                    << "PROJECT_DIRECTORY"
                    << "PROJECT_ICON"
                    << "DOXY_LOGO"
                    << "DOXY_HTML_HEADER"
                    << "DOXY_HTML_FOOTER"
                    << "DOXY_EXTRA_STYLESHEET"
                    << "ASSOCIATED_GROUP"
                    << "DEPARTURE_URL"
                    << "SITE_URL"
                    << "EXECUTABLE_DIR"
                    << "SOURCE_LIST";
 
 
    QObject::connect(ui->ReloadSubstituitions, SIGNAL(pressed()), this, SLOT(ReloadSubstituteTable()));
    QObject::connect(ui->ClearSubstituitions, SIGNAL(pressed()), this, SLOT(ClearSubstituteEntry()));
    QObject::connect(ui->SaveSubstituitions, SIGNAL(pressed()), this, SLOT(SaveLocalSubstitutes()));
 
    // Set the Substituition Table Column and Row Settings
    ui->ProjectSubsList->setColumnCount(2);
    ui->ProjectSubsList->setRowCount( MAXIMUM_KEY_VALUE_PAIRS );
    ui->ProjectSubsList->setHorizontalHeaderLabels( QStringList( {"Key Word", "Substitution String"} ));
    ui->ProjectSubsList->setColumnWidth(0, PROJECT_KEY_COLUMN_WIDTH);
    ui->ProjectSubsList->setColumnWidth(1,(ui->ProjectSubsList->width() - ui->ProjectSubsList->columnWidth(0) ) );
}

References ClearSubstituteEntry(), leadin_string, leadout_string, MAXIMUM_KEY_VALUE_PAIRS, option_name, PROJECT_KEY_COLUMN_WIDTH, project_opts_manager, ReloadSubstituteTable(), SaveLocalSubstitutes(), sys_item_name, system_colour, and ui.

Here is the call graph for this function:

Member Function Documentation

◆ AddKeyValue()

void ProjectSubstitute::AddKeyValue	(	QString	Key,
		QString	Value,
		int	RowIndex )

private

Add a New Key-Value pair to the Substitution List.

Parameters

Key	The Key to be inserted into the List
Value	The Value to be associated with the New Key in the list

Definition at line 246 of file projectsubstitute.cpp.

{
    QTableWidgetItem *new_key = new QTableWidgetItem( Key );
    new_key->data(true);
    QTableWidgetItem *new_value = new QTableWidgetItem( Value );
    new_key->setBackground(system_colour);
    new_value->setBackground(system_colour);
    new_key->setFlags(new_key->flags() ^ Qt::ItemIsEditable);
    new_value->setFlags(new_value->flags() ^ Qt::ItemIsEditable);
    ui->ProjectSubsList->setItem( RowIndex, 0, new_key );
    ui->ProjectSubsList->setItem( RowIndex, 1, new_value );
}

References system_colour, and ui.

Referenced by DecodeProjectOptions(), and LoadSubsTable().

Here is the caller graph for this function:

◆ ClearSubstituteEntry

void ProjectSubstitute::ClearSubstituteEntry ( void )

privateslot

Clear the Select Substitution Row & data.

Definition at line 279 of file projectsubstitute.cpp.

{
    // Turn Off Sorting
 
 
    // Get the List of Selected Items
    QModelIndexList selection = ui->ProjectSubsList->selectionModel()->selectedRows();
 
    // Multiple rows can be selected
    for(int i=0; i< selection.count(); i++)
    {
        QModelIndex index = selection.at(i);
        QTableWidgetItem* item = ui->ProjectSubsList->item(index.row(), 0);
        if ((item != 0) && (item->flags() & Qt::ItemIsEditable)) ui->ProjectSubsList->removeRow(index.row());
    }
    ui->ProjectSubsList->sortItems(0, Qt::AscendingOrder);
}

References ui.

Referenced by ProjectSubstitute().

Here is the caller graph for this function:

◆ DecodeProjectOptions()

int ProjectSubstitute::DecodeProjectOptions	(	uint	Options,
		int	RowIndex,
		bool	NewProject )

private

Add Key-Value items for all Project Options.

Parameters

Options	Encoded Project Options
RowIndex	The Row in the Substitution table Display
New	Project Flag if this is a new Project

Returns: The RowIndex

Definition at line 297 of file projectsubstitute.cpp.

{
    if (!NewProject)
    {
        QString key = option_name[EXCLUDE_PROJECT_LIST_BIT]; QString value = QVariant(project_opts_manager->CheckExcludeProjectList(Options)).toString();
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[CONTROL_DOC_ACCESS_BIT]; value = QVariant(project_opts_manager->CheckControlDocAccess(Options)).toString();
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[ONLY_DEFAULT_PAGE_BIT]; value = QVariant(project_opts_manager->CheckOnlyDefaultPage(Options)).toString();
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[GROUP_ACCESS_ONLY_BIT]; value = QVariant(project_opts_manager->CheckGroupAccessOnly(Options)).toString();
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[ENABLE_CUSTOM_DOXYGEN_BIT]; value = QVariant(project_opts_manager->CheckEnableCustomDoxygen(Options)).toString();
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[CAVEAT_LECTOR_BIT]; value = QVariant(project_opts_manager->CheckCaveatLector(Options)).toString();
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[POTENTIAL_HAZARD_BIT]; value = QVariant(project_opts_manager->CheckPotentialHazard(Options)).toString();
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[ASSISTANCE_WELCOME_BIT]; value = QVariant(project_opts_manager->CheckAssistanceWelcome(Options)).toString();
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[DONATIONS_WELCOME_BIT]; value = QVariant(project_opts_manager->ChecktDonationsWelcome(Options)).toString();
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[OFFER_PAYPAL_DONATION_BIT]; value = QVariant(project_opts_manager->CheckOfferPaypalDonation(Options)).toString();
        AddKeyValue(key, value, RowIndex++);
    }
    else
    {
        QString key = option_name[EXCLUDE_PROJECT_LIST_BIT]; QString value = "false";
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[CONTROL_DOC_ACCESS_BIT]; value = "false";
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[ONLY_DEFAULT_PAGE_BIT]; value = "false";
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[GROUP_ACCESS_ONLY_BIT]; value = "false";
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[ENABLE_CUSTOM_DOXYGEN_BIT]; value = "false";
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[CAVEAT_LECTOR_BIT]; value = "false";
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[POTENTIAL_HAZARD_BIT]; value = "false";
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[ASSISTANCE_WELCOME_BIT]; value = "false";
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[DONATIONS_WELCOME_BIT]; value = "false";
        AddKeyValue(key, value, RowIndex++);
 
        key = option_name[OFFER_PAYPAL_DONATION_BIT]; value = "false";
        AddKeyValue(key, value, RowIndex++);
 
    }
    return(RowIndex);
}

References AddKeyValue(), ASSISTANCE_WELCOME_BIT, CAVEAT_LECTOR_BIT, CONTROL_DOC_ACCESS_BIT, DONATIONS_WELCOME_BIT, ENABLE_CUSTOM_DOXYGEN_BIT, EXCLUDE_PROJECT_LIST_BIT, GROUP_ACCESS_ONLY_BIT, OFFER_PAYPAL_DONATION_BIT, ONLY_DEFAULT_PAGE_BIT, option_name, POTENTIAL_HAZARD_BIT, and project_opts_manager.

Referenced by LoadSubsTable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoClear

void ProjectSubstitute::DoClear ( void )

slot

Clear the Substitution lists and display.

Definition at line 259 of file projectsubstitute.cpp.

{
    ui->ProjectSubsList->clearContents();
}

References ui.

◆ FindItemByKey()

QTableWidgetItem * ProjectSubstitute::FindItemByKey ( QString Key )

private

Find a Substitution Entry in the Substitution List by Name.

Parameters

Key	The Key String

Returns: The Table Widget Item with that Name or NULL if not found

Definition at line 367 of file projectsubstitute.cpp.

{
    QTableWidgetItem* found_item = NULL;
 
    // Find the Item witht the Match Name. There should only be one match as names are unique.
    QList<QTableWidgetItem*> item_list =  ui->ProjectSubsList->findItems(Key, Qt::MatchExactly);
    if (item_list.count() == 1)
    {
        found_item = item_list[0];
    }
    else
    {
        LogAdd(LOG_DEBUG, MODE_DATABASE, QString("Unknown Key \"%1\" in the Substitute Table").arg(Key));
    }
    return(found_item);
}

References LOG_DEBUG, LogAdd(), MODE_DATABASE, and ui.

Referenced by UpdateItem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetProjectEmail()

QString ProjectSubstitute::GetProjectEmail ( int Index )

private

Definition at line 197 of file projectsubstitute.cpp.

{
    QString email_address;
    QSqlQuery email_query(QString("select developer_email from developer where developer_index = %1").arg(QString::number(Index)));
    while ( email_query.next() )
    {
        email_address = email_query.value(0).toString();
    }
    return(email_address);
}

Referenced by LoadSubsTable().

Here is the caller graph for this function:

◆ LoadBasePresets()

void ProjectSubstitute::LoadBasePresets	(	int	RowIndex,
		int	ProjectNo )

private

Definition at line 213 of file projectsubstitute.cpp.

{
    int row_index = RowIndex;
 
    // Load the Substitution Items from the Database
    QSqlQuery subs_query(QString("select key_word, substitution, lock_entry from project_substitute where project_index = 1 or project_index = %1 order by key_word").arg(QString::number(ProjectNo)));
    QBrush locked_brush;
    locked_brush.setColor(Qt::lightGray);
 
    while ( subs_query.next() )
    {
        QString keyword = subs_query.value(0).toString();
        QString substitution = subs_query.value(1).toString();
        bool locked = subs_query.value(2).toBool();
 
        QTableWidgetItem *new_key = new QTableWidgetItem( keyword );
        new_key->data(locked);
        QTableWidgetItem *new_value = new QTableWidgetItem( substitution );
        if (locked)
        {
            new_key->setBackground(system_colour);
            new_value->setBackground(system_colour);
            new_key->setFlags(new_key->flags() ^ Qt::ItemIsEditable);
            new_value->setFlags(new_value->flags() ^ Qt::ItemIsEditable);
        }
        ui->ProjectSubsList->setItem( row_index, 0, new_key );
        ui->ProjectSubsList->setItem( row_index, 1, new_value );        
        row_index++;
    }
    ui->ProjectSubsList->sortItems(0, Qt::AscendingOrder);
}

References system_colour, and ui.

Referenced by LoadSubsTable().

Here is the caller graph for this function:

◆ LoadFileSubsList()

void ProjectSubstitute::LoadFileSubsList ( PROJECT_INFORMATION * Project )

Load the Substitution table from the Project Information.

Parameters

Project Inforamtion about the Project

Definition at line 643 of file projectsubstitute.cpp.

{
    // Clear the Project Substitution Map
    Project->SubsMap.clear();
 
    // Load the System Defined Substitutions
    QString web_directory = Project->ProgramInformation.PrimaryWebsiteDirectory + "/projects/" + Project->ProjectDesc.ProjectIdent;
 
    // Convenient display of Lead-In and Lead-Out without it invokes the substitution process.
    Project->SubsMap.insert("[#LEAD_IN#]", "'@htmlonly &lsqb;&num; @endhtmlonly'");
    Project->SubsMap.insert("[#LEAD_OUT#]", "'@htmlonly &num;&rsqb; @endhtmlonly'");
 
    Project->SubsMap.insert("[#PROJECT_NAME#]", Project->ProjectDesc.ProjectName);
    Project->SubsMap.insert("[#PROJECT_IDENT#]", Project->ProjectDesc.ProjectIdent);
    Project->SubsMap. insert("[#PROJECT_DIRECTORY#]", Project->ProjectDesc.ProjectDirectory);
    Project->SubsMap.insert("[#BRIEF_DESC#]", Project->ProjectDesc.BriefDescription);
    Project->SubsMap.insert("[#FULL_DESC#]", Project->ProjectDesc.FullDescription);
    Project->SubsMap.insert("[#VERSION#]", Project->VersionInfo.VersionString);
    Project->SubsMap.insert("[#VERSION_TEXT#]", Project->VersionInfo.CurrentVersionString);
    Project->SubsMap.insert("[#VERSION_HISTORY#]", Project->VersionInfo.FullVersionString);
    Project->SubsMap.insert("[#VERSION_DATE#]", Project->VersionInfo.VersionDateString);
    Project->SubsMap.insert("[#DEV_SHORT_NAME#]", Project->DevFamilyInfo.ShortName);
    Project->SubsMap.insert("[#DEV_FULL_NAME#]", Project->DevFamilyInfo.FullName);
    Project->SubsMap.insert("[#DEV_IMAGE#]", Project->DevFamilyInfo.DevFamilyImage);
    Project->SubsMap.insert("[#COMPILER_SHORT_NAME#]", Project->LangFamilyInfo.ShortName);
    Project->SubsMap.insert("[#COMPILER_FULL_NAME#]", Project->LangFamilyInfo.FullName);
    Project->SubsMap.insert("[#COMPILER_IMAGE#]", Project->LangFamilyInfo.LangFamilyImage);
    Project->SubsMap.insert("[#TOOL_SHORT_NAME#]", Project->CompFamilyInfo.ShortName);
    Project->SubsMap.insert("[#TOOL_FULL_NAME#]", Project->CompFamilyInfo.FullName);
    Project->SubsMap.insert("[#TOOL_IMAGE#]", Project->CompFamilyInfo.CompilerToolImage);
    Project->SubsMap.insert("[#TOOL_DIRECTORY#]", Project->CompFamilyInfo.CompilerDirectory);
    Project->SubsMap.insert("[#TARGET_SHORT_NAME#]", Project->TargetFamilyInfo.ShortName);
    Project->SubsMap.insert("[#TARGET_FULL_NAME#]", Project->TargetFamilyInfo.FullName);
    Project->SubsMap.insert("[#TARGET_IMAGE#]", Project->TargetFamilyInfo.TargetFamilyImage);
    Project->SubsMap.insert("[#STATUS_NAME#]", Project->StatusInfo.StatusName);
    Project->SubsMap.insert("[#STATUS_DESC#]", Project->StatusInfo.StatusDescription);
    Project->SubsMap.insert("[#STATUS_IMAGE#]", Project->StatusInfo.StatusImage);
    Project->SubsMap.insert("[#STATUS_DATE#]", Project->StatusInfo.StatusDateTimeString);
    Project->SubsMap.insert("[#DL_SHORT_NAME#]", Project->DocLicence.ShortName);
    Project->SubsMap.insert("[#DL_FULL_NAME#]", Project->DocLicence.FullName);
    Project->SubsMap.insert("[#DL_IMAGE#]", Project->DocLicence.LicenceImage);
    Project->SubsMap.insert("[#DL_URL#]", Project->DocLicence.LicenceURL);
    Project->SubsMap.insert("[#SL_SHORT_NAME#]", Project->SoftwareLicence.ShortName);
    Project->SubsMap.insert("[#SL_FULL_NAME#]", Project->SoftwareLicence.FullName);
    Project->SubsMap.insert("[#SL_IMAGE#]", Project->SoftwareLicence.LicenceImage);
    Project->SubsMap.insert("[#SL_URL#]", Project->SoftwareLicence.LicenceURL);
    Project->SubsMap.insert("[#HL_SHORT_NAME#]", Project->HardwareLicence.ShortName);
    Project->SubsMap.insert("[#HL_FULL_NAME#]", Project->HardwareLicence.FullName);
    Project->SubsMap.insert("[#HL_IMAGE#]", Project->HardwareLicence.LicenceImage);
    Project->SubsMap.insert("[#HL_URL#]", Project->HardwareLicence.LicenceURL);
    Project->SubsMap.insert("[#DEVELOPER_NAME#]", Project->Developer.Name);
    Project->SubsMap.insert("[#DEVELOPER_EMAIL#]", Project->Developer.Email);
    Project->SubsMap.insert("[#DEVELOPER_PHONE#]", Project->Developer.Phone);
    Project->SubsMap.insert("[#DEVELOPER_INFO#]", Project->Developer.Info);
    Project->SubsMap.insert("[#DEVELOPER_HANDLE#]", Project->Developer.Handle);
    Project->SubsMap.insert("[#PROJECT_ICON#]", Project->ProjectDesc.ProjectIcon);
    Project->SubsMap.insert("[#SITE_NAME#]", Project->ProgramInformation.SiteName);
    Project->SubsMap.insert("[#SITE_URL#]", Project->ProgramInformation.SiteURL);
    Project->SubsMap.insert("[#SITE_LOGO#]", Project->ProgramInformation.SiteLogo);
    Project->SubsMap.insert("[#DEPARTURE_URL#]", Project->ProjectDesc.DepartureURL);
    Project->SubsMap.insert("[#EXE_BUILD_DIR#]", Project->ProjectDesc.ExeDirectory);
    Project->SubsMap.insert("[#EXE_NAME#]", Project->ProjectDesc.ExeName);
    Project->SubsMap.insert("[#WEBSITE_DIR#]", Project->ProgramInformation.PrimaryWebsiteDirectory);
    Project->SubsMap.insert("[#TEMPLATE_DIR#]", Project->ProgramInformation.SharedTemplateDirectory);
    Project->SubsMap.insert("[#LOCAL_DEV_DIR#]", Project->ProgramInformation.LocalDevelopmentDirectory);
    Project->SubsMap.insert("[#DOXY_LOGO#]", Project->DoxyOptions.DoxyLogoFilename);
    Project->SubsMap.insert("[#DOXY_HEADER#]", Project->DoxyOptions.DoxyHtmlHeaderFilename);
    Project->SubsMap.insert("[#DOXY_FOOTER#]", Project->DoxyOptions.DoxyHtmlFooterFilename);
    Project->SubsMap.insert("[#DOXY_STYLESHEET#]", Project->DoxyOptions.DoxyExtraStylesheetFilename);
    Project->SubsMap.insert("[#ASSOC_SHORT_NAME#]", Project->InAssocInfo.ShortName);
    Project->SubsMap.insert("[#ASSOC_FULL_NAME#]", Project->InAssocInfo.FullName);
    Project->SubsMap.insert("[#ASSOC_LOGO#]", Project->InAssocInfo.AssociationLogo);
    Project->SubsMap.insert("[#ASSOC_URL#]", Project->InAssocInfo.AssociationURL);
    Project->SubsMap.insert("[#EXCLUDE_FROM_LIST#]", QVariant(project_opts_manager->CheckExcludeProjectList(Project->ProjectDesc.ProjectOptions)).toString());
    Project->SubsMap.insert("[#CONTROL_DOC_ACCESS#]", QVariant(project_opts_manager->CheckControlDocAccess(Project->ProjectDesc.ProjectOptions)).toString());
    Project->SubsMap.insert("[#ONLY_DEFAULT_PAGE#]", QVariant(project_opts_manager->CheckOnlyDefaultPage(Project->ProjectDesc.ProjectOptions)).toString());
    Project->SubsMap.insert("[#GROUP_ACCESS_ONLY#]", QVariant(project_opts_manager->CheckGroupAccessOnly(Project->ProjectDesc.ProjectOptions)).toString());
    Project->SubsMap.insert("[#ENABLE_CUSTOM_DOXY#]", QVariant(project_opts_manager->CheckEnableCustomDoxygen(Project->ProjectDesc.ProjectOptions)).toString());
    Project->SubsMap.insert("[#CAVEAT_LECTOR#]", QVariant(project_opts_manager->CheckCaveatLector(Project->ProjectDesc.ProjectOptions)).toString());
    Project->SubsMap.insert("[#POTENTIAL_HAZARD#]", QVariant(project_opts_manager->CheckPotentialHazard(Project->ProjectDesc.ProjectOptions)).toString());
    Project->SubsMap.insert("[#ASSISTANCE_WELCOME#]", QVariant(project_opts_manager->CheckAssistanceWelcome(Project->ProjectDesc.ProjectOptions)).toString());
    Project->SubsMap.insert("[#DONATIONS_WELCOME#]", QVariant(project_opts_manager->ChecktDonationsWelcome(Project->ProjectDesc.ProjectOptions)).toString());
    Project->SubsMap.insert("[#OFFER_PAYPAL_DONATION#]", QVariant(project_opts_manager->CheckOfferPaypalDonation(Project->ProjectDesc.ProjectOptions)).toString());
    Project->SubsMap.insert("[#DOCUMENTATION_ADDRESS#]", Project->ProgramInformation.SiteURL + "/projects/" + Project->ProjectDesc.ProjectIdent);
    Project->SubsMap.insert("[#CODE_DIR#]", Project->ProjectDesc.ProjectDirectory + "/source/" + Project->ProjectDesc.ExeName);
    Project->SubsMap.insert("[#WEB_DIR#]", web_directory);
    Project->SubsMap.insert("[#DIA_PATH#]", Project->ProjectDesc.ProjectDirectory + "/dia");
    Project->SubsMap.insert("[#DOXY_LOG_FILE#]", Project->ProjectDesc.ProjectDirectory + "/scratch/" + DOXY_LOG_FILE);
    Project->SubsMap.insert("[#DOXY_RESULTS#]", Project->ProgramInformation.SiteURL + "/project_dynamic/" + Project->ProjectDesc.ProjectIdent + "/html/" + DOXY_LOG_FILE);
    Project->SubsMap.insert("[#CPPCHECK_RESULTS#]", Project->ProgramInformation.SiteURL + "/project_dynamic/" + Project->ProjectDesc.ProjectIdent + "/html/" + CPP_CHECK_FILE);
    Project->SubsMap.insert("[#DOXY_IMAGE_PATH#]", web_directory + "/images");
    Project->SubsMap.insert("[#DOT_IMAGE_FORMAT#]", ui->DotImageType->currentText());
    if (ui->DotImageType->currentText() == "SVG") Project->SubsMap.insert("[#INTERACTIVE_SVG#]", "YES");
    Project->SubsMap.insert("[#DOXY_TAB_SIZE#]", QString::number(ui->DoxyTabSize->value()));
    Project->SubsMap.insert("[#DOXY_FILTERS#]", Project->ProgramInformation.SharedTemplateDirectory + "/support_template/doxygen_filters");
    Project->SubsMap.insert("[#PUBLISHER_NAME#]", Project->ProgramInformation.PublisherName);
    Project->SubsMap.insert("[#PUBLISHER_WEBSITE#]", Project->ProgramInformation.PublisherWebsite);
    Project->SubsMap.insert("[#PUBLISHER_CONTACT#]", Project->ProgramInformation.PublisherContactEmail);
    Project->SubsMap.insert("[#WEBDIR_PROJECT_HTML", Project->ProgramInformation.PrimaryWebsiteDirectory + "/html");
    Project->SubsMap.insert("[#WEBDIR_PROJECT_IMAGES", Project->ProgramInformation.PrimaryWebsiteDirectory + "/images");
    Project->SubsMap.insert("[#WEBDIR_PROJECT_DOCS", Project->ProgramInformation.PrimaryWebsiteDirectory + "/docs");
    Project->SubsMap.insert("[#WEBSITE_PROJECT_HTML",Project->ProgramInformation.SiteURL + "/project_dynamic/" + Project->ProjectDesc.ProjectIdent + "/html");
    Project->SubsMap.insert("[#WEBSITE_PROJECT_IMAGES", Project->ProgramInformation.SiteURL + "/project_dynamic/" + Project->ProjectDesc.ProjectIdent + "/images");
    Project->SubsMap.insert("[#WEBSITE_PROJECT_DOCS", Project->ProgramInformation.SiteURL + "/project_dynamic/" + Project->ProjectDesc.ProjectIdent + "/docs");
    Project->SubsMap.insert("[#LOCAL_DESKTOP#]", "/home/" + Project->ProgramInformation.CurrentUser + "/.local/share/applications/" + Project->ProjectDesc.ExeName + ".desktop");
 
    if (Project->ProjectDesc.ProjectOptions & CREATE_SOURCE_ARCHIVE)
    {
        QString archive_web_location = Project->ProgramInformation.SiteURL + "/project_dynamic/" +
                                       Project->ProjectDesc.ProjectIdent + "/archive/" + Project->ProjectDesc.ExeName + ".tar.gz";
        Project->SubsMap.insert("[#ARCHIVE_FILENAME#]", archive_web_location);
    }
 
    // Add Doxygen Optimisation for appropriate languages
    QString key; QString value; bool key_set = false;
    switch(Project->LangFamilyInfo.LangFamilyIndex)
    {
        case 5: // C++
            key = "[#OPTIMIZE_C#]"; value = "YES"; key_set = true;
        break;
 
        case 16: // Java
            key = "[#OPTIMIZE_JAVA#]"; value = "YES"; key_set = true;
        break;
 
        case 17: // Fortran
            key = "[#OPTIMIZE_FORTRAN#]"; value = "YES"; key_set = true;
        break;
 
        case 18: // VDHL
            key = "[#OPTIMIZE_FORTRAN#]"; value = "YES"; key_set = true;
            break;
 
        default:
            key_set = false;
            break;
    }
    if (key_set)  Project->SubsMap.insert(key, value);
 
 
    // Create Copyright Statement
    QString created_query_template = "select version_timestamp from proj_version_info where project_id = %1 and major_version = 0 and minor_version = 0 and revision = 0";
    QSqlQuery created_query(QString(created_query_template).arg(QString::number(Project->ProjectDesc.ProjectIndex)));
 
    QString creation_year = "";
    while ( created_query.next() )
    {
        QDateTime created_datetime = created_query.value(0).toDateTime();
        creation_year = created_datetime.toString("yyyy");
    }
    QString current_year = QDateTime::currentDateTime().toString("yyyy");
    QString copyright_year = creation_year + "-" + current_year;
    QString copyright_template = "Copyright © %1 by %2";
    QString copyright_statement = copyright_template.arg(copyright_year, Project->ProgramInformation.PublisherName);
    Project->SubsMap.insert("[#COPYRIGHT_STATEMENT#]", copyright_statement);
 
    // Create the
    // Include the User Defined Substitutions
    LoadUserSubstitutes(Project);
}

Here is the call graph for this function:

◆ LoadPresets

void ProjectSubstitute::LoadPresets ( void )

slot

Load the Substitution Table.

Definition at line 208 of file projectsubstitute.cpp.

{
    LoadSubsTable(0);
}

References LoadSubsTable().

Here is the call graph for this function:

◆ LoadSubsTable

void ProjectSubstitute::LoadSubsTable ( int ProjectNo )

slot

Definition at line 85 of file projectsubstitute.cpp.

{
    QString key, value;
 
    // Clear any Existing Entries
    ui->ProjectSubsList->clearContents();
 
    // Insert the Program Defined Substitutions
    int row_index = 0;
 
    // Add Keys defined by the Project
    QString timestamp_format_string = DATETIME_DISPLAY_FORMAT;
 
    // If this is a project Creation, use the Current Date Time.
    if (ProjectNo != 0)
    {
        key = sys_item_name[STATUS_DATE];           value = project_info->StatusInfo.StatusDateTime.toString(timestamp_format_string);
        AddKeyValue(key, value, row_index++);
        key = sys_item_name[FULL_DESCRIPTION];      value = project_info->ProjectDesc.FullDescription;
        AddKeyValue(key, value, row_index++);
        key = sys_item_name[PROJECT_DIRECTORY];     value = project_info->ProgramInformation.LocalDevelopmentDirectory;
        AddKeyValue(key, value, row_index++);
        key = sys_item_name[PROJECT_ICON];          value = project_info->ProjectDesc.ProjectIcon;
        AddKeyValue(key, value, row_index++);
        key = sys_item_name[DOXY_LOGO];             value = project_info->DoxyOptions.DoxyLogoFilename;
        AddKeyValue(key, value, row_index++);
        key = sys_item_name[DOXY_HTML_HEADER];      value = project_info->DoxyOptions.DoxyHtmlHeaderFilename;
        AddKeyValue(key, value, row_index++);
        key = sys_item_name[DOXY_HTML_FOOTER];      value = project_info->DoxyOptions.DoxyHtmlFooterFilename;
        AddKeyValue(key, value, row_index++);
        key = sys_item_name[DOXY_EXTRA_STYLESHEET]; value = project_info->DoxyOptions.DoxyExtraStylesheetFilename;
        //AddKeyValue(key, value, row_index++);
        //key = sys_item_name[SOURCE_LIST];           value = project_info->ProjectDesc->
    }
    else
    {
        key = sys_item_name[STATUS_DATE];           value = "";
        AddKeyValue(key, value, row_index++);
        key = sys_item_name[FULL_DESCRIPTION];      value = "";
        AddKeyValue(key, value, row_index++);
        key = sys_item_name[PROJECT_DIRECTORY];     value = "";
        AddKeyValue(key, value, row_index++);
        key = sys_item_name[PROJECT_ICON];          value = "";
        AddKeyValue(key, value, row_index++);
        key = sys_item_name[DOXY_LOGO];             value = "";
        AddKeyValue(key, value, row_index++);
        key = sys_item_name[DOXY_HTML_HEADER];      value = "";
        AddKeyValue(key, value, row_index++);
        key = sys_item_name[DOXY_HTML_FOOTER];      value = "";
        AddKeyValue(key, value, row_index++);
        key = sys_item_name[DOXY_EXTRA_STYLESHEET]; value = "";
        AddKeyValue(key, value, row_index++);
    }
 
    if (ProjectNo == 0)
    {
        row_index = DecodeProjectOptions(0, row_index, true);
    }
    else
    {
        row_index = DecodeProjectOptions(project_info->ProjectDesc.ProjectOptions, row_index, false);
    }
    key = sys_item_name[PROJECT_NAME];      value = ui->ProjectName->text();
    AddKeyValue(key, value, row_index++);
 
    key = sys_item_name[DEPARTURE_URL]; value = ui->DepartureURL->text();
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[EXECUTABLE_DIR];    value = ui->ExecutableDirectory->text();
    AddKeyValue(key, value, row_index++);
 
    key = sys_item_name[SITE_URL];          value = ui->SiteURL->text();
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[PROJECT_IDENT];     value = ui->ProjectIdent->text();
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[MAJOR_VERSION];     value = QString::number(ui->MajorVersion->value());
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[MINOR_VERSION];     value = QString::number(ui->MinorVersion->value());
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[REVISION];          value = QString::number(ui->Revision->value());
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[BRIEF_DESCRIPTION]; value = ui->BriefDescription->text();
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[DEV_FAMILY];        value = ui->DevelopmentFamily->currentText();
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[LANGUAGE_FAMILY];   value = ui->LanguageFamily->currentText();
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[PRIMARY_TOOL];      value = ui->PrimaryTool->currentText();
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[SYSTEM_FAMILY];     value = ui->TargetFamily->currentText();
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[PROJECT_STATUS];    value = ui->ProjectStatus->currentText();
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[PROJECT_HISTORY];   value = ui->FullHistory->toHtml();
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[ASSOCIATED_GROUP];  value = ui->InAssociationList->currentText();
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[DOCUMENT_LICENCE];  value = ui->DocumentationLicenceList->currentText();
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[SOFTWARE_LICENCE];  value = ui->SoftwareLicenceList->currentText();
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[HARDWARE_LICENCE];  value = ui->HardwareLicenceList->currentText();
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[PROJECT_CONTACT];   value = ui->ProjectContactList->currentText();
    AddKeyValue(key, value, row_index++);
    key = sys_item_name[PROJECT_EMAIL];   value = GetProjectEmail(ui->ProjectContactList->currentIndex() + 1);
    AddKeyValue(key, value, row_index++);
 
    LoadBasePresets(row_index, ProjectNo);
    ui->ProjectSubsList->sortItems(0, Qt::AscendingOrder);
    LogAdd(LOG_DEBUG, MODE_DATABASE, QString("Read %1 Substitution entries from table \"project_substitute\"").arg(QString::number(row_index)));
}

References AddKeyValue(), ASSOCIATED_GROUP, BRIEF_DESCRIPTION, DATETIME_DISPLAY_FORMAT, DecodeProjectOptions(), DEPARTURE_URL, DEV_FAMILY, DOCUMENT_LICENCE, DOXY_EXTRA_STYLESHEET, DOXY_HTML_FOOTER, DOXY_HTML_HEADER, DOXY_LOGO, EXECUTABLE_DIR, FULL_DESCRIPTION, GetProjectEmail(), HARDWARE_LICENCE, LANGUAGE_FAMILY, LoadBasePresets(), LOG_DEBUG, LogAdd(), MAJOR_VERSION, MINOR_VERSION, MODE_DATABASE, PRIMARY_TOOL, PROJECT_CONTACT, PROJECT_DIRECTORY, PROJECT_EMAIL, PROJECT_HISTORY, PROJECT_ICON, PROJECT_IDENT, project_info, PROJECT_NAME, PROJECT_STATUS, REVISION, SITE_URL, SOFTWARE_LICENCE, STATUS_DATE, sys_item_name, SYSTEM_FAMILY, and ui.

Referenced by LoadPresets(), ReadProjectId(), ReloadSubstituteTable(), and SaveLocalSubstitutes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadUserSubstitutes()

void ProjectSubstitute::LoadUserSubstitutes ( PROJECT_INFORMATION * Project )

private

Definition at line 804 of file projectsubstitute.cpp.

{
    // Define Substitution Variables
    QString key_string; QString value_string;
 
    // Load the Substitution Items from the Database
    QString user_subs_query = "select key_word, substitution, lock_entry from project_substitute where project_index = 1 or project_index = %1 order by key_word";
    QSqlQuery subs_query(QString(user_subs_query).arg(QString::number(Project->ProjectDesc.ProjectIndex)));
 
    while ( subs_query.next() )
    {
        key_string = leadin_string + subs_query.value(0).toString() + leadout_string;
        value_string = subs_query.value(1).toString();
        Project->SubsMap.insert(key_string, value_string);
    }
}

References leadin_string, leadout_string, PROJECT_INFORMATION::ProjectDesc, PROJECT_DESCRIPTION::ProjectIndex, and PROJECT_INFORMATION::SubsMap.

Referenced by LoadFileSubsList().

Here is the caller graph for this function:

◆ LogAdd()

void ProjectSubstitute::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 70 of file projectsubstitute.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 FindItemByKey(), LoadSubsTable(), SaveKeyValuePair(), SaveLocalSubstitutes(), and UpdateItem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadMajorVersion

void ProjectSubstitute::ReadMajorVersion ( int MajorVersion )

slot

Update the Major Version in the Substitute Table.

Parameters

MajorVersion Major Version as Integer

Definition at line 573 of file projectsubstitute.cpp.

{
    UpdateItem(sys_item_name[MAJOR_VERSION], QString::number(MajorVersion));
}

References MAJOR_VERSION, sys_item_name, and UpdateItem().

Here is the call graph for this function:

◆ ReadMinorVersion

void ProjectSubstitute::ReadMinorVersion ( int MinorVersion )

slot

Update the Minor Version in the Substitute Table.

Parameters

MinorVersion Minor Version as Integer

Definition at line 578 of file projectsubstitute.cpp.

{
    UpdateItem(sys_item_name[MINOR_VERSION], QString::number(MinorVersion));
}

References MINOR_VERSION, sys_item_name, and UpdateItem().

Here is the call graph for this function:

◆ ReadProjectId

void ProjectSubstitute::ReadProjectId ( PROJECT_INFORMATION * ProjectInfo )

slot

Load the Substitution Table for th Project.

Parameters

ProjectInfo Pointer to the Project Information

Definition at line 79 of file projectsubstitute.cpp.

{
    project_info = ProjectInfo;
    LoadSubsTable(project_info->ProjectDesc.ProjectIndex);
}

References LoadSubsTable(), and project_info.

Here is the call graph for this function:

◆ ReadRevision

void ProjectSubstitute::ReadRevision ( int Revision )

slot

Update the Revision in the Substitute Table.

Parameters

Revision Revision as Integer

Definition at line 583 of file projectsubstitute.cpp.

{
    UpdateItem(sys_item_name[REVISION], QString::number(Revision));
}

References REVISION, sys_item_name, and UpdateItem().

Here is the call graph for this function:

◆ ReloadSubstituteTable

void ProjectSubstitute::ReloadSubstituteTable ( void )

privateslot

Reload the Substituition Table & Display.

Definition at line 274 of file projectsubstitute.cpp.

{
    if (project_info->ProjectDesc.ProjectIndex != 0) LoadSubsTable(project_info->ProjectDesc.ProjectIndex);
}

References LoadSubsTable(), and project_info.

Referenced by ProjectSubstitute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveKeyValuePair()

bool ProjectSubstitute::SaveKeyValuePair	(	int	ProjectId,
		QString	Key,
		QString	Value,
		bool	Lock )

private

Definition at line 536 of file projectsubstitute.cpp.

{
    QString insert_string = QString("insert into project_substitute values (null, %1, '%2', '%3', %4)").arg(QString::number(ProjectId), Key, Value, QString::number(Lock));
    QSqlQuery insert_keyvalue;
    bool result = insert_keyvalue.exec(insert_string);
    if (!result)
    {
        LogAdd(LOG_ERROR, MODE_DATABASE, QString("Unable to Add Key-Value Pair \"%1 - %2\" to project Id %3").arg(Key, Value, QString::number(ProjectId)));
    }
    else
    {
        LogAdd(LOG_DEBUG, MODE_DATABASE, QString("Added Key-Value Pair \"%1 - %2\" to project Id %3").arg(Key, Value, QString::number(ProjectId)));
    }
 
    return(result);
}

References LOG_DEBUG, LOG_ERROR, LogAdd(), and MODE_DATABASE.

Referenced by SaveLocalSubstitutes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveLocalSubstitutes

void ProjectSubstitute::SaveLocalSubstitutes ( void )

slot

Save the Local Substitutes to the Database.

Definition at line 482 of file projectsubstitute.cpp.

{
    // Remove the Project's Deletable Substituitions from the Database
    uint project_index = project_info->ProjectDesc.ProjectIndex;
    QString query_string(QString("delete from project_substitute where project_index = %1 and lock_entry = false").arg(QString::number(project_index)));
    QSqlQuery remove_query;
    if (!remove_query.exec(query_string))
    {
        LogAdd(LOG_ERROR, MODE_DATABASE, "Unable to remove Key-Value pairs.");
    }
    else
    {
        LogAdd(LOG_DEBUG, MODE_DATABASE, "Removed Project's Key-Value pairs.");
 
        // Step Through the Substituition Table Widget and put the Projects Deletable Key-Value Pairs into the Database
        int row_count = ui->ProjectSubsList->rowCount();
        for (int row = 0; row < row_count; row++)
        {
            QTableWidgetItem* key_item = ui->ProjectSubsList->item(row, 0);
            QTableWidgetItem* value_item = ui->ProjectSubsList->item(row, 1);
 
            if (key_item != nullptr)
            {
                // If the Key-Value Pair isn't Locked, Process It
                Qt::ItemFlags flags = key_item->flags();
                Qt::ItemFlags flag_bit = flags & Qt::ItemIsEditable;
                bool is_locked = !(flag_bit & Qt::ItemIsEditable);
                if (is_locked)
                {
                    LogAdd(LOG_DEBUG, MODE_DATABASE, "Key-Value pair Locked");
                }
                else
                {
                    if (SaveKeyValuePair(project_index, key_item->text(), value_item->text(),false))
                    {
                        LogAdd(LOG_DEBUG, MODE_DATABASE, QString("Key-Value pair:") + key_item->text() + " saved to database" );
                    }
                    else
                    {
                        LogAdd(LOG_ERROR, MODE_DATABASE, QString("Key-Value pair:") + key_item->text() + " NOT saved to database" );
                    }
                }
            }
            else
            {
                LogAdd(LOG_DEBUG, MODE_DATABASE, QString("No Item in this row %1").arg(QString::number(row)));
            }
        }
    }
 
    // Reload the Substituitions Table
    LoadSubsTable(project_index);
}

References LoadSubsTable(), LOG_DEBUG, LOG_ERROR, LogAdd(), MODE_DATABASE, project_info, SaveKeyValuePair(), and ui.

Referenced by ProjectSubstitute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendLogEntry

void ProjectSubstitute::SendLogEntry ( REMOTE_LOG_ENTRY LogEntry )

signal

Referenced by LogAdd().

Here is the caller graph for this function:

◆ SetEditableState

void ProjectSubstitute::SetEditableState ( QTableWidgetItem * Item )

privateslot

Definition at line 553 of file projectsubstitute.cpp.

{
    Item->setFlags(Item->flags() | Qt::ItemIsEditable);
}

◆ SetOptionState

void ProjectSubstitute::SetOptionState ( uint Options )

privateslot

Definition at line 433 of file projectsubstitute.cpp.

{
    bool state = OptionState & ((uint)EXCLUDE_PROJECT_LIST);
    UpdateItem(option_name[EXCLUDE_PROJECT_LIST_BIT], QVariant(state).toString());
 
    state = OptionState & ((uint)CONTROL_DOC_ACCESS);
    UpdateItem(option_name[CONTROL_DOC_ACCESS_BIT], QVariant(state).toString());
    if (!state)
    {
        UpdateItem(option_name[ONLY_DEFAULT_PAGE_BIT], "false");
        UpdateItem(option_name[GROUP_ACCESS_ONLY_BIT], "false");
    }
    else
    {
        if (OptionState & (uint)ONLY_DEFAULT_PAGE)
        {
            UpdateItem(option_name[ONLY_DEFAULT_PAGE_BIT], "true");
            UpdateItem(option_name[GROUP_ACCESS_ONLY_BIT], "false");
        }
        else
        {
            UpdateItem(option_name[ONLY_DEFAULT_PAGE_BIT], "false");
            UpdateItem(option_name[GROUP_ACCESS_ONLY_BIT], "true");
        }
    }
 
    state = OptionState & ((uint)ENABLE_CUSTOM_DOXYGEN);
    UpdateItem(option_name[ENABLE_CUSTOM_DOXYGEN_BIT], QVariant(state).toString());
 
    state = OptionState & ((uint)CAVEAT_LECTOR);
    UpdateItem(option_name[CAVEAT_LECTOR_BIT], QVariant(state).toString());
 
    state = OptionState & ((uint)POTENTIAL_HAZARD);
    UpdateItem(option_name[POTENTIAL_HAZARD_BIT], QVariant(state).toString());
 
    state = OptionState & ((uint)ASSISTANCE_WELCOME);
    UpdateItem(option_name[ASSISTANCE_WELCOME_BIT], QVariant(state).toString());
 
    state = OptionState & ((uint)DONATIONS_WELCOME);
    UpdateItem(option_name[DONATIONS_WELCOME_BIT], QVariant(state).toString());
    if (!state)
    {
        UpdateItem(option_name[OFFER_PAYPAL_DONATION_BIT], "false");
    }
 
    state = OptionState & ((uint)OFFER_PAYPAL_DONATION);
    UpdateItem(option_name[OFFER_PAYPAL_DONATION_BIT], QVariant(state).toString());
}

References ASSISTANCE_WELCOME, ASSISTANCE_WELCOME_BIT, CAVEAT_LECTOR, CAVEAT_LECTOR_BIT, CONTROL_DOC_ACCESS, CONTROL_DOC_ACCESS_BIT, DONATIONS_WELCOME, DONATIONS_WELCOME_BIT, ENABLE_CUSTOM_DOXYGEN, ENABLE_CUSTOM_DOXYGEN_BIT, EXCLUDE_PROJECT_LIST, EXCLUDE_PROJECT_LIST_BIT, GROUP_ACCESS_ONLY_BIT, OFFER_PAYPAL_DONATION, OFFER_PAYPAL_DONATION_BIT, ONLY_DEFAULT_PAGE, ONLY_DEFAULT_PAGE_BIT, option_name, POTENTIAL_HAZARD, POTENTIAL_HAZARD_BIT, and UpdateItem().

Here is the call graph for this function:

◆ SetSubstituteState

void ProjectSubstitute::SetSubstituteState ( bool State )

privateslot

Definition at line 264 of file projectsubstitute.cpp.

{
    ui->ProjectSubsGroupBox->setEnabled(State);
    ui->ProjectSubsList->setEnabled(State);
    ui->ReloadSubstituitions->setEnabled(State);
    ui->ClearSubstituitions->setEnabled(State);
    ui->SaveSubstituitions->setEnabled(State);
 
}

References ui.

◆ UpdateDepartureURL

void ProjectSubstitute::UpdateDepartureURL ( QString ExitURL )

slot

Update Exit URL in Substitute Table.

Parameters

ExitURL URL of exit destination

Definition at line 593 of file projectsubstitute.cpp.

{
    UpdateItem(sys_item_name[DEPARTURE_URL], Name);
}

References DEPARTURE_URL, sys_item_name, and UpdateItem().

Here is the call graph for this function:

◆ UpdateDevFamily

void ProjectSubstitute::UpdateDevFamily ( DEVELOPMENT_FAMILY DevelopmentTypes )

slot

Update the Dev Families Information in the Substitute Table.

Parameters

Structure holding the Dev Families Information

Definition at line 419 of file projectsubstitute.cpp.

{
    UpdateItem("DEV_FAMILY", DevelopmentTypes.DevelopmentFamilyString);
    UpdateItem("LANGUAGE_FAMILY", DevelopmentTypes.LanguageFamilyString);
    UpdateItem("PRIMARY_TOOL", DevelopmentTypes.CompilerFamilyString);
    UpdateItem("SYSTEM_FAMILY", DevelopmentTypes.TargetFamilyString);
}

References DEVELOPMENT_FAMILY::CompilerFamilyString, DEVELOPMENT_FAMILY::DevelopmentFamilyString, DEVELOPMENT_FAMILY::LanguageFamilyString, DEVELOPMENT_FAMILY::TargetFamilyString, and UpdateItem().

Here is the call graph for this function:

◆ UpdateDocumentationLicence

void ProjectSubstitute::UpdateDocumentationLicence ( QString LicenceName )

slot

Update the Documentation Licence Information in the Substitute Table.

Parameters

LicenceName String holding the Documentation Licence Name

Definition at line 568 of file projectsubstitute.cpp.

{
    UpdateItem(sys_item_name[DOCUMENT_LICENCE], LicenceName);
}

References DOCUMENT_LICENCE, sys_item_name, and UpdateItem().

Here is the call graph for this function:

◆ UpdateDoxyFooter

void ProjectSubstitute::UpdateDoxyFooter ( QString DoxyFooter )

slot

Update Doxygen's Footer Filename in Substitute Table.

Parameters

DoxyFooter Filename of the Doxygen's Header

Definition at line 628 of file projectsubstitute.cpp.

{
    UpdateItem(sys_item_name[DOXY_HTML_FOOTER], DoxyFooter);
}

References DOXY_HTML_FOOTER, sys_item_name, and UpdateItem().

Here is the call graph for this function:

◆ UpdateDoxyHeader

void ProjectSubstitute::UpdateDoxyHeader ( QString DoxyHeader )

slot

Update Doxygen's Header Filename in Substitute Table.

Parameters

DoxyHeader Filename of the Doxygen's Header

Definition at line 623 of file projectsubstitute.cpp.

{
    UpdateItem(sys_item_name[DOXY_HTML_HEADER], DoxyHeader);
}

References DOXY_HTML_HEADER, sys_item_name, and UpdateItem().

Here is the call graph for this function:

◆ UpdateDoxyProjectLogo

void ProjectSubstitute::UpdateDoxyProjectLogo ( QString DoxyProjectLogo )

slot

Update Doxygen's Project Logo Filename in Substitute Table.

Parameters

DoxyProjectLogo Filename of the Doxygen's Project Logo

Definition at line 618 of file projectsubstitute.cpp.

{
    UpdateItem(sys_item_name[DOXY_LOGO], DoxyProjectLogo);
}

References DOXY_LOGO, sys_item_name, and UpdateItem().

Here is the call graph for this function:

◆ UpdateDoxyStylesheet

void ProjectSubstitute::UpdateDoxyStylesheet ( QString DoxyStylesheet )

slot

Update Doxygen's Stylesheet Filename in Substitute Table.

Parameters

DoxyStylesheet Filename of the Doxygen's Stylesheet

Definition at line 633 of file projectsubstitute.cpp.

{
    UpdateItem(sys_item_name[DOXY_EXTRA_STYLESHEET], DoxyStylesheet);
}

References DOXY_EXTRA_STYLESHEET, sys_item_name, and UpdateItem().

Here is the call graph for this function:

◆ UpdateFullDescription

void ProjectSubstitute::UpdateFullDescription ( QString FullDescription )

slot

Update the Full Description in the Substitute Table.

Parameters

FullDescription String holding the Full Description

Definition at line 407 of file projectsubstitute.cpp.

{
    UpdateItem("FULL_DESCRIPTION", TheText);
}

References UpdateItem().

Here is the call graph for this function:

◆ UpdateHardwareLicence

void ProjectSubstitute::UpdateHardwareLicence ( QString LicenceName )

slot

Update the Hardware Licence Information in the Substitute Table.

Parameters

LicenceName String holding the Hardware Licence Name

Definition at line 563 of file projectsubstitute.cpp.

{
    UpdateItem(sys_item_name[HARDWARE_LICENCE], LicenceName);
}

References HARDWARE_LICENCE, sys_item_name, and UpdateItem().

Here is the call graph for this function:

◆ UpdateInAssocation

void ProjectSubstitute::UpdateInAssocation ( QString Association )

slot

Definition at line 638 of file projectsubstitute.cpp.

{
    UpdateItem(sys_item_name[ASSOCIATED_GROUP], Association);
}

References ASSOCIATED_GROUP, sys_item_name, and UpdateItem().

Here is the call graph for this function:

◆ UpdateItem()

bool ProjectSubstitute::UpdateItem	(	QString	Key,
		QString	Value )

private

Update the Value of an Entry in the Substitution List.

Parameters

Key	The Value of the Key in the List
Value	The New Value to be associated with the Key

Returns: Success (true) or Failed (false)

Definition at line 385 of file projectsubstitute.cpp.

{
    bool result;
    QTableWidgetItem* item = FindItemByKey(Key);
    if (item != NULL)
    {
        int row = item->row();  // Item's Row
        int column = 1;         // Value Column
 
        QTableWidgetItem* value_item = ui->ProjectSubsList->item(row, column);
        value_item->setText(Value);
        LogAdd(LOG_DEBUG, MODE_GENERAL, QString("Set Key \"%1\" to \"%2\"in the Substitute Table").arg(Key, Value));
        result = true;
    }
    else
    {
        LogAdd(LOG_DEBUG, MODE_GENERAL, QString("Unable to set Key \"%1\" to \"%2\"in the Substitute Table").arg(Key, Value));
        result = false;
    }
    return(result);
}

References FindItemByKey(), LOG_DEBUG, LogAdd(), MODE_GENERAL, and ui.

Referenced by ReadMajorVersion(), ReadMinorVersion(), ReadRevision(), SetOptionState(), UpdateDepartureURL(), UpdateDevFamily(), UpdateDocumentationLicence(), UpdateDoxyFooter(), UpdateDoxyHeader(), UpdateDoxyProjectLogo(), UpdateDoxyStylesheet(), UpdateFullDescription(), UpdateHardwareLicence(), UpdateInAssocation(), UpdateProjectBrief(), UpdateProjectContact(), UpdateProjectDateTime(), UpdateProjectIcon(), UpdateProjectName(), UpdateSoftwareLicence(), UpdateStatus(), and UpdateVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateProjectBrief

void ProjectSubstitute::UpdateProjectBrief ( QString Text )

slot

Update Project Brief in Substitute Table.

Parameters

Name	URL of exit destination

Definition at line 603 of file projectsubstitute.cpp.

{
    UpdateItem(sys_item_name[BRIEF_DESCRIPTION], Description);
}

References BRIEF_DESCRIPTION, sys_item_name, and UpdateItem().

Here is the call graph for this function:

◆ UpdateProjectContact

void ProjectSubstitute::UpdateProjectContact ( QString ContactName )

slot

Definition at line 608 of file projectsubstitute.cpp.

{
    UpdateItem(sys_item_name[PROJECT_CONTACT], ContactName);
}

References PROJECT_CONTACT, sys_item_name, and UpdateItem().

Here is the call graph for this function:

◆ UpdateProjectDateTime

void ProjectSubstitute::UpdateProjectDateTime ( QString ProjectDateTime )

slot

Update Project's DateTime in Substitute Table.

Parameters

ProjectDateTime Project's Status DateTime

Definition at line 613 of file projectsubstitute.cpp.

{
    UpdateItem(sys_item_name[STATUS_DATE], ProjectDateTimeString);
}

References STATUS_DATE, sys_item_name, and UpdateItem().

Here is the call graph for this function:

◆ UpdateProjectIcon

void ProjectSubstitute::UpdateProjectIcon ( QString Name )

slot

Definition at line 598 of file projectsubstitute.cpp.

{
    UpdateItem(sys_item_name[PROJECT_ICON], Name);
}

References PROJECT_ICON, sys_item_name, and UpdateItem().

Here is the call graph for this function:

◆ UpdateProjectName

void ProjectSubstitute::UpdateProjectName ( QString Name )

slot

Update Project Name in Substitute Table.

Parameters

Name	Name of the Project

Definition at line 588 of file projectsubstitute.cpp.

{
    UpdateItem(sys_item_name[PROJECT_NAME], Name);
}

References PROJECT_NAME, sys_item_name, and UpdateItem().

Here is the call graph for this function:

◆ UpdateSoftwareLicence

void ProjectSubstitute::UpdateSoftwareLicence ( QString LicenceName )

slot

Update the Software Licence Information in the Substitute Table.

Parameters

LicenceName String holding the Software Licence Name

Definition at line 558 of file projectsubstitute.cpp.

{
    UpdateItem(sys_item_name[SOFTWARE_LICENCE], LicenceName);
}

References SOFTWARE_LICENCE, sys_item_name, and UpdateItem().

Here is the call graph for this function:

◆ UpdateStatus

void ProjectSubstitute::UpdateStatus ( STATUS_INFO StatusInfo )

slot

Update the Deve Families Information in the Substitute Table.

Parameters

Structure holding the Status Information

Definition at line 427 of file projectsubstitute.cpp.

{
    UpdateItem("PROJECT_STATUS", StatusInfo.StatusName);
    UpdateItem("STATUS_DATE", StatusInfo.StatusDateTimeString);
}

References STATUS_INFO::StatusDateTimeString, STATUS_INFO::StatusName, and UpdateItem().

Here is the call graph for this function:

◆ UpdateVersion

void ProjectSubstitute::UpdateVersion ( REMOTE_VERSION_ENTRY Version )

slot

Update the Version Information in the Substitute Table.

Parameters

Version Structure holding the Version Information

Definition at line 412 of file projectsubstitute.cpp.

{
    UpdateItem("MAJOR_VERSION", QString::number(Version.VersionInfo.MajorVersion));
    UpdateItem("MINOR_VERSION", QString::number(Version.VersionInfo.MinorVersion));
    UpdateItem("REVISION", QString::number(Version.VersionInfo.Revision));
}

References VERSION_INFO::MajorVersion, VERSION_INFO::MinorVersion, VERSION_INFO::Revision, UpdateItem(), and REMOTE_VERSION_ENTRY::VersionInfo.

Here is the call graph for this function:

Field Documentation

◆ leadin_string

QString ProjectSubstitute::leadin_string

private

Lead in Characters for substitution blocks.

Definition at line 303 of file projectsubstitute.h.

Referenced by LoadUserSubstitutes(), and ProjectSubstitute().

◆ leadout_string

QString ProjectSubstitute::leadout_string

private

Lead out Characters for substitution blocks.

Definition at line 309 of file projectsubstitute.h.

Referenced by LoadUserSubstitutes(), and ProjectSubstitute().

◆ option_name

QStringList ProjectSubstitute::option_name

private

List of Option Names for Subtitution process.

Definition at line 327 of file projectsubstitute.h.

Referenced by DecodeProjectOptions(), ProjectSubstitute(), and SetOptionState().

◆ project_info

PROJECT_INFORMATION* ProjectSubstitute::project_info

private

Structure to hold Project Information.

Definition at line 297 of file projectsubstitute.h.

Referenced by LoadSubsTable(), ReadProjectId(), ReloadSubstituteTable(), and SaveLocalSubstitutes().

◆ project_opts_manager

ProjectOptionsManager* ProjectSubstitute::project_opts_manager

private

Pointer the Project Options Manager Class.

Definition at line 321 of file projectsubstitute.h.

Referenced by DecodeProjectOptions(), LoadFileSubsList(), and ProjectSubstitute().

◆ sys_item_name

QStringList ProjectSubstitute::sys_item_name

private

List of System Names for Subtitution process.

Definition at line 333 of file projectsubstitute.h.

Referenced by LoadSubsTable(), ProjectSubstitute(), ReadMajorVersion(), ReadMinorVersion(), ReadRevision(), UpdateDepartureURL(), UpdateDocumentationLicence(), UpdateDoxyFooter(), UpdateDoxyHeader(), UpdateDoxyProjectLogo(), UpdateDoxyStylesheet(), UpdateHardwareLicence(), UpdateInAssocation(), UpdateProjectBrief(), UpdateProjectContact(), UpdateProjectDateTime(), UpdateProjectIcon(), UpdateProjectName(), and UpdateSoftwareLicence().

◆ system_colour

QColor ProjectSubstitute::system_colour

private

table Background Colour

Definition at line 315 of file projectsubstitute.h.

Referenced by AddKeyValue(), LoadBasePresets(), and ProjectSubstitute().

◆ ui

Ui::MainWindow* ProjectSubstitute::ui

private

Pointer to the Main Window.

Definition at line 291 of file projectsubstitute.h.

Referenced by AddKeyValue(), ClearSubstituteEntry(), DoClear(), FindItemByKey(), LoadBasePresets(), LoadFileSubsList(), LoadSubsTable(), ProjectSubstitute(), SaveLocalSubstitutes(), SetSubstituteState(), and UpdateItem().

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

◆ ProjectSubstitute()

Member Function Documentation

◆ AddKeyValue()

◆ ClearSubstituteEntry

◆ DecodeProjectOptions()

◆ DoClear

◆ FindItemByKey()

◆ GetProjectEmail()

◆ LoadBasePresets()

◆ LoadFileSubsList()

◆ LoadPresets

◆ LoadSubsTable

◆ LoadUserSubstitutes()

◆ LogAdd()

◆ ReadMajorVersion

◆ ReadMinorVersion

◆ ReadProjectId

◆ ReadRevision

◆ ReloadSubstituteTable

◆ SaveKeyValuePair()

◆ SaveLocalSubstitutes

◆ SendLogEntry

◆ SetEditableState

◆ SetOptionState

◆ SetSubstituteState

◆ UpdateDepartureURL

◆ UpdateDevFamily

◆ UpdateDocumentationLicence

◆ UpdateDoxyFooter

◆ UpdateDoxyHeader

◆ UpdateDoxyProjectLogo

◆ UpdateDoxyStylesheet

◆ UpdateFullDescription

◆ UpdateHardwareLicence

◆ UpdateInAssocation

◆ UpdateItem()

◆ UpdateProjectBrief

◆ UpdateProjectContact

◆ UpdateProjectDateTime

◆ UpdateProjectIcon

◆ UpdateProjectName

◆ UpdateSoftwareLicence

◆ UpdateStatus

◆ UpdateVersion

Field Documentation

◆ leadin_string

◆ leadout_string

◆ option_name

◆ project_info

◆ project_opts_manager

◆ sys_item_name

◆ system_colour

◆ ui