|
Project Documentation Manager BRIGADOON-0002
Project Documentation Manager
|
#include <readprojectinfo.h>
Signals | |
| void | SendLogEntry (REMOTE_LOG_ENTRY LogEntry) |
| Send Log Entry to the Log \LogEntry Structure holding Log information. | |
Public Member Functions | |
| ReadProjectInfo (QObject *parent=nullptr) | |
| Read Project Info Clawss Constructor. | |
| bool | LoadProjectInfo (PROJECT_INFORMATION *Store, int ProjectIndex, int ProjManIndex) |
| Load Project & relevant System Information into the Structure. | |
| QString | FindQtBuildVersion (QString ConfigFile) |
| Find the Qt Builder Version. | |
| bool | SetProjectStatus (int ProjectIndex, bool LockState, bool QueueState) |
| Set the Locked and Queued State of the Project. | |
Private Member Functions | |
| void | LogAdd (LOGGING_SEVERITY Severity, LOGGING_MODE Mode, QString Message) |
| Send Message to the Log. | |
| bool | LoadLicenceData (LICENCE_INFO *Licence, int LicenceIndex) |
| Load the Licence Information for the Selected Licence. | |
| bool | LoadAssocGroupData (ASSOCIATED_GROUP_INFO *Assoc, int AssociationIndex) |
| Load the In Association Information for the Selected Licence. | |
| bool | LoadDevFamilyData (DEV_FAMILY_INFO *DevFam, int DevFamilyIndex) |
| Load the Licence Information for the Selected Licence. | |
| bool | LoadLangFamilyData (LANG_FAMILY_INFO *LangFam, int LangFamilyIndex) |
| Load the Licence Information for the Selected Licence. | |
| bool | LoadCompilerFamilyData (COMP_FAMILY_INFO *CompFam, int CompFamilyIndex) |
| Load the Compiler Family Information for the Selected Licence. | |
| bool | LoadTargetFamilyData (TARGET_FAMILY_INFO *TargetFam, int TargetFamilyIndex) |
| Load the Compiler Family Information for the Selected Licence. | |
| bool | LoadFullHistory (VERSION_INFO *Version, int ProjectIndex) |
| Load the Compiler Family Information for the Selected Licence. | |
| bool | LoadVersionInfo (VERSION_INFO *Version, int ProjectIndex) |
| Load the Compiler Family Information for the Selected Licence. | |
| bool | LoadStatusInfo (STATUS_INFO *Status, int StatusIndex) |
| Load the Status Information for the Selected Licence. | |
| bool | LoadDeveloperData (DEVELOPER_INFO *person, int DevIndex) |
| Load the Developer Information for the Selected Licence. | |
| QString | FormatVersion (int MajorVersion, int MinorVersion, int Revision) |
| Format the Version information into a String. | |
Private Attributes | |
| QList< PROJECT_INFORMATION > | ProjectList |
| List of Projects to be Processed. | |
Definition at line 16 of file readprojectinfo.h.
|
explicit |
Read Project Info Clawss Constructor.
| parent | Pointer to Parent Object |
Definition at line 8 of file readprojectinfo.cpp.
| QString ReadProjectInfo::FindQtBuildVersion | ( | QString | ConfigFile | ) |
Find the Qt Builder Version.
| ConfigFile |
Definition at line 613 of file worker.cpp.
|
private |
Format the Version information into a String.
| MajorVersion | Project's Major Version |
| MinorVersion | Project's Minor Version |
| Revision | Project's Revision |
Definition at line 306 of file readprojectinfo.cpp.
Referenced by LoadFullHistory(), and LoadProjectInfo().
|
private |
Load the In Association Information for the Selected Licence.
| Pointer | to the Licence Structure |
| LicenceIndex | Database Index of the Desired Licence |
Definition at line 122 of file readprojectinfo.cpp.
References ASSOCIATED_GROUP_INFO::AssociationLogo, ASSOCIATED_GROUP_INFO::AssociationURL, ASSOCIATED_GROUP_INFO::FullName, ASSOCIATED_GROUP_INFO::HtaccessFileName, ASSOCIATED_GROUP_INFO::InAssociationIndex, LOG_DEBUG, LogAdd(), MODE_DATABASE, and ASSOCIATED_GROUP_INFO::ShortName.
Referenced by LoadProjectInfo().
|
private |
Load the Compiler Family Information for the Selected Licence.
| CompFam | Index to the Computer Family Structure |
| CompFamilyIndex | Database Index of the Desired Computer Family |
Definition at line 234 of file readprojectinfo.cpp.
References COMP_FAMILY_INFO::CompFamilyIndex, COMP_FAMILY_INFO::CompilerDirectory, COMP_FAMILY_INFO::CompilerToolImage, COMP_FAMILY_INFO::DocumentationLicenceRestriction, COMP_FAMILY_INFO::FullName, COMP_FAMILY_INFO::HardwareLicenceRestriction, LOG_DEBUG, LogAdd(), MODE_DATABASE, COMP_FAMILY_INFO::ShortName, and COMP_FAMILY_INFO::SoftwareLicenceRestriction.
Referenced by LoadProjectInfo().
|
private |
Load the Developer Information for the Selected Licence.
| Person | Developer Structure |
| DevIndex | Database Index of the Developer |
Definition at line 332 of file readprojectinfo.cpp.
References DEVELOPER_INFO::DateJoined, DEVELOPER_INFO::DateLeft, DEVELOPER_INFO::DeveloperIndex, DEVELOPER_INFO::Email, DEVELOPER_INFO::Handle, DEVELOPER_INFO::Info, DEVELOPER_INFO::IsAvailable, DEVELOPER_INFO::Name, and DEVELOPER_INFO::Phone.
Referenced by LoadProjectInfo().
|
private |
Load the Licence Information for the Selected Licence.
| Pointer | to the In Development Family Structure |
| DevFamilyIndex | Database Index of the Desired Licence |
Definition at line 152 of file readprojectinfo.cpp.
References DEV_FAMILY_INFO::DevFamilyImage, DEV_FAMILY_INFO::DevFamilyIndex, DEV_FAMILY_INFO::FullName, LOG_DEBUG, LogAdd(), MODE_DATABASE, and DEV_FAMILY_INFO::ShortName.
Referenced by LoadProjectInfo().
|
private |
Load the Compiler Family Information for the Selected Licence.
| Version | Version whose history is to be Read |
| ProjectIndex | Database Index of the Project |
Definition at line 286 of file readprojectinfo.cpp.
References FormatVersion(), and VERSION_INFO::FullVersionString.
Referenced by LoadProjectInfo().
|
private |
Load the Licence Information for the Selected Licence.
| Pointer | to the Development Famil;y Structure |
| LangFamilyIndex | Database Index of the Desired Licence |
Definition at line 179 of file readprojectinfo.cpp.
References LANG_FAMILY_INFO::FullName, LANG_FAMILY_INFO::LangFamilyImage, LANG_FAMILY_INFO::LangFamilyIndex, LOG_DEBUG, LogAdd(), MODE_DATABASE, and LANG_FAMILY_INFO::ShortName.
Referenced by LoadProjectInfo().
|
private |
Load the Licence Information for the Selected Licence.
| Pointer | to the Licence Structure |
| LicenceIndex | Database Index of the Desired Licence |
Definition at line 94 of file readprojectinfo.cpp.
References LICENCE_INFO::FullName, LICENCE_INFO::LicenceImage, LICENCE_INFO::LicenceIndex, LICENCE_INFO::LicenceURL, LOG_DEBUG, LogAdd(), MODE_DATABASE, and LICENCE_INFO::ShortName.
Referenced by LoadProjectInfo().
| bool ReadProjectInfo::LoadProjectInfo | ( | PROJECT_INFORMATION * | Store, |
| int | ProjectIndex, | ||
| int | ProjManIndex ) |
Load Project & relevant System Information into the Structure.
| ProjectIndex | The Database Index of the Project |
| ProjManIndex | The Datgabase Index of the Site where the Documentation will be placed |
Definition at line 14 of file readprojectinfo.cpp.
References PROJECT_DESCRIPTION::BriefDescription, PROJECT_INFORMATION::CompFamilyInfo, PROGRAM_INFORMATION::CurrentUser, DATETIME_DISPLAY_FORMAT, PROGRAM_INFORMATION::DefaultReturnAddress, PROJECT_DESCRIPTION::DepartureURL, PROJECT_INFORMATION::Developer, PROGRAM_INFORMATION::DevelopmentDoxyDocDirectory, PROJECT_INFORMATION::DevFamilyInfo, PROJECT_INFORMATION::DocLicence, DOXY_OPTIONS::DoxyExtraStylesheetFilename, DOXY_OPTIONS::DoxyHtmlFooterFilename, DOXY_OPTIONS::DoxyHtmlHeaderFilename, DOXY_OPTIONS::DoxyLogoFilename, PROJECT_INFORMATION::DoxyOptions, PROJECT_DESCRIPTION::ExeDirectory, PROJECT_DESCRIPTION::ExeName, FormatVersion(), PROJECT_DESCRIPTION::FullDescription, PROJECT_INFORMATION::HardwareLicence, PROJECT_INFORMATION::InAssocInfo, PROJECT_INFORMATION::LangFamilyInfo, LoadAssocGroupData(), LoadCompilerFamilyData(), LoadDeveloperData(), LoadDevFamilyData(), LoadFullHistory(), LoadLangFamilyData(), LoadLicenceData(), LoadStatusInfo(), LoadTargetFamilyData(), LoadVersionInfo(), PROGRAM_INFORMATION::LocalDevelopmentDirectory, LOG_DEBUG, LOG_ERROR, LogAdd(), VERSION_INFO::MajorVersion, VERSION_INFO::MinorVersion, MODE_DATABASE, PM_LOCAL_DEV_DIRECTORY, PM_PRIMARY_WEBSITE_DIRECTORY, PM_PROJ_MANAGER_INDEX, PM_PROJECT_DEVELOPMENT_DOXY_DIRECTORY, PM_PROJECT_LIST_FOOTER_FILENAME, PM_PROJECT_LIST_HEADER_FILENAME, PM_PROJECT_LIST_LINE_FILENAME, PM_PROJECT_LIST_RETURN_ADDRESS, PM_PROJECT_PREFIX, PM_PUBLISHER_CONTACT_EMAIL, PM_PUBLISHER_NAME, PM_PUBLISHER_WEBSITE, PM_SHARED_TEMPLATE_DIR, PM_SITE_LOGO, PM_SITE_NAME, PM_SITE_URL, PM_SUFFIX_SIZE, PROGRAM_INFORMATION::PrimaryWebsiteDirectory, PROJECT_INFORMATION::ProgramInformation, PROGRAM_INFORMATION::ProgramInformationIndex, PROJECT_INFORMATION::ProjectDesc, PROJECT_DESCRIPTION::ProjectDirectory, PROJECT_DESCRIPTION::ProjectIcon, PROJECT_DESCRIPTION::ProjectIdent, PROJECT_DESCRIPTION::ProjectIndex, PROGRAM_INFORMATION::ProjectListFooterFilename, PROGRAM_INFORMATION::ProjectListHeaderFilename, PROGRAM_INFORMATION::ProjectListLineFilename, PROJECT_INFORMATION::ProjectLock, PROJECT_DESCRIPTION::ProjectName, PROJECT_DESCRIPTION::ProjectOptions, PROGRAM_INFORMATION::ProjectPrefix, PROJECT_INFORMATION::ProjectQueued, PT_ASSOC_GROUP, PT_BRIEF_DESCRIPTION, PT_COMPILER_FAMILY, PT_COMPILER_TYPE, PT_DEPARTURE_URL, PT_DEV_FAMILY, PT_DOC_LICENCE, PT_DOXY_EXTRA_STYLESHEET_FILENAME, PT_DOXY_HTML_FOOTER_FILENAME, PT_DOXY_HTML_HEADER_FILENAME, PT_DOXY_PROJECT_LOGO_FILENAME, PT_EXECUTABLE_DIRECTORY, PT_EXECUTABLE_NAME, PT_FULL_DESCRIPTION, PT_HARDWARE_LICENCE, PT_ICON_FILENAME, PT_MAJOR_VERSION, PT_MINOR_VERSION, PT_PROJECT_CONTACT, PT_PROJECT_DIRECTORY, PT_PROJECT_IDENT, PT_PROJECT_INDEX, PT_PROJECT_LOCK, PT_PROJECT_NAME, PT_PROJECT_OPTIONS, PT_PROJECT_QUEUED, PT_PROJECT_STATUS, PT_REVISION, PT_SOFTWARE_LICENCE, PT_STATUS_DATE, PT_TARGET_FAMILY, PROGRAM_INFORMATION::PublisherContactEmail, PROGRAM_INFORMATION::PublisherName, PROGRAM_INFORMATION::PublisherWebsite, VERSION_INFO::Revision, PROGRAM_INFORMATION::SharedTemplateDirectory, PROGRAM_INFORMATION::SiteLogo, PROGRAM_INFORMATION::SiteName, PROGRAM_INFORMATION::SiteURL, PROJECT_INFORMATION::SoftwareLicence, STATUS_INFO::StatusDateTime, STATUS_INFO::StatusDateTimeString, PROJECT_INFORMATION::StatusInfo, PROGRAM_INFORMATION::SuffixSize, PROJECT_INFORMATION::TargetFamilyInfo, PROJECT_INFORMATION::VersionInfo, and VERSION_INFO::VersionString.
|
private |
Load the Status Information for the Selected Licence.
| Version | Version whose history is to be Read |
| StatusIndex | Database Index of the Status Level |
Definition at line 313 of file readprojectinfo.cpp.
References STATUS_INFO::StatusDescription, STATUS_INFO::StatusImage, STATUS_INFO::StatusIndex, and STATUS_INFO::StatusName.
Referenced by LoadProjectInfo().
|
private |
Load the Compiler Family Information for the Selected Licence.
| TargetFam | Index to the Target Family Structure |
| TargetFamilyIndex | Database Index of the Desired target Family |
Definition at line 206 of file readprojectinfo.cpp.
References TARGET_FAMILY_INFO::FullName, LOG_DEBUG, LogAdd(), MODE_DATABASE, TARGET_FAMILY_INFO::ShortName, TARGET_FAMILY_INFO::TargetFamilyImage, and TARGET_FAMILY_INFO::TargetFamilyIndex.
Referenced by LoadProjectInfo().
|
private |
Load the Compiler Family Information for the Selected Licence.
| Version | Version whose history is to be Read |
| ProjectIndex | Database Index of the Project |
Definition at line 268 of file readprojectinfo.cpp.
References VERSION_INFO::CurrentVersionString, DATETIME_DISPLAY_FORMAT, VERSION_INFO::MajorVersion, VERSION_INFO::MinorVersion, VERSION_INFO::Revision, VERSION_INFO::VersionDate, and VERSION_INFO::VersionDateString.
Referenced by LoadProjectInfo().
|
private |
Send Message to the Log.
| Severity | Severity of the Log Message |
| Mode | Which part of the program does the message relate to |
| Message | Text message to be added to the Log |
Definition at line 356 of file readprojectinfo.cpp.
References REMOTE_LOG_ENTRY::Message, REMOTE_LOG_ENTRY::Mode, SendLogEntry(), and REMOTE_LOG_ENTRY::Severity.
Referenced by LoadAssocGroupData(), LoadCompilerFamilyData(), LoadDevFamilyData(), LoadLangFamilyData(), LoadLicenceData(), LoadProjectInfo(), LoadTargetFamilyData(), and SetProjectStatus().
|
signal |
Send Log Entry to the Log \LogEntry Structure holding Log information.
Referenced by LogAdd().
| bool ReadProjectInfo::SetProjectStatus | ( | int | ProjectIndex, |
| bool | LockState, | ||
| bool | QueueState ) |
Set the Locked and Queued State of the Project.
| ProjectIndex | Database Project Index |
| LockState | Locked (true) or Unlocked (false) |
| QueueState | Queued (true) or Unqueued (false) |
Definition at line 365 of file readprojectinfo.cpp.
References current_locked_project, LOG_DEBUG, LOG_ERROR, LogAdd(), and MODE_DATABASE.
|
private |
List of Projects to be Processed.
Definition at line 62 of file readprojectinfo.h.