cmFunctionContext.h

#ifndef cmEngine_Include_cmEngine_cmFunctionContext_h
#define cmEngine_Include_cmEngine_cmFunctionContext_h

#include <cmEngine/cmCacheType.h>
#include <cmEngine/cmPublic.h>

#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

struct cmArgument;
struct cmFunctionContext;
struct cmMessage;

CM_PUBLIC void
cmIssueMessage(struct cmFunctionContext* function_context, const struct cmMessage* message);

#ifdef __GNUC__
#  define cmIssue_ATTRIBUTES __attribute__((format(printf, 2, 3)))
#else
#  define cmIssue_ATTRIBUTES
#endif

CM_PUBLIC const char*
cmGetFunctionFilename(const struct cmFunctionContext* function_context);

CM_PUBLIC size_t
cmGetFunctionLine(const struct cmFunctionContext* function_context);

CM_PUBLIC size_t
cmGetFunctionColumn(const struct cmFunctionContext* function_context);

CM_PUBLIC struct cmHost*
cmGetFunctionHost(struct cmFunctionContext* function_context);

CM_PUBLIC void
cmIssueFatalError(struct cmFunctionContext* function_context, const char* fmt, ...) cmIssue_ATTRIBUTES;

CM_PUBLIC void
cmIssueError(struct cmFunctionContext* function_context, const char* fmt, ...) cmIssue_ATTRIBUTES;

CM_PUBLIC void
cmIssueWarning(struct cmFunctionContext* function_context, const char* fmt, ...) cmIssue_ATTRIBUTES;

CM_PUBLIC const struct cmArgument*
cmPopFunctionArgument(struct cmFunctionContext* function_context);

CM_PUBLIC const struct cmArgument*
cmPeekFunctionArgument(struct cmFunctionContext* function_context);

CM_PUBLIC void
cmNextFunctionArgument(struct cmFunctionContext* function_context);

CM_PUBLIC int
cmFunctionHasParentScope(const struct cmFunctionContext* function_context);

#define CM_PARENT_SCOPE 1

CM_PUBLIC int
cmDefineVariableFromFunction(struct cmFunctionContext* function_context,
                             const char* name,
                             const char* value,
                             int flags);

CM_PUBLIC int
cmUndefineVariableFromFunction(struct cmFunctionContext* function_context,
                               const char* name,
                               int flags);

struct cmCacheVariableDesc
{
  const char* name;
  const char* value;
  const char* doc;
  enum cmCacheType type;
};

CM_PUBLIC int
cmDefineCacheVariableFromFunction(struct cmFunctionContext* function_context,
                                  const struct cmCacheVariableDesc* desc);

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* cmEngine_Include_cmEngine_cmFunctionContext_h */