version_rc.h File Reference

Global version information for eVaf applications and modules. More...

#include <QtCore/qglobal.h>

Go to the source code of this file.

Classes
struct	ModuleVersionInfo
	Version info structure for modules. More...

Macros
#define	C_EXTERN_C
#define	MT_GENERIC   0
	Generic type for modules. More...
#define	MT_GENERIC_STR   "generic\0"
#define	VER_COMPANY_NAME_STR   "eVaf\0"
	Name of the company (shall end with \0) More...
#define	VER_EXPORT_VERSION_INFO()
	Macro that exports version information from modules. More...
#define	VER_LEGAL_COPYRIGHT_STR   "(C) 2011-2012 Enar Vaikene\0"
	Legal copyright (shall end with \0) More...
#define	VER_PRODUCT_DATE_STR   "N/A\0"
	Product's release date (shall end with \0) More...
#define	VER_PRODUCT_NAME_STR   "eVaf\0"
	Product's name (shall end with \0) More...
#define	VER_PRODUCT_VERSION   0,1,1
	Product's version number in the format major,minor,release. More...
#define	VER_PRODUCT_VERSION_STR   "0.1.1\0"
	Product's version number in the human-readable format (shall end with \0) More...

Typedefs
typedef void(*	ModuleQueryVersionInfoFunction) (ModuleVersionInfo **ptr)
	Function prototype that returns version information from a module. More...

Detailed Description

Global version information for eVaf applications and modules.

Author

Enar Vaikene

Copyright (c) 2011-2012 Enar Vaikene

This file is part of the eVaf C++ cross-platform application development framework.

This file can be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file. Please review the the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html.

Alternatively, this file may be used in accordance with the Commercial License Agreement provided with the Software.

Definition in file version_rc.h.

Macro Definition Documentation

#define C_EXTERN_C

Definition at line 162 of file version_rc.h.

#define MT_GENERIC   0

Generic type for modules.

The string version shall end with \0.

Definition at line 71 of file version_rc.h.

#define MT_GENERIC_STR   "generic\0"

Definition at line 72 of file version_rc.h.

#define VER_COMPANY_NAME_STR   "eVaf\0"

Name of the company (shall end with \0)

Definition at line 64 of file version_rc.h.

#define VER_EXPORT_VERSION_INFO

(

)

Value:

C_EXTERN_C Q_DECL_EXPORT void moduleQueryVersionInfo(ModuleVersionInfo ** ptr) \
        { \
            static ModuleVersionInfo ver = { VER_MODULE_TYPE, \
                                             VER_MODULE_NAME_STR, \
                                             { VER_FILE_VERSION }, \
                                             VER_FILE_VERSION_STR, \
                                             VER_FILE_DESCRIPTION_STR, \
                                             VER_PRODUCT_NAME_STR, \
                                             { VER_PRODUCT_VERSION }, \
                                             VER_PRODUCT_VERSION_STR, \
                                             VER_PRODUCT_DATE_STR, \
                                             VER_LEGAL_COPYRIGHT_STR, \
                                             VER_COMPANY_NAME_STR \
                                           }; \
            *ptr = &ver; \
        }

Macro that exports version information from modules.

At least the following macros describing the module shall be defined for this macro to work properly:

• VER_MODULE_TYPE
• VER_MODULE_NAME_STR
• VER_FILE_VERSION
• VER_FILE_VERSION_STR
• VER_FILE_DESCRIPTION_STR

Additional macros describing the product are:

• VER_PRODUCT_NAME_STR
• VER_PRODUCT_VERSION
• VER_PRODUCT_VERSION_STR
• VER_PRODUCT_DATE_STR

And some legal stuff:

• VER_LEGAL_COPYRIGHT_STR
• VER_COMPANY_NAME_STR

Definition at line 201 of file version_rc.h.

#define VER_LEGAL_COPYRIGHT_STR   "(C) 2011-2012 Enar Vaikene\0"

Legal copyright (shall end with \0)

Definition at line 57 of file version_rc.h.

#define VER_PRODUCT_DATE_STR   "N/A\0"

Product's release date (shall end with \0)

Definition at line 50 of file version_rc.h.

#define VER_PRODUCT_NAME_STR   "eVaf\0"

Product's name (shall end with \0)

Definition at line 43 of file version_rc.h.

#define VER_PRODUCT_VERSION   0,1,1

Product's version number in the format major,minor,release.

Definition at line 29 of file version_rc.h.

#define VER_PRODUCT_VERSION_STR   "0.1.1\0"

Product's version number in the human-readable format (shall end with \0)

Definition at line 36 of file version_rc.h.

Typedef Documentation

typedef void(* ModuleQueryVersionInfoFunction) (ModuleVersionInfo **ptr)

Function prototype that returns version information from a module.

This is a typedef for a pointer to a function with the following signature:

void queryVersionInfo(ModuleVersionInfo **);

Every eVaf module is expected to export this function and the version info shall be available without any extra initialization.

The function copies the address of the ModuleVersionInfo structure to the variable at ptr.

Definition at line 179 of file version_rc.h.