xref: /btstack/port/samv71-xplained-atwilc3000/ASF/sam/utils/preprocessor/stringz.h (revision 1b2596b5303dd8caeea8565532c93cca8dab8cc4)
1 /**
2  * \file
3  *
4  * \brief Preprocessor stringizing utils.
5  *
6  * Copyright (c) 2010-2015 Atmel Corporation. All rights reserved.
7  *
8  * \asf_license_start
9  *
10  * \page License
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions are met:
14  *
15  * 1. Redistributions of source code must retain the above copyright notice,
16  *    this list of conditions and the following disclaimer.
17  *
18  * 2. Redistributions in binary form must reproduce the above copyright notice,
19  *    this list of conditions and the following disclaimer in the documentation
20  *    and/or other materials provided with the distribution.
21  *
22  * 3. The name of Atmel may not be used to endorse or promote products derived
23  *    from this software without specific prior written permission.
24  *
25  * 4. This software may only be redistributed and used in connection with an
26  *    Atmel microcontroller product.
27  *
28  * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
29  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
30  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
31  * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
32  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
36  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
37  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGE.
39  *
40  * \asf_license_stop
41  *
42  */
43 /*
44  * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
45  */
46 
47 #ifndef _STRINGZ_H_
48 #define _STRINGZ_H_
49 
50 /**
51  * \defgroup group_sam_utils_stringz Preprocessor - Stringize
52  *
53  * \ingroup group_sam_utils
54  *
55  * \{
56  */
57 
58 /*! \brief Stringize.
59  *
60  * Stringize a preprocessing token, this token being allowed to be \#defined.
61  *
62  * May be used only within macros with the token passed as an argument if the token is \#defined.
63  *
64  * For example, writing STRINGZ(PIN) within a macro \#defined by PIN_NAME(PIN)
65  * and invoked as PIN_NAME(PIN0) with PIN0 \#defined as A0 is equivalent to
66  * writing "A0".
67  */
68 #define STRINGZ(x)                                #x
69 
70 /*! \brief Absolute stringize.
71  *
72  * Stringize a preprocessing token, this token being allowed to be \#defined.
73  *
74  * No restriction of use if the token is \#defined.
75  *
76  * For example, writing ASTRINGZ(PIN0) anywhere with PIN0 \#defined as A0 is
77  * equivalent to writing "A0".
78  */
79 #define ASTRINGZ(x)                               STRINGZ(x)
80 
81 /**
82  * \}
83  */
84 
85 #endif  // _STRINGZ_H_
86