Add FatFS library to the Webserver project, extend the HTTP server so that it now...
[pub/USBasp.git] / LUFA / Common / FunctionAttributes.h
index 9efa440..4ed876d 100644 (file)
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
 \r
 \r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
@@ -34,6 +34,9 @@
  *  and code generation features of the compiler. Attributes may be placed in the function prototype in any\r
  *  order, and multiple attributes can be specified for a single function via a space separated list.\r
  *\r
  *  and code generation features of the compiler. Attributes may be placed in the function prototype in any\r
  *  order, and multiple attributes can be specified for a single function via a space separated list.\r
  *\r
+ *  On incompatible versions of GCC or on other compilers, these macros evaluate to nothing unless they are\r
+ *  critical to the code's function and thus must throw a compiler error when used.\r
+ *\r
  *  \note Do not include this file directly, rather include the Common.h header file instead to gain this file's\r
  *        functionality.\r
  */\r
  *  \note Do not include this file directly, rather include the Common.h header file instead to gain this file's\r
  *        functionality.\r
  */\r
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
-                       /** Indicates to the compiler that the function can not ever return, so that any stack restoring or\r
-                        *  return code may be omitted by the compiler in the resulting binary.\r
-                        */\r
-                       #define ATTR_NO_RETURN              __attribute__ ((noreturn))\r
+                       #if (__GNUC__ >= 3) || defined(__DOXYGEN__)\r
+                               /** Indicates to the compiler that the function can not ever return, so that any stack restoring or\r
+                                *  return code may be omitted by the compiler in the resulting binary.\r
+                                */\r
+                               #define ATTR_NO_RETURN              __attribute__ ((noreturn))\r
+                               \r
+                               /** Indicates that the function returns a value which should not be ignored by the user code. When\r
+                                *  applied, any ignored return value from calling the function will produce a compiler warning.\r
+                                */\r
+                               #define ATTR_WARN_UNUSED_RESULT     __attribute__ ((warn_unused_result))\r
+\r
+                               /** Indicates that the specified parameters of the function are pointers which should never be NULL.\r
+                                *  When applied as a 1-based comma separated list the compiler will emit a warning if the specified\r
+                                *  parameters are known at compiler time to be NULL at the point of calling the function.\r
+                                */\r
+                               #define ATTR_NON_NULL_PTR_ARG(...)  __attribute__ ((nonnull (__VA_ARGS__)))\r
+\r
+                               /** Removes any preamble or postamble from the function. When used, the function will not have any\r
+                                *  register or stack saving code. This should be used with caution, and when used the programmer\r
+                                *  is responsible for maintaining stack and register integrity.\r
+                                */\r
+                               #define ATTR_NAKED                  __attribute__ ((naked))\r
+                               \r
+                               /** Prevents the compiler from considering a specified function for inlining. When applied, the given\r
+                                *  function will not be inlined under any circumstances.\r
+                                */\r
+                               #define ATTR_NO_INLINE              __attribute__ ((noinline))\r
+\r
+                               /** Forces the compiler to inline the specified function. When applied, the given function will be\r
+                                *  inlined under all circumstances.\r
+                                */\r
+                               #define ATTR_ALWAYS_INLINE          __attribute__ ((always_inline))\r
+                               \r
+                               /** Indicates that the specified function is pure, in that it has no side-effects other than global\r
+                                *  or parameter variable access.\r
+                                */\r
+                               #define ATTR_PURE                   __attribute__ ((pure))\r
+                               \r
+                               /** Indicates that the specified function is constant, in that it has no side effects other than\r
+                                *  parameter access.\r
+                                */\r
+                               #define ATTR_CONST                  __attribute__ ((const))\r
+                               \r
+                               /** Marks a given function as deprecated, which produces a warning if the function is called. */\r
+                               #define ATTR_DEPRECATED             __attribute__ ((deprecated))\r
+                               \r
+                               /** Marks a function as a weak reference, which can be overridden by other functions with an\r
+                                *  identical name (in which case the weak reference is discarded at link time).\r
+                                */\r
+                               #define ATTR_WEAK                   __attribute__ ((weak))\r
+                       #endif\r
 \r
                        /** Places the function in one of the initialization sections, which execute before the main function\r
                         *  of the application. The init function number can be specified as "x", as an integer. Refer to the\r
 \r
                        /** Places the function in one of the initialization sections, which execute before the main function\r
                         *  of the application. The init function number can be specified as "x", as an integer. Refer to the\r
                         */\r
                        #define ATTR_INIT_SECTION(x)        __attribute__ ((naked, section (".init" #x )))\r
                        \r
                         */\r
                        #define ATTR_INIT_SECTION(x)        __attribute__ ((naked, section (".init" #x )))\r
                        \r
-                       /** Indicates that the function returns a value which should not be ignored by the user code. When\r
-                        *  applied, any ignored return value from calling the function will produce a compiler warning.\r
-                        */\r
-                       #define ATTR_WARN_UNUSED_RESULT     __attribute__ ((warn_unused_result))\r
-\r
-                       /** Indicates that the specified parameters of the function are pointers which should never be NULL.\r
-                        *  When applied as a 1-based comma separated list the compiler will emit a warning if the specified\r
-                        *  parameters are known at compiler time to be NULL at the point of calling the function.\r
-                        */\r
-                       #define ATTR_NON_NULL_PTR_ARG(...)  __attribute__ ((nonnull (__VA_ARGS__)))\r
-\r
-                       /** Removes any preamble or postamble from the function. When used, the function will not have any\r
-                        *  register or stack saving code. This should be used with caution, and when used the programmer\r
-                        *  is responsible for maintaining stack and register integrity.\r
-                        */\r
-                       #define ATTR_NAKED                  __attribute__ ((naked))\r
-                       \r
-                       /** Prevents the compiler from considering a specified function for inlining. When applied, the given\r
-                        *  function will not be inlined under any circumstances.\r
-                        */\r
-                       #define ATTR_NOINLINE               __attribute__ ((noinline))\r
-\r
-                       /** Forces the compiler to inline the specified function. When applied, the given function will be\r
-                        *  inlined under all circumstances.\r
-                        */\r
-                       #define ATTR_ALWAYS_INLINE          __attribute__ ((always_inline))\r
-                       \r
-                       /** Indicates that the specified function is pure, in that it has no side-effects other than global\r
-                        *  or parameter variable access.\r
-                        */\r
-                       #define ATTR_PURE                   __attribute__ ((pure))\r
-                       \r
-                       /** Indicates that the specified function is constant, in that it has no side effects other than\r
-                        *  parameter access.\r
-                        */\r
-                       #define ATTR_CONST                  __attribute__ ((const))\r
-                       \r
-                       /** Marks a given function as deprecated, which produces a warning if the function is called. */\r
-                       #define ATTR_DEPRECATED             __attribute__ ((deprecated))\r
-                       \r
-                       /** Marks a function as a weak reference, which can be overridden by other functions with an\r
-                        *  identical name (in which case the weak reference is discarded at link time).\r
-                        */\r
-                       #define ATTR_WEAK                   __attribute__ ((weak))\r
-                       \r
                        /** Marks a function as an alias for another function of name "x". */\r
                        #define ATTR_ALIAS(x)               __attribute__ ((alias( #x )))\r
                        /** Marks a function as an alias for another function of name "x". */\r
                        #define ATTR_ALIAS(x)               __attribute__ ((alias( #x )))\r
-               \r
 #endif\r
 \r
 /** @} */\r
 #endif\r
 \r
 /** @} */\r