rpm  5.4.14
Macros | Typedefs | Enumerations | Functions | Variables
rpmmacro.h File Reference
#include <stdio.h>
#include <sys/types.h>
Include dependency graph for rpmmacro.h:
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. More...
 
#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. More...
 
int rpmGetMacroEntries (MacroContext mc, void *_mire, int used, const char ***avp)
 Return macro entries as string array. More...
 
int rpmSecuritySaneFile (const char *filename)
 Check whether configuration file is moderately secure to load. More...
 
int rpmGlob (const char *patterns, int *argcPtr, const char ***argvPtr)
 Return URL path(s) from a (URL prefixed) pattern glob. More...
 
int expandMacros (void *spec, MacroContext mc, char *sbuf, size_t slen)
 Expand macro into buffer. More...
 
void addMacro (MacroContext mc, const char *n, const char *o, const char *b, int level)
 Add macro to context. More...
 
void delMacro (MacroContext mc, const char *n)
 Delete macro from context. More...
 
int rpmDefineMacro (MacroContext mc, const char *macro, int level)
 Define macro in context. More...
 
int rpmUndefineMacro (MacroContext mc, const char *macro)
 Undefine macro in context. More...
 
void rpmLoadMacros (MacroContext mc, int level)
 Load macros from specific context into global context. More...
 
int rpmLoadMacroFile (MacroContext mc, const char *fn, int nesting)
 Load macro context from a macro file. More...
 
void rpmInitMacros (MacroContext mc, const char *macrofiles)
 Initialize macro context from set of macrofile(s). More...
 
void rpmFreeMacros (MacroContext mc)
 Destroy macro context. More...
 
int isCompressed (const char *file, rpmCompressedMagic *compressed)
 Return type of compression used in file. More...
 
char * rpmExpand (const char *arg,...)
 Return (malloc'ed) concatenated macro expansion(s). More...
 
char * rpmMCExpand (MacroContext mc, const char *arg,...)
 Return (malloc'ed) concatenated macro expansion(s) in a context. More...
 
char * rpmCleanPath (char *path)
 Canonicalize file path. More...
 
char * rpmGetPath (const char *path,...)
 Return (malloc'ed) expanded, canonicalized, file path. More...
 
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. More...
 
int rpmExpandNumeric (const char *arg)
 Return macro expansion as a numeric value. More...
 

Variables

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

Macro Definition Documentation

#define RMIL_CMDLINE   -7
#define RMIL_DEFAULT   -15

Markers for sources of macros added throughout rpm.

Definition at line 55 of file rpmmacro.h.

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

#define RMIL_GLOBAL   0

Definition at line 63 of file rpmmacro.h.

Referenced by rpmcliInstall(), and while().

#define RMIL_MACROFILES   -13

Definition at line 56 of file rpmmacro.h.

Referenced by rpmLoadMacroFile().

#define RMIL_OLDSPEC   -1

Definition at line 62 of file rpmmacro.h.

Referenced by handlePreambleTag().

#define RMIL_RPMRC   -11

Definition at line 57 of file rpmmacro.h.

Referenced by parseSpec(), and rpmRebuildTargetVars().

#define RMIL_SPEC   -3

Definition at line 61 of file rpmmacro.h.

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

#define RMIL_TARBALL   -5

Definition at line 60 of file rpmmacro.h.

Typedef Documentation

typedef struct MacroContext_s* MacroContext

Definition at line 13 of file rpmmacro.h.

typedef struct MacroEntry_s* MacroEntry

Definition at line 12 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 211 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 2722 of file macro.c.

References _, findEntry(), n, NULL, pushMacro(), rpmGlobalMacroContext, rpmlog(), RPMLOG_ERR, sortMacroTable(), and strcmp().

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

void delMacro ( MacroContext  mc,
const char *  n 
)

Delete macro from context.

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

Definition at line 2761 of file macro.c.

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

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 2687 of file macro.c.

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

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 3045 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(), fd, Ferror(), Fopen(), Fread(), Fstrerror(), nb, NULL, rc, rpmlog(), RPMLOG_ERR, and void.

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 3279 of file macro.c.

References NULL, path, s, se, t, and te.

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 2789 of file macro.c.

References alloca(), MacroBuf_s::mc, memset(), rpmGlobalMacroContext, and void.

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 _, fprintf(), i, me, NULL, and rpmGlobalMacroContext.

Referenced by rpmShowRC(), and while().

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 3178 of file macro.c.

References _macro_BUFSIZ, bufn, expandMacros(), NULL, s, stpcpy(), t, te, void, xmalloc, xrealloc, and xstrdup().

Referenced by _GetPass(), addChangelog(), archScore(), checkForValidArchitectures(), checkUnpackagedFiles(), cpio_doio(), dbiTagsInit(), debevrfmtTag(), debmd5sumsTag(), defaultMachine(), doPatch(), doPrimary(), doSetupMacro(), fillOutMainPackage(), Fopen(), for(), formatValue(), getMachineInfo(), headerMacrosLoad(), headerMacrosUnload(), headerSprintf(), i18nTag(), if(), 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(), 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(), rpmtsAddInstallElement(), rpmtsAddObsoletes(), rpmtsAddUpgrades(), rpmtsEraseDebuginfo(), rpmtsFindPubkey(), rpmtsOpenSDB(), rpmtsRollback(), rpmtsSkipFiles(), rpmtsSolve(), rpmvtNew(), runImmedTriggers(), runInstScript(), runScript(), runTriggers(), 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 3016 of file macro.c.

References _free(), i, me, memset(), NULL, and rpmGlobalMacroContext.

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 3417 of file macro.c.

References _free(), alloca(), file, fprintf(), NULL, result, rpmGetPath(), strncpy(), t, URL_IS_DASH, and urlPath().

Referenced by addSource(), createDir(), db3close(), db3open(), db_init(), doIcon(), doPatch(), doScript(), doSetupMacro(), doUntar(), for(), handlePreambleTag(), 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 ac, av, dupMacroEntry(), i, me, mireRegexec(), NULL, 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 2547 of file macro.c.

References _free(), ac, argv, av, exit, fprintf(), glob_t::gl_pathc, glob_t::gl_pathv, Glob(), Glob_error(), Glob_pattern_p(), GLOB_TILDE, Globfree(), i, j, nb, NULL, path, rc, setlocale, strncpy(), t, 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(), void, xmalloc, XpoptParseArgvString(), xrealloc, and xstrdup().

Referenced by for(), IDTXglob(), processBinaryFile(), 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 2930 of file macro.c.

References _free(), _max_load_depth, _suffix, ac, av, i, m, me, NULL, RMIL_CMDLINE, rpmCLIMacroContext, rpmGlob(), rpmGlobalMacroContext, rpmLoadMacroFile(), rpmLoadMacros(), rpmlog(), RPMLOG_WARNING, rpmSecuritySaneFile(), void, 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 2851 of file macro.c.

References _, _free(), _macro_BUFSIZ, _MAX_MACRO_DEPTH, alloca(), argv, buf, c, exit, Fclose(), fd, Ferror(), Fopen(), i, max_macro_depth, NULL, rc, RMIL_MACROFILES, rpmDefineMacro(), rpmGlob(), rpmLoadMacroFile(), rpmlog(), RPMLOG_WARNING, rpmMCExpand(), s, SKIPBLANK, void, and xx.

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

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 2811 of file macro.c.

References addMacro(), i, me, NULL, 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 3215 of file macro.c.

References _macro_BUFSIZ, bufn, expandMacros(), NULL, s, stpcpy(), t, te, void, 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 2524 of file macro.c.

Referenced by for(), 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 2803 of file macro.c.

References rpmGlobalMacroContext, and void.

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

Variable Documentation

MacroContext rpmCLIMacroContext
MacroContext rpmGlobalMacroContext