rpmio/rpmmacro.h File Reference

Go to the source code of this file.

Data Structures

struct  MacroEntry_s
struct  MacroContext_s

Defines

#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_sMacroEntry
typedef struct MacroContext_sMacroContext
typedef enum rpmCompressedMagic_e rpmCompressedMagic

Enumerations

enum  rpmCompressedMagic_e { COMPRESSED_NOT = 0, COMPRESSED_OTHER = 1, COMPRESSED_BZIP2 = 2, COMPRESSED_ZIP = 3 }

Functions

void rpmDumpMacroTable (MacroContext mc, FILE *fp)
 Print macros to file stream.
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.
void rpmLoadMacros (MacroContext mc, int level)
 Load macros from specific context into global context.
int rpmLoadMacroFile (MacroContext mc, const char *fn)
 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 * rpmCleanPath (char *path)
 Canonicalize file path.
const 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 * macrofiles
 List of macro files to read when configuring rpm.


Detailed Description

Definition in file rpmmacro.h.


Define Documentation

#define RMIL_CMDLINE   -7

Definition at line 50 of file rpmmacro.h.

Referenced by ftsCacheUpdate(), and rpmcliAllArgCallback().

#define RMIL_DEFAULT   -15

Markers for sources of macros added throughout rpm.

Definition at line 46 of file rpmmacro.h.

Referenced by main(), rpmtsOpenSDB(), setDefaults(), setPathDefault(), and setVarDefault().

#define RMIL_GLOBAL   0

Definition at line 54 of file rpmmacro.h.

#define RMIL_MACROFILES   -13

Definition at line 47 of file rpmmacro.h.

#define RMIL_OLDSPEC   -1

Definition at line 53 of file rpmmacro.h.

Referenced by handlePreambleTag().

#define RMIL_RPMRC   -11

Definition at line 48 of file rpmmacro.h.

Referenced by doReadRC(), and parseSpec().

#define RMIL_SPEC   -3

Definition at line 52 of file rpmmacro.h.

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

#define RMIL_TARBALL   -5

Definition at line 51 of file rpmmacro.h.

Referenced by buildForTarget().


Typedef Documentation

typedef struct MacroContext_s * MacroContext

typedef struct MacroEntry_s * MacroEntry

typedef enum rpmCompressedMagic_e rpmCompressedMagic


Enumeration Type Documentation

enum rpmCompressedMagic_e

Enumerator:
COMPRESSED_NOT  not compressed
COMPRESSED_OTHER  gzip can handle
COMPRESSED_BZIP2  bzip2 can handle
COMPRESSED_ZIP  unzip can handle

Definition at line 171 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:
mc macro context (NULL uses global context).
n macro name
o macro paramaters
b macro body
level macro recursion level (0 is entry API)

Definition at line 1864 of file macro.c.

Referenced by addSource(), buildForTarget(), doReadRC(), doScript(), doSetupMacro(), handlePreambleTag(), main(), makeGPGSignature(), makePGPSignature(), parseSpec(), rpmPlatform(), rpmrc_AddMacro(), rpmtsOpenSDB(), setDefaults(), setPathDefault(), and setVarDefault().

void delMacro ( MacroContext  mc,
const char *  n 
)

Delete macro from context.

Parameters:
mc macro context (NULL uses global context).
n macro name

Definition at line 1890 of file macro.c.

Referenced by doScript(), handlePreambleTag(), makeGPGSignature(), makePGPSignature(), parseSpec(), rpmrc_DelMacro(), 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:
spec cookie (unused)
mc macro context (NULL uses global context).
Return values:
sbuf input macro to expand, output expansion
Parameters:
slen size of buffer
Returns:
0 on success

Definition at line 1829 of file macro.c.

Referenced by addFileToTagAux(), copyNextLine(), and processPackageFiles().

int isCompressed ( const char *  file,
rpmCompressedMagic compressed 
)

Return type of compression used in file.

Parameters:
file name of file
Return values:
compressed address of compression type
Returns:
0 on success, 1 on I/O error

Definition at line 2056 of file macro.c.

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

char* rpmCleanPath ( char *  path  ) 

Canonicalize file path.

Parameters:
path path to canonicalize (in-place)
Returns:
canonicalized path (malloc'ed)

Definition at line 2158 of file macro.c.

Referenced by doLookup(), relocateFileList(), and rpmQueryVerify().

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

Define macro in context.

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

Definition at line 1906 of file macro.c.

Referenced by ftsCacheUpdate(), and rpmcliAllArgCallback().

void rpmDumpMacroTable ( MacroContext  mc,
FILE *  fp 
)

Print macros to file stream.

Parameters:
mc macro context (NULL uses global context).
fp file stream (NULL uses stderr).

Definition at line 207 of file macro.c.

References _, MacroEntry_s::body, MacroContext_s::firstFree, MacroEntry_s::level, MacroContext_s::macroTable, MacroEntry_s::name, MacroEntry_s::opts, rpmGlobalMacroContext, and MacroEntry_s::used.

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

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

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

Definition at line 2108 of file macro.c.

Referenced by checkForValidArchitectures(), checkPassPhrase(), cpio_doio(), db3New(), defaultMachine(), doPrimary(), doScript(), doSetupMacro(), expandMacro(), initGlobs(), main(), makeGPGSignature(), makePGPSignature(), open_dso(), packageBinaries(), parseForRegexLang(), parseForSimple(), parseSpec(), processSourceFiles(), rdToken(), readLine(), rpmcliAllArgCallback(), rpmcliImportPubkeys(), rpmcliQuery(), rpmfcExec(), rpmfcExpandAppend(), rpmGetPassPhrase(), rpmgiNext(), rpmgiOpen(), rpmLookupSignatureType(), rpmPlatform(), rpmRollback(), rpmts_IDTXglob(), rpmtsFindPubkey(), rpmtsSolve(), skipFiles(), urlFind(), and writeRPM().

int rpmExpandNumeric ( const char *  arg  ) 

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.

Parameters:
arg macro to expand
Returns:
numeric value

Definition at line 2131 of file macro.c.

Referenced by build(), genCpioListAndHeader(), main(), parseRCPOT(), parseSpec(), processPackageFiles(), relocateFileList(), rpmcliQuery(), rpmcliVerify(), rpmdbInit(), rpmErase(), rpmfcELF(), rpmInstall(), rpmLeadVersion(), rpmRollback(), rpmts_Create(), rpmts_init(), rpmtsCreate(), rpmtsOpenSDB(), rpmtsRun(), and skipFiles().

void rpmFreeMacros ( MacroContext  mc  ) 

Destroy macro context.

Parameters:
mc macro context (NULL uses global context).

Definition at line 2029 of file macro.c.

Referenced by build(), and main().

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:
urlroot root URL (often path to chroot, or NULL)
urlmdir directory URL (often a directory, or NULL)
urlfile file URL (often a file, or NULL)
Returns:
expanded, merged, canonicalized path (malloc'ed)

Definition at line 2277 of file macro.c.

Referenced by buildForTarget(), db3close(), db3open(), db_init(), doScript(), doSetupMacro(), handlePreambleTag(), makeTempFile(), processPackageFiles(), rpmInstall(), and rpmInstallSourcePackage().

const char* rpmGetPath ( const char *  path,
  ... 
)

Return (malloc'ed) expanded, canonicalized, file path.

Parameters:
path macro(s) to expand (NULL terminates list)
Returns:
canonicalized path (malloc'ed)

Definition at line 2246 of file macro.c.

Referenced by addFileToTagAux(), addSource(), buildForTarget(), db3close(), db3open(), doPatch(), doReadRC(), doRmSource(), doUntar(), genCpioListAndHeader(), main(), packageBinaries(), packageSources(), parseFiles(), parseForSimple(), parseSpec(), processPackageFiles(), processSourceFiles(), readIcon(), rpmDetectPGPVersion(), rpmfiBuildREContexts(), rpmfiNew(), rpmInstall(), rpmQueryVerify(), rpmsxParse(), rpmts_Run(), rpmtsOpenDB(), rpmtsOpenSDB(), and setPathDefault().

int rpmGlob ( const char *  patterns,
int *  argcPtr,
const char ***  argvPtr 
)

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

Parameters:
patterns glob pattern
Return values:
*argcPtr no. of paths
*argvPtr array of paths (malloc'd contiguous blob)
Returns:
0 on success

Definition at line 1690 of file macro.c.

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

Referenced by IDTXglob(), rpmgiGlobArgv(), rpmGraph(), rpmInstall(), and rpmReadPackageManifest().

void rpmInitMacros ( MacroContext  mc,
const char *  macrofiles 
)

Initialize macro context from set of macrofile(s).

Parameters:
mc macro context
macrofiles colon separated list of macro files (NULL does nothing)

Definition at line 1973 of file macro.c.

int rpmLoadMacroFile ( MacroContext  mc,
const char *  fn 
)

Load macro context from a macro file.

Parameters:
mc (unused)
fn macro file name

Definition at line 1940 of file macro.c.

void rpmLoadMacros ( MacroContext  mc,
int  level 
)

Load macros from specific context into global context.

Parameters:
mc macro context (NULL does nothing).
level macro recursion level (0 is entry API)

Definition at line 1919 of file macro.c.


Variable Documentation

MacroContext rpmCLIMacroContext

Definition at line 73 of file macro.c.

MacroContext rpmGlobalMacroContext

Definition at line 68 of file macro.c.


Generated on Tue Jan 15 19:55:51 2008 for rpm by  doxygen 1.5.4