#include <cmHost.h>

Data Fields
void *	impl

void(*	release )(void *impl)

void(*	report_message )(void impl, const struct cmMessage message)

void(*	report_diagnostic )(void impl, const struct cmDiagnostic diagnostic)

int(*	open_for_reading )(void impl, struct cmHostFile host_file, const char *filename)

void (	malloc_override )(void *impl, size_t size)

void (	realloc_override )(void impl, void addr, size_t size)

void(*	free_override )(void impl, void addr)

const char (	getenv_override )(void impl, const char key, size_t key_size)

int(*	stat_override )(void impl, const char path, struct cmStat *stat)

Detailed Description

This structure is used for providing a customized interface from the interpreter to the host system. Functions in this structure that are assigned to null pointers will be substituted by the default behavior.

Field Documentation

§ free_override

void(* cmHost::free_override) (void *impl, void *addr)

Overrides the memory free function.

§ getenv_override

const char*(* cmHost::getenv_override) (void *impl, const char *key, size_t key_size)

Accesses the value of an environment variable.

§ impl

void* cmHost::impl

Host implementation data.

§ malloc_override

void*(* cmHost::malloc_override) (void *impl, size_t size)

Overrides the memory allocation function.

§ open_for_reading

int(* cmHost::open_for_reading) (void *impl, struct cmHostFile *host_file, const char *filename)

Opens a file for reading. A value of zero should be returned on success. On failure, the errno value should be returned that indicates the reason for the failure.

§ realloc_override

void*(* cmHost::realloc_override) (void *impl, void *addr, size_t size)

Overrides the memory reallocation function.

§ release

void(* cmHost::release) (void *impl)

Releases memory allocated by the host.

§ report_diagnostic

void(* cmHost::report_diagnostic) (void *impl, const struct cmDiagnostic *diagnostic)

Reports a diagnostic to the user.

§ report_message

void(* cmHost::report_message) (void *impl, const struct cmMessage *message)

Reports a message to the user.

§ stat_override

int(* cmHost::stat_override) (void *impl, const char *path, struct cmStat *stat)

Gets file status and meta data.

The documentation for this struct was generated from the following file:

Include/cmEngine/cmHost.h

Data Fields