FunctionAttributes.h File Reference


Defines

#define ATTR_NO_RETURN   __attribute__ ((noreturn))
#define ATTR_INIT_SECTION(x)   __attribute__ ((naked, section (".init" #x )))
#define ATTR_WARN_UNUSED_RESULT   __attribute__ ((warn_unused_result))
#define ATTR_NON_NULL_PTR_ARG(...)   __attribute__ ((nonnull (__VA_ARGS__)))
#define ATTR_NAKED   __attribute__ ((naked))
#define ATTR_NOINLINE   __attribute__ ((noinline))
#define ATTR_PURE   __attribute__ ((pure))
#define ATTR_CONST   __attribute__ ((const))
#define ATTR_DEPRECATED   __attribute__ ((deprecated))
#define ATTR_WEAK   __attribute__ ((weak))
#define ATTR_ALIAS(x)   __attribute__ ((alias( #x )))

Detailed Description

This file contains macros for applying GCC specific attributes to functions to control various optimizer and code generation features of the compiler. Attributes may be placed in the function prototype in any order, and multiple attributes can be specified for a single function via a space seperated list.

Note:
Do not include this file directly, rather include the Common.h header file instead to gain this file's functionality.

Define Documentation

#define ATTR_ALIAS (  )     __attribute__ ((alias( #x )))

Marks a function as an alias for another function of name "x".

#define ATTR_CONST   __attribute__ ((const))

Indicates that the specified function is constant, in that it has no side effects other than parameter access.

#define ATTR_DEPRECATED   __attribute__ ((deprecated))

Marks a given function as deprecated, which produces a warning if the function is called.

#define ATTR_INIT_SECTION (  )     __attribute__ ((naked, section (".init" #x )))

Places the function in one of the initilization sections, which execute before the main function of the application. The init function number can be specified as "x", as an integer. Refer to the avr-libc manual for more information on the initialization sections.

#define ATTR_NAKED   __attribute__ ((naked))

Removes any preample or postample from the function. When used, the function will not have any register or stack saving code. This should be used with caution, and when used the programmer is responsible for maintaining stack and register integrity.

#define ATTR_NO_RETURN   __attribute__ ((noreturn))

Indicates to the compiler that the function can not ever return, so that any stack restoring or return code may be ommited by the compiler in the resulting binary.

#define ATTR_NOINLINE   __attribute__ ((noinline))

Prevents the compiler from considering a specified function for inlining. When applied, the given function will not be inlined under any circumstances.

#define ATTR_NON_NULL_PTR_ARG ( ...   )     __attribute__ ((nonnull (__VA_ARGS__)))

Indicates that the specified parameters of the function are pointers which should never be NULL. When applied as a 1-based comma seperated list the compiler will emmit a warning if the specified parameters are known at compiler time to be NULL at the point of calling the function.

#define ATTR_PURE   __attribute__ ((pure))

Indicates that the specified function is pure, in that it has no side-effects other than global or parameter variable access.

#define ATTR_WARN_UNUSED_RESULT   __attribute__ ((warn_unused_result))

Indicates that the function returns a value which should not be ignored by the user code. When applied, any ignored return value from calling the function will produce a compiler warning.

#define ATTR_WEAK   __attribute__ ((weak))

Marks a function as a weak reference, which can be overridden by other functions with an identical name (in which case the weak reference is discarded at link time).


Generated on Mon Jul 7 12:27:43 2008 for MyUSB Library by  doxygen 1.5.5