libpromeki/main/buildinfo_8h_source.html

#pragma once


#include <promeki/core/namespace.h>


PROMEKI_NAMESPACE_BEGIN


typedef struct {

    const char * name;

    const char * version;

    const char * repoident;

    const char * date;

    const char * time;

    const char * hostname;

    const char * type;

    int          betaVersion;

    int          rcVersion;

} BuildInfo;


const BuildInfo * getBuildInfo();


void logBuildInfo();


PROMEKI_NAMESPACE_END


getBuildInfo
const BuildInfo * getBuildInfo()
Returns a pointer to the global BuildInfo structure.

logBuildInfo
void logBuildInfo()
Writes all build information fields to the log output.

namespace.h

PROMEKI_NAMESPACE_BEGIN
#define PROMEKI_NAMESPACE_BEGIN
Starts a promeki namespace block.
Definition namespace.h:14

PROMEKI_NAMESPACE_END
#define PROMEKI_NAMESPACE_END
Ends a promeki namespace block.
Definition namespace.h:19

BuildInfo
Holds compile-time build information for the library.
Definition buildinfo.h:18

BuildInfo::name
const char * name
Project name.
Definition buildinfo.h:19

BuildInfo::version
const char * version
Version string (e.g. "1.2.3").
Definition buildinfo.h:20

BuildInfo::repoident
const char * repoident
Repository identifier (e.g. git commit hash).
Definition buildinfo.h:21

BuildInfo::betaVersion
int betaVersion
Beta version number, or 0 if not a beta build.
Definition buildinfo.h:26

BuildInfo::date
const char * date
Build date string (DATE).
Definition buildinfo.h:22

BuildInfo::time
const char * time
Build time string (TIME).
Definition buildinfo.h:23

BuildInfo::rcVersion
int rcVersion
Release candidate number, or 0 if not an RC build.
Definition buildinfo.h:27

BuildInfo::type
const char * type
Build type (e.g. "Release", "Debug").
Definition buildinfo.h:25

BuildInfo::hostname
const char * hostname
Hostname of the build machine.
Definition buildinfo.h:24