build/rpmbuild.h

Go to the documentation of this file.

#ifndef _H_RPMBUILD_
#define _H_RPMBUILD_

#include "rpmcli.h"

/* and it shouldn't need these :-( */
#include "stringbuf.h"
#include "misc.h"

/* but this will be needed */
#include "rpmspec.h"

/*@-typeuse@*/
typedef enum rpmBuildFlags_e {
/*@-enummemuse@*/
    RPMBUILD_NONE       = 0,
/*@=enummemuse@*/
    RPMBUILD_PREP       = (1 <<  0),    
    RPMBUILD_BUILD      = (1 <<  1),    
    RPMBUILD_INSTALL    = (1 <<  2),    
    RPMBUILD_CHECK      = (1 <<  3),    
    RPMBUILD_CLEAN      = (1 <<  4),    
    RPMBUILD_FILECHECK  = (1 <<  5),    
    RPMBUILD_PACKAGESOURCE = (1 <<  6), 
    RPMBUILD_PACKAGEBINARY = (1 <<  7), 
    RPMBUILD_RMSOURCE   = (1 <<  8),    
    RPMBUILD_RMBUILD    = (1 <<  9),    
    RPMBUILD_STRINGBUF  = (1 << 10),    
    RPMBUILD_RMSPEC     = (1 << 11)     
} rpmBuildFlags;
/*@=typeuse@*/

#include <ctype.h>

#define SKIPSPACE(s) { while (*(s) && xisspace(*(s))) (s)++; }
#define SKIPNONSPACE(s) { while (*(s) && !xisspace(*(s))) (s)++; }

#define PART_SUBNAME  0
#define PART_NAME     1

typedef enum rpmParseState_e {
    PART_NONE           =  0,   
    PART_PREAMBLE       =  1,   
    PART_PREP           =  2,   
    PART_BUILD          =  3,   
    PART_INSTALL        =  4,   
    PART_CHECK          =  5,   
    PART_CLEAN          =  6,   
    PART_FILES          =  7,   
    PART_PRE            =  8,   
    PART_POST           =  9,   
    PART_PREUN          = 10,   
    PART_POSTUN         = 11,   
    PART_PRETRANS       = 12,   
    PART_POSTTRANS      = 13,   
    PART_DESCRIPTION    = 14,   
    PART_CHANGELOG      = 15,   
    PART_TRIGGERIN      = 16,   
    PART_TRIGGERUN      = 17,   
    PART_VERIFYSCRIPT   = 18,   
    PART_BUILDARCHITECTURES= 19,
    PART_TRIGGERPOSTUN  = 20,   
    PART_LAST           = 21    
} rpmParseState;

#define STRIP_NOTHING             0
#define STRIP_TRAILINGSPACE (1 << 0)
#define STRIP_COMMENTS      (1 << 1)

#ifdef __cplusplus
extern "C" {
#endif
/*@-redecl@*/

void freeNames(void)
        /*@globals internalState@*/
        /*@modifies internalState */;

extern /*@observer@*/ const char * getUname(uid_t uid)
        /*@globals internalState @*/
        /*@modifies internalState @*/;

extern /*@observer@*/ const char * getUnameS(const char * uname)
        /*@globals internalState @*/
        /*@modifies internalState @*/;

uid_t getUidS(const char * uname)
        /*@globals internalState @*/
        /*@modifies internalState @*/;

extern /*@observer@*/ const char * getGname(gid_t gid)
        /*@globals internalState @*/
        /*@modifies internalState @*/;

extern /*@observer@*/ const char * getGnameS(const char * gname)
        /*@globals internalState @*/
        /*@modifies internalState @*/;

gid_t getGidS(const char * gname)
        /*@globals internalState @*/
        /*@modifies internalState @*/;

extern /*@observer@*/ const char * const buildHost(void)        /*@*/;

extern /*@observer@*/ int_32 * const getBuildTime(void) /*@*/;

int readLine(Spec spec, int strip)
        /*@globals rpmGlobalMacroContext, h_errno, fileSystem, internalState @*/
        /*@modifies spec->fileStack, spec->readStack, spec->line, spec->lineNum,
                spec->nextline, spec->nextpeekc, spec->lbuf, spec->sl,
                rpmGlobalMacroContext, fileSystem, internalState  @*/;

void closeSpec(/*@partial@*/ Spec spec)
        /*@globals fileSystem, internalState @*/
        /*@modifies spec->fileStack, fileSystem, internalState @*/;

void handleComments(char * s)
        /*@modifies s @*/;

rpmParseState isPart(const char * line) /*@*/;

int parseNum(/*@null@*/ const char * line, /*@null@*/ /*@out@*/int * res)
        /*@modifies *res @*/;

void addChangelogEntry(Header h, time_t time, const char * name,
                const char * text)
        /*@modifies h @*/;

int parseBuildInstallClean(Spec spec, rpmParseState parsePart)
        /*@globals rpmGlobalMacroContext, h_errno, fileSystem, internalState @*/
        /*@modifies spec->build, spec->install, spec->check, spec->clean,
                spec->macros,
                spec->fileStack, spec->readStack, spec->line, spec->lineNum,
                spec->nextline, spec->nextpeekc, spec->lbuf, spec->sl,
                rpmGlobalMacroContext, fileSystem, internalState @*/;

int parseChangelog(Spec spec)
        /*@globals rpmGlobalMacroContext, h_errno, fileSystem, internalState @*/
        /*@modifies spec->fileStack, spec->readStack, spec->line, spec->lineNum,
                spec->nextline, spec->nextpeekc, spec->lbuf, spec->sl,
                spec->packages->header,
                rpmGlobalMacroContext, fileSystem, internalState @*/;

int parseDescription(Spec spec)
        /*@globals rpmGlobalMacroContext, h_errno, fileSystem, internalState @*/
        /*@modifies spec->packages,
                spec->fileStack, spec->readStack, spec->line, spec->lineNum,
                spec->nextline, spec->nextpeekc, spec->lbuf, spec->sl,
                spec->st,
                rpmGlobalMacroContext, fileSystem, internalState  @*/;

int parseFiles(Spec spec)
        /*@globals rpmGlobalMacroContext, h_errno, fileSystem, internalState @*/
        /*@modifies spec->packages,
                spec->fileStack, spec->readStack, spec->line, spec->lineNum,
                spec->nextline, spec->nextpeekc, spec->lbuf, spec->sl,
                rpmGlobalMacroContext, fileSystem, internalState @*/;

int parsePreamble(Spec spec, int initialPackage)
        /*@globals rpmGlobalMacroContext, h_errno,
                fileSystem, internalState @*/
        /*@modifies spec->packages,
                spec->fileStack, spec->readStack, spec->line, spec->lineNum,
                spec->buildSubdir,
                spec->macros, spec->st, spec->buildRootURL,
                spec->sources, spec->numSources, spec->noSource,
                spec->buildRestrictions, spec->BANames, spec->BACount,
                spec->gotBuildRootURL,
                spec->nextline, spec->nextpeekc, spec->lbuf, spec->sl,
                rpmGlobalMacroContext, fileSystem, internalState @*/;

int parsePrep(Spec spec)
        /*@globals rpmGlobalMacroContext, h_errno, fileSystem, internalState @*/
        /*@modifies spec->prep, spec->buildSubdir, spec->macros,
                spec->fileStack, spec->readStack, spec->line, spec->lineNum,
                spec->nextline, spec->nextpeekc, spec->lbuf, spec->sl,
                rpmGlobalMacroContext, fileSystem, internalState @*/;

int parseRCPOT(Spec spec, Package pkg, const char * field, rpmTag tagN,
                int index, rpmsenseFlags tagflags)
        /*@globals rpmGlobalMacroContext, h_errno @*/
        /*@modifies rpmGlobalMacroContext @*/;

int parseScript(Spec spec, int parsePart)
        /*@globals rpmGlobalMacroContext, h_errno, fileSystem, internalState @*/
        /*@modifies spec->packages,
                spec->fileStack, spec->readStack, spec->line, spec->lineNum,
                spec->nextline, spec->nextpeekc, spec->lbuf, spec->sl,
                rpmGlobalMacroContext, fileSystem, internalState  @*/;

int parseExpressionBoolean(Spec spec, const char * expr)
        /*@globals rpmGlobalMacroContext, h_errno @*/
        /*@modifies rpmGlobalMacroContext @*/;

/*@unused@*/ /*@null@*/
char * parseExpressionString(Spec spec, const char * expr)
        /*@globals rpmGlobalMacroContext, h_errno @*/
        /*@modifies rpmGlobalMacroContext @*/;

int doScript(Spec spec, int what, /*@null@*/ const char * name,
                /*@null@*/ StringBuf sb, int test)
        /*@globals rpmGlobalMacroContext, h_errno,
                fileSystem, internalState @*/
        /*@modifies spec->macros,
                rpmGlobalMacroContext, fileSystem, internalState @*/;

int lookupPackage(Spec spec, /*@null@*/ const char * name, int flag,
                /*@out@*/ Package * pkg)
        /*@modifies spec->packages, *pkg @*/;

/*@only@*/
Package newPackage(Spec spec)
        /*@modifies spec->packages, spec->packages->next @*/;

/*@null@*/
Package freePackages(/*@only@*/ /*@null@*/ Package packages)
        /*@globals fileSystem @*/
        /*@modifies packages, fileSystem @*/;

/*@null@*/
Package  freePackage(/*@only@*/ /*@null@*/ Package pkg)
        /*@globals fileSystem @*/
        /*@modifies pkg, fileSystem @*/;

int addReqProv(/*@unused@*/Spec spec, Header h, rpmTag tagN,
                const char * N, const char * EVR, rpmsenseFlags Flags,
                int index)
        /*@modifies h @*/;

int rpmlibNeedsFeature(Header h, const char * feature, const char * featureEVR)
        /*@modifies h @*/;

int processBinaryFiles(Spec spec, int installSpecialDoc, int test)
        /*@globals rpmGlobalMacroContext, h_errno, fileSystem, internalState @*/
        /*@modifies spec->macros,
                spec->packages->cpioList, spec->packages->fileList,
                spec->packages->specialDoc, spec->packages->header,
                rpmGlobalMacroContext, fileSystem, internalState @*/;

void initSourceHeader(Spec spec)
        /*@modifies spec->sourceHeader,
                spec->buildRestrictions, spec->BANames,
                spec->packages->header @*/;

int processSourceFiles(Spec spec)
        /*@globals rpmGlobalMacroContext, h_errno, fileSystem, internalState @*/
        /*@modifies spec->sourceHeader, spec->sourceCpioList,
                spec->buildRestrictions, spec->BANames,
                spec->packages->header,
                rpmGlobalMacroContext, fileSystem, internalState @*/;

int parseSpec(rpmts ts, const char * specFile,
                /*@null@*/ const char * rootURL,
                /*@null@*/ const char * buildRootURL,
                int recursing,
                /*@null@*/ const char * passPhrase,
                /*@null@*/ char * cookie,
                int anyarch, int force)
        /*@globals rpmGlobalMacroContext, h_errno, fileSystem, internalState @*/
        /*@modifies ts, rpmGlobalMacroContext, fileSystem, internalState @*/;

int buildSpec(rpmts ts, Spec spec, int what, int test)
        /*@globals rpmGlobalMacroContext, h_errno, fileSystem, internalState @*/
        /*@modifies spec->sourceHeader, spec->sourceCpioList, spec->cookie,
                spec->sourceRpmName, spec->sourcePkgId,
                spec->macros, spec->BASpecs,
                spec->buildRestrictions, spec->BANames,
                spec->packages->cpioList, spec->packages->fileList,
                spec->packages->specialDoc, spec->packages->header,
                rpmGlobalMacroContext, fileSystem, internalState @*/;

int packageBinaries(Spec spec)
        /*@globals rpmGlobalMacroContext, h_errno, fileSystem, internalState @*/
        /*@modifies spec->packages->header, spec->packages->cpioList,
                spec->sourceRpmName,
                rpmGlobalMacroContext, fileSystem, internalState @*/;

int packageSources(Spec spec)
        /*@globals rpmGlobalMacroContext, h_errno, fileSystem, internalState @*/
        /*@modifies spec->sourceHeader, spec->cookie, spec->sourceCpioList,
                spec->sourceRpmName, spec->sourcePkgId,
                rpmGlobalMacroContext, fileSystem, internalState @*/;

/*@=redecl@*/
#ifdef __cplusplus
}
#endif

#endif  /* _H_RPMBUILD_ */

---