Debian Codegraph @

upstream/debian-unstable/man3/OPENSSL_FILE.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OPENSSL_FILE 3SSL"
58 .TH OPENSSL_FILE 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 OPENSSL_FILE, OPENSSL_LINE, OPENSSL_FUNC,
65 OPENSSL_MSTR, OPENSSL_MSTR_HELPER
66 \&\- generic C programming utility macros
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/macros.h>
71 \&
72 \& #define OPENSSL_FILE /* typically: _\|_FILE_\|_ */
73 \& #define OPENSSL_LINE /* typically: _\|_LINE_\|_ */
74 \& #define OPENSSL_FUNC /* typically: _\|_func_\|_ */
75 \&
76 \& #define OPENSSL_MSTR_HELPER(x) #x
77 \& #define OPENSSL_MSTR(x) OPENSSL_MSTR_HELPER(x)
78 .Ve
79 .SH DESCRIPTION
80 .IX Header "DESCRIPTION"
81 The macros \fBOPENSSL_FILE\fR and \fBOPENSSL_LINE\fR
82 typically yield the current filename and line number during C compilation.
83 When \fBOPENSSL_NO_FILENAMES\fR is defined they yield \fB""\fR and \fB0\fR, respectively.
84 .PP
85 The macro \fBOPENSSL_FUNC\fR attempts to yield the name of the C function
86 currently being compiled, as far as language and compiler versions allow.
87 Otherwise, it yields "(unknown function)".
88 .PP
89 The macro \fBOPENSSL_MSTR\fR yields the expansion of the macro given as argument,
90 which is useful for concatenation with string constants.
91 The macro \fBOPENSSL_MSTR_HELPER\fR is an auxiliary macro for this purpose.
92 .SH "RETURN VALUES"
93 .IX Header "RETURN VALUES"
94 see above
95 .SH "SEE ALSO"
96 .IX Header "SEE ALSO"
97 \&\fBcrypto\fR\|(7)
98 .SH HISTORY
99 .IX Header "HISTORY"
100 \&\fBOPENSSL_FUNC\fR, \fBOPENSSL_MSTR\fR, and \fBOPENSSL_MSTR_HELPER\fR
101 were added in OpenSSL 3.0.
102 .SH COPYRIGHT
103 .IX Header "COPYRIGHT"
104 Copyright 2018\-2019 The OpenSSL Project Authors. All Rights Reserved.
105 .PP
106 Licensed under the Apache License 2.0 (the "License"). You may not use
107 this file except in compliance with the License. You can obtain a copy
108 in the file LICENSE in the source distribution or at
109 <https://www.openssl.org/source/license.html>.