camp.prepro.hpp File Reference

Description:

This header-file is part of the ALib C++ Framework.

Copyright 2013-2026 A-Worx GmbH, Germany. Published under License.

Definition in file camp.prepro.hpp.

#include "alib/alib.prepro.hpp"

Include dependency graph for camp.prepro.hpp:

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

Go to the source code of this file.

Macros
#define	ALIB_CAMP_ENUM(T, TRecord, Camp, ResName)
#define	ALIB_CAMP_OMIT_DEFAULT_RESOURCES   0
#define	ALIB_CAMP_RESOURCE_COMPILATION   1
#define	ALIB_RESOURCED_IN_CAMP(T, Camp, ResName)

Macro Definition Documentation

ALIB_CAMP_ENUM

#define ALIB_CAMP_ENUM	(		T,
			TRecord,
			Camp,
			ResName )

Value:

ALIB_ENUMS_ASSIGN_RECORD( T, TRecord  )                                                    \
ALIB_RESOURCED_IN_CAMP( T, Camp, ResName  )

Combines macros ALIB_ENUMS_ASSIGN_RECORD and ALIB_RESOURCED_IN_CAMP.

Parameters

T	The enumeration to assign a record and resources to.
TRecord	The record type to assign.
ResName	Resource name string.
Camp	Pointer to the Camp that provides the ResourcePool object.

Definition at line 23 of file camp.prepro.hpp.

ALIB_CAMP_OMIT_DEFAULT_RESOURCES

#define ALIB_CAMP_OMIT_DEFAULT_RESOURCES   0

If set, code that defines static default resource strings is pruned, and thus, all static resource string data is pruned from the library's executable's data segment.

The omission occurs in the implementations of virtual void Bootstrap() =0 of various ALib Modules, where methods void Bootstrap(const NString&, const NString&, const String&)  and virtual void BootstrapBulk(const nchar*, ...) =0 are used to define the default resources.

If resources are omitted, the bootstrap process has to be customized to use an external resource provider. Otherwise the library has undefined behavior as resources are missing.

See also

Chapter 6.2 Exporting Resources For Externalization of the Programmer's Manual of module ALib Resources for more information.

Definition at line 28 of file camp.prepro.hpp.

ALIB_CAMP_RESOURCE_COMPILATION

#define ALIB_CAMP_RESOURCE_COMPILATION   1

This symbol selects the implementation of the class DevtimeResourceCompiler and the availability of:

• type ResourceListEntry,
• type ResourceList,
• function LoadResourceFile,
• function PatchCPPFile, and
• function ListErrors.

With that, it controls whether resources are parsed from the .alibrc resource-files at runtime and - on changes - are written into a C++ file.

If not pre-defined by the build system, this symbol defaults to:

• 1 in debug builds.
• 0 in non-debug builds.

Definition at line 48 of file camp.prepro.hpp.

ALIB_RESOURCED_IN_CAMP

#define ALIB_RESOURCED_IN_CAMP	(		T,
			Camp,
			ResName )

Value:

ALIB_RESOURCED( T, &Camp.GetResourcePool(), Camp.ResourceCategory, ResName  )

Variant of macro ALIB_RESOURCED, which specializes the type trait ResourcedTraits for type T to use the resource-backend found in the given Camp, as well as its default ResourceCategory.

Availability

This macro is available only if ALIB_CAMP equals true.

Parameters

T	The type to specialize the type trait ResourcedTraits for.
Camp	Pointer to the Camp that provides the ResourcePool object.
ResName	Expression providing the resource name.

Definition at line 20 of file camp.prepro.hpp.