Common Structure Defintitions. More...

#include <QString>
#include <QDateTime>
#include <QColor>

Include dependency graph for common_definitions.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	LICENCE_STATE
	Assigned Software, Hardware and COgumenttaion Licences. More...
struct	LICENCE_INFO
	Fields describing a Licence. More...
struct	DEVELOPER_INFO
	Personal Information about the Developer. More...
struct	VERSION_INFO
	Information about the Project's Version. More...
struct	STATUS_INFO
	Information about the Development Status. More...
struct	CATEGORY_INFO
	Background Information about Project. More...
struct	ASSOCIATED_GROUP_INFO
	Inforamtion about Group Associated with the Project. More...
struct	DOXY_OPTIONS
	Major options for the Doxygen Process. More...
struct	PROJECT_DESCRIPTION
struct	PROGRAM_INFORMATION
	Information that is common to all Projects. More...
struct	DEVELOPMENT_FAMILY
	Summary of Project Types. More...
struct	DEV_FAMILY_INFO
	Project Groups like Home Automation, Houseboat, Sensors, etc. More...
struct	LANG_FAMILY_INFO
	Language groups like C++, Javascript, CAD etc. More...
struct	TARGET_FAMILY_INFO
	Target Systems like Linux, Windows, Arduino. More...
struct	COMP_FAMILY_INFO
	Information about the Primary Tool. More...
struct	REMOTE_VERSION_ENTRY
	Version Structure used between functions. More...
struct	PROJECT_INFORMATION
	Project Information Passed Between Functions. More...

Macros
#define	LOCK_COLOUR 255,0,0
	The Text colour indicating a Locked Project.
#define	QUEUED_COLOUR 200,200,0
#define	INACTIVE_COLOUR 0,0,0
	The Text colour indicating an unlocked and unqueued Project.
#define	DATETIME_DISPLAY_FORMAT "hh:mm:ss dd-MMMM-yyyy"
	DateTime formatting for the program displays.
#define	DATETIME_DATABASE_FORMAT "yyyy-MM-dd hh:mm:ss"
	text format of the DateTime used by the Database.
#define	TABLE_COLUMN_COUNT (PUBLISH_BUTTON_COLUMN + 1)
	Number of Columns in the Project List Table.
#define	INSTALL_SCRIPT_MASK (1 << INSTALL_SCRIPT_BIT)
	Bit Mask for the Install Script.
#define	ARCHIVE_MASK (1 << ARCHIVE_BIT)
	Bit Mask for Updating the Project's Git.
#define	PUBLISH_MASK (1 << PUBLISH_BIT)
	Bit Mask for publishing the Doxygen Files.
#define	EXCLUDE_PROJECT_LIST (1<< EXCLUDE_PROJECT_LIST_BIT)
	Exclude Project from Public List Mask.
#define	CONTROL_DOC_ACCESS (1<< CONTROL_DOC_ACCESS_BIT)
	Control Document Access to Public Mask.
#define	ONLY_DEFAULT_PAGE (1<< ONLY_DEFAULT_PAGE_BIT)
	Only Display Default Page to Public Mask.
#define	GROUP_ACCESS_ONLY (1<< GROUP_ACCESS_ONLY_BIT)
	restrict Public Access Mask
#define	ENABLE_CUSTOM_DOXYGEN (1<< ENABLE_CUSTOM_DOXYGEN_BIT)
	Enable Custom Doxygen Definitions Mask.
#define	CAVEAT_LECTOR (1<< CAVEAT_LECTOR_BIT)
	Display User Warning Mask.
#define	POTENTIAL_HAZARD (1<< POTENTIAL_HAZARD_BIT)
	Display Potential Harzard Mask.
#define	ASSISTANCE_WELCOME (1<< ASSISTANCE_WELCOME_BIT)
	Display Assistance Welcome Mask.
#define	DONATIONS_WELCOME (1<< DONATIONS_WELCOME_BIT)
	Display Donations Welcome Mask.
#define	OFFER_PAYPAL_DONATION (1<< OFFER_PAYPAL_DONATION_BIT)
	Display Paypal Available Mask.
#define	CREATE_SOURCE_ARCHIVE (1<< CREATE_SOURCE_ARCHIVE_BIT)
	Create a SOurce Archive when Documentation Generated.
#define	ALLOW_AUTOMATIC_INSTALL (1 << ALLOW_AUTOMATIC_INSTALL_BIT)
#define	ONLY_UPDATE_SOURCE (1 << ONLY_UPDATE_SOURCE_BIT)
	Mask to Test if Only Source Code should be Processed.
#define	UPDATE_GIT_REVISION (1<< UPDATE_GIT_REVISION_BIT)
#define	DOXY_LOG_FILE "doxy_log_file.txt"
	The name of the Doxygen Log File.
#define	CPP_CHECK_FILE "cpp_results.txt"

Enumerations
enum	EXECUTION_STATUS { EXECUTION_SUCCESS , EXECUTION_WARNING , EXECUTION_FAILURE }
	Status Codes for Thread Execution. More...
enum	PROJECT_COLUMN_NUMBER { PROJECT_IDENT_COLUMN , PROJECT_NAME_COLUMN , TARGET_FAMILY_COLUMN , PROJECT_STATUS_COLUMN , PROJECT_CONTACT_COLUMN , BRIEF_DESC_COLUMN , DEV_FAMILY_COLUMN , COMPILER_FAMILY_COLUMN , ASSOCIATION_COLUMN , SOFTWARE_LICENCE_COLUMN , HARDWARE_LICENCE_COLUMN , DOC_LICENCE_COLUMN , INSTALL_BUTTON_COLUMN , ARCHIVE_BUTTON_COLUMN , PUBLISH_BUTTON_COLUMN }
	Column Number for the List of Projects. More...
enum	PROJECT_OPTION_BITS { EXCLUDE_PROJECT_LIST_BIT , CONTROL_DOC_ACCESS_BIT , ONLY_DEFAULT_PAGE_BIT , GROUP_ACCESS_ONLY_BIT , ENABLE_CUSTOM_DOXYGEN_BIT , CAVEAT_LECTOR_BIT , POTENTIAL_HAZARD_BIT , ASSISTANCE_WELCOME_BIT , DONATIONS_WELCOME_BIT , OFFER_PAYPAL_DONATION_BIT , CREATE_SOURCE_ARCHIVE_BIT , ALLOW_AUTOMATIC_INSTALL_BIT , UPDATE_GIT_REVISION_BIT , PROJECT_OPTION_BITS_END }
	Project's Doc Generator Options. More...
enum	PROJECT_SELECTION_BITS { INSTALL_SCRIPT_BIT , ARCHIVE_BIT , ONLY_UPDATE_SOURCE_BIT , PUBLISH_BIT }
	Bits hold the Running Options for each Project. More...
enum	PROJECT_TABLE_FIELDS { PT_PROJECT_INDEX , PT_PROJECT_NAME , PT_MAJOR_VERSION , PT_MINOR_VERSION , PT_REVISION , PT_BRIEF_DESCRIPTION , PT_DEV_FAMILY , PT_COMPILER_FAMILY , PT_PROJECT_STATUS , PT_PROJECT_LOCK , PT_COMPILER_TYPE , PT_STATUS_DATE , PT_DOC_LICENCE , PT_SOFTWARE_LICENCE , PT_HARDWARE_LICENCE , PT_PROJECT_CONTACT , PT_FULL_DESCRIPTION , PT_PROJECT_DIRECTORY , PT_ICON_FILENAME , PT_PROJECT_OPTIONS , PT_PROJECT_IDENT , PT_DOXY_PROJECT_LOGO_FILENAME , PT_DOXY_HTML_HEADER_FILENAME , PT_DOXY_HTML_FOOTER_FILENAME , PT_DOXY_EXTRA_STYLESHEET_FILENAME , PT_ASSOC_GROUP , PT_PROJECT_QUEUED , PT_TARGET_FAMILY , PT_DEPARTURE_URL , PT_EXECUTABLE_DIRECTORY , PT_EXECUTABLE_NAME , PT_DOT_IMAGE_TYPE , PT_DOXY_TAB_SIZE }
enum	PROJECT_MANAGER_FIELDS { PM_PROJ_MANAGER_INDEX , PM_SITE_NAME , PM_SITE_URL , PM_SITE_LOGO , PM_SHARED_TEMPLATE_DIR , PM_LOCAL_DEV_DIRECTORY , PM_DESTINATION_DIRECTORY , PM_INTERMEDIATE_DIRECTORY , PM_PROJECT_PREFIX , PM_SUFFIX_SIZE , PM_PRIMARY_WEBSITE_DIRECTORY , PM_SECONDARY_WEBSITE_DIRECTORY , PM_PUBLISHER_NAME , PM_PUBLISHER_WEBSITE , PM_PUBLISHER_CONTACT_EMAIL , PM_PROJECT_LIST_HEADER_FILENAME , PM_PROJECT_LIST_FOOTER_FILENAME , PM_PROJECT_LIST_LINE_FILENAME , PM_PROJECT_LIST_WEBPAGE_FILENAME , PM_PROJECT_LIST_RETURN_ADDRESS , PM_PROJECT_LIST_OPENSIM_FILENAME , PM_PROJECT_DEVELOPMENT_DOXY_DIRECTORY }
enum	PROJECT_TARGET_FAMILY { TARGET_NOT_DEFINED = 1 , TARGET_OPEN_SIM_PROJECT , TARGET_OPEN_SIM_SCRIPT , TARGET_SOFTWARE , TARGET_HARDWARE , TARGET_DEVELOPMENT , TARGET_DOCUMENTATION }

Detailed Description

Common Structure Defintitions.

These defintions are used by the various parts of the program so that the data can be easily p[assed around using pointers to these structures.

Definition in file common_definitions.h.

Macro Definition Documentation

◆ ALLOW_AUTOMATIC_INSTALL

#define ALLOW_AUTOMATIC_INSTALL (1 << ALLOW_AUTOMATIC_INSTALL_BIT)

Definition at line 369 of file common_definitions.h.

Referenced by ProjectOptionsManager::CheckAutomaticInstall(), ProjectListManager::LoadProjectTable(), ProjectOptionsManager::ReadOptionState(), ProjectOptionsManager::SetAllowAutomaticInstall(), and ProjectOptionsManager::WriteOptionState().

◆ ARCHIVE_MASK

#define ARCHIVE_MASK (1 << ARCHIVE_BIT)

Bit Mask for Updating the Project's Git.

Definition at line 291 of file common_definitions.h.

◆ ASSISTANCE_WELCOME

#define ASSISTANCE_WELCOME (1<< ASSISTANCE_WELCOME_BIT)

Display Assistance Welcome Mask.

Definition at line 345 of file common_definitions.h.

Referenced by ProjectOptionsManager::CheckAssistanceWelcome(), ProjectOptionsManager::ReadOptionState(), ProjectOptionsManager::SetAssistanceWelcome(), ProjectSubstitute::SetOptionState(), and ProjectOptionsManager::WriteOptionState().

◆ CAVEAT_LECTOR

#define CAVEAT_LECTOR (1<< CAVEAT_LECTOR_BIT)

Display User Warning Mask.

Definition at line 333 of file common_definitions.h.

Referenced by ProjectOptionsManager::CheckCaveatLector(), ProjectOptionsManager::ReadOptionState(), ProjectOptionsManager::SetCaveatLector(), ProjectSubstitute::SetOptionState(), and ProjectOptionsManager::WriteOptionState().

◆ CONTROL_DOC_ACCESS

#define CONTROL_DOC_ACCESS (1<< CONTROL_DOC_ACCESS_BIT)

Control Document Access to Public Mask.

Definition at line 309 of file common_definitions.h.

Referenced by Worker::PreProcessProject(), ProjectOptionsManager::ReadOptionState(), DoxygenManager::ReceiveResult(), ProjectOptionsManager::SetControlDocAccess(), ProjectSubstitute::SetOptionState(), and ProjectOptionsManager::WriteOptionState().

◆ CPP_CHECK_FILE

#define CPP_CHECK_FILE "cpp_results.txt"

Definition at line 539 of file common_definitions.h.

Referenced by Worker::CppCheck(), and ProjectSubstitute::LoadFileSubsList().

◆ CREATE_SOURCE_ARCHIVE

#define CREATE_SOURCE_ARCHIVE (1<< CREATE_SOURCE_ARCHIVE_BIT)

Create a SOurce Archive when Documentation Generated.

Definition at line 363 of file common_definitions.h.

Referenced by ProjectOptionsManager::CheckCreateSourceArchive(), Worker::CreateSourceArchive(), ProjectListManager::FindSelections(), ProjectSubstitute::LoadFileSubsList(), ProjectListManager::LoadProjectTable(), ProjectOptionsManager::ReadOptionState(), ProjectOptionsManager::SetCreateSourceArchive(), and ProjectOptionsManager::WriteOptionState().

◆ DATETIME_DATABASE_FORMAT

#define DATETIME_DATABASE_FORMAT "yyyy-MM-dd hh:mm:ss"

text format of the DateTime used by the Database.

This format is compatible with teDataTime text layout that makes it easy to convert text DateTime variables into te databhase format.

Definition at line 51 of file common_definitions.h.

Referenced by ProjectStatus::PostStatus(), and ProgramVersion::SaveVersion().

◆ DATETIME_DISPLAY_FORMAT

#define DATETIME_DISPLAY_FORMAT "hh:mm:ss dd-MMMM-yyyy"

DateTime formatting for the program displays.

This dis paly format is used for the common Australian data format. It can be changed as required.

Definition at line 42 of file common_definitions.h.

Referenced by ReadProjectInfo::LoadProjectInfo(), ProjectSubstitute::LoadSubsTable(), ReadProjectInfo::LoadVersionInfo(), and ProgramVersion::ProgramVersion().

◆ DONATIONS_WELCOME

#define DONATIONS_WELCOME (1<< DONATIONS_WELCOME_BIT)

Display Donations Welcome Mask.

Definition at line 351 of file common_definitions.h.

Referenced by ProjectOptionsManager::ChecktDonationsWelcome(), ProjectOptionsManager::ReadOptionState(), ProjectOptionsManager::SetDonationsWelcome(), ProjectSubstitute::SetOptionState(), and ProjectOptionsManager::WriteOptionState().

◆ DOXY_LOG_FILE

#define DOXY_LOG_FILE "doxy_log_file.txt"

The name of the Doxygen Log File.

Definition at line 533 of file common_definitions.h.

Referenced by Worker::DoDoxygen(), and ProjectSubstitute::LoadFileSubsList().

◆ ENABLE_CUSTOM_DOXYGEN

#define ENABLE_CUSTOM_DOXYGEN (1<< ENABLE_CUSTOM_DOXYGEN_BIT)

Enable Custom Doxygen Definitions Mask.

Definition at line 327 of file common_definitions.h.

Referenced by ProjectOptionsManager::CheckEnableCustomDoxygen(), ProjectOptionsManager::ReadOptionState(), ProjectOptionsManager::SetEnableCustomDoxygen(), ProjectSubstitute::SetOptionState(), and ProjectOptionsManager::WriteOptionState().

◆ EXCLUDE_PROJECT_LIST

#define EXCLUDE_PROJECT_LIST (1<< EXCLUDE_PROJECT_LIST_BIT)

Exclude Project from Public List Mask.

Definition at line 303 of file common_definitions.h.

Referenced by ProjectOptionsManager::CheckExcludeProjectList(), ProjectListManager::MakeHTMLProjectPage(), Worker::PreProcessProject(), ProjectOptionsManager::ReadOptionState(), ProjectOptionsManager::SetExcludeProjectList(), ProjectSubstitute::SetOptionState(), and ProjectOptionsManager::WriteOptionState().

◆ GROUP_ACCESS_ONLY

#define GROUP_ACCESS_ONLY (1<< GROUP_ACCESS_ONLY_BIT)

restrict Public Access Mask

Definition at line 321 of file common_definitions.h.

Referenced by ProjectOptionsManager::CheckControlDocAccess(), ProjectOptionsManager::CheckGroupAccessOnly(), ProjectOptionsManager::ReadOptionState(), DoxygenManager::ReceiveResult(), ProjectOptionsManager::SetGroupAccessOnly(), and ProjectOptionsManager::WriteOptionState().

◆ INACTIVE_COLOUR

#define INACTIVE_COLOUR 0,0,0

The Text colour indicating an unlocked and unqueued Project.

Definition at line 32 of file common_definitions.h.

Referenced by ProjectListManager::PrStateChange().

◆ INSTALL_SCRIPT_MASK

#define INSTALL_SCRIPT_MASK (1 << INSTALL_SCRIPT_BIT)

Bit Mask for the Install Script.

Definition at line 285 of file common_definitions.h.

Referenced by ProjectListManager::FindSelections().

◆ LOCK_COLOUR

#define LOCK_COLOUR 255,0,0

The Text colour indicating a Locked Project.

Definition at line 20 of file common_definitions.h.

Referenced by ProjectListManager::PrStateChange().

◆ OFFER_PAYPAL_DONATION

#define OFFER_PAYPAL_DONATION (1<< OFFER_PAYPAL_DONATION_BIT)

Display Paypal Available Mask.

Definition at line 357 of file common_definitions.h.

Referenced by ProjectOptionsManager::CheckOfferPaypalDonation(), ProjectOptionsManager::ReadOptionState(), ProjectOptionsManager::SetOfferPaypalDonation(), ProjectSubstitute::SetOptionState(), and ProjectOptionsManager::WriteOptionState().

◆ ONLY_DEFAULT_PAGE

#define ONLY_DEFAULT_PAGE (1<< ONLY_DEFAULT_PAGE_BIT)

Only Display Default Page to Public Mask.

Definition at line 315 of file common_definitions.h.

Referenced by ProjectOptionsManager::CheckOnlyDefaultPage(), Worker::PreProcessProject(), ProjectOptionsManager::ReadOptionState(), ProjectOptionsManager::SetOnlyDefaultPage(), ProjectSubstitute::SetOptionState(), and ProjectOptionsManager::WriteOptionState().

◆ ONLY_UPDATE_SOURCE

#define ONLY_UPDATE_SOURCE (1 << ONLY_UPDATE_SOURCE_BIT)

Mask to Test if Only Source Code should be Processed.

Referenced by ProjectDocManager::UpdateProjectToDatabase().

◆ POTENTIAL_HAZARD

#define POTENTIAL_HAZARD (1<< POTENTIAL_HAZARD_BIT)

Display Potential Harzard Mask.

Definition at line 339 of file common_definitions.h.

Referenced by ProjectOptionsManager::CheckPotentialHazard(), ProjectOptionsManager::ReadOptionState(), ProjectSubstitute::SetOptionState(), ProjectOptionsManager::SetPotentialHazard(), and ProjectOptionsManager::WriteOptionState().

◆ PUBLISH_MASK

#define PUBLISH_MASK (1 << PUBLISH_BIT)

Bit Mask for publishing the Doxygen Files.

Definition at line 297 of file common_definitions.h.

◆ QUEUED_COLOUR

#define QUEUED_COLOUR 200,200,0

Definition at line 26 of file common_definitions.h.

Referenced by ProjectListManager::PrStateChange().

◆ TABLE_COLUMN_COUNT

#define TABLE_COLUMN_COUNT (PUBLISH_BUTTON_COLUMN + 1)

Number of Columns in the Project List Table.

Definition at line 222 of file common_definitions.h.

Referenced by ProjectListManager::ProjectListManager().

◆ UPDATE_GIT_REVISION

#define UPDATE_GIT_REVISION (1<< UPDATE_GIT_REVISION_BIT)

Definition at line 381 of file common_definitions.h.

Referenced by ProjectOptionsManager::CheckAutomaticGit(), and ProjectOptionsManager::SetUpdateGitRevision().

Enumeration Type Documentation

◆ EXECUTION_STATUS

enum EXECUTION_STATUS

Status Codes for Thread Execution.

Enumerator
EXECUTION_SUCCESS	Execution Success Status
EXECUTION_WARNING	Execution Warning Status
EXECUTION_FAILURE	Execution Failure Status

Definition at line 57 of file common_definitions.h.

{
    EXECUTION_SUCCESS, 
    EXECUTION_WARNING, 
    EXECUTION_FAILURE  
};

◆ PROJECT_COLUMN_NUMBER

enum PROJECT_COLUMN_NUMBER

Column Number for the List of Projects.

Enumerator
PROJECT_IDENT_COLUMN	Column holding the Project Identification
PROJECT_NAME_COLUMN	Column holding the Project Name
TARGET_FAMILY_COLUMN	Column holding the Target System Type
PROJECT_STATUS_COLUMN	Column holding the Project's Current Status
PROJECT_CONTACT_COLUMN	Column holding the Project's Contact's Name
BRIEF_DESC_COLUMN	Column holding the Project's Brief Description
DEV_FAMILY_COLUMN	Column holding the Project's Development Family
COMPILER_FAMILY_COLUMN	Column holding the Project's Compiler Family
ASSOCIATION_COLUMN	Column holding the Projet's Associated Organisation
SOFTWARE_LICENCE_COLUMN	Column holding the Project's Software Licence
HARDWARE_LICENCE_COLUMN	Column holding the Project's Hardware Licence
DOC_LICENCE_COLUMN	Column holding the Project's Documentation Licence
INSTALL_BUTTON_COLUMN	Column holding the Project's Installation Button
ARCHIVE_BUTTON_COLUMN	Column holding the Project's Archive Button
PUBLISH_BUTTON_COLUMN	Column holding the Project's Publish Button

Definition at line 199 of file common_definitions.h.

{
    PROJECT_IDENT_COLUMN,               
    PROJECT_NAME_COLUMN,                
    TARGET_FAMILY_COLUMN,               
    PROJECT_STATUS_COLUMN,              
    PROJECT_CONTACT_COLUMN,             
    BRIEF_DESC_COLUMN,                  
    DEV_FAMILY_COLUMN,                  
    COMPILER_FAMILY_COLUMN,             
    ASSOCIATION_COLUMN,                 
    SOFTWARE_LICENCE_COLUMN,            
    HARDWARE_LICENCE_COLUMN,            
    DOC_LICENCE_COLUMN,                 
    INSTALL_BUTTON_COLUMN,              
    ARCHIVE_BUTTON_COLUMN,              
    PUBLISH_BUTTON_COLUMN               
};

◆ PROJECT_MANAGER_FIELDS

enum PROJECT_MANAGER_FIELDS

Enumerator
PM_PROJ_MANAGER_INDEX
PM_SITE_NAME
PM_SITE_URL
PM_SITE_LOGO
PM_SHARED_TEMPLATE_DIR
PM_LOCAL_DEV_DIRECTORY
PM_DESTINATION_DIRECTORY
PM_INTERMEDIATE_DIRECTORY
PM_PROJECT_PREFIX
PM_SUFFIX_SIZE
PM_PRIMARY_WEBSITE_DIRECTORY
PM_SECONDARY_WEBSITE_DIRECTORY
PM_PUBLISHER_NAME
PM_PUBLISHER_WEBSITE
PM_PUBLISHER_CONTACT_EMAIL
PM_PROJECT_LIST_HEADER_FILENAME
PM_PROJECT_LIST_FOOTER_FILENAME
PM_PROJECT_LIST_LINE_FILENAME
PM_PROJECT_LIST_WEBPAGE_FILENAME
PM_PROJECT_LIST_RETURN_ADDRESS
PM_PROJECT_LIST_OPENSIM_FILENAME
PM_PROJECT_DEVELOPMENT_DOXY_DIRECTORY

Definition at line 578 of file common_definitions.h.

{
    PM_PROJ_MANAGER_INDEX,
    PM_SITE_NAME,
    PM_SITE_URL,
    PM_SITE_LOGO,
    PM_SHARED_TEMPLATE_DIR,
    PM_LOCAL_DEV_DIRECTORY,
    PM_DESTINATION_DIRECTORY,
    PM_INTERMEDIATE_DIRECTORY,
    PM_PROJECT_PREFIX,
    PM_SUFFIX_SIZE,
    PM_PRIMARY_WEBSITE_DIRECTORY,
    PM_SECONDARY_WEBSITE_DIRECTORY,
    PM_PUBLISHER_NAME,
    PM_PUBLISHER_WEBSITE,
    PM_PUBLISHER_CONTACT_EMAIL,
    PM_PROJECT_LIST_HEADER_FILENAME,
    PM_PROJECT_LIST_FOOTER_FILENAME,
    PM_PROJECT_LIST_LINE_FILENAME,
    PM_PROJECT_LIST_WEBPAGE_FILENAME,
    PM_PROJECT_LIST_RETURN_ADDRESS,
    PM_PROJECT_LIST_OPENSIM_FILENAME,
    PM_PROJECT_DEVELOPMENT_DOXY_DIRECTORY
};

◆ PROJECT_OPTION_BITS

enum PROJECT_OPTION_BITS

Project's Doc Generator Options.

Enumerator
EXCLUDE_PROJECT_LIST_BIT	Exclude Project from List if Bit is Set
CONTROL_DOC_ACCESS_BIT	Control Document Access if the Bit is Set
ONLY_DEFAULT_PAGE_BIT	Only Build Default Page if the Bit is Set
GROUP_ACCESS_ONLY_BIT	Only allow Access by the Group if Bit is Set
ENABLE_CUSTOM_DOXYGEN_BIT	Enable Custom Doxygen Setting if Bit is Set
CAVEAT_LECTOR_BIT	Display "Reader Beware" caution if Bit is Set
POTENTIAL_HAZARD_BIT	Display "Potentially Hazardous" caution if Bit is Set
ASSISTANCE_WELCOME_BIT	Display "Assistance Welcome" message if Bit is Set
DONATIONS_WELCOME_BIT	Display "Donations Welcome message if Bit is Set
OFFER_PAYPAL_DONATION_BIT	Display "Paypal Available" message if Bit is Set
CREATE_SOURCE_ARCHIVE_BIT	Create Archive of Source when Documentation Built
ALLOW_AUTOMATIC_INSTALL_BIT	All the Creation of an Installation Script
UPDATE_GIT_REVISION_BIT	Update the Git Revision
PROJECT_OPTION_BITS_END	End of the Project Option's List

Definition at line 249 of file common_definitions.h.

{
    EXCLUDE_PROJECT_LIST_BIT,       
    CONTROL_DOC_ACCESS_BIT,         
    ONLY_DEFAULT_PAGE_BIT,          
    GROUP_ACCESS_ONLY_BIT,          
    ENABLE_CUSTOM_DOXYGEN_BIT,      
    CAVEAT_LECTOR_BIT,              
    POTENTIAL_HAZARD_BIT,           
    ASSISTANCE_WELCOME_BIT,         
    DONATIONS_WELCOME_BIT,          
    OFFER_PAYPAL_DONATION_BIT,      
    CREATE_SOURCE_ARCHIVE_BIT,      
    ALLOW_AUTOMATIC_INSTALL_BIT,    
    UPDATE_GIT_REVISION_BIT,        
 
    // Insert new bits above this line
    PROJECT_OPTION_BITS_END         
};

◆ PROJECT_SELECTION_BITS

enum PROJECT_SELECTION_BITS

Bits hold the Running Options for each Project.

Enumerator
INSTALL_SCRIPT_BIT	Create the Installation Script
ARCHIVE_BIT	Save to Project to Git
ONLY_UPDATE_SOURCE_BIT	Only Update the Source Code for Compilation
PUBLISH_BIT	Copy the Doxygen Files to the Website

Definition at line 273 of file common_definitions.h.

{
    INSTALL_SCRIPT_BIT,             
    ARCHIVE_BIT,                    
    ONLY_UPDATE_SOURCE_BIT,         
    PUBLISH_BIT                     
};

◆ PROJECT_TABLE_FIELDS

enum PROJECT_TABLE_FIELDS

Enumerator
PT_PROJECT_INDEX
PT_PROJECT_NAME
PT_MAJOR_VERSION
PT_MINOR_VERSION
PT_REVISION
PT_BRIEF_DESCRIPTION
PT_DEV_FAMILY
PT_COMPILER_FAMILY
PT_PROJECT_STATUS
PT_PROJECT_LOCK
PT_COMPILER_TYPE
PT_STATUS_DATE
PT_DOC_LICENCE
PT_SOFTWARE_LICENCE
PT_HARDWARE_LICENCE
PT_PROJECT_CONTACT
PT_FULL_DESCRIPTION
PT_PROJECT_DIRECTORY
PT_ICON_FILENAME
PT_PROJECT_OPTIONS
PT_PROJECT_IDENT
PT_DOXY_PROJECT_LOGO_FILENAME
PT_DOXY_HTML_HEADER_FILENAME
PT_DOXY_HTML_FOOTER_FILENAME
PT_DOXY_EXTRA_STYLESHEET_FILENAME
PT_ASSOC_GROUP
PT_PROJECT_QUEUED
PT_TARGET_FAMILY
PT_DEPARTURE_URL
PT_EXECUTABLE_DIRECTORY
PT_EXECUTABLE_NAME
PT_DOT_IMAGE_TYPE
PT_DOXY_TAB_SIZE

Definition at line 541 of file common_definitions.h.

{
    PT_PROJECT_INDEX,
    PT_PROJECT_NAME,
    PT_MAJOR_VERSION,
    PT_MINOR_VERSION,
    PT_REVISION,
    PT_BRIEF_DESCRIPTION,
    PT_DEV_FAMILY,
    PT_COMPILER_FAMILY,
    PT_PROJECT_STATUS,
    PT_PROJECT_LOCK,
    PT_COMPILER_TYPE,
    PT_STATUS_DATE,
    PT_DOC_LICENCE,
    PT_SOFTWARE_LICENCE,
    PT_HARDWARE_LICENCE,
    PT_PROJECT_CONTACT,
    PT_FULL_DESCRIPTION,
    PT_PROJECT_DIRECTORY,
    PT_ICON_FILENAME,
    PT_PROJECT_OPTIONS,
    PT_PROJECT_IDENT,
    PT_DOXY_PROJECT_LOGO_FILENAME,
    PT_DOXY_HTML_HEADER_FILENAME,
    PT_DOXY_HTML_FOOTER_FILENAME,
    PT_DOXY_EXTRA_STYLESHEET_FILENAME,
    PT_ASSOC_GROUP,
    PT_PROJECT_QUEUED,
    PT_TARGET_FAMILY,
    PT_DEPARTURE_URL,
    PT_EXECUTABLE_DIRECTORY,
    PT_EXECUTABLE_NAME,
    PT_DOT_IMAGE_TYPE,
    PT_DOXY_TAB_SIZE
};

◆ PROJECT_TARGET_FAMILY

enum PROJECT_TARGET_FAMILY

Enumerator
TARGET_NOT_DEFINED
TARGET_OPEN_SIM_PROJECT
TARGET_OPEN_SIM_SCRIPT
TARGET_SOFTWARE
TARGET_HARDWARE
TARGET_DEVELOPMENT
TARGET_DOCUMENTATION

Definition at line 604 of file common_definitions.h.

{
    TARGET_NOT_DEFINED = 1,
    TARGET_OPEN_SIM_PROJECT,
    TARGET_OPEN_SIM_SCRIPT,
    TARGET_SOFTWARE,
    TARGET_HARDWARE,
    TARGET_DEVELOPMENT,
    TARGET_DOCUMENTATION
};

Data Structures

Macros

Enumerations

Detailed Description

Macro Definition Documentation

◆ ALLOW_AUTOMATIC_INSTALL

◆ ARCHIVE_MASK

◆ ASSISTANCE_WELCOME

◆ CAVEAT_LECTOR

◆ CONTROL_DOC_ACCESS

◆ CPP_CHECK_FILE

◆ CREATE_SOURCE_ARCHIVE

◆ DATETIME_DATABASE_FORMAT

◆ DATETIME_DISPLAY_FORMAT

◆ DONATIONS_WELCOME

◆ DOXY_LOG_FILE

◆ ENABLE_CUSTOM_DOXYGEN

◆ EXCLUDE_PROJECT_LIST

◆ GROUP_ACCESS_ONLY

◆ INACTIVE_COLOUR

◆ INSTALL_SCRIPT_MASK

◆ LOCK_COLOUR

◆ OFFER_PAYPAL_DONATION

◆ ONLY_DEFAULT_PAGE

◆ ONLY_UPDATE_SOURCE

◆ POTENTIAL_HAZARD

◆ PUBLISH_MASK

◆ QUEUED_COLOUR

◆ TABLE_COLUMN_COUNT

◆ UPDATE_GIT_REVISION

Enumeration Type Documentation

◆ EXECUTION_STATUS

◆ PROJECT_COLUMN_NUMBER

◆ PROJECT_MANAGER_FIELDS

◆ PROJECT_OPTION_BITS

◆ PROJECT_SELECTION_BITS

◆ PROJECT_TABLE_FIELDS

◆ PROJECT_TARGET_FAMILY