add OPENSSL_FUNC.pod documenting OPENSSL_MSTR, OPENSSL_FUNC, and friends
[openssl.git] / doc / man3 / OPENSSL_FILE.pod
1 =pod
2
3 =head1 NAME
4
5 OPENSSL_FILE, OPENSSL_LINE, OPENSSL_FUNC,
6 OPENSSL_MSTR, OPENSSL_MSTR_HELPER
7 - generic C programming utility macros
8
9 =head1 SYNOPSIS
10
11  #include <openssl/macros.h>
12
13  #define OPENSSL_FILE /* typically: __FILE__ */
14  #define OPENSSL_LINE /* typically: __LINE__ */
15  #define OPENSSL_FUNC /* typically: __func__ */
16
17  #define OPENSSL_MSTR_HELPER(x) #x
18  #define OPENSSL_MSTR(x) OPENSSL_MSTR_HELPER(x)
19
20 =head1 DESCRIPTION
21
22 The macros B<OPENSSL_FILE> and B<OPENSSL_LINE>
23 typically yield the current filename and line number during C compilation.
24 When B<OPENSSL_NO_FILENAMES> is defined they yield B<""> and B<0>, respectively.
25
26 The macro B<OPENSSL_FUNC> attempts to yield the name of the C function
27 currently being compiled, as far as language and compiler versions allow.
28 Otherwise, it yields "(unknown function)".
29
30 The macro B<OPENSSL_MSTR> yields the expansion of the macro given as argument,
31 which is useful for concatentation with string constants.
32 The macro B<OPENSSL_MSTR_HELPER> is an auxiliary macro for this purpose.
33
34 =head1 RETURN VALUES
35
36 see above
37
38 =head1 SEE ALSO
39
40 L<crypto(7)>
41
42 =head1 HISTORY
43
44 B<OPENSSL_FUNC>, B<OPENSSL_MSTR>, and B<OPENSSL_MSTR_HELPER>
45 were added in OpenSSL 3.0.
46
47 =head1 COPYRIGHT
48
49 Copyright 2018-2019 The OpenSSL Project Authors. All Rights Reserved.
50
51 Licensed under the Apache License 2.0 (the "License").  You may not use
52 this file except in compliance with the License.  You can obtain a copy
53 in the file LICENSE in the source distribution or at
54 L<https://www.openssl.org/source/license.html>.
55
56 =cut