Viewing file:  rpmmacro.h (4.36 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
#ifndef _H_MACRO_
#define _H_MACRO_
/** \ingroup rpmio
* \file rpmio/rpmmacro.h
*
* Macro API
*/
#include <stdio.h>
#include <stddef.h>
#include <rpm/rpmutil.h>
#include <rpm/rpmfileutil.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct rpmMacroEntry_s * rpmMacroEntry;
typedef struct rpmMacroContext_s * rpmMacroContext;
extern rpmMacroContext rpmGlobalMacroContext;
extern rpmMacroContext rpmCLIMacroContext;
/** \ingroup rpmrc
* List of macro files to read when configuring rpm.
* This is a colon separated list of files. URI's are permitted as well,
* identified by the token '://', so file paths must not begin with '//'.
*/
extern const char * macrofiles;
/**
* Markers for sources of macros added throughout rpm.
*/
#define RMIL_DEFAULT -15
#define RMIL_MACROFILES -13
#define RMIL_RPMRC -11
#define RMIL_CMDLINE -7
#define RMIL_TARBALL -5
#define RMIL_SPEC -3
#define RMIL_OLDSPEC -1
#define RMIL_GLOBAL 0
/* Deprecated compatibility wrappers */
#define addMacro(_mc, _n, _o, _b, _l) rpmPushMacro(_mc, _n, _o, _b, _l)
#define delMacro(_mc, _n) rpmPopMacro(_mc, _n)
/** \ingroup rpmmacro
* Print macros to file stream.
* @param mc macro context (NULL uses global context).
* @param fp file stream (NULL uses stderr).
*/
void rpmDumpMacroTable (rpmMacroContext mc,
FILE * fp);
/** \ingroup rpmmacro
* Expand macro into buffer.
* @param mc macro context (NULL uses global context).
* @param sbuf input macro to expand
* @param obuf macro expansion (malloc'ed)
* @param flags flags (currently unused)
* @return negative on failure
*/
int rpmExpandMacros (rpmMacroContext mc, const char * sbuf,
char ** obuf, int flags);
/** \ingroup rpmmacro
* Push macro to context.
* @param mc macro context (NULL uses global context).
* @param n macro name
* @param o macro parameters
* @param b macro body
* @param level macro recursion level (0 is entry API)
* @return 0 on success
*/
int rpmPushMacro (rpmMacroContext mc, const char * n,
const char * o,
const char * b, int level);
/** \ingroup rpmmacro
* Pop macro from context.
* @param mc macro context (NULL uses global context).
* @param n macro name
* @return 0 on success
*/
int rpmPopMacro (rpmMacroContext mc, const char * n);
/** \ingroup rpmmacro
* Define macro in context.
* @param mc macro context (NULL uses global context).
* @param macro macro name, options, body
* @param level macro recursion level (0 is entry API)
* @return 0 on success (always)
*/
int rpmDefineMacro (rpmMacroContext mc, const char * macro,
int level);
/** \ingroup rpmmacro
* Load macros from specific context into global context.
* @param mc macro context (NULL does nothing).
* @param level macro recursion level (0 is entry API)
*/
void rpmLoadMacros (rpmMacroContext mc, int level);
/** \ingroup rpmmacro
* Load macro context from a macro file.
* @param mc (unused)
* @param fn macro file name
*/
int rpmLoadMacroFile(rpmMacroContext mc, const char * fn);
/** \ingroup rpmmacro
* Initialize macro context from set of macrofile(s).
* @param mc macro context
* @param macrofiles colon separated list of macro files (NULL does nothing)
*/
void rpmInitMacros (rpmMacroContext mc, const char * macrofiles);
/** \ingroup rpmmacro
* Destroy macro context.
* @param mc macro context (NULL uses global context).
*/
void rpmFreeMacros (rpmMacroContext mc);
/** \ingroup rpmmacro
* Return (malloc'ed) concatenated macro expansion(s).
* @param arg macro(s) to expand (NULL terminates list)
* @return macro expansion (malloc'ed)
*/
char * rpmExpand (const char * arg, ...) RPM_GNUC_NULL_TERMINATED;
/** \ingroup rpmmacro
* Return macro expansion as a numeric value.
* Boolean values ('Y' or 'y' returns 1, 'N' or 'n' returns 0)
* are permitted as well. An undefined macro returns 0.
* @param arg macro to expand
* @return numeric value
*/
int rpmExpandNumeric (const char * arg);
/** \ingroup rpmmacro
* Return rpm configuration base directory.
* If RPM_CONFIGDIR environment variable is set, it's value will be used.
* Otherwise the configuration directory is the one set at build time,
* typically /usr/lib/rpm. The value of rpmConfigDir() is determined
* on first call to this function and is guaranteed to remain the same
* on subsequent calls.
* @return rpm configuration directory name
*/
const char *rpmConfigDir(void);
#ifdef __cplusplus
}
#endif
#endif /* _H_ MACRO_ */
|