iPXE
Macros | Functions
Macros to provide or require explicit objects

Macros

#define PREFIX_OBJECT(_prefix)   _C2 ( _prefix, OBJECT )
 
#define OBJECT_SYMBOL   PREFIX_OBJECT ( obj_ )
 
#define REQUEST_OBJECT(object)   REQUEST_SYMBOL ( obj_ ## object )
 Request an object. More...
 
#define REQUIRE_OBJECT(object)   REQUIRE_SYMBOL ( obj_ ## object )
 Require an object. More...
 

Functions

 PROVIDE_SYMBOL (OBJECT_SYMBOL)
 Always provide the symbol for the current object (defined by -DOBJECT) More...
 

Detailed Description

Macro Definition Documentation

◆ PREFIX_OBJECT

#define PREFIX_OBJECT (   _prefix)    _C2 ( _prefix, OBJECT )

Definition at line 174 of file compiler.h.

◆ OBJECT_SYMBOL

#define OBJECT_SYMBOL   PREFIX_OBJECT ( obj_ )

Definition at line 175 of file compiler.h.

◆ REQUEST_OBJECT

#define REQUEST_OBJECT (   object)    REQUEST_SYMBOL ( obj_ ## object )

Request an object.

Parameters
objectObject name

Request an object to be included within the link. If the object cannot be found, the link will succeed anyway.

Definition at line 188 of file compiler.h.

◆ REQUIRE_OBJECT

#define REQUIRE_OBJECT (   object)    REQUIRE_SYMBOL ( obj_ ## object )

Require an object.

Parameters
objectObject name

Require an object to be included within the link. If the object cannot be found, the link will fail.

To use this macro within a file, you must also specify the file's "requiring symbol" using the REQUIRING_SYMBOL() or PROVIDE_REQUIRING_SYMBOL() macros.

Definition at line 202 of file compiler.h.

Function Documentation

◆ PROVIDE_SYMBOL()

PROVIDE_SYMBOL ( OBJECT_SYMBOL  )

Always provide the symbol for the current object (defined by -DOBJECT)