rpm  5.4.10
Macros | Typedefs | Enumerations | Functions | Variables
rpmmacro.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define RMIL_DEFAULT   -15
 Markers for sources of macros added throughout rpm.
#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

Typedefs

typedef struct MacroEntry_s * MacroEntry
typedef struct MacroContext_s * MacroContext
typedef enum rpmCompressedMagic_e rpmCompressedMagic

Enumerations

enum  rpmCompressedMagic_e {
  COMPRESSED_NOT = 0, COMPRESSED_OTHER = 1, COMPRESSED_BZIP2 = 2, COMPRESSED_ZIP = 3,
  COMPRESSED_LZOP = 4, COMPRESSED_LZMA = 5, COMPRESSED_XZ = 6, COMPRESSED_LRZIP = 7,
  COMPRESSED_LZIP = 8, COMPRESSED_7ZIP = 9
}

Functions

void rpmDumpMacroTable (MacroContext mc, FILE *fp)
 Print macros to file stream.
int rpmGetMacroEntries (MacroContext mc, void *_mire, int used, const char ***avp)
 Return macro entries as string array.
int rpmSecuritySaneFile (const char *filename)
 Check whether configuration file is moderately secure to load.
int rpmGlob (const char *patterns, int *argcPtr, const char ***argvPtr)
 Return URL path(s) from a (URL prefixed) pattern glob.
int expandMacros (void *spec, MacroContext mc, char *sbuf, size_t slen)
 Expand macro into buffer.
void addMacro (MacroContext mc, const char *n, const char *o, const char *b, int level)
 Add macro to context.
void delMacro (MacroContext mc, const char *n)
 Delete macro from context.
int rpmDefineMacro (MacroContext mc, const char *macro, int level)
 Define macro in context.
int rpmUndefineMacro (MacroContext mc, const char *macro)
 Undefine macro in context.
void rpmLoadMacros (MacroContext mc, int level)
 Load macros from specific context into global context.
int rpmLoadMacroFile (MacroContext mc, const char *fn, int nesting)
 Load macro context from a macro file.
void rpmInitMacros (MacroContext mc, const char *macrofiles)
 Initialize macro context from set of macrofile(s).
void rpmFreeMacros (MacroContext mc)
 Destroy macro context.
int isCompressed (const char *file, rpmCompressedMagic *compressed)
 Return type of compression used in file.
char * rpmExpand (const char *arg,...)
 Return (malloc'ed) concatenated macro expansion(s).
char * rpmMCExpand (MacroContext mc, const char *arg,...)
 Return (malloc'ed) concatenated macro expansion(s) in a context.
char * rpmCleanPath (char *path)
 Canonicalize file path.
char * rpmGetPath (const char *path,...)
 Return (malloc'ed) expanded, canonicalized, file path.
const char * rpmGenPath (const char *urlroot, const char *urlmdir, const char *urlfile)
 Merge 3 args into path, any or all of which may be a url.
int rpmExpandNumeric (const char *arg)
 Return macro expansion as a numeric value.

Variables

MacroContext rpmGlobalMacroContext
MacroContext rpmCLIMacroContext
const char * rpmMacrofiles
 List of macro files to read when configuring rpm.

Detailed Description

Definition in file rpmmacro.h.

Macro Definition Documentation

#define RMIL_CMDLINE   -7
#define RMIL_DEFAULT   -15

Markers for sources of macros added throughout rpm.

Definition at line 50 of file rpmmacro.h.

Referenced by addMacroDefault(), rpmtsOpenSDB(), setDefaults(), and setPathDefault().

#define RMIL_GLOBAL   0

Definition at line 58 of file rpmmacro.h.

Referenced by expandMacro(), and rpmcliInstall().

#define RMIL_MACROFILES   -13

Definition at line 51 of file rpmmacro.h.

Referenced by rpmLoadMacroFile().

#define RMIL_OLDSPEC   -1

Definition at line 57 of file rpmmacro.h.

Referenced by handlePreambleTag().

#define RMIL_RPMRC   -11

Definition at line 52 of file rpmmacro.h.

Referenced by parseSpec(), and rpmRebuildTargetVars().

#define RMIL_SPEC   -3

Definition at line 56 of file rpmmacro.h.

Referenced by addSource(), doSetupMacro(), handlePreambleTag(), parsePreamble(), and parseSpec().

#define RMIL_TARBALL   -5

Definition at line 55 of file rpmmacro.h.

Typedef Documentation

typedef struct MacroContext_s* MacroContext

Definition at line 8 of file rpmmacro.h.

typedef struct MacroEntry_s* MacroEntry

Definition at line 7 of file rpmmacro.h.

Enumeration Type Documentation

Enumerator:
COMPRESSED_NOT 

not compressed

COMPRESSED_OTHER 

gzip can handle

COMPRESSED_BZIP2 

bzip2 can handle

COMPRESSED_ZIP 

unzip can handle

COMPRESSED_LZOP 

lzop can handle

COMPRESSED_LZMA 

lzma can handle

COMPRESSED_XZ 

xz can handle

COMPRESSED_LRZIP 

lrzip can handle

COMPRESSED_LZIP 

lzip can handle

COMPRESSED_7ZIP 

7zip can handle

Definition at line 206 of file rpmmacro.h.

Function Documentation

void addMacro ( MacroContext  mc,
const char *  n,
const char *  o,
const char *  b,
int  level 
)

Add macro to context.

Deprecated:
Use rpmDefineMacro().
Parameters
mcmacro context (NULL uses global context).
nmacro name
omacro paramaters
bmacro body
levelmacro recursion level (0 is entry API)

Definition at line 2684 of file macro.c.

References _, expandMacroTable(), findEntry(), name, pushMacro(), rpmGlobalMacroContext, rpmlog(), RPMLOG_ERR, and sortMacroTable().

Referenced by addMacroDefault(), addSource(), doDefine(), doSetupMacro(), expandMacro(), grabArgs(), handlePreambleTag(), headerMacrosLoad(), makeGPGSignature(), parsePreamble(), parseSpec(), rpmcliInstall(), rpmLoadMacros(), rpmPlatform(), rpmRebuildTargetVars(), rpmtsOpenSDB(), setDefaults(), and setPathDefault().

void delMacro ( MacroContext  mc,
const char *  n 
)

Delete macro from context.

Parameters
mcmacro context (NULL uses global context).
nmacro name

Definition at line 2723 of file macro.c.

References findEntry(), popMacro(), rpmGlobalMacroContext, and sortMacroTable().

Referenced by doUndefine(), handlePreambleTag(), headerMacrosUnload(), makeGPGSignature(), parseSpec(), rpmcliInstall(), rpmRebuildTargetVars(), and rpmtsOpenSDB().

int expandMacros ( void *  spec,
MacroContext  mc,
char *  sbuf,
size_t  slen 
)

Expand macro into buffer.

Deprecated:
Use rpmExpand().
Todo:
Eliminate from API.
Parameters
speccookie (unused)
mcmacro context (NULL uses global context).
Return values
sbufinput macro to expand, output expansion
Parameters
slensize of buffer
Returns
0 on success

Definition at line 2649 of file macro.c.

References _, alloca(), MacroBuf_s::depth, MacroBuf_s::expand_trace, expandMacro(), MacroBuf_s::macro_trace, MacroBuf_s::mc, MacroBuf_s::nb, print_expand_trace, print_macro_trace, rpmGlobalMacroContext, rpmlog(), RPMLOG_ERR, MacroBuf_s::s, MacroBuf_s::spec, and MacroBuf_s::t.

Referenced by addFileToTagAux(), copyNextLineFromOFI(), processPackageFiles(), rpmExpand(), rpmGetPath(), and rpmMCExpand().

int isCompressed ( const char *  file,
rpmCompressedMagic compressed 
)

Return type of compression used in file.

Parameters
filename of file
Return values
compressedaddress of compression type
Returns
0 on success, 1 on I/O error

Definition at line 2995 of file macro.c.

References _, COMPRESSED_7ZIP, COMPRESSED_BZIP2, COMPRESSED_LRZIP, COMPRESSED_LZIP, COMPRESSED_LZMA, COMPRESSED_LZOP, COMPRESSED_NOT, COMPRESSED_OTHER, COMPRESSED_XZ, COMPRESSED_ZIP, Fclose(), Ferror(), Fopen(), Fread(), Fstrerror(), rpmlog(), and RPMLOG_ERR.

Referenced by doFoo(), doPatch(), and doUntar().

char* rpmCleanPath ( char *  path)

Canonicalize file path.

Note
Path canonicalization always removes the pesky trailing '/'.
Parameters
pathpath to canonicalize (in-place)
Returns
pointer to path

Definition at line 3218 of file macro.c.

Referenced by db3open(), doLookup(), relocateFileList(), rpmGetPath(), rpmioAccess(), and rpmQueryVerify().

int rpmDefineMacro ( MacroContext  mc,
const char *  macro,
int  level 
)

Define macro in context.

Parameters
mcmacro context (NULL uses global context).
macromacro name, options, body
levelmacro recursion level (0 is entry API)
Returns
Todo:
Document.

Definition at line 2739 of file macro.c.

References alloca(), doDefine(), MacroBuf_s::mc, and rpmGlobalMacroContext.

Referenced by ftsCacheUpdate(), main(), rpmcliAllArgCallback(), rpmioAllArgCallback(), rpmLoadMacroFile(), and rpmmc_add().

void rpmDumpMacroTable ( MacroContext  mc,
FILE *  fp 
)

Print macros to file stream.

Parameters
mcmacro context (NULL uses global context).
fpfile stream (NULL uses stderr).

Definition at line 285 of file macro.c.

References _, and rpmGlobalMacroContext.

Referenced by expandMacro(), and rpmShowRC().

char* rpmExpand ( const char *  arg,
  ... 
)

Return (malloc'ed) concatenated macro expansion(s).

Parameters
argmacro(s) to expand (NULL terminates list)
Returns
macro expansion (malloc'ed)

Definition at line 3117 of file macro.c.

References _macro_BUFSIZ, expandMacros(), stpcpy(), xmalloc, xrealloc, and xstrdup().

Referenced by _GetPass(), addChangelog(), archScore(), checkForValidArchitectures(), checkUnpackagedFiles(), cpio_doio(), dbiTagsInit(), debevrfmtTag(), debmd5sumsTag(), defaultMachine(), doPatch(), doPrimary(), doSetupMacro(), fillOutMainPackage(), Fopen(), formatValue(), getMachineInfo(), headerMacrosLoad(), headerMacrosUnload(), headerSprintf(), i18nTag(), initGlobs(), initSourceHeader(), lookupPackage(), main(), makeGPGSignature(), Open(), open_dso(), packageBinaries(), packageSources(), parseBuildInstallClean(), parseForRegexLang(), parseForSimple(), parsePreamble(), parseSpec(), prepFetch(), processBinaryFiles(), processSourceFiles(), rdToken(), readLine(), Realpath(), rpmCheckPassPhrase(), rpmcliEvalSlurp(), rpmcliImportPubkeys(), rpmcliInstallElementPath(), rpmcliQuery(), rpmdbExportL10N_SQL(), rpmdbNew(), rpmdcParseZeroInstall(), rpmdsCpuinfo(), rpmdsEVRorder(), rpmdsGetconf(), rpmdsLdconfig(), rpmdsPipe(), rpmdsSysinfo(), rpmEVRmire(), rpmEVRorder(), rpmExpandNumeric(), rpmfcClassify(), rpmfcExec(), rpmfcExpandAppend(), rpmfcExpandRegexps(), rpmfcGenerateDependsHelper(), rpmfcSCRIPT(), rpmgiNext(), rpmgiOpen(), rpmInstallSourcePackage(), rpmioAllArgCallback(), rpmmiAddPattern(), rpmnsArch(), rpmnsParse(), rpmnsProbeSignature(), rpmperlNew(), rpmPlatform(), rpmpsmStage(), rpmpythonNew(), rpmrbLoadClasses(), rpmrbLoadFile(), rpmReadConfigFiles(), rpmReadRC(), rpmrepoDoRepoMetadata(), rpmrepoInitPopt(), rpmrepoMDExpand(), rpmRollback(), rpmShowProgress(), rpmShowRC(), rpmsqlNew(), rpmsqlRun(), rpmts_IDTXglob(), rpmtsAddInstallElement(), rpmtsAddObsoletes(), rpmtsAddUpgrades(), rpmtsEraseDebuginfo(), rpmtsFindPubkey(), rpmtsOpenSDB(), rpmtsRollback(), rpmtsSkipFiles(), rpmtsSolve(), rpmvtNew(), runImmedTriggers(), runInstScript(), runScript(), runTriggers(), spec_get_buildroot(), statFormat(), strsubFormat(), tagLoadATags(), tagValidate(), unsatisfiedDepend(), urlFind(), urlGetFile(), and writeRPM().

int rpmExpandNumeric ( const char *  arg)
void rpmFreeMacros ( MacroContext  mc)

Destroy macro context.

Parameters
mcmacro context (NULL uses global context).

Definition at line 2966 of file macro.c.

References _free(), and rpmGlobalMacroContext.

Referenced by _rpmmc_free(), main(), rpmcliFini(), rpmioFini(), and rpmspecQuery().

const char* rpmGenPath ( const char *  urlroot,
const char *  urlmdir,
const char *  urlfile 
)

Merge 3 args into path, any or all of which may be a url.

The leading part of the first URL encountered is used for the result, other URL prefixes are discarded, permitting a primitive form of URL inheiritance.

Parameters
urlrootroot URL (often path to chroot, or NULL)
urlmdirdirectory URL (often a directory, or NULL)
urlfilefile URL (often a file, or NULL)
Returns
expanded, merged, canonicalized path (malloc'ed)

Definition at line 3356 of file macro.c.

References _free(), alloca(), file, rpmGetPath(), URL_IS_DASH, and urlPath().

Referenced by addSource(), createDir(), db3close(), db3open(), db_init(), doIcon(), doPatch(), doScript(), doSetupMacro(), doUntar(), handlePreambleTag(), main(), prepFetch(), processBinaryFile(), processMetadataFile(), processPackageFiles(), rpmdsNew(), rpmfcGenerateDepends(), rpmfiNew(), rpmpsmStage(), rpmrepoInitPopt(), rpmTempFile(), sql_close(), sql_initDB(), and sql_open().

int rpmGetMacroEntries ( MacroContext  mc,
void *  _mire,
int  used,
const char ***  avp 
)

Return macro entries as string array.

Parameters
mcmacro context (NULL uses global context)
_mirepattern to match (NULL disables)
usedmacro usage (<0 all, =0 unused, >=1 used count)
Return values
*avpmacro definitions
Returns
no. of entries

Definition at line 319 of file macro.c.

References dupMacroEntry(), mireRegexec(), rpmGlobalMacroContext, xcalloc(), and xrealloc.

Referenced by packageSources(), rpmmc_list(), and rpmtsFini().

char* rpmGetPath ( const char *  path,
  ... 
)
int rpmGlob ( const char *  patterns,
int *  argcPtr,
const char ***  argvPtr 
)

Return URL path(s) from a (URL prefixed) pattern glob.

Parameters
patternsglob pattern
Return values
*argcPtrno. of paths
*argvPtrarray of paths (malloc'd contiguous blob)
Returns
0 on success XXX FIXME: rpmRC return?

Definition at line 2509 of file macro.c.

References _free(), glob_t::gl_pathc, glob_t::gl_pathv, Glob(), Glob_error(), Glob_pattern_p(), GLOB_TILDE, Globfree(), setlocale, URL_IS_DASH, URL_IS_FTP, URL_IS_HKP, URL_IS_HTTP, URL_IS_HTTPS, URL_IS_MONGO, URL_IS_PATH, URL_IS_UNKNOWN, urlPath(), xmalloc, XpoptParseArgvString(), xrealloc, and xstrdup().

Referenced by IDTXglob(), processBinaryFile(), rpmcliInit(), rpmcliInstallElementPath(), rpmgiGlobArgv(), rpmInitMacros(), rpmioInit(), rpmLoadMacroFile(), and rpmReadPackageManifest().

void rpmInitMacros ( MacroContext  mc,
const char *  macrofiles 
)

Initialize macro context from set of macrofile(s).

Parameters
mcmacro context
macrofilescolon separated list of macro files (NULL does nothing)

Definition at line 2880 of file macro.c.

References _free(), _max_load_depth, _suffix, RMIL_CMDLINE, rpmCLIMacroContext, rpmGlob(), rpmGlobalMacroContext, rpmLoadMacroFile(), rpmLoadMacros(), rpmlog(), RPMLOG_WARNING, rpmSecuritySaneFile(), xmalloc, and xstrdup().

Referenced by rpmmc_init_macros(), and rpmReadRC().

int rpmLoadMacroFile ( MacroContext  mc,
const char *  fn,
int  nesting 
)

Load macro context from a macro file.

Parameters
mc(unused)
fnmacro file name
nestingmax load recursion depth, 0 disables.

Definition at line 2801 of file macro.c.

References _, _free(), _macro_BUFSIZ, _MAX_MACRO_DEPTH, alloca(), Fclose(), Ferror(), Fopen(), matchchar(), max_macro_depth, rdcl(), RMIL_MACROFILES, rpmDefineMacro(), rpmGlob(), rpmLoadMacroFile(), rpmlog(), RPMLOG_WARNING, rpmMCExpand(), and SKIPBLANK.

Referenced by expandMacro(), rpmInitMacros(), rpmLoadMacroFile(), and rpmmc_load_macro_file().

void rpmLoadMacros ( MacroContext  mc,
int  level 
)

Load macros from specific context into global context.

Parameters
mcmacro context (NULL does nothing).
levelmacro recursion level (0 is entry API)

Definition at line 2761 of file macro.c.

References addMacro(), and rpmGlobalMacroContext.

Referenced by rpmInitMacros().

char* rpmMCExpand ( MacroContext  mc,
const char *  arg,
  ... 
)

Return (malloc'ed) concatenated macro expansion(s) in a context.

Parameters
mcmacro context
argmacro(s) to expand (NULL terminates list)
Returns
macro expansion (malloc'ed)

Definition at line 3154 of file macro.c.

References _macro_BUFSIZ, expandMacros(), stpcpy(), xmalloc, xrealloc, and xstrdup().

Referenced by rpmLoadMacroFile(), and rpmmc_expand().

int rpmSecuritySaneFile ( const char *  filename)

Check whether configuration file is moderately secure to load.

Parameters
filenamefilename to check
Returns
1 on success, 0 on failure XXX FIXME: rpmRC return?

Definition at line 2486 of file macro.c.

Referenced by rpmcliInit(), rpmInitMacros(), and rpmioInit().

int rpmUndefineMacro ( MacroContext  mc,
const char *  macro 
)

Undefine macro in context.

Parameters
mcmacro context (NULL uses global context).
macromacro name
Returns
Todo:
Document.

Definition at line 2753 of file macro.c.

References doUndefine(), and rpmGlobalMacroContext.

Referenced by rpmcliAllArgCallback(), rpmioAllArgCallback(), and rpmmc_del().

Variable Documentation

MacroContext rpmCLIMacroContext
MacroContext rpmGlobalMacroContext