common_definitions.h

Go to the documentation of this file.

 
#ifndef COMMON_DEFINITIONS_H
#define COMMON_DEFINITIONS_H
 
#include <QString>
#include <QDateTime>
#include <QColor>

#define LOCK_COLOUR 255,0,0

#define QUEUED_COLOUR 200,200,0

#define INACTIVE_COLOUR 0,0,0
 

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

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

enum EXECUTION_STATUS
{
    EXECUTION_SUCCESS, 
    EXECUTION_WARNING, 
    EXECUTION_FAILURE  
};

struct LICENCE_STATE
{
    uint SoftwareLicence;      
    uint DocumentationLicence; 
    uint HardwareLicence;      
};

struct LICENCE_INFO
{
    int LicenceIndex;       
    QString ShortName;      
    QString FullName;       
    QString LicenceURL;     
    QString LicenceImage;   
};

struct DEVELOPER_INFO
{
    int DeveloperIndex;     
    QString Name;           
    QString Email;          
    QString Phone;          
    QString Info;           
    QString Handle;         
    QDateTime DateJoined;   
    QDateTime DateLeft;     
    bool IsAvailable;       
};

struct VERSION_INFO
{
    int MajorVersion;               
    int MinorVersion;               
    int Revision;                   
    QDateTime VersionDate;          
    QString VersionDateString;      
    QString VersionString;          
    QString CurrentVersionString;   
    QString FullVersionString;      
};

struct STATUS_INFO
{
    int StatusIndex;                
    QDateTime StatusDateTime;       
    QString StatusName;             
    QString StatusDescription;      
    QString StatusImage;            
    QString StatusDateTimeString;   
};

struct CATEGORY_INFO
{
    int DevFamily;                  
    int LanguageFamily;             
    int PrimaryTool;                
};

struct ASSOCIATED_GROUP_INFO
{
    int InAssociationIndex;         
    QString ShortName;              
    QString FullName;               
    QString AssociationURL;         
    QString AssociationLogo;        
    QString HtaccessFileName;       
};

struct DOXY_OPTIONS
{
    QString DoxyLogoFilename;            
    QString DoxyHtmlHeaderFilename;      
    QString DoxyHtmlFooterFilename;      
    QString DoxyExtraStylesheetFilename; 
};

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               
};

#define TABLE_COLUMN_COUNT    (PUBLISH_BUTTON_COLUMN + 1)
 

struct PROJECT_DESCRIPTION
{
    int     ProjectIndex;           
    QString ProjectName;            
    QString ProjectIdent;           
    QString ProjectDirectory;       
    QString BriefDescription;       
    QString FullDescription;        
    QString ProjectIcon;            
    QString DepartureURL;           
    QString ExeDirectory;           
    QString ExeName;                
    uint    ProjectOptions;         
    uint    ProjectSelections;      
};

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_PUBLISH_LIST_BIT,   
  ALLOW_AUTOMATIC_INSTALL_BIT, 
  UPDATE_GIT_REVISION_BIT,     
 
  CREATE_SOURCE_ARCHIVE_BIT, 
 
  // Insert new bits above this line
  PROJECT_OPTION_BITS_END 
};

enum PROJECT_SELECTION_BITS
{
    INSTALL_SCRIPT_BIT,             
    ARCHIVE_BIT,                    
    ONLY_UPDATE_SOURCE_BIT,         
    PUBLISH_BIT                     
};

#define INSTALL_SCRIPT_MASK (1 << INSTALL_SCRIPT_BIT)

#define ARCHIVE_MASK     (1 << ARCHIVE_BIT)

#define PUBLISH_MASK    (1 << PUBLISH_BIT)

#define EXCLUDE_PROJECT_LIST (1<< EXCLUDE_PROJECT_LIST_BIT)

#define CONTROL_DOC_ACCESS (1<< CONTROL_DOC_ACCESS_BIT)

#define ONLY_DEFAULT_PAGE (1<< ONLY_DEFAULT_PAGE_BIT)

#define GROUP_ACCESS_ONLY (1<< GROUP_ACCESS_ONLY_BIT)

#define ENABLE_CUSTOM_DOXYGEN (1<< ENABLE_CUSTOM_DOXYGEN_BIT)

#define CAVEAT_LECTOR (1<< CAVEAT_LECTOR_BIT)

#define POTENTIAL_HAZARD (1<< POTENTIAL_HAZARD_BIT)

#define ASSISTANCE_WELCOME (1<< ASSISTANCE_WELCOME_BIT)

#define DONATIONS_WELCOME (1<< DONATIONS_WELCOME_BIT)

#define OFFER_PAYPAL_DONATION (1<< OFFER_PAYPAL_DONATION_BIT)

#define CREATE_SOURCE_ARCHIVE (1<< CREATE_SOURCE_ARCHIVE_BIT)

#define CREATE_PUBLISH_LIST (1 << CREATE_PUBLISH_LIST_BIT)

#define ALLOW_AUTOMATIC_INSTALL (1 << ALLOW_AUTOMATIC_INSTALL_BIT)

#define ONLY_UPDATE_SOURCE (1 << ONLY_UPDATE_SOURCE_BIT)

#define UPDATE_GIT_REVISION (1<< UPDATE_GIT_REVISION_BIT)

struct PROGRAM_INFORMATION
{
    int ProgramInformationIndex;            
    QString SiteName;                       
    QString SiteURL;                        
    QString SiteLogo;                       
    QString SharedTemplateDirectory;        
    QString LocalDevelopmentDirectory;      
    QString ProjectPrefix;                  
    QString PrimaryWebsiteDirectory;        
    QString PublisherName;                  
    QString PublisherWebsite;               
    QString PublisherContactEmail;          
    QString ProjectListHeaderFilename;      
    QString ProjectListFooterFilename;      
    QString ProjectListLineFilename;        
    QString ProjectListWebpageFilename;     
    QString ProjectListOpenSimFilename;     
    QString DefaultReturnAddress;           
    QString DevelopmentDoxyDocDirectory;    
    QString CurrentUser;                    
    int SuffixSize;                             
};

struct DEVELOPMENT_FAMILY
{
    uint DevelopmentFamily;                 
    uint LanguageFamily;                    
    uint CompilerFamily;                    
    uint TargetFamily;                      
    QString DevelopmentFamilyString;        
    QString LanguageFamilyString;           
    QString CompilerFamilyString;           
    QString TargetFamilyString;             
};

struct DEV_FAMILY_INFO
{
    int DevFamilyIndex;                     
    QString ShortName;                      
    QString FullName;                       
    QString DevFamilyImage;                 
};

struct LANG_FAMILY_INFO
{
    int LangFamilyIndex;                     
    QString ShortName;                       
    QString FullName;                        
    QString LangFamilyImage;                 
};

struct TARGET_FAMILY_INFO
{
    int TargetFamilyIndex;                   
    QString ShortName;                       
    QString FullName;                        
    QString TargetFamilyImage;               
};
 

struct COMP_FAMILY_INFO
{
    int CompFamilyIndex;                    
    QString ShortName;                      
    QString FullName;                       
    QString CompilerToolImage;              
    QString CompilerDirectory;              
    uint SoftwareLicenceRestriction;        
    uint DocumentationLicenceRestriction;   
    uint HardwareLicenceRestriction;        
};

struct REMOTE_VERSION_ENTRY
{
    uint      ProjectNumber;                
    VERSION_INFO VersionInfo;               
};

struct PROJECT_INFORMATION
{
    PROGRAM_INFORMATION ProgramInformation; 
    PROJECT_DESCRIPTION ProjectDesc;        
    VERSION_INFO VersionInfo;               
    STATUS_INFO StatusInfo;                 
    DEVELOPER_INFO Developer;               
    DEV_FAMILY_INFO DevFamilyInfo;          
    LANG_FAMILY_INFO LangFamilyInfo;        
    COMP_FAMILY_INFO CompFamilyInfo;        
    TARGET_FAMILY_INFO TargetFamilyInfo;    
    LICENCE_INFO DocLicence;                
    LICENCE_INFO SoftwareLicence;           
    LICENCE_INFO HardwareLicence;           
    ASSOCIATED_GROUP_INFO InAssocInfo;      
    DOXY_OPTIONS DoxyOptions;               
    QMap<QString, QString> SubsMap;         
    int ProjectContact;                     
    EXECUTION_STATUS ExecutionStatus;       
    bool ProjectLock;                       
    bool ProjectQueued;                     
};

#define DOXY_LOG_FILE "doxy_log_file.txt"

#define CPP_CHECK_FILE "cppcheck_output.txt"
 
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
};
 
#endif // COMMON_DEFINITIONS_H