Information technology — Programming languages — C
Reply To: JeanHeyd Meneide <wg14@soasis.org>
Freek Wiedijk <freek@cs.ru.nl>
Abstract
(This cover sheet to be replaced by ISO.)
This document specifies the form and establishes the interpretation of programs expressed in the programming language C. Its purpose is to promote portability, reliability, maintainability, and efficient execution of C language programs on a variety of computing systems.
Clauses are included that detail the C language itself and the contents of the C language execution library. Annexes summarize aspects of both of them, and enumerate factors that influence the portability of C programs.
Although this document is intended to guide knowledgeable C language programmers as well as implementers of C language translation systems, the document itself is not designed to serve as a tutorial.
Recipients of this draft are invited to submit, with their comments, notification of any relevant patent rights of which they are aware and to provide supporting documentation.
After the end of the C23 cycle, work began on so-called "C2y", the next projected edition of this document on 2024 January 24.
2024 January
The following changes were made on or after the 2024 January Strasbourg, France meeting:
- N3192: Sequential hexdigits
- Editorial: Adjusted a footnote in Annex K from "reserved" to "potentially reserved"
2024 June
The following changes were made on or after the 2024 June Virtual meeting:
- N3064: Writing to multibyte character files
- N3232: Round-trip rounding
- N3233: Recommendation for printf rounding
- N3239: Some constants are literally literals, v2
- N3242: Problematic use of "correctly rounded"
- N3244: Slay Some Earthly Demons I (6.3.2.1 change, 6.7.2 change option 1, 6.7 change, 6.7.5 change, 6.7.6 change)
- N3247:
fopen"p"and bringfopen’s mode closer to POSIX 202x - N3254: Accessing byte arrays, v4
- N3259: Support
++and--on complex values - N3260:
_Genericselection expression with a type operand - N3273:
alignofof an incomplete array type - N3274: Remove imaginary types, v3
- Editorial: "may" -> "can" for alignment with ISO/IEC Directives
- Editorial: Table headings changed to match ISO/IEC Directives
2024 September/October
The following changes were made on or after the 2024 September/October Minneapolis, USA meeting:
- N3272:
strftimebroken-down structure usage (Option 1: Undefined Behavior) - N3286: Floating-point exception for Macro Replacements
- N3287: Nonsensical Parenthetical in Mathematics Specification
- N3291: Decimal Floating-Point Number Term Misuse
- N3298: Introduce Complex Literals (without changes proposed in 4.2)
- N3303:
HUGE_VALCorrections - N3305: Leftover
WANT_...Macros for<math.h>and Decimal Floating-Point - N3312: Relax Atomic Alignment Requirements
- N3322: Allow Zero Length operations on Null Pointers (Including in the Library)
- N3323: How Do You Add One To Something? (By Using The Proper Type)
- N3324: "pole-error" Wording Fix
- N3326: Standardize
strnlenandwcsnlen - N3340: Slay Some Earthly Demons II
- N3341: Slay Some Earthly Demons III
- N3342: Slay Some Earthly Demons IV
- N3344: Slay Some Earthly Demons VI
- N3345: Slay Some Earthly Demons VII
- N3346: Slay Some Earthly Demons VIII
- N3349:
absWithout Undefined Behavior - N3353: Obsolete Octal and Provide New, Proper Escape Sequences
- N3355: Named/Labeled Loops
- N3356:
ifDeclarations - N3364:
SNANInitialization - N3366: Restartable Functions for Efficient Character Conversions
- N3367: More Modern Bit Utilities
- N3369: The
_LengthofOperator - N3370: Case Ranges in
switchStatements - N3461: range error definition followup
2025 February
The following changes were integrated from the 2025 February Graz, Austria meeting:
- N3363:
<stdarg.h>Wording - N3401: SIGFPE and I/O (v2)
- N3405: Improved Wording for Treatment of Error Conditions in
<math.h> - N3409: Slay Some Earthly Demons X
- N3410: Slay Some Earthly Demons XI
- N3411: Slay Some Earthly Demons XII
- N3418: Slay Some Earthly Demons XIV
- N3447: Chasing Ghost I - Constant Expressions
- N3448: Chasing Ghosts II - Accessing Allocated Storage
- N3451: Initialization of Anonymous Structures and Unions (v2)
- N3452: Complex Literals Warning
- N3459: Integer and Arithmetic Constant Expressions
- N3460: Complex Operators
- N3466: Clarifications on Null Pointers in the Library
- N3469: Big Array Size Survey (
_Lengthof->_Countof, and<stdcountof.h>header) - N3478: Slay Some Earthly Demons XIII
- N3481: Slay Some Earthly Demons XVI
- N3482: Slay Some Earthly Demons XVII
- N3492: Improved treatment of error conditions for functions that round result
- N3496: Clarify the Specification of the Width Macros
- N3505: Preprocessor integer expressions, II
2025 August
The following changes were integrated from the 2025 Brno, Czech Republic meeting:
- N3347: Slay Some Earthly Demons IX
- N3348: Matching of Multi-Dimensional Arrays in Generic Selection Expressions
- N3457: The
__COUNTER__predefined macro - N3484: Slay Some Earthly Demons V
- N3500: Clarification for Complex Suffix Specification
- N3511: Remove "category" from "type category" in footnote
- N3517: Array subscripting without decay
- N3525:
static_assertwithout UB - N3532: Member Access of an Incomplete
structShould Not Be Allowed - N3535:
frexpanddouble-double - N3536: Clarify wording of
cproj - N3537: Correct and clarify 7.3.1 Introduction of Complex Arithmetic
<complex.h> - N3544: Classification of the
registerStorage-class Specifier - N3558: Chasing Ghosts I: Constant Expressions and Objects of Known Constant Size
- N3563: Representation of Pointers and
nullptr_t - N3577: Rename
uimaxabstoumaxabs - N3598: Make text consistent between
crealandcimag - N3623: Slay Some Earthly Demons XIV: Definition of Main
- N3652: Composite types v1.3
Contents
1 Scope
2 Normative references
3 Terms, definitions, and symbols
4 Conformance
5 Environment
6 Language
- 6.4.2 Keywords
- 6.4.3 Identifiers
- 6.4.4 Universal character names .
- 6.4.5 Constants
- 6.4.6 String literals
- 6.4.7 Punctuators
- 6.4.8 Header names
- 6.4.9 Preprocessing numbers
- 6.4.10 Comments
- 6.5 Expressions
- 6.5.1 General .
- 6.5.2 Primary expressions
- 6.5.3 Postfix operators
- 6.5.4 Unary operators
- 6.5.5 Cast operators
- 6.5.6 Multiplicative operators
- 6.5.7 Additive operators
- 6.5.8 Bitwise shift operators
- 6.5.9 Relational operators
- 6.5.10 Equality operators
- 6.5.11 Bitwise AND operator
- 6.5.12 Bitwise exclusive OR operator
- 6.5.13 Bitwise inclusive OR operator
- 6.5.14 Logical AND operator
- 6.5.15 Logical OR operator
- 6.5.16 Conditional operator
- 6.5.17 Assignment operators
- 6.5.18 Comma operator
- 6.6 Constant expressions
- 6.7 Declarations
- 6.7.9 Type definitions
- 6.7.10 Type inference
- 6.7.11 Initialization
- 6.7.12 Static assertions
- 6.7.13 Attributes
- 6.8 Statements and blocks
- 6.9 External definitions
- 6.10 Preprocessing directives
- 6.11 Future language directions
7 Library
- 7.1 Introduction
- 7.2 Diagnostics <assert.h>
- 7.3 Complex arithmetic <complex.h>
- 7.4 Character handling <ctype.h>
- 7.5 Errors <errno.h>
- 7.6 Floating-point environment <fenv.h>
- 7.7 Characteristics of floating types <float.h>
- 7.8 Format conversion of integer types <inttypes.h>
- 7.9 Alternative spellings <iso646.h>
- 7.10 Characteristics of integer types <limits.h>
- 7.11 Localization <locale.h>
- 7.11.1 General .
- 7.11.2 The setlocale function
- 7.11.3 Numeric formatting convention inquiry
- 7.12 Mathematics <math.h>
- 7.13 Non-local jumps <setjmp.h>
- 7.14 Signal handling <signal.h>
- 7.15 Alignment <stdalign.h>
- 7.16 Varying arguments <stdarg.h>
- 7.17 Atomics <stdatomic.h>
- 7.17.6 Atomic integer types
- 7.17.7 Operations on atomic types
- 7.17.8 Atomic flag type and operations
- 7.18 Bit and byte utilities <stdbit.h>
- 7.19 Boolean type and values <stdbool.h>
- 7.20 Checked Integer Arithmetic <stdckdint.h>
- 7.21 Array count <stdcountof.h>
- 7.22 Common definitions <stddef.h>
- 7.23 Integer types <stdint.h>
- 7.23.5 Macros for constants of integer type
- 7.23.6 Maximal and minimal values of integer types
- 7.24 Input/output <stdio.h>
- 7.25 General utilities <stdlib.h>
- 7.25.1 General .
- 7.25.2 Numeric conversion functions
- 7.25.3 Pseudo-random sequence generation functions
- 7.25.4 Memory management functions
- 7.25.5 Communication with the environment
- 7.25.6 Searching and sorting utilities .
- 7.25.7 Integer arithmetic functions
- 7.25.8 Multibyte/wide character conversion functions
- 7.25.9 Multibyte/wide string conversion functions
- 7.26 Text transcoding utilities <stdmchar.h>
- 7.27 _ Noreturn <stdnoreturn.h>
- 7.28 String handling <string.h>
- 7.29 Type-generic math <tgmath.h>
- 7.30 Threads <threads.h>
- 7.30.3 Condition variable functions
- 7.30.4 Mutex functions
- 7.30.5 Thread functions
- 7.30.6 Thread-specific storage functions
- 7.31 Date and time <time.h>
- 7.32 Unicode utilities <uchar.h>
- 7.33 Extended multibyte and wide character utilities <wchar.h>
- 7.34 Wide character classification and mapping utilities <wctype.h>
- 7.35 Future library directions
- 7.35.1 General .
- 7.35.2 Complex arithmetic <complex.h>
- 7.35.3 Character handling <ctype.h>
- 7.35.4 Errors <errno.h>
- 7.35.5 Floating-point environment <fenv.h>
- 7.35.6 Characteristics of floating types <float.h>
- 7.35.7 Format conversion of integer types <inttypes.h>
- 7.35.8 Localization <locale.h>
- 7.35.9 Mathematics <math.h>
A Language syntax summary
B Library summary
C Sequence points
D Universal character names for identifiers
E Implementation limits
F ISO/IEC 60559 floating-point arithmetic
G ISO/IEC 60559-compatible complex arithmetic
H ISO/IEC 60559 interchange and extended types
I Common warnings
J Portability issues
K Bounds-checking interfaces
L Analyzability
M Change History
Bibliography
Index
Foreword
ISO (the International Organization for Standardization) and IEC (the International Electrotechnical Commission) form the specialized system for worldwide standardization. National bodies that are members of ISO or IEC participate in the development of International Standards through technical committees established by the respective organization to deal with particular fields of technical activity. ISO and IEC technical committees collaborate in fields of mutual interest. Other international organizations, governmental and non-governmental, in liaison with ISO and IEC, also take part in the work.
The procedures used to develop this document and those intended for its further maintenance are described in the ISO/IEC Directives, Part 1. In particular, the different approval criteria needed for the different types of document should be noted. This document was drafted in accordance with the editorial rules of the ISO/IEC Directives, Part 2 (see www.iso.org/directives or www.iec.ch/members_experts/refdocs).
ISO and IEC draw attention to the possibility that the implementation of this document may involve the use of (a) patent(s). ISO and IEC take no position concerning the evidence, validity or applicability of any claimed patent rights in respect thereof. As of the date of publication of this document, ISO and IEC had not received notice of (a) patent(s) which may be required to implement this document. However, implementers are cautioned that this may not represent the latest information, which may be obtained from the patent database available at www.iso.org/patents and patents.iec.ch. ISO and IEC shall not be held responsible for identifying any or all such patent rights.
Any trade name used in this document is information given for the convenience of users and does not constitute an endorsement.
For an explanation of the voluntary nature of standards, the meaning of ISO specific terms and expressions related to conformity assessment, as well as information about ISO’s adherence to the World Trade Organization (WTO) principles in the Technical Barriers to Trade (TBT) see www.iso.org/iso/foreword.html. In the IEC, see www.iec.ch/understanding-standards.
This document was prepared by Joint Technical Committee ISO/IEC JTC1, Information technology, Subcommittee SC22, Programming languages, their environments and system software interfaces.
This fifth edition cancels and replaces the fourth edition (ISO/IEC 9899:2018), which has been technically revised. The main changes are contained in Annex M.
Any feedback or questions on this document should be directed to the user’s national standards body. A complete listing of these bodies can be found at www.iso.org/members.html and www.iec.ch/national-committees.
Introduction
With the introduction of new devices and extended character sets, new features could be added to future editions of this document. Subclauses in the language and library clauses warn implementers and programmers of usages which, though valid in themselves, could conflict with future additions.
Certain features are obsolescent, which means that they could be considered for withdrawal in future revisions of this document. They are retained because of their widespread use, but their use in new implementations (for implementation features) or new programs (for language [6.11] or library features [7.35]) is discouraged.
This document is divided into four major subdivisions:
In any given subsequent clause or subclause, there are section delineations in bold to describe the semantics, restrictions, and behaviors of programs for this language and potentially the use of its library clauses in this document:
- Syntax
- which pertains to the spelling and organization of the language and library;
- Constraints
- which detail and enumerate various requirements for the correct interpretation of the language and library, typically during translation;
- Semantics
- which explain the behavior of language features and similar constructs;
- Description
- which explain the behavior of library usage and similar constructs;
- Returns
- which describes the effects of constructs provided back to a user of the library;
- Runtime-constraints
- which detail and enumerate various requirements that are expected to be checked and which shall not be violated, typically during execution;
- Environmental limits
- which list limitations an implementation may impose on a library or language construct which might otherwise be unlimited;
- Recommended practice
- which provides guidance and important considerations for implementers of this document.
Examples are provided to illustrate possible forms of the constructions described. Footnotes are provided to emphasize consequences of the rules described in that subclause or elsewhere in this document. References are used to refer to other related subclauses. Recommendations are provided to give advice or guidance to implementers. Annexes define optional features, provide additional information and summarize the information contained in this document. A bibliography lists documents that were referred to during the preparation of this document.
1 Scope
This document specifies the form and establishes the interpretation of programs written in the C programming language. It is designed to promote the portability of C programs among a variety of data-processing systems. It is intended for use by implementers and programmers. It specifies:
- the representation of C programs;
- the syntax and constraints of the C language;
- the semantic rules for interpreting C programs;
- the representation of input data to be processed by C programs;
- the representation of output data produced by C programs;
- the restrictions and limits imposed by a conforming implementation of C.
This document does not specify:
- the mechanism by which C programs are transformed for use by a data-processing system;
- the mechanism by which C programs are invoked for use by a data-processing system;
- the mechanism by which input data are transformed for use by a C program;
- the mechanism by which output data are transformed after being produced by a C program;
- the size or complexity of a program and its data that will exceed the capacity of any specific data-processing system or the capacity of a particular processor;
- all minimal requirements of a data-processing system that is capable of supporting a conforming implementation.
Annex J gives an overview of portability issues that a C program can encounter.
2 Normative references
The following documents are referred to in the text in such a way that some or all their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.
ISO/IEC 2382:2015, Information technology — Vocabulary.
ISO 4217, Codes for the representation of currencies.
ISO 8601 series, Data elements and interchange formats — Information interchange — Representation of dates and times.
ISO/IEC 10646, Information technology —Universal Coded Character Set (UCS).
ISO/IEC 60559:2020, Information technology — Microprocessor Systems — Floating-Point arithmetic.
ISO 80000–2, Quantities and units — Part 2: Mathematics.
The Unicode Consortium. Unicode Standard Annex, UAX #44, Unicode Character Database [online]. Edited by Ken Whistler. Available at https://www.unicode.org/reports/tr44.
The Unicode Consortium. The Unicode Standard, Derived Core Properties. Available at https://www.unicode.org/Public/UCD/latest/ucd/DerivedCoreProperties.txt.
3 Terms, definitions, and symbols
For the purposes of this document, the terms and definitions given in ISO/IEC 2382, ISO 80000–2, and the following apply.
ISO and IEC maintain terminology databases for use in standardization at the following addresses:
- ISO Online browsing platform: available at
https://www.iso.org/obp - IEC Electropedia: available at
https://www.electropedia.org/
Additional terms are defined where they appear in italic type or on the left side of a syntax rule. Terms explicitly defined in this document are not to be presumed to refer implicitly to similar terms defined elsewhere.
3.1 access (verb)
Note 1 to entry: Where only one of these two actions is meant, "read" or "modify" is used.
Note 2 to entry: "Modify" includes the case where the new value being stored is the same as the previous value.
Note 3 to entry: Expressions that are not evaluated do not access objects.
3.2 alignment
alignment
requirement that objects of a particular type be located on storage boundaries with addresses that are particular multiples of a byte (3.7) address
3.3 argument
argument
actual argument
DEPRECATED: actual parameter
expression in the comma-separated list bounded by the parentheses in a function call expression, or a sequence of preprocessing tokens in the comma-separated list bounded by the parentheses in a function-like macro invocation
3.4 arithmetically negate
Note 1 to entry: For a floating-point number (5.3.5.3.3), this changes the sign; for an integer, this is equivalent to subtracting from zero.
3.5 behavior
3.5.1 implementation-defined behavior
implementation-defined behavior
unspecified behavior where each implementation documents how the choice is made
Note 1 to entry: J.3 gives an overview over properties of C programs that lead to implementation-defined behavior.
EXAMPLE An example of implementation-defined behavior is the propagation of the high-order bit when a signed integer is shifted right.
3.5.2 locale-specific behavior
locale-specific behavior
behavior that depends on local conventions of nationality, culture, and language that each implementation documents
Note 1 to entry: J.4 gives an overview over properties of C programs that lead to locale-specific behavior.
EXAMPLE An example of locale-specific behavior is whether the islower function returns true for characters other than the 26 lowercase Latin letters.
3.5.3 undefined behavior
undefined behavior
behavior, upon use of a nonportable or erroneous program construct or of erroneous data, for which this document imposes no requirements
Note 1 to entry: Possible undefined behavior ranges from ignoring the situation completely with unpredictable results, to behaving during translation or program execution in a documented manner characteristic of the environment (with or without the issuance of a diagnostic message), to terminating a translation or execution (with the issuance of a diagnostic message).
Note 2 to entry: J.2 gives an overview over properties of C programs that lead to undefined behavior.
Note 3 to entry: Any other behavior during execution of a program is only affected as a direct consequence of the concrete behavior that occurs when encountering the erroneous or non-portable program construct or data. In particular, all observable behavior (5.2.2.4) appears as specified in this document when it happens before an operation with undefined behavior in the execution of the program.
EXAMPLE An example of undefined behavior is the behavior on dereferencing a null pointer.
3.5.4 unspecified behavior
unspecified behavior
behavior, that results from the use of an unspecified value, or other behavior upon which this document provides two or more possibilities and imposes no further requirements on which is chosen in any instance
Note 1 to entry: J.1 gives an overview over properties of C programs that lead to unspecified behavior.
EXAMPLE An example of unspecified behavior is the order in which the arguments to a function are evaluated.
3.6 bit
bit
unit of data storage in the execution environment large enough to hold an object that can have one of two values
Note 1 to entry: It is possible that each individual bit of an object is not addressable.
3.7 byte
byte
addressable unit of data storage large enough to hold any member of the basic character set of the execution environment
Note 1 to entry: Each individual byte of an object is uniquely addressable.
3.8 byte array
byte array
3.9 byte type
3.10 low-order bit
3.11 high-order bit
3.12 character
character
⟨abstract⟩member of a set of elements used for the organization, control, or representation of data
3.12.1 character
3.12.2 multibyte character
multibyte character
sequence of one or more bytes representing a member of the extended character set of either the source or the execution environment
Note 1 to entry: The extended character set is a superset of the basic character set.
3.12.3 wide character
3.13 constraint
constraint
restriction, either syntactic or semantic, by which the exposition of language elements is interpreted
3.14 correctly rounded result
correctly rounded result
representation in the result format that is nearest in value, subject to the current rounding mode, to what the result would be given unlimited range and precision
Note 1 to entry: In this document, the words "correctly rounded" may apply to an operation that produces a correctly rounded result.
Note 2 to entry: ISO/IEC 60559 or implementation-defined rules apply for extreme magnitude results if the result format contains infinity.
3.15 diagnostic message
diagnostic message
message belonging to an implementation-defined subset of the implementation’s message output
3.16 forward reference
forward reference
reference to a subsequent subclause in this document that contains additional information relevant to the subclause containing the reference
3.17 implementation
implementation
particular set of software, running in a particular translation environment under particular control options, that performs translation of programs for, and supports execution of functions in, a particular execution environment
3.18 implementation limit
3.19 memory location
memory location
either an object of scalar type, or a maximal sequence of adjacent bit-fields all having nonzero width
Note 1 to entry: Two threads of execution can update and access separate memory locations without interfering with each other.
Note 2 to entry: A bit-field and an adjacent non-bit-field member are in separate memory locations. The same applies to two bit-fields, if one is declared inside a nested structure declaration and the other is not, or if the two are separated by a zero-length bit-field declaration, or if they are separated by a non-bit-field member declaration. It is not safe to concurrently update two non-atomic bit-fields in the same structure if all members declared between them are also (nonzero-length) bit-fields, no matter what the sizes of those intervening bit-fields happen to be.
EXAMPLE A structure declared as
struct { char a; int b:5, c:11,:0, d:8; struct { int ee:8; } e; }
contains four separate memory locations: The member a, and bit-fields d and e.ee are each separate memory locations, and can be modified concurrently without interfering with each other. The bit-fields b and c together constitute the fourth memory location. The bit-fields b and c cannot be concurrently modified, but b and a, for example, can be.
3.20 object
object
region of data storage in the execution environment, the contents of which can represent values
Note 1 to entry: When referenced, an object can be interpreted as having a particular type; see 6.3.3.1.
3.21 parameter
parameter
formal parameter
DEPRECATED: formal argument
object declared as part of a function declaration or definition that acquires a value on entry to the function, or an identifier from the comma-separated list bounded by the parentheses immediately following the macro name in a function-like macro definition
3.22 recommended practice
recommended practice
specification that is strongly recommended as being in keeping with the intent of the standard, but that may be impractical for some implementations
3.23 runtime-constraint
Note 1 to entry: Despite the similar terms, a runtime-constraint is not a kind of constraint as defined by 3.13, and it is not necessary for it to be diagnosed at translation time.
Note 2 to entry: Implementations that support the extensions in Annex K are required to verify that the runtime-constraints for a library function are not violated by the program; see K.3.1.4.
Note 3 to entry: Implementations that support Annex L are permitted to invoke a runtime-constraint handler when they perform a trap.
3.24 value
3.24.1 implementation-defined value
implementation-defined value
unspecified value where each implementation documents how the choice is made
3.24.2 unspecified value
unspecified value
valid value of the relevant type where this document imposes no requirements on which value is chosen in any instance
3.25 indeterminate representation
indeterminate representation
object representation that either represents an unspecified value or is a non-value representation
3.26 non-value representation
non-value representation
an object representation that does not represent a value of the object type
3.27 perform a trap
Note 1 to entry: Fetching a non-value representation permits an implementation to perform a trap but is not required to (see 6.2.6.1).
Note 2 to entry: Implementations that support Annex L are permitted to invoke a runtime-constraint handler when they perform a trap.
3.28
EXAMPLE is , is .
3.29
EXAMPLE is , is .
3.30 wraparound
wraparound
the process by which a value is reduced modulo , where is the width of the resulting type
3.31 out-of-bounds store
out-of-bounds store
(attempted) access (3.1) that, at run time, for a given computational state, would modify (or, for an object declared volatile, fetch) one or more bytes that lie outside the bounds permitted by this document.
3.32 bounded undefined behavior
Note 1 to entry: The behavior can perform a trap.
Note 2 to entry: Any values produced can be unspecified values, and the representation of objects that are written to can become indeterminate.
3.33 critical undefined behavior
Note 1 to entry: The behavior can perform an out-of-bounds store or perform a trap.
4 Conformance
In this document, "shall" is to be interpreted as a requirement on an implementation or on a program; conversely, "shall not" is to be interpreted as a prohibition.
If a "shall" or "shall not" requirement that appears outside of a constraint or runtime-constraint is violated, the behavior is undefined. Undefined behavior is otherwise indicated in this document by the words "undefined behavior" or by the omission of any explicit definition of behavior. There is no difference in emphasis among these three; they all describe "behavior that is undefined".
A program that is correct in all other aspects, operating on correct data, containing unspecified behavior shall be a correct program and act in accordance with 5.2.2.4.
The implementation shall not successfully translate a preprocessing translation unit containing a #error preprocessing directive unless it is part of a group skipped by conditional inclusion.
A strictly conforming program shall use only those features of the language and library specified in this document. It shall not produce output dependent on any unspecified, undefined, or implementationdefined behavior, and shall not exceed any minimum implementation limit.
EXAMPLE
A strictly conforming program can use conditional features (see 6.10.10.4) provided the use is guarded by an appropriate conditional inclusion preprocessing directive using the related macro. For example:
#ifdef __STDC_IEC_60559_BFP__ /* FE_UPWARD defined */ /* ... */ fesetround(FE_UPWARD); /* ... */ #endif
The two forms of conforming implementation are hosted and freestanding. A conforming hosted implementation shall accept any strictly conforming program. A conforming freestanding implementation shall accept any strictly conforming program in which the use of the features specified in the library clause (Clause 7) is confined to the contents of the standard headers:
<float.h> <iso646.h> <limits.h>
<stdalign.h> <stdarg.h> <stdbit.h>
<stdbool.h> <stdcountof.h> <stddef.h>
<stdint.h> <stdnoreturn.h>
Additionally, a conforming freestanding implementation shall accept any strictly conforming program where:
- the features specified in the header
<string.h>are used, except the following functions:
strcoll, strdup, strerror, strndup, strtok, strxfrm; and/or,
- the selected function
memalignmentfrom<stdlib.h>is used.
A conforming implementation may have extensions (including additional library functions), provided they do not alter the behavior of any strictly conforming program.1)
The strictly conforming programs that shall be accepted by a conforming freestanding implementation that defines __STDC_IEC_60559_BFP__ or __STDC_IEC_60559_DFP__ can also use features in the contents of the standard headers <fenv.h>, <math.h>, and the strto* floating-point numeric conversion functions (7.25.2) of the standard header <stdlib.h>, provided the program does not set the state of the FENV_ACCESS pragma to "on".
An implementation shall be accompanied by a document that defines all implementation-defined and locale-specific characteristics and all extensions.
<float.h> (7.7), alternative spellings <iso646.h> (7.9), characteristics of integer types <limits.h> (7.10), alignment <stdalign.h> (7.15), varying arguments <stdarg.h> (7.16), boolean type and values <stdbool.h> (7.19), common definitions <stddef.h> (7.22), integer types <stdint.h> (7.23), <stdnoreturn.h> (7.27).5 Environment
5.1 Introduction
An implementation translates C source files and executes C programs in two data-processing-system environments, which will be called the translation environment and the execution environment in this document. Their characteristics define and constrain the results of executing conforming C programs constructed according to the syntactic and semantic rules for conforming implementations.
NOTE In this clause, only a few of many possible forward references have been noted.
5.2 Conceptual models
5.2.1 Translation environment
5.2.1.1 Program structure
A C program is not required to be translated in its entirety at the same time. The text of the program is kept in units called source files, (or preprocessing files) in this document. A source file together with all the headers and source files included via the preprocessing directive #include is known as a preprocessing translation unit. After preprocessing, a preprocessing translation unit is called a translation unit. Previously translated translation units can be preserved individually or in libraries. The separate translation units of a program communicate by (for example) calls to functions whose identifiers have external linkage, manipulation of objects whose identifiers have external linkage, or manipulation of data files. Translation units may be separately translated and then later linked to produce an executable program.
5.2.1.2 Translation phases
The precedence among the syntax rules of translation is specified by the following phases.3)
- Physical source file multibyte characters are mapped, in an implementation-defined manner, to the source character set (introducing new-line characters for end-of-line indicators) if necessary.
- Each instance of a backslash character (
\) immediately followed by a new-line character is deleted, splicing physical source lines to form logical source lines. Only the last backslash on any physical source line shall be eligible for being part of such a splice. - The source file is decomposed into preprocessing tokens4) and sequences of white-space characters (including comments). Each comment is replaced by one space character. New-line characters are retained. Whether each nonempty sequence of white-space characters other than new-line is retained or replaced by one space character is implementation-defined.
- Preprocessing directives are executed, macro invocations are expanded, and
_Pragmaunary operator expressions are executed. A#includepreprocessing directive causes the named header or source file to be processed from phase 1 through phase 4, recursively. All preprocessing directives are then deleted. - Each source character set member and escape sequence in character literals and string literals is converted to the corresponding member of the execution character set. Each instance of a source character or escape sequence for which there is no corresponding member is convertedin an implementation-defined manner to some member of the execution character set other than the null (wide) character.5)
- Adjacent string literal tokens are concatenated.
- White-space characters separating tokens are no longer significant. Each preprocessing token is converted into a token. The resulting tokens are syntactically and semantically analyzed and translated as a translation unit.
- All external object and function references are resolved. Library components are linked to satisfy external references to functions and objects not defined in the current translation. All such translator output is collected into a program image which contains information needed for execution in its execution environment.
5.2.1.3 Diagnostics
A conforming implementation shall produce at least one diagnostic message (identified in an implementation-defined manner) if a preprocessing translation unit or translation unit contains a violation of any syntax rule or constraint, even if the behavior is also explicitly specified as undefined or implementation-defined. Diagnostic messages are not required to be produced in other circumstances.
EXAMPLE An implementation is required to issue a diagnostic for the translation unit:
char i; int i;
because in those cases where wording in this document describes the behavior for a construct as being both a constraint error and resulting in undefined behavior, the constraint error is still required to be diagnosed.
Recommended practice
An implementation is encouraged to identify the nature of, and where possible localize, each violation. Of course, an implementation is free to produce any number of diagnostic messages, often referred to as warnings, as long as a valid program is still correctly translated. It can also successfully translate an invalid program. Annex I lists a few of the more common warnings.
5.2.2 Execution environments
5.2.2.1 General
Two execution environments are defined: freestanding and hosted. In both cases, program startup occurs when a designated C function is called by the execution environment. All objects with static storage duration shall be initialized (set to their initial values) before program startup. The manner and timing of such initialization are otherwise unspecified. Program termination returns control to the execution environment.
5.2.2.2 Freestanding environment
In a freestanding environment (in which C program execution can take place without any benefit of an operating system), the name and type of the function called at program startup are implementation-defined. Any library facilities available to a freestanding program, other than the minimal set required by Clause 4, are implementation-defined.
The effect of program termination in a freestanding environment is implementation-defined.
5.2.2.3 Hosted environment
5.2.2.3.1 General
A hosted environment is not required to be provided, but shall conform to the following specifications if present.
5.2.2.3.2 Program startup
The function called at program startup is named main. The implementation declares no prototype for this function. It is defined with a return type of int and with no parameters:
int main(void) { /* ... */ }or with two parameters (referred to here as
argc and argv, though any names can be used, as they are local to the function in which they are declared):int main(int argc, char *argv[]) { /* ... */ }
or using another type that is compatible with one of these two function types, or using some other implementation-defined type.
If they are declared, the parameters to the main function shall obey the following constraints:
- The value of
argcshall be nonnegative. -
argv[argc]shall be a null pointer. - If the value of
argcis greater than zero, the array membersargv[0]throughargv[argc-1]inclusive shall contain pointers to strings, which are given implementation-defined values by the host environment prior to program startup. The intent is to supply to the program information determined prior to program startup from elsewhere in the hosted environment. If the host environment is not capable of supplying strings with letters in both uppercase and lowercase, the implementation shall ensure that the strings are received in lowercase. - If the value of
argcis greater than zero, the string pointed to byargv[0]represents the program name;argv[0][0]shall be the null character if the program name is not available from the host environment. If the value ofargcis greater than one, the strings pointed to byargv[1]throughargv[argc-1]represent the program parameters. - The parameters
argcandargvand the strings pointed to by theargvarray shall be modifiable by the program, and retain their last-stored values between program startup and program termination.
5.2.2.3.3 Program execution
In a hosted environment, a program can use all the functions, macros, type definitions, and objects described in the library clause (Clause 7).
5.2.2.3.4 Program termination
If the return type of the main function is a type compatible with int, a return from the initial call to the main function is equivalent to calling the exit function with the value returned by the main function as its argument;6) reaching the } that terminates the main function returns a value of . If the return type is not compatible with int, the termination status returned to the host environment is unspecified.
5.2.2.4 Program semantics
The semantic descriptions in this document describe the behavior of an abstract machine in which issues of optimization are irrelevant.
An access to an object through the use of an lvalue of volatile-qualified type is a volatile access. A volatile access to an object, modifying an object, modifying a file, or calling a function that does any of those operations are all side effects,7) which are changes in the state of the execution environment.
Evaluation of an expression in general includes both value computations and initiation of side effects. Value computation for an lvalue expression includes determining the identity of the designated object.
Sequenced before is an asymmetric, transitive, pair-wise relation between evaluations executed by a single thread, which induces a partial order among those evaluations. Given any two evaluations A and B, if A is sequenced before B, then the execution of A shall precede the execution of B. (Conversely, if A is sequenced before B, then B is sequenced after A.) If A is not sequenced before or after B, then A and B are unsequenced. Evaluations A and B are indeterminately sequenced when A is sequenced either before or after B, but it is unspecified which.8) The presence of a sequence point between the evaluation of expressions A and B implies that every value computation and side effect associated with A is sequenced before every value computation and side effect associated with B. (A summary of the sequence points is given in Annex C.)
In the abstract machine, all expressions are evaluated as specified by the semantics. An actual implementation is not required to evaluate part of an expression if it can deduce that its value is not used and that no needed side effects are produced (including any caused by calling a function or through volatile access to an object).
When the processing of the abstract machine is interrupted by receipt of a signal, the values of objects that are neither lock-free atomic objects nor of type volatile sig_atomic_t are unspecified, as is the state of the dynamic floating-point environment. The representation of any object modified by the handler that is neither a lock-free atomic object nor of type volatile sig_atomic_t becomes indeterminate when the handler exits, as does the state of the dynamic floating-point environment if it is modified by the handler and not restored to its original state.
The least requirements on a conforming implementation are:
- Volatile accesses to objects are evaluated strictly according to the rules of the abstract machine.
- At program termination, all data written into files shall be identical to the result that execution of the program according to the abstract semantics would have produced.
- The input and output dynamics of interactive devices shall take place as specified in 7.24.3. The intent of these requirements is that unbuffered or line-buffered output appear as soon as possible, to ensure that prompting messages appear prior to a program waiting for input.
This is the observable behavior of the program.
What constitutes an interactive device is implementation-defined.
More stringent correspondences between abstract and actual semantics may be defined by each implementation.
EXAMPLE 1 An implementation can define a one-to-one correspondence between abstract and actual semantics: at every sequence point, the values of the actual objects would agree with those specified by the abstract semantics. The keyword volatile would then be redundant.
Alternatively, an implementation can perform various optimizations within each translation unit, such that the actual semantics would agree with the abstract semantics only when making function calls across translation unit boundaries. In such an implementation, at the time of each function entry and function return where the calling function and the called function are in different translation units, the values of all externally linked objects and of all objects accessible via pointers therein would agree with the abstract semantics. Furthermore, at the time of each such function entry the values of the parameters of the called function and of all objects accessible via pointers therein would agree with the abstract semantics. In this type of implementation, objects referred to by interrupt service routines activated by the signal function would require explicit specification of volatile storage, as well as other implementation-defined restrictions.
EXAMPLE 2 In executing the fragment
char c1, c2; /* ... */ c1 = c1 + c2;
the "integer promotions" require that the abstract machine promote the value of each variable to int size and then add the two ints and truncate the sum. Provided the addition of two chars can be done without integer overflow, or with integer overflow wrapping silently to produce the correct result, the actual execution need only produce the same result, possibly omitting the promotions.
EXAMPLE 3 Similarly, in the fragment
float f1, f2; double d; /* ... */ f1 = f2 * d;
the multiplication can be executed using float arithmetic if the implementation can ascertain that the result would be the same as if it were executed using double arithmetic (for example, if d were replaced by the literal 2.0, which has type double).
EXAMPLE 4 Implementations employing wide registers are expected to take care to honor appropriate semantics. Values are independent of whether they are represented in a register or in memory. For example, an implicit spilling of a register cannot alter the value. Also, an explicit store and load rounds to the precision of the storage type. In particular, casts and assignments perform their specified conversion. For the fragment
double d1, d2; float f; d1 = f = /* expression */; d2 = (float) /* expression */;
the values assigned to d1 and d2 are required to have been converted to float.
EXAMPLE 5 Rearrangement for floating-point expressions is often restricted because of limitations in precision as well as range. The implementation cannot generally apply the mathematical associative rules for addition or multiplication, nor the distributive rule, because of roundoff error, even in the absence of overflow and underflow. Likewise, implementations cannot generally replace decimal literals to rearrange expressions. In the following fragment, rearrangements suggested by mathematical rules for real numbers are often not valid (see F.9).
double x, y, z; /* ... */ x = (x * y) * z; // not equivalent to x *= y * z; z = (x - y) + y; // not equivalent to z = x; z = x + x * y; // not equivalent to z = x * (1.0 + y); y = x / 5.0; // not equivalent to y = x * 0.2;
EXAMPLE 6 To illustrate the grouping behavior of expressions, in the following fragment
int a, b; /* ... */ a = a + 32760 + b + 5; a = (((a + 32760) + b) + 5); a = ((a + b) + 32765); a = ((a + 32765) + b); a = (a + (b + 32765));
EXAMPLE 7 The grouping of an expression does not completely determine its evaluation. In the following fragment:
#include <stdio.h> int sum; char *p; /* ... */ sum = sum * 10 - ’0’ + (*p++ = getchar());the expression statement is grouped as if it were written as
sum = (((sum * 10) - ’0’) + ((*(p++)) = (getchar())));
but the actual increment of p can occur at any time between the previous sequence point and the next sequence point (the ;), and the call to getchar can occur at any point prior to the need of its returned value.
Forward references: expressions (6.5.1), type qualifiers (6.7.4), statements (6.8), floating-point environment <fenv.h> (7.6), the signal function (7.14), files (7.24.3).
5.2.2.5 Multi-threaded executions and data races
Under a hosted implementation that does not define __STDC_NO_THREADS__, a program can have more than one thread of execution (or thread) running concurrently. The execution of each thread proceeds as defined by the remainder of this document. The execution of the entire program consists of an execution of all its threads.9) Under a freestanding implementation, it is implementationdefined whether a program can have more than one thread of execution.
The value of an object visible to a thread at a particular point is the initial value of the object, a value stored in the object by , or a value stored in the object by another thread, according to the rules in the rest of this subclause.
NOTE 1 In some cases, there can instead be undefined behavior. Much of this subclause is motivated by the desire to support atomic operations with explicit and detailed visibility constraints. However, it also implicitly supports a simpler view for more restricted programs.
Two expression evaluations conflict if one of them modifies a memory location and the other one reads or modifies the same memory location.
The library defines atomic operations (7.17) and operations on mutexes (7.30.4) that are specially identified as synchronization operations. These operations play a special role in making assignments in one thread visible to another. A synchronization operation on one or more memory locations is one of an acquire operation, a release operation, both an acquire and release operation, or a consume operation. A synchronization operation without an associated memory location is a fence and can be either an acquire fence, a release fence, or both an acquire and release fence. In addition, there are relaxed atomic operations, which are not synchronization operations, and atomic read-modify-write operations, which have special characteristics.
NOTE 2 For example, a call that acquires a mutex will perform an acquire operation on the locations composing the mutex. Correspondingly, a call that releases the same mutex will perform a release operation on those same locations. Informally, performing a release operation on A forces prior side effects on other memory locations to become visible to other threads that later perform an acquire or consume operation on A. Relaxed atomic operations are not included as synchronization operations although, like synchronization operations, they cannot contribute to data races.
All modifications to a particular atomic object occur in some particular total order, called the modification order of . If and are modifications of an atomic object , and happens before , then shall precede in the modification order of , which is defined later in this subclause.
NOTE 3 This states that the modification orders are expected to respect the "happens before" relation.
NOTE 4 There is a separate order for each atomic object. There is no requirement that these can be combined into a single total order for all objects. In general this will be impossible because different threads can observe modifications to different variables in inconsistent orders.
A release sequence headed by a release operation on an atomic object is a maximal contiguous sub-sequence of side effects in the modification order of , where the first operation is and every subsequent operation either is performed by the same thread that performed the release or is an atomic read-modify-write operation.
Certain library calls synchronize with other library calls performed by another thread. In particular, an atomic operation that performs a release operation on an object synchronizes with an atomic operation that performs an acquire operation on and reads a value written by any side effect in the release sequence headed by .
NOTE 5 Except in the specified cases, reading a later value does not necessarily ensure visibility as described later in this subclause. Such a requirement would sometimes interfere with efficient implementation.
NOTE 6 The specifications of the synchronization operations define when one reads the value written by another. For atomic variables, the definition is clear. All operations on a given mutex occur in a single total order. Each mutex acquisition "reads the value written" by the last mutex release.
An evaluation carries a dependency10) to an evaluation if:
- the value of is used as an operand of , unless:
- is an invocation of the
kill_dependencymacro, - is the left operand of a
&&or||operator, - is the left operand of a
?:operator, or - is the left operand of a
,operator;
- is an invocation of the
or
- writes a scalar object or bit-field , reads from the value written by , and is sequenced before , or
- for some evaluation , carries a dependency to and carries a dependency to .
An evaluation inter-thread happens before an evaluation if synchronizes with , is dependency-ordered before , or, for some evaluation :
- synchronizes with and is sequenced before ,
- is sequenced before and inter-thread happens before , or
- inter-thread happens before and inter-thread happens before .
NOTE 7 The "inter-thread happens before" relation describes arbitrary concatenations of "sequenced before", "synchronizes with", and "dependency-ordered before" relationships, with two exceptions. The first exception is that a concatenation is not permitted to end with "dependency-ordered before" followed by "sequenced before". The reason for this limitation is that a consume operation participating in a "dependency-ordered before" relationship provides ordering only with respect to operations to which this consume operation carries a dependency. The reason that this limitation applies only to the end of such a concatenation is that any subsequent release operation will provide the required ordering for a prior consume operation. The second exception is that a concatenation is not permitted to consist entirely of "sequenced before". The reasons for this limitation are (1) to permit "inter-thread happens before" to be transitively closed and (2) the "happens before" relation, defined subsequently in this subclause, provides for relationships consisting entirely of "sequenced before".
An evaluation happens before an evaluation if is sequenced before or inter-thread happens before . The implementation shall ensure that no program execution demonstrates a cycle in the "happens before" relation.
NOTE 8 This cycle would otherwise be possible only through the use of consume operations.
A visible side effect on an object with respect to a value computation of satisfies the conditions:
- happens before , and
- there is no other side effect to such that happens before and happens before .
The value of a non-atomic scalar object , as determined by evaluation , shall be the value stored by the visible side effect .
NOTE 9 If there is ambiguity about which side effect to a non-atomic object is visible, then there is a data race and the behavior is undefined.
NOTE 10 This states that operations on ordinary variables are not visibly reordered. This is not detectable without data races, but ensures that data races, as defined here, and with suitable restrictions on the use of atomics, correspond to data races in a simple interleaved (sequentially consistent) execution.
The value of an atomic object , as determined by evaluation , shall be the value stored by some side effect that modifies , where does not happen before .
NOTE 11 The set of side effects from which a given evaluation can take its value is also restricted by the rest of the rules described here, and in particular, by the coherence requirements subsequently in this subclause.
If an operation that modifies an atomic object happens before an operation that modifies , then shall be earlier than in the modification order of .
NOTE 12 Such a requirement is known as "write-write coherence".
If a value computation of an atomic object happens before a value computation of , and takes its value from a side effect on , then the value computed by shall either be the value stored by or the value stored by a side effect on , where follows in the modification order of .
NOTE 13 Such a requirement is known as "read-read coherence".
If a value computation of an atomic object happens before an operation on , then shall take its value from a side effect on , where precedes in the modification order of .
NOTE 14 Such a requirement is known as "read-write coherence".
If a side effect on an atomic object happens before a value computation of , then the evaluation shall take its value from or from a side effect that follows in the modification order of .
NOTE 15 Such a requirement is known as "write-read coherence".
NOTE 16 This effectively disallows compiler reordering of atomic operations to a single object, even if both operations are "relaxed" loads. By doing so, it effectively makes the "cache coherence" guarantee provided by most hardware available to C atomic operations.
NOTE 17 The value observed by a load of an atomic object depends on the "happens before" relation, which in turn depends on the values observed by loads of atomic objects. The intended reading is that there exists an association of atomic loads with modifications they observe that, together with suitably chosen modification orders and the "happens before" relation derived as described previously, satisfy the resulting constraints as imposed here.
The execution of a program contains a data race if it contains two conflicting actions in different threads, at least one of which is not atomic, and neither happens before the other. Any such data race results in undefined behavior.
NOTE 18 It can be shown that programs that correctly use simple mutexes and memory_order_seq_cst operations to prevent all data races, and use no other synchronization operations, behave as though the operations executed by their constituent threads were simply interleaved, with each value computation of an object being the last value stored in that interleaving. This is normally referred to as "sequential consistency". However, this applies only to data-race-free programs, and data-race-free programs cannot observe most program transformations that do not change single-threaded program semantics. In fact, most single-threaded program transformations continue to be allowed, because any program that behaves differently as a result of such transformations necessarily has undefined behavior even before such a transformation is applied.
NOTE 19 Compiler transformations that introduce assignments to a potentially shared memory location that would not be modified by the abstract machine are generally precluded by this document, because such an assignment can overwrite another assignment by a different thread in cases in which an abstract machine execution would not have encountered a data race. This includes implementations of data member assignment that overwrite adjacent members in separate memory locations. Reordering of atomic loads in cases in which the atomics in question can alias is also generally precluded as this can violate the coherence requirements.
NOTE 20 Transformations that introduce a speculative read of a potentially shared memory location possibly will not preserve the semantics of the program as defined in this document as they potentially introduce a data race. However, they are typically valid in the context of an optimizing compiler that targets a specific machine with well-defined semantics for data races. They would be invalid for a hypothetical machine that is not tolerant of races or provides hardware race detection.
5.3 Environmental considerations
5.3.1 Character sets
Two sets of characters and their associated collating sequences shall be defined: the set in which source files are written (the source character set), and the set interpreted in the execution environment (the execution character set). Each set is further divided into a basic character set, whose contents are given by this subclause, and a set of zero or more locale-specific members (which are not members of the basic character set) called extended characters. The combined set is also called the extended character set. The values of the members of the execution character set are implementation-defined.
In a character literal or string literal, members of the execution character set shall be represented by corresponding members of the source character set or by escape sequences consisting of the backslash \ followed by one or more characters. A byte with all bits set to , called the null character, shall exist in the basic execution character set; it is used to terminate a character string.
Both the basic source and basic execution character sets shall have the following members: the 26 uppercase letters of the Latin alphabet
The value of each character after a, up to and including f, in the prior specified list of lowercase letters, shall be one greater than the value of the previous.
The value of each character after A, up to and including F, in the prior specified list of uppercase letters, shall be one greater than the value of the previous.
A letter is an uppercase letter or a lowercase letter as defined previously in this subclause; in this document the term does not include other characters that are letters in other alphabets.
The universal character name construct provides a way to name other characters.
5.3.2 Multibyte characters
The source character set can contain multibyte characters, used to represent members of the extended character set. The execution character set can also contain multibyte characters, which are not required to have the same encoding as for the source character set. For both character sets, the following shall hold:
- The basic character set shall be present and each character shall be encoded as a single byte.
- The presence, meaning, and representation of any additional members is locale-specific.
- A multibyte character set can have a state-dependent encoding, wherein each sequence of multibyte characters begins in an initial shift state and enters other locale-specific shift states when specific multibyte characters are encountered in the sequence. While in the initial shift state, all single-byte characters retain their usual interpretation and do not alter the shift state. The interpretation for subsequent bytes in the sequence is a function of the current shift state.
- A byte with all bits zero shall be interpreted as a null character independent of shift state. Such a byte shall not occur as part of any other multibyte character.
For source files, the following shall hold:
- An identifier, comment, string literal, character literal, or header name shall begin and end in the initial shift state.
- An identifier, comment, string literal, character literal, or header name shall consist of a sequence of valid multibyte characters.
5.3.3 Character display semantics
The active position is that location on a display device where the next character output by the fputc function would appear. The intent of writing a printing character (as defined by the isprint function) to a display device is to display a graphic representation of that character at the active position and then advance the active position to the next position on the current line. The direction of writing is locale-specific. If the active position is at the final position of a line (if there is one), the behavior of the display device is unspecified.
Alphabetic escape sequences representing non-graphic characters in the execution character set are intended to produce actions on display devices as follows:
\a (alert) Produces an audible or visible alert without changing the active position.
\b (backspace) Moves the active position to the previous position on the current line. If the active position is at the initial position of a line, the behavior of the display device is unspecified.
\f (form feed) Moves the active position to the initial position at the start of the next logical page.
\n (new line) Moves the active position to the initial position of the next line.
\r (carriage return) Moves the active position to the initial position of the current line.
\t (horizontal tab) Moves the active position to the next horizontal tabulation position on the current line. If the active position is at or past the last defined horizontal tabulation position, the behavior of the display device is unspecified.
\v (vertical tab) Moves the active position to the initial position of the next vertical tabulation position. If the active position is at or past the last defined vertical tabulation position, the behavior of the display device is unspecified.
Each of these escape sequences shall produce a unique implementation-defined value which can be stored in a single char object. The external representations in a text file are not necessarily identical to the internal representations, and are outside the scope of this document.
5.3.4 Signals and interrupts
Functions shall be implemented such that they can be interrupted at any time by a signal, or can be called by a signal handler, or both, with no alteration to earlier, but still active, invocations’ control flow (after the interruption), function return values, or objects with automatic storage duration. All such objects shall be maintained outside the function image (the instructions that compose the executable representation of a function) on a per-invocation basis.
5.3.5 Environmental limits
5.3.5.1 General
Both the translation and execution environments constrain the implementation of language translators and libraries. The following summarizes the language-related environmental limits on a conforming implementation; the library-related limits are discussed in Clause 7.
5.3.5.2 Translation limits
The implementation shall be able to translate and execute a program that uses but does not exceed the following limitations for these constructs and entities:12)
5.3.5.3 Numerical limits
5.3.5.3.1 General
An implementation is required to document all the limits specified in this subclause, which are specified in the headers <limits.h> and <float.h>. Additional limits are specified in <stdint.h>.
<stdint.h> (7.23).5.3.5.3.2 Characteristics of integer types <limits.h> and <stdint.h>
Many integer types that are defined in this document have a corresponding width macro with a name ending in _WIDTH.14) The values of these macros provide the number of bits in the value representation of the type (6.2.6.2). The values given subsequently are replaced by constant expressions suitable for use in conditional expression inclusion preprocessing directives. Those of the values that are implementation-defined are equal or greater to those shown; otherwise the values are exact.
- width for an object of type
bool15)
BOOL_WIDTH 1- number of bits for smallest object that is not a bit-field (byte)
CHAR_BIT 8The macros CHAR_WIDTH, SCHAR_WIDTH, and UCHAR_WIDTH that represent the width of the types char, signed char and unsigned char shall expand to the same value as CHAR_BIT.
- width for an object of type
unsigned short int
USHRT_WIDTH 16The macro SHRT_WIDTH represents the width of the type short int and shall expand to the same value as USHRT_WIDTH.
- width for an object of type
unsigned int
UINT_WIDTH 16The macro INT_WIDTH represents the width of the type int and shall expand to the same value as UINT_WIDTH.
- width for an object of type
unsigned long int
ULONG_WIDTH 32The macro LONG_WIDTH represents the width of the type long int and shall expand to the same value as ULONG_WIDTH.
- width for an object of type
unsigned long long int
ULLONG_WIDTH 64The macro LLONG_WIDTH represents the width of the type long long int and shall expand to the same value as ULLONG_WIDTH.
- maximum width of a bit-precise integer type
BITINT_MAXWIDTH /* see the following */
The macro BITINT_MAXWIDTH represents the maximum width N supported by the declaration of a bit-precise integer (6.2.5) in the type specifier _BitInt(N). The value BITINT_MAXWIDTH shall expand to a value that is greater than or equal to the value of ULLONG_WIDTH.
MB_LEN_MAX 1For all unsigned integer types for which <limits.h> or <stdint.h> define a macro with suffix _WIDTH holding its width N, there is a macro with suffix _MAX holding the maximal value that is representable by the type and that has the same type as would an expression that is an object of the corresponding type converted according to the integer promotions. If the value is in the range of the type uintmax_t (7.23.2.6) the macro is suitable for use in conditional expression inclusion preprocessing directives.
For all signed integer types for which <limits.h> or <stdint.h> define a macro with suffix _WIDTH holding its width , there are macros with suffix _MIN and _MAX holding the minimal and maximal values and that are representable by the type and that have the same type as would an expression that is an object of the corresponding type converted according to the integer promotions. If the values are in the range of the type intmax_t (7.23.2.6) the macros are suitable for use in conditional expression inclusion preprocessing directives.
If an object of type char can hold negative values, the value of CHAR_MIN shall be the same as that of SCHAR_MIN and the value of CHAR_MAX shall be the same as that of SCHAR_MAX. Otherwise, the value of CHAR_MIN shall be 0 and the value of CHAR_MAX shall be the same as that of UCHAR_MAX (see 6.2.5.).
<stdint.h> (7.23).5.3.5.3.3 Characteristics of floating types <float.h>
The characteristics of floating types are defined in terms of a model that describes a representation of floating-point numbers and allows other values. The characteristics provide information about an implementation’s floating-point arithmetic.16) An implementation that defines __STDC_IEC_60559_BFP__ or __STDC_IEC_559__ shall implement floating types and arithmetic conforming to ISO/IEC 60559 as specified in Annex F of this document. An implementation that defines __STDC_IEC_60559_COMPLEX__ shall implement complex types and arithmetic conforming to ISO/IEC 60559 as specified in Annex G of this document.
The following parameters are used to define the model for each floating type:
sign () base or radix of exponent representation (an integer ) exponent (an integer between a minimum and a maximum ) precision (the number of base- digits in the significand) nonnegative integers less than (the significand digits)
For each floating type, the parameters , , , and are fixed constants.
Model floating-point numbers with are called normalized floating-point numbers.
Model floating-point numbers with and are called subnormal floating-point numbers.
Model floating-point numbers with and are called unnormalized floating-point numbers.
Model floating-point numbers with all are zeros.
Floating types shall be able to represent signed zeros or an unsigned zero and all normalized floatingpoint numbers. In addition, floating types may be able to contain other kinds of floating-point
NOTE 1 Some implementations have types that include finite numbers with range and/or precision that are not covered by the model.
A NaN is a value signifying Not-a-Number. A quiet NaN propagates through almost every arithmetic operation without raising a floating-point exception; a signaling NaN generally raises a floating-point exception when occurring as an arithmetic operand.
NOTE 2 ISO/IEC 60559 specifies quiet and signaling NaNs. For implementations that do not support ISO/IEC 60559, the terms quiet NaN and signaling NaN are intended to apply to values with similar behavior.
Wherever values are unsigned, any requirement in this document to get the sign shall produce an unspecified sign, and any requirement to set the sign shall be ignored, unless otherwise specified.
NOTE 3 Bit representations of floating-point values can include a sign bit, even if the values can be regarded as unsigned; ISO/IEC 60559 NaNs are such values.
Whether and in what cases subnormal numbers are treated as zeros is implementation-defined. Subnormal numbers that in some cases are treated by arithmetic operations as zeros are properly classified as subnormal. However, object representations that could represent subnormal numbers but that are always treated by arithmetic operations as zeros are non-canonical zeros, and the values are properly classified as zero, not subnormal. ISO/IEC 60559 arithmetic (with default exception handling) always treats subnormal numbers as nonzero.
A value is negative if and only if it compares less than . Thus, negative zeros and NaNs are not negative values.
An implementation can prefer particular representations of values that have multiple representations in a floating type, 6.2.6.1 notwithstanding. The preferred representations of a floating type, including unique representations of values in the type, are called canonical. A floating type can also contain non-canonical representations, for example, redundant representations of some or all its values, or representations that are extraneous to the floating-point model. Typically, floating-point operations deliver results with canonical representations. ISO/IEC 60559 operations deliver results with canonical representations, unless specified otherwise.
NOTE 4 The library operations iscanonical and canonicalize distinguish canonical (preferred) representations, but this distinction alone does not imply that canonical and non-canonical representations are of different values.
NOTE 5 Some of the values in the ISO/IEC 60559 decimal formats have non-canonical representations (as well as a canonical representation).
The minimum range of representable values for a floating type is the most negative finite floatingpoint number representable in that type through the most positive finite floating-point number representable in that type. In addition, if negative infinity is representable in a type, the range of that type is extended to all negative real numbers; likewise, if positive infinity is representable in a type, the range of that type is extended to all positive real numbers.
The accuracy of the floating-point operations (+, -, *, /) and of most of the library functions in <math.h> and <complex.h> that return floating-point results is implementation-defined, as is the accuracy of the conversion between floating-point internal representations and string representations performed by the library functions in <stdio.h>, <stdlib.h>, and <wchar.h>. The implementation may state that the accuracy is unknown. Decimal floating-point operations have stricter requirements.
All integer values in the <float.h> header, except FLT_ROUNDS, shall be constant expressions suitable for use in conditional expression inclusion preprocessing directives; all floating values shall be arithmetic constant expressions. All except CR_DECIMAL_DIG (F.5), DECIMAL_DIG, DEC_EVAL_METHOD, FLT_EVAL_METHOD, FLT_RADIX, and FLT_ROUNDS have separate names for all floating types. The floating-point model representation is provided for all values except DEC_EVAL_METHOD, FLT_EVAL_METHOD and FLT_ROUNDS.
The remainder of this subclause specifies characteristics of standard floating types.
The rounding mode for floating-point addition for standard floating types is characterized by the implementation-defined value of FLT_ROUNDS. Evaluation of FLT_ROUNDS correctly reflects any execution-time change of rounding mode through the function fesetround in <fenv.h>.
indeterminable
toward zero
to nearest, ties to even
toward positive infinity
toward negative infinity
to nearest, ties away from zero
All other values for FLT_ROUNDS characterize implementation-defined rounding behavior.
Whether a type has the same base (), precision (), and exponent range ( ) as an ISO/IEC 60559 format is characterized by the implementation-defined values of FLT_IS_IEC_60559, DBL_IS_IEC_60559 and LDBL_IS_IEC_60559 (this does not imply conformance to Annex F):
type does not have the precision and exponent range of an ISO/IEC 60559 format
type has the precision and exponent range of an ISO/IEC 60559 format
NOTE 6 Outside of the normalized floating-point numbers, the representability of values (e.g. negative zero) of the ISO/IEC 60559 format is not implied.
The values of floating type yielded by operators subject to the usual arithmetic conversions, including the values yielded by the implicit conversion of operands, and the values of floating literals are evaluated to a format whose range and precision can be greater than required by the type. Such a format is called an evaluation format. In all cases, assignment and cast operators yield values in the format of the type. The extent to which evaluation formats are used is characterized by the value of FLT_EVAL_METHOD:17)
indeterminable;
evaluate all operations and literals just to the range and precision of the type;
evaluate operations and literals of type float and double to the range and precision of the double type, evaluate long double operations and literals to the range and precision of the long double type;
evaluate all operations and literals to the range and precision of the long double type.
All other negative values for FLT_EVAL_METHOD characterize implementation-defined behavior. The value of FLT_EVAL_METHOD does not characterize values returned by function calls (see 6.8.7.5, F.6).
The presence or absence of subnormal numbers is characterized by the implementation-defined values of FLT_HAS_SUBNORM, DBL_HAS_SUBNORM and LDBL_HAS_SUBNORM:
indeterminable
absent (type does not support subnormal numbers)
present (type does support subnormal numbers)
Each of the signaling NaN macros
FLT_SNAN DBL_SNAN LDBL_SNAN
is defined if and only if the respective type contains signaling NaNs. They expand to a constant expression of the respective type representing a signaling NaN. If a signaling NaN macro, optionally preceded by the unary + or - operator, is used as an initializer that is evaluated at translation time to initialize an object of the same type, the object is initialized with a signaling NaN value.
The macro
INFINITYis defined if and only if the implementation supports an infinity for the type float. It expands to a constant expression of type float representing positive or unsigned infinity.
The macro
NANis defined if and only if the implementation supports quiet NaNs for the float type. It expands to a constant expression of type float representing a quiet NaN.
The values given in the following list shall be replaced by constant expressions with implementationdefined values that are greater or equal in magnitude (absolute value) to those shown, with the same sign:
- radix of exponent representation,
FLT_RADIX 2- number of base-
FLT_RADIXdigits in the floating-point significand,
FLT_MANT_DIG DBL_MANT_DIG LDBL_MANT_DIG
- number of decimal digits, , such that any floating-point number with radix digits can be rounded to a floating-point number with decimal digits and back again, using to-nearest rounding for both roundings, without change to the value, � if is a power of otherwise
FLT_DECIMAL_DIG 6 DBL_DECIMAL_DIG 10 LDBL_DECIMAL_DIG 10
- number of decimal digits, , such that any floating-point number in the widest of the supported floating types and the supported ISO/IEC 60559 encodings with radix digits can be rounded to a floating-point number with decimal digits and back again, using to-nearest rounding for both roundings, without change to the value, � if is a power of otherwise
DECIMAL_DIG 10 FLT_DIG 6 DBL_DIG 10 LDBL_DIG 10 FLT_MIN_EXP DBL_MIN_EXP LDBL_MIN_EXP FLT_MIN_10_EXP -37 DBL_MIN_10_EXP -37 LDBL_MIN_10_EXP -37 FLT_MAX_EXP DBL_MAX_EXP LDBL_MAX_EXP FLT_MAX_10_EXP +37 DBL_MAX_10_EXP +37 LDBL_MAX_10_EXP +37
The values given in the following list shall be replaced by constant expressions with implementationdefined values that are greater than or equal to those shown:
- maximum representable finite floating-point number; if that number is normalized, its value is
FLT_MAX 1E+37 DBL_MAX 1E+37 LDBL_MAX 1E+37 FLT_NORM_MAX 1E+37 DBL_NORM_MAX 1E+37 LDBL_NORM_MAX 1E+37
The values given in the following list shall be replaced by constant expressions with implementationdefined (positive) values that are less than or equal to those shown:
- the difference between and the least normalized value greater than that is representable in the given floating type,
FLT_EPSILON 1E-5 DBL_EPSILON 1E-9 LDBL_EPSILON 1E-9
- minimum normalized positive floating-point number,
FLT_MIN 1E-37 DBL_MIN 1E-37 LDBL_MIN 1E-37
- minimum positive floating-point number
FLT_TRUE_MIN 1E-37 DBL_TRUE_MIN 1E-37 LDBL_TRUE_MIN 1E-37
Recommended practice
Conversion between real floating type and decimal character sequence with at most T_DECIMAL_DIG digits should be correctly rounded, where T is the macro prefix for the type. This assures conversion from real floating type to decimal character sequence with T_DECIMAL_DIG digits and back, using to-nearest rounding, is the identity function.
EXAMPLE 1 The following describes an artificial floating-point representation that meets the minimum requirements of this document, and the appropriate values in a <float.h> header for type float:
,
FLT_RADIX 16 FLT_MANT_DIG 6 FLT_EPSILON 9.53674316E-07F FLT_DECIMAL_DIG 9 FLT_DIG 6 FLT_MIN_EXP -31 FLT_MIN 2.93873588E-39F FLT_MIN_10_EXP -38 FLT_MAX_EXP +32 FLT_MAX 3.40282347E+38F FLT_MAX_10_EXP +38
EXAMPLE 2 The following describes floating-point representations that also meet the requirements for binary32 and binary64 numbers in ISO/IEC 60559,18) and the appropriate values in a <float.h> header for types float and double. The decimal floating literals can possibly not give correct values (and hence are not appropriate values in a <float.h> header) if FLT_EVAL_METHOD is not 0 or if a translation-time rounding mode other
FLT_IS_IEC_60559 1 FLT_RADIX 2 FLT_MANT_DIG 24 FLT_EPSILON 1.19209290E-07F // decimal floating literal FLT_EPSILON 0X1P-23F // hex floating literal FLT_DECIMAL_DIG 9 FLT_DIG 6 FLT_MIN_EXP -125 FLT_MIN 1.17549435E-38F // decimal floating literal FLT_MIN 0X1P-126F // hex floating literal FLT_TRUE_MIN 1.40129846E-45F // decimal floating literal FLT_TRUE_MIN 0X1P-149F // hex floating literal FLT_HAS_SUBNORM 1 FLT_MIN_10_EXP -37 FLT_MAX_EXP +128 FLT_MAX 3.40282347E+38F // decimal floating literal FLT_MAX 0X1.fffffeP127F // hex floating literal FLT_MAX_10_EXP +38 DBL_MANT_DIG 53 DBL_IS_IEC_60559 1 DBL_EPSILON 2.2204460492503131E-16 // decimal floating literal DBL_EPSILON 0X1P-52 // hex floating literal DBL_DECIMAL_DIG 17 DBL_DIG 15 DBL_MIN_EXP -1021 DBL_MIN 2.2250738585072014E-308 // decimal floating literal DBL_MIN 0X1P-1022 // hex floating literal DBL_TRUE_MIN 4.9406564584124654E-324 // decimal floating literal DBL_TRUE_MIN 0X1P-1074 // hex floating literal DBL_HAS_SUBNORM 1 DBL_MIN_10_EXP -307 DBL_MAX_EXP +1024 DBL_MAX 1.7976931348623157E+308 // decimal floating literal DBL_MAX 0X1.fffffffffffffP1023 // hex floating literal DBL_MAX_10_EXP +308
<complex.h> (7.3), extended multibyte and wide character utilities <wchar.h> (7.33), floating-point environment <fenv.h> (7.6), general utilities <stdlib.h> (7.25), input/output <stdio.h> (7.24), mathematics <math.h> (7.12), ISO/IEC 60559 floating-point arithmetic (Annex F), ISO/IEC 60559-compatible complex arithmetic (Annex G).5.3.5.3.4 Characteristics of decimal floating types in <float.h>
This subclause specifies macros in <float.h> that provide characteristics of decimal floating types (an optional feature) in terms of the model presented in 5.3.5.3.3. An implementation shall provide these macros if and only if it defines __STDC_IEC_60559_DFP__. The prefixes DEC32_, DEC64_, and DEC128_ denote the types _Decimal32, _Decimal64, and _Decimal128 respectively.
DEC_EVAL_METHOD is the decimal floating-point analog of FLT_EVAL_METHOD (5.3.5.3.3). Its implementation-defined value characterizes the use of evaluation formats for decimal floating types:
Each of the decimal signaling NaN macros
DEC32_SNAN DEC64_SNAN DEC128_SNAN
expands to a constant expression of the respective decimal floating type representing a signaling NaN. If an optional unary + or - operator followed by a signaling NaN macro is used for initializing an object of the same type that has static or thread storage duration, the object is initialized with a signaling NaN value.
The macro
DEC_INFINITYexpands to a constant expression of type _Decimal32 representing positive infinity.
The integer values given in the following lists shall be replaced by constant expressions suitable for use in conditional expression inclusion preprocessing directives:
- radix of exponent representation, (=10). For the standard floating types, this value is implementation-defined and is specified by the macro
FLT_RADIX. For the decimal floating types there is no corresponding macro, because the value is an inherent property of the types. WhereverFLT_RADIXappears in a description of a function that has versions that operate on decimal floating types, it is noted that for the decimal floating-point versions the value used is implicitly , rather thanFLT_RADIX. - number of digits in the coefficient
DEC32_MANT_DIG 7 DEC64_MANT_DIG 16 DEC128_MANT_DIG 34
- minimum exponent
DEC32_MIN_EXP -94 DEC64_MIN_EXP -382 DEC128_MIN_EXP -6142
- maximum exponent
DEC32_MAX_EXP 97 DEC64_MAX_EXP 385 DEC128_MAX_EXP 6145 DEC32_MAX 9.999999E96DF DEC64_MAX 9.999999999999999E384DD DEC128_MAX 9.999999999999999999999999999999999E6144DL DEC32_EPSILON 1E-6DF DEC64_EPSILON 1E-15DD DEC128_EPSILON 1E-33DL DEC32_MIN 1E-95DF DEC64_MIN 1E-383DD DEC128_MIN 1E-6143DL DEC32_TRUE_MIN 0.000001E-95DF DEC64_TRUE_MIN 0.000000000000001E-383DD DEC128_TRUE_MIN 0.000000000000000000000000000000001E-6143DL
For decimal floating-point arithmetic, it is often convenient to consider an alternate equivalent model where the significand is represented with integer rather than fraction digits. With , , , , and as defined in 5.3.5.3.3, a floating-point number is defined by the model:
�
With fixed to , a decimal floating-point number is thus:
�
The quantum exponent is and the coefficient is , which is an integer between and , inclusive. Thus, is represented by the triple of integers (s, c, q). The quantum of is , which is the value of a unit in the last place of the coefficient. Table 5.1 shows the range of quantum exponents.
Table 5.1 — Quantum exponent ranges
Type _Decimal32 _Decimal64 _Decimal128 Maximum Quantum Exponent ( ) Minimum Quantum Exponent ( )
Table 5.2 shows, for each operation delivering a result in decimal floating-point format, how the preferred quantum exponents of the operands, x), y), etc., determine the preferred quantum exponent of the operation result, provided the table formula is defined for the arguments. For the cases where the formula is undefined and the function result is , the preferred quantum exponent is immaterial because the quantum exponent of is defined to be infinity. For the other cases where the formula is undefined and the function result is finite, the preferred quantum exponent is unspecified.
NOTE Although unspecified in ISO/IEC 60559, a preferred quantum exponent of 0 for the cases where the formula is undefined and the function result is finite would be a reasonable implementation choice.
Table 5.2 — Preferred quantum exponents
Operation Preferred quantum exponent of result roundeven, round, trunc, ceil, floor, rint, nearbyint
x
nextup, nextdown, nextafter, nexttoward least possible fmin, fmax, fminimum, fmaximum, fminimum_mag, fmaximum_mag, fminimum_num, fmaximum_num, fminimum_mag_num, fmaximum_mag_num
x) if x gives the result, y) if y gives the result
scalbn, scalbln x) + n ldexp x) + p logb postfix ++ operator, postfix -- operator, prefix ++ operator, prefix -- operator
x
+, d32add, d64add xy)) -, d32sub, d64sub xy))
*, d32mul, d64mul xy) /, d32div, d64div xy) sqrt, d32sqrt, d64sqrt x fma, d32fma, d64fma xyz)) conversion from integer type exact conversion from non-decimal floating type
inexact conversion from non-decimal floating type
least possible
conversion between decimal floating types x)
*cx returned by canonicalize *x) strto, wcsto, scanf, floating literals of decimal floating type
see 7.25.2.7
-(x), +(x) x) fabs x) copysign x) quantize y) quantum x)
<wchar.h> (7.33), floatingpoint environment <fenv.h> (7.6), general utilities <stdlib.h> (7.25), input/output <stdio.h> (7.24), mathematics <math.h> (7.12), type-generic mathematics <tgmath.h> (7.29), ISO/IEC 60559 floating-point arithmetic (Annex F).6 Language
6.1 Notation
In the syntax notation used in this clause, syntactic categories (nonterminals) are indicated by italic type, and literal words and character set members (terminals) by bold type. A colon (:) following a nonterminal introduces its definition. Alternative definitions are listed on separate lines, except when prefaced by the words "one of". An optional symbol is indicated by the subscript "opt", so that
{ expressionopt }
indicates an optional expression enclosed in braces.
When syntactic categories are referred to in the main text, they are not italicized and words are separated by spaces instead of hyphens.
A summary of the language syntax is given in Annex A.
6.2 Concepts
6.2.1 Scopes of identifiers, type names, and compound literals
An identifier can denote:
- a standard attribute, an attribute prefix, or an attribute name;
- an object;
- a function;
- a tag or a member of a structure, union, or enumeration;
- a typedef name;
- a label name;
- a macro name;
- or, a macro parameter.
The same identifier can denote different entities at different points in the program. A member of an enumeration is called an enumeration constant. Macro names and macro parameters are not considered further here, because prior to the semantic phase of program translation any occurrences of macro names in the source file are replaced by the preprocessing token sequences that constitute their macro definitions.
For each different entity that an identifier designates, the identifier is visible (i.e. can be used) only within a region of program text called its scope. Different entities designated by the same identifier either have different scopes or are in different name spaces. There are four kinds of scopes: function, file, block, and function prototype. (A function prototype is a declaration of a function.)
A label name is the only kind of identifier that has function scope. It can be used (in a goto statement) anywhere in the function in which it appears, and is declared implicitly by its syntactic appearance (followed by a : and a statement).
Every other identifier has scope determined by the placement of its declaration (in a declarator or type specifier). If the declarator or type specifier that declares the identifier appears outside of any block or list of parameters, the identifier has file scope, which terminates at the end of the translation unit. If the declarator or type specifier that declares the identifier appears inside a block or within the list of parameter declarations in a function definition, the identifier has block scope, which terminates at the end of the associated block. If the declarator or type specifier that declares
Unless explicitly stated otherwise, where this document uses the term "identifier" to refer to an entity (as opposed to the syntactic construct), it refers to the entity in the relevant name space whose declaration is visible at the point the identifier occurs.
Two identifiers have the same scope if and only if their scopes terminate at the same point.
Structure, union, and enumeration tags have scope that begins just after the appearance of the tag in a type specifier that declares the tag. Each enumeration constant has scope that begins just after the appearance of its defining enumerator in an enumerator list. An ordinary identifier that has an underspecified definition has scope that starts when the definition is completed; if the same ordinary identifier declares another entity with a scope that encloses the current block, that declaration is hidden as soon as the inner declarator is completed.19) Any other identifier has scope that begins just after the completion of its declarator.
As a special case, a type name (which is not a declaration of an identifier) is considered to have a scope that begins just after the place within the type name where the omitted identifier would appear were it not omitted. A compound literal (which is an expression that provides access to an anonymous object) is associated with the scope of the type name used in its definition; that scope is either file scope, function prototype scope, or block scope.
Forward references: declarations (6.7), function calls (6.5.3.3), function calls (6.5.3.6), function definitions (6.9.2), identifiers (6.4.3), macro replacement (6.10.5), name spaces of identifiers (6.2.3), source file inclusion (6.10.3), statements and blocks (6.8).
6.2.2 Linkages of identifiers
An identifier declared in different scopes or in the same scope more than once can be made to refer to the same object or function by a process called linkage.20) There are three kinds of linkage: external, internal, and none.
In the set of translation units and libraries that constitutes an entire program, each declaration of a particular identifier with external linkage denotes the same object or function. Within one translation unit, each declaration of an identifier with internal linkage denotes the same object or function. Each declaration of an identifier with no linkage denotes a unique entity.
If the declaration of a file scope identifier for:
- an object contains any of the storage-class specifiers
staticorconstexpr; - or, a function contains the storage-class specifier
static,
then the identifier has internal linkage.21)
For an identifier declared with the storage-class specifier extern in a scope in which a prior declaration of that identifier is visible,22) if the prior declaration specifies internal or external linkage, the linkage of the identifier at the later declaration is the same as the linkage specified at the prior declaration. If no prior declaration is visible, or if the prior declaration specifies no linkage, then the identifier has external linkage.
If the declaration of an identifier for a function has no storage-class specifier, its linkage is determined exactly as if it were declared with the storage-class specifier extern. If the declaration of an identifier
The following identifiers have no linkage: an identifier declared to be anything other than an object or a function; an identifier declared to be a function parameter; a block scope identifier for an object declared without the storage-class specifier extern.
6.2.3 Name spaces of identifiers
If more than one declaration of a particular identifier is visible at any point in a translation unit, the syntactic context disambiguates uses that refer to different entities. Thus, there are separate name spaces for various categories of identifiers, as follows:
- label names (disambiguated by the syntax of the label declaration and use);
- the tags of structures, unions, and enumerations (disambiguated by following any23) of the keywords
struct,union, orenum); - the members of structures or unions; each structure or union has a separate name space for its members (disambiguated by the type of the expression used to access the member via the
.or->operator); - standard attributes and attribute prefixes (disambiguated by the syntax of the attribute specifier and name of the attribute token) (6.7.13);
- the trailing identifier in an attribute prefixed token; each attribute prefix has a separate name space for the implementation-defined attributes that it introduces (disambiguated by the attribute prefix and the trailing identifier token);
- all other identifiers, called ordinary identifiers (declared in ordinary declarators or as enumeration constants).
goto statement (6.8.7.2).6.2.4 Storage durations of objects
An object has a storage duration that determines its lifetime. There are four storage durations: static, thread, automatic, and allocated. Allocated storage is described in 7.25.4.
The lifetime of an object is the portion of program execution during which storage is guaranteed to be reserved for it. An object exists, has a constant address,24) and retains its last-stored value throughout its lifetime.25) If an object is referred to outside of its lifetime, the behavior is undefined. If a pointer value is used in an evaluation after the object the pointer points to (or just past) reaches the end of its lifetime, the behavior is undefined. The representation of a pointer object becomes indeterminate when the object the pointer points to (or just past) reaches the end of its lifetime.
An object whose identifier is declared without the storage-class specifier thread_local, and either with external or internal linkage or with the storage-class specifier static, has static storage duration. Its lifetime is the entire execution of the program and its stored value is initialized only once, prior to program startup.
An object whose identifier is declared with the storage-class specifier thread_local has thread storage duration. Its explicit or implicit initializer is evaluated prior to program execution, its lifetime is the entire execution of the thread for which it is created, and its stored value is initialized with the previously determined value when the thread is started. There is a distinct object per thread, and
An object whose identifier is declared with no linkage and without the storage-class specifier static has automatic storage duration, as do some compound literals. The result of attempting to indirectly access an object with automatic storage duration from a thread other than the one with which the object is associated is implementation-defined.
For such an object that has a known constant size, see 6.2.5, its lifetime extends from entry into the block with which it is associated until execution of that block ends in any way. (Entering an enclosed block or calling a function suspends, but does not end, execution of the current block.) If the block is entered recursively, a new instance of the object is created each time. The initial representation of the object is indeterminate. If an initialization is specified for the object and it is not specified with constexpr, it is performed each time the declaration or compound literal is reached in the execution of the block; if it is specified with constexpr the initializer is evaluated once at translation time and the new instance of the object is initialized to that fixed value each time the specification is reached; otherwise, the representation of the object becomes indeterminate each time the declaration is reached.
For such an object that does not have a known constant size, its lifetime extends from the declaration of the object until execution of the program leaves the scope of the declaration.26) If the scope is entered recursively, a new instance of the object is created each time. The initial representation of the object is indeterminate.
A non-lvalue expression with structure or union type, where the structure or union contains a member with array type (including, recursively, members of all contained structures and unions) refers to an object with automatic storage duration and temporary lifetime.27) Its lifetime begins when the expression is evaluated and its initial value is the value of the expression. Its lifetime ends when the evaluation of the containing full expression ends. Any attempt to modify an object with temporary lifetime results in undefined behavior. An object with temporary lifetime behaves as if it were declared with the type of its value for the purposes of effective type. Such an object may not have a unique address.
Forward references: array declarators (6.7.7.3), compound literals (6.5.3.6), declarators (6.7.7), function calls (6.5.3.3), initialization (6.7.11), statements (6.8), effective type (6.5.1).
6.2.5 Types
The meaning of a value stored in an object or returned by a function is determined by the type of the expression used to access it. (An identifier declared to be an object is the simplest such expression; the type is specified in the declaration of the identifier.) Types are partitioned into object types (types that describe objects) and function types (types that describe functions). At various points within a translation unit an object type can be incomplete28) (lacking sufficient information to determine the size of objects of that type) or complete (having sufficient information).29)
An object declared as type bool is large enough to store the values false and true.
An object declared as type char is large enough to store any member of the basic execution character set. If a member of the basic execution character set is stored in a char object, its value is guaranteed to be nonnegative. If any other character is stored in a char object, the resulting value is implementation-defined but shall be within the range of values that can be represented in that type.
There are five standard signed integer types, designated as signed char, short int, int, long int, and long long int. (These and other types can be designated in several additional ways, as
A bit-precise signed integer type is designated as _BitInt(N) where N is an integer constant expression that specifies the number of bits that are used to represent the type, including the sign bit. Each value of N designates a distinct type.30)
There may also be implementation-defined extended signed integer types.31) The standard signed integer types, bit-precise signed integer types, and extended signed integer types are collectively called signed integer types.32)
An object declared as type signed char occupies the same amount of storage as a "plain" char object. A "plain" int object has the natural size suggested by the architecture of the execution environment (large enough to contain any value in the range INT_MIN to INT_MAX as defined in the header <limits.h>).
For each of the signed integer types, there is a corresponding (but different) unsigned integer type (designated with the keyword unsigned) that uses the same amount of storage (including sign information) and has the same alignment requirements. The type bool and the unsigned integer types that correspond to the standard signed integer types are the standard unsigned integer types. The unsigned integer types that correspond to the extended signed integer types are the extended unsigned integer types. In addition to the unsigned integer types that correspond to the bit-precise signed integer types there is the type unsigned _BitInt(1), which uses one bit to represent the type. Collectively, unsigned _BitInt(1) and the unsigned integer types that correspond to the bitprecise signed integer types are the bit-precise unsigned integer types. The standard unsigned integer types, bit-precise unsigned integer types, and extended unsigned integer types are collectively called unsigned integer types.33)
The standard signed integer types and standard unsigned integer types are collectively called the standard integer types; the bit-precise signed integer types and bit-precise unsigned integer types are collectively called the bit-precise integer types; the extended signed integer types and extended unsigned integer types are collectively called the extended integer types.
For any two integer types with the same signedness and different integer conversion rank (see 6.3.2.1), the range of values of the type with smaller integer conversion rank is a subrange of the values of the other type.
The range of nonnegative values of a signed integer type is a subrange of the corresponding unsigned integer type, and the representation of the same value in each type is the same.34) The range of representable values for the unsigned type is to (inclusive). A computation involving unsigned operands can never produce an overflow, because arithmetic for the unsigned type is performed modulo .
There are three standard floating types, designated as float, double, and long double.35) The set of values of the type float is a subset of the set of values of the type double; the set of values of the type double is a subset of the set of values of the type long double.
There are three decimal floating types, designated as _Decimal32, _Decimal64, and _Decimal128. Respectively, they have the ISO/IEC 60559 formats: decimal32,36) decimal64, and decimal128. (Decimal floating types are a conditional feature that implementations may not support; see 6.10.10.4.)
The standard floating types and the decimal floating types are collectively called the real floating types..
There are three complex types, designated as float _Complex, double _Complex, and long double _Complex. (Complex types are a conditional feature that implementations may not support; see 6.10.10.4.) The real floating and complex types are collectively called the floating types.
For each floating type there is a corresponding real type, which is always a real floating type. For real floating types, it is the same type. For complex types, it is the type given by deleting the keyword _Complex from the type name.
Each complex type has the same representation and alignment requirements as an array type containing exactly two elements of the corresponding real type; the first element is equal to the real part, and the second element to the imaginary part, of the complex number. In this document complex values are sometimes written in the form , where and are the values of the real and imaginary parts, and represents the mathematical imaginary unit, which has the property . The form is equivalent to .
The type char, the signed and unsigned integer types, and the floating types are collectively called the basic types. The basic types are complete object types. Even if the implementation defines two or more basic types to have the same representation, they are nevertheless distinct types.
NOTE An implementation can define new keywords that provide alternative ways to designate a basic (or any other) type; this does not violate the requirement that all basic types be different. Implementation-defined keywords have the form of an identifier reserved for any use as described in 7.1.3.
The three types char, signed char, and unsigned char are collectively called the character types. The implementation shall define char to have the same range, representation, and behavior as either signed char or unsigned char.37)
An enumeration comprises a set of named constants of integer type. Each distinct enumeration constitutes a different enumerated type.
The type char, the signed and unsigned integer types, and the enumerated types are collectively called integer types. The integer and real floating types are collectively called real types.
Integer and floating types are collectively called arithmetic types. Each arithmetic type belongs to one type domain: the real type domain comprises the real types, the complex type domain comprises the complex types.
The void type comprises an empty set of values; it is an incomplete object type that cannot be completed.
Any number of derived types can be constructed from the object and function types, as follows:
- An array type describes a contiguously allocated nonempty set of objects with a particular member object type, called the element type. The element type shall be complete whenever the array type is specified. Array types are characterized by their element type and by the number of elements in the array. An array type is said to be derived from its element type, and if its element type is T, the array type is sometimes called "array of T". The construction of an array type from an element type is called "array type derivation".
- A structure type describes a sequentially allocated nonempty set of member objects (and, in certain circumstances, an incomplete array), each of which has an optionally specified name and possibly distinct type.
- A union type describes an overlapping nonempty set of member objects, each of which has an optionally specified name and possibly distinct type.
- A function type describes a function with specified return type. A function type is characterized by its return type and the number and types of its parameters. A function type is said to be derived from its return type, and if its return type is T, the function type is sometimes called "function returning T". The construction of a function type from a return type is called "function type derivation".
The type of the nullptr constant, i.e. nullptr_t, is an unqualified complete scalar type that is different from all pointer or arithmetic types and is neither an atomic or array type and has exactly one value, nullptr.
Arithmetic types, pointer types, and the nullptr_t type are collectively called scalar types. Array and structure types are collectively called aggregate types.38)
An array type of unknown size is an incomplete type. It is completed, for an identifier of that type, by specifying the size in a later declaration (with internal or external linkage). A structure or union type of unknown content (as described in 6.7.3.4) is an incomplete type. It is completed, for all declarations of that type, by declaring the same structure or union tag with its defining content later in the same scope.
A complete type shall have a size that is less than or equal to SIZE_MAX. A type has known constant size if it is complete and is not a variable length array type.39)
Array, function, and pointer types are collectively called derived declarator types. A declarator type derivation from a type T is the construction of a derived declarator type from T by the application of an array-type, a function-type, or a pointer-type derivation to T.
A type is characterized by its type category, which is either the outermost derivation of a derived type (as noted previously in this subclause in the construction of derived types), or the type itself if the type consists of no derived types.
Any type so far mentioned is an unqualified type. Each unqualified type has several qualified versions of its type,40) corresponding to the combinations of one, two, or all three of the const, volatile, and restrict qualifiers. The qualified or unqualified versions of a type are distinct types that belong to the same type category and have the same representation and alignment requirements.41) An array and its element type are always considered to be identically qualified.42) Any other derived type is not qualified by the qualifiers (if any) of the type from which it is derived.
Further, there is the _Atomic qualifier. The presence of the _Atomic qualifier designates an atomic type. The size, representation, and alignment of an atomic type may not be the same as those of the corresponding unqualified type. Therefore, this document explicitly uses the phrase "atomic, qualified, or unqualified type" whenever the atomic version of a type is permitted along with the other qualified versions of a type. The phrase "qualified or unqualified type", without specific mention of atomic, does not include the atomic types.
EXAMPLE 1 The type designated as "float *" has type "pointer to float". Its type category is pointer, not a floating type. The const-qualified version of this type is designated as "float * const" whereas the type designated as "const float *" is not a qualified type — its type is "pointer to const-qualified float" and is a pointer to a qualified type.
EXAMPLE 2 The type designated as "struct tag (*[5])(float)" has type "array of pointer to function returning struct tag". The array has length five and the function has a single parameter of type float. Its type category is array.
6.2.6 Representations of types
6.2.6.1 General
The representations of all types are unspecified except as stated in this subclause.
Except for bit-fields, objects are composed of contiguous sequences of one or more bytes, the number, order, and encoding of which are either explicitly specified or implementation-defined.
Values stored in unsigned bit-fields and objects of type unsigned char shall be represented using a pure binary notation.
Values stored in non-bit-field objects of any other object type are represented using CHAR_BIT bits, where is the size of an object of that type, in bytes. An object that has the value can be copied into an object of type unsigned char [] (e.g. by memcpy); the resulting set of bytes is called the object representation of the value. Values stored in bit-fields consist of bits, where is the size specified for the bit-field. The object representation is the set of bits the bit-field comprises in the addressable storage unit holding it. Two values (other than NaNs) with the same object representation compare equal, but values that compare equal may have different object representations.
Certain object representations do not represent a value of the object type. If such a representation is read by an lvalue expression that does not have character type, the behavior is undefined. If such a representation is produced by a side effect that modifies all or any part of the object by an lvalue expression that does not have character type, the behavior is undefined.43) Such a representation is called a non-value representation.
When a value is stored in an object of structure or union type, including in a member object, the bytes of the object representation that correspond to any padding bytes take unspecified values (e.g. structure and union assignment can fail to copy any padding bits). The object representation of a structure or union object is never a non-value representation, even though the byte range corresponding to a member of the structure or union object can be a non-value representation for that member.
When a value is stored in a member of an object of union type, the bytes of the object representation that do not correspond to that member but do correspond to other members take unspecified values.
Where an operator is applied to a value that has more than one object representation, which object representation is used shall not affect the value of the result.44) Where a value is stored in an object using a type that has more than one object representation for that value, it is unspecified which representation is used, but a non-value representation shall not be generated.
Loads and stores of objects with atomic types are done with memory_order_seq_cst semantics.
6.2.6.2 Integer types
For unsigned integer types the bits of the object representation shall be divided into two groups: value bits and padding bits. If there are value bits, each bit shall represent a different power of between and , so that objects of that type shall be capable of representing values from to using a pure binary representation; this shall be known as the value representation. The values of any padding bits are unspecified. The number of value bits is called the width of the
For signed integer types, the bits of the object representation shall be divided into three groups: value bits, padding bits, and the sign bit. If the corresponding unsigned type has width , the signed type uses the same number of bits, its width, as value bits and sign bit. are value bits and the remaining bit is the sign bit. Each bit that is a value bit shall have the same value as the same bit in the object representation of the corresponding unsigned type. If the sign bit is zero, it shall not affect the resulting value. If the sign bit is one, it has value . There can be padding bits; signed char shall not have any padding bits.
The values of any padding bits are unspecified. A valid object representation of a signed integer type where the sign bit is zero is a valid object representation of the corresponding unsigned type, and shall represent the same value. For any integer type, the object representation where all the bits are zero shall be a representation of the value zero in that type.
The precision of an integer type is the number of value bits.
NOTE 1 Some combinations of padding bits can generate non-value representations, for example, if one padding bit is a parity bit. Regardless, no arithmetic operation on valid values can generate a non-value representation other than as part of an exceptional condition such as an integer overflow. All other combinations of padding bits are alternative object representations of the value specified by the value bits.
NOTE 2 The sign representation defined in this document is called two’s complement. Previous editions of this document (specifically ISO/IEC 9899:2018 and prior editions) additionally allowed other sign representations.
NOTE 3 For unsigned integer types the width and precision are the same, while for signed integer types the width is one greater than the precision.
6.2.6.3 Pointer types and nullptr_t
A pointer to void shall have the same representation and alignment requirements as a pointer to a character type.41) Similarly, pointers to qualified or unqualified versions of compatible types shall have the same representation and alignment requirements. All pointers to structure types shall have the same representation and alignment requirements as each other. All pointers to union types shall have the same representation and alignment requirements as each other. Pointers to other types may not have the same representation or alignment requirements.
The size and alignment of nullptr_t is the same as for a pointer to character type. An object representation of the value of nullptr is the same as the object representation of a null pointer value of type void*. All other object representations are non-value representations for this type.
6.2.7 Compatible type and composite type
Two types are compatible types if they are the same. Additional rules for determining whether two types are compatible are described in 6.7.3 for type specifiers, in 6.7.4 for type qualifiers, and in 6.7.7 for declarators.45) Moreover, two complete structure, union, or enumerated types declared with the same tag are compatible if members satisfy the following requirements:
- there shall be a one-to-one correspondence between their members such that each pair of corresponding members are declared with compatible types;
- if one member of the pair is declared with an alignment specifier, the other is declared with an equivalent alignment specifier;
- and, if one member of the pair is declared with a name, the other is declared with the same name.
For two structures, corresponding members shall be declared in the same order. For two unions declared in the same translation unit, corresponding members shall be declared in the same order. For two structures or unions, corresponding bit-fields shall have the same widths. For two enumerations,
All declarations that refer to the same object or function shall have compatible type; otherwise, the behavior is undefined.
A composite type can be constructed from two types that are compatible. If both types are the same type, the composite type is this type. Otherwise, it is a type that is compatible with both and satisfies the following conditions:
- If both types are structure types or both types are union types, the composite type is determined recursively by forming the composite types of their members.
- If both types are array types, the following rules are applied:
• If one type is an array of known constant length, the composite type is an array of that length.
• Otherwise, if one type is a variable length array whose length is specified, the composite type is a variable length array of that length.
• Otherwise, if one type is a variable length array of unspecified length, the composite type is a variable length array of unspecified length.
• Otherwise, both types are arrays of unknown length, and the composite type is an array of unknown length.
The element type of the composite type is the composite type of the two element types.
- If both types are function types, the type of each parameter in the composite parameter type list is the composite type of the corresponding parameters.
- If one of the types has a standard attribute, the composite type also has that attribute.
- If both types are enumerated types, the composite type is an enumerated type.
- If one type is an enumerated type and the other is an integer type other than an enumerated type, it is implementation-defined whether or not the composite type is an enumerated type.
These rules apply recursively to the types from which the two types are derived.
EXAMPLE 1 Given an object nsize of type size_t and two types:
-
double[3]anddouble[]have a composite type ofdouble[3] -
double[]anddouble[nsize]have a composite type ofdouble[nsize] -
double[]anddouble[*]have a composite type ofdouble[*]
If any of the original types satisfies all requirements of the composite type, it is unspecified whether the composite type is one of these types or a different type that satisfies the requirements.47)
For an identifier with internal or external linkage declared in a scope in which a prior declaration of that identifier is visible,48) if the prior declaration specifies internal or external linkage, the type of the identifier at the later declaration becomes the composite type.
EXAMPLE 2 Given the following two file scope declarations:
int f(int (*)(char *), double (*)[3]); int f(int (*)(char *), double (*)[]);The resulting composite type for the function is:
int f(int (*)(char *), double (*)[3]);
6.2.8 Alignment of objects
Complete object types have alignment requirements which place restrictions on the addresses at which objects of that type can be allocated. An alignment is an implementation-defined integer value representing the number of bytes between successive addresses at which a given object can be allocated. An object type imposes an alignment requirement on every object of that type: stricter alignment can be requested using the alignas keyword.
A fundamental alignment is a valid alignment less than or equal to alignof(max_align_t). Fundamental alignments shall be supported by the implementation for objects of all storage durations. The alignment requirements of the following types shall be fundamental alignments:
- all qualified or unqualified basic types;
- all qualified or unqualified enumerated types;
- all qualified or unqualified pointer types;
- all array types whose element type has a fundamental alignment requirement;
- all types specified in Clause 7 as complete object types;
- all structure or union types whose elements have types with fundamental alignment requirements and none of whose elements have an alignment specifier specifying an alignment that is not a fundamental alignment.
Whether any atomic types have fundamental alignment is implementation-defined.
An extended alignment is represented by an alignment greater than alignof(max_align_t). It is implementation-defined whether any extended alignments are supported and the storage durations for which they are supported. A type having an extended alignment requirement is an over-aligned type.49)
Alignments are represented as values of the type size_t. Valid alignments include only fundamental alignments, plus an additional implementation-defined set of values, which can be empty. Every valid alignment value shall be a nonnegative integral power of two.
Alignments have an order from weaker to stronger or stricter alignments. Stricter alignments have larger alignment values. An address that satisfies an alignment requirement also satisfies any weaker valid alignment requirement.
The alignment requirement of a complete type can be queried using an alignof expression. The types char, signed char, and unsigned char shall have the weakest alignment requirement.
Comparing alignments is meaningful and provides the obvious results:
- Two alignments are equal when their numeric values are equal.
- Two alignments are different when their numeric values are not equal.
- When an alignment is larger than another it represents a stricter alignment.
6.2.9 Encodings
The literal encoding is an implementation-defined mapping of the characters of the execution character set to the values in a character literal (6.4.5.5) or string literal (6.4.6). It shall support a mapping from all the basic execution character set values into the implementation-defined encoding. It can contain multibyte character sequences (5.3.2).
The wide literal encoding is an implementation-defined mapping of the characters of the execution character set to the values in a wchar_t character literal (6.4.5.5) or a wchar_t string literal (6.4.6). It shall support a mapping from all the basic execution character set values into the implementationdefined encoding. The mapping shall produce values identical to the literal encoding for all the basic execution character set values if an implementation does not define __STDC_MB_MIGHT_NEQ_WC__. One or more values may map to one or more values of the extended execution character set.
A code unit is a single compositional unit of encoded information, usually of type char, wchar_t, char8_t, char16_t, or char32_t.
A code point is a single compositional unit of decoded information. Code points are generally used as the single complete decoded output, or as an intermediary to transcode to other code units. A Unicode code point is a single compositional unit of decoded information as defined in ISO/IEC 10646, typically used to convert to or from UTF-8, UTF-16, and UTF-32.
The narrow execution encoding is the implementation-defined, LC_CTYPE-influenced (7.11.1), localebased execution environment encoding. The wide execution encoding is the implementation-defined, LC_CTYPE-influenced, locale-based wide execution environment encoding. Both of these encodings are called the execution encodings.
An unrecorded encoding error occurs when an encoding, decoding, or transcoding function encounters an input sequence of code units or code points that
- does not form a valid sequence according to the encoding being associated with the sequence
- or, is not representable in the output encoding or coded character set.
An encoding error is the same as an unrecorded encoding error, except that the value of the macro EILSEQ (7.5) is stored in errno when such an error occurs during execution of the functions defined in this document unless otherwise specified.
6.3 Conversions
6.3.1 Introduction
Several operators convert operand values from one type to another automatically. This subclause specifies the result required from such an implicit conversion, as well as those that result from a cast operation (an explicit conversion). The list in 6.3.2.8 summarizes the conversions performed by most ordinary operators; it is supplemented as required by the discussion of each operator in 6.5.1.
Unless explicitly stated otherwise, conversion of an operand value to a compatible type causes no change to the value or the representation.
6.3.2 Arithmetic operands
6.3.2.1 Boolean, characters, and integers
Every integer type has an integer conversion rank defined as follows:
- No two signed integer types shall have the same rank, even if they have the same representation.
- The rank of a signed integer type shall be greater than the rank of any signed integer type with less precision.
- The rank of
long long intshall be greater than the rank oflong int, which shall be greater than the rank ofint, which shall be greater than the rank ofshort int, which shall be greater than the rank ofsigned char. - The rank of a bit-precise signed integer type shall be greater than the rank of any standard integer type with less width or any bit-precise integer type with less width.
- The rank of any unsigned integer type shall equal the rank of the corresponding signed integer type, if any.
- The rank of any standard integer type shall be greater than the rank of any extended integer type with the same width or bit-precise integer type with the same width.
- The rank of any bit-precise integer type relative to an extended integer type of the same width is implementation-defined.
- The rank of
charshall equal the rank ofsigned charandunsigned char. - The rank of
boolshall be less than the rank of all other standard integer types. - The rank of any enumerated type shall equal the rank of the compatible integer type (see 6.7.3.3).
- The rank of any extended signed integer type relative to another extended signed integer type with the same precision is implementation-defined, but still subject to the other rules for determining the integer conversion rank.
- For all integer types
T1,T2, andT3, ifT1has greater rank thanT2andT2has greater rank than
T3, then T1 has greater rank than T3.
The following can be used in an expression wherever an int or unsigned int can be used:
- An object or expression with an integer type (other than
intorunsigned int) whose integer conversion rank is less than or equal to the rank ofintandunsigned int. - A bit-field of type
bool,int,signed int, orunsigned int.
The value from a bit-field of a bit-precise integer type is converted to the corresponding bit-precise integer type. If the original type is not a bit-precise integer type (6.2.5): if an int can represent all values of the original type (as restricted by the width, for a bit-field), the value is converted to an int;50) otherwise, it is converted to an unsigned int. These are called the integer promotions. All other types are unchanged by the integer promotions.
NOTE The integer promotions are applied only:
- as part of the usual arithmetic conversions,
- to certain argument expressions,
- to the operands of the unary
+,-, and~operators, - and to both operands of the shift operators,
The integer promotions preserve value including sign. As discussed earlier, whether a "plain" char can hold negative values is implementation-defined.
6.3.2.2 Boolean type
When any scalar value is converted to bool, the result is false if the value is a zero (for arithmetic types), null (for pointer types), or the scalar has type nullptr_t; otherwise, the result is true.
6.3.2.3 Signed and unsigned integers
When a value with integer type is converted to another integer type other than bool, if the value can be represented by the new type, it is unchanged.
Otherwise, if the new type is unsigned, the value is converted by repeatedly adding or subtracting one more than the maximum value that can be represented in the new type until the value is in the range of the new type.51)
Otherwise, the new type is signed and the value cannot be represented in it; either the result is implementation-defined or an implementation-defined signal is raised.
6.3.2.4 Real floating and integer
When a finite value of standard floating type is converted to an integer type other than bool, the fractional part is discarded (i.e. the value is truncated toward zero). If the value of the integral part cannot be represented by the integer type, the behavior is undefined.52)
When a finite value of decimal floating type is converted to an integer type other than bool, the fractional part is discarded (i.e. the value is truncated toward zero). If the value of the integral part cannot be represented by the integer type, the "invalid" floating-point exception shall be raised and the result of the conversion is unspecified.
When a value of integer type is converted to a standard floating type, if the value being converted can be represented exactly in the new type, it is unchanged. If the value being converted is in the range of values that can be represented but cannot be represented exactly, the result is either the nearest higher or nearest lower representable value, chosen in an implementation-defined manner. If the value being converted is outside the range of values that can be represented, the behavior is undefined. Results of some implicit conversions can be represented in greater range and precision than that required by the new type (see 6.3.2.8 and 6.8.7.5).
When a value of integer type is converted to a decimal floating type, if the value being converted can be represented exactly in the new type, it is unchanged. If the value being converted cannot be represented exactly, the result shall be correctly rounded with exceptions raised as specified in ISO/IEC 60559.
6.3.2.5 Real floating types
When a value of real floating type is converted to a real floating type, if the value being converted can be represented exactly in the new type, it is unchanged.
When a value of real floating type is converted to a standard floating type, if the value being converted is in the range of values that can be represented but cannot be represented exactly, the result is either the nearest higher or nearest lower representable value, chosen in an implementationdefined manner. If the value being converted is outside the range of values that can be represented, the behavior is undefined.
When a value of real floating type is converted to a decimal floating type, if the value being converted cannot be represented exactly, the result is correctly rounded with exceptions raised as specified in ISO/IEC 60559.
Results of some implicit conversions may be represented in greater range and precision than that required by the new type (see 6.3.2.8 and 6.8.7.5).
6.3.2.6 Complex types
When a value of complex type is converted to another complex type, both the real and imaginary parts follow the conversion rules for the corresponding real types.
6.3.2.7 Real and complex
When a value of real type is converted to a complex type, the real part of the complex result value is determined by the rules of conversion to the corresponding real type and the imaginary part of the complex result value is a positive zero or an unsigned zero.
When a value of complex type is converted to a real type other than bool,53) the imaginary part of the complex value is discarded and the value of the real part is converted according to the conversion rules for the corresponding real type.
6.3.2.8 Usual arithmetic conversions
Many operators that expect operands of arithmetic type cause conversions and yield result types in a similar way. The purpose is to determine a common real type for the operands and result. For the specified operands, each operand is converted, without change of type domain, to a type whose corresponding real type is the common real type. Unless explicitly stated otherwise, the common real type is also the corresponding real type of the result, whose type domain is the type domain of the operands if they are the same, and complex otherwise. This pattern is called the usual arithmetic conversions:
If one operand has decimal floating type, the other operand shall not have standard floating, or complex type.
First, if the type of either operand is _Decimal128, the other operand is converted to _Decimal128.
Otherwise, if the type of either operand is _Decimal64, the other operand is converted to _Decimal64.
Otherwise, if the type of either operand is _Decimal32, the other operand is converted to _Decimal32.
Otherwise, if the corresponding real type of either operand is long double, the other operand is converted, without change of type domain, to a type whose corresponding real type is long double.
Otherwise, if the corresponding real type of either operand is double, the other operand is converted, without change of type domain, to a type whose corresponding real type is double.
Otherwise, if the corresponding real type of either operand is float, the other operand is converted, without change of type domain, to a type whose corresponding real type is float.54)
Otherwise, if any of the two types is an enumeration, it is converted to its underlying type. Then, the integer promotions are performed on both operands. Next, the following rules are applied to the promoted operands:
If both operands have the same type, then no further conversion is needed.
The values of floating operands and of the results of floating expressions may be represented in greater range and precision than that required by the type; the types are not changed thereby. See 5.3.5.3.3 regarding evaluation formats.
EXAMPLE One consequence of _BitInt being exempt from the integer promotion rules (6.3.2) is that a _BitInt operand of a binary operator is not always promoted to an int or unsigned int as part of the usual arithmetic conversions. Instead, a lower-ranked operand is converted to the higher-rank operand type and the result of the operation is the higher-ranked type.
_BitInt(2) a2 = 1; _BitInt(3) a3 = 2; _BitInt(33) a33 = 1; signed char c = 3; a2 * a3; /* As part of the multiplication, a2 is converted to _BitInt(3) and the result type is _BitInt(3). */ a2 * c; /* As part of the multiplication, c is promoted to int, a2 is converted to int and the result type is int. */ a33 * c; /* As part of the multiplication, c is promoted to int. Then, provided int has a width of at most 32, it is converted to _BitInt(33) and the result type is _BitInt(33). */ void func(_BitInt(8) a8, _BitInt(24) a24) { /* Cast one of the operands to 32-bits to guarantee the result of the multiplication can contain all possible values. */ _BitInt(32) a32 = a8 * (_BitInt(32))a24; }
6.3.3 Other operands
6.3.3.1 Lvalues, arrays, and function designators
An lvalue is an expression (with an object type other than void) that potentially designates an object;55) if an lvalue does not designate an object when it is evaluated, the behavior is undefined. When an object is said to have a particular type, the type is specified by the lvalue used to designate the object. A modifiable lvalue is an lvalue that does not have array type, does not have an incomplete type, does not have a const-qualified type, and if it is a structure or union, does not have any member (including, recursively, any member or element of all contained aggregates or unions) with a const-qualified type.
Except when it is the operand of:
An expression that has type "array of type" is converted to an expression with type "pointer to type" except when it is an operand of the sizeof operator, the _Countof operator, the typeof operators, the unary & operator, the array subscripting operator, or if it is a string literal used to initialize an array. The resulting pointer points to the initial element of the array object and is not an lvalue. If the array object has register storage class, the behavior is implementation-defined.
A function designator is an expression that has function type. Except when it is the operand of the sizeof operator,56) a typeof operator, or the unary & operator, a function designator with type "function returning type" is converted to an expression that has type "pointer to function returning type".
Forward references: address and indirection operators (6.5.4.3), assignment operators (6.5.17), common definitions <stddef.h> (7.22), initialization (6.7.11), postfix increment and decrement operators (6.5.3.5), prefix increment and decrement operators (6.5.4.2), the sizeof, _Countof, and alignof operators (6.5.4.5), structure and union members (6.5.3.4).
6.3.3.2 void
An expression that has type void is a void expression. If an expression of any other type is evaluated as a void expression, its value or designator is discarded. (A void expression is evaluated for its side effects.)
6.3.3.3 Pointers
A pointer to void can be converted to or from a pointer to any object type. A pointer to any object type can be converted to a pointer to void and back again; the result shall compare equal to the original pointer.
For any qualifier q, a pointer to a non-q-qualified type can be converted to a pointer to the q-qualified version of the type; the values stored in the original and converted pointers shall compare equal.
An integer constant expression with the value , such an expression cast to type void *, or the predefined constant nullptr is called a null pointer constant.57) If a null pointer constant or a value of the type nullptr_t (which is necessarily the value nullptr) is converted to a pointer type, the resulting pointer, called a null pointer, is guaranteed to compare unequal to a pointer to any object or function.
Conversion of a null pointer to another pointer type yields a null pointer of that type. Any two null pointers shall compare equal.
An integer can be converted to any pointer type. Except as previously specified, the result is implementation-defined, possibly not correctly aligned, can possibly not point to an entity of the referenced type, and can produce an indeterminate representation when stored into an object.58)
Any pointer type can be converted to an integer type. Except as previously specified, the result is implementation-defined. If the result cannot be represented in the integer type, the behavior is undefined. The result is not required to be in the range of values of any integer type.
A pointer to an object type can be converted to a pointer to a different object type. If the resulting pointer is not correctly aligned59) for the referenced type, the behavior is undefined. Otherwise, when converted back again, the result shall compare equal to the original pointer. When a pointer to an object is converted to a pointer to a character type, the result points to the lowest addressed byte of the object. Successive increments of the result, up to the size of the object, yield pointers to the remaining bytes of the object.
A pointer to a function of one type can be converted to a pointer to a function of another type and back again; the result shall compare equal to the original pointer. If a converted pointer is used to call a function whose type is not compatible with the referenced type, the behavior is undefined.
6.3.3.4 nullptr_t
The type nullptr_t can be converted to void, bool or to a pointer type; the result is a void expression, false, or a null pointer value, respectively.
A null pointer constant or value of type nullptr_t can be converted to nullptr_t.
Forward references: cast operators (6.5.5), equality operators (6.5.10), integer types capable of holding object pointers (7.23.2.5), simple assignment (6.5.17.2), the nullptr_t type (7.22.3).
6.4 Lexical elements
6.4.1 General
Syntax
- preprocessing-token:
- header-name
- identifier
- pp-number
- character-literal
- string-literal
- punctuator
- each universal character name that cannot be one of the above
- each non-white-space character that cannot be one of the above
Constraints
Each preprocessing token that is converted to a token shall have the lexical form of a keyword, an identifier, a constant, a string literal, or a punctuator. A single universal character name shall match one of the other preprocessing token categories.
Semantics
A token is the minimal lexical element of the language in translation phases 7 and 8 (5.2.1.2). The categories of tokens are: keywords, identifiers, constants, string literals, and punctuators. A preprocessing token is the minimal lexical element of the language in translation phases 3 through 6. The categories of preprocessing tokens are: header names, identifiers, preprocessing numbers, character literals, string literals, punctuators, and both single universal character names as well as single non-white-space characters that do not lexically match the other preprocessing token categories.60) If a ’ or a " character matches the last category, the behavior is undefined. Preprocessing tokens can be separated by white space; this consists of comments (described later), or white-space characters (space, horizontal tab, new-line, vertical tab, and form-feed), or both. As described in 6.10, in certain circumstances during translation phase 4, white space (or the absence thereof) serves as more than preprocessing token separation. White space may appear within a preprocessing token only as part of a header name or between the quotation characters in a character literal or string literal.
If the input stream has been parsed into preprocessing tokens up to a given character, the next preprocessing token is the longest sequence of characters that could constitute a preprocessing token. There is one exception to this rule: header name preprocessing tokens are recognized only within #include and #embed preprocessing directives, in __has_include and __has_embed expressions, as well as in implementation-defined locations within #pragma directives. In such contexts, a sequence of characters that could be either a header name or a string literal is recognized as the former.
EXAMPLE 1 The program fragment 1Ex is parsed as a preprocessing number token (one that is not a valid floating or integer literal), even though a parse as the pair of preprocessing tokens 1 and Ex can produce a valid expression (for example, if Ex were a macro defined as +1). Similarly, the program fragment 1E1 is parsed as a preprocessing number (one that is a valid floating literal), whether or not E is a macro name.
EXAMPLE 2 The program fragment x+++++y is parsed as x ++ ++ + y, which violates a constraint on increment operators, even though the parse x ++ + ++ y can yield a correct expression.
6.4.2 Keywords
Syntax
keyword: one of
alignas alignof auto bool break case char const constexpr continue default
do double else enum extern false float for goto if inline
int long nullptr register restrict return short signed sizeof static static_assert
struct switch thread_local true typedef typeof typeof_unqual union unsigned void volatile
while _Atomic _BitInt _Complex _Countof _Decimal128 _Decimal32 _Decimal64 _Generic _Noreturn
Semantics
The previously listed tokens (case sensitive) are reserved (in translation phases 7 and 8) for use as keywords except in an attribute token, and shall not be used otherwise.
Table 6.1 provides alternate spellings for certain keywords. These can be used wherever the keyword can.61)
Table 6.1 — Keywords and their spellings
Keyword Alternative Spelling alignas _Alignas alignof _Alignof bool _Bool static_assert _Static_assert thread_local _Thread_local
The spelling of these keywords, their alternate forms, and of false and true inside expressions that are subject to the # and ## preprocessing operators is unspecified.62)
6.4.3 Identifiers
6.4.3.1 General
Syntax
- identifier-start:
- nondigit
- XID_Start character
- universal character name of class XID_Start
- identifier-continue:
- digit
- nondigit
- XID_Continue character
- universal character name of class XID_Continue
- nondigit: one of
_ a b c d e f g h i j k l mn o p q r s t u v w x y zA B C D E F G H I J K L MN O P Q R S T U V W X Y Z
- digit: one of
0 1 2 3 4 5 6 7 8 9
Semantics
An XID_Start character is an implementation-defined character whose corresponding code point in ISO/IEC 10646 has the XID_Start property. An XID_Continue character is an implementationdefined character whose corresponding code point in ISO/IEC 10646 has the XID_Continue property. An identifier is a sequence of one identifier start character followed by 0 or more identifier continue characters, which designates one or more entities as described in 6.2.1. It is implementation-defined if a $ (U+0024, DOLLAR SIGN) may be used as a nondigit character. Lowercase and uppercase letters are distinct. There is no specific limit on the maximum length of an identifier.
The character classes XID_Start and XID_Continue are Derived Core Properties as described by UAX #44.63) Each character and universal character name in an identifier shall designate a character whose encoding in ISO/IEC 10646 has the XID_Continue property. The initial character (which can be a universal character name) shall designate a character whose encoding in ISO/IEC 10646 has the XID_Start property. An identifier shall conform to Normalization Form C as specified in ISO/IEC 10646. Annex D provides an overview of the conforming identifiers.
NOTE 1 Uppercase and lowercase letters are considered different for all identifiers.
NOTE 2 In translation phase 4, the term identifier also includes those preprocessing tokens (6.4.9) differentiated as keywords (6.4.2) in the later translation phase 7 (5.2.1.2).
When preprocessing tokens are converted to tokens during translation phase 7, if a preprocessing token could be converted to either a keyword or an identifier, it is converted to a keyword except in an attribute token.
Some identifiers are reserved.
If the program declares or defines an identifier in a context in which it is reserved (other than as allowed by 7.1.4), the behavior is undefined.
If the program defines a reserved identifier or standard attribute token described in 6.7.13.2 as a macro name, or removes (with #undef) any macro definition of an identifier in the first group listed previously or standard attribute token described in 6.7.13.2, the behavior is undefined.
Some identifiers may be potentially reserved. A potentially reserved identifier is an identifier which is not reserved unless made so by an implementation providing the identifier (7.1.3) but is anticipated to become reserved by an implementation or a future version of this document. An identifier that this document describes as optional:
- If it is defined as a macro it is reserved.
- Otherwise, if the definition is given in clauses 1 to 6 it is reserved.
- Otherwise, it is potentially reserved.
Recommended practice
Implementations are encouraged to issue a diagnostic message when a potentially reserved identifier is declared or defined for any use that is not implementation-compatible (see subsequent description in this subclause) in a context where the potentially reserved identifier may be reserved under a conforming implementation. This brings attention to a potential conflict when porting a program to a future edition of this document.
An implementation-compatible use of a potentially reserved identifier is a declaration of an external name where the name is provided by the implementation as an external name and where the declaration declares an object or function with a type that is compatible with the type of the object or function provided by the implementation under that name.
Implementation limits
As discussed in 5.3.5.2, an implementation may limit the number of significant initial characters in an identifier; the limit for an external name (an identifier that has external linkage) may be more restrictive than that for an internal name (a macro name or an identifier that does not have external linkage). The number of significant characters in an identifier is implementation-defined.
Any identifiers that differ in a significant character are different identifiers. If two identifiers differ only in nonsignificant characters, the behavior is undefined.
6.4.3.2 Predefined identifiers
Semantics
The identifier __func__ shall be implicitly declared by the translator as if, immediately following the opening brace of each function definition, the declaration
static const char __func__[] = "function-name " ;
This name is encoded as if the implicit declaration had been written in the source character set and then translated into the execution character set as indicated in translation phase 5.
EXAMPLE The following code fragment can be used as an example:
#include <stdio.h> void myfunc(void) { printf("%s\n", __func__); /* ... */ }
Each time the function is called, it will print to the standard output stream:
myfunc
6.4.4 Universal character names
Syntax
Constraints
A universal character name shall not designate a code point where the hexadecimal value is:
- in the range D800 through DFFF inclusive; or
- greater than 10FFFF.66)
A universal character name outside the c-char sequence of a character literal, or the s-char sequence of a string literal shall not designate a control character or a character in the basic character set.
Description
Universal character names can be used in identifiers, character literals, and string literals to designate characters that are not in the basic character set.
Semantics
A universal character name designates the character in ISO/IEC 10646 whose code point is the hexadecimal value represented by the sequence of hexadecimal digits in the universal character name.
6.4.5 Constants
6.4.5.1 General
Syntax
Constraints
Each constant shall have a type and the value of a constant shall be in the range of representable values for its type.
Semantics
Each constant has a type, determined by its form and value, as detailed later.
6.4.5.2 Integer literals
Syntax
- integer-literal:
- decimal-literal integer-suffixopt
- octal-literal integer-suffixopt
- hexadecimal-literal integer-suffixopt
- binary-literal integer-suffixopt
- hexadecimal-prefix: one of
0x 0X
- octal-prefix: one of
0o 0O
- binary-prefix: one of
0b 0B
- nonzero-digit: one of
1 2 3 4 5 6 7 8 9
- hexadecimal-digit: one of
0 1 2 3 4 5 6 7 8 9a b c d e fA B C D E F
- octal-digit: one of
0 1 2 3 4 5 6 7
- binary-digit: one of
0 1
- integer-suffix:
- unsigned-suffix long-suffixopt
- unsigned-suffix long-long-suffix
- unsigned-suffix bit-precise-int-suffix
- long-suffix unsigned-suffixopt
- long-long-suffix unsigned-suffixopt
- bit-precise-int-suffix unsigned-suffixopt
- bit-precise-int-suffix: one of
wb WB
- unsigned-suffix: one of
u U
- long-suffix: one of
l L
- long-long-suffix: one of
ll LL
Description
An integer literal begins with a digit, but has no period or exponent part. It can have a prefix that specifies its base and a suffix that specifies its type. An optional separating single quote character (’) in an integer or floating literal is called a digit separator. Digit separators are ignored when determining the value of the literal.
EXAMPLE 1 The following integer literals use digit separators; the comment associated with each literal shows the equivalent literal without digit separators.
0b11’10’11’01 /* 0b11101101 */ ’1’2 /* character literal ’1’ followed by integer literal 2, not the integer literal 12 */ 11’22 /* 1122 */ 0x’FFFF’FFFF /* invalid hexadecimal literal (’ cannot appear after 0x) */ 0x1’2’3’4AB’C’D /* 0x1234ABCD */
A decimal literal begins with a nonzero digit and consists of a sequence of decimal digits. An octal literal consists of the prefix 0o or 0O followed by a sequence of the digits 0 through 7 only. A hexadecimal literal consists of the prefix 0x or 0X followed by a sequence of the decimal digits and the letters a (or A) through f (or F) with values through respectively. A binary literal consists of the prefix 0b or 0B followed by a sequence of the digits 0 or 1.
An unprefixed octal literal begins with the digit 0 optionally followed by a sequence of the digits 0 through 7 only. Use of an unprefixed octal literal with digits other than 0 is an obsolescent feature.
Semantics
The value of a decimal literal is computed base ; that of an octal literal, base ; that of a hexadecimal literal, base ; that of a binary literal, base . The lexically first digit is the most significant.
The type of an integer literal is the first of the corresponding Table 6.2 in which its value can be represented.
Table 6.2 — Relationship between constants, suffixes, and types
Octal, Hexadecimal or Binary Suffix Decimal Literal Literal none int int long int unsigned int long long int long int unsigned long int long long int unsigned long long int u or U unsigned int unsigned int unsigned long int unsigned long int unsigned long long int unsigned long long int l or L long int long int long long int unsigned long int long long int unsigned long long int Both u or U unsigned long int unsigned long int and l or L unsigned long long int unsigned long long int ll or LL long long int long long int unsigned long long int Both u or U unsigned long long int unsigned long long int and ll or LL
wb or WB _BitInt(N) where the width N _BitInt(N) where the width N is the smallest N greater than 1 is the smallest N greater than 1 which can accommodate which can accommodate the value and the sign bit. the value and the sign bit. Both u or U unsigned _BitInt(N) where unsigned _BitInt(N) where and wb or WB the width N is the smallest N the width N is the smallest N greater than 0 which can greater than 0 which can accommodate the value. accommodate the value.
EXAMPLE 2 The wb suffix results in an _BitInt that includes space for the sign bit even if the value of the literal is positive or was specified in binary, octal, or hexadecimal notation.
-3wb /* Yields a _BitInt(3) that is then arithmetically negated; two value bits, one sign bit */ -0x3wb /* Yields a _BitInt(3) that is then arithmetically negated; two value bits, one sign bit */ 3wb /* Yields a _BitInt(3); two value bits, one sign bit */ 3uwb /* Yields an unsigned _BitInt(2) */ -3uwb /* Yields an unsigned _BitInt(2) that is then arithmetically negated, resulting in wraparound */
6.4.5.3 Floating literals
Syntax
- decimal-floating-literal:
- fractional-literal exponent-partopt floating-suffixopt
- digit-sequence exponent-part floating-suffixopt
- hexadecimal-floating-literal:
- hexadecimal-prefix hexadecimal-fractional-literal
- binary-exponent-part floating-suffixopt
- hexadecimal-prefix hexadecimal-digit-sequence
- binary-exponent-part floating-suffixopt
- exponent-part:
esignopt digit-sequenceEsignopt digit-sequence
- sign: one of
+ -
Constraints
A floating suffix df, dd, dl, DF, DD, or DL shall not be used in a hexadecimal floating literal. A floating suffix shall designate a type that the implementation provides.
Description
A floating literal has a significand part that can be followed by an exponent part and a suffix that specifies its type. The components of the significand part can include a digit sequence representing the whole-number part, followed by a period ( .), followed by a digit sequence representing the fraction part. Digit separators (6.4.5.2) are ignored when determining the value of the literal. The components of the exponent part are an e, E, p, or P followed by an exponent consisting of an optionally signed digit sequence. Either the whole-number part or the fraction part has to be present; for decimal floating literals, either the period or the exponent part has to be present.
Semantics
The significand part is interpreted as a (decimal or hexadecimal) rational number; the digit sequence in the exponent part is interpreted as a decimal integer. For decimal floating literals, the exponent indicates the power of by which the significand part is to be scaled. For hexadecimal floating literals, the exponent indicates the power of by which the significand part is to be scaled. For decimal floating literals, and also for hexadecimal floating literals when FLT_RADIX is not a power of , the result is either the nearest representable value, or the larger or smaller representable value immediately adjacent to the nearest representable value, chosen in an implementation-defined manner. For hexadecimal floating literals when FLT_RADIX is a power of , the result is correctly rounded.
The presence of a complex suffix indicates that the type of the literal is the complex type that corresponds to the type of the literal where the complex suffix is removed. The described floating value of such a complex literal designates the imaginary part of an arithmetic constant expression of the indicated complex type, the real part is (positive) zero.67)
An unsuffixed floating literal has type double. If suffixed by a real floating suffix it has a type according to Table 6.3.
Table 6.3 — Suffixes for floating literals
Suffix Type f, F float l, L long double df, DF _Decimal32 dd, DD _Decimal64 dl, DL _Decimal128
The values of floating literals may be represented in greater range and precision than that required by the type (determined by the suffix); the types are not changed thereby. See 5.3.5.3.3 regarding evaluation formats.68)
Floating literals of decimal floating type that have the same numerical value but different quantum exponents have distinguishable internal representations. The value shall be correctly rounded as specified in ISO/IEC 60559. The coefficient and the quantum exponent of a finite converted decimal floating-point number (see 5.3.5.3.4) are determined as follows:
- is set to the value of signopt digit-sequence in the exponent part, if any, or to , otherwise.
- If there is a fractional literal, is decreased by the number of digits to the right of the period and the period is removed to form a digit sequence.
- is set to the value of the digit sequence (after any period has been removed).
- Rounding required because of insufficient precision or range in the type of the result will round to the full precision available in the type, and will adjust accordingly within the limits of the type, provided the rounding does not yield an infinity (in which case the result is an appropriately signed internal representation of infinity). If the full precision of the type would require to be smaller than the minimum for the type, then is pinned at the minimum and is adjusted through the subnormal range accordingly, perhaps to zero.
Floating literals are converted to internal format as if at translation-time. The conversion of a floating literal shall not raise an exceptional condition or a floating-point exception at execution time. All floating literals of the same source form69) shall convert to the same internal format and, provided they are subject to the same translation-time rounding direction (either the default or a constant rounding mode set by an FENV_ROUND or FENV_DEC_ROUND pragma), to the same value.
EXAMPLE Following are floating literals of type _Decimal64 and their values as triples . For _Decimal64, the precision (maximum coefficient length) is 6 and the quantum exponent range is .
0.dd 0.00dd 123.dd 1.23E3dd 1.23E+3dd 12.3E+7dd 12.0dd 12.3dd 0.00123dd 1.23E-12dd 1234.5E-4dd 0E+7dd 12345678901234567890.dd 4) assuming default rounding and DEC_EVAL_METHOD is or 170)
1234E-400dd assuming default rounding and DEC_EVAL_METHOD is or 1234E-402dd assuming default rounding and DEC_EVAL_METHOD is or 1000.dd .0001dd 1000.e0dd .0001e0dd 1000.0dd 0.0001dd
Recommended practice
The implementation should produce a diagnostic message if a hexadecimal floating literal cannot be represented exactly in its evaluation format; the implementation should then proceed with the translation of the program.
The translation-time conversion of floating literals should match the execution-time conversion of character strings by library functions, such as strtod, given matching inputs suitable for both conversions, the same result format, and default execution-time rounding.71)
NOTE 1 Floating literals do not include a sign and are arithmetically negated by the unary - operator (6.5.4.4) which arithmetically negates the rounded value of the literal. In contrast, the numeric conversion functions in the strto family (7.25.2.6, 7.25.2.7) can include the sign as part of the input value and convert and round the arithmetically negated input; implementations conforming to Annex F have this behavior. Negating before rounding and negating after rounding can yield different results, depending on the rounding direction and whether the results are correctly rounded. For example, the results are the same when both are correctly rounded using rounding to nearest or rounding toward zero, but the results are different when they are inexact and correctly rounded using rounding toward positive infinity or rounding toward negative infinity.
Conversions yielding exact results are not affected by the order of negating and rounding. For types with radix 10, decimal floating literals expressed within the precision and range of the evaluation format convert exactly. For types whose radix is a power of 2, hexadecimal floating literals expressed within the precision and range of the evaluation format convert exactly.
NOTE 2 Because complex literals are of complex type and have a (positive) zero real part, their use is problematic where signed zeros and infinities matter. For example, with ISO/IEC 60559 arithmetic and its default rounding,
-0.0 + 1.0i yields -1.0i yields
INFINITY * 1.0i yields
NaN , and raises the "invalid" floating-point exception when evaluated at execution time
The CMPLX macros in <complex.h> can be used to straightforwardly obtain particular values involving signed zeros and infinities. Corresponding to the preceding cases,
CMPLX(-0.0, 1.0) yields CMPLX(0.0, -1.0) yields CMPLX(0.0, INFINITY) yields
Forward references: preprocessing numbers (6.4.9), numeric conversion functions (7.25.2), the strto function family (7.25.2.6, 7.25.2.7).
6.4.5.4 Enumeration constants
Syntax
Semantics
An identifier declared as an enumeration constant for an enumeration without a fixed underlying type has either type int or the enumerated type, as defined in 6.7.3.3. An identifier declared as an enumeration constant for an enumeration with a fixed underlying type has the associated enumerated type.
An enumeration constant can be used in an expression (or constant expression) wherever a value of an integer type may be used.
6.4.5.5 Character literals
Syntax
- encoding-prefix: one of
u8 u U L
- c-char:
- any member of the source character set except
- the single-quote
’, backslash\, or new-line character - escape-sequence
- escape-sequence:
- simple-escape-sequence
- octal-escape-sequence
- hexadecimal-escape-sequence
- universal-character-name
- simple-escape-sequence: one of
\‘ \" \? \\\a \b \f \n \r \t \v
Description
An ordinary character literal is a sequence of one or more multibyte characters enclosed in singlequotes, as in ’x’. A UTF-8 character literal is the same, except prefixed by u8. Together ordinary and UTF-8 character literal are narrow character literals. A wchar_t character literal is prefixed by the letter L. A UTF-16 character literal is prefixed by the letter u. A UTF-32 character literal is prefixed by the letter U. Collectively, wchar_t, UTF-16, and UTF-32 character literals are called wide character literals. With a few exceptions detailed later, the elements of the sequence are any members of the source character set; they are mapped in an implementation-defined manner to members of the execution character set.
The single-quote ’, the double-quote ", the question-mark ?, the backslash \, and arbitrary integer values are representable according to Table 6.7:
Table 6.7 — Escape sequences
single quote ’ \‘ double quote " \" question mark ? \? backslash \ \\ octal character \octal digits hexadecimal character \x hexadecimal digits
The double-quote " and question-mark ? are representable either by themselves or by the escape sequences \" and \?, respectively, but the single-quote ’ and the backslash \ shall be represented, respectively, by the escape sequences \’ and \\.
The octal digits that follow the backslash in an octal escape sequence are taken to be part of the construction of a single character for a narrow character literal or of a single wide character for a wide character literal. The numerical value of the octal integer so formed specifies the value of the desired character or wide character.
The hexadecimal digits that follow the backslash and the letter x in a hexadecimal escape sequence are taken to be part of the construction of a single character for a narrow character literal or of a single wide character for a wide character literal. The numerical value of the hexadecimal integer so formed specifies the value of the desired character or wide character.
Each octal or hexadecimal escape sequence is the longest sequence of characters that can constitute the escape sequence.
In addition, characters not in the basic character set are representable by universal character names and certain non-graphic characters are representable by escape sequences consisting of the backslash \ followed by a lowercase letter: \a, \b, \f, \n, \r, \t, and \v.72)
Constraints
The value of an octal or hexadecimal escape sequence shall be in the range of representable values for the corresponding type, as dictated by Table 6.8:
Table 6.8 — Types provided by prefixes
Prefix Corresponding Type none unsigned char u8 char8_t L the unsigned type corresponding to wchar_t
- :
uchar16_tUchar32_t
A UTF-8, UTF-16, or UTF-32 character literal shall not contain more than one character.73) The value shall be representable with a single UTF-8, UTF-16, or UTF-32 code unit, respectively.
Semantics
An ordinary character literal has type int. The value of an ordinary character literal containing a single character that maps to a single value in the literal encoding (6.2.9) is the numerical value of the representation of the mapped character in the literal encoding interpreted as an integer. The value of an ordinary character literal containing more than one character (e.g. ’ab’), or containing a character or escape sequence that does not map to a single value in the literal encoding, is implementationdefined. If an ordinary character literal contains a single character or escape sequence, its value is the one that results when an object with type char whose value is that of the single character or escape sequence is converted to type int.
A UTF-8 character literal has type char8_t. If the UTF-8 character literal is not produced through a hexadecimal or octal escape sequence, the value of a UTF-8 character literal is equal to its ISO/IEC 10646 code point value, provided that the code point value can be encoded as a single UTF-8 code unit. Otherwise, the value of the UTF-8 character literal is the numeric value specified in the hexadecimal or octal escape sequence.
A UTF-16 character literal has type char16_t which is an unsigned integer type defined in the <uchar.h> header. If the UTF-16 character literal is not produced through a hexadecimal or octal escape sequence, the value of a UTF-16 character literal is equal to its ISO/IEC 10646 code point value, provided that the code point value can be encoded as a single UTF-16 code unit. Otherwise, the value of the UTF-16 character literal is the numeric value specified in the hexadecimal or octal escape sequence.
A UTF-32 character literal has type char32_t which is an unsigned integer type defined in the <uchar.h> header. If the UTF-32 character literal is not produced through a hexadecimal or octal escape sequence, the value of a UTF-32 character literal is equal to its ISO/IEC 10646 code point value, provided that the code point value can be encoded as a single UTF-32 code unit. Otherwise, the value of the UTF-32 character literal is the numeric value specified in the hexadecimal or octal escape sequence.
A wchar_t character literal has type wchar_t, an integer type defined in the <stddef.h> header. The value of a wchar_t character literal containing a single multibyte character that maps to a single member of the extended execution character set is the wide character corresponding to that multibyte character in the implementation-defined wide literal encoding (6.2.9). The value of a wchar_t character literal containing more than one multibyte character or a single multibyte character that maps to multiple members of the extended execution character set, or containing a multibyte character or escape sequence not represented in the extended execution character set, is implementation-defined.
EXAMPLE 1 The construction ’\0’ is commonly used to represent the null character.
EXAMPLE 2 Implementations that use eight bits for objects that have type char can furnish certain values in an variety of ways. In an implementation in which type char has the same range of values as signed char, the ordinary character literal ’\xFF’ has the value ; if type char has the same range of values as unsigned char, the ordinary character literal ’\xFF’ has the value .
EXAMPLE 3 Even if eight bits are used for objects that have type char, the construction ’\x123’ specifies an ordinary character literal containing only one character, because a hexadecimal escape sequence is terminated only by a non-hexadecimal character. To specify an ordinary character literal containing the two characters whose values are ’\x12’ and ’3’, the construction ’\0223’ can be used, because an octal escape sequence is terminated after three octal digits. (The value of this two-character ordinary character literal is implementationdefined.)
EXAMPLE 4 Even if 12 or more bits are used for objects that have type wchar_t, the construction L’\1234’ specifies the implementation-defined value that results from the combination of the values 0123 and ’4’.
<stddef.h> (7.22), the mbtowc function (7.25.8.3), Unicode utilities <uchar.h> (7.32).6.4.5.6 Predefined constants
Syntax
- predefined-constant:
falsetruenullptr
Description
Some keywords represent constants of a specific value and type.
The keywords false and true are constants of type bool with a value of 0 for false and 1 for true.74)
The keyword nullptr represents a null pointer constant. Details of its type are described in 7.22.3.
6.4.6 String literals
Syntax
- string-literal:
- encoding-prefixopt
"s-char-sequenceopt"
- s-char:
- any member of the source character set except
- the double-quote
", backslash\, or new-line character - escape-sequence
Constraints
If a sequence of adjacent string literal tokens includes prefixed string literal tokens, the prefixed tokens shall all have the same prefix.
Description
An ordinary string literal is a sequence of zero or more multibyte characters enclosed in double-quotes, as in "xyz". A UTF-8 string literal is the same, except prefixed by u8. A wchar_t string literal is the same, except prefixed by L. A UTF-16 string literal is the same, except prefixed by u. A UTF-32 string literal is the same, except prefixed by U. Collectively, wchar_t, UTF-16, and UTF-32 string literals are called wide string literals.
The same considerations apply to each element of the sequence in a string literal as if it were in an narrow character literal (for a character or UTF-8 string literal) or a wide character literal (for a wide string literal), except that the single-quote ’ is representable either by itself or by the escape sequence \’, but the double-quote " shall be represented by the escape sequence \".
Semantics
In translation phase 6 (5.2.1.2), the multibyte character sequences specified by any sequence of adjacent character and identically-prefixed string literal tokens are concatenated into a single multibyte character sequence. If any of the tokens has an encoding prefix, the resulting multibyte
In translation phase 7 (5.2.1.2), a byte or code of value zero is appended to each multibyte character sequence that results from a string literal or literals.75) The multibyte character sequence is then used to initialize an array of static storage duration and length just sufficient to contain the sequence. For ordinary string literals, the array elements have type char, and are initialized with the individual bytes of the multibyte character sequence corresponding to the literal encoding (6.2.9). For UTF-8 string literals, the array elements have type char8_t, and are initialized with the characters of the multibyte character sequence, as encoded in UTF-8. For wide string literals prefixed by the letter L, the array elements have type wchar_t and are initialized with the sequence of wide characters corresponding to the wide literal encoding. For wide string literals prefixed by the letter u or U, the array elements have type char16_t or char32_t, respectively, and are initialized with the sequence of wide characters corresponding to UTF-16 and UTF-32 encoded text, respectively. The value of a string literal containing a multibyte character or escape sequence not represented in the execution character set is implementation-defined. Any hexadecimal escape sequence or octal escape sequence specified in a u8, u, or U string specifies a single char8_t, char16_t, or char32_t value and can result in the full character sequence not being valid UTF-8, UTF-16, or UTF-32.
It is unspecified whether these arrays are distinct provided their elements have the appropriate values. If the program attempts to modify such an array, the behavior is undefined.
EXAMPLE 1 This pair of adjacent ordinary string literals
"\x12" "3"produces a single ordinary string literal containing the two characters whose values are ’\x12’ and ’3’, because escape sequences are converted into single members of the execution character set just prior to adjacent string literal concatenation.
EXAMPLE 2 Each of the sequences of adjacent string literal tokens
"a" "b" L"c" "a" L"b" "c" L"a" "b" L"c" L"a" L"b" L"c"is equivalent to the string literal
L"abc"Likewise, each of the sequences"a" "b" u"c" "a" u"b" "c" u"a" "b" u"c" u"a" u"b" u"c"is equivalent to
u"abc"Forward references: common definitions <stddef.h> (7.22), the mbstowcs function (7.25.9.2), Unicode utilities <uchar.h> (7.32).
6.4.7 Punctuators
Syntax
- punctuator: one of
[]( ){}.->++--&*+-~!/%<<>><><=>===!=^|&&||?:::;...=*=/=%=+=-=<<=>>=&=^=|=,###<::><%%>%:%:%:
Semantics
A punctuator is a symbol that has independent syntactic and semantic significance. Depending on context, it may specify an operation to be performed (which in turn may yield a value or a function designator, produce a side effect, or some combination thereof) in which case it is known as an operator (other forms of operator also exist in some contexts). An operand is an entity on which an operator acts.
In all aspects of the language, the six tokens76)
<: :> <% %> %: %:%:
behave, respectively, the same as the six tokens
[ ] { } # ##
except for their spelling.77)
6.4.8 Header names
Syntax
- h-char:
- any member of the source character set except
- the new-line character and >
- q-char:
- any member of the source character set except
- the new-line character and
"
Semantics
The sequences in both forms of header names are mapped in an implementation-defined manner to headers or external source file names as specified in 6.10.3.
If the characters ’, \, ", //, or /* occur in the sequence between the < and > delimiters, the behavior is undefined. Similarly, if the characters ’, \, //, or /* occur in the sequence between the " delimiters,
EXAMPLE The following sequence of characters:
0x3<1/a.h>1e2 #include <1/a.h> #define const.member@$forms the following sequence of preprocessing tokens (with each individual preprocessing token delimited by a { on the left and a } on the right).
{0x3}{<}{1}{/}{a}{.}{h}{>}{1e2}
{#}{include} {<1/a.h>}
{#}{define} {const}{.}{member}{@}{$}6.4.9 Preprocessing numbers
Syntax
Description
A preprocessing number begins with a digit optionally preceded by a period (.) and may be followed by valid identifier characters and the character sequences e+, e-, E+, E-, p+, p-, P+, or P-.
Preprocessing number tokens lexically include all floating and integer literals.
Semantics
A preprocessing number does not have type or a value; it acquires both after a successful conversion (as part of translation phase 7 (5.2.1.2)) to a floating or integer literal. This notwithstanding for the evaluation of expressions within conditional source inclusion (6.10.2) and to determine the limit parameter for binary resource inclusion (6.10.4), preprocessing numbers which have the form of an integer literal are interpreted as such. For the determination of a line number in a #line directive (6.10.6), digit sequences that match the requirements for a preprocessing number are interpreted as numbers as well and the interpretation is of a decimal integer, even if the leading digit is 0.
6.4.10 Comments
Constraints
A source file shall not end in a partial comment.
Semantics
Except within a character literal, a string literal, or a comment, the characters /* introduce a comment. The contents of such a comment are examined only to identify multibyte characters and to find the characters */ that terminate it.80)
Except within a character literal, a string literal, or a comment, the characters // introduce a comment that includes all multibyte characters up to, but not including, the next new-line character. The contents of such a comment are examined only to identify multibyte characters and to find the terminating new-line character.
EXAMPLE
"a//b" // four-character ordinary string literal #include "//e" // undefined behavior // */ // comment, not syntax error f = g/**//h; // equivalent to f = g / h; //\ i(); // part of a two-line comment /\ / j(); // part of a two-line comment #define glue(x,y) x##y glue(/,/) k(); // syntax error, not comment /*//*/ l(); // equivalent to l(); m = n//**/o + p; // equivalent to m = n + p;
6.5 Expressions
6.5.1 General
Constraints
During lvalue conversion, an lvalue shall not have an incomplete type.
Semantics
An expression is a sequence of operators and operands that specifies computation of a value, or that designates an object or a function, or that generates side effects, or that performs a combination thereof. The value computations of the operands of an operator are sequenced before the value computation of the result of the operator.
If a side effect on a scalar object is unsequenced relative to either a different side effect on the same scalar object or a value computation using the value of the same scalar object, the behavior is undefined. If there are multiple allowable orderings of the subexpressions of an expression, the behavior is undefined if such an unsequenced side effect occurs in any of the orderings.81)
The grouping of operators and operands is indicated by the syntax.82) Except as specified later, side effects and value computations of subexpressions are unsequenced.83)
Some operators (the unary operator ~, and the binary operators <<, >>, &, ^, and |, collectively described as bitwise operators) are required to have operands that have integer type. These operators yield values that depend on the internal representations of integers, and have implementationdefined and undefined aspects for signed types.
If an exceptional condition occurs during the evaluation of an expression (that is, if the result is not mathematically defined or not in the range of representable values for its type), the behavior is undefined.
The effective type of an object that is not a byte array, for an access to its stored value, is the declared type of the object.84) If a value is stored into a byte array through an lvalue having a type that is not a byte type, then the type of the lvalue becomes the effective type of the object for that access and for subsequent accesses that do not modify the stored value. If a value is copied into a byte array using memcpy or memmove, or is copied as an array of byte type, then the effective type of the modified object for that access and for subsequent accesses that do not modify the value is the effective type of the object from which the value is copied, if it has one. For all other accesses to a byte array, the effective type of the object is simply the type of the lvalue used for the access.85)
Following a byte-level copy operation, an object of atomic type (6.7.3.5) has an indeterminate representation and a copy of a FILE (7.24.3) object is not required to serve in place of the original.
An object shall have its stored value accessed only by an lvalue expression that has one of the following types:86)
- a type compatible with the effective type of the object,
- a qualified version of a type compatible with the effective type of the object,
- the signed or unsigned type corresponding to a type compatible with the underlying type of the effective type of the object,
- the signed or unsigned type corresponding to a type compatible with a qualified version of the underlying type of the effective type of the object,
- a byte type, or
- an aggregate or union type that includes one of the aforementioned types among its members (including, recursively, a member of a subaggregate or contained union).
A floating expression may be contracted, that is, evaluated as though it were a single operation, thereby omitting rounding errors implied by the source code and the expression evaluation method.87)
The FP_CONTRACT pragma in <math.h> provides a way to disallow contracted expressions. Otherwise, whether and how expressions are contracted is implementation-defined.88)
Operators involving decimal floating types are evaluated according to the semantics of ISO/IEC 60559, including production of results with the preferred quantum exponent as specified in ISO/IEC 60559.
6.5.2 Primary expressions
Syntax
Constraints
The identifier in an identifier primary expression shall have a visible declaration as an ordinary identifier that declares an object or a function.89)
Semantics
An identifier primary expression designating an object is an lvalue. An identifier primary expression designating a function is a function designator.
A parenthesized expression is a primary expression. Its type, value, and semantics are identical to those of the unparenthesized expression.
A generic selection is a primary expression. Its type, value, and semantics depend on the selected generic association, as detailed in the following subclause.
6.5.2.1 Generic selection
Syntax
- generic-selection:
_Generic(generic-controlling-operand,generic-assoc-list)
Constraints
A generic selection shall have no more than one default generic association. No two generic associations in the same generic selection shall specify compatible types. If the generic controlling operand is an assignment expression, the controlling type of the generic selection expression is the type of the assignment expression as if it had undergone an lvalue conversion,90) array to pointer conversion, or function to pointer conversion. Otherwise, the controlling type of the generic selection expression is the type designated by the type name. The controlling type shall be compatible with at most one of the types named in the generic association list. If a generic selection has no default generic association, its controlling type shall be compatible with exactly one of the types named in its generic association list.
Semantics
The generic controlling operand, size expressions, and typeof operators contained in the type names of generic associations are not evaluated. If a generic selection has a generic association with a type name that is compatible with the controlling type, then the result expression of the generic selection is the expression in that generic association. Otherwise, the result expression of the generic selection is the expression in the default generic association. None of the expressions from any other generic association of the generic selection is evaluated.
The type and value of a generic selection are identical to those of its result expression. It is an lvalue, a function designator, or a void expression if its result expression is, respectively, an lvalue, a function designator, or a void expression.
EXAMPLE 1 A cbrt type-generic macro can be implemented as follows:
#define cbrt(X) _Generic((X), \ long double: cbrtl, \ default: cbrt, \ float: cbrtf \ )(X)
7.29 shows how such a macro can be implemented with the required rounding properties.
EXAMPLE 2 The following two generic selection expressions select different associations because the assignment expression operand undergoes lvalue conversion while the type name operand is unchanged:
int func(const int i) { return _Generic(i, int : 0, // int is selected const int : 1, default : 2) + _Generic(typeof(i), int : 0, const int : 1, // const int is selected default : 2); }
Thus, this function returns 1.
EXAMPLE 3 The following generic selection expressions are valid and all evaluate to 1.
void foo(int n, int m) { _Generic(int[3][2], int[3][*]: 1, int[2][*]: 0); _Generic(int[3][2], int[*][2]: 1, int[*][3]: 0); _Generic(int[3][n], int[3][*]: 1, int[2][*]: 0); _Generic(int[n][m], int[*][*]: 1, char[*][*]: 0); _Generic(int(*)[2], int(*)[*]: 1); }
6.5.3 Postfix operators
6.5.3.1 General
Syntax
6.5.3.2 Array subscripting
Description
A postfix expression followed by an expression in square brackets [] is a subscripted designation of an element of an array. The use of this operator with the first operand of integer type is an obsolescent feature.
Constraints
One of the operands shall have type "pointer to complete object type" or "array of type", the other operand, called the subscript, shall have integer type, and the result has type "type". If one of the two operands has array type and the subscript is an integer constant expression, the value of the subscript shall not be negative.
Semantics
If either operand has pointer type the expression E1[E2] is equivalent to *((E1)+(E2)) and is an lvalue.
Otherwise, let E be the operand of array type and let m be the value of the subscript; the array subscript expression designates the m+1st element of the array designated by E (i.e., the count of the subscript is zero-based, the first element being designated by the subscript ). If E is an lvalue, the expression is an lvalue; otherwise, the expression is not an lvalue and its type is the unqualified, non-atomic version of the array’s element type. m shall not be negative and shall be less than the length of the array or equal to it; it shall only equal the length of the array if the [] operator is followed by zero or more [] operators with subscripts equal to zero and the resulting postfix expression is the operand of the unary & operator or is converted to an expression with pointer type as described in 6.3.3.1.
NOTE Successive subscript operators designate an element of a multidimensional array. If E is an dimensional array () with dimensions , then E denotes an ()-dimensional array with dimensions . It follows from this that arrays are stored in row-major order, that is, the last subscript varies fastest.
EXAMPLE The following snippet has an array object defined by the declaration:
int x[3][5];
Here x is a array of objects of type int; more precisely, x is an array of three element objects, each of which is an array of five objects of type int. The expression x[1] designates the second element of the array x, which is itself an array of five objects of type int. Then x[1][2] designates the third element thereof, which is an int. It is the eighth stored element of the two-dimensional array x.
6.5.3.3 Function calls
Constraints
The expression that denotes the called function91) shall have type pointer to function returning void or returning a complete object type other than an array type.
The number of arguments shall agree with the number of parameters. Each argument shall have a type such that its value may be assigned to an object with the unqualified version of the type of its corresponding parameter.
Semantics
A postfix expression followed by parentheses () containing a possibly empty, comma-separated list of expressions is a function call. The postfix expression denotes the called function. The list of expressions specifies the arguments to the function.
An argument can be an expression of any complete object type. In preparing for the call to a function, the arguments are evaluated, and each parameter is assigned the value of the corresponding argument.92)
If the expression that denotes the called function has type pointer to function returning an object type, the function call expression has the same type as that object type, and has the value determined as specified in 6.8.7.5. Otherwise, the function call has type void.
The arguments are implicitly converted, as if by assignment, to the types of the corresponding parameters, taking the type of each parameter to be the unqualified version of its declared type. The ellipsis notation in a variadic function declarator (6.7.7.4) causes argument type conversion to stop after the last declared parameter, if present. The integer promotions are performed on each trailing
If the function is defined with a type that is not compatible with the type (of the expression) pointed to by the expression that denotes the called function, the behavior is undefined.
There is a sequence point after the evaluations of the function designator and the actual arguments but before the actual call. Every evaluation in the calling function (including other function calls) that is not otherwise specifically sequenced before or after the execution of the body of the called function is indeterminately sequenced with respect to the execution of the called function.93)
Recursive function calls shall be permitted, both directly and indirectly through any chain of other functions.
EXAMPLE In the function call
(*pf[f1()]) (f2(), f3() + f4())
the functions f1, f2, f3, and f4 can be called in any order. All side effects are completed before the function pointed to by pf[f1()] is called.
return statement (6.8.7.5), simple assignment (6.5.17.2).6.5.3.4 Structure and union members
Constraints
The first operand of the . operator shall have an atomic, qualified, or unqualified complete structure or union type, and the second operand shall name a member of that type.
The first operand of the -> operator shall be a pointer to an atomic, qualified, or unqualified complete structure or union type, and the second operand shall name a member of the type pointed to.
Semantics
A postfix expression followed by the . operator and an identifier designates a member of a structure or union object. The value is that of the named member,94) and is an lvalue if the first expression is an lvalue. If the first expression has qualified type, the result has the so-qualified version of the type of the designated member.
A postfix expression followed by the -> operator and an identifier designates a member of a structure or union object. The value is that of the named member of the object to which the first expression points, and is an lvalue.95) If the first expression is a pointer to a qualified type, the result has the so-qualified version of the type of the designated member.
One special guarantee is made to simplify the use of unions: if a union contains several structures that share a common initial sequence (see following sentence), and if the union object currently contains one of these structures, it is permitted to inspect the common initial part of any of them anywhere that a declaration of the completed type of the union is visible. Two structures share a common initial sequence if corresponding members have compatible types (and, for bit-fields, the same widths) for a sequence of one or more initial members.
EXAMPLE 1 If f is a function returning a structure or union, and x is a member of that structure or union, f().x is a valid postfix expression but is not an lvalue.
EXAMPLE 2 In:
struct s { int i; const int ci; }; struct s s; const struct s cs; volatile struct s vs;
EXAMPLE 3 The following is a valid fragment:
union { struct { int alltypes; } n; struct { int type; int intnode; } ni; struct { int type; double doublenode; } nf; } u; u.nf.type = 1; u.nf.doublenode = 3.14; /* ... */ if (u.n.alltypes == 1) if (sin(u.nf.doublenode) == 0.0) /* ... */The following is not a valid fragment (because the union type is not visible within function
f):struct t1 { int m; }; struct t2 { int m; }; int f(struct t1 *p1, struct t2 *p2) { if (p1->m < 0) p2->m = -p2->m; return p1->m; } int g() { union { struct t1 s1; struct t2 s2; } u; /* ... */ return f(&u.s1, &u.s2); }
Forward references: address and indirection operators (6.5.4.3), structure and union specifiers (6.7.3.2).
6.5.3.5 Postfix increment and decrement operators
Constraints
The operand of the postfix increment or decrement operator shall have atomic, qualified, or unqualified arithmetic or pointer type, and shall be a modifiable lvalue.
Semantics
The result of the postfix ++ operator is the value of the operand. As a side effect, the value of the operand object is incremented by the adjustment. See the discussions of additive operators and compound assignment for information on constraints, types, and conversions and the effects of operations on pointers. The value computation of the result is sequenced before the side effect of updating the stored value of the operand. With respect to an indeterminately sequenced function call, the operation of postfix ++ is a single evaluation. Postfix ++ on an object with atomic type is a read-modify-write operation with memory_order_seq_cst memory order semantics.97)
The adjustment used to increment or decrement the operand is the value 1 with a type and value representation as follows:
- if the operand has a pointer type, the adjustment has type
ptrdiff_t; - if the operand has complex type, the adjustment has the corresponding real type of the operand;
- if the operand has decimal floating type, the adjustment has the same type as the operand with a quantum exponent of
0; - otherwise, the adjustment has the same type as the operand.
The postfix -- operator is analogous to the postfix ++ operator, except that the value of the operand is decremented by the adjustment.
6.5.3.6 Compound literals
Syntax
Constraints
The type name shall specify a complete object type or an array of unknown size, but not a variable length array type.
If the compound literal is associated with file scope or block scope (see 6.2.1) the storage-class specifiers SC (possibly empty),98) type name T, and initializer list, if any, shall be such that they are valid specifiers for an object definition in file scope or block scope, respectively, of the following form,
SC typeof(T) ID = { IL };
where ID is an identifier that is unique for the whole program and where IL is a (possibly empty) initializer list with nested structure, designators, values and types as the initializer list of the compound literal. All the constraints for storage-class specifiers in 6.7.2 also apply correspondingly to compound literals. If the compound literal is associated with function prototype scope, constraints as if in block scope apply.
Semantics
For a compound literal associated with function prototype scope:
- the type is determined as if in block scope and no object is created;
- if it is a compound literal constant it is evaluated at translation time;
- if it is not a compound literal constant, neither the compound literal as a whole nor any of the initializers are evaluated.
Otherwise, a compound literal provides access to an unnamed object whose value, type, storage duration, initializer, and other properties are as if given by the definition syntax in the constraints.
If the storage duration is automatic, the lifetime of the instance of the unnamed object is the current execution of the enclosing block.99)
If the storage-class specifiers are absent or contain constexpr, static, register, or thread_local the behavior is as if the object were declared and initialized in the corresponding scope with these storage-class specifiers; if another storage-class specifier is present, the behavior is undefined. If the storage-class specifier constexpr is present, the initializer is evaluated at translation time. Otherwise, if the storage duration is automatic, the initializer is evaluated at each evaluation of the compound literal; if the storage duration is static or thread the initializer is (as if) evaluated once prior to program startup.
The value of the compound literal is that of an lvalue corresponding to the unnamed object.
String literals, and compound literals with const-qualified types, including those specified with constexpr, are not required to designate distinct objects.101)
EXAMPLE 1 The following two functions can be used as an example:
int f(int*); int g(char * para[f((int[27]){ 0, })]) { /* ... */ return 0; }
Here, each call to g creates an unnamed object of type int[27] to determine the variably modified type of para for the duration of the call. During that determination, a pointer to the object is passed into a call to the function f. If a pointer to the object is kept by f, access to that object is possible during the whole execution of
EXAMPLE 2 The file scope definition
int *p = (int []){2, 4};
initializes p to point to the first element of an array of two ints, the first having the value two and the second having the value four. The expressions in this compound literal are expected to be constant. The unnamed object has static storage duration.
EXAMPLE 3 In contrast, in
void f(void) { int *p; /* ... */ p = (int [2]){*p}; /* ... */ }
p is assigned the address of the first element of an array of two ints, the first having the value previously pointed to by p and the second, zero. The initializer expression in this compound literal is not required to be constant. The unnamed object has automatic storage duration.
EXAMPLE 4 Initializers with designations can be combined with compound literals. Structure objects created using compound literals can be passed to functions without depending on member order:
drawline((struct point){.x=1, .y=1}, (struct point){.x=3, .y=4});Or, if
drawline instead expected pointers to struct point:drawline(&(struct point){.x=1, .y=1}, &(struct point){.x=3, .y=4});
EXAMPLE 5 A read-only compound literal can be specified through constructions like:
(const float []){1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6}EXAMPLE 6 The following three expressions have different meanings:
"/tmp/fileXXXXXX" (char []){"/tmp/fileXXXXXX"} (const char []){"/tmp/fileXXXXXX"}
The first always has static storage duration and has type array of char, but can be modifiable; the last two have automatic storage duration when they occur within the body of a function, and the first of these two is modifiable.
EXAMPLE 7 Like string literals, const-qualified compound literals can be placed into read-only memory and can even be shared. For example,
(const char []){"abc"} == "abc"
can yield 1 if the literals’ storage is shared.
EXAMPLE 8 Because compound literals are unnamed, a single compound literal cannot specify a circularly linked object. For example, there is no way to write a self-referential compound literal that can be used as the function argument in place of the named object endless_zeros in the following snippet:
struct int_list { int car; struct int_list *cdr; }; struct int_list endless_zeros = {0, &endless_zeros}; eval(endless_zeros);
EXAMPLE 9 Each compound literal creates only a single object in a given scope:
struct s { int i; }; int f (void) { struct s *p = 0, *q; int j = 0; again: q = p, p = &((struct s){ j++ }); if (j < 2) goto again; return p == q && q->i == 1; }
The function f() always returns the value .
If an iteration statement were used instead of an explicit goto and a label, the lifetime of the unnamed object would be the body of the loop only, and on entry next time around p would have indeterminate representation, which would result in undefined behavior.
6.5.4 Unary operators
6.5.4.1 General
Syntax
- unary-expression:
- postfix-expression
++unary-expression-unary-expression- unary-operator cast-expression
_Countofunary-expression_Countof (type-name)sizeofunary-expressionsizeof (type-name)alignof (type-name)
- unary-operator: one of
&*+-~!
6.5.4.2 Prefix increment and decrement operators
Constraints
The operand of the prefix increment or decrement operator shall have atomic, qualified, or unqualified arithmetic or pointer type, and shall be a modifiable lvalue.
Semantics
The value of the operand of the prefix ++ operator is incremented. The result is the new value of the operand after incrementation. The expression ++E is similar to (E+=1), except where the value 1 is of the adjustment (6.5.3.5). See the discussions of additive operators and compound assignment for information on constraints, types, side effects, and conversions and the effects of operations on pointers.
The prefix -- operator is analogous to the prefix ++ operator, except that the value of the operand is decremented.
6.5.4.3 Address and indirection operators
Constraints
The operand of the unary & operator shall be either a function designator, the result of a [] or unary
* operator, or an lvalue that designates an object that is not a bit-field and is not declared with the register storage-class specifier.
The operand of the unary * operator shall have pointer type.
Semantics
The unary & operator yields the address of its operand. If the operand has type "type", the result has type "pointer to type". If the operand is the result of a unary * operator, neither that operator nor the & operator is evaluated and the result is as if both were omitted, except that the constraints on the operators still apply and the result is not an lvalue. Similarly, if the operand is the result of a [] operator, neither the & operator nor the access to the value that is implied by the [] is evaluated and the result is as if the & operator were removed and the [] operator were changed to a + operator. Otherwise, the result is a pointer to the object or function designated by its operand.
The unary * operator denotes indirection. If the operand points to a function, the result is a function designator; if it points to an object, the result is an lvalue designating the object. If the operand has type "pointer to type", the result has type "type". If an invalid value has been assigned to the pointer, the behavior of the unary * operator is undefined.102)
6.5.4.4 Unary arithmetic operators
Constraints
The operand of the unary + or - operator shall have arithmetic type; of the ~ operator, integer type; of the ! operator, scalar type.
Semantics
The result of the unary + operator is the value of its (promoted) operand. The integer promotions are performed on the operand, and the result has the promoted type.
The result of the unary - operator is the negative of its (promoted) operand. The integer promotions are performed on the operand, and the result has the promoted type.
The result of the ~ operator is the bitwise complement of its (promoted) operand (that is, each bit in the result is set if and only if the corresponding bit in the converted operand is not set). The integer promotions are performed on the operand, and the result has the promoted type. If the promoted type is an unsigned type, the expression ~E is equivalent to the maximum value representable in that type minus E.
The result of the logical negation operator ! is if the value of its operand compares unequal to , if the value of its operand compares equal to . The result has type int. The expression !E is equivalent to (0==E).
6.5.4.5 The sizeof, _Countof, and alignof operators
Constraints
The sizeof operator shall not be applied to an expression that has function type or an incomplete type, to the parenthesized name of such a type, or to an expression that designates a bit-field member. The _Countof operator shall only be applied to an expression that has a complete array type, or to the parenthesized name of such a type. The alignof operator shall be applied to a complete object type or an array thereof.
Semantics
The sizeof operator yields the size (in bytes) of its operand, which can be an expression or the parenthesized name of a type. The size is determined from the type of the operand. The result is an integer. If the type of the operand does not have a known constant size, the operand is evaluated; otherwise, the operand is not evaluated and the expression is an integer constant expression.
The alignof operator yields the alignment requirement of its operand type. The operand is not evaluated and the expression is an integer constant expression. When applied to an array type, the result is the alignment requirement of the element type.
When sizeof is applied to an operand that has type char, unsigned char, or signed char, (or a qualified version thereof) the result is 1. When applied to an operand that has array type, the result is the total number of bytes in the array.103) When applied to an operand that has structure or union type, the result is the total number of bytes in such an object, including internal and trailing padding.
The _Countof operator yields the number of elements of its operand. The number of elements is determined from the type of the operand. The result is an integer. If the number of elements of the array type is variable, the operand is evaluated; otherwise, the operand is not evaluated and the expression is an integer constant expression.
The value of the result of all operators is implementation-defined, and its type (an unsigned integer type) is size_t, defined in <stddef.h> (and other headers).
EXAMPLE 1 A principal use of the sizeof operator is in communication with routines such as storage allocators and I/O systems. A storage-allocation function can accept a size (in bytes) of an object to allocate and return a pointer to void. For example:
extern void *alloc(size_t); double *dp = alloc(sizeof *dp);
The implementation of the alloc function presumably ensures that its return value is aligned suitably for conversion to a pointer to double.
EXAMPLE 2 The use of _Countof operator is to compute the number of elements in an array. Similar results can be computed from the sizeof operator, but the _Countof operator is more concise and is encouraged:
double array[42]; static_assert(_Countof array == 42); // number of elements static_assert(sizeof array == _Countof array * sizeof(double)); /* number of bytes in a one-dimensional array */ static_assert(_Countof array == sizeof array / sizeof array[0]); // equivalentThe
_Countof operator only computes the number of elements in the array of the outermost dimension, which is not the same as sizeof:double array[4][42]; static_assert(_Countof array == 4); // number of elements in // the last array’s dimension static_assert(sizeof array != _Countof array * sizeof(double)); /* NOT equivalent; sizeof is the byte size of the whole multidimensional array object */ static_assert(_Countof array == sizeof array / sizeof array[0]); // equivalent
EXAMPLE 3 In this example, the size of a variable length array is computed and returned from a function:
#include <stddef.h> size_t fsize3(int n) { char b[n+3]; // variable length array return sizeof b; // execution time sizeof } int main(void) { size_t size; size = fsize3(10); // fsize3 returns 13 return 0; }
EXAMPLE 4 The alignof operator can be applied to an incomplete array type, as shown in the following snippet:
int a1 = alignof(int[]); // Ok int a2 = alignof(int[][1]); // Ok
<stddef.h> (7.22), declarations (6.7), structure and union specifiers (6.7.3.2), type names (6.7.8), array declarators (6.7.7.3).6.5.5 Cast operators
Syntax
Constraints
Unless the type name specifies a void type, the type name shall specify atomic, qualified, or unqualified scalar type, and the operand shall have scalar type.
Conversions that involve pointers, other than where permitted by the constraints of 6.5.17.2, shall be specified by means of an explicit cast.
A pointer type shall be converted only to void, an integer type, or a pointer type. Only a pointer, integer, or nullptr_t type shall be converted to a pointer type. The type nullptr_t shall not be converted to any type other than void, bool or a pointer type. If the target type is nullptr_t, the cast expression shall be a null pointer constant or have type nullptr_t.
Semantics
Size expressions and typeof operators contained in a type name used with a cast operator are evaluated whenever the cast expression is evaluated.
Preceding an expression by a parenthesized type name converts the value of the expression to the unqualified, non-atomic version of the named type. This construction is called a cast.104) A cast that specifies no conversion has no effect on the type or value of an expression.
If the value of the expression is represented with greater range or precision than required by the type named by the cast (6.3.2.8), then the cast specifies a conversion even if the type of the expression is the same as the named type and removes any extra range and precision.
6.5.6 Multiplicative operators
Syntax
Constraints
Each of the operands shall have arithmetic type. The operands of the % operator shall have integer type.
If either operand has decimal floating type, the other operand shall not have standard floating type, or complex type type.
Semantics
The usual arithmetic conversions are performed on the operands.
The result of the binary * operator is the product of the operands.
The result of the / operator is the quotient from the division of the first operand by the second; the result of the % operator is the remainder. In both operations, if the value of the second operand is zero, the behavior is undefined.
When integers are divided, the result of the / operator is the algebraic quotient with any fractional part discarded.105) If the quotient a/b is representable, the expression (a/b)*b + a%b shall equal a; otherwise, the behaviors of both a/b and a%b are undefined.
In the following, the result and any floating-point exceptions are completely specified by the realvalued operations in the definition.
- The
*operator where one operand is real with value and the other operand is complex with value is defined by . - The
/operator where the first operand is complex with value and the second operand is real with value is defined by .
In the following, the real and imaginary parts of the result approximate the real and imaginary parts, respectively, of the mathematical formula to be computed. The formulas do not indicate how the results are to be evaluated, nor do they necessarily give desirable results when infinities or NaNs are involved (see Annex G).
- The
*operator where both operands are complex with values and computes . - The
/operator where both operands are complex with values and computes . - The
/operator where the first operand is real with value and the second operand is complex with value computes .
Recommended practice
The * operator where both operands are complex should be commutative (that is, for complex values and , and are equivalent). The * operator where both operands are complex, the / operator where both operands are complex, and the / operator where the first operand is real and the second operand is complex should compute their results without undue overflow or underflow (see 7.3.4).
6.5.7 Additive operators
Syntax
Constraints
For addition, either both operands shall have arithmetic type, or one operand shall be a pointer to a complete object type and the other shall have integer type. (Incrementing is equivalent to adding 1.)
For subtraction, one of the following shall hold:
- both operands have arithmetic type;
- both operands are pointers to qualified or unqualified versions of compatible complete object types; or
- the left operand is a pointer to a complete object type and the right operand has integer type.
(Decrementing is equivalent to subtracting 1.)
If either operand has decimal floating type, the other operand shall not have standard floating type, or complex type.
Semantics
If both operands have arithmetic type, the usual arithmetic conversions are performed on them.
The result of the binary + operator is the sum of the operands.
The result of the binary - operator is the difference resulting from the subtraction of the second operand from the first.
For the purposes of these operators, a pointer to an object that is not an element of an array behaves the same as a pointer to the first element of an array of length one with the type of the object as its element type.
When an expression that has integer type is added to or subtracted from a pointer, the result has the type of the pointer operand. If the pointer operand points to an element of an array object, and the array is large enough, the result points to an element offset from the original element such that the difference of the subscripts of the resulting and original array elements equals the integer expression. In other words, if the expression P points to the th element of an array object, the expressions (P)+N (equivalently, N+(P)) and (P)-N (where N has the value ) point to, respectively, the th and th elements of the array object, provided they exist. Moreover, if the expression P points to the last element of an array object, the expression (P)+1 points one past the last element of the array object, and if the expression Q points one past the last element of an array object, the expression (Q)-1 points to the last element of the array object. If the pointer operand is not null, and the pointer operand and result do not point to elements of the same array object or one past the last element of the array object, the behavior is undefined. If the pointer operand is a null pointer value and the integer operand is nonzero, the behavior is undefined.106) If the addition or subtraction produces an overflow, the behavior is undefined. If the pointer operand is null or the result points one past the last element of the array object, it shall not be used as the operand of a unary * operator that is evaluated.
When two pointers are subtracted, both shall be null pointer values, point to elements of the same array object, or one past the last element of the array object. If both pointers are null pointer values, the result is zero. Otherwise, the result is the difference of the subscripts of the two array elements.
NOTE Another way to approach pointer arithmetic is first to convert the pointer(s) to character pointer(s): In this scheme the integer expression added to or subtracted from the converted pointer is first multiplied by the size of the object originally pointed to, and the resulting pointer is converted back to the original type. For pointer subtraction, the result of the difference between the character pointers is similarly divided by the size of the object originally pointed to. When viewed in this way, an implementation need only provide one extra byte (which can overlap another object in the program) just after the end of the object to satisfy the "one past the last element" requirements.
EXAMPLE Pointer arithmetic is well defined with pointers to variable length array types.
{
int n = 4, m = 3;
int a[n][m];
int (*p)[m] = a; // p == &a[0]
p += 1; // p == &a[1]
(*p)[2] = 99; // a[1][2] == 99
n = p - a; // n == 1
}If array a in the preceding example were declared to be an array of known constant size, and pointer p were declared to be a pointer to an array of the same known constant size (pointing to a), the results would be the same.
In the following, the result and any floating-point exceptions are completely specified by the realvalued operations in the definition.
- The
+operator where both operands are complex with values and is defined by . - The
+operator where one operand is real with value and the other operand is complex with value is defined by . - The
-operator where the first operand is complex with value and the second operand is complex with value is defined by . - The
-operator where the first operand is real with value and the second operand is complex with value is defined by . - The
-operator where the first operand is complex with value and the second operand is real with value is defined by .
6.5.8 Bitwise shift operators
Syntax
Constraints
Each of the operands shall have integer type.
Semantics
The integer promotions are performed on each of the operands. The type of the result is that of the promoted left operand. If the value of the right operand is negative or is greater than or equal to the width of the promoted left operand, the behavior is undefined.
The result of E1 << E2 is E1 left-shifted E2 bit positions; vacated bits are filled with zeros. If E1 has an unsigned type, the value of the result is E1 E2, wrapped around. If E1 has a signed type and nonnegative value, and E1 E2 is representable in the result type, then that is the resulting value; otherwise, the behavior is undefined.
The result of E1 >> E2 is E1 right-shifted E2 bit positions. If E1 has an unsigned type or if E1 has a signed type and a nonnegative value, the value of the result is the integral part of the quotient of E1E2. If E1 has a signed type and a negative value, the resulting value is implementation-defined.
6.5.9 Relational operators
Syntax
Constraints
One of the following shall hold:
- both operands have real type; or
- both operands are pointers to qualified or unqualified versions of compatible object types.
If either operand has decimal floating type, the other operand shall not have standard floating type.
Semantics
If both of the operands have arithmetic type, the usual arithmetic conversions are performed. Positive zeros compare equal to negative zeros.
For the purposes of these operators, a pointer to an object that is not an element of an array behaves the same as a pointer to the first element of an array of length one with the type of the object as its element type.
When two pointers are compared, the result depends on the relative locations in the address space of the objects pointed to, if any. If two pointers to object types are both null pointer values, both point to the same object, or both point one past the last element of the same array object, they compare equal. If the objects pointed to are members of the same aggregate object, pointers to structure members declared later compare greater than pointers to members declared earlier in the structure, and pointers to array elements with larger subscript values compare greater than pointers to elements of the same array with lower subscript values. All pointers to members of the same union object compare equal. If the expression P points to an element of an array object and the expression Q points to the last element of the same array object, the pointer expression Q+1 compares greater than P. In all other cases, the behavior is undefined.
Each of the operators < (less than), > (greater than), <= (less than or equal to), and >= (greater than or equal to) shall yield 1 if the specified relation is true and 0 if it is false.107) The result has type int.
6.5.10 Equality operators
Syntax
Constraints
One of the following shall hold:
- both operands have arithmetic type;
- both operands are pointers to qualified or unqualified versions of compatible types;
- one operand is a pointer to an object type and the other is a pointer to a qualified or unqualified version of
void; - both operands have type
nullptr_t; - one operand has type
nullptr_tand the other is a null pointer constant; or, - one operand is a pointer and the other is a null pointer constant or has type
nullptr_t.
If either operand has decimal floating type, the other operand shall not have standard floating type, or complex type.
Semantics
The == (equal to) and != (not equal to) operators are analogous to the relational operators except for their lower precedence.108) Each of the operators yields if the specified relation is true and if it is false. The result has type int. For any pair of operands, exactly one of the relations is true.
If both of the operands have arithmetic type, the usual arithmetic conversions are performed. Positive zeros compare equal to negative zeros. Values of complex types are equal if and only if both their real parts are equal and also their imaginary parts are equal. Any two values of arithmetic types from different type domains are equal if and only if the results of their conversions to the (complex) result type determined by the usual arithmetic conversions are equal. If both operands have type nullptr_t or one operand has type nullptr_t and the other is a null pointer constant, they compare equal.
Otherwise, at least one operand is a pointer. If one operand is a pointer and the other is a null pointer constant or has type nullptr_t, they compare equal if the former is a null pointer. If one operand is a pointer to an object type and the other is a pointer to a qualified or unqualified version of void, the former is converted to the type of the latter.
Two pointers compare equal if and only if both are null pointers, both are pointers to the same object (including a pointer to an object and a subobject at its beginning) or function, both are pointers to one past the last element of the same array object, or one is a pointer to one past the end of one array object and the other is a pointer to the start of a different array object that happens to immediately follow the first array object in the address space.109)
For the purposes of these operators, a pointer to an object that is not an element of an array behaves the same as a pointer to the first element of an array of length one with the type of the object as its element type.
6.5.11 Bitwise AND operator
Syntax
- AND-expression:
- equality-expression
- AND-expression
&equality-expression
Constraints
Each of the operands shall have integer type.
Semantics
The usual arithmetic conversions are performed on the operands.
The result of the binary & operator is the bitwise AND of the operands (that is, each bit in the result is set if and only if each of the corresponding bits in the converted operands is set).
6.5.12 Bitwise exclusive OR operator
Syntax
- exclusive-OR-expression:
- AND-expression
- exclusive-OR-expression
^AND-expression
Constraints
Each of the operands shall have integer type.
Semantics
The usual arithmetic conversions are performed on the operands.
The result of the ^ operator is the bitwise exclusive OR of the operands (that is, each bit in the result is set if and only if exactly one of the corresponding bits in the converted operands is set).
6.5.13 Bitwise inclusive OR operator
Syntax
Constraints
Each of the operands shall have integer type.
Semantics
The usual arithmetic conversions are performed on the operands.
The result of the | operator is the bitwise inclusive OR of the operands (that is, each bit in the result is set if and only if at least one of the corresponding bits in the converted operands is set).
6.5.14 Logical AND operator
Syntax
Constraints
Each of the operands shall have scalar type.
Semantics
The && operator shall yield 1 if both of its operands compare unequal to 0; otherwise, it yields 0. The result has type int.
Unlike the bitwise binary & operator, the && operator guarantees left-to-right evaluation; if the second operand is evaluated, there is a sequence point between the evaluations of the first and second operands. If the first operand compares equal to 0, the second operand is not evaluated.
6.5.15 Logical OR operator
Syntax
Constraints
Each of the operands shall have scalar type.
Semantics
The || operator shall yield 1 if either of its operands compare unequal to 0; otherwise, it yields 0. The result has type int.
Unlike the bitwise | operator, the || operator guarantees left-to-right evaluation; if the second operand is evaluated, there is a sequence point between the evaluations of the first and second operands. If the first operand compares unequal to 0, the second operand is not evaluated.
6.5.16 Conditional operator
Syntax
Constraints
The first operand shall have scalar type.
One of the following shall hold for the second and third operands:110)
- both operands have arithmetic type;
- both operands have compatible structure or union type;
- both operands have void type;
- both operands are pointers to qualified or unqualified versions of compatible types;
- both operands have
nullptr_ttype; - one operand is a pointer and the other is a null pointer constant or has type
nullptr_t; or - one operand is a pointer to an object type and the other is a pointer to a qualified or unqualified version of
void.
If either of the second or third operands has decimal floating type, the other operand shall not have standard floating type, or complex type.
If one operand is a pointer to a variably modified type and the other operand is a null pointer constant or has type nullptr_t, the variably modified type shall not depend on array length expressions that would remain unevaluated when the corresponding operand is not evaluated. When recursively forming a composite type to determine the result type, no composite type shall be formed from an array of unknown length that is not part of a declaration for a function parameter and an array whose length expression remains unevaluated when the corresponding operand is not evaluated.
Semantics
The first operand is evaluated; there is a sequence point between its evaluation and the evaluation of the second or third operand (whichever is evaluated). The second operand is evaluated only if the first compares unequal to ; the third operand is evaluated only if the first compares equal to ; the result is the value of the second or third operand (whichever is evaluated), converted to the type described subsequently in this subclause.111)
If the second and third operands have arithmetic type, the result type is the same as if the usual arithmetic conversions were applied to both operands. If both the operands have structure or union type, the result is the composite type. If both operands have void type, the result has void type.
If both the second and third operands are pointers, the result type is a pointer to a type qualified with all the type qualifiers of the types referenced by both operands; if one is a null pointer constant (other than a pointer) or has type nullptr_t and the other is a pointer, the result type is the pointer type; if both the second and third operands have nullptr_t type, the result also has that type. Furthermore, if both operands are pointers to compatible types or to differently qualified versions of compatible types, the result type is a pointer to an appropriately qualified version of the composite type; if one operand is a null pointer constant, the result has the type of the other operand; otherwise, one operand is a pointer to void or a qualified version of void, in which case the result type is a pointer to an appropriately qualified version of void.
All array length expressions that are not an integer constant expression and which are part of the type of the operand that is not evaluated are treated as unspecified lengths in the determination of type compatibility and when forming the composite type according to 6.2.7.
EXAMPLE 1 The common type that results when the second and third operands are pointers is determined in two independent stages. The appropriate qualifiers, for example, do not depend on whether the two pointers have compatible types.
Given the declarations
const void *c_vp; void *vp; const int *c_ip; volatile int *v_ip; int *ip; const char *c_cp;
the third column in the Table 6.9 is the common type that is the result of a conditional expression in which the first two columns are the second and third operands (in either order):
Table 6.9 — Common type for conditional expression evaluations
c_vp c_ip const void * v_ip 0 volatile int * c_ip v_ip const volatile int * vp c_cp const void * ip c_ip const int *
- :
vpipvoid*
EXAMPLE 2 Both conditional expressions in the foo function are constraint violations.
void foo(bool cond, void* p1, void* p2) { int n = 2; // An array whose length might not be evaluated is // a constraint violation auto a = cond ? nullptr : (char(*)[n])p1; // Forming the composite type of an array of unknown length and an // array whose length might not be evaluated is a constraint // violation auto b = cond ? (char(*)[ ])p1 : (char(*)[n])p2; }
EXAMPLE 3 All conditional expressions in the foo function have defined behavior.
void foo(bool cond, void *p1, void *p2) { int n = 2; int m = 3; char (*a)[3] = // known constant length cond ? (char(*)[3])p1 : (char(*)[m])p2; char (*b)[cond ? n : m] = // active branch length cond ? (char(*)[n])p1 : (char(*)[m])p2; char (*p3)[ ] = p1; char (*p4)[m] = p2; char (*c)[m] = cond ? nullptr : p4; // previously evaluated char (*d)[m] = cond ? p3 : p4; // previously evaluated }
6.5.17 Assignment operators
6.5.17.1 General
Syntax
- assignment-expression:
- conditional-expression
- unary-expression assignment-operator assignment-expression
- assignment-operator: one of
=*=/=%=+=-=<<=>>=&=^=|=
Constraints
An assignment operator shall have a modifiable lvalue as its left operand.
Semantics
An assignment operator stores a value in the object designated by the left operand. An assignment expression has the value of the left operand after the assignment,112) but is not an lvalue. The type of an assignment expression is the type the left operand would have after lvalue conversion. The side effect of updating the stored value of the left operand is sequenced after the value computations of the left and right operands. The evaluations of the operands are unsequenced.
6.5.17.2 Simple assignment
Constraints
One of the following shall hold:113)
- the left operand has atomic, qualified, or unqualified arithmetic type, and the right operand has arithmetic type;
- the left operand has an atomic, qualified, or unqualified version of a structure or union type compatible with the type of the right operand;
- the left operand has atomic, qualified, or unqualified pointer type, and (considering the type the left operand would have after lvalue conversion) both operands are pointers to qualified or unqualified versions of compatible types, and the type pointed to by the left operand has all the qualifiers of the type pointed to by the right operand;
- the left operand has atomic, qualified, or unqualified pointer type, and (considering the type the left operand would have after lvalue conversion) one operand is a pointer to an object type, and the other is a pointer to a qualified or unqualified version of
void, and the type pointed to by the left operand has all the qualifiers of the type pointed to by the right operand; - the left operand has an atomic, qualified, or unqualified version of the
nullptr_ttype and the right operand is a null pointer constant or its type isnullptr_t; - the left operand is an atomic, qualified, or unqualified pointer, and the right operand is a null pointer constant or its type is
nullptr_t; or - the left operand has type atomic, qualified, or unqualified
bool, and the right operand is a pointer or its type isnullptr_t.
Semantics
In simple assignment (=), the value of the right operand is converted to the type of the assignment expression and replaces the value stored in the object designated by the left operand.114)
If the value being stored in an object is read from another object that overlaps in any way the storage of the first object, then the two objects shall occupy exactly the same storage and shall have qualified or unqualified versions of a compatible type; otherwise, the behavior is undefined.
EXAMPLE 1 In the program fragment
int f(void); char c; /* ... */ if ((c = f()) == -1) /* ... */
the int value returned by the function can be truncated when stored in the char, and then converted back to int width prior to the comparison. In an implementation in which "plain" char has the same range of values as unsigned char (and char is narrower than int), the result of the conversion cannot be negative, so the operands of the comparison can never compare equal. Therefore, for full portability, the variable c would be declared as int.
EXAMPLE 3 The following fragment can be used as an example:
const char **cpp; char *p; const char c = ’A’; cpp = &p; // constraint violation *cpp = &c; // valid *p = 0; // valid
The first assignment is unsafe because it would allow the following valid code to attempt to change the value of the const object c.
6.5.17.3 Compound assignment
Constraints
For the operators += and -= only, either the left operand shall be an atomic, qualified, or unqualified pointer to a complete object type, and the right shall have integer type; or the left operand shall have atomic, qualified, or unqualified arithmetic type, and the right shall have arithmetic type.
For the other operators, the left operand shall have atomic, qualified, or unqualified arithmetic type, and (considering the type the left operand would have after lvalue conversion) each operand shall have arithmetic type consistent with those allowed by the corresponding binary operator.
If either operand has decimal floating type, the other operand shall not have standard floating type, or complex type.
Semantics
A compound assignment of the form E1 op= E2 is equivalent to the simple assignment expression E1 = E1 op (E2), except that the lvalue E1 is evaluated only once, and with respect to an indeterminately sequenced function call, the operation of a compound assignment is a single evaluation. If E1 has an atomic type, compound assignment is a read-modify-write operation with memory_order_seq_cst memory order semantics.
NOTE Where a pointer to an atomic object can be formed and E1 and E2 have integer type, this is equivalent to the following code sequence where T1 is the type of E1 and T2 is the type of E2:
T1 *addr = &E1; T2 val = (E2); T1 old = *addr; T1 new; do { new = old op val; } while (!atomic_compare_exchange_strong(addr, &old, new));
with new being the result of the operation.
If E1 or E2 has floating type, then exceptional conditions or floating-point exceptions encountered during discarded evaluations of new would also be discarded to satisfy the equivalence of E1 op= E2 and E1 = E1 op (E2). For example, if Annex F is in effect, the floating types involved have ISO/IEC 60559 binary formats, and FLT_EVAL_METHOD is 0, the equivalent code would be:
#include <fenv.h> #pragma STDC FENV_ACCESS ON /* ... */ fenv_t fenv; T1 *addr = &E1; T2 val = E2; T1 old = *addr; T1 new; feholdexcept(&fenv); for (;;) { new = old op val; if (atomic_compare_exchange_strong(addr, &old, new)) break; feclearexcept(FE_ALL_EXCEPT); } feupdateenv(&fenv);
6.5.18 Comma operator
Syntax
Semantics
The left operand of a comma operator is evaluated as a void expression; there is a sequence point between its evaluation and that of the right operand. Then the right operand is evaluated; the result has its type and value.115)
EXAMPLE As indicated by the syntax, the comma operator (as described in this subclause) cannot appear in contexts where a comma is used to separate items in a list (such as arguments to functions or lists of initializers). On the other hand, it can be used within a parenthesized expression or within the second expression of a conditional operator in such contexts. In the function call
f(a, (t=3, t+2), c)
the function has three arguments, the second of which has the value .
6.6 Constant expressions
6.6.1 General
Syntax
Description
The fact that a given conditional expression forms a constant expression is detected in translation phases 4116) and 7. In most of the cases, the value of the constant expression is determined in translation phases 1-7 (i.e. before linking). Values of address constants or arithmetic constant expressions with floating type and values that are derived from these are possibly only determined during linking (translation phase 8) or just before program startup.
An expression that evaluates to a constant is required in several contexts. The most general form appears in initializers for objects whose value is determined at translation time or program startup, such as objects with static storage duration or with the constexpr specifier. Additionally, for some uses the property of an expression E being an integer constant expression or not changes the semantics of the program. In particular, it determines if an array declaration T A[E] denotes a VLA or not and thus if a seemingly benign expression sizeof(A) is determined at translation time or evaluated each time when it is met during the program execution.
Constant expressions do not contain assignment, increment, decrement, function-call, or comma operators, except when they are contained within a subexpression that is not evaluated.117) Additionally, such a constant expression is, or evaluates to, a null pointer constant (6.3.3.3) or one of the categories that are described in this clause:
- a compound literal constant,
- a named constant,
- an integer constant expression,
- an arithmetic constant expression,
- an address constant, or
- an address constant for a complete object type plus or minus an integer constant expression.
A compound literal with storage-class specifier constexpr is a compound literal constant, as is a postfix expression that applies the . member access operator to a compound literal constant of structure or union type, even recursively. A compound literal constant is a constant expression with the type and value of the unnamed object.
An identifier that is:
- an enumeration constant,
- a predefined constant, or
- declared with storage-class specifier
constexprand has an object type,
is a named constant, as is a postfix expression that applies the . member access operator to a named constant of structure or union type, even recursively. For enumeration and predefined constants, their value and type are defined in the respective clauses; for constexpr objects, such a named constant is a constant expression with the type and value of the declared object.
An integer constant expression118) has integer type and only has operands that are integer literals, named and compound literal constants of integer type, character literals, sizeof or _Countof expressions which are integer constant expressions, alignof expressions, and floating, named, or compound literal constants of arithmetic type that are the immediate operands of casts. Cast operators in an integer constant expression only convert arithmetic types to integer types, except as part of an operand to the typeof operators, sizeof operator, _Countof operator, or alignof operator.
An arithmetic constant expression has arithmetic type and only has operands that are floating literals, named or compound literal constants of arithmetic type and integer constant expressions. Cast operators in an arithmetic constant expression only convert arithmetic types to arithmetic types, except as part of an operand to the typeof operators, sizeof operator, _Countof operator, or alignof operator.
An address constant is a null pointer,119) a pointer to an lvalue designating an object of static storage duration, or a pointer to a function designator; it is created explicitly using the unary & operator or an integer constant cast to pointer type, or implicitly using an expression of array or function type.
The array-subscript [] and member-access -> operator, the address & and indirection * unary operators, and pointer casts can be used in the creation of an address constant, if no value of an object is accessed by use of these operators.120)
A structure or union constant is a named constant or compound literal constant with structure or union type, respectively.
An implementation may accept other forms of constant expressions, called extended constant expressions. It is implementation-defined whether extended constant expressions are usable in the same manner as the constant expressions defined in this document, including whether or not extended integer constant expressions are considered to be integer constant expressions.121)
Constraints
Each constant expression shall evaluate to a value that is in the range of representable values for its type.
Semantics
If a floating expression is evaluated in the translation environment, the arithmetic range and precision shall be at least as great as if the expression were being evaluated in the execution environment.122)
If the member-access operator . accesses a member of a union constant, the accessed member shall be the same as the member that is initialized by the union constant’s initializer.
Otherwise, the semantic rules for the evaluation of a constant expression are the same as for nonconstant expressions.123)
6.6.2 Constant range expressions
Syntax
Description
A constant range expression is a special syntactic form that describes a sequence of contiguously incrementing integer values ranging from the arithmetic value of the first constant expression to the second, without listing intermediate values explicitly. The operator is not a value expression and is only permitted in specific contexts, such as the operand to a case label to indicate that a single label matches multiple values.
Constraints
The constant expressions shall be integer constant expressions.
Semantics
The values described by the ... operator form a closed range, which contains all integer values in sequence starting from and including the first, low value, up to and including the second, high value.124)
If the arithmetic value of the first constant expression is greater than the one of the second, the range described by the constant range expression is empty.
Recommended practice
Implementations are encouraged to emit a diagnostic message when a range is empty.
EXAMPLE 1 Range expressions may be used as the operand to a case label to concisely describe a sequence of matching values in one label:
extern int n; extern void f(void); switch (n) { case 2 ... 5: // equivalent to // case 2: // case 3: // case 4: // case 5: f (); break; }
EXAMPLE 2 Because a range expression describes a closed range, it is possible to match past-the-end values such as the size of an array:
constexpr const int N = 42; int arr[N]; switch (i) { case 0 ... N: // matches the past-the-end range of arr f (arr[i]); // not OK, will dereference arr[N] g (&arr[i]); // may be OK depending on purpose break; } switch (i) { case 0 ... N - 1: // only matches the valid element range of arr f (arr[i]); // OK break; }
EXAMPLE 3 This range expression describes a range with elements that have different types. The implementation creates a range with the values from to +10, inclusive, in whatever representation it needs in order to preserve the semantics of the expressed range:
extern int n; switch (n) { case -10 ... 10ul: // case covers all values from -10 to 10 break; }
switch statement (6.8.5.3).6.7 Declarations
6.7.1 General
Syntax
- declaration:
- declaration-specifiers init-declarator-listopt
; - attribute-specifier-sequence declaration-specifiers init-declarator-list
; - static_assert-declaration
- attribute-declaration
Constraints
If a declaration other than a static_assert or attribute declaration does not include an init declarator list, its declaration specifiers shall include one of the following:
- a struct or union specifier or enum specifier that includes a tag, with the declaration being of a form specified in 6.7.3.4 to declare that tag;
- an enum specifier that includes an enumerator list.
EXAMPLE 1 The following are invalid, because the declared tag or enumeration constants are in a nested construct, rather than a declaration specifier of the declaration being of one of the given forms:
struct { struct s2 { int x2a; } x2b; }; typeof (struct s3 { int x3; }); alignas (struct s4 { int x4; }) int; typeof (struct s5 *); typeof (enum { E6 }); struct { void (*p)(struct s7 *); };
If an identifier has no linkage, there shall be no more than one declaration of the identifier (in a declarator or type specifier) with the same scope and in the same name space, except that:
- a typedef name can be redefined to denote the same type as it currently does, provided that type is not a variably modified type;
All declarations in the same scope that refer to the same object or function shall specify compatible types.
If an identifier for an object that does not have function prototype scope is declared with no linkage, the type for the object shall be complete by the end of its declarator, or by the end of its init-declarator if it has an initializer.125)
Within a translation unit, the same identifier shall not appear with both internal and external linkage.
Semantics
A declaration specifies the interpretation and properties of a set of identifiers. A definition of an identifier is a declaration for that identifier that for:
- an object, causes storage to be reserved for that object,
- a function, includes the function body,126)
- an enumeration constant, is the first (or only) declaration of the identifier, or
- a typedef name, is the first (or only) declaration of the identifier.
The declaration specifiers consist of a sequence of specifiers, followed by an optional attribute specifier sequence. The declaration specifiers indicate the linkage, storage duration, and part of the type of the entities that the declarators denote. The init declarator list is a comma-separated sequence of declarators, each of which can have additional type information, or an initializer, or both. The declarators contain the identifiers (if any) being declared. The optional attribute specifier sequence in a declaration appertains to each of the entities declared by the declarators of the init declarator list.
The optional attribute specifier sequence terminating a sequence of declaration specifiers appertains to the type determined by the preceding sequence of declaration specifiers. The attribute specifier sequence affects the type only for the declaration it appears in, not other declarations involving the same type.
Except where specified otherwise, the meaning of an attribute declaration is implementation-defined.
EXAMPLE 2 In the declaration for an entity, attributes appertaining to that entity can appear at the start of the declaration and after the identifier for that declaration.
[[deprecated]] void f [[deprecated]] (void); // valid
A declaration such that the declaration specifiers contain no type specifier or that is declared with constexpr is said to be underspecified. If such a declaration is not a definition, if it declares no or more than one ordinary identifier, if the declared identifier already has a declaration in the same scope, if the declared entity is not an object, or if anywhere within the sequence of tokens making up the declaration identifiers that are not ordinary are declared, the behavior is implementation-defined.127)
A simple declaration is a declaration128) that can appear in place of the controlling expression of a selection statement.
EXAMPLE 3 As declarations using constexpr are underspecified, the following has implementation-defined behavior because tokens within the declaration declare s which is not an ordinary identifier:
constexpr typeof(struct s *) x = 0;
6.7.2 Storage-class specifiers
Syntax
- storage-class-specifier:
autoconstexprexternregisterstaticthread_localtypedef
Constraints
At most, one storage-class specifier can be given in the declaration specifiers in a declaration, except that:
-
thread_localcan appear withstaticorextern, -
autocan appear with all the others excepttypedef,129) and -
constexprcan appear withauto,register, orstatic.
In the declaration of an object with block scope, if the declaration specifiers include thread_local, they shall also include either static or extern. If thread_local appears in any declaration of an object, it shall be present in every declaration of that object.
thread_local shall not appear in the declaration specifiers of a function declaration. auto shall only appear in the declaration specifiers of an identifier with file scope or along with other storage-class specifiers if the type is to be inferred from an initializer.
An object declared with storage-class specifier constexpr or any of its members, even recursively, shall not have an atomic type, or a variably modified type, or a type that is volatile or restrict qualified. An initializer of floating type shall be evaluated with the translation-time floating-point environment. The declaration shall be a definition and shall have an initializer.130) The value of any constant expressions or of any character in a string literal of the initializer shall be exactly representable in the corresponding target type; no change of value shall be applied.131)
If an object or subobject declared with storage-class specifier constexpr has pointer, integer, or arithmetic type, any explicit initializer value for it shall be null,132) an integer constant expression, or an arithmetic constant expression, respectively. If the object declared has real floating type, the initializer shall have integer or real floating type. If the initializer has decimal floating type, the object declared shall have decimal floating type and the conversion shall preserve the quantum of the initializer. If the initializer has real type and a signaling NaN value, the unqualified versions of the type of the initializer and the corresponding real type of the object declared shall be compatible.
The declaration of an identifier for a function that has block scope shall have no explicit storage-class specifier other than extern.
EXAMPLE 1 Although in the following the expression A.p is not a null pointer constant, only a constant expression with pointer type and a null pointer value, the member-wise initialization of B with A is valid.
struct s { void *p; }; constexpr struct s A = { nullptr }; constexpr struct s B = A;
EXAMPLE 2 Pointers can be initialized to eligible constant expressions, such as a null pointer constant:
constexpr int *p = {}; // Default initialization with a null pointer
EXAMPLE 3
void f (void) { constexpr float f = 1.0f; constexpr float g = 3.0f; fesetround(FE_TOWARDZERO); // does not affect // the following initialization // of h constexpr float h = f / g; // ... }
Semantics
Storage-class specifiers specify various properties of identifiers and declared features:
- addressability (
register), - storage duration (
staticin block scope,thread_local,auto), - linkage (
extern,staticandconstexprin file scope,typedef), - value (
constexpr), - and, type (
typedef).
The meanings of the various linkages and storage durations were discussed in 6.2.2 and 6.2.4, typedef is discussed in 6.7.9, and type inference using auto is discussed in 6.7.10.
A declaration of an identifier for an object with storage-class specifier register suggests that access to the object be as fast as possible. The extent to which such suggestions are effective is implementation-defined.133)
If an aggregate or union object is declared with a storage-class specifier other than typedef, the properties resulting from the storage-class specifier, except with respect to linkage, also apply to the members of the object, including recursively for any aggregate or union member objects.
If auto appears with another storage-class specifier, or if it appears in a declaration at file scope, it is ignored for the purposes of determining a storage duration or linkage. In this case, it indicates only that the declared type can be inferred.
An object declared with a storage-class specifier constexpr has its value permanently fixed at translation-time; if not yet present, a const-qualification is implicitly added to the object’s type. The declared identifier is considered a constant expression of the respective kind, see 6.6.1.
NOTE 1 An object declared in block scope with a storage-class specifier constexpr and without static has automatic storage duration, the identifier has no linkage, and each instance of the object has a unique address obtainable with & (if it is not declared with the register specifier), if any. Such an object in file scope has static
NOTE 2 The constraints for constexpr objects are intended to enforce checks for portability at translation time.
constexpr unsigned int minusOne = -1; // constraint violation constexpr unsigned int uint_max = -1U; // ok constexpr double onethird = 1.0/3.0; // possible constraint violation constexpr double onethirdtrunc = (double)(1.0/3.0); // ok constexpr _Decimal32 small = DEC64_TRUE_MIN * 0; // constraint violation
If a truncation of excess precision changes the value in the initializer of onethird, a constraint is violated and a diagnostic is required. In contrast to that, the explicit conversion in the initializer for onethirdtrunc ensures that the definition is valid. Similarly, the initializer of small has a quantum exponent that is larger than the largest possible quantum exponent for _Decimal32.
NOTE 3 Similarly, implementation-defined behavior related to the char type of the elements of the string literal "\xFF" can cause constraint violations at translation time:
constexpr char string[] = { "\xFF", }; // ok constexpr char8_t u8string[] = { u8"\xFF", }; // ok constexpr unsigned char ucstring[] = { "\xFF", }; // possible constraint // violationIn both the string and
ucstring initializers, the initializer is a (brace-enclosed) string literal of type char. If the type char is capable of representing negative values and its width is 8, then the preceding code is equivalent to:constexpr char string[] = { -1, 0, }; // ok constexpr char8_t u8string[] = { 255, 0, }; // ok constexpr unsigned char ucstring[] = { -1, 0, }; // constraint violationThe hexadecimal escape sequence results in a value of
255. For an initializer of type char, it is converted to a signed 8-bit integer, making a value of -1. A negative value does not fit within the range of values for unsigned char, and therefore the initialization of ucstring is a constraint violation under the previously stated implementation conditions. In the case where char is not capable of representing negative values, the original snippet is equivalent to the following and there is no constraint violation.constexpr char string[] = { 255, 0, }; // ok constexpr char8_t u8string[] = { 255, 0, }; // ok constexpr unsigned char ucstring[] = { 255, 0, }; // ok
EXAMPLE 4 An identifier declared with the constexpr specifier can have its value used in constant expressions:
constexpr int K = 47; enum { A = K, // valid, constant initialization }; constexpr int L = K; // valid, constexpr initialization static int b = K + 1; // valid, static initialization int array[K]; // not a VLA
EXAMPLE 5 This example illustrates constexpr initializations involving different type domains, decimal and non-decimal floating types, NaNs and infinities, and quanta in decimal floating types.
#include <float.h> #include <complex.h> constexpr float _Complex fc1 = 1.0; // ok constexpr float _Complex fc2 = 0.1; // constraint violation, unless double // has the same precision as float // and is evaluated with the same // precision constexpr float _Complex fc3 = 3*I; // ok constexpr double d1 = (double _Complex)1.0; // constraint violation constexpr float f1 = (long double)INFINITY; // ok constexpr float f2 = (long double)NAN; // ok, quiet NaNs in real floating // types are considered the same // value, regardless of payloads constexpr double d2 = DBL_SNAN; // ok constexpr double d3 = FLT_SNAN; // constraint violation, even if float // and double have the same format constexpr double _Complex dc1 = DBL_SNAN; // ok constexpr double _Complex dc2 = CMPLX(DBL_SNAN, 0.); // ok constexpr double _Complex dc3 = CMPLX(0., DBL_SNAN); // ok constexpr _Decimal32 d321 = 1.0; // ok constexpr _Decimal32 d322 = 1; // ok constexpr _Decimal32 d323 = INFINITY; // ok constexpr _Decimal32 d324 = NAN; // ok constexpr _Decimal64 d641 = DEC64_SNAN; // ok constexpr _Decimal64 d642 = DEC32_SNAN; // constraint violation constexpr float f3 = 1.DF; // constraint violation constexpr float f4 = DEC_INFINITY; // constraint violation constexpr double d4 = DEC_NAN; // constraint violation constexpr _Decimal32 d325 = DEC64_TRUE_MIN * 0; // constraint violation, // quantum not preserved
EXAMPLE 6 An object declared with the constexpr specifier stores the exact value of its initializer, no implicit value change is applied:
#include <float.h> constexpr int A = 42LL; // valid, 42 always fits in an int constexpr signed short B = ULLONG_MAX; // constraint violation, value never // fits constexpr float C = 47u; // valid, exactly representable // in float #if FLT_MANT_DIG > 24 constexpr float D = 536900000; // constraint violation if float is // ISO/IEC 60559 binary32 #endif #if (FLT_MANT_DIG == DBL_MANT_DIG) \ && (0 <= FLT_EVAL_METHOD) \ && (FLT_EVAL_METHOD <= 1) constexpr float E = 1.0 / 3.0; // only valid if double expressions // and float objects have the same // precision #endif #if FLT_EVAL_METHOD == 0 constexpr float F = 1.0f / 3.0f; // valid, same type and precision #else constexpr float F = (float)(1.0f / 3.0f); // needs cast to truncate the // excess precision #endif
EXAMPLE 7 This recursively applies to initializers for all elements of an aggregate object declared with the constexpr specifier:
constexpr static unsigned short array[] = { 3000, // valid, fits in unsigned short range 300000, // constraint violation if short is 16-bit -1 // constraint violation, target type is unsigned }; struct S { int x, y; }; constexpr struct S s = { .x = INT_MAX, // valid .y = UINT_MAX, // constraint violation };
6.7.3 Type specifiers
6.7.3.1 General
Syntax
- type-specifier:
voidcharshortintlongfloatdoublesignedunsigned_BitInt (constant-expression)bool_Complex_Decimal32_Decimal64_Decimal128- atomic-type-specifier
- struct-or-union-specifier
- enum-specifier
- typedef-name
- typeof-specifier
Constraints
Except where the type is inferred (6.7.10), at least one type specifier shall be given in the declaration specifiers in each declaration, and in the specifier-qualifier list in each member declaration and type name. Each list of type specifiers shall be one of the following multisets (delimited by commas, when there is more than one multiset per item); the type specifiers can occur in any order, possibly intermixed with the other declaration specifiers.
-
void -
char -
signed char -
unsigned char -
short,signed short,short int, orsigned short int
The type specifier _Complex shall not be used if the implementation does not support complex types, and the type specifiers _Decimal32, _Decimal64, and _Decimal128 shall not be used if the implementation does not support decimal floating types (see 6.10.10.4).
The parenthesized constant expression that follows the _BitInt keyword shall be an integer constant expression N that specifies the width (6.2.6.2) of the type. The value of N for unsigned _BitInt shall be greater than or equal to 1. The value of N for _BitInt shall be greater than or equal to 2. The value of N shall be less than or equal to the value of BITINT_MAXWIDTH (see 5.3.5.3.2).
Semantics
Specifiers for structures, unions, enumerations, atomic types, and typeof specifiers are discussed in 6.7.3.2 through 6.7.3.6. Declarations of typedef names are discussed in 6.7.9. The characteristics of the other types are discussed in 6.2.5.
For a declaration such that the declaration specifiers contain no type specifier a mechanism to infer the type from an initializer is discussed in 6.7.10. In such a declaration, optional elements, if any, of a sequence of declaration specifiers appertain to the inferred type (for qualifiers and attribute specifiers) or to the declared objects (for alignment specifiers).
Each of the comma-separated multisets designates the same type, except that for bit-fields, it is implementation-defined whether the specifier int designates the same type as signed int or the same type as unsigned int.
6.7.3.2 Structure and union specifiers
Syntax
- struct-or-union-specifier:
- struct-or-union attribute-specifier-sequenceopt identifieropt
{member-declaration-list} - struct-or-union attribute-specifier-sequenceopt identifier
- struct-or-union:
structunion
- member-declaration:
- attribute-specifier-sequenceopt specifier-qualifier-list member-declarator-listopt
; - static_assert-declaration
Constraints
A member declaration that does not declare an anonymous structure or anonymous union shall contain a member declarator list.
Each member of a structure or union shall have a known constant size (hence, a structure shall not contain an instance of itself, but can contain a pointer to an instance of itself), except that the last member of a structure with more than one named member can have incomplete array type; such a structure (and any union containing, possibly recursively, a member that is such a structure) shall not be a member of a structure or an element of an array.
The expression that specifies the width of a bit-field shall be an integer constant expression with a nonnegative value that does not exceed the width of an object of the type that would be specified were the colon and expression omitted.134) If the value is zero, the declaration shall have no declarator.
A bit-field shall have a type that is a qualified or unqualified bool, signed int, unsigned int, a bit-precise integer type, or other implementation-defined type. It is implementation-defined whether atomic types are permitted.
An attribute specifier sequence shall not appear in a struct-or-union specifier without a member declaration list, except in a declaration of the form:
struct-or-union attribute-specifier-sequence identifier ;
The attributes in the attribute specifier sequence, if any, are thereafter considered attributes of the struct or union whenever it is named.
Semantics
As discussed in 6.2.5, a structure is a type consisting of a sequence of members, whose storage is allocated in an ordered sequence, and a union is a type consisting of a sequence of members whose storage overlap.
Structure and union specifiers have the same form. The keywords struct and union indicate that the type being specified is, respectively, a structure type or a union type.
The optional attribute specifier sequence in a struct-or-union specifier appertains to the structure or union type being declared. The optional attribute specifier sequence in a member declaration appertains to each of the members declared by the member declarator list; it shall not appear if the optional member declarator list is omitted. The optional attribute specifier sequence in a specifier qualifier list appertains to the type denoted by the preceding type specifier qualifiers. The attribute specifier sequence affects the type only for the member declaration or type name it appears in, not other types or declarations involving the same type.
The member declaration list is a sequence of declarations for the members of the structure or union. If the member declaration list does not contain any named members, either directly or via an anonymous structure or anonymous union, the behavior is implementation-defined.135)
A member of a structure or union can have any type of known constant size other than a variably modified type.136) In addition, a member can be declared to consist of a specified number of bits (including a sign bit, if any). Such a member is called a bit-field;137) its width is preceded by a colon.
A bit-field is interpreted as having a signed or unsigned integer type consisting of the specified number of bits.138) If the value or is stored into a nonzero-width bit-field of type bool, the value of the bit-field shall compare equal to the value stored; a bool bit-field has the semantics of a bool.
An implementation can allocate any addressable storage unit large enough to hold a bit-field. If enough space remains, a bit-field that immediately follows another bit-field in a structure shall be packed into adjacent bits of the same unit. If insufficient space remains, whether a bit-field that does not fit is put into the next unit or overlaps adjacent units is implementation-defined. The order of allocation of bit-fields within a unit (high-order to low-order or low-order to high-order) is implementation-defined. The alignment of the addressable storage unit is unspecified.
A bit-field declaration with no declarator, but only a colon and a width, indicates an unnamed bit-field.139) As a special case, a bit-field structure member with a width of zero indicates that no further bit-field is to be packed into the unit in which the previous bit-field, if any, was placed.
An unnamed member whose type specifier is a structure specifier with no tag is called an anonymous structure; an unnamed member whose type specifier is a union specifier with no tag is called an anonymous union. The members of an anonymous structure or union are members of the containing structure or union, keeping their structure or union layout. This applies recursively if the containing structure or union is also anonymous.
Each non-bit-field member of a structure or union object is aligned in an implementation-defined manner appropriate to its type.
Within a structure object, the non-bit-field members and the units in which bit-fields reside have addresses that increase in the order in which they are declared. A pointer to a structure object, suitably converted, points to its initial member (or if that member is a bit-field, then to the unit in which it resides), and vice versa. There can be unnamed padding within a structure object, but not at its beginning.
The size of a union is sufficient to contain the largest of its members. The value of at most one of the members can be stored in a union object at any time. A pointer to a union object, suitably converted, points to each of its members (or if a member is a bit-field, then to the unit in which it resides), and vice versa. The members of a union object overlap in such a way that pointers to them when converted to pointers to character type point to the same byte. There can be unnamed padding at the end of a union object, but not at its beginning.
There can be unnamed padding at the end of a structure or union.
As a special case, the last member of a structure with more than one named member can have an incomplete array type; this is called a flexible array member. In most situations, the flexible array member is ignored. In particular, the size of the structure is as if the flexible array member were omitted except that it may have more trailing padding than the omission would imply. However, when a . (or ->) operator has a left operand that is (a pointer to) a structure with a flexible array member and the right operand names that member, it behaves as if that member were replaced with the longest array (with the same element type) that would not make the structure larger than the object being accessed; the offset of the array shall remain that of the flexible array member, even if this would differ from that of the replacement array. If this array would have no elements, it behaves as if it had one element but the behavior is undefined if any attempt is made to access that element or to generate a pointer one past it.
EXAMPLE 1 The following declarations illustrate the behavior when an attribute is written on a tag declaration:
struct [[deprecated]] S; // valid, [[deprecated]] appertains to struct S void f(struct S *s); // valid, the struct S type has the [[deprecated]] // attribute struct S { // valid, struct S inherits the [[deprecated]] int a; // attribute from the previous declaration }; void g(struct [[deprecated]] S s); // invalid
EXAMPLE 2 The following illustrates anonymous structures and unions:
struct v { union { // anonymous union struct { int i, j; }; // anonymous structure struct { long k, l; } w; }; int m; } v1; v1.i = 2; // valid v1.k = 3; // invalid: inner structure is not anonymous v1.w.k = 5; // valid
EXAMPLE 3
After the declaration:
struct s { int n; double d[]; };the structure
struct s has a flexible array member d. A typical way to use this is:int m = /* some value */; struct s *p = malloc(sizeof(struct s) + sizeof(double [m])); struct { int n; double d[m]; } *p;
Following the declaration of the previous example:
struct s t1 = { 0 }; // valid struct s t2 = { 1, { 4.2 }}; // invalid t1.n = 4; // valid t1.d[0] = 4.2; // can be undefined behaviorThe initialization of
t2 is invalid (and violates a constraint) because struct s is treated as if it did not contain member d. The assignment to t1.d[0] has probably undefined behavior, but it is possible thatsizeof(struct s) >= offsetof(struct s, d) + sizeof(double)
in which case the assignment would be legitimate. Nevertheless, it cannot appear in strictly conforming code.
After the further declaration:
struct ss { int n; };the expressions:
sizeof(struct s) >= sizeof(struct ss) sizeof(struct s) >= offsetof(struct s, d)
are always equal to 1.
If sizeof(double) is 8, then after the following code is executed:
struct s *s1; struct s *s2; s1 = malloc(sizeof(struct s) + 64); s2 = malloc(sizeof(struct s) + 46);and assuming that the calls to
malloc succeed, the objects pointed to by s1 and s2 behave, for most purposes, as if the identifiers had been declared as:struct { int n; double d[8]; } *s1; struct { int n; double d[5]; } *s2;
Following the further successful assignments:
s1 = malloc(sizeof(struct s) + 10); s2 = malloc(sizeof(struct s) + 6);they then behave as if the declarations were:
struct { int n; double d[1]; } *s1, *s2;and:
double *dp; dp = &(s1->d[0]); // valid *dp = 42; // valid dp = &(s2->d[0]); // valid *dp = 42; // undefined behavior
The assignment:
*s1 = *s2;
EXAMPLE 4
Because members of anonymous structures and unions are considered to be members of the containing structure or union, struct s in the following example has more than one named member and thus the use of a flexible array member is valid:
struct s { struct { int i; }; int a[]; };
6.7.3.3 Enumeration specifiers
Syntax
- enum-specifier:
enumattribute-specifier-sequenceopt identifieropt enum-type-specifieropt{enumerator-list}enumattribute-specifier-sequenceopt identifieropt enum-type-specifieropt{enumerator-list, }enumidentifier enum-type-specifieropt
All enumerations have an underlying type. The underlying type can be explicitly specified using an enum type specifier and is its fixed underlying type. If it is not explicitly specified, the underlying type is the enumeration’s compatible type, which is either char or a standard or extended signed or unsigned integer type.
Constraints
For an enumeration with a fixed underlying type, the integer constant expression defining the value of the enumeration constant shall be representable in that fixed underlying type. If the value of an enumeration constant without a defining constant expression for an enumeration with fixed underlying type is obtained by adding 1 to the previous enumeration constant, the value of that previous enumeration constant shall not be the maximum value of the underlying type.
For an enumeration without a fixed underlying type, the expression that defines the value of an enumeration constant shall be an integer constant expression. For all the integer constant expressions which make up the values of the enumeration constants, there shall be a type capable of representing all the values that is a standard or extended signed or unsigned integer type, or char.
If an enum type specifier is present, then the longest possible sequence of tokens that can be interpreted as a specifier qualifier list is interpreted as part of the enum type specifier. It shall name an integer type that is neither an enumeration nor a bit-precise integer type. The underlying type of
An enum specifier of the form
enum identifier enum-type-specifier
shall not appear except in a declaration of the form
enum identifier enum-type-specifier ;
unless it is immediately followed by an opening brace, an enumerator list (with an optional ending comma), and a closing brace.
If two enum specifiers that include an enum type specifier declare the same type, the underlying types shall be compatible.
An enumeration with a fixed underlying type shall be defined with an enum type specifier. No enum specifier for an enumeration without a fixed underlying type shall include an enum type specifier.
Semantics
The optional attribute specifier sequence in the enum specifier appertains to the enumeration; the attributes in that attribute specifier sequence are thereafter considered attributes of the enumeration whenever it is named. The optional attribute specifier sequence in the enumerator appertains to that enumerator.
The identifiers in an enumerator list are declared as constants of the types specified later in this subclause and can appear wherever such are permitted.141) An enumerator with = defines its enumeration constant as the value of the constant expression. If the first enumerator has no =, the value of its enumeration constant is zero. Each subsequent enumerator with no = defines its enumeration constant as the value of the constant expression obtained by adding to the value of the previous enumeration constant. (The use of enumerators with = may produce enumeration constants with values that duplicate other values in the same enumeration.) The enumerators of an enumeration are also known as its members.
The type for the members of an enumeration is called the enumeration member type.
During the processing of each enumeration constant in the enumerator list, the type of the enumeration constant shall be:
- the previously declared type, if it is a redeclaration of the same enumeration constant; or,
- the enumerated type, for an enumeration with fixed underlying type; or,
-
int, if there are no previous enumeration constants in the enumerator list and no explicit=with a defining integer constant expression; or, -
int, if given explicitly with=and the value of the integer constant expression is representable by anint; or, - the type of the integer constant expression, if given explicitly with
=and if the value of the integer constant expression is not representable byint; or, - the type of the value from the previous enumeration constant with one added to it. If such an integer constant expression would overflow or wraparound the value of the previous enumeration constant from the addition of one, the type takes on either:
For all enumerations without a fixed underlying type, each enumerated type shall be compatible with char or a signed or an unsigned integer type that is not bool or a bit-precise integer type. The choice of type is implementation-defined,143) but shall be capable of representing the values of all the members of the enumeration.144)
Enumeration constants can be redefined in the same scope with the same value as part of a redeclaration of the same enumerated type.
The enumeration member type for an enumerated type without fixed underlying type upon completion is:
-
intif all the values of the enumeration are representable as anint; or, - the enumerated type.145)
The enumeration member type for an enumerated type with fixed underlying type is the enumerated type. The enumerated type is compatible with the underlying type of the enumeration. After possible lvalue conversion a value of the enumerated type behaves the same as the value with the underlying type, in particular with all aspects of promotion, conversion, and arithmetic. Conversion to the enumerated type has the same semantics as conversion to the underlying type.146)
EXAMPLE 1 The following fragment:
enum hue { chartreuse, burgundy, claret=20, winedark }; enum hue col, *cp; col = claret; cp = &col; if (*cp != burgundy) /* ... */
makes hue the tag of an enumeration, and then declares col as an object that has that type and cp as a pointer to an object that has that type. The enumerated values are in the set {0, 1, 20, 21}.
EXAMPLE 2 Even if the value of an enumeration constant is generated by the implicit addition of one, an enumeration with a fixed underlying type does not exhibit typical overflow behavior:
#include <limits.h> enum us : unsigned short { us_max = USHRT_MAX, us_violation, /* Constraint violation: USHRT_MAX + 1 would wraparound. */ us_violation_2 = us_max + 1, /* Maybe constraint violation: USHRT_MAX + 1 can be promoted to int, and result is too wide for the underlying type. */ us_wraparound_to_zero = (unsigned short)(USHRT_MAX + 1) /* Okay: conversion done in constant expression before conversion to underlying type: unsigned semantics okay. */ }; enum ui : unsigned int { ui_max = UINT_MAX, ui_violation, /* Constraint violation: UINT_MAX + 1 would wraparound. */ ui_no_violation = ui_max + 1, /* Okay: Arithmetic performed as typical unsigned integer arithmetic: conversion from a value that is already 0 to 0. */ ui_wraparound_to_zero = (unsigned int)(UINT_MAX + 1) /* Okay: conversion done in constant expression before conversion to underlying type: unsigned semantics okay. */ }; int main () { // Same as return 0; return ui_wraparound_to_zero + us_wraparound_to_zero; }
EXAMPLE 3 The following fragment:
#include <limits.h> enum E1: short; enum E2: short; enum E3; /* Constraint violation: E3 forward declaration. */ enum E4 : unsigned long long; enum E1 : short { m11, m12 }; enum E1 x = m11; enum E2 : long { m21, m22 }; /* Constraint violation: different underlying types */ enum E3 { m31, m32, m33 = sizeof(enum E3) /* Constraint violation: E3 is not complete here. */ }; enum E3 : int; /* Constraint violation: E3 previously had no underlying type */ enum E4 : unsigned long long { m40 = sizeof(enum E4), m41 = ULLONG_MAX, m42 /* Constraint violation: unrepresentable value (wraparound) */ }; enum E5 y; /* Constraint violation: incomplete type */ enum E6 : long int z; /* Constraint violation: enum-type-specifier with identifier in declarator */ enum E7 : long int = 0; /* Syntax violation: enum-type-specifier with initializer */
EXAMPLE 4 The following fragment:
enum no_underlying { a0 }; int main (void) { int a = _Generic(a0, int: 2, unsigned char: 1, default: 0 ); int b = _Generic((enum no_underlying)a0, int: 2, unsigned char: 1, default: 0 ); return a + b; }
demonstrates the implementation-defined nature of the underlying type of enumerations using generic selection (6.5.2.1). The value of a after its initialization is 2. The value of b after its initialization is implementation-defined: the enumeration is compatible with a type large enough to fit the values of its enumeration constants due to the constraints. Because the only value is 0 for a0, b can hold any of 2, 1, or 0.
The following fragment is similar, but uses a fixed underlying type:
enum underlying : unsigned char { b0 }; int main (void) { int a = _Generic(b0, int: 2, unsigned char: 1, default: 0 ); int b = _Generic((enum underlying)b0, int: 2, unsigned char: 1, default: 0 ); return 0; }
Here, we are guaranteed that a and b are both initialized to 1. This makes enumerations with a fixed underlying type more portable.
EXAMPLE 5 Enumerations with a fixed underlying type have braces and the enumerator list specified as part of their declaration if they are not a standalone declaration:
void f1 (enum a : long b); /* Constraint violation */ void f2 (enum c : long { x } d); enum e : int f3(); /* Constraint violation */ typedef enum t u; /* Constraint violation: forward declaration of t. */ typedef enum v : short W; /* Constraint violation */ typedef enum q : short { s } R; struct s1 { int x; enum e : int : 1; /* Constraint violation */ int y; }; enum forward; /* Constraint violation */ extern enum forward fwd_val0; /* Constraint violation: incomplete type */ extern enum forward* fwd_ptr0; /* Constraint violation: enums cannot be used like other incomplete types */ extern int* fwd_ptr0; /* Constraint violation: incompatible with incomplete type. */ enum forward1 : int; extern enum forward1 fwd_val1; extern int fwd_val1; extern enum forward1* fwd_ptr1; extern int* fwd_ptr1; int main () { enum e : short; enum e : short f = 0; /* Constraint violation */ enum g : short { y } h = y; return 0; }
EXAMPLE 6 Enumerations with a fixed underlying type are complete when the enum type specifier for that specific enumeration is complete. The enumeration e in this snippet:
enum e : typeof ((enum e : short { A })0, (short)0);
enum e is considered complete by the first opening brace within the typeof in this snippet.
6.7.3.4 Tags
Constraints
Where two declarations that use the same tag declare the same type, they shall both use the same choice of struct, union, or enum. If two declarations of the same type have a member-declaration or enumerator-list, one shall not be nested within the other and both declarations shall fulfill all requirements of compatible types (6.2.7) with the additional requirement that corresponding members of structure or union types shall have the same (and not merely compatible) types.
A type specifier of the form
enum identifier
without an enumerator list shall only appear after the type it specifies is complete.
Semantics
All declarations of structure, union, or enumerated types that have the same scope and use the same tag declare the same type.
Irrespective of whether there is a tag or what other declarations of the type are in the same translation unit, the type (except enumerated types with a fixed underlying type) is incomplete until immediately after the closing brace of the list defining the content for the first time and complete thereafter.
Enumerated types with fixed underlying type (6.7.3.3) are complete immediately after their first associated enum type specifier ends.
EXAMPLE 1 The following example shows allowed redeclarations of the same structure, union, or enumerated type in the same scope:
struct foo { struct { int x; }; }; struct foo { struct { int x; }; }; union bar { int FormatUnionMember x; float y; }; union bar { int FormatUnionMember x; float y; }; typedef struct q { int x; } q_t; typedef struct q { int x; } q_t; void foo(void) { struct S { int x; }; struct T { struct S s; }; struct S { int x; }; struct T { struct S s; }; } enum X { A = 1, B = 1 + 1 }; enum X { B = 2, A = 1 }; enum Q { C = 1 }; enum Q { C = C }; // ok!
EXAMPLE 2 The following example shows invalid redeclarations of the same structure, union, or enumerated type in the same scope:
struct foo { int (*p)[3]; }; struct foo { int (*p)[]; }; // member has different type union bar { int x; float y; }; union bar { int z; float y; }; // member has different name union purr { int x; float y; }; union purr { float y; int x; }; // members have different order // purr only valid if each union purr is in // a different translation unit typedef struct { int x; } q_t; typedef struct { int x; } q_t; // not the same type struct S { int x; }; void foo(void) { struct T { struct S s; }; struct S { int x; }; struct T { struct S s; }; // struct S not the same type } enum X { A = 1, B = 2 }; enum X { A = 1, B = 3 }; // different enumeration constant enum R { C = 1 }; enum Q { C = 1 }; // conflicting enumeration constant
Two declarations of structure, union, or enumerated types which are in different scopes or use different tags declare distinct types. Each declaration of a structure, union, or enumerated type which does not include a tag declares a distinct type.
A type specifier of the form
struct-or-union attribute-specifier-sequenceopt identifieropt { member-declaration-list }
or
enum attribute-specifier-sequenceopt identifieropt enum-type-specifieropt { enumerator-list }
or
enum attribute-specifier-sequenceopt identifieropt enum-type-specifieropt { enumerator-list , }
declares a structure, union, or enumerated type. The list defines the structure content, union content, or enumeration content. If an identifier is provided,148) the type specifier also declares the identifier to be the tag of that type. The optional attribute specifier sequence appertains to the structure, union, or enumerated type being declared; the attributes in that attribute specifier sequence are thereafter considered attributes of the structure, union, or enumerated type whenever it is named.
A declaration of the form
struct-or-union attribute-specifier-sequenceopt identifier ;
or
enum identifier enum-type-specifier ;
specifies a structure, union, or enumerated type and declares the identifier as a tag of that type.149)
The optional attribute specifier sequence appertains to the structure or union type being declared; the attributes in that attribute specifier sequence are thereafter considered attributes of the structure or union type whenever it is named.
If a type specifier of the form
struct-or-union attribute-specifier-sequenceopt identifier
occurs other than as part of one of the preceding forms, and no other declaration of the identifier as a tag is visible, then it declares an incomplete structure or union type, and declares the identifier as the tag of that type.149)
If a type specifier of the form
struct-or-union attribute-specifier-sequenceopt identifier
or
enum identifier
occurs other than as part of one of the preceding forms, and a declaration of the identifier as a tag is visible, then it specifies the same type as that other declaration, and does not redeclare the tag.
EXAMPLE 3 This mechanism allows declaration of a self-referential structure.
struct tnode { int count; struct tnode *left, *right; }; struct tnode s, *sp;
The following alternative formulation uses the typedef mechanism:
typedef struct tnode TNODE; struct tnode { int count; TNODE *left, *right; }; TNODE s, *sp;
EXAMPLE 4 To illustrate the use of prior declaration of a tag to specify a pair of mutually referential structures, the declarations
struct s1 { struct s2 *s2p; /* ... */ }; // D1 struct s2 { struct s1 *s1p; /* ... */ }; // D2specify a pair of structures that contain pointers to each other. If
s2 were already declared as a tag in an enclosing scope, the declaration D1 would refer to it, not to the tag s2 declared in D2. To eliminate this context sensitivity, the declarationstruct s2;
can be inserted ahead of D1. This declares a new tag s2 in the inner scope; the declaration D2 then completes the specification of the new type.
6.7.3.5 Atomic type specifiers
Syntax
- atomic-type-specifier:
_Atomic(type-name)
Constraints
Atomic type specifiers shall not be used if the implementation does not support atomic types (see 6.10.10.4).
The type name in an atomic type specifier shall not refer to an array type, a function type, an atomic type, or a qualified type.
Semantics
The properties associated with atomic types are meaningful only for expressions that are lvalues. If the _Atomic keyword is immediately followed by a left parenthesis, it is interpreted as a type specifier (with a type name), not as a type qualifier.
6.7.3.6 Typeof specifiers
Syntax
- typeof-specifier:
typeof (typeof-specifier-argument)typeof_unqual (typeof-specifier-argument)
The typeof and typeof_unqual tokens are collectively called the typeof operators.
Constraints
The typeof operators shall not be applied to an expression that designates a bit-field member.
Semantics
The typeof specifier applies the typeof operators to an expression (6.5.1) or a type name. If the typeof operators are applied to an expression, they yield the type of their operand.150) Otherwise, they designate the same type as the type name with any nested typeof specifier evaluated.151) If the type of the operand is a variably modified type, the operand is evaluated; otherwise, the operand is not evaluated.
The result of the typeof_unqual operator is the non-atomic unqualified version of the type that would result from the typeof operator.152) The typeof operator preserves all qualifiers.
EXAMPLE 1 Type of an expression.
typeof(1+1) main () { return 0; }is equivalent to this program:
int main () { return 0; }
EXAMPLE 2 The following program:
const _Atomic int purr = 0; const int meow = 1; const char* const animals[] = { "aardvark", "bluejay", "catte", }; typeof_unqual(meow) main (int argc, char* argv[]) { typeof_unqual(purr) plain_purr; typeof(_Atomic typeof(meow)) atomic_meow; typeof(animals) animals_array; typeof_unqual(animals) animals2_array; return 0; } const _Atomic int purr = 0; const int meow = 1; const char* const animals[] = { "aardvark", "bluejay", "catte", }; int main (int argc, char* argv[]) { int plain_purr; const _Atomic int atomic_meow; const char* const animals_array[3]; const char* animals2_array[3]; return 0; }
EXAMPLE 3 The equivalence between sizeof and typeof’s deduction of the type means this program has no constraint violations:
int main (int argc, char* argv[]) { static_assert(sizeof(typeof(’p’)) == sizeof(int)); static_assert(sizeof(typeof(’p’)) == sizeof(’p’)); static_assert(sizeof(typeof((char)’p’)) == sizeof(char)); static_assert(sizeof(typeof((char)’p’)) == sizeof((char)’p’)); static_assert(sizeof(typeof("meow")) == sizeof(char[5])); static_assert(sizeof(typeof("meow")) == sizeof("meow")); static_assert(sizeof(typeof(argc)) == sizeof(int)); static_assert(sizeof(typeof(argc)) == sizeof(argc)); static_assert(sizeof(typeof(argv)) == sizeof(char**)); static_assert(sizeof(typeof(argv)) == sizeof(argv)); static_assert(sizeof(typeof_unqual(’p’)) == sizeof(int)); static_assert(sizeof(typeof_unqual(’p’)) == sizeof(’p’)); static_assert(sizeof(typeof_unqual((char)’p’)) == sizeof(char)); static_assert(sizeof(typeof_unqual((char)’p’)) == sizeof((char)’p’)); static_assert(sizeof(typeof_unqual("meow")) == sizeof(char[5])); static_assert(sizeof(typeof_unqual("meow")) == sizeof("meow")); static_assert(sizeof(typeof_unqual(argc)) == sizeof(int)); static_assert(sizeof(typeof_unqual(argc)) == sizeof(argc)); static_assert(sizeof(typeof_unqual(argv)) == sizeof(char**)); static_assert(sizeof(typeof_unqual(argv)) == sizeof(argv)); return 0; }
EXAMPLE 4 The following program with nested typeof(...):
int main (int argc, char*[]) { float val = 6.0f; return (typeof(typeof_unqual(typeof(argc))))val; }is equivalent to this program:
int main (int argc, char*[]) { float val = 6.0f; return (int)val; }
EXAMPLE 5 Variable length arrays with typeof operators perform the operation at execution time rather than translation time.
#include <stddef.h> size_t vla_size (int n) { typedef char vla_type[n + 3]; vla_type b; // variable length array return sizeof( typeof_unqual(b) ); // execution-time sizeof, translation-time typeof operation } int main () { return (int)vla_size(10); // vla_size returns 13 }
EXAMPLE 6 Nested typeof operators, arrays, and pointers do not perform array to pointer decay.
int main () { typeof(typeof(const char*)[4]) y = { "a", "b", "c", "d" }; // 4-element array of "pointer to const char" return 0; }
EXAMPLE 7 Function, pointer, and array types can be substituted with typeof operations.
void f(int); typeof(f(5)) g(double x) { // g has type void(double) printf("value %g\n", x); } typeof(g)* h; // h has type void(*)(double) typeof(true ? g : nullptr) k; // k has type void(*)(double) void j(double A[5], typeof(A)* B); // j has type void(double*, double**) extern typeof(double[]) D; // D has an incomplete type typeof(D) C = { 0.7, 99 }; // C has type double[2] typeof(D) D = { 5, 8.9, 0.1, 99 }; // D is now completed to double[4] typeof(D) E; // E has type double[4] from D’s completed type
6.7.4 Type qualifiers
6.7.4.1 General
Syntax
- type-qualifier:
constrestrictvolatile_Atomic
Constraints
Types other than pointer types whose referenced type is an object type and (possibly multidimensional) array types with such pointer types as element type shall not be restrict-qualified.
The _Atomic qualifier shall not be used if the implementation does not support atomic types (see 6.10.10.4).
The type modified by the _Atomic qualifier shall not be an array type or a function type.
Semantics
The properties associated with qualified types are meaningful only for expressions that are lvalues.153)
If the same qualifier appears more than once in the same specifier-qualifier list or as declaration specifiers, either directly, via one or more typeof specifiers, or via one or more typedefs, the behavior is the same as if it appeared only once. If other qualifiers appear along with the _Atomic qualifier the resulting type is the so-qualified atomic type.
If an attempt is made to modify an object defined with a const-qualified type through use of an lvalue with non-const-qualified type, the behavior is undefined. If an attempt is made to refer to an object defined with a volatile-qualified type through use of an lvalue with non-volatile-qualified type, the behavior is undefined.154)
An object that has volatile-qualified type can be modified in ways unknown to the implementation or have other unknown side effects. Therefore, any expression referring to such an object shall be evaluated strictly according to the rules of the abstract machine, as described in 5.2.2.4. Furthermore, at every sequence point the value last stored in the object shall agree with that prescribed by the abstract machine, except as modified by the unknown factors mentioned previously.155) What constitutes an access to an object that has volatile-qualified type is implementation-defined.
An object that is accessed through a restrict-qualified pointer has a special association with that pointer. This association, defined in 6.7.4.2, requires that all accesses to that object use, directly or indirectly, the value of that pointer.156) The intended use of the restrict qualifier (like the register storage class) is to promote optimization, and deleting all instances of the qualifier from all preprocessing translation units composing a conforming program does not change its meaning (i.e. observable behavior), unless _Generic is used to distinguish whether or not a type has that qualifier.
If the specification of an array type includes any type qualifiers, both the array and the element type are so-qualified. If the specification of a function type includes any type qualifiers, the behavior is implementation-defined.157)
Two qualified types are compatible if and only if they are identically qualified versions of compatible types; the order of type qualifiers within a list of specifiers or qualifiers does not affect the specified type.
EXAMPLE 1 An object declared
extern const volatile int real_time_clock;
can be modifiable by hardware, but cannot be assigned to, incremented, or decremented.
EXAMPLE 2 The following declarations and expressions illustrate the behavior when type qualifiers modify an aggregate type:
const struct s { int mem; } cs = { 1 }; struct s ncs; // the object ncs is modifiable typedef int A[2][3]; const A a = {{4, 5, 6}, {7, 8, 9}}; // array of array of const int int *pi; const int *pci; ncs = cs; // valid cs = ncs; // violates modifiable lvalue constraint for = pi = &ncs.mem; // valid pi = &cs.mem; // violates type constraints for = pci = &cs.mem; // valid pi = a[0]; // invalid: a[0] has type "const int *"
EXAMPLE 3 The declaration
_Atomic volatile int *p;
specifies that p has the type "pointer to volatile atomic int", a pointer to a volatile-qualified atomic type.
6.7.4.2 Formal definition of restrict
Let D be a declaration of an ordinary identifier that provides a means of designating an object P as a restrict-qualified pointer to type T.
If D appears inside a block and does not have storage class extern, let B denote the block. If D appears in the list of parameter declarations of a function definition, let B denote the associated block. Otherwise, let B denote the block of main (or the block of whatever function is called at program startup in a freestanding environment).
In what follows, a pointer expression E is said to be based on object P if (at some sequence point in the execution of B prior to the evaluation of E) modifying P to point to a copy of the array object into which it formerly pointed would change the value of E.158) "based" is defined only for expressions with pointer types.
During each execution of B, let L be any lvalue that has &L based on P. If L is used to access the value of the object X that it designates, and X is also modified (by any means), then the following requirements apply: T shall not be const-qualified. Every other lvalue used to access the value of X shall also have its address based on P. Every access that modifies X shall be considered also to modify P, for the purposes of this subclause. If P is assigned the value of a pointer expression E that is based on another restricted pointer object P2, associated with block B2, then either the execution of B2 shall begin before the execution of B, or the execution of B2 shall end prior to the assignment. If these requirements are not met, then the behavior is undefined.
Here an execution of B means that portion of the execution of the program that would correspond to the lifetime of an object with scalar type and automatic storage duration associated with B.
A translator is free to ignore any or all aliasing implications of uses of restrict.
EXAMPLE 1 The file scope declarations
int * restrict a; int * restrict b; extern int c[];
assert that if an object is accessed using one of a, b, or c, and that object is modified anywhere in the program, then it is never accessed using either of the other two.
void f(int n, int * restrict p, int * restrict q) { while (n-- > 0) *p++ = *q++; }
The benefit of the restrict qualifiers is that they enable a translator to make an effective dependence analysis of function f without examining any of the calls of f in the program. The cost is that the programmer has to examine all those calls to ensure that none give undefined behavior. For example, the second call of f in g has undefined behavior because each of d[1] through d[49] is accessed through both p and q.
void g(void) { extern int d[100]; f(50, d + 50, d); // valid f(50, d + 1, d); // undefined behavior }
EXAMPLE 3 The function parameter declarations
void h(int n, int * restrict p, int * restrict q, int * restrict r) { int i; for (i = 0; i < n; i++) p[i] = q[i] + r[i]; }
illustrate how an unmodified object can be aliased through two restricted pointers. If a and b are disjoint arrays, a call of the form h(100, a, b, b) has defined behavior, because array b is not modified within function h.
EXAMPLE 4 The rule limiting assignments between restricted pointers does not distinguish between a function call and an equivalent nested block. With one exception, only "outer-to-inner" assignments between restricted pointers declared in nested blocks have defined behavior.
{
int * restrict p1;
int * restrict q1;
p1 = q1; // undefined behavior
{
int * restrict p2 = p1; // valid
int * restrict q2 = q1; // valid
p1 = q2; // undefined behavior
p2 = q2; // undefined behavior
}
}The one exception allows the value of a restricted pointer to be carried out of the block in which it (or, more precisely, the ordinary identifier used to designate it) is declared when that block finishes execution. For example, this permits new_vector to return a vector.
typedef struct { int n; float * restrict v; } vector; vector new_vector(int n) { vector t; t.n = n; t.v = malloc(n * sizeof(float)); return t; }
EXAMPLE 5 Suppose that a programmer knows that references of the form p[i] and q[j] are never aliases in the body of a function:
void f(int n, int *p, int *q) { /* ... */ }There are several ways that this information can be conveyed to a translator using the
restrict qualifier. Example 2 shows the most effective way, qualifying all pointer parameters, and can be used provided that neither p nor q becomes based on the other in the function body. A potentially effective alternative is:void f(int n, int * restrict p, int * const q) { /* ... */ }
Again, it is possible for a translator to make the no-aliasing inference based on the parameter declarations alone, though now subtler reasoning is used: that the const-qualification of q precludes it becoming based on p. There is also a requirement that q is not modified, so this alternative cannot be used for the function in Example 2, as written.
EXAMPLE 6 Another potentially effective alternative is:
void f(int n, int *p, int const * restrict q) { /* ... */ }
Again, it is possible for a translator to make the no-aliasing inference based on the parameter declarations alone, though now even subtler reasoning is used: that this combination of restrict and const means that objects referenced using q cannot be modified, and so no modified object can be referenced using both p and q.
EXAMPLE 7 The least effective alternative is:
void f(int n, int * restrict p, int *q) { /* ... */ }
Here the translator can make the no-aliasing inference only by analyzing the body of the function and proving that q cannot become based on p. Some translator designs can choose to exclude this analysis, given availability of the more effective alternatives described previously. Such a translator is required to assume that aliases are present because assuming that aliases are not present can result in an incorrect translation. Also, a translator that attempts the analysis can potentially not succeed in all cases and consequently need to conservatively assume that aliases are present.
6.7.5 Function specifiers
Syntax
- function-specifier:
inline_Noreturn
Constraints
Function specifiers shall be used only in the declaration of an identifier for a function.
An inline definition of a function with external linkage shall not contain, anywhere in the tokens making up the function definition, a definition of a modifiable object with static or thread storage duration, and shall not contain, anywhere in the tokens making up the function definition, a reference to an identifier with internal linkage.
In a hosted environment, no function specifier(s) shall appear in a declaration of main.
If a function declaration declaring an identifier with external linkage has an inline function specifier, then the function shall also be defined in the same translation unit.
Semantics
A function specifier can appear more than once; the behavior is the same as if it appeared only once.
A function declared with an inline function specifier is an inline function. Making a function an inline function suggests that calls to the function be as fast as possible.159) The extent to which such
Any function with internal linkage can be an inline function. For a function with external linkage, the following restrictions apply: If all the file scope declarations for a function in a translation unit include the inline function specifier without extern, then the definition in that translation unit is an inline definition. An inline definition does not provide an external definition for the function and does not forbid an external definition in another translation unit. Inline definitions provide an alternative to external definitions, which a translator can use to implement any call to the function in the same translation unit. It is unspecified whether a call to the function uses the inline definition or the external definition.161)
A function declared with a _Noreturn function specifier shall not return to its caller. The attribute [[noreturn]] provides similar semantics. The _Noreturn function specifier is an obsolescent feature (6.7.13.7).
Recommended practice
The implementation should produce a diagnostic message for a function declared with a _Noreturn function specifier that appears to be capable of returning to its caller.
EXAMPLE 1 The declaration of an inline function with external linkage can result in either an external definition, or a definition available for use only within the translation unit. A file scope declaration with extern creates an external definition. The following example shows an entire translation unit.
inline double fahr(double t) { return (9.0 * t) / 5.0 + 32.0; } inline double cels(double t) { return (5.0 * (t - 32.0)) / 9.0; } extern double fahr(double); // creates an external definition double convert(int is_fahr, double temp) { /* A translator can perform inline substitutions */ return is_fahr ? cels(temp): fahr(temp); }
The definition of fahr is an external definition because fahr is also declared with extern, but the definition of cels is an inline definition. Because cels has external linkage and is referenced, an external definition has to appear in another translation unit (see 6.9); the inline definition and the external definition are distinct and either can be used for the call.
EXAMPLE 2 The following inline definitions are invalid:
static int a; typeof (a) inline f() { return 0; } typeof ((int) { 0 }) inline g() { return 0; }
6.7.6 Alignment specifier
Syntax
- alignment-specifier:
alignas(type-name)alignas(constant-expression)
Constraints
An alignment specifier shall appear only in the declaration specifiers of a declaration, or in the specifier-qualifier list of a member declaration, or in the type name of a compound literal. An alignment specifier shall not be used in conjunction with either of the storage-class specifiers typedef or register, nor in a declaration of a function or bit-field.
The constant expression shall be an integer constant expression. It shall evaluate to a valid fundamental alignment, or to a valid extended alignment supported by the implementation for an object of the storage duration (if any) being declared, or to zero.
An object shall not be declared with an over-aligned type with an extended alignment requirement not supported by the implementation for an object of that storage duration.
The combined effect of all alignment specifiers in a declaration shall not specify an alignment that is less strict than the alignment that would otherwise be required for the type of the object or member being declared.
If the definition of an object has an alignment specifier, any other declaration of that object in the same translation unit shall either specify equivalent alignment or have no alignment specifier. If the definition of an object does not have an alignment specifier, any other declaration of that object in the same translation unit shall also have no alignment specifier.
Semantics
The first form is equivalent to alignas(alignof(type-name)).
The alignment requirement of the declared object or member is taken to be the specified alignment. An alignment specification of zero has no effect.162) When multiple alignment specifiers occur in a declaration, the effective alignment requirement is the strictest specified alignment.
If the definition of an object has an alignment specifier, no declaration of the object in a different translation unit shall specify a stricter alignment.
6.7.7 Declarators
6.7.7.1 General
Syntax
Semantics
Each declarator declares an identifier for a single object, function, or type, within a declaration. The preceding specifiers indicate the type, storage class, or other properties of the identifier or identifiers being declared. Each declarator specifies one declaration and names it and/or modifies the type of the specifiers with operators such as * (pointer to) and () (function returning).
A full declarator is a declarator that is not part of another declarator. If, in the nested sequence of declarators in a full declarator, there is a declarator specifying a variable length array type, the type specified by the full declarator is said to be variably modified. Furthermore, any type derived by declarator type derivation from a variably modified type is itself variably modified.
In the following subclauses, consider a declaration
T D1
where T contains the declaration specifiers that specify a type T (such as int) and D1 is a declarator that contains an identifier ident. The type specified for the identifier ident in the various forms of declarator is described inductively using this notation.
If, in the declaration "T D1", D1 has the form
identifier attribute-specifier-sequenceopt
then the type specified for ident is T and the optional attribute specifier sequence appertains to the entity that is declared.
If, in the declaration "T D1", D1 has the form
( D )
then ident has the type specified by the declaration "T D". Thus, a declarator in parentheses is identical to the unparenthesized declarator, but the binding of complicated declarators can be altered by parentheses.
Implementation limits
As discussed in 5.3.5.2, an implementation may limit the number of pointer, array, and function declarators that modify an arithmetic, structure, union, or void type, either directly or via one or
6.7.7.2 Pointer declarators
Semantics
If, in the declaration "T D1", D1 has the form
* attribute-specifier-sequenceopt type-qualifier-listopt D
and the type specified for ident in the declaration "T D" is "derived-declarator-type-list T", then the type specified for ident is "derived-declarator-type-list type-qualifier-list pointer to T". For each type qualifier in the list, ident is a so-qualified pointer. The optional attribute specifier sequence appertains to the pointer and not the object pointed to.
For two pointer types to be compatible, both shall be identically qualified and both shall be pointers to compatible types.
EXAMPLE The following pair of declarations demonstrates the difference between a "variable pointer to a constant value" and a "constant pointer to a variable value".
const int *ptr_to_constant; int *const constant_ptr;
The contents of any object pointed to by ptr_to_constant cannot be modified through that pointer, but ptr_to_constant itself can be changed to point to another object. Similarly, the contents of the int pointed to by constant_ptr can be modified, but constant_ptr itself always points to the same location.
The declaration of the constant pointer constant_ptr can be clarified by including a definition for the type "pointer to int".
typedef int *int_ptr; const int_ptr constant_ptr;
declares constant_ptr as an object that has type "const-qualified pointer to int".
6.7.7.3 Array declarators
Constraints
In addition to optional type qualifiers and the keyword static, the [ and ] can delimit an expression or *. If they delimit an expression, called the array length expression, the expression shall have an integer type. If the expression is a constant expression, it shall have a value greater than zero. The element type shall not be an incomplete or function type. The optional type qualifiers and the keyword static shall appear only in a declaration of a function parameter with an array type, and then only in the outermost array type derivation.
If an identifier is declared as having a variably modified type, it shall be an ordinary identifier (as defined in 6.2.3), have no linkage, and have either block scope or function prototype scope. If an identifier is declared to be an object with static or thread storage duration, it shall not have a variable length array type.
Semantics
If, in the declaration "T D1", D1 has one of the forms:
D [ type-qualifier-listopt assignment-expressionopt ] attribute-specifier-sequenceopt D [ static type-qualifier-listopt assignment-expression ] attribute-specifier-sequenceopt D [ type-qualifier-list static assignment-expression ] attribute-specifier-sequenceopt D [ type-qualifier-listopt * ] attribute-specifier-sequenceopt
and the type specified for ident in the declaration "T D" is "derived-declarator-type-list T", then the type specified for ident is "derived-declarator-type-list array of T".163)164) The optional attribute specifier
If the array length expression is not present, the array type is an incomplete type. If there is * instead of an array length expression, the array type is a variable length array type of unspecified array length, which can only be used as part of the nested sequence of declarators or abstract declarators for a parameter declaration or as part of such a sequence in a type name of a generic association, not including anything inside an array length expression in one of those declarators;165) such arrays are nonetheless complete types. If the array length expression is an integer constant expression and the element type has a known constant size, the array type has a known constant size; otherwise, the array type has is a variable length array type.166)
If the array length expression is not an integer constant expression: if it occurs in a declaration at function prototype scope or in a type name of a generic association (as described above), it is treated as if it were replaced by *; otherwise, each time it is evaluated it shall have a value greater than zero. The size of each instance of a variable length array type does not change during its lifetime. Where an array length expression is part of the operand of the typeof or sizeof operators and changing the value of the array length expression would not affect the result of the operator, it is unspecified whether or not the array length expression is evaluated. Where an array length expression is part of the operand with a _Countof operator and changing the value of the array length expression would not affect the result of the operator, the array length expression is not evaluated. Where an array length expression is part of the operand of an alignof operator, that expression is not evaluated.
Two array types are compatible if and only if both of the following hold:
- They have compatible element types.
- If both array length expressions are present, and are integer constant expressions, then they same constant value.
If the two array types are used in a context which requires them to be compatible, the behavior is undefined if the lengths of both are specified and the corresponding array length expressions evaluate to unequal values.
EXAMPLE 1
float fa[11], *afp[17];
declares an array of float numbers and an array of pointers to float numbers.
EXAMPLE 2 There is a distinction between the declarations
extern int *x; extern int y[];
The first declares x to be a pointer to int; the second declares y to be an array of int of unknown size (an incomplete type), the storage for which is defined elsewhere.
EXAMPLE 3 The following declarations demonstrate the compatibility rules for variably modified types.
extern int n; extern int m; void fcompat(void) { int a[n][6][m]; int (*p)[4][n+1]; int c[n][n][6][m]; int (*r)[n][n][n+1]; p = a; // invalid: not compatible because 4 != 6 r = c; // compatible, but defined behavior only if // n == 6 and m == n+1 }
EXAMPLE 4 All valid declarations of variably modified (VM) types are either at block scope or function prototype scope. Array objects declared with the thread_local, static, or extern storage-class specifier cannot have a variable length array (VLA) type. However, an object declared with the static storage-class specifier can have a VM type (that is, a pointer to a VLA type). Finally, only ordinary identifiers can be declared with a VM type and identifiers with VM type cannot, therefore, be members of structures or unions.
extern int n; int A[n]; // invalid: file scope VLA extern int (*p2)[n]; // invalid: file scope VM int B[100]; // valid: file scope but not VM void fvla(int m, int C[m][m]); // valid: VLA with prototype scope void fvla(int m, int C[m][m]) // valid: adjusted to auto pointer to VLA { typedef int VLA[m][m]; // valid: block scope typedef VLA struct tag { int (*y)[n]; // invalid: y not ordinary identifier int z[n]; // invalid: z not ordinary identifier }; int D[m]; // valid: auto VLA static int E[m]; // invalid: static block scope VLA extern int F[m]; // invalid: F has linkage and is VLA int (*s)[m]; // valid: auto pointer to VLA extern int (*r)[m]; // invalid: r has linkage and points to VLA static int (*q)[m] = &B; // valid: q is a static block pointer to VLA }
EXAMPLE 5 The following is invalid, because the use of [*] is inside an array size expression rather than directly part of the nested sequence of abstract declarators for a parameter declaration:
void f(int (*)[sizeof(int (*)[*])]);
6.7.7.4 Function declarators
Constraints
A function declarator shall not specify a return type that is a function type or an array type.
The only storage-class specifier that shall occur in a parameter declaration is register.
After adjustment, the parameters in a parameter type list in a function declarator that is part of a definition of that function shall not have incomplete type.
A parameter declaration shall not specify a void type, except for the special case of a single unnamed parameter of type void with no storage-class specifier, no type qualifier, and no following ellipsis terminator.
Semantics
If, in the declaration "T D1", D1 has the form
D ( parameter-type-listopt ) attribute-specifier-sequenceopt
and the type specified for ident in the declaration "T D" is "derived-declarator-type-list T", then the type specified for ident is "derived-declarator-type-list function returning the unqualified, non-atomic version of T". The optional attribute specifier sequence appertains to the function type.
A parameter type list specifies the types of, and can declare identifiers for, the parameters of the function.
A declaration of a parameter as "array of type" shall be adjusted to "qualified pointer to type", where the type qualifiers (if any) are those specified within the [ and ] of the array type derivation. If the keyword static also appears within the [ and ] of the array type derivation, then for each call to the function, the value of the corresponding actual argument shall provide access to the first element of an array with at least as many elements as specified by the size expression.
A declaration of a parameter as "function returning type" shall be adjusted to "pointer to function returning type", as in 6.3.3.1.
If the list terminates with an ellipsis (...), no information about the number or types of the parameters after the comma is supplied.167) Functions whose declarators use the ellipses in a parameter list are known as variadic functions. Arguments supplied to a function whose positions match or come after the ellipsis in the parameter list are its varying arguments.
The special case of an unnamed parameter of type void as the only item in the list specifies that the function has no parameters.
If, in a parameter declaration, an identifier can be treated either as a typedef name or as a parameter name, it shall be taken as a typedef name.
If the function declarator is not part of a definition of that function, parameters can have incomplete type and can use the [*] notation in their sequences of declarator specifiers to specify variable length array types.
The storage-class specifier in the declaration specifiers for a parameter declaration, if present, is ignored unless the declared parameter is one of the members of the parameter type list for a function definition. The optional attribute specifier sequence in a parameter declaration appertains to the parameter.
For a function declarator without a parameter type list: the effect is as if it were declared with a parameter type list consisting of the keyword void. A function declarator provides a prototype for the function.
Two function types are compatible if and only if all of the following hold:
- They specify compatible return types.
- The parameter type lists agree in the number of parameters and in whether the function is variadic or not.
- The corresponding parameters have compatible types.
In the determination of type compatibility and of a composite type, each parameter declared with function or array type is taken as having the adjusted type and each parameter declared with qualified type is taken as having the unqualified version of its declared type.
EXAMPLE 1
The declaration
int f(void), *fip(), (*pfi)();
declares a function f with no parameters returning an int, a function fip with no parameters returning a pointer to an int, and a pointer pfi to a function with no parameters returning an int. It is especially useful to compare the last two. The binding of *fip() is *(fip()), so that the declaration suggests, and the same construction in an expression requires, the calling of a function fip, and then using indirection through the pointer result to yield an int. In the declarator (*pfi)(), the extra parentheses are necessary to indicate that indirection through a pointer to a function yields a function designator, which is then used to call the function; it returns an int.
If the declaration occurs outside of any function, the identifiers have file scope and external linkage. If the declaration occurs inside a function, the identifiers of the functions f and fip have block scope and either internal or external linkage (depending on what file scope declarations for these identifiers are visible), and the identifier of the pointer pfi has block scope and no linkage.
EXAMPLE 2 The declaration
int (*apfi[3])(int *x, int *y);
declares an array apfi of three pointers to functions returning int. Each of these functions has two parameters that are pointers to int. The identifiers x and y are declared for descriptive purposes only and go out of scope at the end of the declaration of apfi.
EXAMPLE 3 The declaration
int (*fpfi(int (*)(long), int))(int, ...);
declares a function fpfi that returns a pointer to a function returning an int. The function fpfi has two parameters: a pointer to a function returning an int (with one parameter of type long int), and an int. The pointer returned by fpfi points to a function that has one int parameter and accepts zero or more additional arguments of any type.
EXAMPLE 4 The following prototype has a variably modified parameter.
void addscalar(int n, int m, double a[n][n*m+300], double x); int main(void) { double b[4][308]; addscalar(4, 2, b, 2.17); return 0; } void addscalar(int n, int m, double a[n][n*m+300], double x) { for (int i = 0; i < n; i++) for (int j = 0, k = n*m+300; j < k; j++) // a is a pointer to a VLA with n*m+300 elements a[i][j] += x; }
EXAMPLE 5 The following are all compatible function prototype declarators.
double maximum(int n, int m, double a[n][m]); double maximum(int n, int m, double a[*][*]); double maximum(int n, int m, double a[ ][*]); double maximum(int n, int m, double a[ ][m]);as are:
void f(double (* restrict a)[5]); void f(double a[restrict][5]); void f(double a[restrict 3][5]); void f(double a[restrict static 3][5]);
The last declaration also specifies that the argument corresponding to a in any call to f can be expected to be a non-null pointer to the first of at least three arrays of 5 doubles, which the others do not.
6.7.8 Type names
Syntax
- direct-abstract-declarator:
(abstract-declarator)- array-abstract-declarator attribute-specifier-sequenceopt
- function-abstract-declarator attribute-specifier-sequenceopt
- array-abstract-declarator:
- direct-abstract-declaratoropt
[type-qualifier-listopt assignment-expressionopt] - direct-abstract-declaratoropt
[ statictype-qualifier-listopt assignment-expression] - direct-abstract-declaratoropt
[type-qualifier-liststaticassignment-expression] - direct-abstract-declaratoropt
[ * ]
Semantics
In several contexts, it is necessary to specify a type. This is accomplished using a type name, which is syntactically a declaration for a function or an object of that type that omits the identifier.168) The optional attribute specifier sequence in a direct abstract declarator appertains to the preceding array or function type. The attribute specifier sequence affects the type only for the declaration it appears in, not other declarations involving the same type.
EXAMPLE The constructions
(a) int (b) int * (c) int *[3] (d) int (*)[3] (e) int (*)[*] (f) int *() (g) int (*)(void) (h) int (*const [])(unsigned int, ...)
name respectively the types
(a) int,
(b) pointer to int,
(c) array of three pointers to int,
(d) pointer to an array of three int s,
(e) pointer to a variable length array of an unspecified number of ints,
(f) function with no parameters returning a pointer to int,
(g) pointer to function with no parameters returning an int, and
(h) array of an unspecified number of constant pointers to functions, each with one parameter that has type unsigned int and an unspecified number of other parameters, returning an int.
6.7.9 Type definitions
Syntax
Constraints
If a typedef name specifies a variably modified type then it shall have block scope.
Semantics
In a declaration whose storage-class specifier is typedef, each declarator defines an identifier to be a typedef name that denotes the type specified for the identifier in the way described in 6.7.7. Any array size expressions associated with variable length array declarators and typeof operators are evaluated each time the declaration of the typedef name is reached in the order of execution. A typedef declaration does not introduce a new type, only a synonym for the type so specified. That is, in the following declarations:
typedef T type_ident; type_ident D;
type_ident is defined as a typedef name with the type specified by the declaration specifiers in T (known as T), and the identifier in D has the type "derived-declarator-type-list T" where the deriveddeclarator-type-list is specified by the declarators of D. A typedef name shares the same name space as other identifiers declared in ordinary declarators. If the identifier is redeclared in an enclosed block, the type of the inner declaration shall not be inferred (6.7.10).
EXAMPLE 1
After
typedef int MILES, KLICKSP(); typedef struct { double hi, lo; } range;the constructions
MILES distance; extern KLICKSP *metricp; range x; range z, *zp;
are all valid declarations. The type of distance is int, that of metricp is "pointer to function with no parameters returning int", and that of x and z is the specified structure; zp is a pointer to such a structure. The object distance has a type compatible with any other int object.
EXAMPLE 2
After the declarations
typedef struct s1 { int x; } t1, *tp1; typedef struct s2 { int x; } t2, *tp2;
type t1 and the type pointed to by tp1 are compatible. Type t1 is also compatible with type struct s1, but not compatible with the types struct s2, t2, the type pointed to by tp2, or int.
typedef signed int t; typedef int plain; struct tag { unsigned t:4; const t:5; plain r:5; }; t f(t (t)); long t;
EXAMPLE 4
On the other hand, typedef names can be used to improve code readability. All three of the following declarations of the signal function specify exactly the same type, the first without making use of any typedef names.
typedef void fv(int), (*pfv)(int); void (*signal(int, void (*)(int)))(int); fv *signal(int, fv *); pfv signal(int, pfv);
EXAMPLE 5 If a typedef name denotes a variable length array type, the length of the array is fixed at the time the typedef name is defined, not each time it is used:
void copyt(int n) { typedef int B[n]; // B is n ints, n evaluated now n += 1; B a; // a is n ints, n without += 1 int b[n]; // a and b are different sizes for (int i = 1; i < n; i++) a[i-1] = b[i]; }
6.7.10 Type inference
Constraints
A declaration for which the type is inferred shall contain the storage-class specifier auto.
Semantics
For such a declaration that is the definition of an object the init-declarator shall have the form
direct-declarator = assignment-expression
The inferred type of the declared object is the type of the assignment expression after lvalue, array to pointer or function to pointer conversion, additionally qualified by qualifiers and amended by
NOTE A declaration that also defines a structure or union type has implementation-defined behavior. Here, the identifier x which is not ordinary but in the name space of the structure type is declared.
auto p = (struct { int x; } *)0;Even a forward declaration of a structure tag
struct s; auto p = (struct s { int x; } *)0;would not change that situation. A direct use of the structure definition as the type specifier ensures portability of the declaration.
struct s { int x; } * p = 0;The following also has implementation-defined behavior:
auto alignas (struct s *) x = 0;
EXAMPLE 1 The following file scope definitions:
static auto a = 3.5; auto p = &a;are interpreted as if they had been written as:
static double a = 3.5; double * p = &a;
So effectively a is a double and p is a double*. The restrictions on the syntax of such declarations does not allow the declarator to be *p, but that the final type here nevertheless is a pointer type.
EXAMPLE 2 The scope of the identifier for which the type is inferred only starts after the end of the initializer (6.2.1), so the assignment expression cannot use the identifier to refer to the object or function that is declared, for example to take its address. Any use of the identifier in the initializer is invalid, even if an entity with the same name exists in an outer scope.
{
double a = 7;
double b = 9;
{
double b = b * b; // undefined, uses uninitialized
// variable without address
printf("%g\n", a); // valid, uses a from outer scope, prints 7
auto a = a * a; // invalid, a from outer scope is not
// visible during initialization
}
{
auto b = a * a; // valid, uses a from outer scope
auto a = b; // valid, a from outer scope not visible now
// ...
printf("%g\n", a); // valid, uses a from inner scope, prints 49
}
// ...
}EXAMPLE 3 In the following, declarations of pA and qA are valid. The type of A after array-to-pointer conversion is a pointer type, and qA is a pointer to array.
double A[3] = { 0 }; auto pA = A; auto qA = &A;
EXAMPLE 4 Type inference can be used to capture the type of a call to a type-generic function. It ensures that the same type as the argument x is used.
#include <tgmath.h> auto y = cos(x);
If instead the type of y is explicitly specified to a different type than x, a diagnosis of the mismatch is not enforced.
EXAMPLE 5 A type-generic macro that generalizes the div functions (7.25.7.2) is defined and used as follows.
#define div(X, Y) _Generic((X)+(Y),\ int: div,\ long: ldiv,\ long long: lldiv)((X), (Y)) auto z = div(x, y); auto q = z.quot; auto r = z.rem;
EXAMPLE 6 Definitions of objects with inferred type are valid in all contexts that allow the initializer syntax as described. In particular they can be used to ensure type safety of for-loop controlling expressions.
for (auto i = j; i < 2*j; ++i) { // ... }
Here, regardless of the integer rank or signedness of the type of j, i will have the non-atomic unqualified version of j’s type. So, after lvalue conversion and possible promotion, the two operands of the < operator in the controlling expression are guaranteed to have the same type, and, in particular, the same signedness.
6.7.11 Initialization
Syntax
- braced-initializer:
{ }{initializer-list}{initializer-list, }
An empty brace pair ({}) is called an empty initializer and is referred to as empty initialization.
Constraints
No initializer shall attempt to provide a value for an object not contained within the entity being initialized.
The type of the entity to be initialized shall be an array of unknown size or a complete object type. An entity of variable length array type shall not be initialized except by an empty initializer. An array of unknown size shall not be initialized by an empty initializer.
The initializer for a scalar shall be a single expression, optionally enclosed in braces, or it shall be an empty initializer.
The initializer for an object that has structure or union type shall be either a single expression that has compatible type or a brace-enclosed list of initializers for the members other than unnamed bit-fields.
The initializer for an array shall be either a string literal, optionally enclosed in braces, or a braceenclosed list of initializers for the elements. An array initialized by a character string literal or UTF-8 string literal shall have a character type as element type. An array initialized with a wide string literal shall have element type compatible with a qualified or unqualified wchar_t, char16_t, or char32_t, and the string literal shall have the corresponding encoding prefix (L, u, or U, respectively).
All the expressions in an initializer for an object that has static or thread storage duration or is declared with the constexpr storage-class specifier shall be constant expressions or string literals.
If the declaration of an identifier has block scope, and the identifier has external or internal linkage, the declaration shall have no initializer for the identifier.
If a designator has the form
then the current object (defined subsequently in this subclause) shall have array type and the expression shall be an integer constant expression. If the array is of unknown size, any nonnegative value is valid.
If a designator has the form
then the current object (defined subsequently in this subclause) shall have structure or union type and the identifier shall be the name of a member of that type.
Semantics
An initializer specifies the initial value stored in an object. For objects with atomic type additional restrictions apply, see 7.17.2 and 7.17.8.
Except where explicitly stated otherwise, for the purposes of this subclause unnamed bit-fields do not participate in initialization. Unnamed bit-field members of structure objects have indeterminate representation even after initialization.
If an object that has automatic storage duration is not initialized explicitly, its representation is indeterminate. If an object that has static or thread storage duration is not initialized explicitly, or any object is initialized with an empty initializer, then it is subject to default initialization, which initializes an object as follows:
If the initializer for a scalar is not the empty initializer, the initial value of the object is that of the expression (after conversion); the same type constraints and conversions as for simple assignment apply, taking the type of the scalar to be the unqualified version of its declared type.
The rest of this subclause deals with initializers for objects that have aggregate or union type.
If the initializer for a struct or a union is a single expression, the initial value of the object, including unnamed bit-fields, is that of the expression.172)
For an array of character type initialized by an ordinary string literal or UTF-8 string literal, successive bytes of the string literal (including the terminating null character if there is room or if the array is of unknown size) initialize the elements of the array.
For an array initialized by a wide string literal, successive wide characters of the wide string literal (including the terminating null wide character if there is room or if the array is of unknown size) initialize the elements of the array.
When a structure or union object is initialized using a brace-enclosed initializer list, any anonymous structure or union members of the object participate in initialization in the same way as named members, except that they cannot be described by designators. For the purposes of initialization, the members of an anonymous structure or union are treated as being members of the anonymous structure or union object rather than of the structure or union that contains it, but they may be described by designators as if they are members of the containing structure or union.
Each brace-enclosed initializer list has an associated current object. When no designations are present, subobjects of the current object are initialized in order according to the type of the current object: array elements in increasing subscript order, structure members (other than unnamed bit-fields) in declaration order, and the first member of a union that is not an unnamed bit-field.173) In contrast, a designation causes the following initializer to begin initialization of the subobject described by the designator. Initialization then continues forward in order, beginning with the next subobject after that described by the designator.174)
Each designator list begins its description with the current object associated with the closest surrounding brace pair. Each item in the designator list (in order) specifies a particular member of its current object and changes the current object for the next designator (if any) to be that member.175)
The current object that results at the end of the designator list is the subobject to be initialized by the following initializer.
The initialization shall occur in initializer list order, each initializer provided for a particular subobject overriding any previously listed initializer for the same subobject;176) all subobjects that are not initialized explicitly are subject to default initialization.
If the aggregate or union contains elements or members that are aggregates or unions, these rules apply recursively to the subaggregates or contained unions. If the initializer of a subaggregate or contained union begins with a left brace, the initializers enclosed by that brace and its matching right brace initialize the elements or members of the subaggregate or the contained union. Otherwise, only enough initializers from the list are taken to account for the elements or members of the subaggregate or the first member of the contained union; any remaining initializers are left to initialize the next element or member of the aggregate of which the current subaggregate or contained union is a part.
If there are fewer initializers in a brace-enclosed list than there are elements or members of an aggregate, or fewer characters in a string literal used to initialize an array of known size than there are elements in the array, the remainder of the aggregate is subject to default initialization.
If an array of unknown size is initialized, its size is determined by the largest indexed element with an explicit initializer. The array type is completed at the end of its initializer list.
The evaluations of the initialization list expressions are indeterminately sequenced with respect to one another and thus the order in which any side effects occur is unspecified.177)
EXAMPLE 1 Provided that <complex.h> has been included, the declarations
int i = 3.5; double complex c = 5 + 3 * I;
define and initialize i with the value 3 and c with the value .
EXAMPLE 2 The declaration
int x[] = { 1, 3, 5 };
defines and initializes x as a one-dimensional array object that has three elements, as no size was specified and there are three initializers.
EXAMPLE 3 The declaration
int y[4][3] = { { 1, 3, 5 }, { 2, 4, 6 }, { 3, 5, 7 }, };is a definition with a fully bracketed initialization: 1, 3, and 5 initialize the first row of
y (the array object y[0]), namely y[0][0], y[0][1], and y[0][2]. Likewise the next two lines initialize y[1] and y[2]. The initializer ends early, so y[3] is initialized with zeros. Precisely the same effect can be achieved byint y[4][3] = { 1, 3, 5, 2, 4, 6, 3, 5, 7 };
The initializer for y[0] does not begin with a left brace, so three items from the list are used. Likewise the next three are taken successively for y[1] and y[2].
EXAMPLE 4 The declaration
int z[4][3] = { { 1 }, { 2 }, { 3 }, { 4 } };
initializes the first column of z as specified and initializes the rest with zeros.
EXAMPLE 5
The declaration
struct { int a[3], b; } w[] = { { 1 }, 2 };
is a definition with an inconsistently bracketed initialization. It defines an array with two element structures: w[0].a[0] is 1 and w[1].a[0] is 2; all the other elements are zero.
EXAMPLE 6 The declaration
short q[4][3][2] = { { 1 }, { 2, 3 }, { 4, 5, 6 } };contains an incompletely but consistently bracketed initialization. It defines a three-dimensional array object:
q[0][0][0] is 1, q[1][0][0] is 2, q[1][0][1] is 3, and 4, 5, and 6 initialize q[2][0][0], q[2][0][1], and q[2][1][0], respectively; all the rest are zero. The initializer for q[0][0] does not begin with a left brace, so up to six items from the current list can be used. There is only one, so the values for the remaining five elements are initialized with zero. Likewise, the initializers for q[1][0] and q[2][0] do not begin with a left brace, so each uses up to six items, initializing their respective two-dimensional subaggregates. If there had been more than six items in any of the lists, a diagnostic message would have been issued. The same initialization result can be achieved by:short q[4][3][2] = { 1, 0, 0, 0, 0, 0, 2, 3, 0, 0, 0, 0, 4, 5, 6 };or by:
short q[4][3][2] = { { { 1 }, }, { { 2, 3 }, }, { { 4, 5 }, { 6 }, } };
in a fully bracketed form.
The fully bracketed and minimally bracketed forms of initialization are, in general, less likely to cause confusion.
EXAMPLE 7
One form of initialization that completes array types involves typedef names. Given the declaration
typedef int A[]; // OK - declared with block scopethe declaration
A a = { 1, 2 }, b = { 3, 4, 5 };is identical to
int a[] = { 1, 2 }, b[] = { 3, 4, 5 };
EXAMPLE 8 The declaration
char s[] = "abc", t[3] = "abc";defines "plain"
char array objects s and t whose elements are initialized with ordinary string literals. This declaration is identical tochar s[] = { ’a’, ’b’, ’c’, ’\0’ }, t[] = { ’a’, ’b’, ’c’ };The contents of the arrays are modifiable. On the other hand, the declaration
char *p = "abc";
defines p with type "pointer to char" and initializes it to point to an object with type "array of char" with length 4 whose elements are initialized with an ordinary string literal. If an attempt is made to use p to modify the contents of the array, the behavior is undefined.
EXAMPLE 9 Arrays can be initialized to correspond to the elements of an enumeration by using designators:
enum { member_one, member_two }; const char *nm[] = { [member_two] = "member two", [member_one] = "member one", };
EXAMPLE 10 Structure members can be initialized to nonzero values without depending on their order:
div_t answer = {.quot = 2, .rem = -1 };
EXAMPLE 11
Designators can be used to provide explicit initialization when unadorned initializer lists are difficult to understand:
struct { int a[3], b; } w[] = { [0].a = {1}, [1].a[0] = 2 };
EXAMPLE 12
struct T int k; int l;
;
struct S {
int i;
struct T t ;
};
struct T x = {. l = 43, . k = 42, };
void f ( void )
{
struct S l = { 1, . t = x , . t . l = 41, };
}The value of l.t.k is , because implicit initialization does not override explicit initialization.
EXAMPLE 13 Space can be "allocated" from both ends of an array by using a single designator:
int a[A_MAX] = { 1, 3, 5, 7, 9, [A_MAX-5] = 8, 6, 4, 2, 0 };
EXAMPLE 15 The declarations
struct { int a:10; int :12; long b; } s = {1, 2}; union { int :16; char c; } u = {3};
initialize s.a to 1, s.b to 2, and u.c to 3. The unnamed bit-field in s has indeterminate representation even after initialization.
EXAMPLE 16
The declaration
struct { union { float a; int b; void *p; }; char c; } s = {{.b = 1}, 2};initializes
s.b to 1 and s.c to 2. Members of the anonymous union can also be described by designators as if they are members of the containing structure, so the same initialization result can be achieved by:struct { union { float a; int b; void *p; }; char c; } s = {.b = 1, 2};
<stddef.h> (7.22).6.7.12 Static assertions
Syntax
- static_assert-declaration:
static_assert(constant-expression,string-literal) ;static_assert(constant-expression) ;
Constraints
The constant expression shall be an integer constant expression with a nonzero value.
Semantics
A static assertion has no effect.
Recommended practice
If the constraint is violated with an integer constant expression of value zero, the diagnostic message should include the text of the string literal, if present.
6.7.13 Attributes
6.7.13.1 Introduction
Attributes specify additional information for various source constructs such as types, objects, identifiers, or blocks. They are identified by an attribute token, which can either be a attribute prefixed token (for implementation-specific attributes) or a standard attribute specified by an identifier (for attributes specified in this document).
Support for any of the standard attributes specified in this document is implementation-defined and optional. For an attribute token (including an attribute prefixed token) not specified in this document, the behavior is implementation-defined. Any attribute token that is not supported by the implementation is ignored.
Attributes are said to appertain to some source construct, identified by the syntactic context where they appear, and for each individual attribute, the corresponding clause constrains the syntactic context in which this appurtenance is valid. The attribute specifier sequence appertaining to some source construct shall contain only attributes that are allowed to apply to that source construct.
In all aspects of the language, a standard attribute specified by this document as an identifier attr and an identifier of the form __attr__ shall behave the same when used as an attribute token, except for the spelling.178)
For all standard attributes specified by this document, the current value when its token sequence is given to the __has_c_attribute conditional inclusion expression (6.10.2) is written in the associated subclause for that attribute. A history of those values can be found in Table M.1.
Recommended practice
It is recommended that implementations support all standard attributes as defined in this document.
6.7.13.2 General
Syntax
- attribute-specifier:
[ [attribute-list] ]
- balanced-token:
(balanced-token-sequenceopt)[balanced-token-sequenceopt]{balanced-token-sequenceopt}- any token other than a parenthesis, a bracket, or a brace
Constraints
The identifier in a standard attribute shall be one of:
deprecated fallthrough
maybe_unused nodiscard
noreturn _Noreturn
unsequenced reproducible
Semantics
An attribute specifier that contains no attributes has no effect. The order in which attribute tokens appear in an attribute list is not significant. If a keyword (6.4.2) that satisfies the syntactic requirements of an identifier (6.4.3) is contained in an attribute token, it is considered an identifier. A strictly conforming program using a standard attribute remains strictly conforming in the absence of that attribute.179)
NOTE For each standard attribute, the form of the balanced token sequence, if any, will be specified.
Recommended practice
Each implementation should choose a distinctive name for the attribute prefix in an attribute prefixed token. Implementations should not define attributes without an attribute prefix unless it is a standard attribute as specified in this document.
EXAMPLE 1
Suppose that an implementation chooses the attribute prefix hal and provides specific attributes named daisy and rosie.
[[deprecated, hal::daisy]] double nine1000(double); [[deprecated]] [[hal::daisy]] double nine1000(double); [[deprecated]] double nine1000 [[hal::daisy]] (double);
Then all the following declarations should be equivalent aside from the spelling:
[[__deprecated__, __hal__::__daisy__]] double nine1000(double); [[__deprecated__]] [[__hal__::__daisy__]] double nine1000(double); [[__deprecated__]] double nine1000 [[__hal__::__daisy__]] (double);
EXAMPLE 2
For the same implementation, the following two declarations are equivalent, because the ordering inside attribute lists is not important.
[[hal::daisy, hal::rosie]] double nine999(double); [[hal::rosie, hal::daisy]] double nine999(double);On the other hand the following two declarations are not equivalent, because the ordering of different attribute specifiers can affect the semantics.
[[hal::daisy]] [[hal::rosie]] double nine999(double); [[hal::rosie]] [[hal::daisy]] double nine999(double); // can have different semantics
6.7.13.3 The nodiscard attribute
Constraints
The nodiscard attribute shall be applied to a function or to the definition of a structure, union, or enumerated type. If an attribute argument clause is present, it shall have the form:
( string-literal )
Semantics
The __has_c_attribute conditional inclusion expression (6.10.2) shall return the value 202311L when given nodiscard as the pp-tokens operand if the implementation supports the attribute.
A name or entity declared without the nodiscard attribute can later be redeclared with the attribute and vice versa. An entity is considered marked after the first declaration that marks it.
Recommended practice
A nodiscard call is a function call expression that calls a function previously declared with attribute nodiscard, or whose return type is a structure, union, or enumerated type marked with attribute nodiscard. Evaluation of a nodiscard call as a void expression (6.8.4) is discouraged unless explicitly cast to void. Implementations are encouraged to issue a diagnostic in such cases. This is typically because immediately discarding the return value of a nodiscard call has surprising consequences.
The diagnostic message should include text provided by the string literal within the attribute argument clause of any nodiscard attribute applied to the name or entity.
EXAMPLE 1
struct [[nodiscard]] error_info { /*...*/ }; struct error_info enable_missile_safety_mode(void); void launch_missiles(void); void test_missiles(void) { enable_missile_safety_mode(); launch_missiles(); }
A diagnostic for the call to enable_missile_safety_mode is encouraged.
EXAMPLE 2
[[nodiscard]] int important_func(void); void call(void) { int i = important_func(); }
EXAMPLE 3
[[nodiscard("armer needs to check armed state")]] bool arm_detonator(int within); void call(void) { arm_detonator(3); detonate(); }
A diagnostic for the call to arm_detonator using the string literal "armer needs to check armed state" from the attribute argument clause is encouraged.
6.7.13.4 The maybe_unused attribute
Constraints
The maybe_unused attribute shall be applied to the declaration of a structure, a union, a typedef name, an object, a structure or union member, a function, an enumeration, an enumerator, or a label. No attribute argument clause shall be present.
Semantics
The maybe_unused attribute indicates that a name or entity is possibly intentionally unused.
The __has_c_attribute conditional inclusion expression (6.10.2) shall return the value 202311L when given maybe_unused as the pp-tokens operand if the implementation supports the attribute.
A name or entity declared without the maybe_unused attribute can later be redeclared with the attribute and vice versa. An entity is considered marked with the attribute after the first declaration that marks it.
Recommended practice
For an entity marked maybe_unused, implementations are encouraged not to emit a diagnostic that the entity is unused, or that the entity is used despite the presence of the attribute.
EXAMPLE
[[maybe_unused]] void f([[maybe_unused]] int i) { [[maybe_unused]] int j = i + 100; assert(j); }
Implementations are encouraged not to diagnose that j is unused, even if NDEBUG is defined.
6.7.13.5 The deprecated attribute
Constraints
The deprecated attribute shall be applied to the declaration of a structure, a union, a typedef name, an object, a structure or union member, a function, an enumeration, or an enumerator.
Semantics
The deprecated attribute can be used to mark names and entities whose use is still allowed, but is discouraged for some reason.180)
The __has_c_attribute conditional inclusion expression (6.10.2) shall return the value 202311L when given deprecated as the pp-tokens operand if the implementation supports the attribute.
A name or entity declared without the deprecated attribute can later be redeclared with the attribute and vice versa. An entity is considered marked with the attribute after the first declaration that marks it.
Recommended practice
Implementations should use the deprecated attribute to produce a diagnostic message in case the program refers to a name or entity other than to declare it, after a declaration that specifies the attribute, when the reference to the name or entity is not within the context of a related deprecated entity. The diagnostic message should include text provided by the string literal within the attribute argument clause of any deprecated attribute applied to the name or entity.
EXAMPLE
struct [[deprecated]] S { int a; }; enum [[deprecated]] E1 { one }; enum E2 { two [[deprecated("use ’three’ instead")]], three }; [[deprecated]] typedef int Foo; void f1(struct S s) { // Diagnose use of S int i = one; // Diagnose use of E1 int j = two; // Diagnose use of two: "use ’three’ instead" int k = three; Foo f; // Diagnose use of Foo } [[deprecated]] void f2(struct S s) { int i = one; int j = two; int k = three; Foo f; } struct [[deprecated]] T { Foo f; struct S s; };
Implementations are encouraged to diagnose the use of deprecated entities within a context which is not itself deprecated, as indicated for function f1, but not to diagnose within function f2 and struct T, as they are themselves deprecated.
6.7.13.6 The fallthrough attribute
Constraints
The attribute token fallthrough shall only appear in an attribute declaration (6.7); such a declaration is a fallthrough declaration. No attribute argument clause shall be present. A fallthrough declaration can only appear within an enclosing switch statement (6.8.5.3). The next block item (6.8.3) that would be encountered after a fallthrough declaration shall be a case label or default label associated with the innermost enclosing switch statement and, if the fallthrough declaration is contained in an iteration statement, the next statement shall be part of the same execution of the secondary block of the innermost enclosing iteration statement.
Semantics
The __has_c_attribute conditional inclusion expression (6.10.2) shall return the value 202311L when given fallthrough as the pp-tokens operand if the implementation supports the attribute.
Recommended practice
The use of a fallthrough declaration is intended to suppress a diagnostic that an implementation can otherwise issue for a case or default label that is reachable from another case or default label along some path of execution. Implementations are encouraged to issue a diagnostic if a fallthrough declaration is not dynamically reachable.
EXAMPLE
void f(int n) { void g(void), h(void), i(void); switch (n) { case 1: /* diagnostic on fallthrough discouraged */ case 2: g(); [[fallthrough]]; case 3: /* diagnostic on fallthrough discouraged */ do { [[fallthrough]]; /* constraint violation: next statement is not part of the same secondary block execution */ } while(false); case 6: do { [[fallthrough]]; /* constraint violation: next statement is not part of the same secondary block execution */ } while (n--); case 7: while (false) { [[fallthrough]]; /* constraint violation: next statement is not part of the same secondary block execution */ } case 5: h(); case 4: /* fallthrough diagnostic encouraged */ i(); [[fallthrough]]; /* constraint violation */ } }
6.7.13.7 The noreturn and _Noreturn attributes
Description
When _Noreturn is used as an attribute token (instead of a function specifier), the constraints and semantics are identical to that of the noreturn attribute token. Use of _Noreturn as an attribute token is an obsolescent feature.181)
Constraints
The noreturn attribute shall be applied to a function. No attribute argument clause shall be present.
Semantics
The first declaration of a function shall specify the noreturn attribute if any declaration of that function specifies the noreturn attribute. If a function is declared with the noreturn attribute in one translation unit and the same function is declared without the noreturn attribute in another translation unit, the behavior is undefined.
If a function f is called where f was previously declared with the noreturn attribute and f eventually returns, the behavior is undefined.
The __has_c_attribute conditional inclusion expression (6.10.2) shall return the value 202311L when given noreturn as the pp-tokens operand if the implementation supports the attribute.
Recommended practice
The implementation should produce a diagnostic message for a function declared with a noreturn attribute that appears to be capable of returning to its caller.
EXAMPLE
[[noreturn]] void f(void) { abort(); // ok } [[noreturn]] void g(int i) { // causes undefined behavior if i <= 0 if (i > 0) abort(); } [[noreturn]] int h(void);
Implementations are encouraged to diagnose the definition of g() because it is capable of returning to its caller. Implementations are similarly encouraged to diagnose the declaration of h() because it appears capable of returning to its caller due to the non-void return type.
6.7.13.8 Standard attributes for function types
6.7.13.8.1 General
Constraints
An attribute for a function type shall be applied to a function declarator182) or to a type specifier that has a function type. The corresponding attribute is a property of the function type.183) No attribute argument clause shall be present.
Description
The main purpose of the function type properties and attributes defined in this clause is to provide the translator with information about the access of objects by a function such that certain properties of function calls can be deduced; the properties distinguish read operations (stateless and independent) and write operations (effectless, idempotent and reproducible) or a combination of both (unsequenced). Although semantically attached to a function type, the attributes described are not part of the prototype of such a function, and redeclarations and conversions that drop such an attribute are valid and constitute compatible types. Conversely, if a definition that does not have the
To allow reordering of calls to functions as they are described here, possible access to objects with a lifetime that starts before or ends after a call has to be restricted; effects on all objects that are accessed during a function call are restricted to the same thread as the call and the based-on relation between pointer parameters and lvalues (6.7.4.2) models the fact that objects do not change inadvertently during the call. In the following, an operation is said to be sequenced during a function call if it is sequenced after the start of the function call185) and before the call terminates. An object definition of an object in a function escapes if an access to happens while no call to is active. An object is local to a call to a function if its lifetime starts and ends during the call or if it is defined by but does not escape. A function call and an object synchronize if all accesses to that are not sequenced during the call happen before or after the call. Execution state that is described in the library clause, such as the floating-point environment, conversion state, locale, input/output streams, external files or errno are considered as objects for the purposes of these attributes; operations that access this state, even indirectly, are considered as lvalue conversions for the purposes of these attributes, and operations that allow to change this state are considered as store operations, for the purposes of these attributes.
A function definition is stateless if any definition of an object of static or thread storage duration in or in a function that is called by is const but not volatile qualified.
An object is observed by a function call if both synchronize, if is not local to the call, if has a lifetime that starts before the function call and if an access of is sequenced during the call; the last value of , if any, that is stored before the call is said to be the value of that is observed by the call. A function pointer value is independent if for any object that is observed by some call to through an lvalue that is not based on a parameter of the call, then all accesses to in all calls to during the same program execution observe the same value; otherwise if the access is based on a pointer parameter, there shall be a unique such pointer parameter such that any access to shall be to an lvalue that is based on . A function definition is independent if the derived function pointer value is independent.
A store operation to an object that is sequenced during a function call such that both synchronize is said to be observable if is not local to the call, if the lifetime of ends after the call, if the stored value is different from the value observed by the call, if any, and if it is the last value written before the termination of the call. An evaluation of a function call186) is effectless if any store operation that is sequenced during the call is the modification of an object that synchronizes with the call; if additionally the operation is observable, there shall be a unique pointer parameter of the function such that any access to shall be to an lvalue that is based on . A function pointer value is effectless if any evaluation of a function call that calls is effectless. A function definition is effectless if the derived function pointer value is effectless.
An evaluation is idempotent if a second evaluation of can be sequenced immediately after the original one without changing the resulting value, if any, or the observable state of the execution. A function pointer value is idempotent if any evaluation of a function call187) that calls is idempotent. A function definition is idempotent if the derived function pointer value is idempotent.
A function is reproducible if it is effectless and idempotent; it is unsequenced if it is stateless, effectless, idempotent and independent.188)
NOTE 1 The synchronization requirements with respect to any accessed object for the independence of functions provide boundaries up to which a function call can safely be reordered without changing the semantics of the program. If is const but not volatile qualified the reordering is unconstrained. If it is an object that is conditioned in an initialization phase, for a single threaded program a synchronization is provided by the sequenced before relation and the reordering can, in principle, move the call just after the initialization. For a multi-threaded program, synchronization guarantees can be given by calls to synchronizing functions of the <threads.h> header or by an appropriate call to atomic_thread_fence at the end of the initialization phase. If a function is known to be independent or effectless, adding restrict qualifications to the declarations of all pointer parameters does not change the semantics of any call. Similarly, changing the memory order to memory_order_relaxed for all atomic operations during a call to such a function preserves semantics.
NOTE 2 In general the functions provided by the <math.h> header do not have the properties that are defined previously in this subclause; many of them change the floating-point state or errno when they encounter an error (so they have observable side effects) and the results of most of them depend on execution-wide state such as the rounding direction mode (so they are not independent). Whether a particular C library function is reproducible or unsequenced additionally often depends on properties of the implementation, such as implementation-defined behavior for certain error conditions.
Recommended practice
If possible, it is recommended that implementations diagnose if an attribute of this clause is applied to a function definition that does not have the corresponding property. It is recommended that applications that assert the independent or effectless properties for functions qualify pointer parameters with restrict.
<errno.h> (7.5), floating-point environment <fenv.h> (7.6), localization <locale.h> (7.11), mathematics <math.h> (7.12), fences (7.17.4), input/output <stdio.h> (7.24), threads <threads.h> (7.30), extended multibyte and wide character utilities <wchar.h> (7.33).6.7.13.8.2 The reproducible type attribute
Description
The reproducible type attribute asserts that a function or pointed-to function with that type is reproducible.
The __has_c_attribute conditional inclusion expression (6.10.2) shall return the value 202311L when given reproducible as the pp-tokens operand if the implementation supports the attribute.
EXAMPLE The attribute in the following function declaration asserts that two consecutive calls to the function will result in the same return value. Changes to the abstract state during the call are possible as long as they are not observable, but no other side effects will occur. Thus the function definition can for example use local objects of static or thread storage duration to keep track of the arguments for which the function has been called and cache their computed return values.
size_t hash(char const[static 32]) [[reproducible]];
6.7.13.8.3 The unsequenced type attribute
Description
The unsequenced type attribute asserts that a function or pointed-to function with that type is unsequenced.
The __has_c_attribute conditional inclusion expression (6.10.2) shall return the value 202311L when given unsequenced as the pp-tokens operand if the implementation supports the attribute.
NOTE 1 The unsequenced type attribute asserts strong properties for such a function, in particular that certain sequencing requirements for function calls can be relaxed without affecting the state of the abstract machine. Thereby, calls to such functions are natural candidates for optimization techniques such as common subexpression elimination, local memoization or lazy evaluation.
NOTE 2 A proof of validity of the annotation of a function type with the unsequenced attribute can depend on the property of whether a derived function pointer escapes the translation unit or not. For a function with internal linkage where no function pointer escapes the translation unit, all calling contexts are known and it is possible, in principle, to prove that no control flow exists such that a library function is called with arguments
NOTE 3 The unsequenced property does not necessarily imply that the function is reentrant or that calls can be executed concurrently. This is because an unsequenced function can read from and write to objects of static storage duration, as long as no change is observable after a call terminates.
EXAMPLE 1 The attribute in the following function declaration asserts that it doesn’t depend on any modifiable state of the abstract machine. Calls to the function can be executed out of sequence before the return value is needed and two calls to the function with the same argument value will result in the same return value.
bool tendency(signed char) [[unsequenced]];
Therefore such a call for a given argument value needs only to be executed once and the returned value can be reused when appropriate. For example, calls for all possible argument values can be executed during program startup and tabulated.
EXAMPLE 2 The attribute in the following function declaration asserts that it doesn’t depend on any modifiable state of the abstract machine. Within the same thread, calls to the function can be executed out of sequence before the return value is needed and two calls to the function will result in the same pointer return value. Therefore such a call needs only to be executed once in a given thread and the returned pointer value can be reused when appropriate. For example, a single call can be executed during thread startup and the return value p and the value of the object *p of type toto const can be cached.
typedef struct toto toto; toto const* toto_zero(void) [[unsequenced]];
6.8 Statements and blocks
6.8.1 General
Syntax
Semantics
A statement specifies an action to be performed. Except as indicated, statements are executed in sequence. The optional attribute specifier sequence appertains to the respective statement.
A block is either a primary block, a secondary block, or the block associated with a function definition; it allows a set of declarations and statements to be grouped into one syntactic unit. Whenever a block B appears in the syntax production as part of the definition of an enclosing block A, scopes of identifiers and lifetimes of objects that are associated with B do not extend to the parts of A that are outside of B. The initializers of objects that have automatic storage duration, and any size expressions and typeof operators in declarations of ordinary identifiers with block scope, are evaluated and the values are stored in the objects (the representation of objects without an initializer becomes indeterminate) each time the declaration is reached in the order of execution, as if it were a statement, and within each declaration in the order that declarators appear.
A full expression is an expression that is not part of another expression, nor part of a declarator or abstract declarator. There is also an implicit full expression in which the non-constant size expressions for a variably modified type are evaluated; within that full expression, the evaluation of different size expressions are unsequenced with respect to one another. There is a sequence point between the evaluation of a full expression and the evaluation of the next full expression to be evaluated.
NOTE Each of the following is a full expression:
- a full declarator for a variably modified type,
- an initializer that is not part of a compound literal,
- the expression in an expression statement,
- the controlling expression of a selection statement (
iforswitch), - the controlling expression of a
whileordostatement, - each of the (optional) expressions of a
forstatement, - the (optional) expression in a
returnstatement.
While a constant expression satisfies the definition of a full expression, evaluating it does not depend on nor produce any side effects, so the sequencing implications of being a full expression are not relevant to a constant expression.
return statement (6.8.7.5).6.8.2 Labeled statements
Syntax
Constraints
A case or default label shall appear only in a switch statement. Further constraints on such labels are discussed under the switch statement.
Label names shall be unique within a function.
Semantics
Any statement or declaration in a compound statement can be preceded by a prefix that declares an identifier as a label name. The optional attribute specifier sequence appertains to the label. Labels in themselves do not alter the flow of control, which continues unimpeded across them.
A case label specifies the value of the following constant expression, if followed by a single constant expression, or each value in the sequence described by the following range, if followed by a constant range expression.
If a statement following a label is an iteration or switch statement, that statement is named by the label label. If a statement following a label is a labeled statement, the statement named by this label is the same statement named within the nested labeled statement, if any.189)
EXAMPLE Only an iteration or switch statement may be named by a label, by appearing as its immediate syntactic operand:
loop: for (int i = 0; i < IK; ++ i) { // this for is named by "loop:" /* ... */ } braces: { // no statement is named by "braces:" for (int i = 0; i < IK; ++ i) { /* ... */ } }
goto statement (6.8.7.2), the break statement (6.8.7.4), the switch statement (6.8.5.3).6.8.3 Compound statement
Syntax
Semantics
A compound statement that is a function body together with the parameter type list and the optional attribute specifier sequence between them forms the block associated with the function definition in which it appears. Otherwise, it is a block that is different from any other block. A label that is not followed by another label or an unlabeled statement shall be translated as if it were followed by a null statement.
A statement that follows one or more labels without other intervening block items is named by those labels, if it would be eligible to be named by the labels of a labeled statement (6.8.2).
6.8.4 Expression and null statements
Syntax
Semantics
The attribute specifier sequence appertains to the expression. The expression in an expression statement is evaluated as a void expression for its side effects.190)
A null statement (consisting of just a semicolon) performs no operations.
EXAMPLE 1 If a function call is evaluated as an expression statement for its side effects only, the discarding of its value can be made explicit by converting the expression to a void expression by means of a cast:
int p(int); /* ... */ (void)p(0);
EXAMPLE 2 In the program fragment
char *s; /* ... */ while (*s++ != ’\0’) ;
a null statement is used to supply an empty loop body to the iteration statement.
6.8.5 Selection statements
6.8.5.1 General
Syntax
- selection-statement:
if (selection-header)secondary-blockif (selection-header)secondary-blockelsesecondary-blockswitch (selection-header)secondary-block
Semantics
A selection statement selects among a set of secondary blocks depending on the value of a controlling expression.
If the selection header is the first or second form, the controlling expression is the expression of the selection header. Otherwise, there is no explicit expression and the controlling expression is the value of the single declared object after initialization.
If the selection header includes a declaration (the second or third forms), the scope of any identifiers it declares is the remainder of the declaration and the entire selection statement, including the subsequent expression in the second form as well as the secondary block or blocks. In the second form, the declaration is reached in the order of execution before evaluation of the expression.
6.8.5.2 The if statement
Constraints
The controlling expression of an if statement shall have scalar type.
Semantics
In both forms, the first secondary block is executed if the controlling expression191) compares unequal to 0. In the else form, the second secondary block is executed if the expression compares equal to 0. If the first secondary block is reached via a label, the second secondary block is not executed.
An else is associated with the lexically nearest preceding if that is allowed by the syntax.
EXAMPLE 1 The controlling expression of an if statement that uses a declaration as its selection header is implicitly the value of the declaration:
if (int x = get ()) { // x is non-zero here } else { // x is zero here }is equivalent to
if (int x = get (); x) { // x is non-zero here } else { // x is zero here }and therefore to
{
int x = get ();
if (x) {
// x is non-zero here
} else {
// x is zero here
}
}EXAMPLE 2 The controlling expression of any if statement is always implicitly compared to 0 by the statement itself:
double x = DBL_SNAN; if (x) { // fetestexcept (FE_INVALID) is nonzero because of the comparison }
6.8.5.3 The switch statement
Constraints
The controlling expression of a switch statement shall have integer type.
If a switch statement has an associated case or default label within the scope of an identifier with a variably modified type, the entire secondary block of the switch statement shall be within the scope of that identifier.192)
The expression of each case label shall be an integer constant expression or a constant range expression and no two of the values of case constant expressions or constant range expressions associated to the same switch statement shall specify the same value after conversion. There can be at most one default label associated to a switch statement. (Any enclosed switch statement can have a default label or case-specified values that duplicate case-specified values in the enclosing switch statement.)
The arithmetic values specified by a constant range expression shall not change as a result of conversion to the promoted type of the controlling expression.
Semantics
A switch statement causes control to jump to, into, or past the secondary block that is the switch body, depending on the value of a controlling expression, and on the presence of a default label and the specified values of any case labels on or in the switch body. A case or default label is accessible only within the closest enclosing switch statement.
The integer promotions are performed on the controlling expression. The values specified by each case label are converted to the promoted type of the controlling expression. If a converted value matches that of the promoted controlling expression, control jumps to the statement or declaration following the matched case label. Otherwise, if there is a default label, control jumps to the statement or declaration following the default label. If no converted case value matches and there is no default label, no part of the switch body is executed.
A case label with a range expression that describes an empty range (which occurs when the first value is greater than the second value) never matches any value of the controlling expression.193)
Implementation limits
As discussed in 5.3.5.2, the implementation may limit the number of case labels in a switch statement.
EXAMPLE 1 In the artificial program fragment
switch (expr) { int i = 4; f(i); case 0: i = 17; /* falls through into default code */ default: printf("%d\n", i); }
EXAMPLE 2 A value specified as part of the sequence in a range expression argument to case shall not be repeated by a different label:
extern int n; switch (n) { case 1 ... 5: /* ... */ break; case 6: // OK, 6 has not been specified /* ... */ case 4: // constraint violation: /* ... */ // 4 was specified by 1 ... 5 break; case 3 ... 8: // constraint violation: /* ... */ // 3, 4, 5, 6 were specified above break; }
EXAMPLE 3 A constant range expression may express one or no values.
extern int n; switch (n) { case 1 ... 1: // OK, same as case 1: /* ... */ break; case 8 ... 7: // OK, matches nothing, // but diagnostic encouraged /* ... */ break; }
6.8.6 Iteration statements
6.8.6.1 General
Syntax
- iteration-statement:
while (expression)secondary-blockdosecondary-blockwhile (expression) ;for (expressionopt;expressionopt;expressionopt)secondary-blockfor (declaration expressionopt;expressionopt)secondary-block
Constraints
The controlling expression of an iteration statement shall have scalar type.
Semantics
An iteration statement causes a secondary block called the loop body to be executed repeatedly until the controlling expression compares equal to 0. The repetition occurs regardless of whether the loop body is entered from the iteration statement or by a jump.194)
An iteration statement may be assumed by the implementation to terminate if its controlling expression is not a constant expression,195) and none of the following operations are performed in its body, controlling expression or (in the case of a for statement) its expression-3:196)
- input/output operations
- accessing a volatile object
- synchronization or atomic operations.
6.8.6.2 The while statement
The evaluation of the controlling expression takes place before each execution of the loop body.
6.8.6.3 The do statement
The evaluation of the controlling expression takes place after each execution of the loop body.
6.8.6.4 The for statement
The statement
for (clause-1 ; expression-2 ; expression-3 ) secondary-blockbehaves as follows: The expression expression-2 is the controlling expression that is evaluated before each execution of the loop body. The expression expression-3 is evaluated as a void expression after each execution of the loop body. If clause-1 is a declaration, the scope of any identifiers it declares is the remainder of the declaration and the entire loop, including the other two expressions; it is reached in the order of execution before the first evaluation of the controlling expression. If clause-1 is an expression, it is evaluated as a void expression before the first evaluation of the controlling expression.197)
Both clause-1 and expression-3 can be omitted. An omitted expression-2 is replaced by a nonzero constant.
6.8.7 Jump statements
6.8.7.1 General
Syntax
- jump-statement:
gotoidentifier;continueidentifieropt;breakidentifieropt;returnexpressionopt;
Semantics
A jump statement causes an unconditional jump to another place.
6.8.7.2 The goto statement
Constraints
The identifier in a goto statement shall name a label located somewhere in the enclosing function. A goto statement shall not jump from outside the scope of an identifier having a variably modified type to inside the scope of that identifier.
Semantics
A goto statement causes an unconditional jump to the statement prefixed by the named label in the enclosing function.
EXAMPLE 1 It is sometimes convenient to jump into the middle of a complicated set of statements. The following outline presents one possible approach to a problem based on these three assumptions:
/* ... */ goto first_time; for (;;) { // determine next operation /* ... */ if (need to reinitialize ) { // reinitialize-only code /* ... */ first_time: // general initialization code /* ... */ continue; } // handle other operations /* ... */ }
- The general initialization code accesses objects only visible to the current function.
- The general initialization code is too large to warrant duplication.
- The code to determine the next operation is at the head of the loop. (To allow it to be reached by
continuestatements, for example.)
EXAMPLE 2 A goto statement which jumps past any declarations of objects with variably modified types is not conforming. A jump within the scope, however, is valid.
goto lab3; // invalid: going INTO scope of VLA. { double a[n]; a[j] = 4.4; lab3: a[j] = 3.3; goto lab4; // valid: going WITHIN scope of VLA. a[j] = 5.5; lab4: a[j] = 6.6; } goto lab4; // invalid: going INTO scope of VLA.
6.8.7.3 The continue statement
Constraints
A continue statement shall appear only in or as a loop body.
A continue statement with an identifier operand shall appear within a statement named by the label with the corresponding identifier.
Semantics
A continue statement causes a jump to the loop-continuation portion of an enclosing iteration statement; that is, to the end of the loop body. More precisely, in each of the statements:
while (/* ... */) { do { for (/* ... */) { /* ... */ /* ... */ /* ... */ continue; continue; continue; /* ... */ /* ... */ /* ... */ contin: contin:; contin: } } while (/* ... */); }
If the continue statement has an identifier operand, the jump is to the loop-continuation of the iteration statement named by the label with the corresponding identifier. Otherwise, the jump is to the loop-continuation of the innermost enclosing iteration statement.
EXAMPLE 1 In the following code, continue only jumps to the loop-continuation of the inner nested loop, whereas continue outer jumps to the loop-continuation of the outermost loop:
outer: for (int i = 0; i < 10; ++ i) { for (int j = 0; j < 20; ++ j) { continue; // jumps to CONT1 continue outer; // jumps to CONT2 // CONT1 } // CONT2 } int i = 0; outer: do { int j = 0; do { continue; // jumps to CONT1 continue outer; // jumps to CONT2 // CONT1 } while (j < 20); // CONT2 } while (i < 10);
6.8.7.4 The break statement
Constraints
A break statement shall appear only in or as a switch body or loop body.
A break statement with an identifier operand shall appear within a switch or iteration statement named by the label with the corresponding identifier.
Semantics
A break statement terminates execution of an enclosing switch or iteration statement, as if by jumping to a label immediately following it in the surrounding scope using goto.
If the break statement has an identifier operand, the jump exits the switch or iteration statement named by the label with the corresponding identifier. Otherwise, the jump exits the innermost enclosing switch or iteration statement.
EXAMPLE 1 Therefore, this:
while (1) { break; } // break jumps here while (1) { goto there; } there:
EXAMPLE 2 In the following code, break only exits the switch, whereas break outer exits the enclosing loop as well:
outer: for (int i = 0; i < IK; ++ i) { switch (i) { case 1: break; // jumps to CONT1 case 2: break outer; // jumps to CONT2 } // CONT1 } // CONT2
6.8.7.5 The return statement
Constraints
A return statement with an expression shall not appear in a function whose return type is void. A return statement without an expression shall only appear in a function whose return type is void.
Semantics
A return statement terminates execution of the current function and returns control to its caller. A function can have any number of return statements.
If a return statement with an expression is executed, the value of the expression is returned to the caller as the value of the function call expression. If the expression has a type different from the return type of the function in which it appears, the value is converted as if by assignment to an object having the return type of the function.199)
EXAMPLE In:
struct s { double i; } f(void); union { struct { int f1; struct s f2; } u1; struct { struct s f3; int f4; } u2; } g; struct s f(void) { return g.u1.f2; } /* ... */ g.u2.f3 = f();
6.9 External definitions
6.9.1 General
Syntax
Constraints
For hosted implementations, the function called at program startup shall have one of the function types specified in 5.2.2. There shall be a definition of this function with external linkage.200)
The storage-class specifier register shall not appear in the declaration specifiers in an external declaration. The storage-class specifier auto shall only appear in the declaration specifiers in an external declaration if the type is inferred.
There shall be no more than one external definition for each identifier declared with internal linkage in a translation unit. Moreover, if an identifier declared with internal linkage is used in an expression there shall be exactly one external definition for the identifier in the translation unit, unless it is:
- part of the operand of a
sizeofoperator which is an integer constant expression; - part of the operand of a
_Countofoperator which is an integer constant expression; - part of the operand of an
alignofoperator; - part of the controlling expression of a generic selection;
- part of the expression in a generic association that is not the result expression of its generic selection;
- or, part of the operand of any typeof operator whose result is not a variably modified type.
Semantics
As discussed in 5.2.1.1, the unit of program text after preprocessing is a translation unit, which consists of a sequence of external declarations. These are described as "external" because they appear outside any function (and hence have file scope). As discussed in 6.7, a declaration that also causes storage to be reserved for an object or a function named by the identifier is a definition.
An external definition is an external declaration that is also a definition of a function (other than an inline definition) or an object. If an identifier declared with external linkage is used in an expression (other than as part of the operand of a typeof operator whose result is not a variably modified type, part of the controlling expression of a generic selection, part of the expression in a generic association that is not the result expression of its generic selection, or part of a sizeof, _Countof, or alignof operator that is an integer constant expression), somewhere in the entire program there shall be exactly one external definition for the identifier; otherwise, there shall be no more than one.201)
6.9.2 Function definitions
Syntax
Constraints
The identifier declared in a function definition (which is the name of the function) shall have a function type, as specified by the declarator portion of the function definition.
The return type of a function shall be void or a complete object type other than array type.
The storage-class specifier, if any, in the declaration specifiers shall be either extern or static.
If the parameter list consists of a single parameter of type void, the parameter declarator shall not include an identifier.
Variable length array types of unspecified size shall not be used as part of a parameter declaration in a function definition.
Semantics
The optional attribute specifier sequence in a function definition appertains to the function.
The declarator in a function definition specifies the name of the function being defined and the types (and optionally the names) of all the parameters; the declarator also serves as a function prototype for later calls to the same function in the same translation unit. The type of each parameter is adjusted as described in 6.7.7.4.
The parameter type list, the attribute specifier sequence of the declarator that follows the parameter type list, and the compound statement of the function body form a single block.202) Each parameter has automatic storage duration; its identifier, if any,203) is an lvalue.204) The layout of the storage for parameters is unspecified.
On entry to the function, the size expressions of each variably modified parameter and typeof operators used in declarations of parameters are evaluated and the value of each argument expression is converted to the type of the corresponding parameter as if by assignment. (Array expressions and function designators as arguments were converted to pointers before the call.)
After all parameters have been assigned, the compound statement of the function body is executed.
Unless otherwise specified, if the } that terminates the function body is reached, and the value of the function call is used by the caller, the behavior is undefined.
NOTE In a function definition, the return type of the function and its prototype cannot be inherited from a typedef:
typedef int F(void); // type F is "function with no parameters // returning int" F f, g; // f and g both have type compatible with F F f { /* ... */ } // WRONG: syntax/constraint error F g() { /* ... */ } // WRONG: declares that g returns a function int f(void) { /* ... */ } // RIGHT: f has type compatible with F int g() { /* ... */ } // RIGHT: g has type compatible with F F *e(void) { /* ... */ } // e returns a pointer to a function F *((e))(void) { /* ... */ } // same: parentheses irrelevant int (*fp)(void); // fp points to a function that has type F F *Fp; // Fp points to a function that has type F
EXAMPLE 1 In the following:
extern int max(int a, int b) { return a > b ? a: b; } { return a > b ? a: b; }
EXAMPLE 2 To pass one function to another, one can say
int f(void); /* ... */ g(f);Then the definition of
g can readvoid g(int (*funcp)(void)) { /* ... */ (*funcp)(); /* or funcp(); */ }or, equivalently,
void g(int func(void)) { /* ... */ func(); /* or (*func)(); */ }
6.9.3 External object definitions
Constraints
If the declaration of an identifier for an object is a tentative definition with incomplete type and internal linkage, the type of the object shall be completed before the end of the translation unit.
Semantics
If the declaration of an identifier for an object has file scope and an initializer, or has file scope and storage-class specifier thread_local, the declaration is an external definition for the identifier.
A declaration of an identifier for an object that has file scope without an initializer, and without the storage-class specifier extern or thread_local, constitutes a tentative definition. If a translation unit contains one or more tentative definitions for an identifier, and the translation unit contains no external definition for that identifier, then the behavior is exactly as if the translation unit contains a file scope declaration of that identifier with an empty initializer and a type determined as follows:
- if the composite type as of the end of the translation unit is an array of unknown size, then an array of size one with the composite element type;
- otherwise, the composite type at the end of the translation unit.
EXAMPLE 1
int i1 = 1; // definition, external linkage static int i2 = 2; // definition, internal linkage extern int i3 = 3; // definition, external linkage int i4; // tentative definition, external linkage static int i5; // tentative definition, internal linkage int i1; // valid tentative definition, refers to previous int i2; // 6.2.2 renders undefined, linkage disagreement int i3; // valid tentative definition, refers to previous int i4; // valid tentative definition, refers to previous int i5; // 6.2.2 renders undefined, linkage disagreement extern int i1; // refers to previous, whose linkage is external extern int i2; // refers to previous, whose linkage is internal extern int i3; // refers to previous, whose linkage is external extern int i4; // refers to previous, whose linkage is external extern int i5; // refers to previous, whose linkage is internal
EXAMPLE 2 If at the end of the translation unit containing
int i[];
the array i still has incomplete type, the implicit initializer causes it to have one element, which is set to zero on program startup.
6.10 Preprocessing directives
6.10.1 General
Syntax
- if-group:
# ifconstant-expression new-line groupopt# ifdefidentifier new-line groupopt# ifndefidentifier new-line groupopt
- elif-group:
# elifconstant-expression new-line groupopt# elifdefidentifier new-line groupopt# elifndefidentifier new-line groupopt
- else-group:
# elsenew-line groupopt
- endif-line:
# endifnew-line
- control-line:
# includepp-tokens new-line# embedpp-tokens new-line# defineidentifier replacement-list new-line# defineidentifier lparen identifier-listopt)replacement-list new-line# defineidentifier lparen... )replacement-list new-line# defineidentifier lparen identifier-list, ... )replacement-list new-line# undefidentifier new-line# linepp-tokens new-line# errorpp-tokensopt new-line# warningpp-tokensopt new-line# pragmapp-tokensopt new-line#new-line
- lparen:
- a
(character not immediately preceded by white space
- new-line:
- the new-line character
- pp-balanced-token:
(pp-balanced-token-sequenceopt)[pp-balanced-token-sequenceopt]{pp-balanced-token-sequenceopt}- any pp-token other than a parenthesis, a bracket, or a brace
Description
A preprocessing directive consists of a sequence of preprocessing tokens that satisfies the following constraints: The first token in the sequence is a # preprocessing token that (at the start of translation phase 4) is either the first character in the source file (optionally after white space containing no
A text line shall not begin with a # preprocessing token. A non-directive shall not begin with any of the directive names appearing in the syntax.
Some preprocessing directives take additional information using preprocessor parameters. A preprocessing parameter (pp-parameter) shall be either a preprocessor prefixed parameter (identified by a pp-prefixed-parameter, for implementation-defined preprocessor parameters) or a preprocessor standard parameter (identified with a pp-standard-parameter, for pp-parameters specified by this document).
In all aspects, a preprocessor standard parameter specified by this document as an identifier pp_param and an identifier of the form __pp_param__ shall behave the same when used as a preprocessor parameter, except for the spelling.
EXAMPLE 1 Thus, the preprocessor parameters on the two binary resource inclusion directives (6.10.4):
#embed "boop.h" limit(5) #embed "boop.h" __limit__(5)
behave the same, and can be freely interchanged. Implementations are encouraged to behave similarly for preprocessor parameters (including preprocessor prefixed parameters) they provide.
When in a group that is skipped (6.10.2), the directive syntax is relaxed to allow any sequence of preprocessing tokens to occur between the directive name and the following new-line character.
Constraints
The only white-space characters that shall appear between preprocessing tokens within a preprocessing directive (from just after the introducing # preprocessing token through just before the terminating new-line character) are space and horizontal-tab (including spaces that have replaced comments or possibly other white-space characters in translation phase 3).
A preprocessor parameter shall be either a preprocessor standard parameter, or an implementationdefined preprocessor prefixed parameter.206)
Semantics
The implementation can process and skip sections of source files conditionally, include other source files, and replace macros. These capabilities are called preprocessing, because conceptually they occur before translation of the resulting translation unit.
The preprocessing tokens within a preprocessing directive are not subject to macro expansion unless otherwise stated.
EXAMPLE 2 In:
#define EMPTY EMPTY # include <file.h>
the sequence of preprocessing tokens on the second line is not a preprocessing directive, because it does not begin with a # at the start of translation phase 4 (5.2.1.2), even though it will do so after the macro EMPTY has been replaced.
The execution of a non-directive preprocessing directive results in undefined behavior.
6.10.2 Conditional inclusion
Syntax
- defined-macro-expression:
definedidentifierdefined (identifier)
- h-preprocessing-token:
- any preprocessing-token other than
>
- has-include-expression:
__has_include (header-name)__has_include (header-name-tokens)
- has-embed-expression:
__has_embed (header-name embed-parameter-sequenceopt)__has_embed (header-name-tokens pp-balanced-token-sequenceopt)
- has-c-attribute-express:
__has_c_attribute (pp-tokens)
The #if and #elif directives are collectively known as the conditional expression inclusion preprocessing directives. The conditional expression inclusion preprocessing directives, #ifdef, #ifndef, #elifdef, and #elifndef directives are collectively known as the conditional inclusion preprocessing directives.
Constraints
The expression that controls conditional inclusion shall be an integer constant expression except that: identifiers (including those lexically identical to keywords) are interpreted as described subsequently in this subclause207) and it can contain zero or more defined macro expressions, has_include expressions, has_embed expressions, and/or has_c_attribute expressions as unary operator expressions.
A defined macro expression evaluates to 1 if the identifier is currently defined as a macro name (that is, if it is predefined or if it has been the subject of a #define preprocessing directive without an intervening #undef directive with the same subject identifier), 0 if it is not.
The second form of the has_include expression and has_embed expression is considered only if the first form does not match, in which case the preprocessing tokens are processed just as in normal text.
The header or source file identified by the parenthesized preprocessing token sequence in each contained has_include expression is searched for as if that preprocessing token were the pp-tokens in a #include directive, except that no further macro expansion is performed. Such a directive shall satisfy the syntactic requirements of a #include directive. The has_include expression evaluates to 1 if the search for the source file succeeds, and to 0 if the search fails.
The resource (6.10.4) identified by the header-name preprocessing token sequence in each contained has_embed expression is searched for as if those preprocessing token were the pp-tokens in a #embed directive, except that no further macro expansion is performed. Such a directive shall satisfy the
NOTE 1 Unrecognized preprocessor prefixed parameters in has_embed expressions are not a constraint violation and instead cause the expression to be evaluated to 0, as specified previously.
Each has_c_attribute expression is replaced by a nonzero pp-number matching the form of an integer literal if the implementation supports an attribute with the name specified by interpreting the pp-tokens as an attribute token, and by 0 otherwise. The pp-tokens shall match the form of an attribute token.
Each preprocessing token that remains (in the list of preprocessing tokens that will become the controlling expression) after all macro replacements have occurred shall be in the lexical form of a token (6.4).
After each preprocessing token has been converted into a token, the resulting tokens shall be solely integer literals, character literals, punctuators and other implementation-defined sequences of tokens.
Semantics
The #ifdef, #ifndef, #elifdef, and #elifndef directives, and the defined conditional inclusion operator, shall treat __has_include, __has_embed and __has_c_attribute as if they were the name of defined macros. The identifiers __has_include, __has_embed, and __has_c_attribute shall not appear in any context not mentioned in this subclause.
Preprocessing directives of the forms
# if constant-expression new-line groupopt # elif constant-expression new-line groupopt
check whether the controlling constant expression evaluates to nonzero.
Prior to evaluation, macro invocations in the list of preprocessing tokens that will become the controlling constant expression are replaced (except for those macro names modified by the defined unary operator), just as in normal text. If the token defined is generated as a result of this replacement process or use of the defined unary operator does not match one of the two specified forms prior to macro replacement, the behavior is undefined. After all replacements due to macro expansion and evaluations of defined macro expressions, has_include expressions, has_embed expressions, and has_c_attribute expressions have been performed, all remaining identifiers other than true (including those lexically identical to keywords such as false) are replaced with the pp-number 0, true is replaced with pp-number 1, and then each preprocessing token is converted into a token. The resulting tokens compose the controlling constant expression which is evaluated according to the rules of 6.6.1. For the purposes of this token conversion and evaluation, all signed integer types and all unsigned integer types act as if they have the same representation as, respectively, the types intmax_t and uintmax_t defined in the header <stdint.h>. This includes interpreting character literals, which can involve converting escape sequences into execution character set members. Whether the numeric value for these character literals matches the value obtained when an identical character literal occurs in an expression (other than within a #if or #elif directive) is implementation-defined. Whether a single-character character literal may have a negative value is implementation-defined.
NOTE 2 On an implementation where INT_MAX is 0x7FFF and UINT_MAX is 0xFFFF, the literal 0x8000 is signed and positive within a #if expression even though it would be unsigned in translation phase 7 (5.2.1.2).
NOTE 3 The constant expression in the following #if directive and if statement is not guaranteed to evaluate to the same value in these two contexts.
#if ’z’ - ’a’ == 25 if (’z’ - ’a’ == 25)
Preprocessing directives of the forms
# ifdef identifier new-line groupopt # ifndef identifier new-line groupopt # elifdef identifier new-line groupopt # elifndef identifier new-line groupopt
check whether the identifier is or is not currently defined as a macro name. Their conditions are equivalent to #if defined identifier, #if !defined identifier, #elif defined identifier, and #elif !defined identifier respectively.
Each directive’s condition is checked in order. If it evaluates to false (zero), the group that it controls is skipped: directives are processed only through the name that determines the directive to keep track of the level of nested conditionals; the rest of the directives’ preprocessing tokens are ignored, as are the other preprocessing tokens in the group. Only the first group whose control condition evaluates to true (nonzero) is processed; any following groups are skipped and their controlling directives are processed as if they were in a group that is skipped. If none of the conditions evaluates to true, and there is a #else directive, the group controlled by the #else is processed; lacking a #else directive, all the groups until the #endif are skipped.208)
EXAMPLE 1 This demonstrates a way to include a header file only if it is available.
#if __has_include(<optional.h>) # include <optional.h> # define have_optional 1 #elif __has_include(<experimental/optional.h>) # include <experimental/optional.h> # define have_optional 1 # define have_experimental_optional 1 #endif #ifndef have_optional # define have_optional 0 #endif
EXAMPLE 2
/* Fallback for compilers not yet implementing this feature. */ #ifndef __has_c_attribute #define __has_c_attribute(x) 0 #endif /* __has_c_attribute */ #if __has_c_attribute(fallthrough) /* Standard attribute is available, use it. */ #define FALLTHROUGH [[fallthrough]] #elif __has_c_attribute(vendor::fallthrough) /* Vendor attribute is available, use it. */ #define FALLTHROUGH [[vendor::fallthrough]] #else /* Fallback implementation. */ #define FALLTHROUGH #endif
EXAMPLE 3
#ifdef __STDC__ #define TITLE "ISO C Compilation" #elifndef __cplusplus #define TITLE "Non-ISO C Compilation" #else /* C++ */ #define TITLE "C++ Compilation" #endif
EXAMPLE 4 A combination of __FILE__ (6.10.10.2) and __has_embed can be used to check for support of specific implementation extensions for the #embed (6.10.4) directive’s parameters.
#if __has_embed(__FILE__ ext::token(0xB055)) #define DESCRIPTION "Supports extended token embed parameter" #else #define DESCRIPTION "Does not support extended token embed parameter" #endif
EXAMPLE 5 The following snippet uses __has_embed to check for support of a specific implementationdefined embed parameter, and otherwise uses standard behavior to produce the same effect.
void parse_into_s(short* ptr, unsigned char* ptr_bytes, unsigned long long size); int main () { #if __has_embed ("bits.bin" ds9000::element_type(short)) /* Implementation extension: create short integers from the */ /* translation environment resource into */ /* a sequence of integer literals */ short meow[] = { #embed "bits.bin" ds9000::element_type(short) }; #elif __has_embed ("bits.bin") /* no support for implementation-specific */ /* ds9000::element_type(short) parameter */ const unsigned char meow_bytes[] = { #embed "bits.bin" }; short meow[sizeof(meow_bytes) / sizeof(short)] = {}; /* parse meow_bytes into short values by-hand! */ parse_into_s(meow, meow_bytes, sizeof(meow_bytes)); #else #error "cannot find bits.bin resource" #endif return (int)(meow[0] + meow[_Countof(meow) - 1]); }
EXAMPLE 6 If the search for the resource is successful, this resource is always considered empty due to the limit(0) embed parameter, including in __has_embed expressions.
int main () { #if __has_embed(<infinite-resource> limit(0)) == 2 // if <infinite-resource> exists, this // token sequence is always taken. return 0; #else // the ’infinite-resource’ resource does not exist #error "The resource does not exist" #endif }
6.10.3 Source file inclusion
Constraints
A #include directive shall identify a header or source file that can be processed by the implementation.
Semantics
A preprocessing directive of the form
# include < h-char-sequence > new-line
searches a sequence of implementation-defined places for a header identified uniquely by the specified sequence between the < and > delimiters, and causes the replacement of that directive by the entire contents of the header. How the places are specified or the header identified is implementation-defined.
A preprocessing directive of the form
# include " q-char-sequence " new-line
causes the replacement of that directive by the entire contents of the source file identified by the specified sequence between the " delimiters. The named source file is searched for in an implementation-defined manner. If this search is not supported, or if the search fails, the directive is reprocessed as if it read
# include < h-char-sequence > new-line
with the identical contained sequence (including > characters, if any) from the original directive.
A preprocessing directive of the form
# include pp-tokens new-line
(that does not match one of the two previous forms) is permitted. The preprocessing tokens after include in the directive are processed just as in normal text. (Each identifier currently defined as a macro name is replaced by its replacement list of preprocessing tokens.) The directive resulting after all replacements shall match one of the two previous forms.209) The method by which a sequence of preprocessing tokens between a < and a > preprocessing token pair or a pair of " characters is combined into a single header name preprocessing token is implementation-defined.
The implementation shall provide unique mappings for sequences consisting of one or more nondigits or digits (6.4.3.1) followed by a period (.) and a single nondigit. The first character shall not be a digit. The implementation can ignore distinctions of alphabetical case and restrict the mapping to eight significant characters before the period.
A #include preprocessing directive may appear in a source file that has been read because of a #include directive in another file, up to an implementation-defined nesting limit (see 5.3.5.2).
EXAMPLE 1 The most common uses of #include preprocessing directives are as in the following:
#include <stdio.h> #include "myprog.h"
EXAMPLE 2 This illustrates macro-replaced #include directives:
#if VERSION == 1 #define INCFILE "vers1.h" #elif VERSION == 2 #define INCFILE "vers2.h" // and so on #else #define INCFILE "versN.h" #endif #include INCFILE
6.10.4 Binary resource inclusion
6.10.4.1 #embed preprocessing directive
Description
A resource is a source of data accessible from the translation environment. An embed parameter is a single preprocessor parameter in the embed parameter sequence. It has an implementation resource width, which is the implementation-defined size in bits of the located resource. It also has a resource width, which is either:
- the number of bits as computed from the optionally-provided
limitembed parameter (6.10.4.2), if present; or, - the implementation resource width.
An embed parameter sequence is a whitespace-delimited list of preprocessor parameters which can modify the result of the replacement for the #embed preprocessing directive.
Constraints
An #embed directive shall identify a resource that can be processed by the implementation as a binary data sequence given the provided embed parameters.
Embed parameters not specified in this document shall be implementation-defined. Implementationdefined embed parameters may change the subsequently-defined semantics of the directive; otherwise, #embed directives which do not contain implementation-defined embed parameters shall behave as described in this document.
A resource is considered empty when its resource width is zero.
Let embed element width be either:
- an integer constant expression greater than zero determined by an implementation-defined embed parameter; or,
-
CHAR_BIT(5.3.5.3.2).
The result of shall be zero.210)
Semantics
The expansion of a #embed directive is a token sequence formed from the list of integer constant expressions described later in this subclause. The group of tokens for each integer constant expression in the list is separated in the token sequence from the group of tokens for the previous integer constant expression in the list by a comma. The sequence neither begins nor ends in a comma. If the list of integer constant expressions is empty, the token sequence is empty. The directive is replaced by its expansion and, with the presence of certain embed parameters, additional or replacement token sequences.
A preprocessing directive of the form
# embed < h-char-sequence > embed-parameter-sequenceopt new-line
searches a sequence of implementation-defined places for a resource identified uniquely by the specified sequence between the < and >. The search for the named resource is done in an implementationdefined manner.
A preprocessing directive of the form
# embed " q-char-sequence " embed-parameter-sequenceopt new-line
searches a sequence of implementation-defined places for a resource identified uniquely by the specified sequence between the " delimiters. The search for the named resource is done in an implementation-defined manner. If this search is not supported, or if the search fails, the directive is reprocessed as if it read
# embed < h-char-sequence > embed-parameter-sequenceopt new-line
with the identical contained q-char-sequence (including > characters, if any) from the original directive.
Either form of the #embed directive specified previously behaves as specified later in this subclause. The values of the integer constant expressions in the expanded sequence are determined by an implementation-defined mapping of the resource’s data. Each integer constant expression’s value is in the range from to (, inclusive.211) If:
- the list of integer constant expressions is used to initialize an array of a type compatible with
unsigned char, or compatible withcharifcharcannot hold negative values; and, - the embed element width is equal to
CHAR_BIT(5.3.5.3.2),
then the contents of the initialized elements of the array are as-if the resource’s binary data is fread (7.24.8.1) into the array at translation time.
A preprocessing directive of the form
# embed pp-tokens new-line
(that does not match one of the two previous forms) is permitted. The preprocessing tokens after embed in the directive are processed just as in normal text. (Each identifier currently defined as a macro name is replaced by its replacement list of preprocessing tokens.) The directive resulting after all replacements shall match one of the two previous forms.212) The method by which a sequence of preprocessing tokens between a < and a > preprocessing token pair or a pair of " characters is combined into a single resource name preprocessing token is implementation-defined.
An embed parameter with a preprocessor parameter token that is one of the following is a standard embed parameter:
limit prefix suffix if_empty
The significance of these standard embed parameters is specified later in this subclause.
Recommended practice
The #embed directive is meant to translate binary data in a resource to a sequence of integer constant expressions in a way that preserves the value of the resource’s bit stream where possible.
A mechanism similar to, but distinct from, the implementation-defined search paths used for source file inclusion (6.10.3) is encouraged.
Implementations should take into account translation-time bit and byte orders as well as executiontime bit and byte orders to more appropriately represent the resource’s binary data from the directive. This maximizes the chance that, if the resource referenced at translation time through the #embed directive is the same one accessed through execution-time means, the data that is e.g. fread or similar into contiguous storage will compare bit-for-bit equal to an array of character type initialized from an #embed directive’s expanded contents.
EXAMPLE 1 Placing a small image resource.
#include <stddef.h> void have_you_any_wool(const unsigned char*, size_t); int main (int, char*[]) { static const unsigned char baa_baa[] = { #embed "black_sheep.ico" }; have_you_any_wool(baa_baa, _Countof(baa_baa)); return 0; }
EXAMPLE 2 This snippet:
int main (int, char*[]) { static const unsigned char coefficients[] = { #embed "only_8_bits.bin" // potential constraint violation }; return 0; }
can violate the constraint that is . There is a chance that the implementation-defined 8 bit width of the resource is not evenly divisible by the embed element width (e.g. on a system where CHAR_BIT is 16). Issuing a diagnostic in this case can aid in portability by calling attention to potentially incompatible expectations between implementations and their resources.
EXAMPLE 3 Initialization of non-arrays.
int main () { /* Braces can be kept or elided as per normal initialization rules */ int i = { #embed "i.dat" }; /* valid if i.dat produces one value, embed element width i value is in [0, 2 ) */ int i2 = #embed "i.dat" ; /* valid if i.dat produces one value, embed element width i2 value is in [0, 2 ) */ struct s { double a, b, c; struct { double e, f, g; }; double h, i, j; }; struct s x = { /* initializes each element in order according to initialization rules with comma-separated list of integer constant expression s inside of braces */ #embed "s.dat" }; return 0; }
Non-array types can still be initialized because the directive produces a comma-delimited list of integer constant expressions, a single integer constant expression, or nothing.
EXAMPLE 4 Equivalency of bit sequence and bit order between a translation-time read and an execution-time read of the same resource/file.
#include <string.h> #include <stddef.h> #include <stdio.h> int main(void) { static const unsigned char embed_data[] = { #embed <data.dat> }; const size_t f_size = sizeof(embed_data); unsigned char f_data[f_size]; FILE* f_source = fopen("data.dat", "rb"); if (f_source == nullptr) return 1; char* f_ptr = (char*)&f_data[0]; if (fread(f_ptr, 1, f_size, f_source) != f_size) { fclose(f_source); return 1; } fclose(f_source); int is_same = memcmp(&embed_data[0], f_ptr, f_size); // if both operations refers to the same resource/file at // execution time and translation time, is_same should be 0 return is_same == 0 ? 0 : 1; }
6.10.4.2 limit parameter
Constraints
The limit standard embed parameter can appear zero times or one time in the embed parameter sequence. Its preprocessor argument clause shall be present and have the form:
and shall be an integer constant expression. The integer constant expression shall not evaluate to a value less than 0.
The token defined shall not appear within the constant expression.
Semantics
The embed parameter with a preprocessor parameter token limit denotes a balanced preprocessing token sequence that will be used to compute the resource width. Independently of any macro replacement done previously (e.g. when matching the form of #embed), the constant expression is evaluated after the balanced preprocessing token sequence is processed as in normal text, using the rules specified for conditional inclusion (6.10.2), with the exception that any defined macro expressions are not permitted.
The resource width is:
- 0, if the integer constant expression evaluates to 0; or,
- the implementation resource width if it is less than the embed element width multiplied by the integer constant expression; or,
- the embed element width multiplied by the integer constant expression, if it is less than or equal to the implementation resource width.
EXAMPLE 1 Checking the first 4 elements of a sound resource.
#include <assert.h> int main (int, char*[]) { static const char sound_signature[] = { #embed <sdk/jump.wav> limit(2+2) }; static_assert(_Countof sound_signature == 4, "There should only be 4 elements in this array."); // verify PCM WAV resource assert(sound_signature[0] == ’R’); assert(sound_signature[1] == ’I’); assert(sound_signature[2] == ’F’); assert(sound_signature[3] == ’F’); assert(sizeof(sound_signature) == 4); return 0; }
EXAMPLE 2 Similar to a previous example, except it illustrates macro expansion specifically done for the limit(...) parameter.
#include <assert.h> #define TWO_PLUS_TWO 2+2 int main (int, char*[]) { const char sound_signature[] = { /* the token sequence within the parentheses for the limit parameter undergoes macro expansion, at least once, resulting in #embed <sdk/jump.wav> limit(2+2) */ #embed <sdk/jump.wav> limit(TWO_PLUS_TWO) }; static_assert(_Countof(sound_signature) == 4, "There should only be 4 elements in this array."); // verify PCM WAV resource assert(sound_signature[0] == ’R’); assert(sound_signature[1] == ’I’); assert(sound_signature[2] == ’F’); assert(sound_signature[3] == ’F’); assert(sizeof(sound_signature) == 4); return 0; }
EXAMPLE 3 The following is a potential constraint violation because an environment that has a CHAR_BIT whose value is greater than 24 can possibly not get enough data from the resource.
int main (int, char*[]) { const unsigned char arr[] = { #embed "24_bits.bin" limit(1) // can be a constraint violation }; return 0; }
EXAMPLE 4 Resources interfacing with certain implementations can recieve an infinite stream of data, such as the (hypothetical) </owo/uwurandom> resource used in the following snippet:
int main (int, char*[]) { const unsigned char arr[] = { #embed </owo/uwurandom> limit(513) }; return 0; }
6.10.4.3 suffix parameter
Constraints
The suffix standard embed parameter can appear zero times or one time in the embed parameter sequence. Its preprocessor argument clause shall be present and have the form:
( pp-balanced-token-sequenceopt )
Semantics
The embed parameter with a preprocessing parameter token suffix denotes a balanced preprocessing token sequence within its preprocessor argument clause that will be placed immediately after the result of the associated #embed directive’s expansion.
If the resource is empty, then suffix has no effect and is ignored.
EXAMPLE Extra elements added to array initializer.
#include <string.h> #ifndef SHADER_TARGET #define SHADER_TARGET "edith-impl.glsl" #endif extern char* null_term_shader_data; void fill_in_data () { const char internal_data[] = { #embed SHADER_TARGET \ suffix(,) 0 }; strcpy(null_term_shader_data, internal_data); }
6.10.4.4 prefix parameter
Constraints
The prefix standard embed parameter can appear zero times or one time in the embed parameter sequence. Its preprocessor parameter clause shall be present and have the form:
( pp-balanced-token-sequenceopt )
Semantics
The embed parameter with a preprocessor parameter token prefix denotes a balanced preprocessing token sequence within its preprocessor argument clause that will be placed immediately before the result of the associated #embed directive’s expansion, if any.
If the resource is empty, then prefix has no effect and is ignored.
EXAMPLE A null-terminated character array with prefixed and suffixed additional tokens when the resource is not empty, providing null termination and a byte order mark.
#include <assert.h> #include <string.h> #ifndef SHADER_TARGET #define SHADER_TARGET "ches.glsl" #endif extern char* merp; void init_data () { const char whl[] = { #embed SHADER_TARGET \ prefix(0xEF, 0xBB, 0xBF, ) /* UTF-8 BOM */ \ suffix(,) 0 }; // always null terminated, // contains BOM if not-empty int is_good = (_Countof(whl) == 1 && whl[0] == ’\0’) || (whl[0] == ’\xEF’ && whl[1] == ’\xBB’ && whl[2] == ’\xBF’ && whl[_Countof(whl) - 1] == ’\0’); assert(is_good); strcpy(merp, whl); }
6.10.4.5 if_empty parameter
Constraints
The if_empty standard embed parameter can appear zero times or one time in the embed parameter sequence. Its preprocessor argument clause shall be present and have the form:
( pp-balanced-token-sequenceopt )
Semantics
The embed parameter with a preprocessing parameter token if_empty denotes a balanced preprocessing token sequence within its preprocessor argument clause that will replace the #embed directive entirely.
If the resource is not empty, then if_empty has no effect and is ignored.
EXAMPLE 1 If the search for the resource is successful, this resource is always considered empty due to the limit(0) embed parameter. This program always returns 0, even if the resource is searched for and found successfully by the implementation and has an implementation resource width greater than 0.
int main () { return #embed <some_resource> limit(0) prefix(1) if_empty(0) ; // becomes: // return 0; }
EXAMPLE 2 An example similar to using the suffix embed parameter, but changed slightly.
#include <string.h> #ifndef SHADER_TARGET #define SHADER_TARGET "edith-impl.glsl" #endif extern char* null_term_shader_data; void fill_in_data () { const char internal_data[] = { #embed SHADER_TARGET \ suffix(, 0) \ if_empty(0) }; strcpy(null_term_shader_data, internal_data); }
EXAMPLE 3 This resource is considered empty due to the limit(0) embed parameter, meaning an if_empty expression replaces the directive as specified previously. A constraint is still violated if the search for the resource is unsuccessful.
int main () { return #embed <infinite-resource> limit(0) if_empty(45540) ; }becomes:
int main () { return 45540; }
6.10.5 Macro replacement
6.10.5.1 General
Constraints
Two replacement lists are identical if and only if the preprocessing tokens in both have the same number, ordering, spelling, and white-space separation, where all white-space separations are considered identical.
An identifier currently defined as an object-like macro shall not be redefined by another #define preprocessing directive unless the second definition is an object-like macro definition and the two replacement lists are identical. Likewise, an identifier currently defined as a function-like macro shall not be redefined by another #define preprocessing directive unless the second definition is a function-like macro definition that has the same number and spelling of parameters, and the two replacement lists are identical.
There shall be white space between the identifier and the replacement list in the definition of an object-like macro.
If the identifier-list in the macro definition does not end with an ellipsis, the number of arguments (including those arguments consisting of no preprocessing tokens) in an invocation of a function-like macro shall equal the number of parameters in the macro definition. Otherwise, there shall be at least as many arguments in the invocation as there are parameters in the macro definition (excluding the ...). There shall exist a ) preprocessing token that terminates the invocation.
The identifiers __VA_ARGS__ and __VA_OPT__ shall occur only in the replacement-list of a functionlike macro that uses the ellipsis notation in the parameters.
A parameter identifier in a function-like macro shall be uniquely declared within its scope.
Semantics
The identifier immediately following the define is called the macro name. There is one name space for macro names. Any white-space characters preceding or following the replacement list of preprocessing tokens are not considered part of the replacement list for either form of macro.
If a # preprocessing token, followed by an identifier, occurs lexically at the point at which a preprocessing directive can begin, the identifier is not subject to macro replacement.
A preprocessing directive of the form
# define identifier replacement-list new-line
defines an object-like macro that causes each subsequent instance of the macro name213) to be replaced by the replacement list of preprocessing tokens that constitute the remainder of the directive. The replacement list is then rescanned for more macro names as specified later in this subclause.
A preprocessing directive of the form
# define identifier lparen identifier-listopt ) replacement-list new-line # define identifier lparen ... ) replacement-list new-line # define identifier lparen identifier-list , ... ) replacement-list new-line
defines a function-like macro with parameters, whose use is similar syntactically to a function call. The parameters are specified by the optional list of identifiers, whose scope extends from their declaration in the identifier list until the new-line character that terminates the #define preprocessing directive. Each subsequent instance of the function-like macro name followed by a ( as the next preprocessing token introduces the sequence of preprocessing tokens that is replaced by the replacement list in the definition (an invocation of the macro). The replaced sequence of preprocessing tokens is terminated by the matching ) preprocessing token, skipping intervening matched pairs of left and right parenthesis preprocessing tokens. Within the sequence of preprocessing tokens making up an invocation of a function-like macro, new-line is considered a normal white-space character.
The sequence of preprocessing tokens bounded by the outside-most matching parentheses forms the list of arguments for the function-like macro. The individual arguments within the list are separated by comma preprocessing tokens, but comma preprocessing tokens between matching inner parentheses do not separate arguments. If there are sequences of preprocessing tokens within the list of arguments that would otherwise act as preprocessing directives,214) the behavior is undefined.
If there is a ... in the identifier-list in the macro definition, then the trailing arguments (if any), including any separating comma preprocessing tokens, are merged to form a single item: the varying arguments. The number of arguments so combined is such that, following merger, the number of arguments is one more than the number of parameters in the macro definition (excluding the ...), except that if there are as many arguments as named parameters, the macro invocation behaves as if a comma token has been appended to the argument list such that varying arguments are formed that contain no pp-tokens.
6.10.5.2 Argument substitution
Syntax
- va-opt-replacement:
__VA_OPT__ (pp-tokensopt)
Description
Argument substitution is a process during macro expansion in which identifiers corresponding to the parameters of the macro definition and the special constructs __VA_ARGS__ and __VA_OPT__ are replaced with token sequences from the arguments of the macro invocation and possibly of the argument of the feature __VA_OPT__. The latter process allows to control a substitute token sequence that is only expanded if the argument list that corresponds to a trailing ... of the parameter list is present and has a non-empty substitution.
Constraints
The identifier __VA_OPT__ shall always occur as part of the preprocessing token sequence va-optreplacement; its closing ) is determined by skipping intervening pairs of matching left and right parentheses in its pp-tokens. The pp-tokens of a va-opt-replacement shall not contain __VA_OPT__. The pp-tokens shall form a valid replacement list for the current function-like macro.
Semantics
After the arguments for the invocation of a function-like macro have been identified, argument substitution takes place. A va-opt-replacement is treated as if it were a parameter. For each parameter that occurs in the replacement list such that it is neither preceded by a # or ## preprocessing token nor followed by a ## preprocessing token, the preprocessing tokens naming the parameter are replaced by a token sequence determined as follows:
- If the parameter is of the form va-opt-replacement, the replacement preprocessing tokens are the preprocessing token sequence for the corresponding argument, as specified later in this subclause.
- Otherwise, the replacement preprocessing tokens are the preprocessing tokens of the corresponding argument after all macros contained therein have been expanded. The argument’s preprocessing tokens are completely macro replaced before being substituted as if they formed the rest of the preprocessing file with no other preprocessing tokens being available. For each such parameter this expansion is performed exactly once, and then preprocessing tokens naming the parameter are each replaced with the resulting token list.
EXAMPLE 1
#define LPAREN() ( #define G(Q) 42 #define F(R, X, ...) __VA_OPT__(G R X) ) int x = F(LPAREN(), 0, <:-); // replaced by int x = 42;
An identifier __VA_ARGS__ that occurs in the replacement list is treated as if it were a parameter, and the varying arguments form the preprocessing tokens used to replace it.
The preprocessing token sequence for the corresponding argument of a va-opt-replacement is defined as follows. If a (hypothetical) substitution of __VA_ARGS__ as neither an operand of # nor ## consists of no preprocessing tokens, the argument consists of a single placemarker preprocessing token (6.10.5.4, 6.10.5.5). Otherwise, the argument consists of the results of the expansion of the contained pp-tokens as the replacement list of the current function-like macro before removal of placemarker tokens, rescanning, and further replacement.
NOTE The placemarker tokens are removed before stringization (6.10.5.3), and can be removed by rescanning and further replacement (6.10.5.5).
EXAMPLE 2
#define F(...) f(0 __VA_OPT__(,) __VA_ARGS__) #define G(X, ...) f(0, X __VA_OPT__(,) __VA_ARGS__) #define SDEF(sname, ...) S sname __VA_OPT__(= { __VA_ARGS__ }) #define EMP F(a, b, c) // replaced by f(0, a, b, c) F() // replaced by f(0) F(EMP) // replaced by f(0) G(a, b, c) // replaced by f(0, a, b, c) G(a, ) // replaced by f(0, a) G(a) // replaced by f(0, a) SDEF(foo); // replaced by S foo; SDEF(bar, 1, 2); // replaced by S bar = { 1, 2 }; #define H1(X, ...) X __VA_OPT__(##) __VA_ARGS__ // error: ## on line above // cannot appear at the beginning of a replacement // list (6.10.5.4) #define H2(X, Y, ...) __VA_OPT__(X ## Y,) __VA_ARGS__ H2(a, b, c, d) // replaced by ab, c, d #define H3(X, ...) #__VA_OPT__(X##X X##X) H3(, 0) // replaced by "" #define H4(X, ...) __VA_OPT__(a X ## X) ## b H4(, 1) // replaced by a b #define H5A(...) __VA_OPT__()/**/__VA_OPT__() #define H5B(X) a ## X ## b #define H5C(X) H5B(X) H5C(H5A()) // replaced by ab
6.10.5.3 The # operator
Constraints
Each # preprocessing token in the replacement list for a function-like macro shall be followed by a parameter as the next preprocessing token in the replacement list.
Semantics
If, in the replacement list, a parameter is immediately preceded by a # preprocessing token, both are replaced by a single ordinary string literal preprocessing token that contains the spelling of the preprocessing token sequence for the corresponding argument (excluding placemarker tokens).
Let the stringizing argument be the preprocessing token sequence for the corresponding argument with placemarker tokens removed. Each occurrence of white space between the stringizing argument’s preprocessing tokens becomes a single space character in the ordinary string literal. White space before the first preprocessing token and after the last preprocessing token composing the stringizing argument is deleted. Otherwise, the original spelling of each preprocessing token in the stringizing argument is retained in the ordinary string literal, except for special handling for producing the spelling of string literals and character literals: a \ character is inserted before each " and \ character of a character literal or string literal (including the delimiting " characters), except that it is implementation-defined whether a \ character is inserted before the \ character beginning a universal character name.
If the replacement that results is not a valid ordinary string literal, the behavior is undefined. The ordinary string literal corresponding to an empty stringizing argument is "". The order of evaluation of # and ## operators is unspecified.
6.10.5.4 The ## operator
Constraints
A ## preprocessing token shall not occur at the beginning or at the end of a replacement list for either form of macro definition.
A character sequence that matches the syntax of a universal character name shall not be produced by token concatenation.
Semantics
If, in the replacement list of a function-like macro, a parameter is immediately preceded or followed by a ## preprocessing token, the parameter is replaced by the corresponding argument’s preprocessing token sequence; however, if an argument consists of no preprocessing tokens, the parameter is
For both object-like and function-like macro invocations, before the replacement list is reexamined for more macro names to replace, each instance of a ## preprocessing token in the replacement list (not from an argument) is deleted and the preceding preprocessing token is concatenated with the following preprocessing token. Placemarker preprocessing tokens are handled specially: concatenation of two placemarkers results in a single placemarker preprocessing token, and concatenation of a placemarker with a non-placemarker preprocessing token results in the non-placemarker preprocessing token. If the result is not a valid preprocessing token, the behavior is undefined. The resulting token is available for further macro replacement. The order of evaluation of ## operators is unspecified.
EXAMPLE In the following fragment:
#define hash_hash # ## # #define mkstr(a) # a #define in_between(a) mkstr(a) #define join(c, d) in_between(c hash_hash d) char p[] = join(x, y); // equivalent to // char p[] = "x ## y";The expansion produces, at various stages:
join(x, y) in_between(x hash_hash y) in_between(x ## y) mkstr(x ## y) "x ## y"
In other words, expanding hash_hash produces a new token, consisting of two adjacent sharp signs, but this new token is not the ## operator.
6.10.5.5 Rescanning and further replacement
After all parameters in the replacement list have been substituted and # and ## processing has taken place, all placemarker preprocessing tokens are removed. The resulting preprocessing token sequence is then rescanned, along with all subsequent preprocessing tokens of the source file, for more macro names to replace.
If the name of the macro being replaced is found during this scan of the replacement list (not including the rest of the source file’s preprocessing tokens), it is not replaced. Furthermore, if any nested replacements encounter the name of the macro being replaced, it is not replaced. These nonreplaced macro name preprocessing tokens are no longer available for further replacement even if they are later (re)examined in contexts in which that macro name preprocessing token would otherwise have been replaced.
The resulting completely macro-replaced preprocessing token sequence is not processed as a preprocessing directive even if it resembles one, but all pragma unary operator expressions within it are then processed as specified in 6.10.11.
EXAMPLE There are cases where it is not clear whether a replacement is nested or not. For example, given the following macro definitions:
#define f(a) a*g #define g(a) f(a) f(2)(9) 2*f(9) 2*9*g
6.10.5.6 Scope of macro definitions
A macro definition lasts (independent of block structure) until a corresponding #undef directive is encountered or (if none is encountered) until the end of the preprocessing translation unit. Macro definitions have no significance after translation phase 4.
A preprocessing directive of the form
# undef identifier new-line
causes the specified identifier no longer to be defined as a macro name. It is ignored if the specified identifier is not currently defined as a macro name.
EXAMPLE 1 The simplest use of this facility is to define a "manifest constant", as in
#define TABSIZE 100 int table[TABSIZE];
EXAMPLE 2 The following defines a function-like macro whose value is the maximum of its arguments. It has the advantages of working for any compatible types of the arguments and of generating in-line code without the overhead of function calling. It has the disadvantages of evaluating one or the other of its arguments a second time (including side effects) and generating more code than a function if invoked several times. It also cannot have its address taken, as it has none.
#define max(a, b) ((a) > (b) ? (a): (b))
The parentheses ensure that the arguments and the resulting expression are bound properly.
EXAMPLE 3 To illustrate the rules for redefinition and reexamination, the sequence
#define x 3 #define f(a) f(x * (a)) #undef x #define x 2 #define g f #define z z[0] #define h g(~ #define m(a) a(w) #define w 0,1 #define t(a) a #define p() int #define q(x) x #define r(x,y) x## y #define str(x) # x f(y+1) + f(f(z)) % t(t(g)(0) + \t)(1); g(x+(3,4)-w) | h 5) & m (f)^m(m); p() i[q()] = { q(1), r(2,3), r(4,), r(,5), r(,) }; char c[2][6] = { str(hello), str() }; f(2 * (y+1)) + f(2 * (f(2 * (z[0])))) % f(2 * (0)) + t(1); f(2 * (2+(3,4)-0,1)) | f(2 * (~ 5)) & f(2 * (0,1))^m(0,1); int i[] = { 1, 23, 4, 5, }; char c[2][6] = { "hello", "" };
EXAMPLE 4 To illustrate the rules for creating ordinary string literals and concatenating tokens, the sequence
#define str(s) # s #define xstr(s) str(s) #define debug(s, t) printf("x" # s "= %d, x" # t "= %s", \ x ## s, x ## t) #define INCFILE(n) vers ## n #define glue(a, b) a ## b #define xglue(a, b) glue(a, b) #define HIGHLOW "hello" #define LOW LOW ", world" debug(1, 2); fputs(str(strncmp("abc\0d", "abc", ’\4’) // this goes away == 0) str(: @\n), s); #include xstr(INCFILE(2).h) glue(HIGH, LOW); xglue(HIGH, LOW)results in
printf("x" "1" "= %d, x" "2" "= %s", x1, x2); fputs( "strncmp(\"abc\0d\", \"abc\", ’\4’) == 0" ": @\n", s); #include "vers2.h" (after macro replacement, before file access) "hello"; "hello" ", world"or, after concatenation of the ordinary string literals,
printf("x1= %d, x2= %s", x1, x2); fputs( "strncmp(\"abc\0d\", \"abc\", ’\4’) == 0: @\n", s); #include "vers2.h" (after macro replacement, before file access) "hello"; "hello, world"
Space around the # and ## tokens in the macro definition is optional.
EXAMPLE 5 To illustrate the rules for placemarker preprocessing tokens, the sequence
#define t(x,y,z) x ## y ## z int j[] = { t(1,2,3), t(,4,5), t(6,,7), t(8,9,), t(10,,), t(,11,), t(,,12), t(,,) };results in
int j[] = { 123, 45, 67, 89, 10, 11, 12, };
#define OBJ_LIKE (1-1) #define OBJ_LIKE /* white space */ (1-1) /* other */ #define FUNC_LIKE(a) ( a ) #define FUNC_LIKE( a ) ( /* note the white space */ \ a /* other stuff on this line */) #define OBJ_LIKE (0) // different token sequence #define OBJ_LIKE (1 - 1) // different white space #define FUNC_LIKE(b) ( a ) // different parameter usage #define FUNC_LIKE(b) ( b ) // different parameter spelling
EXAMPLE 7
Finally, to show the varying argument list macro facilities:
#define debug(...) fprintf(stderr, __VA_ARGS__) #define showlist(...) puts(#__VA_ARGS__) #define report(test, ...) ((test)?puts(#test):\ printf(__VA_ARGS__)) debug("Flag"); debug("X = %d\n", x); showlist(The first, second, and third items.); report(x>y, "x is %d but y is %d", x, y);results in
fprintf(stderr, "Flag"); fprintf(stderr, "X = %d\n", x); puts("The first, second, and third items."); ((x>y)?puts("x>y"): printf("x is %d but y is %d", x, y));
6.10.6 Line control
Constraints
The string literal of a #line directive, if present, shall be an ordinary string literal.
Semantics
The line number of the current source line is one greater than the number of new-line characters read or introduced in translation phase 1 (5.2.1.2) while processing the source file to the current token.
If a preprocessing token (in particular __LINE__) spans two or more physical lines, it is unspecified which of those line numbers is associated with that token. If a preprocessing directive spans two or more physical lines, it is unspecified which of those line numbers is associated with the preprocessing directive. If a macro invocation spans multiple physical lines, it is unspecified which of those line numbers is associated with that invocation. The line number of a preprocessing token is independent of the context (in particular, as a macro argument or in a preprocessing directive). The line number of a __LINE__ in a macro body is the line number of the macro invocation.
A preprocessing directive of the form
# line digit-sequence new-line
causes the implementation to behave as if the following sequence of source lines begins with a source line that has a line number as specified by the digit sequence (interpreted as a decimal integer, ignoring any optional digit separators (6.4.5.2) in the digit sequence). The digit sequence shall not specify zero, nor a number greater than 2147483647.
A preprocessing directive of the form
- :
# linedigit-sequence"s-char-sequenceopt"new-line
A preprocessing directive of the form
# line pp-tokens new-line
(that does not match one of the two previous forms) is permitted. The preprocessing tokens after line on the directive are processed just as in normal text (each identifier currently defined as a macro name is replaced by its replacement list of preprocessing tokens). The directive resulting after all replacements shall match one of the two previous forms and is then processed as appropriate.216)
Recommended practice
The line number associated with a pp-token should be the line number of the first character of the pp-token. The line number associated with a preprocessing directive should be the line number of the line with the first # token. The line number associated with a macro invocation should be the line number of the first character of the macro name in the invocation.
6.10.7 Diagnostic directives
Semantics
A preprocessing directive of either form
# error pp-tokensopt new-line # warning pp-tokensopt new-line
causes the implementation to produce a diagnostic message that includes the specified sequence of preprocessing tokens.
6.10.8 Pragma directive
Semantics
A preprocessing directive of the form
# pragma pp-tokensopt new-line
where the preprocessing token STDC does not immediately follow pragma in the directive (prior to any macro replacement)217) causes the implementation to behave in an implementation-defined manner. The behavior can cause translation to fail or cause the translator or the resulting program to behave in a non-conforming manner. Any such pragma that is not recognized by the implementation is ignored.
If the preprocessing token STDC does immediately follow pragma in the directive (prior to any macro replacement), then no macro replacement is performed on the directive, and the directive shall have one of the following forms218) whose meanings are described elsewhere:
- standard-pragma:
# pragma STDC FP_CONTRACTon-off-switch# pragma STDC FENV_ACCESSon-off-switch# pragma STDC FENV_DEC_ROUNDdec-direction# pragma STDC FENV_ROUNDdirection# pragma STDC CX_LIMITED_RANGEon-off-switch
- on-off-switch: one of
ONOFFDEFAULT
- direction: one of
FE_DOWNWARDFE_TONEARESTFE_TONEARESTFROMZEROFE_TOWARDZEROFE_UPWARDFE_DYNAMIC
- dec-direction: one of
FE_DEC_DOWNWARDFE_DEC_TONEARESTFE_DEC_TONEARESTFROMZEROFE_DEC_TOWARDZEROFE_DEC_UPWARDFE_DEC_DYNAMIC
Recommended practice
Implementations are encouraged to diagnose unrecognized pragmas.
CX_LIMITED_RANGE pragma (7.3.4), the FP_CONTRACT pragma (7.12.3), the FENV_ACCESS pragma (7.6.2), the FENV_DEC_ROUND pragma (7.6.4), the FENV_ROUND pragma (7.6.3).6.10.9 Null directive
Semantics
6.10.10 Predefined macro names
6.10.10.1 General
The values of the predefined macros listed in the following subclauses219) (except for __COUNTER__, __FILE__ and __LINE__) remain constant throughout the translation unit.
None of the following macro names in this subclause nor the identifiers defined, __has_c_attribute, __has_include, or __has_embed shall be the subject of a #define or a #undef preprocessing directive. Any other predefined macro names: shall begin with a leading underscore followed by an uppercase letter; or, a second underscore; or, shall be any of the identifiers alignas, alignof, bool, false, static_assert, thread_local, or true.
The implementation shall not predefine the macro __cplusplus, nor shall it define it in any standard header.
6.10.10.2 Mandatory macros
The following macro names shall be defined by the implementation:
__COUNTER__ a per-expansion unique integer literal as described in 6.10.10.2.1.
__DATE__ The date of translation of the preprocessing translation unit: an ordinary string literal of the form "Mmm dd yyyy", where the names of the months are the same as those generated by the asctime function, and the first character of dd is a space character if the value is less than . If the date of translation is not available, an implementation-defined valid date shall be supplied.
__FILE__ The presumed name of the current source file (an ordinary string literal).220)
__LINE__ The presumed line number (within the current source file) of the current source line (an integer literal).220)
asctime function (7.31.3.2).6.10.10.2.1 The __COUNTER__ predefined macro
Description
The expansion of the object-like macro __COUNTER__ produces a unique integer literal not containing any digit separators that relates to the specific lexical position within the pp-token sequence during translation phase 4. The produced integer literal is such that a concatenation with a preceding identifier token using the ## operator again results in an identifier token, and such that when interpreted in translation phase 7 it has a value that is representable with the signed long type. The value of the first expansion in a given translation unit is zero, and each subsequent expansion produces a value that is one greater than the previous one.
It is unspecified if the inclusion of any of the standard headers of clause 7 or if the invocations of any macro that is defined by them will result in expansions of the __COUNTER__ macro.
Constraints
The number of expansions of the __COUNTER__ macro in a translation unit shall not exceed 2147483648.
Recommended practice
Application code should not make other assumptions than given in the description about the form, type or value of the integer literal that is produced.
EXAMPLE The __COUNTER__ predefined macro is useful for producing unique identifiers:
#define CONCAT_IMPL(A, B) A ## B #define CONCAT(A, B) CONCAT_IMPL(A, B) #define UNIQUE_ID(NAME) CONCAT(NAME, __COUNTER__) #define SWAP_IMPL(A, B, PTRA, PTRB, TMP) \ do { \ auto PTRA = &(A); \ auto PTRB = &(B); \ auto TMP = *PTRA; \ *PTRA = *PTRB; \ *PTRB = TMP; \ } while (false) /* A and B are modifiable and addressable lvalues. */ #define SWAP(A, B) \ SWAP_IMPL(A, B, \ UNIQUE_ID(ptr), \ UNIQUE_ID(ptr), \ UNIQUE_ID(val)) do { auto ptr0 = &(X[35]); auto ptr1 = &(y); auto val2 = *ptr0; *ptr0 = *ptr1; *ptr1 = val2; } while (false)
6.10.10.3 Environment macros
The following macro names are conditionally defined by the implementation:
__STDC_ISO_10646__ An integer literal of the form yyyymmL (for example, 202012L). If this symbol is defined, then every character in the Unicode required set, when stored in an object of type wchar_t, has the same value as the short identifier of that character. The Unicode required set consists of all the characters that are defined by ISO/IEC 10646, along with all amendments and technical corrigenda, as of the specified year and month. If some other encoding is used, the macro shall not be defined and the actual encoding used is implementation-defined.
__STDC_LITERAL_UTF8__ A strictly positive integer constant expression if this symbol is defined. If it is defined, then the literal encoding (6.2.9) is capable of storing every character in the Unicode required set and every sequence of char (with each the value of char treated as an unsigned char) from a string literal (excluding non-Universal character escape sequences) forms a valid encoding of a UTF-8 sequence.
__STDC_LITERAL_UTF16__ A strictly positive integer constant expression if this symbol is defined. If it is defined, then the literal encoding (6.2.9) is capable of storing every character in the Unicode required set and every sequence of char (with each the value of char treated as an unsigned char) from a string literal (excluding non-Universal character escape sequences) forms a valid encoding of a UTF-16 sequence.
__STDC_LITERAL_UTF32__ A strictly positive integer constant expression if this symbol is defined. If it is defined, then the literal encoding (6.2.9) is capable of storing every character in the Unicode required set and every sequence of char (with each the value of char treated as an unsigned char) from a string literal (excluding non-Universal character escape sequences) forms a valid encoding of a UTF-32 sequence.
__STDC_MB_MIGHT_NEQ_WC__ The integer literal 1, intended to indicate that, in the encoding for
wchar_t, a member of the basic character set is not required to have a code value equal to its value when used as the lone character in an ordinary character literal.
__STDC_WIDE_LITERAL_UTF8__ A strictly positive integer constant expression if this symbol is defined. If it is defined, then the wide literal encoding (6.2.9) is capable of storing every character in the Unicode required set and every sequence of wchar_t from a wchar_t string literal (excluding non-Universal character escape sequences) forms a valid encoding of a UTF-8 sequence.
6.10.10.4 Conditional feature macros
The following macro names are conditionally defined by the implementation:
__STDC_ANALYZABLE__ The integer literal 1, if the implementation conforms to the specifications in Annex L (Analyzability).
__STDC_IEC_60559_BFP__ The integer literal 202ymmL, intended to indicate conformance to Annex F (ISO/IEC 60559 floating-point arithmetic) for binary floating-point arithmetic.
__STDC_IEC_559__ The integer literal 1, intended to indicate conformance to the specifications in Annex F (ISO/IEC 60559 floating-point arithmetic) for binary floating-point arithmetic. Use of this macro is an obsolescent feature.
__STDC_IEC_60559_DFP__ The integer literal 202ymmL, intended to indicate support of decimal floating types and conformance to Annex F (ISO/IEC 60559 floating-point arithmetic) for decimal floating-point arithmetic.
__STDC_IEC_60559_COMPLEX__ The integer literal 202ymmL, intended to indicate conformance to the specifications in Annex G (ISO/IEC 60559 compatible complex arithmetic).
__STDC_IEC_60559_TYPES__ The integer literal 202ymmL, intended to indicate conformance to the specification in Annex H (ISO/IEC 60559 interchange and extended types).
__STDC_LIB_EXT1__ The integer literal 202ymmL, intended to indicate support for the extensions defined in Annex K (Bounds-checking interfaces).
__STDC_NO_ATOMICS__ The integer literal 1, intended to indicate that the implementation does not support atomic types (including the _Atomic type qualifier) and the <stdatomic.h> header.
__STDC_NO_COMPLEX__ The integer literal 1, intended to indicate that the implementation does not support complex types or the <complex.h> header. An implementation that defines this macro shall not define __STDC_IEC_60559_COMPLEX__.
__STDC_NO_THREADS__ The integer literal 1, intended to indicate that the implementation does not support the <threads.h> header.
__STDC_NO_VLA__ The integer literal 1, intended to indicate that the implementation does not support variable length arrays with automatic storage duration. Parameters declared with variable length array types are adjusted and then define objects of automatic storage duration with pointer types. Thus, support for such declarations is mandatory.
NOTE The intention for the macros __STDC_LIB_EXT1__, __STDC_IEC_60559_BFP__, __STDC_IEC_60559_DFP__, __STDC_IEC_60559_COMPLEX__, and __STDC_IEC_60559_TYPES__, with the value 202ymmL, is that this will remain an integer literal of type long int that is increased with each edition of this document.
6.10.11 Pragma operator
Semantics
A unary operator expression of the form:
_Pragma ( string-literal )
is processed as follows: The string literal is destringized by deleting any encoding prefix, deleting the leading and trailing double-quotes, replacing each escape sequence \" by a double-quote, and replacing each escape sequence \\ by a single backslash. The resulting sequence of characters is processed through translation phase 3 to produce preprocessing tokens that are executed as if they were the pp-tokens in a pragma directive. The original four preprocessing tokens in the unary operator expression are removed.
EXAMPLE A directive of the form:
#pragma listing on "..\listing.dir"can also be expressed as:
_Pragma ("listing on \"..\listing.dir\"")The latter form is processed in the same way whether it appears literally as shown, or results from macro replacement, as in:
#define LISTING(x) PRAGMA(listing on #x) #define PRAGMA(x) _Pragma(#x) LISTING (..\listing.dir)
6.11 Future language directions
6.11.1 Floating types
Future standardization can include additional floating types, including those with greater range, precision, or both than long double.
6.11.2 Linkages of identifiers
Declaring an identifier with internal linkage at file scope without the static or constexpr storageclass specifier is an obsolescent feature.
6.11.3 External names
Restriction of the significance of an external name to fewer than 255 characters (considering each universal character name or extended source character as a single character) is an obsolescent feature that is a concession to existing implementations.
6.11.4 Character escape sequences
Lowercase letters as escape sequences are reserved for future standardization. Other characters may be used in extensions.
6.11.5 Octal integer literals
The use of nonzero octal integer literals without the prefix 0o or 0O is an obsolescent feature.
6.11.6 Postfix operators
The use of the array subscripting operator with an operand of integer type followed by an operand of pointer or array type enclosed in square brackets is an obsolescent feature.
6.11.7 Storage-class specifiers
The placement of a storage-class specifier other than at the beginning of the declaration specifiers in a declaration is an obsolescent feature.
Future standardization can change the auto storage-class specifier to a type specifier.
6.11.8 Pragma directives
Pragmas whose first preprocessing token is STDC are reserved for future standardization.
6.11.9 Predefined macro names
Macro names beginning with __STDC_ are reserved for future standardization.
Use of the __STDC_IEC_559__ macro is an obsolescent feature.
7 Library
7.1 Introduction
7.1.1 Definitions of terms
A string is a contiguous sequence of characters terminated by and including the first null character. The term multibyte string is sometimes used instead to emphasize special processing given to multibyte characters contained in the string or to avoid confusion with a wide string. A pointer to a string is a pointer to its initial (lowest addressed) character. The length of a string is the number of bytes preceding the null character and the value of a string is the sequence of the values of the contained characters, in order.
The decimal-point character is the character used by functions that convert floating-point numbers to or from character sequences to denote the beginning of the fractional part of such character sequences.222) It is represented in the text and examples by a period, but can be changed by the setlocale function.
A null wide character is a wide character with code value zero.
A wide string is a contiguous sequence of wide characters terminated by and including the first null wide character. A pointer to a wide string is a pointer to its initial (lowest addressed) wide character. The length of a wide string is the number of wide characters preceding the null wide character and the value of a wide string is the sequence of code values of the contained wide characters, in order.
A shift sequence is a contiguous sequence of bytes within a multibyte string that (potentially) causes a change in shift state (see 5.3.2). A shift sequence shall not have a corresponding wide character; it is instead taken to be an adjunct to an adjacent multibyte character.223) In this clause, "white-space character" refers to (execution) white-space character as defined by isspace. "White-space wide character" refers to (execution) white-space wide character as defined by iswspace.
7.1.2 Standard headers
Each library function is declared in a header,224) whose contents are made available by the #include preprocessing directive. The header declares a set of related functions, plus any types and additional macros needed to facilitate the use of such related functions. In addition to the provisions given in this clause, an implementation that defines __STDC_IEC_60559_BFP__, __STDC_IEC_559__, or __STDC_IEC_60559_DFP__ shall conform to the specifications in Annex F, one that defines __STDC_IEC_60559_COMPLEX__ shall conform to the specifications in Annex G, one that defines __STDC_IEC_60559_TYPES__ shall conform to the specifications in Annex H and one that defines __STDC_LIB_EXT1__ shall conform to the specifications in Annex K, and those Annexes should be read as if they were merged into the parallel structure of named subclauses of this clause. Declarations of types described here, in Annex H, or in Annex K, shall not include type qualifiers, unless explicitly stated otherwise.
An implementation that does not support decimal floating types (6.10.10.4) may not support interfaces or aspects of interfaces that are specific to these types.
- :
<setjmp.h><signal.h><stdalign.h><stdarg.h><stdatomic.h><stdbit.h><stdbool.h><stdckdint.h><stdcountof.h><stddef.h><stdint.h><stdio.h><stdlib.h><stdmchar.h><stdnoreturn.h><string.h><tgmath.h><threads.h><time.h><uchar.h><wchar.h><wctype.h>
If a file with the same name as one of the preceding entries in < and > delimited sequences, not provided as part of the implementation, is placed in any of the standard places that are searched for included source files, the behavior is undefined.
Standard headers can be included in any order; each can be included more than once in a given scope, with no effect different from being included only once, except that the effect of including <assert.h> depends on the definition of NDEBUG (see 7.2). If used, a header shall be included outside of any external declaration or definition, and it shall first be included before the first reference to any of the functions or objects it declares, or to any of the types or macros it defines. However, if an identifier is declared or defined in more than one header, the second and subsequent associated headers can be included after the initial reference to the identifier. The program shall not have any macros with names lexically identical to keywords currently defined prior to the inclusion of the header or when any macro defined in the header is expanded.
Some standard headers define or declare identifiers that had not been present in previous versions of this document. To allow implementations and users to adapt to that situation, they also define a version macro for feature test of the form __STDC_VERSION_XXXX_H__, where XXXX is the all-caps spelling of the corresponding header <xxxx.h>. These version macros expand to one of many values detailed in the subclauses of Annex M such as 202311L and 202ymmL.
Any definition of an object-like macro described in this clause or Annex F, Annex G, Annex H, or Annex K shall expand to code that is fully protected by parentheses where necessary, so that it groups in an arbitrary expression as if it were a single identifier.
The evaluation of the replacement for an object-like macro described in this clause or Annex F, Annex G, Annex H, or Annex K shall not raise a floating-point exception.226)
Any declaration of a library function shall have external linkage.
A summary of the contents of the standard headers is given in Annex B.
7.1.3 Reserved identifiers
Each header declares or defines all identifiers listed in its associated subclause, and optionally declares or defines identifiers listed in its associated future library directions subclause and identifiers which are always reserved either for any use or for use as file scope identifiers.
- All potentially reserved identifiers (including ones listed in the future library directions) that are provided by an implementation with an external definition are reserved for any use. An implementation shall not provide an external definition of a potentially reserved identifier unless that identifier is reserved for a use where it would have external linkage.227) All other potentially reserved identifiers that are provided by an implementation (including in the form of a macro) are reserved for any use when the associated header is included. No other
7.1.4 Use of library functions
Each of the following statements applies unless explicitly stated otherwise in the detailed descriptions that follow:
- If an argument to a function has an invalid value (such as a value outside the domain of the function, or a pointer outside the address space of the program, or a null pointer, or a pointer to non-modifiable storage when the corresponding parameter is not const-qualified) or a type (after default argument promotion) not expected by a variadic function, the behavior is undefined.
- If a function argument is described as being an array, the pointer passed to the function shall have a value such that all address computations and accesses to objects (that would be valid if the pointer did point to the first element of such an array) are valid.230)
- Any function declared in a header may be additionally implemented as a function-like macro defined in the header, so if a library function is declared explicitly when its header is included, one of the techniques shown later in the next subclause can be used to ensure the declaration is not affected by such a macro. Any macro definition of a function can be suppressed locally by enclosing the name of the function in parentheses, because the name is then not followed by the left parenthesis that indicates expansion of a macro function name. For the same syntactic reason, it is permitted to take the address of a library function even if it is also defined as a macro.231) The use of
#undefto remove any macro definition will also ensure that an actual function is referred to. - Any invocation of a library function that is implemented as a macro shall expand to code that evaluates each of its arguments exactly once, fully protected by parentheses where necessary, so it is generally safe to use arbitrary expressions as arguments.232)
- Likewise, those function-like macros described in the following subclauses may be invoked in an expression anywhere a function with a compatible return type could be called.233)
Provided that a library function can be declared without reference to any type defined in a header, it is also permissible to declare the function and use it without including its associated header.
There is a sequence point immediately before a library function returns.
The functions in the standard library are not guaranteed to be reentrant and may modify objects with static or thread storage duration.234)
Unless explicitly stated otherwise in the detailed descriptions that follow, library functions shall prevent data races as follows: A library function shall not directly or indirectly access objects accessible by threads other than the current thread unless the objects are accessed directly or indirectly via the function’s arguments. A library function shall not directly or indirectly modify objects accessible by threads other than the current thread unless the objects are accessed directly or indirectly via the function’s non-const arguments.235) Implementations may share their own internal objects between threads if the objects are not visible to users and are protected against data races.
Unless otherwise specified, library functions shall perform all operations solely within the current thread if those operations have effects that are visible to users.236)
EXAMPLE The function atoi can be used in any of several ways:
- by use of its associated header (possibly generating a macro expansion)
#include <stdlib.h> const char *str; /* ... */ i = atoi(str);
- by use of its associated header (assuredly generating a true function reference)
#include <stdlib.h> #undef atoi const char *str; /* ... */ i = atoi(str);or
#include <stdlib.h> const char *str; /* ... */ i = (atoi)(str);
- by explicit declaration
extern int atoi(const char *); const char *str; /* ... */ i = atoi(str);
A library function (other than raise) should execute without raising SIGFPE.
7.2 Diagnostics <assert.h>
7.2.1 General
The header <assert.h> defines the assert and __STDC_VERSION_ASSERT_H__ macros and refers to another macro,
NDEBUGwhich is not defined by <assert.h>. If NDEBUG is defined as a macro name at the point in the source file where <assert.h> is included, the assert macro is defined simply as#define assert(...) ((void)0)
The assert macro is redefined according to the current state of NDEBUG each time that <assert.h> is included.
The assert macro shall be implemented as a macro with an ellipsis parameter, not as an actual function. If the macro definition is suppressed to access an actual function, the behavior is undefined.
NOTE Nevertheless, when NDEBUG is not defined, the macro acts as a function taking one parameter as indicated by the prototype as given later in this subclause (7.2.2.1). For both assert() and assert(1, 1), the number of arguments does not agree with the number of parameters. A diagnostic is required by 6.5.3.3.
The macro
__STDC_VERSION_ASSERT_H__is an integer constant expression with a value equivalent to 202311L.
7.2.2 Program diagnostics
7.2.2.1 The assert macro
Synopsis
#include <assert.h> void assert(scalar expression);
Description
The assert macro puts diagnostic tests into programs; it expands to a void expression. When it is executed, if expression (which shall have a scalar type) is false (that is, compares equal to ), the assert macro writes information about the particular invocation that failed (including the text of the argument, the name of the source file, the source line number, and the name of the enclosing function — the latter are respectively the values of the preprocessing macros __FILE__ and __LINE__ and of the identifier __func__) on the standard error stream in an implementation-defined format.237)
It then calls the abort function.
Returns
The assert macro returns no value.
abort function (7.25.5.1).7.3 Complex arithmetic <complex.h>
7.3.1 Introduction
Implementations that define the macro __STDC_NO_COMPLEX__ may not provide this header nor support any of its facilities. The macro __STDC_VERSION_COMPLEX_H__ is an integer constant expression with a value equivalent to 202ymmL.
The macro Complex expands to _Complex; the macro _Complex_I expands to an arithmetic constant expression of type float _Complex with the value of its real part being positive or unsigned zero and the value of its imaginary part being one; the macro I expands to _Complex_I or to an arithmetic constant expression of another implementation-defined type with the same value and precision. Notwithstanding the provisions of 7.1.3
- a program may undefine and perhaps then redefine the macros
complex, andI; - the implementation may define a macro
imaginarybut a program may undefine and perhaps then redefine that identifier.
Each synopsis, other than for the CMPLX macros, specifies a family of functions consisting of a principal function with one or more double complex parameters and a double complex or double return type, and similar functions whose names have f and l suffixes and whose parameter and return types have corresponding real types float and long double. The synopsis for the CMPLX macros is similar, except that the parameters have real floating types and the suffixes are F and L.
CMPLX macros (7.3.9.3), ISO/IEC 60559-compatible complex arithmetic (Annex G).7.3.2 Conventions
Values are interpreted as radians, not degrees. An implementation may set errno but is not required to do so.
7.3.3 Branch cuts
Some of the following functions have branch cuts, across which the function is discontinuous. For implementations with a signed zero (including all ISO/IEC 60559 implementations) that follow the specifications of Annex G, the sign of zero distinguishes one side of a cut from another so that the function is continuous (except for format limitations) as the cut is approached from either side. For example, for the square root function, which has a branch cut along the negative real axis, the top of the cut, with imaginary part +0, maps to the positive imaginary axis, and the bottom of the cut, with imaginary part -0, maps to the negative imaginary axis.
Implementations that do not support a signed zero (see Annex F) cannot distinguish the sides of branch cuts. These implementations shall map a cut so that the function is continuous as the cut is approached coming around the finite endpoint of the cut in a counter clockwise direction. (Branch cuts for the functions specified here have just one finite endpoint.) For example, in the square root function, coming counter clockwise around the finite endpoint of the cut along the negative real axis approaches the cut from above, so that the cut maps to the positive imaginary axis.
7.3.4 The CX_LIMITED_RANGE pragma
Synopsis
#include <complex.h> #pragma STDC CX_LIMITED_RANGE on-off-switch
Description
The usual mathematical formulas for complex multiply, divide, and absolute value are problematic because of their treatment of infinities and because of undue overflow and underflow. The CX_LIMITED_RANGE pragma can be used to inform the implementation that (where the state is "on") the usual mathematical formulas are acceptable.239) The pragma can occur either outside external declarations or preceding all explicit declarations and statements inside a compound statement. When outside external declarations, the pragma takes effect from its occurrence until another CX_LIMITED_RANGE pragma is encountered, or until the end of the translation unit. When inside a compound statement, the pragma takes effect from its occurrence until another CX_LIMITED_RANGE pragma is encountered (including within a nested compound statement), or until the end of the compound statement; at the end of a compound statement the state for the pragma is restored to its condition just before the compound statement. If this pragma is used in any other context, the behavior is undefined. The default state for the pragma is "off".
7.3.5 Trigonometric functions
7.3.5.1 The cacos functions
Synopsis
#include <complex.h> double complex cacos(double complex z); float complex cacosf(float complex z); long double complex cacosl(long double complex z);
Description
The cacos functions compute the complex arc cosine of z, with branch cuts outside the interval along the real axis.
Returns
The cacos functions return the complex arc cosine value, in the range of a strip mathematically unbounded along the imaginary axis and in the interval along the real axis.
7.3.5.2 The casin functions
Synopsis
#include <complex.h> double complex casin(double complex z); float complex casinf(float complex z); long double complex casinl(long double complex z);
Description
The casin functions compute the complex arc sine of z, with branch cuts outside the interval along the real axis.
Returns
The casin functions return the complex arc sine value, in the range of a strip mathematically unbounded along the imaginary axis and in the interval
along the real axis.
239)The purpose of the pragma is to allow the implementation to use the formulas:
=
=
= �
7.3.5.3 The catan functions
Synopsis
#include <complex.h> double complex catan(double complex z); float complex catanf(float complex z); long double complex catanl(long double complex z);
Description
The catan functions compute the complex arc tangent of z, with branch cuts outside the interval along the imaginary axis.
Returns
The catan functions return the complex arc tangent value, in the range of a strip mathematically unbounded along the imaginary axis and in the interval
along the real axis.
7.3.5.4 The ccos functions
Synopsis
#include <complex.h> double complex ccos(double complex z); float complex ccosf(float complex z); long double complex ccosl(long double complex z);
Description
The ccos functions compute the complex cosine of z.
Returns
The ccos functions return the complex cosine value.
7.3.5.5 The csin functions
Synopsis
#include <complex.h> double complex csin(double complex z); float complex csinf(float complex z); long double complex csinl(long double complex z);
Description
The csin functions compute the complex sine of z.
Returns
The csin functions return the complex sine value.
7.3.5.6 The ctan functions
Synopsis
#include <complex.h> double complex ctan(double complex z); float complex ctanf(float complex z); long double complex ctanl(long double complex z);
Description
The ctan functions compute the complex tangent of z.
Returns
The ctan functions return the complex tangent value.
7.3.6 Hyperbolic functions
7.3.6.1 The cacosh functions
Synopsis
#include <complex.h> double complex cacosh(double complex z); float complex cacoshf(float complex z); long double complex cacoshl(long double complex z);
Description
The cacosh functions compute the complex arc hyperbolic cosine of z, with a branch cut at values less than along the real axis.
Returns
The cacosh functions return the complex arc hyperbolic cosine value, in the range of a half-strip of nonnegative values along the real axis and in the interval along the imaginary axis.
7.3.6.2 The casinh functions
Synopsis
#include <complex.h> double complex casinh(double complex z); float complex casinhf(float complex z); long double complex casinhl(long double complex z);
Description
The casinh functions compute the complex arc hyperbolic sine of z, with branch cuts outside the interval along the imaginary axis.
Returns
The casinh functions return the complex arc hyperbolic sine value, in the range of a strip mathematically unbounded along the real axis and in the interval
along the imaginary axis.
7.3.6.3 The catanh functions
Synopsis
#include <complex.h> double complex catanh(double complex z); float complex catanhf(float complex z); long double complex catanhl(long double complex z);
Description
The catanh functions compute the complex arc hyperbolic tangent of z, with branch cuts outside the interval along the real axis.
Returns
The catanh functions return the complex arc hyperbolic tangent value, in the range of a strip mathematically unbounded along the real axis and in the interval
along the imaginary axis.
Description
The ccosh functions compute the complex hyperbolic cosine of z.
Returns
The ccosh functions return the complex hyperbolic cosine value.
7.3.6.5 The csinh functions
Synopsis
#include <complex.h> double complex csinh(double complex z); float complex csinhf(float complex z); long double complex csinhl(long double complex z);
Description
The csinh functions compute the complex hyperbolic sine of z.
Returns
The csinh functions return the complex hyperbolic sine value.
7.3.6.6 The ctanh functions
Synopsis
#include <complex.h> double complex ctanh(double complex z); float complex ctanhf(float complex z); long double complex ctanhl(long double complex z);
Description
The ctanh functions compute the complex hyperbolic tangent of z.
Returns
The ctanh functions return the complex hyperbolic tangent value.
7.3.7 Exponential and logarithmic functions
7.3.7.1 The cexp functions
Synopsis
#include <complex.h> double complex cexp(double complex z); float complex cexpf(float complex z); long double complex cexpl(long double complex z);
Description
The cexp functions compute the complex base- exponential of z.
Returns
The cexp functions return the complex base- exponential value.
7.3.7.2 The clog functions
Synopsis
#include <complex.h> double complex clog(double complex z); float complex clogf(float complex z); long double complex clogl(long double complex z);
Description
The clog functions compute the complex natural (base-) logarithm of z, with a branch cut along the negative real axis.
Returns
The clog functions return the complex natural logarithm value, in the range of a strip mathematically unbounded along the real axis and in the interval along the imaginary axis.
7.3.8 Power and absolute-value functions
7.3.8.1 The cabs functions
Synopsis
#include <complex.h> double cabs(double complex z); float cabsf(float complex z); long double cabsl(long double complex z);
Description
The cabs functions compute the complex absolute value (also called norm, modulus, or magnitude) of z.
Returns
The cabs functions return the complex absolute value.
7.3.8.2 The cpow functions
Synopsis
#include <complex.h> double complex cpow(double complex x, double complex y); float complex cpowf(float complex x, float complex y); long double complex cpowl(long double complex x, long double complex y);
Description
The cpow functions compute the complex power function xy, with a branch cut for the first parameter along the negative real axis.
Returns
The cpow functions return the complex power function value.
7.3.8.3 The csqrt functions
Synopsis
#include <complex.h> double complex csqrt(double complex z); float complex csqrtf(float complex z); long double complex csqrtl(long double complex z);
Description
The csqrt functions compute the complex square root of z, with a branch cut along the negative real axis.
Returns
The csqrt functions return the complex square root value, in the range of the right half-plane (including the imaginary axis).
7.3.9 Manipulation functions
7.3.9.1 The carg functions
Synopsis
#include <complex.h> double carg(double complex z); float cargf(float complex z); long double cargl(long double complex z);
Description
The carg functions compute the argument (also called phase (which is an angle)) of z, with a branch cut along the negative real axis.
Returns
The carg functions return the value of the argument in the interval .
7.3.9.2 The cimag functions
Synopsis
#include <complex.h> double cimag(double complex z); float cimagf(float complex z); long double cimagl(long double complex z);
Description
Returns
The cimag functions return the value of the imaginary part (as a value of the corresponding real type).
7.3.9.3 The CMPLX macros
Synopsis
#include <complex.h> double complex CMPLX(double x, double y); float complex CMPLXF(float x, float y); long double complex CMPLXL(long double x, long double y);
Description
The CMPLX macros expand to an expression of the specified complex type, with the real part having the (converted) value of x and the imaginary part having the (converted) value of y. The resulting expression shall be suitable for use as an initializer for an object with static or thread storage duration, provided both arguments are likewise suitable. The resulting expression shall be an arithmetic constant expression, provided both arguments are arithmetic constant expressions.
Returns
The CMPLX macros return the complex value x y.
7.3.9.4 The conj functions
Synopsis
#include <complex.h> double complex conj(double complex z); float complex conjf(float complex z); long double complex conjl(long double complex z);
Description
The conj functions compute the complex conjugate of z, by arithmetically negating its imaginary part.
Returns
The conj functions return the complex conjugate value.
7.3.9.5 The cproj functions
Synopsis
#include <complex.h> double complex cproj(double complex z); float complex cprojf(float complex z); long double complex cprojl(long double complex z);
Description
The cproj functions map z to itself except where z has an infinite real or imaginary part (even if the other part is a NaN) in which case cproj(z) is equivalent to
CMPLX(INFINITY, copysign(0.0, cimag(z))
Returns
The cproj functions return the value of their argument unless that argument has an infinite part in which case they return a complex floating value with an infinite real part and a zero imaginary part.
7.3.9.6 The creal functions
Synopsis
#include <complex.h> double creal(double complex z); float crealf(float complex z); long double creall(long double complex z);
Description
Returns
The creal functions return the value of the real part (as a value of the corresponding real type).
7.4 Character handling <ctype.h>
7.4.1 General
The header <ctype.h> declares several functions useful for classifying and mapping characters.242)
In all cases the argument is an int, the value of which shall be representable as an unsigned char or shall equal the value of the macro EOF. If the argument has any other value, the behavior is undefined.
The behavior of these functions is affected by the current locale. Those functions that have localespecific aspects only when not in the "C" locale are noted subsequently in this subclause.
The term printing character refers to a member of a locale-specific set of characters, each of which occupies one printing position on a display device; the term control character refers to a member of a locale-specific set of characters that are not printing characters.243) All letters and digits are printing characters.
7.4.2 Character classification functions
7.4.2.1 General
The functions in this subclause return nonzero (true) if and only if the value of the argument c conforms to that in the description of the function.
7.4.2.2 The isalnum function
Synopsis
Description
The isalnum function tests for any character for which isalpha or isdigit is true.
7.4.2.3 The isalpha function
Synopsis
Description
The isalpha function tests for any character for which isupper or islower is true, or any character that is one of a locale-specific set of alphabetic characters for which none of iscntrl, isdigit, ispunct, or isspace is true.244) In the "C" locale, isalpha returns true only for the characters for which isupper or islower is true.
7.4.2.4 The isblank function
Synopsis
Description
The isblank function tests for any character that is a standard blank character or is one of a localespecific set of characters for which isspace is true and that is used to separate words within a line of text. The standard blank characters are the following: space (’ ’), and horizontal tab (’\t’). In the "C" locale, isblank returns true only for the standard blank characters.
7.4.2.5 The iscntrl function
Synopsis
Description
The iscntrl function tests for any control character.
7.4.2.6 The isdigit function
Synopsis
Description
7.4.2.7 The isgraph function
Synopsis
Description
The isgraph function tests for any printing character except space (’ ’).
7.4.2.8 The islower function
Synopsis
Description
The islower function tests for any character that is a lowercase letter or is one of a locale-specific set of characters for which none of iscntrl, isdigit, ispunct, or isspace is true. In the "C" locale, islower returns true only for the lowercase letters (as defined in 5.3.1).
7.4.2.9 The isprint function
Synopsis
Description
The isprint function tests for any printing character including space (’ ’).
7.4.2.10 The ispunct function
Synopsis
Description
The ispunct function tests for any printing character that is one of a locale-specific set of punctuation characters for which neither isspace nor isalnum is true. In the "C" locale, ispunct returns true for every printing character for which neither isspace nor isalnum is true.
7.4.2.11 The isspace function
Synopsis
Description
The isspace function tests for any character that is a standard white-space character or is one of a locale-specific set of characters for which isalnum is false. The standard white-space characters are the following: space (’ ’), form feed (’\f’), new-line (’\n’), carriage return (’\r’), horizontal tab (’\t’), and vertical tab (’\v’). In the "C" locale, isspace returns true only for the standard white-space characters.
7.4.2.12 The isupper function
Synopsis
Description
The isupper function tests for any character that is an uppercase letter or is one of a locale-specific set of characters for which none of iscntrl, isdigit, ispunct, or isspace is true. In the "C" locale, isupper returns true only for the uppercase letters (as defined in 5.3.1).
7.4.2.13 The isxdigit function
Synopsis
Description
7.4.3 Character case mapping functions
7.4.3.1 The tolower function
Synopsis
Description
The tolower function converts an uppercase letter to a corresponding lowercase letter.
Returns
If the argument is a character for which isupper is true and there are one or more corresponding characters, as specified by the current locale, for which islower is true, the tolower function returns one of the corresponding characters (always the same one for any given locale); otherwise, the argument is returned unchanged.
7.4.3.2 The toupper function
Synopsis
Description
The toupper function converts a lowercase letter to a corresponding uppercase letter.
Returns
If the argument is a character for which islower is true and there are one or more corresponding characters, as specified by the current locale, for which isupper is true, the toupper function returns one of the corresponding characters (always the same one for any given locale); otherwise, the argument is returned unchanged.
7.5 Errors <errno.h>
The header <errno.h> defines several macros, all relating to the reporting of error conditions.
The macros are
EDOM EILSEQ ERANGEwhich expand to integer constant expressions with type
int, distinct positive values, and which are suitable for use in conditional expression inclusion preprocessing directives; anderrnowhich expands to a modifiable lvalue245) that has type int and thread storage duration, the value of which is set to a positive error number by several library functions. If a macro definition is suppressed to access an actual object, or a program defines an identifier with the name errno, the behavior is undefined.
The value of errno in the initial thread is zero at program startup (the initial representation of the object designated by errno in other threads is indeterminate), but is never set to zero by any library function.246) The value of errno may be set to nonzero by a library function call whether or not there is an error, provided the use of errno is not documented in the description of the function in this document.
Additional macro definitions, beginning with E and a digit or E and an uppercase letter,247) may also be specified by the implementation.
7.6 Floating-point environment <fenv.h>
7.6.1 General
The header <fenv.h> defines several macros, and declares types and functions that provide access to the floating-point environment. The floating-point environment refers collectively to any floating-point status flags and control modes supported by the implementation.248)
A floating-point status flag is a system variable whose value is set (but never cleared) when a floatingpoint exception is raised, which occurs as a side effect of exceptional floating-point arithmetic to provide auxiliary information.249) A floating-point control mode is a system variable whose value may be set by the user to affect the subsequent behavior of floating-point arithmetic.
A floating-point control mode may be constant (7.6.3) or dynamic. The dynamic floating-point environment includes the dynamic floating-point control modes and the floating-point status flags.
The dynamic floating-point environment has thread storage duration. The initial state for a thread’s dynamic floating-point environment is the current state of the dynamic floating-point environment of the thread that creates it. It is initialized at the time of the thread’s creation.
Certain programming conventions support the intended model of use for the dynamic floating-point environment:250)
- a function call does not alter its caller’s floating-point control modes, clear its caller’s floatingpoint status flags, nor depend on the state of its caller’s floating-point status flags unless the function is so documented;
- a function call is assumed to require default floating-point control modes, unless its documentation promises otherwise;
- a function call is assumed to have the potential for raising floating-point exceptions, unless its documentation promises otherwise.
The feature test macro __STDC_VERSION_FENV_H__ expands to the token 202311L.
The type
femode_trepresents the collection of dynamic floating-point control modes supported by the implementation, including the dynamic rounding direction mode.
The type
fexcept_trepresents the floating-point status flags collectively, including any status the implementation associates with the flags.
Each of the macros
FE_DIVBYZERO FE_INEXACT FE_INVALID FE_OVERFLOW FE_UNDERFLOW
Decimal floating-point operations and ISO/IEC 60559 binary floating-point operations (Annex F) access the same floating-point exception status flags.
The macro
FE_DFL_MODErepresents the default state for the collection of dynamic floating-point control modes supported by the implementation – and has type "pointer to const-qualified femode_t". Additional implementation-defined states for the dynamic mode collection, with macro definitions beginning with FE_ and an uppercase letter, and having type "pointer to const-qualified femode_t", may also be specified by the implementation.
The macro
FE_ALL_EXCEPTis the bitwise OR of all floating-point exception macros defined by the implementation. If no such macros are defined, FE_ALL_EXCEPT shall be defined as 0.
Each of the macros
FE_DOWNWARD FE_TONEAREST FE_TONEARESTFROMZERO FE_TOWARDZERO FE_UPWARD
is defined if and only if the implementation supports getting and setting the represented rounding direction by means of the fegetround and fesetround functions. The defined macros expand to integer constant expressions whose values are distinct nonnegative values. Additional implementation-defined rounding directions, with macro definitions beginning with FE_ and an uppercase letter,254) may also be specified by the implementation.255)
If the implementation supports decimal floating types, each of the macros
FE_DEC_DOWNWARD FE_DEC_TONEAREST FE_DEC_TONEARESTFROMZERO FE_DEC_TOWARDZERO FE_DEC_UPWARD
During translation, constant rounding direction modes for decimal floating-point arithmetic are in effect where specified. Elsewhere, during translation the decimal rounding direction mode is FE_DEC_TONEAREST.
At program startup the dynamic rounding direction mode for decimal floating-point arithmetic is initialized to FE_DEC_TONEAREST.
The macro
FE_DFL_ENVrepresents the default dynamic floating-point environment — the one installed at program startup — and has type "pointer to const-qualified fenv_t". It can be used as an argument to <fenv.h> functions that manage the dynamic floating-point environment.
Additional implementation-defined environments, with macro definitions beginning with FE_ and an uppercase letter,256) and having type "pointer to const-qualified fenv_t", may also be specified by the implementation.
7.6.2 The FENV_ACCESS pragma
Synopsis
#include <fenv.h> #pragma STDC FENV_ACCESS on-off-switch
Description
The FENV_ACCESS pragma provides a means to inform the implementation when a program can access the floating-point environment to test floating-point status flags or run under non-default floating-point control modes.257) The pragma shall occur either outside external declarations or preceding all explicit declarations and statements inside a compound statement. When outside external declarations, the pragma takes effect from its occurrence until another FENV_ACCESS pragma is encountered, or until the end of the translation unit. When inside a compound statement, the pragma takes effect from its occurrence until another FENV_ACCESS pragma is encountered (including within a nested compound statement), or until the end of the compound statement. At the end of a compound statement, the state for the pragma is restored to its condition just before the compound statement. If this pragma is used in any other context, the behavior is undefined. If part of a program tests floating-point status flags or establishes or is executed with non-default floating-point mode settings using any means other than the FENV_ROUND pragmas, but was translated with the state for the FENV_ACCESS pragma "off", the behavior is undefined. The default state ("on" or "off") for the pragma is implementation-defined. (When execution passes from a part of the program translated with FENV_ACCESS "off" to a part translated with FENV_ACCESS "on", the state of the floating-point status flags is unspecified and the floating-point control modes have their default settings.)
EXAMPLE
#include <fenv.h> void f(double x) { #pragma STDC FENV_ACCESS ON void g(double); void h(double); /* ... */ g(x + 1); h(x + 1); /* ... */ }
If the function g can depend on status flags set as a side effect of the first x + 1, or if the second x + 1 can depend on control modes set as a side effect of the call to function g, then the program has to contain an appropriately placed invocation of #pragma STDC FENV_ACCESS ON as shown.258)
7.6.3 The FENV_ROUND pragma
Synopsis
#include <fenv.h> #pragma STDC FENV_ROUND direction #pragma STDC FENV_ROUND FE_DYNAMIC
Description
The FENV_ROUND pragma provides a means to specify a constant rounding direction for floating-point operations for standard floating types within a translation unit or compound statement. The pragma shall occur either outside external declarations or before all explicit declarations and statements inside a compound statement. When outside external declarations, the pragma takes effect from its occurrence until another FENV_ROUND pragma is encountered, or until the end of the translation unit. When inside a compound statement, the pragma takes effect from its occurrence until another FENV_ROUND pragma is encountered (including within a nested compound statement), or until the end of the compound statement; at the end of a compound statement the static rounding mode is restored to its condition just before the compound statement. If this pragma is used in any other context, its behavior is undefined.
direction shall be: one of the names of the supported rounding direction macros for operations for standard floating types (7.6), to specify a constant rounding mode; or, FE_DYNAMIC, to specify dynamic rounding. If any other value is specified, the behavior is undefined. If no FENV_ROUND pragma is in effect, or the specified direction is FE_DYNAMIC, rounding is according to the mode specified by the dynamic floating-point environment, which is the dynamic rounding mode that was established either at thread creation or by a call to fesetround, fesetmode, fesetenv, or feupdateenv. If the direction FE_DYNAMIC is specified and FENV_ACCESS is "off", the translator may assume that the default rounding mode is in effect.
The FENV_ROUND pragma affects operations for standard floating types. Within the scope of an FENV_ROUND pragma establishing a constant rounding mode, floating-point operators, implicit conversions (including the conversion of a value represented in a format wider than its semantic types to its semantic type, as done by classification macros), and invocations of functions indicated in Table 7.1, for which macro replacement has not been suppressed (7.1.4), shall be evaluated according to the specified constant rounding mode (as though no constant mode was specified and the corresponding dynamic rounding mode had been established by a call to fesetround). Invocations of functions for which macro replacement has been suppressed and invocations of functions other than those indicated in Table 7.1 shall not be affected by constant rounding modes – they are affected by (and affect) only the dynamic mode. Floating constants (6.4.5.3) of a standard floating type that occur in the scope of a constant rounding mode shall be interpreted according to that mode.
Table 7.1 — Functions affected by constant rounding modes – for standard floating types
NOTE Constant rounding modes can be implemented using dynamic rounding modes as illustrated in the following example, except that this method does not interpret inexact floating literals according to the constant rounding mode as required.
#pragma STDC FENV_ROUND direction // compiler inserts: // #pragma STDC FENV_ACCESS ON // int __savedrnd; // __savedrnd = __swapround(direction); ... operations affected by constant rounding mode ... // compiler inserts: // __savedrnd = __swapround(__savedrnd); ... operations not affected by constant rounding mode ... // compiler inserts: // __savedrnd = __swapround(__savedrnd); ... operations affected by constant rounding mode ... // compiler inserts: // __swapround(__savedrnd);where
__swapround is defined by:static inline int __swapround(const int new) { const int old = fegetround(); fesetround(new); return old; }
7.6.4 The FENV_DEC_ROUND pragma
Synopsis
#include <fenv.h> #ifdef __STDC_IEC_60559_DFP__ #pragma STDC FENV_DEC_ROUND dec-direction #endif
Description
The FENV_DEC_ROUND pragma is a decimal floating-point analog of the FENV_ROUND pragma. If FLT_RADIX is not , the FENV_DEC_ROUND pragma affects operators, functions, and floating literals only for decimal floating types. The affected functions are listed in Table 7.2. If FLT_RADIX is , whether the FENV_ROUND and FENV_DEC_ROUND pragmas alter the rounding direction of both standard and decimal floating-point operations is implementation-defined. dec-direction shall be one of the decimal rounding direction macro names (FE_DEC_DOWNWARD, FE_DEC_TONEAREST, FE_DEC_TONEARESTFROMZERO, FE_DEC_TOWARDZERO, and FE_DEC_UPWARD) defined in 7.6, to specify a constant rounding mode, or FE_DEC_DYNAMIC, to specify dynamic rounding. The corresponding dynamic rounding mode can be established by a call to fe_dec_setround.
Table 7.2 — Functions affected by constant rounding modes – for decimal floating types
Header Function families <math.h> acos, acospi, asin, asinpi, atan, atan2, atan2pi, atanpi <math.h> cos, cospi, sin, sinpi, tan, tanpi <math.h> acosh, asinh, atanh <math.h> cosh, sinh, tanh <math.h> exp, exp10, exp10m1, exp2, exp2m1, expm1 <math.h> log, log10, log10p1, log1p, log2, log2p1, logp1 <math.h> scalbn, scalbln, ldexp <math.h> cbrt, compoundn, hypot, pow, pown, powr, rootn, rsqrt, sqrt <math.h> erf, erfc <math.h> lgamma, tgamma <math.h> rint, nearbyint, lrint, llrint <math.h> quantize <math.h> fdim <math.h> fma <math.h> d32add, d64add, d32sub, d64sub, d32mul, d64mul, d32div, d64div, d32fma, d64fma, d32sqrt, d64sqrt <stdlib.h> strfrom, strto <wchar.h> wcsto <stdio.h> printf and scanf families <wchar.h> wprintf and wscanf families
A function family listed in Table 7.2 indicates the functions for all decimal floating types, where the function family is represented by the name of the functions without a suffix. For example, acos indicates the functions acosd32, acosd64, and acosd128.
7.6.5 Floating-point exceptions
7.6.5.1 General
The following functions provide access to the floating-point status flags.259) The int input argument for the functions represents a subset of floating-point exceptions, and can be zero or the bitwise OR of one or more floating-point exception macros, for example FE_OVERFLOW | FE_INEXACT. For other argument values, the behavior of these functions is undefined.
7.6.5.2 The feclearexcept function
Synopsis
#include <fenv.h> int feclearexcept(int excepts);
Description
The feclearexcept function attempts to clear the supported floating-point exceptions represented by its argument.
Returns
The feclearexcept function returns zero if the excepts argument is zero or if all the specified exceptions were successfully cleared. Otherwise, it returns a nonzero value.
7.6.5.3 The fegetexceptflag function
Synopsis
#include <fenv.h> int fegetexceptflag(fexcept_t *flagp, int excepts);
Description
The fegetexceptflag function attempts to store an implementation-defined representation of the states of the floating-point status flags indicated by the argument excepts in the object pointed to by the argument flagp.
Returns
The fegetexceptflag function returns zero if the representation was successfully stored. Otherwise, it returns a nonzero value.
7.6.5.4 The feraiseexcept function
Synopsis
#include <fenv.h> int feraiseexcept(int excepts);
Description
The feraiseexcept function attempts to raise the supported floating-point exceptions represented by its argument.260) The order in which these floating-point exceptions are raised is unspecified, except as stated in F.8.7. Whether the feraiseexcept function additionally raises the "inexact" floating-point exception whenever it raises the "overflow" or "underflow" floating-point exception is implementation-defined.
Returns
The feraiseexcept function returns zero if the excepts argument is zero or if all the specified exceptions were successfully raised. Otherwise, it returns a nonzero value.
Recommended practice
7.6.5.5 The fesetexcept function
Synopsis
#include <fenv.h> int fesetexcept(int excepts);
Description
The fesetexcept function attempts to set the supported floating-point exception flags represented by its argument. This function does not clear any floating-point exception flags. This function changes the state of the floating-point exception flags, but does not cause any other side effects that can be associated with raising floating-point exceptions.261)
Returns
The fesetexcept function returns zero if all the specified exceptions were successfully set or if the excepts argument is zero. Otherwise, it returns a nonzero value.
7.6.5.6 The fesetexceptflag function
Synopsis
#include <fenv.h> int fesetexceptflag(const fexcept_t *flagp, int excepts);
Description
The fesetexceptflag function attempts to set the floating-point status flags indicated by the argument excepts to the states stored in the object pointed to by flagp. The value of *flagp shall have been set by a previous call to fegetexceptflag whose second argument represented at least those floating-point exceptions represented by the argument excepts. Like fesetexcept, this function does not raise floating-point exceptions, but only sets the state of the flags.
Returns
The fesetexceptflag function returns zero if the excepts argument is zero or if all the specified flags were successfully set to the appropriate state. Otherwise, it returns a nonzero value.
7.6.5.7 The fetestexceptflag function
Synopsis
#include <fenv.h> int fetestexceptflag(const fexcept_t *flagp, int excepts);
Description
The fetestexceptflag function determines which of a specified subset of the floating-point exception flags are set in the object pointed to by flagp. The value of *flagp shall have been set by a previous call to fegetexceptflag whose second argument represented at least those floating-point exceptions represented by the argument excepts. The excepts argument specifies the floating-point status flags to be queried.
Returns
The fetestexceptflag function returns the value of the bitwise OR of the floating-point exception macros included in excepts corresponding to the floating-point exceptions set in *flagp.
7.6.5.8 The fetestexcept function
Synopsis
#include <fenv.h> int fetestexcept(int excepts);
Description
The fetestexcept function determines which of a specified subset of the floating-point exception flags are currently set. The excepts argument specifies the floating-point status flags to be queried.262)
Returns
The fetestexcept function returns the value of the bitwise OR of the floating-point exception macros corresponding to the currently set floating-point exceptions included in excepts.
EXAMPLE Call f if "invalid" is set, then g if "overflow" is set:
#include <fenv.h> /* ... */ { #pragma STDC FENV_ACCESS ON int set_excepts; feclearexcept(FE_INVALID | FE_OVERFLOW); // maybe raise exceptions set_excepts = fetestexcept(FE_INVALID | FE_OVERFLOW); if (set_excepts & FE_INVALID) f(); if (set_excepts & FE_OVERFLOW) g(); /* ... */ }
7.6.6 Rounding and other control modes
7.6.6.1 General
The fegetround and fesetround functions provide control of rounding direction modes. The fegetmode and fesetmode functions manage all the implementation’s dynamic floating-point control modes collectively.
7.6.6.2 The fegetmode function
Synopsis
Description
The fegetmode function attempts to store all the dynamic floating-point control modes in the object pointed to by modep.
Returns
The fegetmode function returns zero if the modes were successfully stored. Otherwise, it returns a nonzero value.
7.6.6.3 The fegetround function
Synopsis
#include <fenv.h> int fegetround(void);
Description
The fegetround function gets the current value of the dynamic rounding direction mode.
Returns
The fegetround function returns the value of the rounding direction macro representing the current dynamic rounding direction or a negative value if there is no such rounding direction macro or the current dynamic rounding direction is not determinable.
7.6.6.4 The fe_dec_getround function
Synopsis
#include <fenv.h> #ifdef __STDC_IEC_60559_DFP__ int fe_dec_getround(void); #endif
Description
The fe_dec_getround function gets the current value of the dynamic rounding direction mode for decimal floating-point operations.
Returns
The fe_dec_getround function returns the value of the rounding direction macro representing the current dynamic rounding direction for decimal floating-point operations, or a negative value if there is no such rounding macro or the current rounding direction is not determinable.
7.6.6.5 The fesetmode function
Synopsis
Description
The fesetmode function attempts to establish the dynamic floating-point modes represented by the object pointed to by modep. The argument modep shall point to an object set by a call to fegetmode, or equal FE_DFL_MODE or a dynamic floating-point mode state macro defined by the implementation.
Returns
7.6.6.6 The fesetround function
Synopsis
#include <fenv.h> int fesetround(int rnd);
Description
The fesetround function establishes the rounding direction represented by its argument rnd. If the argument is not equal to the value of a rounding direction macro, the rounding direction is not changed.
Returns
The fesetround function returns zero if and only if the dynamic rounding direction mode was set to the requested rounding direction.
EXAMPLE The following is a way to save, set, and restore the rounding direction, including reporting an error and abort if setting the rounding direction fails.
#include <fenv.h> #include <assert.h> void f(int rnd_dir) { #pragma STDC FENV_ACCESS ON int save_round; int setround_ok; save_round = fegetround(); setround_ok = fesetround(rnd_dir); assert(setround_ok == 0); /* ... */ fesetround(save_round); /* ... */ }
7.6.6.7 The fe_dec_setround function
Synopsis
#include <fenv.h> #ifdef __STDC_IEC_60559_DFP__ int fe_dec_setround(int rnd); #endif
Description
The fe_dec_setround function sets the dynamic rounding direction mode for decimal floatingpoint operations to be the rounding direction represented by its argument rnd. If the argument is not equal to the value of a decimal rounding direction macro, the rounding direction is not changed.
If FLT_RADIX is not , the rounding direction altered by the fesetround function is independent of the rounding direction altered by the fe_dec_setround function; otherwise if FLT_RADIX is , whether the fesetround and fe_dec_setround functions alter the rounding direction of both standard and decimal floating-point operations is implementation-defined.
Returns
The fe_dec_setround function returns a zero value if and only if the argument is equal to a decimal rounding direction macro (that is, if and only if the dynamic rounding direction mode for decimal floating-point operations was set to the requested rounding direction).
7.6.7 Environment
7.6.7.1 General
The functions in this subclause manage the floating-point environment — status flags and control modes — as one entity.
7.6.7.2 The fegetenv function
Synopsis
Description
The fegetenv function attempts to store the current dynamic floating-point environment in the object pointed to by envp.
Returns
The fegetenv function returns zero if the environment was successfully stored. Otherwise, it returns a nonzero value.
7.6.7.3 The feholdexcept function
Synopsis
#include <fenv.h> int feholdexcept(fenv_t *envp);
Description
The feholdexcept function saves the current dynamic floating-point environment in the object pointed to by envp, clears the floating-point status flags, and then installs a non-stop (continue on floating-point exceptions) mode, if available, for all floating-point exceptions.263)
Returns
The feholdexcept function returns zero if and only if non-stop floating-point exception handling was successfully installed.
7.6.7.4 The fesetenv function
Synopsis
Description
The fesetenv function attempts to establish the dynamic floating-point environment represented by the object pointed to by envp. The argument envp shall point to an object set by a call to fegetenv or feholdexcept, or equal a dynamic floating-point environment macro. fesetenv merely installs the state of the floating-point status flags represented through its argument, and does not raise these floating-point exceptions.
Returns
The fesetenv function returns zero if the environment was successfully established. Otherwise, it returns a nonzero value.
7.6.7.5 The feupdateenv function
Synopsis
#include <fenv.h> int feupdateenv(const fenv_t *envp);
Description
The feupdateenv function attempts to save the currently raised floating-point exceptions in its automatic storage, install the dynamic floating-point environment represented by the object pointed to by envp, and then raise the saved floating-point exceptions. The argument envp shall point to an object set by a call to feholdexcept or fegetenv, or equal a dynamic floating-point environment macro.
Returns
The feupdateenv function returns zero if all the actions were successfully carried out. Otherwise, it returns a nonzero value.
EXAMPLE Hide spurious underflow floating-point exceptions:
#include <fenv.h> double f(double x) { #pragma STDC FENV_ACCESS ON double result; fenv_t save_env; if (feholdexcept(&save_env)) return /* indication of an environmental problem */; // compute result if (/* test spurious underflow */) if (feclearexcept(FE_UNDERFLOW)) return /* indication of an environmental problem */; if (feupdateenv(&save_env)) return /* indication of an environmental problem */; return result; }
7.7 Characteristics of floating types <float.h>
The header <float.h> defines several macros that expand to various limits and parameters of the real floating types.
The macro
__STDC_VERSION_FLOAT_H__is an integer constant expression with a value equivalent to 202311L.
The rest of the macros, their meanings, and the constraints (or restrictions) on their values are listed in 5.3.5.3.3 and 5.3.5.3.4. A summary is given in Annex E.
7.8 Format conversion of integer types <inttypes.h>
7.8.1 General
The header <inttypes.h> includes the header <stdint.h> and extends it with additional facilities provided by hosted implementations.
It defines the macro
__STDC_VERSION_INTTYPES_H__which is an integer constant expression with a value equivalent to 202311L.
It declares functions for manipulating greatest-width integers and converting numeric character strings to greatest-width integers, and it declares the type
imaxdiv_twhich is a structure type that is the type of the value returned by the imaxdiv function. For each type declared in <stdint.h>, it defines corresponding macros for conversion specifiers for use with the formatted input/output functions.264)
<stdint.h> (7.23), formatted input/output functions (7.24.6), formatted wide character input/output functions (7.33.2).7.8.2 Macros for format specifiers
Each of the following object-like macros expands to an ordinary string literal containing a conversion specifier, possibly modified by a length modifier, suitable for use within the format argument of a formatted input/output function when converting the corresponding integer type. These macro names have the general form of PRI (ordinary string literals for the fprintf and fwprintf family) or SCN (ordinary string literals for the fscanf and fwscanf family),265) followed by the conversion specifier, followed by a name corresponding to a similar type name in 7.23.2. In these names, N represents the width of the type as described in 7.23.2. For example, PRIdFAST32 can be used in a format string to print the value of an integer of type int_fast32_t. The functions in the fprintf and fwprintf families shall behave as if they use va_arg with a type argument naming the type resulting from applying the default argument promotions to the type corresponding to the macro and then convert the result of the va_arg expansion to the type corresponding to the macro.
The fprintf macros for signed integers are:
PRIdN PRIdLEASTN PRIdFASTN PRIdMAX PRIdPTR PRIiN PRIiLEASTN PRIiFASTN PRIiMAX PRIiPTR
The fprintf macros for unsigned integers are:
PRIbN PRIbLEASTN PRIbFASTN PRIbMAX PRIbPTR PRIoN PRIoLEASTN PRIoFASTN PRIoMAX PRIoPTR PRIuN PRIuLEASTN PRIuFASTN PRIuMAX PRIuPTR PRIxN PRIxLEASTN PRIxFASTN PRIxMAX PRIxPTR PRIXN PRIXLEASTN PRIXFASTN PRIXMAX PRIXPTR
The following fprintf macros for unsigned integer types are optional:
PRIBN PRIBLEASTN PRIBFASTN PRIBMAX PRIBPTR
They shall be defined if the implementation supports the B specifier as indicated in 7.24.6.2 and 7.33.2.2; otherwise they shall not be defined.
The fscanf macros for signed integers are:
SCNdN SCNdLEASTN SCNdFASTN SCNdMAX SCNdPTR SCNiN SCNiLEASTN SCNiFASTN SCNiMAX SCNiPTR
The fscanf macros for unsigned integers are:
SCNbN SCNbLEASTN SCNbFASTN SCNbMAX SCNbPTR SCNoN SCNoLEASTN SCNoFASTN SCNoMAX SCNoPTR SCNuN SCNuLEASTN SCNuFASTN SCNuMAX SCNuPTR SCNxN SCNxLEASTN SCNxFASTN SCNxMAX SCNxPTR
For each type that the implementation provides in <stdint.h>, the corresponding fprintf macros shall be defined and the corresponding fscanf macros shall be defined unless the implementation does not have a suitable fscanf length modifier for the type.
EXAMPLE
#include <inttypes.h> #include <wchar.h> int main(void) { uintmax_t i = UINTMAX_MAX; // this type always exists wprintf(L"The largest integer value is %020" PRIxMAX "\n", i); return 0; }
7.8.3 Functions for greatest-width integer types
7.8.3.1 The imaxabs and umaxabs functions
Synopsis
Description
The imaxabs and umaxabs functions compute the absolute value of an integer j. If the result cannot be represented, the behavior is undefined.266)
Returns
The imaxabs and umaxabs functions return the absolute value.
7.8.3.2 The imaxdiv function
Synopsis
Description
The imaxdiv function computes numer / denom and numer %denom in a single operation.
Returns
The imaxdiv function returns a structure of type imaxdiv_t comprising both the quotient and the remainder. The structure shall contain (in either order) the members quot (the quotient) and rem (the remainder), each of which has type intmax_t. If either part of the result cannot be represented, the behavior is undefined.
7.8.3.3 The strtoimax and strtoumax functions
Synopsis
#include <inttypes.h> intmax_t strtoimax(const char * restrict nptr, char ** restrict endptr, int base); uintmax_t strtoumax(const char * restrict nptr, char ** restrict endptr, int base);
Description
The strtoimax and strtoumax functions are equivalent to the strtol, strtoll, strtoul, and strtoull functions, except that the initial portion of the string is converted to intmax_t and uintmax_t representation, respectively.
Returns
The strtoimax and strtoumax functions return the converted value, if any. If no conversion could be performed, zero is returned. If the correct value is outside the range of representable values, INTMAX_MAX, INTMAX_MIN, or UINTMAX_MAX is returned (according to the return type and sign of the value, if any), and the value of the macro ERANGE is stored in errno.
7.8.3.4 The wcstoimax and wcstoumax functions
Synopsis
#include <stddef.h> // for wchar_t #include <inttypes.h> intmax_t wcstoimax(const wchar_t *restrict nptr, wchar_t **restrict endptr, int base); uintmax_t wcstoumax(const wchar_t *restrict nptr, wchar_t **restrict endptr, int base);
Description
The wcstoimax and wcstoumax functions are equivalent to the wcstol, wcstoll, wcstoul, and wcstoull functions except that the initial portion of the wide string is converted to intmax_t and uintmax_t representation, respectively.
Returns
The wcstoimax function returns the converted value, if any. If no conversion could be performed, zero is returned. If the correct value is outside the range of representable values, INTMAX_MAX, INTMAX_MIN, or UINTMAX_MAX is returned (according to the return type and sign of the value, if any), and the value of the macro ERANGE is stored in errno.
7.9 Alternative spellings <iso646.h>
The header <iso646.h> defines the following eleven macros (on the left) that expand to the corresponding tokens (on the right):
and && and_eq &= bitand & bitor | compl ~ not ! not_eq != or || or_eq |= xor ^ xor_eq ^=
7.10 Characteristics of integer types <limits.h>
The header <limits.h> defines several macros that expand to various limits and parameters of the standard integer types.
The macro
__STDC_VERSION_LIMITS_H__is an integer constant expression with a value equivalent to 202311L.
The rest of the macros, their meanings, and the constraints (or restrictions) on their values are listed in 5.3.5.3.2. A summary is given in Annex E.
7.11 Localization <locale.h>
7.11.1 General
The header <locale.h> declares two functions, one type, and defines several macros.
The type is
struct lconvwhich contains members related to the formatting of numeric values. The structure shall contain at least the following members, in any order. The semantics of the members and their normal ranges are explained in 7.11.3.1. In the
"C" locale, the members shall have the values specified in the comments.char *decimal_point; // "." char *thousands_sep; // "" char *grouping; // "" char *mon_decimal_point; // "" char *mon_thousands_sep; // "" char *mon_grouping; // "" char *positive_sign; // "" char *negative_sign; // "" char *currency_symbol; // "" char frac_digits; // CHAR_MAX char p_cs_precedes; // CHAR_MAX char n_cs_precedes; // CHAR_MAX char p_sep_by_space; // CHAR_MAX char n_sep_by_space; // CHAR_MAX char p_sign_posn; // CHAR_MAX char n_sign_posn; // CHAR_MAX char *int_curr_symbol; // "" char int_frac_digits; // CHAR_MAX char int_p_cs_precedes; // CHAR_MAX char int_n_cs_precedes; // CHAR_MAX char int_p_sep_by_space; // CHAR_MAX char int_n_sep_by_space; // CHAR_MAX char int_p_sign_posn; // CHAR_MAX char int_n_sign_posn; // CHAR_MAX
The macros defined are NULL (described in 7.22); and
LC_ALL LC_COLLATE LC_CTYPE LC_MONETARY LC_NUMERIC LC_TIME
which expand to integer constant expressions with distinct values, suitable for use as the first argument to the setlocale function.267) Additional macro definitions, beginning with the characters LC_ and an uppercase letter,268) may also be specified by the implementation.
7.11.2 The setlocale function
Synopsis
Description
The setlocale function selects the appropriate portion of the program’s locale as specified by the category and locale arguments. The setlocale function may be used to change or query the program’s entire current locale or portions thereof. The value LC_ALL for category names the program’s entire locale; the other values for category name only a portion of the program’s locale. LC_COLLATE affects the behavior of the strcoll and strxfrm functions. LC_CTYPE affects the behavior of the character handling functions269) and the multibyte and wide character functions. LC_MONETARY affects the monetary formatting information returned by the localeconv function. LC_NUMERIC affects the decimal-point character for the formatted input/output functions and the string conversion functions, as well as the nonmonetary formatting information returned by the localeconv function. LC_TIME affects the behavior of the strftime and wcsftime functions.
A value of "C" for locale specifies the minimal environment for C translation; a value of "" for locale specifies the locale-specific native environment. Other implementation-defined strings may be passed as the second argument to setlocale.
A call to the setlocale function may introduce a data race with other calls to the setlocale function or with calls to functions that are affected by the current locale. The implementation shall behave as if no library function calls the setlocale function.
Returns
If a pointer to a string is given for locale and the selection can be honored, the setlocale function returns a pointer to the string associated with the specified category for the new locale. If the selection cannot be honored, the setlocale function returns a null pointer and the program’s locale is not changed.
A null pointer for locale causes the setlocale function to return a pointer to the string associated with the category for the program’s current locale; the program’s locale is not changed.270)
The pointer to string returned by the setlocale function is such that a subsequent call with that string value and its associated category will restore that part of the program’s locale. The string pointed to shall not be modified by the program. The behavior is undefined if the returned value is used after a subsequent call to the setlocale function, or after the thread which called the setlocale function to obtain the returned value has exited.
strcoll function (7.28.4.4), the strftime function (7.31.3.6), the strxfrm function (7.28.4.6).7.11.3 Numeric formatting convention inquiry
7.11.3.1 The localeconv function
Synopsis
#include <locale.h> struct lconv *localeconv(void);
Description
The localeconv function sets the components of an object with type struct lconv with values appropriate for the formatting of numeric quantities (monetary and otherwise) according to the
The members of the structure with type char * are pointers to strings, any of which (except decimal_point) can point to "", to indicate that the value is not available in the current locale or is of zero length. Apart from grouping and mon_grouping, the strings shall start and end in the initial shift state. The members with type char are nonnegative numbers, any of which can be CHAR_MAX to indicate that the value is not available in the current locale. The members include the following:
char *decimal_point
The decimal-point character used to format nonmonetary quantities.
char *thousands_sep
The character used to separate groups of digits before the decimal-point character in formatted nonmonetary quantities.
char *grouping
A string whose elements indicate the size of each group of digits in formatted nonmonetary quantities.
char *mon_decimal_point
The decimal-point used to format monetary quantities.
char *mon_thousands_sep
The separator for groups of digits before the decimal-point in formatted monetary quantities.
char *mon_grouping
A string whose elements indicate the size of each group of digits in formatted monetary quantities.
char *positive_sign
The string used to indicate a nonnegative-valued formatted monetary quantity.
char *negative_sign
The string used to indicate a negative-valued formatted monetary quantity.
char *currency_symbol
The local currency symbol applicable to the current locale.
char frac_digits
The number of fractional digits (those after the decimal-point) to be displayed in a locally formatted monetary quantity.
char p_cs_precedes
Set to 1 or 0 if the currency_symbol respectively precedes or succeeds the value for a nonnegative locally formatted monetary quantity.
char n_cs_precedes
Set to 1 or 0 if the currency_symbol respectively precedes or succeeds the value for a negative locally formatted monetary quantity.
char p_sep_by_space
Set to a value indicating the separation of the currency_symbol, the sign string, and the value for a nonnegative locally formatted monetary quantity.
char n_sep_by_space
Set to a value indicating the separation of the currency_symbol, the sign string, and the value for a negative locally formatted monetary quantity.
The elements of grouping and mon_grouping are interpreted according to the following:
CHAR_MAX No further grouping is to be performed.
0 The previous element is to be repeatedly used for the remainder of the digits.
other The integer value is the number of digits that compose the current group. The next element is examined to determine the size of the next group of digits before the current group.
The values of p_sep_by_space, n_sep_by_space, int_p_sep_by_space, and int_n_sep_by_space are interpreted according to the following:
0 No space separates the currency symbol and value.
The values of p_sign_posn, n_sign_posn, int_p_sign_posn, and int_n_sign_posn are interpreted according to the following:
0 Parentheses surround the quantity and currency symbol.
1 The sign string precedes the quantity and currency symbol.
2 The sign string succeeds the quantity and currency symbol.
3 The sign string immediately precedes the currency symbol.
4 The sign string immediately succeeds the currency symbol.
The implementation shall behave as if no library function calls the localeconv function.
Returns
The localeconv function returns a pointer to the filled-in object. The structure pointed to by the return value shall not be modified by the program, but may be overwritten by a subsequent call to the localeconv function. In addition, calls to the setlocale function with categories LC_ALL, LC_MONETARY, or LC_NUMERIC may overwrite the contents of the structure.
EXAMPLE 1 Table 7.3 illustrates rules which can be used by four countries to format — potentially irrelevant, imaginary, and/or historical — monetary quantities.
Table 7.3 — Formatting rule examples
Local format International format Country Positive Negative Positive Negative Country1 1.234,56 mk -1.234,56 mk FIM 1.234,56 FIM -1.234,56 Country2 L.1.234 -L.1.234 ITL 1.234 -ITL 1.234 Country3 f 1.234,56 f -1.234,56 NLG 1.234,56 NLG -1.234,56 Country4 SFrs.1,234.56 SFrs.1,234.56C CHF 1,234.56 CHF 1,234.56C
EXAMPLE 2 Table 7.5 illustrates how the cs_precedes, sep_by_space, and sign_posn members affect the formatted value.
Table 7.5 — Select member formatting affect
p_sep_by_space p_cs_precedes p_sign_posn 0 1 2 0 0 (1.25$) (1.25 $) (1.25$) 1 +1.25$ +1.25 $ + 1.25$ 2 1.25$+ 1.25 $+ 1.25$ + 3 1.25+$ 1.25 +$ 1.25+ $ 4 1.25$+ 1.25 $+ 1.25$ + 1 0 ($1.25) ($ 1.25) ($1.25) 1 +$1.25 +$ 1.25 + $1.25 2 $1.25+ $ 1.25+ $1.25 + 3 +$1.25 +$ 1.25 + $1.25 4 $+1.25 $+ 1.25 $ +1.25
7.12 Mathematics <math.h>
7.12.1 General
The header <math.h> declares two types and many mathematical functions and defines several macros. Most synopses specify a family of functions consisting of a principal function with one or more double parameters, a double return value, or both; and other functions with the same name but with f and l suffixes, which are corresponding functions with float and long double parameters, return values, or both.271) Integer arithmetic functions and conversion functions are discussed later.
The feature test macro __STDC_VERSION_MATH_H__ expands to the token 202311L.
The types
float_t double_t
are floating types such that the values of float and double are subsets of the values of float_t and double_t, respectively, and such that the values of float_t are a subset of the values of double_t. If FLT_EVAL_METHOD equals 0, float_t and double_t are float and double, respectively; if FLT_EVAL_METHOD equals 1, they are both double; if FLT_EVAL_METHOD equals 2, they are both long double; and for other values of FLT_EVAL_METHOD, they are otherwise implementationdefined.272) If they are not real floating types, the behavior is implementation-defined.
The types
_Decimal32_t _Decimal64_t
are decimal floating types at least as wide as _Decimal32 and _Decimal64, respectively, and such that _Decimal64_t is at least as wide as _Decimal32_t. They are present only if the implementation defines __STDC_IEC_60559_DFP__. If DEC_EVAL_METHOD equals , _Decimal32_t and _Decimal64_t are _Decimal32 and _Decimal64, respectively; if DEC_EVAL_METHOD equals , they are both _Decimal64; if DEC_EVAL_METHOD equals , they are both _Decimal128; and for other values of DEC_EVAL_METHOD, they are otherwise implementation-defined.
The macro
HUGE_VALexpands to a double arithmetic constant expression, not necessarily representable as a float, whose value is the maximum value returned by library functions when a floating result of type double overflows under the default rounding mode, either maximum finite number in the type or positive or unsigned infinity. The macrosHUGE_VALF HUGE_VALL
are respectively float and long double analogs of HUGE_VAL.273)
The macros in this paragraph are only present if the implementation defines __STDC_IEC_60559_DFP__.
The macro
HUGE_VAL_D32 HUGE_VAL_D64 HUGE_VAL_D128
The macro
INFINITYis defined if and only if the implementation supports an infinity for the type float. It expands to an arithmetic constant expression of type float representing positive or unsigned infinity.
The macro
DEC_INFINITYexpands to an arithmetic constant expression of type _Decimal32 representing positive infinity.
The macro
NANis defined if and only if the implementation supports quiet NaNs for the float type. It expands to an arithmetic constant expression of type float representing a quiet NaN.
The macro
DEC_NANexpands to an arithmetic constant expression of type _Decimal32 representing a quiet NaN.
Use of the macros INFINITY, DEC_INFINITY, NAN, and DEC_NAN in <math.h> is an obsolescent feature. Instead, use the same macros in <float.h>.
The number classification macros
FP_INFINITE FP_NAN FP_NORMAL FP_SUBNORMAL FP_ZERO
represent mutually exclusive kinds of floating-point values. They expand to integer constant expressions with distinct values. Additional implementation-defined floating-point classifications, with macro definitions beginning with FP_ and an uppercase letter, may also be specified by the implementation.
The math rounding direction macros
FP_INT_UPWARD FP_INT_DOWNWARD FP_INT_TOWARDZERO FP_INT_TONEARESTFROMZERO FP_INT_TONEAREST
represent the rounding directions of the functions ceil, floor, trunc, round, and roundeven, respectively, that convert to integral values in floating-point formats. They expand to integer constant expressions with distinct values suitable for use as the second argument to the fromfp, ufromfp, fromfpx, and ufromfpx functions.
The macro
FP_FAST_FMA FP_FAST_FMAF FP_FAST_FMAL
The macros
FP_FAST_FMAD32 FP_FAST_FMAD64 FP_FAST_FMAD128
are, respectively, _Decimal32, _Decimal64, and _Decimal128 analogs of FP_FAST_FMA.
Each of the macros
FP_FAST_FADD FP_FAST_FADDL FP_FAST_DADDL FP_FAST_FSUB FP_FAST_FSUBL
FP_FAST_DSUBL FP_FAST_FMUL FP_FAST_FMULL FP_FAST_DMULL FP_FAST_FDIV
FP_FAST_FDIVL FP_FAST_DDIVL FP_FAST_FSQRT FP_FAST_FSQRTL FP_FAST_DSQRTL
FP_FAST_FFMA FP_FAST_FFMAL FP_FAST_DFMAL
is optionally defined. If defined, it indicates that the corresponding function generally executes about as fast, or faster, than the corresponding operation or function of the argument type with result type the same as the argument type followed by conversion to the narrower type. For FP_FAST_FFMA, FP_FAST_FFMAL, and FP_FAST_DFMAL, the comparison is to a call to fma or fmal followed by a conversion, not to separate multiply, add, and conversion. If defined, these macros expand to the integer literal 1.
The macros
FP_FAST_D32ADDD64 FP_FAST_D32ADDD128 FP_FAST_D64ADDD128 FP_FAST_D32SUBD64 FP_FAST_D32SUBD128 FP_FAST_D64SUBD128
FP_FAST_D32MULD64 FP_FAST_D32MULD128 FP_FAST_D64MULD128 FP_FAST_D32DIVD64 FP_FAST_D32DIVD128 FP_FAST_D64DIVD128
FP_FAST_D32FMAD64 FP_FAST_D32FMAD128 FP_FAST_D64FMAD128 FP_FAST_D32SQRTD64 FP_FAST_D32SQRTD128 FP_FAST_D64SQRTD128
are analogs of FP_FAST_FADD, FP_FAST_FADDL, FP_FAST_DADDL, etc., for decimal floating types.
The macros
FP_ILOGB0 FP_ILOGBNAN
expand to integer constant expressions whose values are returned by ilogb(x) if x is zero or NaN, respectively. The value of FP_ILOGB0 shall be either INT_MIN or -INT_MAX. The value of FP_ILOGBNAN shall be either INT_MAX or INT_MIN.
The macros
FP_LLOGB0 FP_LLOGBNAN
The macros
MATH_ERRNO MATH_ERREXCEPTexpand to the integer literals
1 and 2, respectively; the macromath_errhandlingexpands to an expression that has type int and the value MATH_ERRNO, MATH_ERREXCEPT, the bitwise OR of both, or ; the value shall not be in a hosted implementation. The value of math_errhandling is constant for the duration of the program. It is unspecified whether math_errhandling is a macro or an identifier with external linkage. If a macro definition is suppressed or a program defines an identifier with the name math_errhandling, the behavior is undefined. If the expression math_errhandling & MATH_ERREXCEPT can be nonzero, the implementation shall define the macros FE_DIVBYZERO, FE_INVALID, and FE_OVERFLOW in <fenv.h>.
7.12.2 Treatment of error conditions
The behavior of each of the functions in <math.h> is specified for all representable values of its input arguments, except where explicitly stated otherwise. Each function shall execute as if it were a single operation without raising SIGFPE and without generating any of the floating-point exceptions "invalid", "divide-by-zero", or "overflow" except to reflect the result of the function.
An error is said to occur when the underlying exceptional computational condition arises and the error is reported using the mechanisms described in this subclause. Not all exceptional conditions are required to be reported as errors.
For all functions, a domain error can occur if and only if an input argument is outside the domain over which the mathematical function is defined. The description of each function lists any required domain errors; an implementation may define additional domain errors, provided that such errors are consistent with the mathematical definition of the function.275) Whether a signaling NaN input causes a domain error is implementation-defined. On a domain error, the function returns an implementation-defined value; if the integer expression math_errhandling & MATH_ERRNO is nonzero, the integer expression errno acquires the value EDOM; if the integer expression math_errhandling & MATH_ERREXCEPT is nonzero, the "invalid" floating-point exception is raised.
Similarly, a pole error can occur in cases where the arguments are finite and where the mathematical function typically has an infinite limit (for example, a pole error occurs at log(0.0) because the mathematical function has a right-hand limit of at 0). The description of each function lists any required pole errors; an implementation may define additional pole errors, provided that such errors are consistent with the mathematical definition of the function. On a pole error, the function returns an implementation-defined value; if the integer expression math_errhandling & MATH_ERRNO is nonzero, the integer expression errno acquires the value ERANGE; if the integer expression math_errhandling & MATH_ERREXCEPT is nonzero, the "divide-by-zero" floating-point exception is raised.
Likewise, a range error can occur if and only if the result overflows or underflows, as defined below. Also, a range error may occur if the function result has integer type and the result is outside the range of the type; however, the occurrence of a range error in such cases is an obsolescent feature. The description of each function lists any required range errors; an implementation may define additional range errors, provided that such errors are consistent with the mathematical definition of the function and are the result of either overflow or underflow. Range errors that are required or implementation-defined shall or may be reported, as specified in this subclause, respectively.
A floating result overflows if a finite result value with ordinary accuracy276) would have magnitude (absolute value) too large for the representation with full precision in the specified type. A result that is exactly an infinity does not overflow. If a floating result overflows and default rounding is in effect, then the function returns the value of the macro HUGE_VAL suffixed according to the return type, with the same sign as the correct value of the function; however, for the types with reduced-precision representations of numbers beyond the overflow threshold, the function may return a representation of the result with less than full precision for the type. If a floating result overflows and default rounding is in effect and the integer expression math_errhandling & MATH_ERRNO is nonzero, then the integer expression errno acquires the value ERANGE. If a floating result overflows, and the integer expression math_errhandling & MATH_ERREXCEPT is nonzero, the "overflow" floatingpoint exception is raised (regardless of whether default rounding is in effect).
The result underflows if a nonzero result value with ordinary accuracy would have magnitude (absolute value) less than the minimum normalized number in the type; however a zero result that is specified to be an exact zero does not underflow. Also, a result with ordinary accuracy and the magnitude of the minimum normalized number may underflow.277) If the result underflows, the function returns an implementation-defined value whose magnitude is no greater than the smallest normalized positive number in the specified type; if the integer expression math_errhandling & MATH_ERRNO is nonzero, whether errno acquires the value ERANGE is implementation-defined; if the integer expression math_errhandling & MATH_ERREXCEPT is nonzero, whether the "underflow" floating-point exception is raised is implementation-defined.
If a domain, pole, or range error occurs and the integer expression math_errhandling & MATH_ERRNO is zero,278) then errno shall either be set to the value corresponding to the error or left unmodified. If no such error occurs, errno shall be left unmodified regardless of the setting of math_errhandling.
7.12.3 The FP_CONTRACT pragma
Synopsis
#include <math.h> #pragma STDC FP_CONTRACT on-off-switch
Description
The FP_CONTRACT pragma can be used to allow (if the state is "on") or disallow (if the state is "off") the implementation to contract expressions (6.5.1). Each pragma can occur either outside external declarations or preceding all explicit declarations and statements inside a compound statement. When outside external declarations, the pragma takes effect from its occurrence until another FP_CONTRACT pragma is encountered, or until the end of the translation unit. When inside a compound statement, the pragma takes effect from its occurrence until another FP_CONTRACT pragma is encountered (including within a nested compound statement), or until the end of the compound statement; at the end of a compound statement the state for the pragma is restored to its condition just before the compound statement. If this pragma is used in any other context, the behavior is undefined. The default state ("on" or "off") for the pragma is implementation-defined.
7.12.4 Classification macros
7.12.4.1 General
Floating-point values can be classified as NaN, infinite, normal, subnormal, or zero, or into other implementation-defined categories. Numbers whose magnitude is at least (the minimum magnitude of normalized floating-point numbers in the type) and at most (the maximum magnitude of normalized floating-point numbers in the type), where , , , and are as in 5.3.5.3.3, are classified as normal. Larger magnitude finite numbers represented with full precision in the type may also be classified as normal. Nonzero numbers whose magnitude is less than are classified as subnormal.
In the synopses in this subclause, real-floating indicates that the argument shall be an expression of real floating type.
7.12.4.2 The fpclassify macro
Synopsis
#include <math.h> int fpclassify(real-floatingx);
Description
The fpclassify macro classifies its argument value as NaN, infinite, normal, subnormal, zero, or into another implementation-defined category. First, an argument represented in a format wider than its semantic type is converted to its semantic type. Then classification is based on the type of the argument.279)
Returns
The fpclassify macro returns the value of the number classification macro appropriate to the value of its argument.
7.12.4.3 The iscanonical macro
Synopsis
#include <math.h> int iscanonical(real-floatingx);
Description
The iscanonical macro determines whether its argument value is canonical (5.3.5.3.3). First, an argument represented in a format wider than its semantic type is converted to its semantic type. Then, determination is based on the type of the argument.
Returns
The iscanonical macro returns a nonzero value if and only if its argument is canonical.
7.12.4.4 The isfinite macro
Synopsis
#include <math.h> int isfinite(real-floatingx);
Description
The isfinite macro determines whether its argument has a finite value (zero, subnormal, or normal, and not infinite or NaN). First, an argument represented in a format wider than its semantic type is converted to its semantic type. Then determination is based on the type of the argument.
Returns
The isfinite macro returns a nonzero value if and only if its argument has a finite value.
7.12.4.5 The isinf macro
Synopsis
#include <math.h> int isinf(real-floatingx);
Description
The isinf macro determines whether its argument value is (positive or negative) infinity. First, an argument represented in a format wider than its semantic type is converted to its semantic type. Then determination is based on the type of the argument.
Returns
The isinf macro returns a nonzero value if and only if its argument has an infinite value.
7.12.4.6 The isnan macro
Synopsis
#include <math.h> int isnan(real-floatingx);
Description
The isnan macro determines whether its argument value is a NaN. First, an argument represented in a format wider than its semantic type is converted to its semantic type. Then determination is based on the type of the argument.280)
Returns
The isnan macro returns a nonzero value if and only if its argument has a NaN value.
7.12.4.7 The isnormal macro
Synopsis
#include <math.h> int isnormal(real-floatingx);
Description
The isnormal macro determines whether its argument value is normal (neither zero, subnormal, infinite, nor NaN). First, an argument represented in a format wider than its semantic type is converted to its semantic type. Then determination is based on the type of the argument.
Returns
The isnormal macro returns a nonzero value if and only if its argument has a normal value.
7.12.4.8 The signbit macro
Synopsis
#include <math.h> int signbit(real-floatingx);
Description
The signbit macro determines whether the sign of its argument value is negative.281) If the argument value is an unsigned zero, its sign is regarded as positive. Otherwise, if the argument value is unsigned, the result value (zero or nonzero) is implementation-defined.
Returns
The signbit macro returns a nonzero value if and only if the sign of its argument value is determined to be negative.
7.12.4.9 The issignaling macro
Synopsis
#include <math.h> int issignaling(real-floatingx);
Description
The issignaling macro determines whether its argument value is a signaling NaN.
Returns
7.12.4.10 The issubnormal macro
Synopsis
#include <math.h> int issubnormal(real-floatingx);
Description
The issubnormal macro determines whether its argument value is subnormal. First, an argument represented in a format wider than its semantic type is converted to its semantic type. Then determination is based on the type of the argument.
Returns
The issubnormal macro returns a nonzero value if and only if its argument is subnormal.
7.12.4.11 The iszero macro
Synopsis
#include <math.h> int iszero(real-floatingx);
Description
The iszero macro determines whether its argument value is (positive, negative, or unsigned) zero. First, an argument represented in a format wider than its semantic type is converted to its semantic type. Then, determination is based on the type of the argument.
Returns
The iszero macro returns a nonzero value if and only if its argument is zero.
7.12.5 Trigonometric functions
7.12.5.1 The acos functions
Synopsis
#include <math.h> double acos(double x); float acosf(float x); long double acosl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 acosd32(_Decimal32 x); _Decimal64 acosd64(_Decimal64 x); _Decimal128 acosd128(_Decimal128 x); #endif
Description
The acos functions compute the principal value of the arc cosine of x. A domain error occurs for arguments not in the interval .
Returns
The acos functions return x in the interval radians.
7.12.5.2 The asin functions
Synopsis
#include <math.h> double asin(double x); float asinf(float x); long double asinl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 asind32(_Decimal32 x); _Decimal64 asind64(_Decimal64 x); _Decimal128 asind128(_Decimal128 x); #endif
Description
The asin functions compute the principal value of the arc sine of x. A domain error occurs for arguments not in the interval . A range error occurs if nonzero x is too close to zero.
Returns
Returns
7.12.5.4 The atan2 functions
Synopsis
#include <math.h> double atan2(double y, double x); float atan2f(float y, float x); long double atan2l(long double y, long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 atan2d32(_Decimal32 y, _Decimal32 x); _Decimal64 atan2d64(_Decimal64 y, _Decimal64 x); _Decimal128 atan2d128(_Decimal128 y, _Decimal128 x); #endif
Description
The atan2 functions compute the value of the arc tangent of yx, using the signs of both arguments to determine the quadrant of the return value. A domain error may occur if both arguments are zero. A range error occurs if x is positive and nonzero y
x is too close to zero.
Returns
The atan2 functions return yx) in the interval radians.
7.12.5.5 The cos functions
Synopsis
#include <math.h> double cos(double x); float cosf(float x); long double cosl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 cosd32(_Decimal32 x); _Decimal64 cosd64(_Decimal64 x); _Decimal128 cosd128(_Decimal128 x); #endif
Description
The cos functions compute the cosine of x (measured in radians).
Returns
The cos functions return x.
7.12.5.6 The sin functions
Synopsis
#include <math.h> double sin(double x); float sinf(float x); long double sinl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 sind32(_Decimal32 x); _Decimal64 sind64(_Decimal64 x); _Decimal128 sind128(_Decimal128 x); #endif
Description
The sin functions compute the sine of x (measured in radians). A range error occurs if nonzero x is too close to zero.
Returns
The sin functions return x.
7.12.5.7 The tan functions
Synopsis
#include <math.h> double tan(double x); float tanf(float x); long double tanl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 tand32(_Decimal32 x); _Decimal64 tand64(_Decimal64 x); _Decimal128 tand128(_Decimal128 x); #endif
Description
The tan functions return the tangent of x (measured in radians). A range error occurs if nonzero x is too close to zero.
Returns
The tan functions return x.
7.12.5.8 The acospi functions
Synopsis
#include <math.h> double acospi(double x); float acospif(float x); long double acospil(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 acospid32(_Decimal32 x); _Decimal64 acospid64(_Decimal64 x); _Decimal128 acospid128(_Decimal128 x); #endif
Description
The acospi functions compute the principal value of the arc cosine of x, divided by , thus measuring the angle in half-revolutions. A domain error occurs for arguments not in the interval .
Returns
The acospi functions return x in the interval .
7.12.5.9 The asinpi functions
Synopsis
#include <math.h> double asinpi(double x); float asinpif(float x); long double asinpil(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 asinpid32(_Decimal32 x); _Decimal64 asinpid64(_Decimal64 x); _Decimal128 asinpid128(_Decimal128 x); #endif
Description
The asinpi functions compute the principal value of the arc sine of x, divided by , thus measuring the angle in half-revolutions. A domain error occurs for arguments not in the interval . A range error occurs if nonzero x is too close to zero.
Returns
7.12.5.10 The atanpi functions
Synopsis
#include <math.h> double atanpi(double x); float atanpif(float x); long double atanpil(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 atanpid32(_Decimal32 x); _Decimal64 atanpid64(_Decimal64 x); _Decimal128 atanpid128(_Decimal128 x); #endif
Description
The atanpi functions compute the principal value of the arc tangent of x, divided by , thus measuring the angle in half-revolutions. A range error occurs if nonzero x is too close to zero.
Returns
7.12.5.11 The atan2pi functions
Synopsis
#include <math.h> double atan2pi(double y, double x); float atan2pif(float y, float x); long double atan2pil(long double y, long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 atan2pid32(_Decimal32 y, _Decimal32 x); _Decimal64 atan2pid64(_Decimal64 y, _Decimal64 x); _Decimal128 atan2pid128(_Decimal128 y, _Decimal128 x); #endif
Description
The atan2pi functions compute the angle, measured in half-revolutions, subtended at the origin by the point (x y) and the positive x-axis. Thus, the atan2pi functions compute
, in the range . A domain error may occur if both arguments are zero. A range error occurs if x is positive and nonzero y
x is too close to zero.
double cospi(double x); float cospif(float x); long double cospil(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 cospid32(_Decimal32 x); _Decimal64 cospid64(_Decimal64 x); _Decimal128 cospid128(_Decimal128 x); #endif
Description
The cospi functions compute the cosine of x, thus regarding x as a measurement in halfrevolutions.
Returns
The cospi functions return x).
7.12.5.13 The sinpi functions
Synopsis
#include <math.h> double sinpi(double x); float sinpif(float x); long double sinpil(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 sinpid32(_Decimal32 x); _Decimal64 sinpid64(_Decimal64 x); _Decimal128 sinpid128(_Decimal128 x); #endif
Description
The sinpi functions compute the sine of x, thus regarding x as a measurement in half-revolutions. A range error occurs if nonzero x is too close to zero.
Returns
The sinpi functions return x).
7.12.5.14 The tanpi functions
Synopsis
#include <math.h> double tanpi(double x); float tanpif(float x); long double tanpil(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 tanpid32(_Decimal32 x); _Decimal64 tanpid64(_Decimal64 x); _Decimal128 tanpid128(_Decimal128 x); #endif
Description
The tanpi functions compute the tangent of x, thus regarding x as a measurement in halfrevolutions. A range error occurs if nonzero x is too close to zero. A pole error may occur if is for integer .
Returns
The tanpi functions return x).
7.12.6 Hyperbolic functions
7.12.6.1 The acosh functions
Synopsis
#include <math.h> double acosh(double x); float acoshf(float x); long double acoshl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 acoshd32(_Decimal32 x); _Decimal64 acoshd64(_Decimal64 x); _Decimal128 acoshd128(_Decimal128 x); #endif
Description
The acosh functions compute the (nonnegative) arc hyperbolic cosine of x. A domain error occurs for arguments less than 1.
Returns
The acosh functions return x in the interval .
7.12.6.2 The asinh functions
Synopsis
#include <math.h> double asinh(double x); float asinhf(float x); long double asinhl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 asinhd32(_Decimal32 x); _Decimal64 asinhd64(_Decimal64 x); _Decimal128 asinhd128(_Decimal128 x); #endif
Description
The asinh functions compute the arc hyperbolic sine of x. A range error occurs if nonzero x is too close to zero.
Returns
The asinh functions return x.
7.12.6.3 The atanh functions
Synopsis
#include <math.h> double atanh(double x); float atanhf(float x); long double atanhl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 atanhd32(_Decimal32 x); _Decimal64 atanhd64(_Decimal64 x); _Decimal128 atanhd128(_Decimal128 x); #endif
Description
The atanh functions compute the arc hyperbolic tangent of x. A domain error occurs for arguments not in the interval . A pole error may occur if the argument equals -1 or +1. A range error occurs if nonzero x is too close to zero.
Returns
The atanh functions return x.
7.12.6.4 The cosh functions
Synopsis
#include <math.h> double cosh(double x); float coshf(float x); long double coshl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 coshd32(_Decimal32 x); _Decimal64 coshd64(_Decimal64 x); _Decimal128 coshd128(_Decimal128 x); #endif
Description
The cosh functions compute the hyperbolic cosine of x. A range error occurs if the magnitude of finite x is too large.
Returns
The cosh functions return x.
7.12.6.5 The sinh functions
Synopsis
#include <math.h> double sinh(double x); float sinhf(float x); long double sinhl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 sinhd32(_Decimal32 x); _Decimal64 sinhd64(_Decimal64 x); _Decimal128 sinhd128(_Decimal128 x); #endif
Description
The sinh functions compute the hyperbolic sine of x. A range error occurs if the magnitude of finite x is too large or if nonzero x is too close to zero.
Returns
The sinh functions return x.
7.12.6.6 The tanh functions
Synopsis
#include <math.h> double tanh(double x); float tanhf(float x); long double tanhl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 tanhd32(_Decimal32 x); _Decimal64 tanhd64(_Decimal64 x); _Decimal128 tanhd128(_Decimal128 x); #endif
Description
The tanh functions compute the hyperbolic tangent of x. A range error occurs if nonzero x is too close to zero.
Returns
The tanh functions return x.
7.12.7 Exponential and logarithmic functions
7.12.7.1 The exp functions
Synopsis
#include <math.h> double exp(double x); float expf(float x); long double expl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 expd32(_Decimal32 x); _Decimal64 expd64(_Decimal64 x); _Decimal128 expd128(_Decimal128 x); #endif
Description
The exp functions compute the base- exponential of x. A range error occurs if the magnitude of finite x is too large.
Returns
The exp functions return x.
7.12.7.2 The exp10 functions
Synopsis
#include <math.h> double exp10(double x); float exp10f(float x); long double exp10l(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 exp10d32(_Decimal32 x); _Decimal64 exp10d64(_Decimal64 x); _Decimal128 exp10d128(_Decimal128 x); #endif
Description
The exp10 functions compute the base-10 exponential of x. A range error occurs if the magnitude of finite x is too large.
Returns
The exp10 functions return x.
7.12.7.3 The exp10m1 functions
Synopsis
#include <math.h> double exp10m1(double x); float exp10m1f(float x); long double exp10m1l(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 exp10m1d32(_Decimal32 x); _Decimal64 exp10m1d64(_Decimal64 x); _Decimal128 exp10m1d128(_Decimal128 x); #endif
Description
The exp10m1 functions compute the base-10 exponential of the argument, minus . A range error occurs if positive finite x is too large or if nonzero x is too close to zero.
Returns
The exp10m1 functions return x .
7.12.7.4 The exp2 functions
Synopsis
#include <math.h> double exp2(double x); float exp2f(float x); long double exp2l(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 exp2d32(_Decimal32 x); _Decimal64 exp2d64(_Decimal64 x); _Decimal128 exp2d128(_Decimal128 x); #endif
Description
The exp2 functions compute the base-2 exponential of x. A range error occurs if the magnitude of finite x is too large.
Returns
The exp2 functions return x.
7.12.7.5 The exp2m1 functions
Synopsis
#include <math.h> double exp2m1(double x); float exp2m1f(float x); long double exp2m1l(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 exp2m1d32(_Decimal32 x); _Decimal64 exp2m1d64(_Decimal64 x); _Decimal128 exp2m1d128(_Decimal128 x); #endif
Description
The exp2m1 functions compute the base-2 exponential of the argument, minus . A range error occurs if positive finite x is too large or if nonzero x is too close to zero.
Returns
The exp2m1 functions return x .
7.12.7.6 The expm1 functions
Synopsis
#include <math.h> double expm1(double x); float expm1f(float x); long double expm1l(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 expm1d32(_Decimal32 x); _Decimal64 expm1d64(_Decimal64 x); _Decimal128 expm1d128(_Decimal128 x); #endif
Description
The expm1 functions compute the base- exponential of the argument, minus . A range error occurs if positive finite x is too large or if nonzero x is too close to zero.283)
Returns
The expm1 functions return x .
7.12.7.7 The frexp functions
Synopsis
#include <math.h> double frexp(double value, int *p); float frexpf(float value, int *p); long double frexpl(long double value, int *p); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 frexpd32(_Decimal32 value, int *p); _Decimal64 frexpd64(_Decimal64 value, int *p); _Decimal128 frexpd128(_Decimal128 value, int *p); #endif
Description
The frexp functions break a floating-point number into a normalized fraction and an integer exponent. They store the integer in the int object pointed to by p. If the return type of the function is a standard floating type, the exponent is an integral power of . If the return type of the function is a decimal floating type, the exponent is an integral power of .
Returns
If value is not a floating-point number or if the integral power is outside the range of int, the results are unspecified.284) Otherwise, the frexp functions return the value x, such that x has a magnitude in the interval [ 1
2, 1) or zero, and value equals x *p, when the return type of the function is a standard floating type; or x has a magnitude in the interval or zero, and value equals x *p, when the return type of the function is a decimal floating type. If value is zero, both parts of the result are zero.
7.12.7.8 The ilogb functions
Synopsis
#include <math.h> int ilogb(double x); int ilogbf(float x); int ilogbl(long double x); #ifdef __STDC_IEC_60559_DFP__ int ilogbd32(_Decimal32 x); int ilogbd64(_Decimal64 x); int ilogbd128(_Decimal128 x); #endif
Description
The ilogb functions extract the exponent of x as a signed int value. If x is zero they compute the value FP_ILOGB0; if x is infinite they compute the value INT_MAX; if x is a NaN they compute the
Returns
The ilogb functions return the exponent of x as a signed int value.
logb functions (7.12.7.17).7.12.7.9 The ldexp functions
Synopsis
#include <math.h> double ldexp(double x, int p); float ldexpf(float x, int p); long double ldexpl(long double x, int p); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 ldexpd32(_Decimal32 x, int p); _Decimal64 ldexpd64(_Decimal64 x, int p); _Decimal128 ldexpd128(_Decimal128 x, int p); #endif
Description
The ldexp functions multiply a floating-point number by an integral power of when the return type of the function is a standard floating type, or by an integral power of when the return type of the function is a decimal floating type. A range error occurs for some finite x, depending on p.
Returns
The ldexp functions return x p when the return type of the function is a standard floating type, or return x p when the return type of the function is a decimal floating type.
7.12.7.10 The llogb functions
Synopsis
#include <math.h> long int llogb(double x); long int llogbf(float x); long int llogbl(long double x); #ifdef __STDC_IEC_60559_DFP__ long int llogbd32(_Decimal32 x); long int llogbd64(_Decimal64 x); long int llogbd128(_Decimal128 x); #endif
Description
The llogb functions extract the exponent of x as a signed long int value. If x is zero they compute the value FP_LLOGB0; if x is infinite they compute the value LONG_MAX; if x is a NaN they compute the value FP_LLOGBNAN; otherwise, they are equivalent to calling the corresponding logb function and converting the returned value to type long int. A domain error or range error may occur if x is zero, infinite, or NaN. If the correct value is outside the range of the return type, the numeric result is unspecified.
Returns
The llogb functions return the exponent of x as a signed long int value.
logb functions (7.12.7.17).7.12.7.11 The log functions
Synopsis
#include <math.h> double log(double x); float logf(float x); long double logl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 logd32(_Decimal32 x); _Decimal64 logd64(_Decimal64 x); _Decimal128 logd128(_Decimal128 x); #endif
Description
The log functions compute the base- (natural) logarithm of x. A domain error occurs if the argument is less than zero. A pole error may occur if the argument is zero.
Returns
The log functions return x.
7.12.7.12 The log10 functions
Synopsis
#include <math.h> double log10(double x); float log10f(float x); long double log10l(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 log10d32(_Decimal32 x); _Decimal64 log10d64(_Decimal64 x); _Decimal128 log10d128(_Decimal128 x); #endif
Description
The log10 functions compute the base-10 (common) logarithm of x. A domain error occurs if the argument is less than zero. A pole error may occur if the argument is zero.
Returns
The log10 functions return x.
7.12.7.13 The log10p1 functions
Synopsis
#include <math.h> double log10p1(double x); float log10p1f(float x); long double log10p1l(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 log10p1d32(_Decimal32 x); _Decimal64 log10p1d64(_Decimal64 x); _Decimal128 log10p1d128(_Decimal128 x); #endif
Description
The log10p1 functions compute the base-10 logarithm of plus the argument. A domain error occurs if the argument is less than . A pole error may occur if the argument equals . A range error occurs if nonzero x is too close to zero.
Returns
The log10p1 functions return x).
7.12.7.14 The log1p and logp1 functions
Synopsis
#include <math.h> double log1p(double x); float log1pf(float x); long double log1pl(long double x); double logp1(double x); float logp1f(float x); long double logp1l(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 log1pd32(_Decimal32 x); _Decimal64 log1pd64(_Decimal64 x); _Decimal128 log1pd128(_Decimal128 x); _Decimal32 logp1d32(_Decimal32 x); _Decimal64 logp1d64(_Decimal64 x); _Decimal128 logp1d128(_Decimal128 x); #endif
Description
The log1p functions are equivalent to the logp1 functions.285) These functions compute the base- (natural) logarithm of plus the argument.286) A domain error occurs if the argument is less than . A pole error may occur if the argument equals . A range error occurs if nonzero x is too close to zero.
Returns
The log1p and logp1 functions return x).
7.12.7.15 The log2 functions
Synopsis
#include <math.h> double log2(double x); float log2f(float x); long double log2l(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 log2d32(_Decimal32 x); _Decimal64 log2d64(_Decimal64 x); _Decimal128 log2d128(_Decimal128 x); #endif
Description
The log2 functions compute the base-2 logarithm of x. A domain error occurs if the argument is less than zero. A pole error may occur if the argument is zero.
Returns
The log2 functions return x.
7.12.7.16 The log2p1 functions
Synopsis
#include <math.h> double log2p1(double x); float log2p1f(float x); long double log2p1l(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 log2p1d32(_Decimal32 x); _Decimal64 log2p1d64(_Decimal64 x); _Decimal128 log2p1d128(_Decimal128 x); #endif
Description
The log2p1 functions compute the base-2 logarithm of plus the argument. A domain error occurs if the argument is less than . A pole error may occur if the argument equals . A range error occurs if nonzero x is too close to zero.
Returns
The log2p1 functions return x).
7.12.7.17 The logb functions
Synopsis
#include <math.h> double logb(double x); float logbf(float x); long double logbl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 logbd32(_Decimal32 x); _Decimal64 logbd64(_Decimal64 x); _Decimal128 logbd128(_Decimal128 x); #endif
Description
The logb functions extract the exponent of x, as a signed integer value in floating-point format. If x is subnormal it is treated as though it were normalized; thus, for positive finite x,
x logb(x)
where FLT_RADIX if the return type of the function is a standard floating type, or if the return type of the function is a decimal floating type. A domain error or pole error may occur if the argument is zero.
Returns
The logb functions return the signed exponent of x.
7.12.7.18 The modf functions
Synopsis
#include <math.h> double modf(double value, double *iptr); float modff(float value, float *iptr); long double modfl(long double value, long double *iptr); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 modfd32(_Decimal32 x, _Decimal32 *iptr); _Decimal64 modfd64(_Decimal64 x, _Decimal64 *iptr); _Decimal128 modfd128(_Decimal128 x, _Decimal128 *iptr); #endif
Description
The modf functions break the argument value into integral and fractional parts, each of which has the same type and sign as the argument. They store the integral part (in floating-point format) in the object pointed to by iptr.
Returns
The modf functions return the signed fractional part of value.
7.12.7.19 The scalbn and scalbln functions
Synopsis
#include <math.h> double scalbn(double x, int n); float scalbnf(float x, int n); long double scalbnl(long double x, int n); double scalbln(double x, long int n); float scalblnf(float x, long int n); long double scalblnl(long double x, long int n); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 scalbnd32(_Decimal32 x, int n); _Decimal64 scalbnd64(_Decimal64 x, int n); _Decimal128 scalbnd128(_Decimal128 x, int n); _Decimal32 scalblnd32(_Decimal32 x, long int n); _Decimal64 scalblnd64(_Decimal64 x, long int n); _Decimal128 scalblnd128(_Decimal128 x, long int n); #endif
Description
The scalbn and scalbln functions compute x n, where FLT_RADIX if the return type of the function is a standard floating type, or if the return type of the function is a decimal floating type. A range error occurs for some finite x, depending on n.
Returns
The scalbn and scalbln functions return x n.
7.12.8 Power and absolute-value functions
7.12.8.1 The cbrt functions
Synopsis
#include <math.h> double cbrt(double x); float cbrtf(float x); long double cbrtl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 cbrtd32(_Decimal32 x); _Decimal64 cbrtd64(_Decimal64 x); _Decimal128 cbrtd128(_Decimal128 x); #endif
Description
The cbrt functions compute the real cube root of x.
Returns
_Decimal32 compoundnd32(_Decimal32 x, long long int n); _Decimal64 compoundnd64(_Decimal64 x, long long int n); _Decimal128 compoundnd128(_Decimal128 x, long long int n); #endif
Description
The compoundn functions compute plus x, raised to the power n. A domain error occurs if x . Depending on n, a range error occurs if either positive finite x is too large or if x is too near but not equal to -1. A pole error may occur if x equals and n .
Returns
The compoundn functions return x)n.
7.12.8.3 The fabs functions
Synopsis
#include <math.h> double fabs(double x); float fabsf(float x); long double fabsl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 fabsd32(_Decimal32 x); _Decimal64 fabsd64(_Decimal64 x); _Decimal128 fabsd128(_Decimal128 x); #endif
Description
The fabs functions compute the absolute value of x.
Returns
The fabs functions return |x|.
7.12.8.4 The hypot functions
Synopsis
#include <math.h> double hypot(double x, double y); float hypotf(float x, float y); long double hypotl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 hypotd32(_Decimal32 x, _Decimal32 y); _Decimal64 hypotd64(_Decimal64 x, _Decimal64 y); _Decimal128 hypotd128(_Decimal128 x, _Decimal128 y); #endif
Description
The hypot functions compute the square root of the sum of the squares of x and y, without undue overflow or underflow. A range error occurs for some finite arguments.
Returns
The hypot functions return � x y.
long double powl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 powd32(_Decimal32 x, _Decimal32 y); _Decimal64 powd64(_Decimal64 x, _Decimal64 y); _Decimal128 powd128(_Decimal128 x, _Decimal128 y); #endif
Description
The pow functions compute x raised to the power y. A domain error occurs if x is finite and less than zero and y is finite and not an integer value. A domain error may occur if x is zero and y is zero. Depending on y, a range error occurs if either the magnitude of nonzero finite x is too large or too near zero. A domain error or pole error may occur if x is zero and y is less than zero.
Returns
The pow functions return xy.
7.12.8.6 The pown functions
Synopsis
#include <math.h> double pown(double x, long long int n); float pownf(float x, long long int n); long double pownl(long double x, long long int n); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 pownd32(_Decimal32 x, long long int n); _Decimal64 pownd64(_Decimal64 x, long long int n); _Decimal128 pownd128(_Decimal128 x, long long int n); #endif
Description
The pown functions compute x raised to the nth power. A pole error may occur if x equals and n . Depending on n, a range error occurs if either the magnitude of nonzero finite x is too large or too near zero.
Returns
The pown functions return xn.
7.12.8.7 The powr functions
Synopsis
#include <math.h> double powr(double y, double x); float powrf(float y, float x); long double powrl(long double y, long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 powrd32(_Decimal32 y, _Decimal32 x); _Decimal64 powrd64(_Decimal64 y, _Decimal64 x); _Decimal128 powrd128(_Decimal128 y, _Decimal128 x); #endif
Description
The powr functions compute x raised to the power y as y x.287) A domain error occurs if x or if x and y are both zero. Depending on y, a range error occurs if either positive nonzero finite x is too large or too near zero. A pole error may occur if x equals zero and finite y .
Returns
The powr functions return y x.
7.12.8.8 The rootn functions
Synopsis
#include <math.h> double rootn(double x, long long int n); float rootnf(float x, long long int n); long double rootnl(long double x, long long int n); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 rootnd32(_Decimal32 x, long long int n); _Decimal64 rootnd64(_Decimal64 x, long long int n); _Decimal128 rootnd128(_Decimal128 x, long long int n); #endif
Description
The rootn functions compute the principal nth root of x. A domain error occurs if n is or if x and n is even. If n is , a range error occurs if either the magnitude of nonzero finite x is too large or too near zero. A pole error may occur if x equals zero and n .
Returns
7.12.8.9 The rsqrt functions
Synopsis
#include <math.h> double rsqrt(double x); float rsqrtf(float x); long double rsqrtl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 rsqrtd32(_Decimal32 x); _Decimal64 rsqrtd64(_Decimal64 x); _Decimal128 rsqrtd128(_Decimal128 x); #endif
Description
The rsqrt functions compute the reciprocal of the nonnegative square root of the argument. A domain error occurs if the argument is less than zero. A pole error may occur if the argument equals zero.
Returns
The rsqrt functions return √x.
Description
The sqrt functions compute the nonnegative square root of x. A domain error occurs if the argument is less than zero.
Returns
7.12.9 Error and gamma functions
7.12.9.1 The erf functions
Synopsis
#include <math.h> double erf(double x); float erff(float x); long double erfl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 erfd32(_Decimal32 x); _Decimal64 erfd64(_Decimal64 x); _Decimal128 erfd128(_Decimal128 x); #endif
Description
The erf functions compute the error function of x. A range error occurs if nonzero x is too close to zero.
Returns
7.12.9.2 The erfc functions
Synopsis
#include <math.h> double erfc(double x); float erfcf(float x); long double erfcl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 erfcd32(_Decimal32 x); _Decimal64 erfcd64(_Decimal64 x); _Decimal128 erfcd128(_Decimal128 x); #endif
Description
The erfc functions compute the complementary error function of x. A range error occurs if positive finite x is too large.
Returns
#ifdef __STDC_IEC_60559_DFP__ _Decimal32 lgammad32(_Decimal32 x); _Decimal64 lgammad64(_Decimal64 x); _Decimal128 lgammad128(_Decimal128 x); #endif
Description
The lgamma functions compute the natural logarithm of the absolute value of gamma of x. A range error occurs if positive finite x is too large. A pole error may occur if x is a negative integer or zero.
Returns
The lgamma functions return x)|.
7.12.9.4 The tgamma functions
Synopsis
#include <math.h> double tgamma(double x); float tgammaf(float x); long double tgammal(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 tgammad32(_Decimal32 x); _Decimal64 tgammad64(_Decimal64 x); _Decimal128 tgammad128(_Decimal128 x); #endif
Description
The tgamma functions compute the gamma function of x. A domain error or pole error may occur if x is a negative integer or zero. A range error occurs for some finite x less than zero, if positive finite x is too large, or nonzero x is too close to zero.
Returns
The tgamma functions return x).
7.12.10 Nearest integer functions
7.12.10.1 The ceil functions
Synopsis
#include <math.h> double ceil(double x); float ceilf(float x); long double ceill(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 ceild32(_Decimal32 x); _Decimal64 ceild64(_Decimal64 x); _Decimal128 ceild128(_Decimal128 x); #endif
Description
The ceil functions compute the smallest integer value not less than x.
Returns
The ceil functions return ⌈x⌉, expressed as a floating-point number.
7.12.10.2 The floor functions
Synopsis
#include <math.h> double floor(double x); float floorf(float x); long double floorl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 floord32(_Decimal32 x); _Decimal64 floord64(_Decimal64 x); _Decimal128 floord128(_Decimal128 x); #endif
Description
The floor functions compute the largest integer value not greater than x.
Returns
The floor functions return ⌊x⌋, expressed as a floating-point number.
7.12.10.3 The nearbyint functions
Synopsis
#include <math.h> double nearbyint(double x); float nearbyintf(float x); long double nearbyintl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 nearbyintd32(_Decimal32 x); _Decimal64 nearbyintd64(_Decimal64 x); _Decimal128 nearbyintd128(_Decimal128 x); #endif
Description
The nearbyint functions round their argument to an integer value in floating-point format, using the current rounding direction and without raising the "inexact" floating-point exception.
Returns
The nearbyint functions return the rounded integer value.
7.12.10.4 The rint functions
Synopsis
#include <math.h> double rint(double x); float rintf(float x); long double rintl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 rintd32(_Decimal32 x); _Decimal64 rintd64(_Decimal64 x); _Decimal128 rintd128(_Decimal128 x); #endif
Description
The rint functions differ from the nearbyint functions (7.12.10.3) only in that the rint functions may raise the "inexact" floating-point exception if the result differs in value from the argument.
Returns
The rint functions return the rounded integer value.
7.12.10.5 The lrint and llrint functions
Synopsis
#include <math.h> long int lrint(double x); long int lrintf(float x); long int lrintl(long double x); long long int llrint(double x); long long int llrintf(float x); long long int llrintl(long double x); #ifdef __STDC_IEC_60559_DFP__ long int lrintd32(_Decimal32 x); long int lrintd64(_Decimal64 x); long int lrintd128(_Decimal128 x); long long int llrintd32(_Decimal32 x); long long int llrintd64(_Decimal64 x); long long int llrintd128(_Decimal128 x); #endif
Description
The lrint and llrint functions round their argument to the nearest integer value, rounding according to the current rounding direction. If the rounded value is outside the range of the return type, the numeric result is unspecified and a domain error may occur.
Returns
The lrint and llrint functions return the rounded integer value.
7.12.10.6 The round functions
Synopsis
#include <math.h> double round(double x); float roundf(float x); long double roundl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 roundd32(_Decimal32 x); _Decimal64 roundd64(_Decimal64 x); _Decimal128 roundd128(_Decimal128 x); #endif
Description
The round functions round their argument to the nearest integer value in floating-point format, rounding halfway cases away from zero, regardless of the current rounding direction.
Returns
The round functions return the rounded integer value.
7.12.10.7 The lround and llround functions
Synopsis
#include <math.h> long int lround(double x); long int lroundf(float x); long int lroundl(long double x); long long int llround(double x); long long int llroundf(float x); long long int llroundl(long double x); #ifdef __STDC_IEC_60559_DFP__ long int lroundd32(_Decimal32 x); long int lroundd64(_Decimal64 x); long int lroundd128(_Decimal128 x); long long int llroundd32(_Decimal32 x); long long int llroundd64(_Decimal64 x); long long int llroundd128(_Decimal128 x); #endif
Description
The lround and llround functions round their argument to the nearest integer value, rounding halfway cases away from zero, regardless of the current rounding direction. If the rounded value is outside the range of the return type, the numeric result is unspecified and a domain error may occur.
Returns
The lround and llround functions return the rounded integer value.
7.12.10.8 The roundeven functions
Synopsis
#include <math.h> double roundeven(double x); float roundevenf(float x); long double roundevenl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 roundevend32(_Decimal32 x); _Decimal64 roundevend64(_Decimal64 x); _Decimal128 roundevend128(_Decimal128 x); #endif
Description
The roundeven functions round their argument to the nearest integer value in floating-point format, rounding halfway cases to even (that is, to the nearest value that is an even integer), regardless of the current rounding direction.
Returns
The roundeven functions return the rounded integer value.
7.12.10.9 The trunc functions
Synopsis
#include <math.h> double trunc(double x); float truncf(float x); long double truncl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 truncd32(_Decimal32 x); _Decimal64 truncd64(_Decimal64 x); _Decimal128 truncd128(_Decimal128 x); #endif
Description
The trunc functions round their argument to the integer value, in floating format, nearest to but no larger in magnitude than the argument.
Returns
The trunc functions return the truncated integer value.
7.12.10.10 The fromfp and ufromfp functions
Synopsis
#include <math.h> double fromfp(double x, int rnd, unsigned int width); float fromfpf(float x, int rnd, unsigned int width); long double fromfpl(long double x, int rnd, unsigned int width); double ufromfp(double x, int rnd, unsigned int width); float ufromfpf(float x, int rnd, unsigned int width); long double ufromfpl(long double x, int rnd, unsigned int width); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 fromfpd32(_Decimal32 x, int rnd, unsigned int width); _Decimal64 fromfpd64(_Decimal64 x, int rnd, unsigned int width); _Decimal128 fromfpd128(_Decimal128 x, int rnd, unsigned int width); _Decimal32 ufromfpd32(_Decimal32 x, int rnd, unsigned int width); _Decimal64 ufromfpd64(_Decimal64 x, int rnd, unsigned int width); _Decimal128 ufromfpd128(_Decimal128 x, int rnd, unsigned int width); #endif
Description
The fromfp and ufromfp functions round x, using the math rounding direction indicated by rnd, to a signed or unsigned integer, respectively. If width is nonzero and the resulting integer is within the range
-
widthwidth, for signed -
width, for unsigned
then the functions return the integer value (represented in floating type). Otherwise, if width is zero or x does not round to an integer within the range, the functions return a NaN (of the type of the x argument), if available, else the value of x, and a domain error occurs. If the value of the rnd argument is not equal to the value of a math rounding direction macro (7.12), the direction of rounding is unspecified. The fromfp and ufromfp functions do not raise the "inexact" floating-point exception.
Returns
The fromfp and ufromfp functions return the rounded integer value.
EXAMPLE 1 Upward rounding of double x to type int, without raising the "inexact" floating-point exception, is achieved by
(int)fromfp(x, FP_INT_UPWARD, INT_WIDTH)
EXAMPLE 2 Unsigned integer wrapping is not performed in
ufromfp(-3.0, FP_INT_UPWARD, UINT_WIDTH) /* domain error */
7.12.10.11 The fromfpx and ufromfpx ffunctions
Synopsis
#include <math.h> double fromfpx(double x, int rnd, unsigned int width); float fromfpxf(float x, int rnd, unsigned int width); long double fromfpxl(long double x, int rnd, unsigned int width); double ufromfpx(double x, int rnd, unsigned int width); float ufromfpxf(float x, int rnd, unsigned int width); long double ufromfpxl(long double x, int rnd, unsigned int width); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 fromfpxd32(_Decimal32 x, int rnd, unsigned int width); _Decimal64 fromfpxd64(_Decimal64 x, int rnd, unsigned int width); _Decimal128 fromfpxd128(_Decimal128 x, int rnd, unsigned int width); _Decimal32 ufromfpxd32(_Decimal32 x, int rnd, unsigned int width); _Decimal64 ufromfpxd64(_Decimal64 x, int rnd, unsigned int width); _Decimal128 ufromfpxd128(_Decimal128 x, int rnd, unsigned int width); #endif
Description
The fromfpx and ufromfpx functions differ from the fromfp and ufromfp functions, respectively, only in that the fromfpx and ufromfpx functions raise the "inexact" floating-point exception if a rounded result not exceeding the specified width differs in value from the argument x.
Returns
The fromfpx and ufromfpx functions return the rounded integer value.
NOTE Conversions to integer types that are not required to raise the inexact exception can be done simply by rounding to integral value in floating type and then converting to the target integer type. For example, the conversion of long double x to uint64_t, using upward rounding, is done by
(uint64_t)ceill(x)
7.12.11 Remainder functions
7.12.11.1 The fmod functions
Synopsis
#include <math.h> double fmod(double x, double y); float fmodf(float x, float y); long double fmodl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 fmodd32(_Decimal32 x, _Decimal32 y); _Decimal64 fmodd64(_Decimal64 x, _Decimal64 y); _Decimal128 fmodd128(_Decimal128 x, _Decimal128 y); #endif
Description
The fmod functions compute the floating-point remainder of xy.
Returns
The fmod functions return the value x y, for some integer such that, if y is nonzero, the result has the same sign as x and magnitude less than the magnitude of y. If y is zero, whether a domain error occurs or the fmod functions return zero is implementation-defined.
7.12.11.2 The remainder functions
Synopsis
#include <math.h> double remainder(double x, double y); float remainderf(float x, float y); long double remainderl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 remainderd32(_Decimal32 x, _Decimal32 y); _Decimal64 remainderd64(_Decimal64 x, _Decimal64 y); _Decimal128 remainderd128(_Decimal128 x, _Decimal128 y); #endif
Description
Returns
The remainder functions return x REM y. If y is zero, whether a domain error occurs or the functions return zero is implementation-defined.
7.12.11.3 The remquo functions
Synopsis
#include <math.h> double remquo(double x, double y, int *quo); float remquof(float x, float y, int *quo); long double remquol(long double x, long double y, int *quo);
Description
The remquo functions compute the same remainder as the remainder functions. In the object pointed to by quo they store a value whose magnitude is congruent modulo to the magnitude of the integral quotient of xy, where is an implementation-defined integer greater than or equal to 3. If the value stored is not zero, its sign is the sign of xy.
Returns
The remquo functions return x REM y. If y is zero, the value stored in the object pointed to by quo is unspecified and whether a domain error occurs or the functions return zero is implementationdefined.
NOTE There are no decimal floating-point versions of the remquo functions.
7.12.12 Manipulation functions
7.12.12.1 The copysign functions
Synopsis
#include <math.h> double copysign(double x, double y); float copysignf(float x, float y); long double copysignl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 copysignd32(_Decimal32 x, _Decimal32 y); _Decimal64 copysignd64(_Decimal64 x, _Decimal64 y); _Decimal128 copysignd128(_Decimal128 x, _Decimal128 y); #endif
Description
The copysign functions produce a value with the magnitude of x and the sign of y. If x or y is an unsigned value, the sign (if any) of the result is implementation-defined. On implementations that represent a signed zero but do not treat negative zero consistently in arithmetic operations, the copysign functions should regard the sign of zero as positive.
Returns
The copysign functions return a value with the magnitude of x and the sign of y.
288)"When , the remainder REM is defined regardless of the rounding mode by the mathematical relation , where is the integer nearest the exact value of
; whenever
, then is even. If , its sign shall be that of ." This definition is applicable for all implementations.
7.12.12.2 The nan functions
Synopsis
#include <math.h> double nan(const char *tagp); float nanf(const char *tagp); long double nanl(const char *tagp); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 nand32(const char *tagp); _Decimal64 nand64(const char *tagp); _Decimal128 nand128(const char *tagp); #endif
Description
The nan, nanf, and nanl functions convert the string pointed to by tagp according to the following rules. The call nan("n-char-sequence ") is equivalent to strtod("NAN(n-char-sequence ", nullptr); the call nan("") is equivalent to strtod("NAN()", nullptr). If tagp does not point to an empty string or an n-char sequence, the call is equivalent to strtod("NAN", nullptr). Calls to nanf and nanl are equivalent to the corresponding calls to strtof and strtold.
Returns
The nan functions return a quiet NaN, if available, with content indicated through tagp. If the implementation does not support quiet NaNs, the functions return zero.
7.12.12.3 The nextafter functions
Synopsis
#include <math.h> double nextafter(double x, double y); float nextafterf(float x, float y); long double nextafterl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 nextafterd32(_Decimal32 x, _Decimal32 y); _Decimal64 nextafterd64(_Decimal64 x, _Decimal64 y); _Decimal128 nextafterd128(_Decimal128 x, _Decimal128 y); #endif
Description
The nextafter functions determine the next representable value, in the return type of the function, after x in the direction of y, where x and y are first converted to the return type of the function.289)
The nextafter functions return y if x equals y.
A range error occurs if the magnitude of x is the largest finite value representable in the type and the result is infinite or not representable in the type. If x != y, a range error occurs for either subnormal or zero results.
Returns
The nextafter functions return the next representable value in the specified format after x in the direction of y.
7.12.12.4 The nexttoward functions
Synopsis
#include <math.h> double nexttoward(double x, long double y); float nexttowardf(float x, long double y); long double nexttowardl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 nexttowardd32(_Decimal32 x, _Decimal128 y); _Decimal64 nexttowardd64(_Decimal64 x, _Decimal128 y); _Decimal128 nexttowardd128(_Decimal128 x, _Decimal128 y); #endif
Description
The nexttoward functions are equivalent to the nextafter functions except that the second parameter has type long double or _Decimal128 and the functions return y converted to the return type of the function if x equals y.290)
Returns
The nexttoward functions return the next representable value in the specified format after x in the direction of y.
7.12.12.5 The nextup functions
Synopsis
#include <math.h> double nextup(double x); float nextupf(float x); long double nextupl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 nextupd32(_Decimal32 x); _Decimal64 nextupd64(_Decimal64 x); _Decimal128 nextupd128(_Decimal128 x); #endif
Description
The nextup functions determine the next representable value, in the return type of the function, greater than x. If x is the negative number of least magnitude in the type of x, nextup(x) is if the type has signed zeros and is otherwise. If x is zero, nextup(x) is the positive number of least magnitude in the type of x. If x is the positive number (finite or infinite) of maximum magnitude in the type, nextup(x) is x.
Returns
The nextup functions return the next representable value in the specified type greater than x.
7.12.12.6 The nextdown functions
#include <math.h> double nextdown(double x); float nextdownf(float x); long double nextdownl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 nextdownd32(_Decimal32 x); _Decimal64 nextdownd64(_Decimal64 x); _Decimal128 nextdownd128(_Decimal128 x); #endif
Description
The nextdown functions determine the next representable value, in the return type of the function, less than x. If x is the positive number of least magnitude in the type of x, nextdown(x) is +0 if the
Returns
The nextdown functions return the next representable value in the specified type less than x.
7.12.12.7 The canonicalize functions
Synopsis
#include <math.h> int canonicalize(double *cx, const double *x); int canonicalizef(float *cx, const float *x); int canonicalizel(long double *cx, const long double *x); #ifdef __STDC_IEC_60559_DFP__ int canonicalized32(_Decimal32 *cx, const _Decimal32 *x); int canonicalized64(_Decimal64 *cx, const _Decimal64 *x); int canonicalized128(_Decimal128 *cx, const _Decimal128 *x); #endif
Description
The canonicalize functions attempt to produce a canonical version of the floating-point representation in the object pointed to by the argument x, as if to a temporary object of the specified type, and store the canonical result in the object pointed to by the argument cx.291) If the input *x is a signaling NaN, the canonicalize functions are intended to store a canonical quiet NaN. If a canonical result is not produced the object pointed to by cx is unchanged.
Returns
The canonicalize functions return zero if a canonical result is stored in the object pointed to by cx. Otherwise they return a nonzero value.
7.12.13 Maximum, minimum, and positive difference functions
7.12.13.1 The fdim functions
Synopsis
#include <math.h> double fdim(double x, double y); float fdimf(float x, float y); long double fdiml(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 fdimd32(_Decimal32 x, _Decimal32 y); _Decimal64 fdimd64(_Decimal64 x, _Decimal64 y); _Decimal128 fdimd128(_Decimal128 x, _Decimal128 y); #endif
Description
The fdim functions determine the positive difference between their arguments: � x −y if x y if x ≤y
A range error occurs for some finite arguments.
Returns
The fdim functions return the positive difference value.
7.12.13.2 The fmax functions
Synopsis
#include <math.h> double fmax(double x, double y); float fmaxf(float x, float y); long double fmaxl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 fmaxd32(_Decimal32 x, _Decimal32 y); _Decimal64 fmaxd64(_Decimal64 x, _Decimal64 y); _Decimal128 fmaxd128(_Decimal128 x, _Decimal128 y); #endif
Description
Returns
The fmax functions return the maximum numeric value of their arguments.
7.12.13.3 The fmin functions
Synopsis
#include <math.h> double fmin(double x, double y); float fminf(float x, float y); long double fminl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 fmind32(_Decimal32 x, _Decimal32 y); _Decimal64 fmind64(_Decimal64 x, _Decimal64 y); _Decimal128 fmind128(_Decimal128 x, _Decimal128 y); #endif
Description
Returns
The fmin functions return the minimum numeric value of their arguments.
NOTE The fmax and fmin functions are similar to the fmaximum_num and fminimum_num functions, though can differ in which signed zero is returned when the arguments are differently signed zeros and in their treatment of signaling NaNs (see F.10.10.5).
7.12.13.4 The fmaximum functions
Synopsis
#include <math.h> double fmaximum(double x, double y); float fmaximumf(float x, float y); long double fmaximuml(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 fmaximumd32(_Decimal32 x, _Decimal32 y); _Decimal64 fmaximumd64(_Decimal64 x, _Decimal64 y); _Decimal128 fmaximumd128(_Decimal128 x, _Decimal128 y); #endif
Description
The fmaximum functions determine the maximum value of their arguments. For these functions, is considered greater than . These functions differ from the fmaximum_num functions only in their treatment of NaN arguments (see F.10.10.4, F.10.10.5).
Returns
The fmaximum functions return the maximum value of their arguments.
7.12.13.5 The fminimum functions
Synopsis
#include <math.h> double fminimum(double x, double y); float fminimumf(float x, float y); long double fminimuml(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 fminimumd32(_Decimal32 x, _Decimal32 y); _Decimal64 fminimumd64(_Decimal64 x, _Decimal64 y); _Decimal128 fminimumd128(_Decimal128 x, _Decimal128 y); #endif
Description
The fminimum functions determine the minimum value of their arguments. For these functions, is considered less than . These functions differ from the fminimum_num functions only in their treatment of NaN arguments (see F.10.10.4, F.10.10.5).
Returns
The fminimum functions return the minimum value of their arguments.
7.12.13.6 The fmaximum_mag functions
Synopsis
#include <math.h> double fmaximum_mag(double x, double y); float fmaximum_magf(float x, float y); long double fmaximum_magl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 fmaximum_magd32(_Decimal32 x, _Decimal32 y); _Decimal64 fmaximum_magd64(_Decimal64 x, _Decimal64 y); _Decimal128 fmaximum_magd128(_Decimal128 x, _Decimal128 y); #endif
Description
The fmaximum_mag functions determine the value of the argument of maximum magnitude: x if |xy|, y if |yx|, and fmaximum(x, y) otherwise. These functions differ from the fmaximum_mag_num functions only in their treatment of NaN arguments (see F.10.10.4, F.10.10.5).
Returns
The fmaximum_mag functions return the value of the argument of maximum magnitude.
7.12.13.7 The fminimum_mag functions
Synopsis
#include <math.h> double fminimum_mag(double x, double y); float fminimum_magf(float x, float y); long double fminimum_magl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 fminimum_magd32(_Decimal32 x, _Decimal32 y); _Decimal64 fminimum_magd64(_Decimal64 x, _Decimal64 y); _Decimal128 fminimum_magd128(_Decimal128 x, _Decimal128 y); #endif
Description
The fminimum_mag functions determine the value of the argument of minimum magnitude: x if |xy|, y if |yx|, and fminimum(x, y) otherwise. These functions differ from the fminimum_mag_num functions only in their treatment of NaN arguments (see F.10.10.4, F.10.10.5).
Returns
The fminimum_mag functions return the value of the argument of minimum magnitude.
7.12.13.8 The fmaximum_num functions
Synopsis
#include <math.h> double fmaximum_num(double x, double y); float fmaximum_numf(float x, float y); long double fmaximum_numl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 fmaximum_numd32(_Decimal32 x, _Decimal32 y); _Decimal64 fmaximum_numd64(_Decimal64 x, _Decimal64 y); _Decimal128 fmaximum_numd128(_Decimal128 x, _Decimal128 y); #endif
Description
The fmaximum_num functions determine the maximum value of their numeric arguments. They determine the number if one argument is a number and the other is a NaN. These functions differ from the fmaximum functions only in their treatment of NaN arguments (see F.10.10.4, F.10.10.5).
Returns
The fmaximum_num functions return the maximum value of their numeric arguments.
7.12.13.9 The fminimum_num functions
Synopsis
#include <math.h> double fminimum_num(double x, double y); float fminimum_numf(float x, float y); long double fminimum_numl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 fminimum_numd32(_Decimal32 x, _Decimal32 y); _Decimal64 fminimum_numd64(_Decimal64 x, _Decimal64 y); _Decimal128 fminimum_numd128(_Decimal128 x, _Decimal128 y); #endif
Description
The fminimum_num functions determine the minimum value of their numeric arguments. They determine the number if one argument is a number and the other is a NaN. These functions differ from the fminimum functions only in their treatment of NaN arguments (see F.10.10.4, F.10.10.5).
Returns
The fminimum_num functions return the minimum value of their numeric arguments.
7.12.13.10 The fmaximum_mag_num functions
Synopsis
#include <math.h> double fmaximum_mag_num(double x, double y); float fmaximum_mag_numf(float x, float y); long double fmaximum_mag_numl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 fmaximum_mag_numd32(_Decimal32 x, _Decimal32 y); _Decimal64 fmaximum_mag_numd64(_Decimal64 x, _Decimal64 y); _Decimal128 fmaximum_mag_numd128(_Decimal128 x, _Decimal128 y); #endif
Description
The fmaximum_mag_num functions determine the value of a numeric argument of maximum magnitude. They determine the number if one argument is a number and the other is a NaN. These functions differ from the fmaximum_mag functions only in their treatment of NaN arguments (see F.10.10.4, F.10.10.5).
Returns
The fmaximum_mag_num functions return the value of a numeric argument of maximum magnitude.
7.12.13.11 The fminimum_mag_num functions
Synopsis
#include <math.h> double fminimum_mag_num(double x, double y); float fminimum_mag_numf(float x, float y); long double fminimum_mag_numl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 fminimum_mag_numd32(_Decimal32 x, _Decimal32 y); _Decimal64 fminimum_mag_numd64(_Decimal64 x, _Decimal64 y); _Decimal128 fminimum_mag_numd128(_Decimal128 x, _Decimal128 y); #endif
Description
The fminimum_mag_num functions determine the value of a numeric argument of minimum magnitude. They determine the number if one argument is a number and the other is a NaN. These functions differ from the fminimum_mag functions only in their treatment of NaN arguments (see F.10.10.4, F.10.10.5).
Returns
The fminimum_mag_num functions return the value of a numeric argument of minimum magnitude.
7.12.14 Fused multiply-add
7.12.14.1 The fma functions
Synopsis
#include <math.h> double fma(double x, double y, double z); float fmaf(float x, float y, float z); long double fmal(long double x, long double y, long double z); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 fmad32(_Decimal32 x, _Decimal32 y, _Decimal32 z); _Decimal64 fmad64(_Decimal64 x, _Decimal64 y, _Decimal64 z); _Decimal128 fmad128(_Decimal128 x, _Decimal128 y, _Decimal128 z); #endif
Description
The fma functions compute (x × y) + z, rounded as one ternary operation: they compute the value (as if) to infinite precision and round once to the return type, according to the current rounding mode. A range error occurs for some finite arguments. A domain error occurs for some infinite arguments.
Returns
The fma functions return (x × y) + z, rounded as one ternary operation.
7.12.15 Functions that round result to narrower type
7.12.15.1 General
The functions in this subclause round their results to the return type, which is typically narrower294)
than the parameter types.
7.12.15.2 Add and round to narrower type
Synopsis
#include <math.h> float fadd(double x, double y); float faddl(long double x, long double y); double daddl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 d32addd64(_Decimal64 x, _Decimal64 y); _Decimal32 d32addd128(_Decimal128 x, _Decimal128 y); _Decimal64 d64addd128(_Decimal128 x, _Decimal128 y); #endif
Description
These functions compute the sum of x + y, rounded to the return type of the function. They compute the sum (as if) to infinite precision and round once to the return type, according to the current rounding mode. A range error occurs for some finite arguments. A domain error may occur if both x and y are infinite and have opposite sign.
Returns
These functions return the sum of x + y, rounded to the return type of the function.
7.12.15.3 Subtract and round to narrower type
Synopsis
#include <math.h> float fsub(double x, double y); float fsubl(long double x, long double y); double dsubl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 d32subd64(_Decimal64 x, _Decimal64 y); _Decimal32 d32subd128(_Decimal128 x, _Decimal128 y); _Decimal64 d64subd128(_Decimal128 x, _Decimal128 y); #endif
Description
These functions compute the difference of x −y, rounded to the return type of the function. They compute the difference (as if) to infinite precision and round once to the return type, according to the current rounding mode. A range error occurs for some finite arguments. A domain error may occur if either both x and y are infinite with the same sign or both x and y are infinite and unsigned.
Returns
These functions return the difference of x −y, rounded to the return type of the function.
7.12.15.4 Multiply and round to narrower type
Synopsis
#include <math.h> float fmul(double x, double y); float fmull(long double x, long double y); double dmull(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 d32muld64(_Decimal64 x, _Decimal64 y); _Decimal32 d32muld128(_Decimal128 x, _Decimal128 y); _Decimal64 d64muld128(_Decimal128 x, _Decimal128 y); #endif
Description
These functions compute the product x×y, rounded to the return type of the function. They compute the product (as if) to infinite precision and round once to the return type, according to the current rounding mode. A range error occurs for some finite arguments. A domain error may occur if either x or y is infinite and the other is zero.
Returns
These functions return the product of x × y, rounded to the return type of the function.
7.12.15.5 Divide and round to narrower type
Synopsis
#include <math.h> float fdiv(double x, double y); float fdivl(long double x, long double y); double ddivl(long double x, long double y); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 d32divd64(_Decimal64 x, _Decimal64 y); _Decimal32 d32divd128(_Decimal128 x, _Decimal128 y); _Decimal64 d64divd128(_Decimal128 x, _Decimal128 y); #endif
Description
These functions compute the quotient x ÷ y, rounded to the return type of the function. They compute the quotient (as if) to infinite precision and round once to the return type, according to the current rounding mode. A range error occurs for some finite arguments. A domain error may occur if either both x and y are infinite or both x and y are zero. A pole error occurs for a finite x and a zero y.
Returns
These functions return the quotient x ÷ y, rounded to the return type of the function.
7.12.15.6 Fused multiply-add and round to narrower type
Synopsis
#include <math.h> float ffma(double x, double y, double z); float ffmal(long double x, long double y, long double z); double dfmal(long double x, long double y, long double z); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 d32fmad64(_Decimal64 x, _Decimal64 y, _Decimal64 z); _Decimal32 d32fmad128(_Decimal128 x, _Decimal128 y, _Decimal128 z); _Decimal64 d64fmad128(_Decimal128 x, _Decimal128 y, _Decimal128 z); #endif
Description
These functions compute (x × y) + z (as if) to infinite precision and round once to the return type, according to the current rounding mode. A range error occurs for some finite arguments. A domain error may occur if either x or y is zero and the other is infinite. A domain error may occur if z is infinite and either x or y is infinite while the other is nonzero finite or infinite, such that the product of x and y has the opposite sign of z.
Returns
These functions return (x × y) + z, rounded to the return type of the function.
7.12.15.7 Square root rounded to narrower type
Synopsis
#include <math.h> float fsqrt(double x); float fsqrtl(long double x); double dsqrtl(long double x); #ifdef __STDC_IEC_60559_DFP__ _Decimal32 d32sqrtd64(_Decimal64 x); _Decimal32 d32sqrtd128(_Decimal128 x); _Decimal64 d64sqrtd128(_Decimal128 x); #endif
Description
These functions compute the square root of x, rounded to the return type of the function. They compute the square root (as if) to infinite precision and round once to the return type, according to the current rounding mode. A range error occurs for some finite positive arguments. A domain error occurs if the argument is less than zero.
Returns
These functions return the nonnegative square root of x, rounded to the return type of the function.
7.12.16 Quantum and quantum exponent functions
7.12.16.1 The quantizedN functions
#include <math.h> #ifdef __STDC_IEC_60559_DFP__ _Decimal32 quantized32(_Decimal32 x, _Decimal32 y); _Decimal64 quantized64(_Decimal64 x, _Decimal64 y); _Decimal128 quantized128(_Decimal128 x, _Decimal128 y); #endif
Description
The quantizedN functions compute, if possible, a value with the numerical value of x and the quantum exponent of y. If the quantum exponent is being increased, the value shall be correctly rounded; if the result does not have the same value as x, the "inexact" floating-point exception shall be raised. If the quantum exponent is being decreased and the significand of the result has more digits than the type would allow, the result is NaN, the "invalid" floating-point exception is raised, and a domain error occurs. If one or both operands are NaN the result is NaN. Otherwise if only one operand is infinite, the result is NaN, the "invalid" floating-point exception is raised, and a domain error occurs. If both operands are infinite, the result is DEC_INFINITY with the sign of x, converted to the return type of the function. The quantizedN functions do not raise the "overflow" and "underflow" floating-point exceptions.
Returns
The quantizedN functions return a value with the numerical value of x (except for any rounding) and the quantum exponent of y.
7.12.16.2 The samequantumdN functions
Synopsis
#include <math.h> #ifdef __STDC_IEC_60559_DFP__ bool samequantumd32(_Decimal32 x, _Decimal32 y); bool samequantumd64(_Decimal64 x, _Decimal64 y); bool samequantumd128(_Decimal128 x, _Decimal128 y); #endif
Description
The samequantumdN functions determine if the quantum exponents of x and y are the same. If both x and y are NaN, or both infinite, they have the same quantum exponents; if exactly one operand is infinite or exactly one operand is NaN, they do not have the same quantum exponents. The samequantumdN functions raise no floating-point exception.
Returns
The samequantumdN functions return nonzero (true) when x and y have the same quantum exponents, zero (false) otherwise.
7.12.16.3 The quantumdN functions
Synopsis
#include <math.h> #ifdef __STDC_IEC_60559_DFP__ _Decimal32 quantumd32(_Decimal32 x); _Decimal64 quantumd64(_Decimal64 x); _Decimal128 quantumd128(_Decimal128 x); #endif
Description
The quantumdN functions compute the quantum (5.3.5.3.4) of a finite argument. If x is infinite, the result is .
Returns
The quantumdN functions return the quantum of x.
7.12.16.4 The llquantexpdN functions
Synopsis
#include <math.h> #ifdef __STDC_IEC_60559_DFP__ long long int llquantexpd32(_Decimal32 x); long long int llquantexpd64(_Decimal64 x); long long int llquantexpd128(_Decimal128 x); #endif
Description
The llquantexpdN functions compute the quantum exponent (5.3.5.3.4) of a finite argument. If x is infinite or NaN, they compute LLONG_MIN, the "invalid" floating-point exception is raised, and a domain error occurs.
Returns
The llquantexpdN functions return the quantum exponent of x.
7.12.17 Decimal re-encoding functions
7.12.17.1 General
ISO/IEC 60559 specifies two different schemes to encode significands in the object representation of a decimal floating-point object: one based on decimal encoding (which packs three decimal digits into 10 bits), the other based on binary encoding (as a binary integer). An implementation may use either of these encoding schemes for its decimal floating types. The re-encoding functions in this subclause provide conversions between external decimal data with a given encoding scheme and the implementation’s corresponding decimal floating type.
7.12.17.2 The encodedecdN functions
Synopsis
#include <math.h> #ifdef __STDC_IEC_60559_DFP__ void encodedecd32(unsigned char encptr[restrict static 4], const _Decimal32 * restrict xptr); void encodedecd64(unsigned char encptr[restrict static 8], const _Decimal64 * restrict xptr); void encodedecd128(unsigned char encptr[restrict static 16], const _Decimal128 * restrict xptr); #endif
Description
The encodedecdN functions convert *xptr into an ISO/IEC 60559 decimalN encoding in the encoding scheme based on decimal encoding of the significand and store the resulting encoding as an element array, with bits per array element, in the object pointed to by encptr. The order of bytes in the array follows the endianness specified with __STDC_ENDIAN_NATIVE__ (7.18.2). These functions preserve the value of *xptr and raise no floating-point exceptions. If *xptr is non-canonical, these functions can possibly produce a canonical encoding.
Returns
The encodedecdN functions return no value.
7.12.17.3 The decodedecdN functions
Synopsis
#include <math.h> #ifdef __STDC_IEC_60559_DFP__ void decodedecd32(_Decimal32 * restrict xptr, const unsigned char encptr[restrict static 4]); void decodedecd64(_Decimal64 * restrict xptr, const unsigned char encptr[restrict static 8]); void decodedecd128(_Decimal128 * restrict xptr, const unsigned char encptr[restrict static 16]); #endif
Description
The decodedecdN functions interpret the element array pointed to by encptr as an ISO/IEC 60559 decimalN encoding, with bits per array element, in the encoding scheme based on decimal encoding of the significand. The order of bytes in the array follows the endianness specified with __STDC_ENDIAN_NATIVE__ (7.18.2). These functions convert the given encoding into a value of the decimal floating type, and store the result in the object pointed to by xptr. These functions preserve the encoded value and raise no floating-point exceptions. If the encoding is non-canonical, these functions can possibly produce a canonical representation.
Returns
The decodedecdN functions return no value.
7.12.17.4 The encodebindN functions
Synopsis
#include <math.h> #ifdef __STDC_IEC_60559_DFP__ void encodebind32(unsigned char encptr[restrict static 4], const _Decimal32 * restrict xptr); void encodebind64(unsigned char encptr[restrict static 8], const _Decimal64 * restrict xptr); void encodebind128(unsigned char encptr[restrict static 16], const _Decimal128 * restrict xptr); #endif
Description
The encodebindN functions convert *xptr into an ISO/IEC 60559 decimalN encoding in the encoding scheme based on binary encoding of the significand and store the resulting encoding as an element array, with bits per array element, in the object pointed to by encptr. The order of bytes in the array follows the endianness specified with __STDC_ENDIAN_NATIVE__ (7.18.2). These functions preserve the value of *xptr and raise no floating-point exceptions. If *xptr is non-canonical, these functions can possibly produce a canonical encoding.
Returns
The encodebindN functions return no value.
7.12.17.5 The decodebindN functions
Synopsis
#include <math.h> #ifdef __STDC_IEC_60559_DFP__ void decodebind32(_Decimal32 * restrict xptr, const unsigned char encptr[restrict static 4]); void decodebind64(_Decimal64 * restrict xptr, const unsigned char encptr[restrict static 8]); void decodebind128(_Decimal128 * restrict xptr, const unsigned char encptr[restrict static 16]); #endif
Description
The decodebindN functions interpret the element array pointed to by encptr as an ISO/IEC 60559 decimalN encoding, with bits per array element, in the encoding scheme based on binary encoding of the significand. The order of bytes in the array follows the endianness specified with __STDC_ENDIAN_NATIVE__ (7.18.2). These functions convert the given encoding into a value of decimal floating type, and store the result in the object pointed to by xptr. These functions preserve the encoded value and raise no floating-point exceptions. If the encoding is non-canonical, these functions can produce a canonical representation.
Returns
The decodebindN functions return no value.
7.12.18 Comparison macros
7.12.18.1 General
The relational and equality operators support the usual mathematical relationships between numeric values. For any ordered pair of numeric values exactly one of the relationships — less, greater, and equal — is true. Relational operators may raise the "invalid" floating-point exception when argument values are NaNs. For a NaN and a numeric value, or for two NaNs, just the unordered relationship
7.12.18.2 The isgreater macro
Synopsis
#include <math.h> int isgreater(real-floatingx, real-floatingy);
Description
The isgreater macro determines whether its first argument is greater than its second argument. The value of isgreater(x,y) is always equal to (x) > (y).
However, unlike (x) > (y), isgreater(x,y) does not raise the "invalid" floating-point exception when x and y are unordered and neither is a signaling NaN.
Returns
The isgreater macro returns the value of (x) > (y).
7.12.18.3 The isgreaterequal macro
Synopsis
#include <math.h> int isgreaterequal(real-floatingx, real-floatingy);
Description
The isgreaterequal macro determines whether its first argument is greater than or equal to its second argument. The value of isgreaterequal(x,y) is always equal to (x) >= (y).
However, unlike (x) >= (y), isgreaterequal(x,y) does not raise the "invalid" floating-point exception when x and y are unordered and neither is a signaling NaN.
Returns
The isgreaterequal macro returns the value of (x) >= (y).
7.12.18.4 The isless macro
Synopsis
#include <math.h> int isless(real-floatingx, real-floatingy);
Description
The isless macro determines whether its first argument is less than its second argument. The value of isless(x,y) is always equal to (x) < (y).
However, unlike (x) < (y), isless(x,y) does not raise the "invalid" floating-point exception when x and y are unordered and neither is a signaling NaN.
Returns
The isless macro returns the value of (x) < (y).
7.12.18.5 The islessequal macro
Synopsis
#include <math.h> int islessequal(real-floatingx, real-floatingy);
Description
The islessequal macro determines whether its first argument is less than or equal to its second argument. The value of islessequal(x,y) is always equal to (x) <= (y).
However, unlike (x) <= (y), islessequal(x,y) does not raise the "invalid" floating-point exception when x and y are unordered and neither is a signaling NaN.
Returns
The islessequal macro returns the value of (x) <= (y).
7.12.18.6 The islessgreater macro
Synopsis
#include <math.h> int islessgreater(real-floatingx, real-floatingy);
Description
The islessgreater macro determines whether its first argument is less than or greater than its second argument. The islessgreater(x,y) macro is similar to (x) < (y) || (x) > (y).
However, islessgreater(x,y) does not raise the "invalid" floating-point exception when x and y are unordered and neither is a signaling NaN (nor does it evaluate x and y twice).
Returns
The islessgreater macro returns the value of (x) < (y) || (x) > (y).
7.12.18.7 The isunordered macro
Synopsis
#include <math.h> int isunordered(real-floatingx, real-floatingy);
Description
The isunordered macro determines whether its arguments are unordered. It does not raise the "invalid" floating-point exception when x and y are unordered and neither is a signaling NaN.
Returns
The isunordered macro returns 1 if its arguments are unordered and 0 otherwise.
7.12.18.8 The iseqsig macro
Synopsis
#include <math.h> int iseqsig(real-floatingx, real-floatingy);
Description
The iseqsig macro determines whether its arguments are equal. If an argument is a NaN, a domain error occurs for the macro, as if a domain error occurred for a function (7.12.2).
Returns
The iseqsig macro returns 1 if its arguments are equal and 0 otherwise.
7.13 Non-local jumps <setjmp.h>
7.13.1 General
The header <setjmp.h> defines the macros setjmp and __STDC_VERSION_SETJMP_H__, and declares one function and one type, for bypassing the normal function call and return discipline.298)
The macro
__STDC_VERSION_SETJMP_H__is an integer constant expression with a value equivalent to 202311L.
The type declared is
jmp_bufwhich is an array type suitable for holding the information needed to restore a calling environment. The environment of an invocation of the setjmp macro consists of information sufficient for a call to the longjmp function to return execution to the correct block and invocation of that block, were it called recursively. It does not include the state of the floating-point environment, of open files, or of any other component of the abstract machine.
It is unspecified whether setjmp is a macro or an identifier declared with external linkage. If a macro definition is suppressed to access an actual function, or a program defines an external identifier with the name setjmp, the behavior is undefined.
7.13.2 Save calling environment
7.13.2.1 The setjmp macro
Synopsis
Description
The setjmp macro saves its calling environment in its jmp_buf argument for later use by the longjmp function.
Returns
If the return is from a direct invocation, the setjmp macro returns the value zero. If the return is from a call to the longjmp function, the setjmp macro returns a nonzero value.
Environmental limits
An invocation of the setjmp macro shall appear only in one of the following contexts:
- the entire controlling expression of a selection or iteration statement;
- one operand of a relational or equality operator with the other operand an integer constant expression, with the resulting expression being the entire controlling expression of a selection or iteration statement;
- the operand of a unary
!operator with the resulting expression being the entire controlling expression of a selection or iteration statement; or - the entire expression of an expression statement (possibly cast to
void).
If the invocation appears in any other context, the behavior is undefined.
7.13.3 Restore calling environment
7.13.3.1 The longjmp function
Synopsis
Description
The longjmp function restores the environment saved by the most recent invocation of the setjmp macro in the same invocation of the program with the corresponding jmp_buf argument. If there has been no such invocation, or if the invocation was from another thread of execution, or if the function containing the invocation of the setjmp macro has terminated execution299) in the interim, or if the invocation of the setjmp macro was within the scope of an identifier with variably modified type and execution has left that scope in the interim, the behavior is undefined.
All accessible objects have values, and all other components of the abstract machine300) have state, as of the time the longjmp function was called, except that the representation of objects of automatic storage duration that are local to the function containing the invocation of the corresponding setjmp macro that do not have volatile-qualified type and have been changed between the setjmp invocation and longjmp call is indeterminate.
Returns
After longjmp is completed, thread execution continues as if the corresponding invocation of the setjmp macro had just returned the value specified by val. The longjmp function cannot cause the setjmp macro to return the value ; if val is 0, the setjmp macro returns the value .
EXAMPLE The longjmp function that returns control back to the point of the setjmp invocation can cause memory associated with a variable length array object to be squandered.
#include <setjmp.h> jmp_buf buf; void g(int n); void h(int n); int n = 6; void f(void) { int x[n]; // valid: ‘f‘ is not terminated setjmp(buf); g(n); } void g(int n) { int a[n]; // ‘a‘ can remain allocated h(n); } void h(int n) { int b[n]; // ‘b‘ can remain allocated longjmp(buf, 2); // can cause memory loss }
7.14 Signal handling <signal.h>
7.14.1 General
The header <signal.h> declares a type and two functions and defines several macros, for handling various signals (conditions that may be reported during program execution).
The type defined is
sig_atomic_twhich is the (possibly volatile-qualified) integer type of an object that can be accessed as an atomic entity, even in the presence of asynchronous interrupts.
The macros defined are
SIG_DFL SIG_ERR SIG_IGN
which expand to constant expressions with distinct values that have type compatible with the second argument to, and the return value of, the signal function, and whose values compare unequal to the address of any declarable function; and the following, which expand to positive integer constant expressions with type int and distinct values that are the signal numbers, each corresponding to the specified condition:
SIGABRT abnormal termination, such as is initiated by the abort function
SIGFPE an erroneous arithmetic operation, such as zero divide or an operation resulting in overflow
SIGILL detection of an invalid function image, such as an invalid instruction
SIGINT receipt of an interactive attention signal
SIGSEGV an invalid access to storage
SIGTERM a termination request sent to the program
An implementation is not required to generate any of these signals, except as a result of explicit calls to the raise function. Additional signals and pointers to undeclarable functions, with macro definitions beginning, respectively, with the letters SIG and an uppercase letter or with SIG_ and an uppercase letter,301) may also be specified by the implementation. The complete set of signals, their semantics, and their default handling is implementation-defined; all signal numbers shall be positive.
7.14.2 Specify signal handling
7.14.2.1 The signal function
Synopsis
Description
The signal function chooses one of three ways in which receipt of the signal number sig is to be subsequently handled. If the value of func is SIG_DFL, default handling for that signal will occur. If the value of func is SIG_IGN, the signal will be ignored. Otherwise, func shall point to a function to be called when that signal occurs. An invocation of such a function because of a signal, or (recursively) of any further functions called by that invocation (other than functions in the standard library),302) is called a signal handler.
When a signal occurs and func points to a function, it is implementation-defined whether the equivalent of signal(sig, SIG_DFL); is executed or the implementation prevents some implementationdefined set of signals (at least including sig) from occurring until the current signal handling has completed; in the case of SIGILL, the implementation may alternatively define that no action is taken. Then the equivalent of (*func)(sig); is executed. If and when the function returns, if the value of sig is SIGFPE, SIGILL, SIGSEGV, or any other implementation-defined value corresponding to a computational exception, the behavior is undefined; otherwise the program will resume execution at the point it was interrupted.
If the signal occurs as the result of calling the abort or raise function, the signal handler shall not call the raise function.
If the signal occurs other than as the result of calling the abort or raise function, the behavior is undefined if the signal handler refers to any object with static or thread storage duration that is not a lock-free atomic object and that is not declared with the constexpr storage-class specifier other than by assigning a value to an object declared as volatile sig_atomic_t, or the signal handler calls any function in the standard library other than
- the
abortfunction, - the
_Exitfunction, - the
quick_exitfunction, - the functions in
<stdatomic.h>(except where explicitly stated otherwise) when the atomic arguments are lock-free, - the
atomic_is_lock_freefunction with any atomic argument, or - the
signalfunction with the first argument equal to the signal number corresponding to the signal that caused the invocation of the handler. Furthermore, if such a call to thesignalfunction results in aSIG_ERRreturn, the object designated byerrnohas an indeterminate representation.303)
At program startup, the equivalent of
signal(sig, SIG_IGN);may be executed for some signals selected in an implementation-defined manner; the equivalent of
signal(sig, SIG_DFL);
is executed for all other signals defined by the implementation.
Use of this function in a multi-threaded program results in undefined behavior. The implementation shall behave as if no library function calls the signal function.
Returns
If the request can be honored, the signal function returns the value of func for the most recent successful call to signal for the specified signal sig. Otherwise, a value of SIG_ERR is returned and a positive value is stored in errno.
abort function (7.25.5.1), the exit function (7.25.5.4), the _Exit function (7.25.5.5), the quick_exit function (7.25.5.7).7.14.3 Send signal
7.14.3.1 The raise function
Synopsis
Description
The raise function carries out the actions described in 7.14.2.1 for the signal sig. If a signal handler is called, the raise function shall not return until after the signal handler does.
Returns
The raise function returns zero if successful, nonzero if unsuccessful.
7.15 Alignment <stdalign.h>
The header <stdalign.h> provides no content.
7.16 Varying arguments <stdarg.h>
7.16.1 General
The header <stdarg.h> declares a type and defines five macros and functions, for use with variadic functions.
The macro
__STDC_VERSION_STDARG_H__is an integer constant expression with a value equivalent to 202311L.
A function may be called with a variable number of arguments of varying types if its parameter type list ends with an ellipsis.
The type declared is
va_listwhich is a complete object type suitable for holding information needed by the macros va_start, va_arg, va_end, and va_copy to access the varying arguments. Objects of type va_list are generally referred to as ap in this subclause. If an ap object is passed as an argument to another function and that function invokes the va_arg macro on ap, the representation of ap in the calling function is indeterminate and ap shall be passed to the va_end macro before being passed to any other va_... macros.304) Whether a byte copy of va_list can be used in place of the original is implementation-defined.
7.16.2 Varying argument access macros
7.16.2.1 General
The va_start and va_arg macros described in this subclause shall be implemented as macros, not functions. It is unspecified whether va_copy and va_end are macros or identifiers declared with external linkage. If a macro definition is suppressed to access an actual function, or a program defines an external identifier with the same name, the behavior is undefined. Each invocation of the va_start and va_copy macros shall be matched by a corresponding invocation of the va_end macro in the same function.
The va_list argument given to every macro defined in this subclause shall be an lvalue of this type or the result of array-to-pointer decay of such an lvalue.305)
7.16.2.2 The va_arg macro
Synopsis
Description
The va_arg macro expands to an expression that has the specified type and the value of the next argument in the call. The parameter ap shall have been initialized by the va_start or va_copy macro (without an intervening invocation of the va_end macro for the same ap). Each invocation of the va_arg macro modifies ap so that the values of successive arguments are returned in turn. The behavior is undefined if there is no actual next argument. The parameter type shall be an object type name. If type is not compatible with the type of the actual next argument (as promoted according to the default argument promotions), the behavior is undefined, except for the following cases:
- both types are pointers to qualified or unqualified versions of compatible types;
Returns
The first invocation of the va_arg macro after that of the va_start macro returns the value of the first varying argument. Successive invocations return the values of the remaining arguments in succession.
7.16.2.3 The va_copy macro
Synopsis
Description
The va_copy macro initializes dest as a copy of src, as if the va_start macro had been applied to dest followed by the same sequence of uses of the va_arg macro as had previously been used to reach the present state of src. Neither the va_copy nor va_start macro shall be invoked to reinitialize dest without an intervening invocation of the va_end macro for the same dest.
Returns
The va_copy macro returns no value.
7.16.2.4 The va_end macro
Synopsis
Description
The va_end macro facilitates a normal return from the variadic function whose varying arguments were referred to by the expansion of the va_start macro, or the function containing the expansion of the va_copy macro, that initialized ap. The va_end macro may modify ap so that it is no longer usable (without being reinitialized by the va_start or va_copy macro). If there is no corresponding invocation of the va_start or va_copy macro, or if the va_end macro is not invoked before the return, the behavior is undefined.
Returns
The va_end macro returns no value.
7.16.2.5 The va_start macro
Synopsis
Description
The va_start macro may only be invoked in the compound statement of the body of a variadic function.
The va_start macro initializes ap for subsequent use by the va_arg and va_end macros. Neither the va_start nor va_copy macro shall be invoked to reinitialize ap without an intervening invocation of the va_end macro for the same ap.
Only the first argument passed to va_start is evaluated. If any additional arguments expand to include unbalanced parentheses, or a preprocessing token that does not convert to a token, the behavior is undefined.
NOTE The macro allows additional arguments to be passed for va_start for compatibility with older versions of the library only.
Returns
The va_start macro returns no value.
Recommended practice
Additional arguments beyond the first given to the va_start macro may be expanded and used in unspecified contexts where they are unevaluated. For example, an implementation diagnoses potentially erroneous input for an invocation of va_start such as:
#include <stdarg.h> void miaou (...) { va_list vl; va_start(vl, 1, 3.0, "12", xd); // diagnostic encouraged /* ... */ va_end(vl); }Simultaneously,
va_start usage consistent with older revisions of this document should not produce a diagnostic:#include <stdarg.h> void neigh (int last_arg, ...) { va_list vl; va_start(vl, last_arg); // no diagnostic /* ... */ va_end(vl); }
EXAMPLE 1 The function f1 gathers into an array a list of arguments that are pointers to strings (but not more than MAXARGS arguments), then passes the array as a single argument to function f2. The number of pointers is specified by the first argument to f1.
#include <stdarg.h> #define MAXARGS 31 void f1(int n_ptrs, ...) { va_list ap; char *array[MAXARGS]; int ptr_no = 0; if (n_ptrs > MAXARGS) n_ptrs = MAXARGS; va_start(ap); while (ptr_no < n_ptrs) array[ptr_no++] = va_arg(ap, char *); va_end(ap); f2(n_ptrs, array); } void f1(int, ...);
EXAMPLE 2 The function f3 is similar, but saves the position in the varying arguments after the indicated number of arguments; after f2 has been called once with all arguments, the trailing arguments are gathered again and passed to function f4.
#include <stdarg.h> #define MAXARGS 31 void f3(int n_ptrs, int f4_after, ...) { va_list ap, ap_save; char *array[MAXARGS]; int ptr_no = 0; if (n_ptrs > MAXARGS) n_ptrs = MAXARGS; va_start(ap); while (ptr_no < n_ptrs) { array[ptr_no++] = va_arg(ap, char *); if (ptr_no == f4_after) va_copy(ap_save, ap); } va_end(ap); f2(n_ptrs, array); // Now process the saved copy. n_ptrs -= f4_after; ptr_no = 0; while (ptr_no < n_ptrs) array[ptr_no++] = va_arg(ap_save, char *); va_end(ap_save); f4(n_ptrs, array); }
EXAMPLE 3 The function f5 is similar to f1, but instead of passing an explicit number of strings as the first argument, the varying arguments are terminated with a null pointer.
#include <stdarg.h> #define MAXARGS 31 void f5(...) { va_list ap; char *array[MAXARGS]; int ptr_no = 0; va_start(ap); while (ptr_no < MAXARGS) { char *ptr = va_arg(ap, char *); if (!ptr) break; array[ptr_no++] = ptr; } va_end(ap); f6(ptr_no, array); } void f5(...);
7.17 Atomics <stdatomic.h>
7.17.1 Introduction
The header <stdatomic.h> defines several macros and declares several types and functions for performing atomic operations on data shared between threads.307)
Implementations that define the macro __STDC_NO_ATOMICS__ may not provide this header nor support any of its facilities.
The macro
__STDC_VERSION_STDATOMIC_H__is an integer constant expression with a value equivalent to 202311L.
The macros defined are the atomic lock-free macros
ATOMIC_BOOL_LOCK_FREE ATOMIC_CHAR_LOCK_FREE ATOMIC_CHAR8_T_LOCK_FREE ATOMIC_CHAR16_T_LOCK_FREE ATOMIC_CHAR32_T_LOCK_FREE ATOMIC_WCHAR_T_LOCK_FREE ATOMIC_SHORT_LOCK_FREE ATOMIC_INT_LOCK_FREE ATOMIC_LONG_LOCK_FREE ATOMIC_LLONG_LOCK_FREE ATOMIC_POINTER_LOCK_FREEwhich expand to constant expressions suitable for use in conditional expression inclusion preprocessing directives and which indicate the lock-free property of the corresponding atomic types (both signed and unsigned); and
ATOMIC_FLAG_INITwhich expands to an initializer for an object of type atomic_flag.
The types include
memory_orderwhich is an enumerated type whose enumerators identify memory ordering constraints;atomic_flagwhich is a structure type representing a lock-free, primitive atomic flag; and several atomic analogs of integer types.
In the following synopses:
- An
Arefers to an atomic type. - A
Crefers to its corresponding non-atomic type. - An
Mrefers to the type of the other argument for arithmetic operations. For atomic integer types,MisC. For atomic pointer types,Misptrdiff_t. - The functions not ending in
_explicithave the same semantics as the corresponding
_explicit function with memory_order_seq_cst for the memory_order argument.
It is unspecified whether any generic function declared in <stdatomic.h> is a macro or an identifier declared with external linkage. If a macro definition is suppressed to access an actual function, or a program defines an external identifier with the name of a generic function, the behavior is undefined.
NOTE Many operations are volatile-qualified. The "volatile as device register" semantics have not changed in the standard. This qualification means that volatility is preserved when applying these operations to volatile objects.
7.17.2 Initialization
7.17.2.1 General
An atomic object with automatic storage duration that is not initialized or such an object with allocated storage duration initially has an indeterminate representation; equally, a non-atomic store to any byte of the representation (either directly or, for example, by calls to memcpy or memset) makes any atomic object have an indeterminate representation. Explicit or default initialization for atomic objects with static or thread storage duration that do not have the type atomic_flag is guaranteed to produce a valid state.308)
Concurrent access to an atomic object before it is set to a valid state, even via an atomic operation, constitutes a data race. If a signal occurs other than as the result of calling the abort or raise functions, the behavior is undefined if the signal handler reads or modifies an atomic object that has an indeterminate representation.
EXAMPLE The following definition ensure valid states for guide and head regardless if these are found in file scope or block scope. Thus any atomic operation that is performed on them after their initialization has been met is well defined.
_Atomic int guide = 42; static _Atomic(void*) head;
7.17.2.2 The atomic_init generic function
Synopsis
#include <stdatomic.h> void atomic_init(volatile A *obj, C value);
Description
The atomic_init generic function initializes the atomic object pointed to by obj to the value value, while also initializing any additional state that the implementation may need to carry for the atomic object. If the object is a byte array, after the call the effective type is the atomic type A.
Although this function initializes an atomic object, it does not avoid data races; concurrent access to the object being initialized, even via an atomic operation, constitutes a data race.
If a signal occurs other than as the result of calling the abort or raise functions, the behavior is undefined if the signal handler calls the atomic_init generic function.
Returns
The atomic_init generic function returns no value.
7.17.3 Order and consistency
7.17.3.1 General
The enumerated type memory_order specifies the detailed regular (non-atomic) memory synchronization operations as defined in 5.2.2.5 and may provide for operation ordering. Its enumeration constants are as follows:309)
memory_order_relaxed memory_order_consume memory_order_acquire memory_order_release memory_order_acq_rel memory_order_seq_cst
For memory_order_relaxed, no operation orders memory.
For memory_order_release, memory_order_acq_rel, and memory_order_seq_cst, a store operation performs a release operation on the affected memory location.
For memory_order_acquire, memory_order_acq_rel, and memory_order_seq_cst, a load operation performs an acquire operation on the affected memory location.
For memory_order_consume, a load operation performs a consume operation on the affected memory location.
There shall be a single total order on all memory_order_seq_cst operations, consistent with the "happens before" order and modification orders for all affected locations, such that each
memory_order_seq_cst operation that loads a value from an atomic object observes one of the following values:
- the result of the last modification of that precedes in , if it exists, or
- if exists, the result of some modification of that is not
memory_order_seq_cstand that does not happen before , or - if does not exist, the result of some modification of that is not
memory_order_seq_cst.
NOTE 1 Although it is not explicitly required that include lock operations, it can always be extended to an order that does include lock and unlock operations, as the ordering between those is already included in the "happens before" ordering.
NOTE 2 Atomic operations specifying memory_order_relaxed are relaxed only with respect to memory ordering. Implementations still guarantee that any given atomic access to a particular atomic object is indivisible with respect to all other atomic accesses to that object.
For an atomic operation that reads the value of an atomic object , if there is a memory_order_seq_cst fence sequenced before , then observes either the last memory_order_seq_cst modification of preceding in the total order or a later modification of in its modification order.
For atomic operations and on an atomic object , where modifies and takes its value, if there is a memory_order_seq_cst fence such that is sequenced before and follows in , then observes either the effects of or a later modification of in its modification order.
For atomic modifications and of an atomic object , occurs later than in the modification order of if:
- there is a
memory_order_seq_cstfence such that is sequenced before , and precedes in , or - there is a
memory_order_seq_cstfence such that is sequenced before , and A precedes in , or
Atomic read-modify-write operations shall always read the last value (in the modification order) stored before the write associated with the read-modify-write operation.
An atomic store shall only store a value that has been computed from constants and program input values by a finite sequence of program evaluations, such that each evaluation observes the stored values of the objects as computed by the last prior assignment in the sequence. The ordering of evaluations in this sequence shall be such that
- If an evaluation observes a value computed by in a different thread, then does not happen before .
- If an evaluation is included in the sequence, then all evaluations that assign to the same object and happen before are also included.
NOTE 3 The second requirement disallows "out-of-thin-air", or "speculative" stores of atomics when relaxed atomics are used. Because unordered operations are involved, evaluations can appear in this sequence out of thread order. For example, with x and y initially zero,
// Thread 1: r1 = atomic_load_explicit(&y, memory_order_relaxed); atomic_store_explicit(&x, r1, memory_order_relaxed); // Thread 2: r2 = atomic_load_explicit(&x, memory_order_relaxed); atomic_store_explicit(&y, 42, memory_order_relaxed);is allowed to produce
r1 == 42 && r2 == 42. The sequence of evaluations justifying this consists of:atomic_store_explicit(&y, 42, memory_order_relaxed); r1 = atomic_load_explicit(&y, memory_order_relaxed); atomic_store_explicit(&x, r1, memory_order_relaxed); r2 = atomic_load_explicit(&x, memory_order_relaxed);On the other hand,
// Thread 1: r1 = atomic_load_explicit(&y, memory_order_relaxed); atomic_store_explicit(&x, r1, memory_order_relaxed); // Thread 2: r2 = atomic_load_explicit(&x, memory_order_relaxed); atomic_store_explicit(&y, r2, memory_order_relaxed);
is not allowed to produce r1 == 42 && r2 == 42 because there is no sequence of evaluations that results in the computation of 42. In the absence of "relaxed" operations and read-modify-write operations with weaker than memory_order_acq_rel ordering, the second requirement has no impact.
Recommended practice
The requirements do not forbid r1 == 42 && r2 == 42 in the following example, with x and y initially zero:
// Thread 1: r1 = atomic_load_explicit(&x, memory_order_relaxed); if (r1 == 42) atomic_store_explicit(&y, r1, memory_order_relaxed); // Thread 2: r2 = atomic_load_explicit(&y, memory_order_relaxed); if (r2 == 42) atomic_store_explicit(&x, 42, memory_order_relaxed);
Implementations should make atomic stores visible to atomic loads within a reasonable amount of time.
7.17.3.2 The kill_dependency macro
Synopsis
#include <stdatomic.h> type kill_dependency(type y);
Description
The kill_dependency macro terminates a dependency chain; the argument does not carry a dependency to the return value.
Returns
The kill_dependency macro returns the value of y.
7.17.4 Fences
7.17.4.1 General
This subclause introduces synchronization primitives called fences. Fences can have acquire semantics, release semantics, or both. A fence with acquire semantics is called an acquire fence; a fence with release semantics is called a release fence.
A release fence synchronizes with an acquire fence if there exist atomic operations and , both operating on some atomic object , such that is sequenced before , modifies , is sequenced before , and reads the value written by or a value written by any side effect in the hypothetical release sequence would head if it were a release operation.
A release fence synchronizes with an atomic operation that performs an acquire operation on an atomic object if there exists an atomic operation such that is sequenced before , modifies , and reads the value written by or a value written by any side effect in the hypothetical release sequence would head if it were a release operation.
An atomic operation that is a release operation on an atomic object synchronizes with an acquire fence if there exists some atomic operation on such that is sequenced before and reads the value written by or a value written by any side effect in the release sequence headed by .
7.17.4.2 The atomic_thread_fence function
Synopsis
#include <stdatomic.h> void atomic_thread_fence(memory_order order);
Description
Depending on the value of order, this operation:
- has no effects, if
order== memory_order_relaxed; - is an acquire fence, if
order== memory_order_acquireor
order == memory_order_consume;
- is a release fence, if
order== memory_order_release; - is both an acquire fence and a release fence, if
order== memory_order_acq_rel;
Returns
The atomic_thread_fence function returns no value.
7.17.4.3 The atomic_signal_fence function
Synopsis
#include <stdatomic.h> void atomic_signal_fence(memory_order order);
Description
Equivalent to atomic_thread_fence(order), except that the resulting ordering constraints are established only between a thread and a signal handler executed in the same thread.
NOTE 1 The atomic_signal_fence function can be used to specify the order in which actions performed by the thread become visible to the signal handler.
NOTE 2 Compiler optimizations and reorderings of loads and stores are inhibited in the same way as with atomic_thread_fence, but the hardware fence instructions that atomic_thread_fence would have inserted are not emitted.
Returns
The atomic_signal_fence function returns no value.
7.17.5 Lock-free property
7.17.5.1 General
The atomic lock-free macros indicate the lock-free property of integer and address atomic types. A value of indicates that the type is never lock-free; a value of indicates that the type is sometimes lock-free; a value of indicates that the type is always lock-free.
Recommended practice
Operations that are lock-free should also be address-free. That is, atomic operations on the same memory location via two different addresses will communicate atomically. The implementation should not depend on any per-process state. This restriction enables communication via memory mapped into a process more than once and memory shared between two processes.
7.17.5.2 The atomic_is_lock_free generic function
Synopsis
#include <stdatomic.h> bool atomic_is_lock_free(const volatile A *obj);
Description
The atomic_is_lock_free generic function indicates whether atomic operations on objects of the type pointed to by obj are lock-free.
Returns
The atomic_is_lock_free generic function returns nonzero (true) if and only if atomic operations on objects of the type pointed to by the argument are lock-free. In any given program execution, the result of the lock-free query shall be consistent for all pointers of the same type.310)
7.17.6 Atomic integer types
For each line in Table 7.6,311) the atomic type name is declared as a type that has the same representation and alignment requirements as the corresponding direct type.312)
Table 7.6 — Type name equivalency
Atomic type name Direct type atomic_bool _Atomic bool atomic_char _Atomic char atomic_schar _Atomic signed char atomic_uchar _Atomic unsigned char atomic_short _Atomic short atomic_ushort _Atomic unsigned short atomic_int _Atomic int atomic_uint _Atomic unsigned int atomic_long _Atomic long atomic_ulong _Atomic unsigned long atomic_llong _Atomic long long atomic_ullong _Atomic unsigned long long atomic_char8_t _Atomic char8_t atomic_char16_t _Atomic char16_t atomic_char32_t _Atomic char32_t atomic_wchar_t _Atomic wchar_t atomic_int_least8_t _Atomic int_least8_t atomic_uint_least8_t _Atomic uint_least8_t atomic_int_least16_t _Atomic int_least16_t atomic_uint_least16_t _Atomic uint_least16_t atomic_int_least32_t _Atomic int_least32_t atomic_uint_least32_t _Atomic uint_least32_t atomic_int_least64_t _Atomic int_least64_t atomic_uint_least64_t _Atomic uint_least64_t atomic_int_fast8_t _Atomic int_fast8_t atomic_uint_fast8_t _Atomic uint_fast8_t atomic_int_fast16_t _Atomic int_fast16_t atomic_uint_fast16_t _Atomic uint_fast16_t atomic_int_fast32_t _Atomic int_fast32_t atomic_uint_fast32_t _Atomic uint_fast32_t atomic_int_fast64_t _Atomic int_fast64_t atomic_uint_fast64_t _Atomic uint_fast64_t atomic_intptr_t _Atomic intptr_t atomic_uintptr_t _Atomic uintptr_t atomic_size_t _Atomic size_t atomic_ptrdiff_t _Atomic ptrdiff_t atomic_intmax_t _Atomic intmax_t atomic_uintmax_t _Atomic uintmax_t
Conversions to atomic_bool behave the same as conversions to bool.
Recommended practice
The representation of an atomic integer type is not required to have the same size as the corresponding regular type but it should have the same size whenever possible, as it eases effort required to port existing code.
7.17.7 Operations on atomic types
7.17.7.1 General
There are only a few kinds of operations on atomic types, though there are many instances of those kinds. This subclause specifies each general kind.
7.17.7.2 The atomic_store generic functions
Synopsis
#include <stdatomic.h> void atomic_store(volatile A *object, C desired); void atomic_store_explicit(volatile A *object, C desired, memory_order order);
Description
The order argument shall not be memory_order_acquire, memory_order_consume, nor memory_order_acq_rel. Atomically replace the value pointed to by object with the value of desired. Memory is affected according to the value of order.
Returns
The atomic_store generic functions return no value.
7.17.7.3 The atomic_load generic functions
Synopsis
#include <stdatomic.h> C atomic_load(const volatile A *object); C atomic_load_explicit(const volatile A *object, memory_order order);
Description
The order argument shall not be memory_order_release nor memory_order_acq_rel. Memory is affected according to the value of order.
Returns
Atomically returns the value pointed to by object.
7.17.7.4 The atomic_exchange generic functions
Synopsis
#include <stdatomic.h> C atomic_exchange(volatile A *object, C desired); C atomic_exchange_explicit(volatile A *object, C desired, memory_order order);
Description
Atomically replace the value pointed to by object with desired. Memory is affected according to the value of order. These operations are read-modify-write operations (5.2.2.5).
Returns
Atomically returns the value pointed to by object immediately before the effects.
7.17.7.5 The atomic_compare_exchange generic functions
Synopsis
#include <stdatomic.h> bool atomic_compare_exchange_strong(volatile A *object, C *expected, C desired); bool atomic_compare_exchange_strong_explicit(volatile A *object, C *expected, C desired, memory_order success, memory_order failure); bool atomic_compare_exchange_weak(volatile A *object, C *expected, C desired); bool atomic_compare_exchange_weak_explicit(volatile A *object, C *expected, C desired, memory_order success, memory_order failure);
Description
The failure argument shall not be memory_order_release nor memory_order_acq_rel. The failure argument shall be no stronger than the success argument.
Atomically, compares the contents of the memory pointed to by object for equality with that pointed to by expected, and if true, replaces the contents of the memory pointed to by object with desired, and if false, updates the contents of the memory pointed to by expected with that pointed to by object. Further, if the comparison is true, memory is affected according to the value of success, and if the comparison is false, memory is affected according to the value of failure. These operations are atomic read-modify-write operations (5.2.2.5).
NOTE 1 For example, the effect of atomic_compare_exchange_strong is
if (memcmp(object, expected, sizeof(*object)) == 0) memcpy(object, &desired, sizeof(*object)); else memcpy(expected, object, sizeof(*object));
A weak compare-and-exchange operation can fail spuriously. That is, even when the contents of memory referred to by expected and object are equal, it can return zero and store back to expected the same memory contents that were originally there.
NOTE 2 This spurious failure enables implementation of compare-and-exchange on a broader class of machines; e.g. load-locked store-conditional machines.
EXAMPLE A consequence of spurious failure is that nearly all uses of weak compare-and-exchange will be in a loop.
exp = atomic_load(&cur); do { des = function(exp); } while (!atomic_compare_exchange_weak(&cur, &exp, des));
When a compare-and-exchange is in a loop, the weak version will yield better performance on some platforms. When a weak compare-and-exchange would require a loop and a strong one would not, the strong one is preferable.
Returns
The result of the comparison.
7.17.7.6 The atomic_fetch and modify generic functions
The following operations perform arithmetic and bitwise computations. All these operations are applicable to an object of any atomic integer type other than _Atomic bool, atomic_bool, or the atomic version of an enumeration with underlying type bool. The key, operator, and computation correspondence is:
key op computation add + addition sub - subtraction or | bitwise inclusive or xor ^ bitwise exclusive or and & bitwise and
Synopsis
#include <stdatomic.h> C atomic_fetch_key(volatile A *object, M operand); C atomic_fetch_key_explicit(volatile A *object, M operand, memory_order order);
Description
Atomically replaces the value pointed to by object with the result of the computation applied to the value pointed to by object and the given operand. Memory is affected according to the value of order. These operations are atomic read-modify-write operations (5.2.2.5). For signed integer types, arithmetic performs silent wraparound on integer overflow; there are no undefined results. For address types, the result may be an undefined address, but the operations otherwise have no undefined behavior.
Returns
Atomically, the value pointed to by object immediately before the effects.
7.17.8 Atomic flag type and operations
7.17.8.1 General
The atomic_flag type provides the classic test-and-set functionality. It has two states, set and clear.
Operations on an object of type atomic_flag shall be lock free.
NOTE Hence, as per 7.17.5, the operations should also be address-free. No other type requires lock-free operations, so the atomic_flag type is the minimum hardware-implemented type needed to conform to this document. The remaining types can be emulated with atomic_flag, though with less than ideal properties.
The macro ATOMIC_FLAG_INIT can be used to initialize an atomic_flag to the clear state. An atomic_flag that is not explicitly initialized with ATOMIC_FLAG_INIT has initially an indeterminate representation.
7.17.8.2 The atomic_flag_test_and_set functions
Synopsis
#include <stdatomic.h> bool atomic_flag_test_and_set(volatile atomic_flag *object); bool atomic_flag_test_and_set_explicit(volatile atomic_flag *object, memory_order order);
Description
Atomically places the atomic flag pointed to by object in the set state and returns the value corresponding to the immediately preceding state. Memory is affected according to the value of order. These operations are atomic read-modify-write operations (5.2.2.5).
Returns
The atomic_flag_test_and_set functions return the value that corresponds to the state of the atomic flag immediately before the effects. The return value true corresponds to the set state and the return value false corresponds to the clear state.
7.17.8.3 The atomic_flag_clear functions
Synopsis
#include <stdatomic.h> void atomic_flag_clear(volatile atomic_flag *object); void atomic_flag_clear_explicit(volatile atomic_flag *object, memory_order order);
Description
The order argument shall not be memory_order_acquire nor memory_order_acq_rel. Atomically places the atomic flag pointed to by object into the clear state. Memory is affected according to the value of order.
Returns
The atomic_flag_clear functions return no value.
7.18 Bit and byte utilities <stdbit.h>
7.18.1 General
The header <stdbit.h> defines the following macros, types, and functions, to work with the byte and bit representation of many types, typically integer types. This header makes available the size_t type name (7.22) and any uintN_t, intN_t, uint_leastN_t, or int_leastN_t type names defined by the implementation (7.23).
The macro
__STDC_VERSION_STDBIT_H__is an integer constant expression with a value equivalent to 202ymmL.
The most significant index is the 0-based index counting from the most significant bit, , to the least significant bit, , where is the width of the type that is having its most significant index computed.
The least significant index is the 0-based index counting from the least significant bit, 0, to the most significant bit, , where is the width of the type that is having its least significant index computed.
It is unspecified whether any generic function declared in <stdbit.h> is a macro or an identifier declared with external linkage. If a macro definition is suppressed to access an actual function, or a program defines an external identifier with the name of a generic function, the behavior is unspecified.
7.18.2 Endian
Two common methods of byte ordering in multi-byte scalar types are little-endian and big-endian. Little-endian is a format for storage or transmission of binary data in which the least significant byte is placed first, with the rest in ascending order. Or, that the least significant byte is stored at the smallest memory address. Big-endian is a format for storage or transmission of binary data in which the most significant byte is placed first, with the rest in descending order. Or, that the most significant byte is stored at the smallest memory address. Other byte orderings are also possible.
The macros are:
__STDC_ENDIAN_LITTLE__which represents a method of byte order storage in which the least significant byte is placed first and the rest are in ascending order, and is an integer constant expression;__STDC_ENDIAN_BIG__which represents a method of byte order storage in which the most significant byte is placed first and the rest are in descending order, and is an integer constant expression;__STDC_ENDIAN_NATIVE__ /* see following description */
which represents the method of byte order storage for the execution environment and is an integer constant expression. __STDC_ENDIAN_NATIVE__ describes the endianness of the execution environment with respect to bit-precise integer types, standard integer types, and extended integer types which do not have padding bits.
__STDC_ENDIAN_NATIVE__ shall expand to an integer constant expression whose value is equivalent to the value of __STDC_ENDIAN_LITTLE__ if the execution environment is littleendian. Otherwise, __STDC_ENDIAN_NATIVE__ shall expand to an integer constant expression whose value is equivalent to the value of __STDC_ENDIAN_BIG__ if the execution environment is big-endian. If the execution environment is neither little-endian nor big-endian, it then has some other implementation-defined byte order and the macro __STDC_ENDIAN_NATIVE__ shall expand to an integer constant expression whose value is different from the values of
7.18.3 Count Leading Zeros
Synopsis
#include <stdbit.h> unsigned int stdc_leading_zeros_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_leading_zeros_us(unsigned short value) [[unsequenced]]; unsigned int stdc_leading_zeros_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_leading_zeros_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_leading_zeros_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_leading_zeros(generic_value_type value) [[unsequenced]];
Returns
Returns the number of consecutive 0 bits in value, starting from the most significant bit.
The type-generic function (marked by its generic_value_type argument) returns the appropriate value based on the type of the input value, so long as it is a:
- standard unsigned integer type, excluding
bool; - extended unsigned integer type;
- or, bit-precise unsigned integer type whose width matches a standard or extended integer type, excluding
bool.
The generic_return_type type shall be a suitably large unsigned integer type capable of representing the computed result.
7.18.4 Count Leading Ones
Synopsis
#include <stdbit.h> unsigned int stdc_leading_ones_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_leading_ones_us(unsigned short value) [[unsequenced]]; unsigned int stdc_leading_ones_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_leading_ones_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_leading_ones_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_leading_ones(generic_value_type value) [[unsequenced]];
Returns
Returns the number of consecutive 1 bits in value, starting from the most significant bit.
The type-generic function (marked by its generic_value_type argument) returns the appropriate value based on the type of the input value, so long as it is a:
- standard unsigned integer type, excluding
bool; - extended unsigned integer type;
- or, bit-precise unsigned integer type whose width matches a standard or extended integer type, excluding
bool.
The generic_return_type type shall be a suitably large unsigned integer type capable of representing the computed result.
7.18.5 Count Trailing Zeros
Synopsis
#include <stdbit.h> unsigned int stdc_trailing_zeros_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_trailing_zeros_us(unsigned short value) [[unsequenced]]; unsigned int stdc_trailing_zeros_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_trailing_zeros_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_trailing_zeros_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_trailing_zeros(generic_value_type value) [[unsequenced]];
Returns
Returns the number of consecutive 0 bits in value, starting from the least significant bit.
The type-generic function (marked by its generic_value_type argument) returns the appropriate value based on the type of the input value, so long as it is a:
- standard unsigned integer type, excluding
bool; - extended unsigned integer type;
- or, bit-precise unsigned integer type whose width matches a standard or extended integer type, excluding
bool.
The generic_return_type type shall be a suitably large unsigned integer type capable of representing the computed result.
7.18.6 Count Trailing Ones
Synopsis
#include <stdbit.h> unsigned int stdc_trailing_ones_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_trailing_ones_us(unsigned short value) [[unsequenced]]; unsigned int stdc_trailing_ones_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_trailing_ones_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_trailing_ones_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_trailing_ones(generic_value_type value) [[unsequenced]];
Returns
Returns the number of consecutive 1 bits in value, starting from the least significant bit.
The type-generic function (marked by its generic_value_type argument) returns the appropriate value based on the type of the input value, so long as it is a:
- standard unsigned integer type, excluding
bool; - extended unsigned integer type;
- or, bit-precise unsigned integer type whose width matches a standard or extended integer type, excluding
bool.
The generic_return_type type shall be a suitably large unsigned integer type capable of representing the computed result.
7.18.7 First Leading Zero
Synopsis
#include <stdbit.h> unsigned int stdc_first_leading_zero_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_first_leading_zero_us(unsigned short value) [[unsequenced]]; unsigned int stdc_first_leading_zero_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_first_leading_zero_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_first_leading_zero_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_first_leading_zero(generic_value_type value) [[unsequenced]];
Returns
Returns the most significant index of the first 0 bit in value, plus 1. If it is not found, this function returns 0.
The type-generic function (marked by its generic_value_type argument) returns the appropriate value based on the type of the input value, so long as it is a:
- standard unsigned integer type, excluding
bool; - extended unsigned integer type;
- or, bit-precise unsigned integer type whose width matches a standard or extended integer type, excluding
bool.
The generic_return_type type shall be a suitably large unsigned integer type capable of representing the computed result.
7.18.8 First Leading One
Synopsis
#include <stdbit.h> unsigned int stdc_first_leading_one_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_first_leading_one_us(unsigned short value) [[unsequenced]]; unsigned int stdc_first_leading_one_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_first_leading_one_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_first_leading_one_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_first_leading_one(generic_value_type value) [[unsequenced]];
Returns
Returns the most significant index of the first 1 bit in value, plus 1. If it is not found, this function returns 0.
The type-generic function (marked by its generic_value_type argument) returns the appropriate value based on the type of the input value, so long as it is a:
- standard unsigned integer type, excluding
bool; - extended unsigned integer type;
- or, bit-precise unsigned integer type whose width matches a standard or extended integer type, excluding
bool.
The generic_return_type type shall be a suitably large unsigned integer type capable of representing the computed result.
7.18.9 First Trailing Zero
Synopsis
#include <stdbit.h> unsigned int stdc_first_trailing_zero_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_first_trailing_zero_us(unsigned short value) [[unsequenced]]; unsigned int stdc_first_trailing_zero_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_first_trailing_zero_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_first_trailing_zero_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_first_trailing_zero(generic_value_type value) [[unsequenced]];
Returns
Returns the least significant index of the first 0 bit in value, plus 1. If it is not found, this function returns 0.
The type-generic function (marked by its generic_value_type argument) returns the appropriate value based on the type of the input value, so long as it is a:
- standard unsigned integer type, excluding
bool; - extended unsigned integer type;
- or, bit-precise unsigned integer type whose width matches a standard or extended integer type, excluding
bool.
The generic_return_type type shall be a suitably large unsigned integer type capable of representing the computed result.
7.18.10 First Trailing One
Synopsis
#include <stdbit.h> unsigned int stdc_first_trailing_one_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_first_trailing_one_us(unsigned short value) [[unsequenced]]; unsigned int stdc_first_trailing_one_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_first_trailing_one_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_first_trailing_one_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_first_trailing_one(generic_value_type value) [[unsequenced]];
Returns
Returns the least significant index of the first 1 bit in value, plus 1. If it is not found, this function returns 0.
The type-generic function (marked by its generic_value_type argument) returns the appropriate value based on the type of the input value, so long as it is a:
- standard unsigned integer type, excluding
bool; - extended unsigned integer type;
- or, bit-precise unsigned integer type whose width matches a standard or extended integer type, excluding
bool.
The generic_return_type type shall be a suitably large unsigned integer type capable of representing the computed result.
7.18.11 Count Zeros
Synopsis
#include <stdbit.h> unsigned int stdc_count_zeros_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_count_zeros_us(unsigned short value) [[unsequenced]]; unsigned int stdc_count_zeros_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_count_zeros_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_count_zeros_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_count_zeros(generic_value_type value) [[unsequenced]];
Returns
Returns the total number of 0 bits within the given value.
The type-generic function (marked by its generic_value_type argument) returns the previously described result for a given input value so long as the generic_value_type is a:
- standard unsigned integer type, excluding
bool; - extended unsigned integer type;
- or, bit-precise unsigned integer type whose width matches a standard or extended integer type, excluding
bool.
The generic_return_type type shall be a suitably large unsigned integer type capable of representing the computed result.
7.18.12 Count Ones
Synopsis
#include <stdbit.h> unsigned int stdc_count_ones_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_count_ones_us(unsigned short value) [[unsequenced]]; unsigned int stdc_count_ones_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_count_ones_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_count_ones_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_count_ones(generic_value_type value) [[unsequenced]];
Returns
Returns the total number of 1 bits within the given value.
The type-generic function (marked by its generic_value_type argument) returns the previously described result for a given input value so long as the generic_value_type is a:
- standard unsigned integer type, excluding
bool; - extended unsigned integer type;
- or, bit-precise unsigned integer type whose width matches a standard or extended integer type, excluding
bool.
The generic_return_type type shall be a suitably large unsigned integer type capable of representing the computed result.
7.18.13 Single-bit Check
Synopsis
#include <stdbit.h> bool stdc_has_single_bit_uc(unsigned char value) [[unsequenced]]; bool stdc_has_single_bit_us(unsigned short value) [[unsequenced]]; bool stdc_has_single_bit_ui(unsigned int value) [[unsequenced]]; bool stdc_has_single_bit_ul(unsigned long int value) [[unsequenced]]; bool stdc_has_single_bit_ull(unsigned long long int value) [[unsequenced]]; bool stdc_has_single_bit(generic_value_type value) [[unsequenced]];
Returns
The stdc_has_single_bit functions return true if and only if there is a single 1 bit in value.
The type-generic function (marked by its generic_value_type argument) returns the previously described result for a given input value so long as the generic_value_type is a:
- standard unsigned integer type, excluding
bool; - extended unsigned integer type;
- or, bit-precise unsigned integer type whose width matches a standard or extended integer type, excluding
bool.
7.18.14 Bit Width
Synopsis
#include <stdbit.h> unsigned int stdc_bit_width_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_bit_width_us(unsigned short value) [[unsequenced]]; unsigned int stdc_bit_width_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_bit_width_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_bit_width_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_bit_width(generic_value_type value) [[unsequenced]];
Description
The stdc_bit_width functions compute the smallest number of bits needed to store value.
Returns
The stdc_bit_width functions return 0 if value is 0. Otherwise, they return .
The type-generic function (marked by its generic_value_type argument) returns the previously described result for a given input value so long as the generic_value_type is a:
- standard unsigned integer type, excluding
bool; - extended unsigned integer type;
- or, bit-precise unsigned integer type whose width matches a standard or extended integer type, excluding
bool.
The generic_return_type type shall be a suitably large unsigned integer type capable of representing the computed result.
7.18.15 Bit Floor
Synopsis
#include <stdbit.h> unsigned char stdc_bit_floor_uc(unsigned char value) [[unsequenced]]; unsigned short stdc_bit_floor_us(unsigned short value) [[unsequenced]]; unsigned int stdc_bit_floor_ui(unsigned int value) [[unsequenced]]; unsigned long int stdc_bit_floor_ul(unsigned long int value) [[unsequenced]]; unsigned long long int stdc_bit_floor_ull(unsigned long long int value) [[unsequenced]]; generic_value_type stdc_bit_floor(generic_value_type value) [[unsequenced]];
Description
The stdc_bit_floor functions compute the largest integral power of 2 that is not greater than value.
Returns
The stdc_bit_floor functions return 0 if value is 0. Otherwise, they return the largest integral power of 2 that is not greater than value.
The type-generic function (marked by its generic_value_type argument) returns the previously described result for a given input value so long as the generic_value_type is a:
- standard unsigned integer type, excluding
bool; - extended unsigned integer type;
- or, bit-precise unsigned integer type whose width matches a standard or extended integer type, excluding
bool.
7.18.16 Bit Ceiling
Synopsis
#include <stdbit.h> unsigned char stdc_bit_ceil_uc(unsigned char value) [[unsequenced]]; unsigned short stdc_bit_ceil_us(unsigned short value) [[unsequenced]]; unsigned int stdc_bit_ceil_ui(unsigned int value) [[unsequenced]]; unsigned long int stdc_bit_ceil_ul(unsigned long int value) [[unsequenced]]; unsigned long long int stdc_bit_ceil_ull(unsigned long long int value) [[unsequenced]]; generic_value_type stdc_bit_ceil(generic_value_type value) [[unsequenced]];
Description
The stdc_bit_ceil functions compute the smallest integral power of 2 that is not less than value. If the computation does not fit in the given return type, they return 0.
Returns
The stdc_bit_ceil functions return the smallest integral power of 2 that is not less than value or 0 if such a value is not representable in the return type.
The type-generic function (marked by its generic_value_type argument) returns the previously described result for a given input value so long as the generic_value_type is a:
- standard unsigned integer type, excluding
bool; - extended unsigned integer type;
- or, bit-precise unsigned integer type whose width matches a standard or extended integer type, excluding
bool.
7.18.17 Rotate Left
Synopsis
#include <stdbit.h> unsigned char stdc_rotate_left_uc(unsigned char value, unsigned int count); unsigned short stdc_rotate_left_us(unsigned short value, unsigned int count); unsigned int stdc_rotate_left_ui(unsigned int value, unsigned int count); unsigned long stdc_rotate_left_ul(unsigned long value, unsigned int count); unsigned long long stdc_rotate_left_ull(unsigned long long value, unsigned int count); generic_value_type stdc_rotate_left( generic_value_type value, generic_count_type count);
Description
The stdc_rotate_left functions perform a bitwise rotate left. This operation is typically known as a left circular shift.
Returns
Let be the width corresponding to the type of the input value. Let no_promote_value be (unsigned _BitInt(N))value. Let be count .
- If is 0, returns
value; - otherwise, returns
(no_promote_value<<| (no_promote_value>> ()).313)
The type-generic function (marked by its generic_value_type argument) returns the above described result for a given input value so long as the generic_value_type is:
- a standard unsigned integer type, excluding
bool; - an extended unsigned integer type;
- or, a bit-precise unsigned integer type whose width matches any standard or extended integer type, excluding
bool.
The generic_count_type count argument shall be a non-negative value of signed or unsigned integer type, or char.
7.18.18 Rotate Right
Synopsis
#include <stdbit.h> unsigned char stdc_rotate_right_uc(unsigned char value, unsigned int count); unsigned short stdc_rotate_right_us(unsigned short value, unsigned int count); unsigned int stdc_rotate_right_ui(unsigned int value, unsigned int count); unsigned long stdc_rotate_right_ul(unsigned long value, unsigned int count); unsigned long long stdc_rotate_right_ull(unsigned long long value, unsigned int count); generic_value_type stdc_rotate_right(generic_value_type value, generic_count_type count);
Description
The stdc_rotate_right functions perform a bitwise rotate right. This operation is typically known as a right circular shift.
Returns
Let be the width corresponding to the type of the input value. Let no_promote_value be (unsigned _BitInt(N))value. Let be count .
- If is 0, returns
value; - otherwise, returns
(no_promote_value>>| (no_promote_value<< ()).314)
The type-generic function (marked by its generic_value_type argument) returns the above described result for a given input value so long as the generic_value_type is:
- a standard unsigned integer type, excluding
bool; - an extended unsigned integer type;
- or, a bit-precise unsigned integer type whose width matches any standard or extended integer type, excluding
bool.
The generic_count_type count argument shall be a non-negative value of signed or unsigned integer type, or char.
7.18.19 8-bit Memory Reversal
Synopsis
#include <stdbit.h> #include <limits.h> #if CHAR_BIT == 8 void stdc_memreverse8(size_t n, unsigned char ptr[static n]); #endif
Description
The stdc_memreverse8 function reverses the order of the bytes pointed to by ptr. For every unsigned char at offset index in the range 0 <= index && index < n/2, swap the values at ptr[index] and ptr[n - index - 1].
7.18.20 Exact-width 8-bit Memory Reversal
Synopsis
#include <stdbit.h> #include <limits.h> #include <stdint.h> #if CHAR_BIT == 8 uintN_t stdc_memreverse8uN(uintN_t value); #endif
Description
The stdc_memreverse8N functions provide an interface to swap the bytes of a corresponding uintN_t object, where matches one of the exact-width integer types (7.23.2.2). If an implementation provides the corresponding uintN_t typedef, it shall define the corresponding exact-width memory reversal function for that value of .
Returns
The stdc_memreverse8uN functions returns the 8-bit memory reversed uintN_t value, as if by invoking stdc_memreverse8(sizeof(value), (unsigned char*)&value) and then returning value.
7.18.21 Endian-Aware 8-bit Load
Synopsis
#include <stdbit.h> #include <limits.h> #if CHAR_BIT == 8 uint_leastN_t stdc_load8_leuN(const unsigned char ptr[static (N / 8)]); uint_leastN_t stdc_load8_beuN(const unsigned char ptr[static (N / 8)]); uint_leastN_t stdc_load8_aligned_leuN(const unsigned char ptr[static (N / 8)]); uint_leastN_t stdc_load8_aligned_beuN(const unsigned char ptr[static (N / 8)]); int_leastN_t stdc_load8_lesN(const unsigned char ptr[static (N / 8)]); int_leastN_t stdc_load8_besN(const unsigned char ptr[static (N / 8)]); int_leastN_t stdc_load8_aligned_lesN(const unsigned char ptr[static (N / 8)]); int_leastN_t stdc_load8_aligned_besN(const unsigned char ptr[static (N / 8)]); #endif
Description
The 8-bit load family of functions read an int_leastN_t or uint_leastN_t object from the provided ptr in an endian-aware (7.18.2) manner, where matches an existing minimum-width integer type (7.23.2.3). If an implementation provides the corresponding uint_leastN_t typedef, it shall define the corresponding endian-aware load function for that value of . If this function is present, shall be a multiple of 8 and CHAR_BIT shall be 8. The functions containing _aligned in the name shall assume that ptr is suitably aligned to access a signed or unsigned integer of width for a signed or unsigned variant of the function, respectively. If the function name contains the s suffix in the name, it is a signed variant. Otherwise, it containts the u suffix and is an unsigned variant. If the function name contains the lesN or leuN suffix, it is a little-endian variant. Otherwise it contains the besN or beuN suffix and is a big-endian variant.
Returns
Let the computed value be:
where is:
-
ptr[index], if the function is the little-endian variant; - otherwise,
ptr[N-index- 1], if the function is the big-endian variant.
If the function is an unsigned variant, return . Otherwise, if the function is a signed variant, return:
- , if is less than ;
- otherwise, .
7.18.22 Endian-Aware 8-bit Store
Synopsis
#include <stdbit.h> #include <limits.h> #if CHAR_BIT == 8 void stdc_store8_leuN(uint_leastN_t value, unsigned char ptr[static (N / 8)]); void stdc_store8_beuN(uint_leastN_t value, unsigned char ptr[static (N / 8)]); void stdc_store8_aligned_leuN(uint_leastN_t value, unsigned char ptr[static (N / 8)]); void stdc_store8_aligned_beuN(uint_leastN_t value, unsigned char ptr[static (N / 8)]); void stdc_store8_lesN(int_leastN_t value, unsigned char ptr[static (N / 8)]); void stdc_store8_besN(int_leastN_t value, unsigned char ptr[static (N / 8)]); void stdc_store8_aligned_lesN(int_leastN_t value, unsigned char ptr[static (N / 8)]); void stdc_store8_aligned_besN(int_leastN_t value, unsigned char ptr[static (N / 8)]); #endif
Description
The 8-bit store family of functions write a int_leastN_t or uint_leastN_t object into the provided ptr in an endian-aware (7.18.2) manner, where matches an existing minimum-width integer type (7.23.2.3). If an implementation provides the corresponding uint_leastN_t typedef, it shall define the corresponding endian-aware store function for that value of . If this function is present, shall be a multiple of 8 and CHAR_BIT shall be 8. The functions containing _aligned in the name shall assume that ptr is suitably aligned to access a signed or unsigned integer of width . If the function name contains the s suffix in the name, it is a signed variant. Otherwise, it containts the u suffix and is an unsigned variant. If the function name contains the lesN or leuN suffix, it is a little-endian variant. Otherwise it contains the besN or beuN suffix and is a big-endian variant.
Let value_unsigned be value if the function is a unsigned variant. Otherwise, let value_unsigned be the conversion of value to its corresponding unsigned type, if the function is a signed variant.
Let index be an integer in a sequence that
- starts from and increments by 8 in the range of [0, ), if the function is a little-endian variant;
- starts from and decrements by 8 in the range of [0, ), if the function is a big-endian variant.
Let ptr_index be an integer that starts from 0. For each index in the order of the above-specified sequence:
- Sets the 8 bits in
ptr[ptr_index]to(value_unsigned>>index) & 0xFF. - Increments
ptr_indexby 1.
7.19 Boolean type and values <stdbool.h>
The header <stdbool.h> provides the obsolescent macro __bool_true_false_are_defined which expands to the integer literal 1.
7.20 Checked Integer Arithmetic <stdckdint.h>
7.20.1 General
The header <stdckdint.h> defines several macros for performing checked integer arithmetic.
The macro
__STDC_VERSION_STDCKDINT_H__is an integer constant expression with a value equivalent to 202311L.
7.20.2 Checked Integer Operation Type-generic Macros
Synopsis
#include <stdckdint.h> bool ckd_add(type1 *result, type2 a, type3 b); bool ckd_sub(type1 *result, type2 a, type3 b); bool ckd_mul(type1 *result, type2 a, type3 b);
Description
These type-generic macros perform addition, subtraction, or multiplication of the mathematical values of a and b, storing the result of the operation in *result, (that is, *result is assigned the result of computing a + b, a - b, or a * b). Each operation is performed as if both operands were represented in a signed integer type with infinite range, and the result was then converted from this integer type to type1.
Both type2 and type3 shall be any integer type other than "plain" char, bool, a bit-precise integer type, or an enumerated type, and they can be the same. *result shall be a modifiable lvalue of any integer type other than "plain" char, bool, a bit-precise integer type, or an enumerated type.
Recommended practice
It is recommended to produce a diagnostic message if type2 or type3 are not suitable integer types, or if *result is not a modifiable lvalue of a suitable integer type.
Returns
If these type-generic macros return false, the value assigned to *result correctly represents the mathematical result of the operation. Otherwise, these type-generic macros return true. In this case, the value assigned to *result is the mathematical result of the operation wrapped around to the width of *result.
EXAMPLE If a and b are values of type signed int, and result is a signed long, then
ckd_sub(&result, a, b);
indicates if a - b can be expressed as a signed long. If signed long has a greater width than signed int, this is the case and this macro invocation returns false.
7.21 Array count <stdcountof.h>
The macro
__STDC_VERSION_STDCOUNTOF_H__is an integer constant expression with a value equivalent to 202ymmL.
7.22 Common definitions <stddef.h>
7.22.1 General
The header <stddef.h> defines the following macros and declares the following types. Some are also defined in other headers, as noted in their respective subclauses.
The macro
__STDC_VERSION_STDDEF_H__is an integer constant expression with a value equivalent to 202311L.
The types are
ptrdiff_twhich is the signed integer type of the result of subtracting two pointers;size_twhich is the unsigned integer type of the result of the sizeof operator;max_align_twhich is an object type whose alignment is the greatest fundamental alignment;wchar_twhich is an integer type whose range of values can represent codes (or part of a sequence of codes) for all the members of the supported wide execution and wide literal encodings (6.2.9); the null character shall have the code value zero. Each member of the basic character set shall have a code value equal to its value when used as the lone character in an ordinary character literal if an implementation does not define __STDC_MB_MIGHT_NEQ_WC__; and,nullptr_twhich is the type of the nullptr predefined constant, see the subsequent description in the following subclauses.
The macros are
NULLwhich expands to an implementation-defined null pointer constant;unreachable()which expands to a void expression whose behavior is undefined if it is reached during execution; andoffsetof(type, member-designator )which expands to an integer constant expression that has type
size_t, the value of which is the offset in bytes, to the subobject (designated by member-designator), from the beginning of any object of type type. The type and member designator shall be such that givenstatic type t;
then the expression &(t.member-designator) evaluates to an address constant. If the specified type name contains a comma not between matching parentheses or if the specified member is a bit-field, the behavior is undefined.
Recommended practice
The types used for size_t and ptrdiff_t should not have an integer conversion rank greater than that of signed long int unless the implementation supports objects large enough to make this necessary.
7.22.2 The unreachable macro
Synopsis
#include <stddef.h> void unreachable(void);
Description
An invocation of the function-like macro unreachable indicates that the particular control flow that leads to the invocation will never be taken; it receives no arguments and expands to a void expression. The program execution shall not reach such an invocation.
Returns
If a macro invocation unreachable() is reached during execution, the behavior is undefined.
EXAMPLE 1 The following program assumes that each execution is provided with at least one command line argument. The behavior of an execution with no arguments is undefined.
#include <stddef.h> #include <stdio.h> int main (int argc, char* argv[static argc + 1]) { if (argc <= 2) unreachable(); else return printf("%s: we see %s", argv[0], argv[1]); return puts("this should never be reached"); }
Here, the static array size expression and the annotation of the control flow with unreachable indicates that the pointed-to parameter array argv will hold at least three elements, regardless of the circumstances. A possible optimization is that the resulting executable never performs the comparison and unconditionally executes a tail call to printf that never returns to the main function. In particular, the entire call and reference to puts can be omitted from the executable. No diagnostic is expected.
Because argv and argc’s values are controlled by the implementation and cannot be deterministically accounted for by the program, this program runs a high risk of engaging in completely undefined behavior.
EXAMPLE 2 The following code expresses the expectation that the argument to the function will be one of the three enumerator values despite an enumerated type allowing other, non-enumerated values to be passed. Some implementations can diagnose the lack of a return statement after the switch, but use of the unreachable macro signals information to the implementation that this scenario should not be possible, allowing for better diagnostic and optimization properties.
enum Colors { Red, Green, Blue }; int get_channel_index(enum Colors c) { switch (c) { case Red: return 0; case Green: return 1; case Blue: return 2; } unreachable(); }
7.22.3 The nullptr_t type
Synopsis
#include <stddef.h> typedef typeof_unqual(nullptr) nullptr_t;
Description
The nullptr_t type is the type of the nullptr predefined constant. It has only a very limited use in contexts where this type is needed to distinguish nullptr from other expression types.
NOTE Because it is considered to be a scalar type, nullptr_t can appear in many context where (void*)0 would be valid, for example:
- as the operand of
alignas,sizeofor typeof operators, - as the operand of an implicit or explicit conversion to a pointer type,
- as the assignment expression in an assignment or initialization of an object of type
nullptr_t, - as an argument to a parameter of type
nullptr_tor in a varying argument list, - as a void expression,
- as the operand of an implicit or explicit conversion to
bool, - as an operand of a
_Genericprimary expression, - as an operand of the
!,&&,||or conditional operators, - or, as the controlling expression of an
ifor iteration statement.
7.23 Integer types <stdint.h>
7.23.1 General
The header <stdint.h> declares sets of integer types having specified widths, and defines corresponding sets of macros.315) It also defines macros that specify limits of integer types corresponding to types defined in other standard headers.
Types are defined in the following categories:
- integer types having certain exact widths;
- integer types having at least certain specified widths;
- fastest integer types having at least certain specified widths;
- integer types wide enough to hold pointers to objects;
- integer types having greatest width.
(Some of these types may denote the same type.)
Corresponding macros specify limits of the declared types and construct suitable constants.
For each type described herein that the implementation provides,316) <stdint.h> shall declare that typedef name and define the associated macros. Conversely, for each type described herein that the implementation does not provide, <stdint.h> shall not declare that typedef name nor shall it define the associated macros. An implementation shall provide those types described as "required", but may not provide any of the others (described as "optional"). None of the types shall be defined as a synonym for a bit-precise integer type.
The feature test macro __STDC_VERSION_STDINT_H__ expands to the token 202311L.
7.23.2 Integer types
7.23.2.1 General
When typedef names differing only in the absence or presence of the initial u are defined, they shall denote corresponding signed and unsigned types as described in 6.2.5; an implementation providing one of these corresponding types shall also provide the other.
In the following descriptions, the symbol N represents an unsigned decimal integer with no leading zeros (e.g. 8 or 24, but not 04 or 048).
7.23.2.2 Exact-width integer types
The typedef name intN_t designates a signed integer type with width N and no padding bits. Thus, int8_t denotes such a signed integer type with a width of exactly 8 bits.
The typedef name uintN_t designates an unsigned integer type with width N and no padding bits. Thus, uint24_t denotes such an unsigned integer type with a width of exactly 24 bits.
If an implementation provides standard or extended integer types with a particular width and no padding bits, it shall define the corresponding typedef names.
7.23.2.3 Minimum-width integer types
The typedef name int_leastN_t designates a signed integer type with a width of at least N, such that no signed integer type with lesser size has at least the specified width. Thus, int_least32_t denotes a signed integer type with a width of at least 32 bits.
The typedef name uint_leastN_t designates an unsigned integer type with a width of at least N, such that no unsigned integer type with lesser size has at least the specified width. Thus, uint_least16_t denotes an unsigned integer type with a width of at least 16 bits.
If the typedef name intN_t is defined, int_leastN_t designates the same type. If the typedef name uintN_t is defined, uint_leastN_t designates the same type.
The following types are required:
int_least8_t int_least16_t int_least32_t int_least64_t
uint_least8_t uint_least16_t uint_least32_t uint_least64_t
All other types of this form are optional.
7.23.2.4 Fastest minimum-width integer types
Each of the following types designates an integer type that is usually fastest317) to operate with among all integer types that have at least the specified width.
The typedef name int_fastN_t designates the fastest signed integer type with a width of at least N. The typedef name uint_fastN_t designates the fastest unsigned integer type with a width of at least N.
The following types are required:
int_fast8_t int_fast16_t int_fast32_t int_fast64_t
uint_fast8_t uint_fast16_t uint_fast32_t uint_fast64_t
All other types of this form are optional.
7.23.2.5 Integer types capable of holding object pointers
The following type designates a signed integer type, other than a bit-precise integer type, with the property that any valid pointer to void can be converted to this type, then converted back to pointer to void, and the result will compare equal to the original pointer:
intptr_tThe following type designates an unsigned integer type, other than a bit-precise integer type, with the property that any valid pointer to void can be converted to this type, then converted back to pointer to void, and the result will compare equal to the original pointer:uintptr_tThese types are optional.
7.23.2.6 Greatest-width integer types
The following type designates a signed integer type, other than a bit-precise integer type, capable of representing any value of any signed integer type with the possible exceptions of signed bit-precise integer types and of signed extended integer types that are wider than long long and that are referred by the type definition for an exact width integer type:
intmax_tThe following type designates the unsigned integer type that corresponds to intmax_t:318)uintmax_tThese types are required.
7.23.3 Widths of specified-width integer types
7.23.3.1 General
The following object-like macros specify the width of the types declared in <stdint.h>. Each macro name corresponds to a similar type name in 7.23.2.
Each instance of any defined macro shall be replaced by a constant expression suitable for use in #if preprocessing directives. Its implementation-defined value shall be equal to or greater than the value given in the subsequent subclauses, except where stated to be exactly the given value. An implementation shall define only the macros corresponding to those typedef names it actually provides.319)
7.23.3.2 Width of exact-width integer types
INTN_WIDTH exactly N UINTN_WIDTH exactly N
7.23.3.3 Width of minimum-width integer types
INT_LEASTN_WIDTH exactly UINT_LEASTN_WIDTH UINT_LEASTN_WIDTH N
7.23.3.4 Width of fastest minimum-width integer types
INT_FASTN_WIDTH exactly UINT_FASTN_WIDTH UINT_FASTN_WIDTH N
7.23.3.5 Width of integer types capable of holding object pointers
INTPTR_WIDTH exactly UINTPTR_WIDTH UINTPTR_WIDTH 16
7.23.3.6 Width of greatest-width integer types
INTMAX_WIDTH exactly UINTMAX_WIDTH UINTMAX_WIDTH 64
7.23.4 Width of other integer types
7.23.4.1 General
The following object-like macros specify the width of integer types corresponding to types defined in other standard headers.
Each instance of these macros shall be replaced by a constant expression suitable for use in #if preprocessing directives. Its implementation-defined value shall be equal to or greater than the corresponding value given in the following subclauses. An implementation shall define only the macros corresponding to those typedef names it actually provides.320)
7.23.4.2 Width of ptrdiff_t
PTRDIFF_WIDTH
167.23.4.3 Width of sig_atomic_t
SIG_ATOMIC_WIDTH
87.23.4.4 Width of size_t
SIZE_WIDTH 167.23.4.5 Width of wchar_t
WCHAR_WIDTH
87.23.4.6 Width of wint_t
WINT_WIDTH
167.23.5 Macros for constants of integer type
7.23.5.1 General
The following function-like macros expand to integer constant expressions suitable for initializing objects that have integer types corresponding to types defined in <stdint.h>. Each macro name corresponds to a similar type name in 7.23.2.3 or 7.23.2.6.
The argument in any instance of these macros shall be an unsuffixed integer literal (as defined in 6.4.5.2) with a value that does not exceed the limits for the corresponding type.
Each invocation of one of these macros shall expand to an integer constant expression. The type of the expression shall have the same type as would an expression of the corresponding type converted according to the integer promotions. The value of the expression shall be that of the argument. If the value is in the range of the type intmax_t (for a signed type) or the type uintmax_t (for an unsigned type), see 7.23.2.6, the expression is suitable for use in conditional expression inclusion preprocessing directives.
7.23.5.2 Macros for minimum-width constants
The macro INTN_C(value) expands to an integer constant expression corresponding to the type int_leastN_t. The macro UINTN_C(value) expands to an integer constant expression corresponding to the type uint_leastN_t. For example, if uint_least64_t is a name for the type unsigned long long int, then UINT64_C(0x123) can expand to the integer literal 0x123ULL.
7.23.5.3 Macros for greatest-width constants
The following macro expands to an integer constant expression having the value specified by its argument and the type intmax_t:
INTMAX_C(value)The following macro expands to an integer constant expression having the value specified by its argument and the type
uintmax_t:UINTMAX_C(value)
7.23.6 Maximal and minimal values of integer types
For all integer types for which there is a macro with suffix _WIDTH holding the width, maximum macros with suffix _MAX and, for all signed types, minimum macros with suffix _MIN are defined as by 5.3.5.3. If it is unspecified if a type is signed or unsigned and the implementation has it as an unsigned type, a minimum macro with extension _MIN and value 0 of the corresponding type, converted according to the integer promotions, is defined.
7.24 Input/output <stdio.h>
7.24.1 Introduction
The header <stdio.h> defines several macros, and declares three types and many functions for performing input and output.
The macro
__STDC_VERSION_STDIO_H__is an integer constant expression with a value equivalent to 202ymmL.
The types declared are size_t (described in 7.22);
FILEwhich is an object type capable of recording all the information needed to control a stream, including its file position indicator, a pointer to its associated buffer (if any), an error indicator that records whether a read/write error has occurred, and an end-of-file indicator that records whether the end of the file has been reached; andfpos_twhich is a complete object type other than an array type capable of recording all the information needed to specify uniquely every position within a file.
The macros are NULL (described in 7.22);
_IOFBF _IOLBF _IONBFwhich expand to integer constant expressions with distinct values, suitable for use as the third argument to the
setvbuf function;BUFSIZwhich expands to an integer constant expression that is the size of the buffer used by the setbuf function;EOFwhich expands to an integer constant expression, with type int and a negative value, that is returned by several functions to indicate end-of-file, that is, no more input from a stream;FOPEN_MAXwhich expands to an integer constant expression that is the minimum number of files that the implementation guarantees can be open simultaneously;FILENAME_MAXwhich expands to an integer constant expression that is the size needed for an array of char large enough to hold the longest file name string that the implementation guarantees can be opened or, if the implementation imposes no practical limit on the length of file name strings, the recommended size of an array intended to hold a file name string;321)
_PRINTF_NAN_LEN_MAX- :
[-]NAN(n-char-sequence)
L_tmpnam SEEK_CUR SEEK_END SEEK_SET TMP_MAX stderr stdin stdout
The header <wchar.h> declares functions for wide character input and output. The wide character input/output functions described in that subclause provide operations analogous to most of those described here, except that the fundamental units internal to the program are wide characters. The external representation (in the file) is a sequence of generalized multibyte characters, as described further in 7.24.3.
The input/output functions are given the following collective terms:
- The wide character input functions — those functions described in 7.33 that perform input into wide characters and wide strings:
fgetwc,fgetws,getwc,getwchar,fwscanf,wscanf,vfwscanf, andvwscanf. - The wide character output functions — those functions described in 7.33 that perform output from wide characters and wide strings:
fputwc,fputws,putwc,putwchar,fwprintf,wprintf,vfwprintf, andvwprintf. - The wide character input/output functions — the union of the
ungetwcfunction, the wide character input functions, and the wide character output functions. - The byte input/output functions — those functions described in this subclause that perform input/output:
fgetc,fgets,fprintf,fputc,fputs,fread,fscanf,fwrite,getc,getchar,printf,putc,putchar,puts,scanf,ungetc,vfprintf,vfscanf,vprintf, andvscanf.
fseek function (7.24.9.2), streams (7.24.2), the tmpnam function (7.24.4.4), <wchar.h> (7.33).7.24.2 Streams
Input and output, whether to or from physical devices such as terminals and tape drives, or whether to or from files supported on structured storage devices, are mapped into logical data streams, whose properties are more uniform than their various inputs and outputs. Two forms of mapping are supported, for text streams and for binary streams.323)
A text stream is an ordered sequence of characters composed into lines, each line consisting of zero or more characters plus a terminating new-line character. Whether the last line requires a terminating new-line character is implementation-defined. Characters can be added, altered, or deleted on input and output to conform to differing conventions for representing text in the host environment. Thus, there is not required to be a one-to-one correspondence between the characters in a stream and those in the external representation. Data read in from a text stream will necessarily compare equal to the data that were earlier written out to that stream only if:
- the data consist only of printing characters and the control characters horizontal tab and new-line;
- no new-line character is immediately preceded by space characters;
- and, the last character is a new-line character.
Whether space characters that are written out immediately before a new-line character appear when read in is implementation-defined.
A binary stream is an ordered sequence of characters that can transparently record internal data. Data read in from a binary stream shall compare equal to the data that were earlier written out to that stream, under the same implementation. Such a stream may, however, have an implementationdefined number of null characters appended to the end of the stream.
Each stream has an orientation. After a stream is associated with an external file, but before any operations are performed on it, the stream is unoriented. Once a wide character input/output function has been applied to an unoriented stream, the stream becomes a wide-oriented stream. Similarly, once a byte input/output function has been applied to an unoriented stream, the stream becomes a byte-oriented stream. Only a call to the freopen function or the fwide function can otherwise alter the orientation of a stream. (A successful call to freopen removes any orientation.)324)
Byte input/output functions shall not be applied to a wide-oriented stream and wide character input/output functions shall not be applied to a byte-oriented stream. The remaining stream operations do not affect, and are not affected by, a stream’s orientation, except for the following additional restrictions:
- Binary wide-oriented streams have the file-positioning restrictions ascribed to both text and binary streams.
- For any input and output stream with pre-existing multibyte characters beyond the file position indicator, any call to
fputcandfputwcruns the risk of overwriting part of a multibyte character, leaving the file with bytes that no longer consist of valid multibyte characters.
Each wide-oriented stream has an associated mbstate_t object that stores the current parse state of the stream. A successful call to fgetpos stores a representation of the value of this mbstate_t object as part of the value of the fpos_t object. A later successful call to fsetpos using the same stored fpos_t value restores the value of the associated mbstate_t object as well as the position within the controlled stream.
Each stream has an associated lock that is used to prevent data races when multiple threads of execution access a stream, and to restrict the interleaving of stream operations performed by multiple
All functions that read, write, position, or query the position of a stream lock the stream before accessing it. They release the lock associated with the stream when the access is complete.
Environmental limits
An implementation shall support text files with lines containing at least characters, including the terminating new-line character. The value of the macro BUFSIZ shall be at least .
Forward references: the freopen function (7.24.5.4), the fwide function (7.33.3.5), mbstate_t (7.33.1), the fgetpos function (7.24.9.1), the fsetpos function (7.24.9.3).
7.24.3 Files
A stream is associated with an external file (which can be a physical device) by opening a file, which can involve creating a new file. Creating an existing file causes its former contents to be discarded, if necessary. If a file can support positioning requests (such as a disk file, as opposed to a terminal), then a file position indicator associated with the stream is positioned at the start (character number zero) of the file, unless the file is opened with append mode in which case it is implementationdefined whether the file position indicator is initially positioned at the beginning or the end of the file. The file position indicator is maintained by subsequent reads, writes, and positioning requests, to facilitate an orderly progression through the file.
Binary files are not truncated, except as defined in 7.24.5.3. Whether a write on a text stream causes the associated file to be truncated beyond that point is implementation-defined.
When a stream is unbuffered, characters are intended to appear from the source or at the destination as soon as possible. Otherwise characters may be accumulated and transmitted to or from the host environment as a block. When a stream is fully buffered, characters are intended to be transmitted to or from the host environment as a block when a buffer is filled. When a stream is line buffered, characters are intended to be transmitted to or from the host environment as a block when a new-line character is encountered. Furthermore, characters are intended to be transmitted as a block to the host environment when a buffer is filled, when input is requested on an unbuffered stream, or when input is requested on a line buffered stream that requires the transmission of characters from the host environment. Support for these characteristics is implementation-defined, and can be affected via the setbuf and setvbuf functions.
A file may be disassociated from a controlling stream by closing the file. Output streams are flushed (any unwritten buffer contents are transmitted to the host environment) before the stream is disassociated from the file. The lifetime of a FILE object ends when the associated file is closed (including the standard text streams). Whether a file of zero length (on which no characters have been written by an output stream) actually exists is implementation-defined.
The file may be subsequently reopened, by the same or another program execution, and its contents reclaimed or modified (if it can be repositioned at its start). If the main function returns to its original caller, or if the exit function is called, all open files are closed (hence all output streams are flushed) before program termination. Other paths to program termination, such as calling the abort function, are not required to close all files properly.
The address of the FILE object used to control a stream can be significant; a copy of a FILE object is not required to serve in place of the original.
At program startup, three text streams are predefined and are already opened — standard input (for reading conventional input), standard output (for writing conventional output), and standard error (for writing diagnostic output). As initially opened, the standard error stream is not fully buffered; the standard input and standard output streams are fully buffered if and only if the stream can be determined not to refer to an interactive device.
Functions that open additional (nontemporary) files require a file name, which is a string. The rules for composing valid file names are implementation-defined. Whether the same file can be simultaneously open multiple times is also implementation-defined.
Although both text and binary wide-oriented streams are conceptually sequences of wide characters, the external file associated with a wide-oriented stream is a sequence of multibyte characters, generalized as follows:
- Multibyte encodings within files can contain embedded null bytes (unlike multibyte encodings valid for use internal to the program).
- A file is not required to begin nor end in the initial shift state.325)
Moreover, the encodings used for multibyte characters can differ among files. Both the nature and choice of such encodings are implementation-defined.
The wide character input functions read multibyte characters from the stream and convert them to wide characters as if they were read by successive calls to the fgetwc function. Each conversion occurs as if by a call to the mbrtowc function, with the conversion state described by the stream’s own mbstate_t object. The byte input functions read characters from the stream as if by successive calls to the fgetc function.
The wide character output functions convert wide characters to multibyte characters and write them to the stream as if they were written by successive calls to the fputwc function. Each conversion occurs as if by a call to the wcrtomb function, with the conversion state described by the stream’s own mbstate_t object. The byte output functions write characters to the stream as if by successive calls to the fputc function.
In some cases, some of the byte input/output functions also perform conversions between multibyte characters and wide characters. These conversions also occur as if by calls to the mbrtowc and wcrtomb functions.
An encoding error occurs if the character sequence presented to the underlying mbrtowc function does not form a valid (generalized) multibyte character, or if the code value passed to the underlying wcrtomb does not correspond to a valid (generalized) multibyte character. The wide character input/output functions and the byte input/output functions store the value of the macro EILSEQ in errno if and only if an encoding error occurs.
Environmental limits
The value of FOPEN_MAX shall be at least eight, including the three standard text streams.
exit function (7.25.5.4), the fgetc function (7.24.7.1), the fopen function (7.24.5.3), the fputc function (7.24.7.3), the setbuf function (7.24.5.5), the setvbuf function (7.24.5.6), the fgetwc function (7.33.3.1), the fputwc function (7.33.3.3), conversion state (7.33.6), the mbrtowc function (7.33.6.4.3), the wcrtomb function (7.33.6.4.4).7.24.4 Operations on files
7.24.4.1 The remove function
Synopsis
Description
The remove function causes the file whose name is the string pointed to by filename to be no longer accessible by that name. A subsequent attempt to open that file using that name will fail, unless it is created anew. If the file is open, the behavior of the remove function is implementation-defined.
Returns
The remove function returns zero if the operation succeeds, nonzero if it fails.
7.24.4.2 The rename function
Synopsis
Description
The rename function causes the file whose name is the string pointed to by old to be henceforth known by the name given by the string pointed to by new. The file named old is no longer accessible by that name. If a file named by the string pointed to by new exists prior to the call to the rename function, the behavior is implementation-defined.
Returns
The rename function returns zero if the operation succeeds, nonzero if it fails,326) in which case if the file existed previously it is still known by its original name.
7.24.4.3 The tmpfile function
Synopsis
Description
The tmpfile function creates a temporary binary file that is different from any other existing file and that will automatically be removed when it is closed or at program termination. If the program terminates abnormally, whether an open temporary file is removed is implementation-defined. The file is opened for update with "wb+" mode.
Recommended practice
It should be possible to open at least TMP_MAX temporary files during the lifetime of the program (this limit may be shared with tmpnam) and there should be no limit on the number simultaneously open other than this limit and any limit on the number of open files (FOPEN_MAX).
Returns
The tmpfile function returns a pointer to the stream of the file that it created. If the file cannot be created, the tmpfile function returns a null pointer.
fopen function (7.24.5.3).7.24.4.4 The tmpnam function
Synopsis
Description
The tmpnam function generates a string that is a valid file name and that is not the same as the name of an existing file.327) The function is potentially capable of generating at least TMP_MAX different strings, but any or all of them can already be in use by existing files and thus not be suitable return values.
The tmpnam function generates a different string each time it is called.
Calls to the tmpnam function with a null pointer argument may introduce data races with each other. The implementation shall behave as if no library function calls the tmpnam function.
Returns
If no suitable string can be generated, the tmpnam function returns a null pointer. Otherwise, if the argument is a null pointer, the tmpnam function leaves its result in an internal static object and returns a pointer to that object (subsequent calls to the tmpnam function may modify the same object). If the argument is not a null pointer, it is assumed to point to an array of at least L_tmpnam chars; the tmpnam function writes its result in that array and returns the argument as its value.
Environmental limits
The value of the macro TMP_MAX shall be at least .
7.24.5 File access functions
7.24.5.1 The fclose function
Synopsis
Description
A successful call to the fclose function causes the stream pointed to by stream to be flushed and the associated file to be closed. Any unwritten buffered data for the stream are delivered to the host environment to be written to the file; any unread buffered data are discarded. Whether the call succeeds or not, the stream is disassociated from the file and any buffer set by the setbuf or setvbuf function is disassociated from the stream (and deallocated if it was automatically allocated).
Returns
The fclose function returns zero if the stream was successfully closed, or EOF if any errors were detected.
7.24.5.2 The fflush function
Synopsis
Description
If stream points to an output stream or an update stream in which the most recent operation was not input, the fflush function causes any unwritten data for that stream to be delivered to the host environment to be written to the file; otherwise, the behavior is undefined.
If stream is a null pointer, the fflush function performs this flushing action on all streams for which the behavior is defined previously in this subclause.
Returns
The fflush function sets the error indicator for the stream and returns EOF if a write error occurs, otherwise it returns zero.
fopen function (7.24.5.3).7.24.5.3 The fopen function
Synopsis
Description
The fopen function opens the file whose name is the string pointed to by filename, and associates a stream with it.
The argument mode points to a string. The behavior is unspecified if any character occurs more than once in the string. If the string begins with one of the following characters, then the file shall be opened in the mode indicated. Otherwise, the behavior is undefined.328)
r Open the file for reading.
w Truncate the file to zero length or create the file for writing.
a Open or create the file for writing at end-of-file (append).
The remainder of the string can contain any of the following characters in any order, and further affect how the file is opened:
b The contents of the file shall be treated as binary, otherwise they shall be treated as text.
x The file shall be opened in exclusive mode.
p The file shall be opened in private mode.
+ The file shall be opened for update (both reading and writing), rather than just reading or writing.
Opening a file with read mode (’r’ as the first character in the mode argument) fails if the file does not exist or cannot be read.
Opening a file with append mode (’a’ as the first character in the mode argument) causes all subsequent writes to the file to be forced to the then current end-of-file at the point of buffer flush or actual write, regardless of intervening calls to the fseek, fsetpos, or rewind functions. Incrementing the current end-of-file by the amount of data written is atomic with respect to other threads writing to the same file provided the file was also opened in append mode. If the implementation is not capable of incrementing the current end-of-file atomically, it shall fail instead of performing non-atomic end-of-file writes. In some implementations, opening a binary file with append mode (’b’ as the second or third character in the previously described list of mode argument values) may initially position the file position indicator for the stream beyond the last data written, because of null character padding.
Opening a file with exclusive mode (’x’ as a character in the mode argument) fails if the file already exists or cannot be created. The check for the existence of the file and the creation of the file if it does not exist is atomic with respect to other threads and other concurrent program executions. If the implementation is not capable of performing the check for the existence of the file and the creation of the file atomically, it shall fail instead of performing a non-atomic check and creation.
Opening a file with private mode (’p’ as a character in the mode argument) creates a file whose contents cannot be accessed by other means at any point in time including after program end, and whose filename may be ignored by implementations except to identify which storage may hold the file. If the implementation is not capable of creating private files, it shall fail.
When a file is opened with update mode (’+’ as the second or third character in the previously described list of mode argument values), both input and output can be performed on the associated stream. However, output shall not be directly followed by input without an intervening call to the fflush function or to a file positioning function (fseek, fsetpos, or rewind), and input shall not be directly followed by output without an intervening call to a file positioning function, unless the
When opened, a stream is fully buffered if and only if it can be determined not to refer to an interactive device. The error and end-of-file indicators for the stream are cleared.
Returns
The fopen function returns a pointer to the object controlling the stream. If the open operation fails, fopen returns a null pointer.
7.24.5.4 The freopen function
Synopsis
#include <stdio.h> FILE *freopen(const char * restrict filename, const char * restrict mode, FILE * restrict stream);
Description
The freopen function opens the file whose name is the string pointed to by filename and associates the stream pointed to by stream with it. The mode argument is used just as in the fopen function.329)
If filename is a null pointer, the freopen function attempts to change the mode of the stream to that specified by mode, as if the name of the file currently associated with the stream had been used. It is implementation-defined which changes of mode are permitted (if any), and under what circumstances.
The freopen function first attempts to close any file that is associated with the specified stream. Failure to close the file is ignored. The error and end-of-file indicators for the stream are cleared.
Returns
The freopen function returns a null pointer if the open operation fails. Otherwise, freopen returns the value of stream.
7.24.5.5 The setbuf function
Synopsis
Description
Except that it returns no value, the setbuf function is equivalent to the setvbuf function invoked with the values _IOFBF for mode and BUFSIZ for size, or (if buf is a null pointer), with the value _IONBF for mode.
Returns
The setbuf function returns no value.
setvbuf function (7.24.5.6).7.24.5.6 The setvbuf function
Synopsis
#include <stdio.h> int setvbuf(FILE * restrict stream, char * restrict buf, int mode, size_t size);
Description
The setvbuf function may be used only after the stream pointed to by stream has been associated with an open file and before any other operation (other than an unsuccessful call to setvbuf) is performed on the stream. The argument mode determines how stream will be buffered, as follows:
_IOFBF causes input/output to be fully buffered;
_IOLBF causes input/output to be line buffered;
_IONBF causes input/output to be unbuffered.
If buf is not a null pointer, the array it points to can be used instead of a buffer allocated by the setvbuf function330) and the argument size specifies the size of the array; otherwise, size may determine the size of a buffer allocated by the setvbuf function. The members of the array at any time have unspecified values.
Returns
The setvbuf function returns zero on success, or nonzero if an invalid value is given for mode or if the request cannot be honored.
7.24.6 Formatted input/output functions
7.24.6.1 General
The formatted input/output functions shall behave as if there is a sequence point after the actions associated with each specifier.331)
7.24.6.2 The fprintf function
Synopsis
Description
The fprintf function writes output to the stream pointed to by stream, under control of the string pointed to by format that specifies how subsequent arguments are converted for output. If there are insufficient arguments for the format, the behavior is undefined. If the format is exhausted while arguments remain, the excess arguments are evaluated (as always) but are otherwise ignored. The fprintf function returns when the end of the format string is encountered.
The format shall be a multibyte character sequence, beginning and ending in its initial shift state. The format is composed of zero or more directives: ordinary multibyte characters (not %), which are copied unchanged to the output stream; and conversion specifications, each of which results in fetching zero or more subsequent arguments, converting them, if applicable, according to the corresponding conversion specifier, and then writing the result to the output stream.
Each conversion specification is introduced by the character %. After the %, the following appear in sequence:
- Zero or more flags (in any order) that modify the meaning of the conversion specification.
- An optional minimum field width. If the converted value has fewer characters than the field width, it is padded with spaces (by default) on the left (or right, if the left adjustment flag, described later, has been given) to the field width. The field width takes the form of an asterisk
* (described later) or a nonnegative decimal integer.332)
As noted previously, a field width, or precision, or both, may be indicated by an asterisk. In this case, an int argument supplies the field width or precision. The arguments specifying field width, or precision, or both, shall appear (in that order) before the argument (if any) to be converted. A negative field width argument is taken as a - flag followed by a positive field width. A negative precision argument is taken as if the precision were omitted.
The flag characters and their meanings are:
- The result of the conversion is left-justified within the field. (It is right-justified if this flag is not specified.)
+ The result of a signed conversion always begins with a plus or minus sign. (It begins with a sign only when a value with a negative sign is converted if this flag is not specified.)333)
space If the first character of a signed conversion is not a sign, or if a signed conversion results in no characters, a space is prefixed to the result. If the space and + flags both appear, the space flag is ignored.
# The result is converted to an "alternative form". For o conversion, it increases the precision, if and only if necessary, to force the first digit of the result to be a zero (if the value and precision are both 0, a single 0 is printed). For b conversion, a nonzero result has 0b prefixed to it. For the optional B conversion as described later in this subclause, a nonzero result has 0B prefixed to it. For x (or X) conversion, a nonzero result has 0x (or 0X) prefixed to it. For a, A, e, E, f, F, g, and G conversions, the result of converting a floating-point number always contains a decimal-point character, even if no digits follow it. (Normally, a decimal-point character appears in the result of these conversions only if a digit follows it.) For g and G conversions, trailing zeros are not removed from the result. For other conversions, the behavior is undefined.
0 For b, B, d, i, o, u, x, X, a, A, e, E, f, F, g, and G conversions, leading zeros (following any indication of sign or base) are used to pad to the field width rather than performing space padding, except when converting an infinity or NaN. If the 0 and - flags both appear, the 0 flag is ignored. For b, B, d, i, o, u, x, and X conversions, if a precision is specified, the 0 flag is ignored. For other conversions, the behavior is undefined.
The length modifiers and their meanings are:
hh Specifies that a following b, B, d, i, o, u, x, or X conversion specifier applies to a signed char or unsigned char argument (the argument will have been promoted according to the integer promotions, but its value shall be converted to signed char or unsigned char before printing); or that a following n conversion specifier applies to a pointer to a signed char argument.
h Specifies that a following b, B, d, i, o, u, x, or X conversion specifier applies to a short int or unsigned short int argument (the argument will have been promoted according to the integer promotions, but its value shall be converted to short int or
- :
unsigned short intbefore printing); or that a followingnconversion specifier applies- to a pointer to a
short intargument.
The conversion specifiers and their meanings are:
- :
- A
doubleargument representing an infinity is converted in one of the styles [-]infor - [-]
infinity— which style is implementation-defined. Adoubleargument representing a - NaN is converted in one of the styles [-]
nanor [-]nan(n-char-sequence)— which style, and - the meaning of any n-char-sequence, is implementation-defined. The
Fconversion specifier - produces
INF,INFINITY, orNANinstead ofinf,infinity, ornan, respectively.334)
If a conversion specification is invalid, the behavior is undefined.339) fprintf shall behave as if it uses va_arg with a type argument naming the type resulting from applying the default argument promotions to the type corresponding to the conversion specification and then converting the result of the va_arg expansion to the type corresponding to the conversion specification.340)
In no case does a nonexistent or small field width cause truncation of a field; if the result of a conversion is wider than the field width, the field is expanded to contain the conversion result.
For a and A conversions, if FLT_RADIX is a power of , the value is correctly rounded to a hexadecimal floating number with the given precision.
Recommended practice
For a and A conversions, if FLT_RADIX is not a power of and the result is not exactly representable in the given precision, the result should be one of the two adjacent numbers in hexadecimal floating style with the given precision, with the extra stipulation that the error should have a correct sign for the current rounding direction.
For e, E, f, F, g, and G conversions, if the number of significant decimal digits is at most the maximum value of the T_DECIMAL_DIG macros (defined in <float.h>), then the result should be correctly rounded.341) If the number of significant decimal digits is more than but the source value is exactly representable with digits, then the result should be an exact representation with trailing zeros. Otherwise, the source value is bounded by two adjacent decimal strings , both having significant digits; the value of the resultant decimal string should satisfy , with the
The uppercase B format specifier is made optional by the previous description, because it used to be available for extensions in previous versions of this document. Implementations that did not use an uppercase B as their own extension before are encouraged to implement it as previously described.
Returns
The fprintf function returns the number of characters transmitted, or a negative value if an output or encoding error occurred or if the implementation does not support a specified width length modifier.
Environmental limits
The number of characters that can be produced by any single conversion shall be at least 4095.
EXAMPLE 1 To print a date and time in the form "Sunday, July 3, 10:02" followed by to five decimal places:
#include <math.h> #include <stdio.h> /* ... */ char *weekday, *month; // pointers to strings int day, hour, min; fprintf(stdout, "%s, %s %d, %.2d:%.2d\n", weekday, month, day, hour, min); fprintf(stdout, "pi = %.5f\n", 4 * atan(1.0));
EXAMPLE 2 In this example, multibyte characters do not have a state-dependent encoding, and the members of the extended character set that consist of more than one byte each consist of exactly two bytes, the first of which is denoted here by a □and the second by an uppercase letter.
Given the following wide string with length seven,
static wchar_t wstr[] = L"□X□Yabc□Z□W";the seven calls
fprintf(stdout, "|1234567890123|\n"); fprintf(stdout, "|%13ls|\n", wstr); fprintf(stdout, "|%-13.9ls|\n", wstr); fprintf(stdout, "|%13.10ls|\n", wstr); fprintf(stdout, "|%13.11ls|\n", wstr); fprintf(stdout, "|%13.15ls|\n", &wstr[2]); fprintf(stdout, "|%13lc|\n", (wint_t) wstr[5]);
will print the following seven lines:
|1234567890123| | □X□Yabc□Z□W| |□X□Yabc□Z | | □X□Yabc□Z| | □X□Yabc□Z□W| | abc□Z□W| | □Z|
EXAMPLE 3 Following are representations of _Decimal64 arguments as triples and the corresponding character sequences fprintf produces with "%Da":
_Decimal32 x = 6543.00DF; // (+1, 654300, -2) fprintf(stdout, "%Ha\n", x); fprintf(stdout, "%.6Ha\n", x); fprintf(stdout, "%.5Ha\n", x); fprintf(stdout, "%.4Ha\n", x); fprintf(stdout, "%.3Ha\n", x); fprintf(stdout, "%.2Ha\n", x); fprintf(stdout, "%.1Ha\n", x); fprintf(stdout, "%.0Ha\n", x); _Decimal32 x = 9543210e87DF; // (+1, 9543210, 87) _Decimal32 y = 9500000e90DF; // (+1, 9500000, 90) fprintf(stdout, "%.6Ha\n", x); fprintf(stdout, "%.5Ha\n", x); fprintf(stdout, "%.4Ha\n", x); fprintf(stdout, "%.3Ha\n", x); fprintf(stdout, "%.2Ha\n", x); fprintf(stdout, "%.1Ha\n", x); fprintf(stdout, "%.1Ha\n", y); _Decimal32 x = 9512345e90DF; // (+1, 9512345, 90) _Decimal32 y = 9512345e86DF; // (+1, 9512345, 86) fprintf(stdout, "%.3Ha\n", x); fprintf(stdout, "%.2Ha\n", x); fprintf(stdout, "%.1Ha\n", x); fprintf(stdout, "%.2Ha\n", y);
7.24.6.3 The fscanf function
Synopsis
Description
The fscanf function reads input from the stream pointed to by stream, under control of the string pointed to by format that specifies the admissible input sequences and how they are to be converted for assignment, using subsequent arguments as pointers to the objects to receive the converted input. If there are insufficient arguments for the format, the behavior is undefined. If the format is exhausted while arguments remain, the excess arguments are evaluated (as always) but are otherwise ignored.
The format shall be a multibyte character sequence, beginning and ending in its initial shift state. The format is composed of zero or more directives: one or more white-space characters, an ordinary multibyte character (neither % nor a white-space character), or a conversion specification. Each conversion specification is introduced by the character %. After the %, the following appear in sequence:
- An optional assignment-suppressing character
*. - An optional decimal integer greater than zero that specifies the maximum field width (in characters).
- An optional length modifier that specifies the size of the receiving object.
- A conversion specifier character that specifies the type of conversion to be applied.
The fscanf function executes each directive of the format in turn. When all directives have been executed, or if a directive fails (as detailed later in this subclause), the function returns. Failures are described as input failures (due to the occurrence of an encoding error or the unavailability of input characters), or matching failures (due to inappropriate input).
A directive composed of white-space character(s) is executed by reading input up to the first nonwhite-space character (which remains unread), or until no more characters can be read. The directive never fails.
A directive that is an ordinary multibyte character is executed by reading the next characters of the stream. If any of those characters differ from the ones composing the directive, the directive fails
A directive that is a conversion specification defines a set of matching input sequences, as described further in this subclause for each specifier. A conversion specification is executed in the following steps:
Input white-space characters are skipped, unless the specification includes a [, c, or n specifier.342)
An input item is read from the stream, unless the specification includes an n specifier. An input item is defined as the longest sequence of input characters which does not exceed any specified field width and which is, or is a prefix of, a matching input sequence.343) The first character, if any, after the input item remains unread. If the length of the input item is zero, the execution of the directive fails; this condition is a matching failure unless end-of-file, an encoding error, or a read error prevented input from the stream, in which case it is an input failure.
Except in the case of a % specifier, the input item (or, in the case of a %n directive, the count of input characters) is converted to a type appropriate to the conversion specifier. If the input item is not a matching sequence, the execution of the directive fails: this condition is a matching failure. Unless assignment suppression was indicated by a *, the result of the conversion is placed in the object pointed to by the first argument following the format argument that has not already received a conversion result. If this object does not have an appropriate type, or if the result of the conversion cannot be represented in the object, the behavior is undefined.
The length modifiers and their meanings are:
hh Specifies that a following b, d, i, o, u, x, X, or n conversion specifier applies to an argument with type pointer to signed char or unsigned char.
h Specifies that a following b, d, i, o, u, x, X, or n conversion specifier applies to an argument with type pointer to short int or unsigned short int.
l (ell) Specifies that a following b, d, i, o, u, x, X, or n conversion specifier applies to an argument with type pointer to long int or unsigned long int; that a following a, A, e, E, f, F, g, or G conversion specifier applies to an argument with type pointer to double; or that a following c, s, or [ conversion specifier applies to an argument with type pointer to wchar_t.
ll (ell-ell) Specifies that a following b, d, i, o, u, x, X, or n conversion specifier applies to an argument with type pointer to long long int or unsigned long long int.
j Specifies that a following b, d, i, o, u, x, X, or n conversion specifier applies to an argument with type pointer to intmax_t or uintmax_t.
z Specifies that a following b, d, i, o, u, x, X, or n conversion specifier applies to an argument with type pointer to size_t or the corresponding signed integer type.
t Specifies that a following b, d, i, o, u, x, X, or n conversion specifier applies to an argument with type pointer to ptrdiff_t or the corresponding unsigned integer type.
wN Specifies that a following b, d, i, o, u, x, X, or n conversion specifier applies to an argument which is a pointer to an integer with a specific width where N is a positive decimal integer with no leading zeros. All minimum-width integer types (7.23.2.3) and exact-width integer types (7.23.2.2) defined in the header <stdint.h> shall be supported. Other supported values of N are implementation-defined.
wfN Specifies that a following b, d, i, o, u, x, X, or n conversion specifier applies to an argument which is a pointer to a fastest minimum-width integer with a specific width where N is a positive decimal integer with no leading zeros. All fastest minimum-width integer types
In the following, the type of the corresponding argument for a conversion specifier shall be a pointer to a type determined by the length modifiers, if any, or specified by the conversion specifier. The conversion specifiers and their meanings are:
d Matches an optionally signed decimal integer, whose format is the same as expected for the subject sequence of the strtol function with the value for the base argument. Unless a length modifier is specified, the corresponding argument shall be a pointer to int.
b Matches an optionally signed binary integer, whose format is the same as expected for the subject sequence of the strtoul function with the value for the base argument. Unless a length modifier is specified, the corresponding argument shall be a pointer to unsigned int.
i Matches an optionally signed integer, whose format is the same as expected for the subject sequence of the strtol function with the value for the base argument. Unless a length modifier is specified, the corresponding argument shall be a pointer to int.
o Matches an optionally signed octal integer, whose format is the same as expected for the subject sequence of the strtoul function with the value for the base argument. Unless a length modifier is specified, the corresponding argument shall be a pointer to unsigned int.
u Matches an optionally signed decimal integer, whose format is the same as expected for the subject sequence of the strtoul function with the value for the base argument. Unless a length modifier is specified, the corresponding argument shall be a pointer to unsigned int.
x Matches an optionally signed hexadecimal integer, whose format is the same as expected for the subject sequence of the strtoul function with the value for the base argument. Unless a length modifier is specified, the corresponding argument shall be a pointer to unsigned int.
a,e,f,g Matches an optionally signed floating-point number, infinity, or NaN, whose format is the same as expected for the subject sequence of the strtod function. Unless a length modifier is specified, the corresponding argument shall be a pointer to float.
c Matches a sequence of characters of exactly the number specified by the field width (1 if no field width is present in the directive).344)
The conversion specifiers A, E, F, G, and X are also valid and behave the same as, respectively, a, e, f, g, and x.
Trailing white-space characters (including new-line characters) are left unread unless matched by a directive. The success of literal matches and suppressed assignments is not directly determinable other than via the %n directive.
Returns
The fscanf function returns the value of the macro EOF if an input failure occurs before the first conversion (if any) has completed. Otherwise, the function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure or if the implementation does not support a specific width length modifier.
EXAMPLE 1 The call:
#include <stdio.h> /* ... */ int n, i; float x; char name[50]; n = fscanf(stdin, "%d%f%s", &i, &x, name);with the input line:
25 54.32E-1 thompsonwill assign to n the value , to i the value , to x the value , and to name the sequence thompson\0.
EXAMPLE 2 The call:
#include <stdio.h> /* ... */ int i; float x; char name[50]; fscanf(stdin, "%2d%f%*d %[0123456789]", &i, &x, name);with input:
56789 0123 56a72will assign to i the value and to x the value , will skip 0123, and will assign to name the sequence 56\0. The next character read from the input stream will be a.
EXAMPLE 3 To accept repeatedly from stdin a quantity, a unit of measure, and an item name:
#include <stdio.h> /* ... */ int count; float quant; char units[21], item[21]; do { count = fscanf(stdin, "%f%20s of %20s", &quant, units, item); fscanf(stdin,"%*[^\n]"); } while (!feof(stdin) && !ferror(stdin));
If the stdin stream contains the following lines:
2 quarts of oil -12.8degrees Celsius lots of luck 10.0LBS of dirt 100ergs of energy quant = 2; strcpy(units, "quarts"); strcpy(item, "oil"); count = 3; quant = -12.8; strcpy(units, "degrees"); count = 2; // "C" fails to match "o" count = 0; // "l" fails to match "%f" quant = 10.0; strcpy(units, "LBS"); strcpy(item, "dirt"); count = 3; count = 0; // "100e" fails to match "%f" count = EOF;
EXAMPLE 4 In:
#include <stdio.h> /* ... */ int d1, d2, n1, n2, i; i = sscanf("123", "%d%n%n%d", &d1, &n1, &n2, &d2);
the value is assigned to d1 and the value to n1. Because %n can never get an input failure, the value of is also assigned to n2. The value of d2 is not affected. The value is assigned to i.
EXAMPLE 5 The call:
#include <stdio.h> /* ... */ int n, i; n = sscanf("foo %bar 42", "foo%%bar%d", &i);
will assign to n the value and to i the value because input white-space characters are skipped for both the % and d conversion specifiers.
EXAMPLE 6 In these examples, multibyte characters do have a state-dependent encoding, and the members of the extended character set that consist of more than one byte each consist of exactly two bytes, the first of which is denoted here by a □and the second by an uppercase letter, but are only recognized as such when in the alternate shift state. The shift sequences are denoted by ↑and ↓, in which the first causes entry into the alternate shift state.
After the call:
#include <stdio.h> /* ... */ char str[50]; fscanf(stdin, "a%s", str);with the input line:
a↑□X□Y↓ bc
str will contain ↑□X□Y↓\0 assuming that none of the bytes of the shift sequences (or of the multibyte characters, in the more general case) appears to be a single-byte white-space character.
In contrast, after the call:
#include <stdio.h> #include <stddef.h> /* ... */ wchar_t wstr[50]; fscanf(stdin, "a%ls", wstr);
However, the call:
#include <stdio.h> #include <stddef.h> /* ... */ wchar_t wstr[50]; fscanf(stdin, "a↑□X↓%ls", wstr);
with the same input line will return zero due to a matching failure against the ↓sequence in the format string.
Assuming that the first byte of the multibyte character □X is the same as the first byte of the multibyte character □Y, after the call:
#include <stdio.h> #include <stddef.h> /* ... */ wchar_t wstr[50]; fscanf(stdin, "a↑□Y↓%ls", wstr);
with the same input line, zero will again be returned, but stdin will be left with a partially consumed multibyte character.
strtod, strtof, and strtold functions (7.25.2.6), the strtol, strtoll, strtoul, and strtoull functions (7.25.2.8), conversion state (7.33.6), the wcrtomb function (7.33.6.4.4).7.24.6.4 The printf function
Synopsis
Description
The printf function is equivalent to fprintf with the argument stdout interposed before the arguments to printf.
Returns
The printf function returns the number of characters transmitted, or a negative value if an output or encoding error occurred.
7.24.6.5 The scanf function
Synopsis
Description
The scanf function is equivalent to fscanf with the argument stdin interposed before the arguments to scanf.
Returns
The scanf function returns the value of the macro EOF if an input failure occurs before the first conversion (if any) has completed. Otherwise, the scanf function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
7.24.6.6 The snprintf function
Synopsis
Description
The snprintf function is equivalent to fprintf, except that the output is written into an array (specified by argument s) rather than to a stream. If n is zero, nothing is written, and s can be a null pointer. Otherwise, output characters beyond the n-1st are discarded rather than being written to the array, and a null character is written at the end of the characters actually written into the array. If copying takes place between objects that overlap, the behavior is undefined.
Returns
The snprintf function returns the number of characters that would have been written had n been sufficiently large, not counting the terminating null character, or a negative value if an encoding error occurred. Thus, the null-terminated output has been completely written if and only if the returned value is both nonnegative and less than n.
7.24.6.7 The sprintf function
Synopsis
Description
The sprintf function is equivalent to fprintf, except that the output is written into an array (specified by the argument s) rather than to a stream. A null character is written at the end of the characters written; it is not counted as part of the returned value. If copying takes place between objects that overlap, the behavior is undefined.
Returns
The sprintf function returns the number of characters written in the array, not counting the terminating null character, or a negative value if an encoding error occurred.
7.24.6.8 The sscanf function
Synopsis
Description
The sscanf function is equivalent to fscanf, except that input is obtained from a string (specified by the argument s) rather than from a stream. Reaching the end of the string is equivalent to encountering end-of-file for the fscanf function. If copying takes place between objects that overlap, the behavior is undefined.
Returns
The sscanf function returns the value of the macro EOF if an input failure occurs before the first conversion (if any) has completed. Otherwise, the sscanf function returns the number of input
7.24.6.9 The vfprintf function
Synopsis
#include <stdarg.h> #include <stdio.h> int vfprintf(FILE * restrict stream, const char * restrict format, va_list arg);
Description
The vfprintf function is equivalent to fprintf, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg invocations). The vfprintf function does not invoke the va_end macro.346)
Returns
The vfprintf function returns the number of characters transmitted, or a negative value if an output or encoding error occurred.
EXAMPLE The following shows the use of the vfprintf function in a general error-reporting routine.
#include <stdarg.h> #include <stdio.h> void error(char *function_name, char *format, ...) { va_list args; va_start(args, format); // print out name of function causing error fprintf(stderr, "ERROR in %s: ", function_name); // print out remainder of message vfprintf(stderr, format, args); va_end(args); }
7.24.6.10 The vfscanf function
Synopsis
#include <stdarg.h> #include <stdio.h> int vfscanf(FILE * restrict stream, const char * restrict format, va_list arg);
Description
The vfscanf function is equivalent to fscanf, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg calls). The vfscanf function does not invoke the va_end macro.346)
Returns
The vfscanf function returns the value of the macro EOF if an input failure occurs before the first conversion (if any) has completed. Otherwise, the vfscanf function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
7.24.6.11 The vprintf function
Synopsis
Description
The vprintf function is equivalent to printf, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg calls). The vprintf function does not invoke the va_end macro.346)
Returns
The vprintf function returns the number of characters transmitted, or a negative value if an output or encoding error occurred.
7.24.6.12 The vscanf function
Synopsis
Description
The vscanf function is equivalent to scanf, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg calls). The vscanf function does not invoke the va_end macro.346)
Returns
The vscanf function returns the value of the macro EOF if an input failure occurs before the first conversion (if any) has completed. Otherwise, the vscanf function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
7.24.6.13 The vsnprintf function
Synopsis
#include <stdarg.h> #include <stdio.h> int vsnprintf(char * restrict s, size_t n, const char * restrict format, va_list arg);
Description
The vsnprintf function is equivalent to snprintf, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg calls). The vsnprintf function does not invoke the va_end macro.346) If copying takes place between objects that overlap, the behavior is undefined.
Returns
The vsnprintf function returns the number of characters that would have been written had n been sufficiently large, not counting the terminating null character, or a negative value if an encoding error occurred. Thus, the null-terminated output has been completely written if and only if the returned value is both nonnegative and less than n.
7.24.6.14 The vsprintf function
Synopsis
#include <stdarg.h> #include <stdio.h> int vsprintf(char * restrict s, const char * restrict format, va_list arg);
Description
The vsprintf function is equivalent to sprintf, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg calls). The vsprintf function does not invoke the va_end macro.346) If copying takes place between objects that overlap, the behavior is undefined.
Returns
The vsprintf function returns the number of characters written in the array, not counting the terminating null character, or a negative value if an encoding error occurred.
7.24.6.15 The vsscanf function
Synopsis
#include <stdarg.h> #include <stdio.h> int vsscanf(const char * restrict s, const char * restrict format, va_list arg);
Description
The vsscanf function is equivalent to sscanf, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg calls). The vsscanf function does not invoke the va_end macro.346)
Returns
The vsscanf function returns the value of the macro EOF if an input failure occurs before the first conversion (if any) has completed. Otherwise, the vsscanf function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
7.24.7 Character input/output functions
7.24.7.1 The fgetc function
Synopsis
Description
If the end-of-file indicator for the input stream pointed to by stream is not set and a next character is present, the fgetc function obtains that character as an unsigned char converted to an int and advances the associated file position indicator for the stream (if defined).
Returns
If the end-of-file indicator for the stream is set, or if the stream is at end-of-file, the end-of-file indicator for the stream is set and the fgetc function returns EOF. Otherwise, the fgetc function returns the next character from the input stream pointed to by stream. If a read error occurs, the error indicator for the stream is set and the fgetc function returns EOF.347)
7.24.7.2 The fgets function
Synopsis
Description
The fgets function reads at most one less than the number of characters specified by n from the stream pointed to by stream into the array pointed to by s. No additional characters are read after a new-line character (which is retained) or after end-of-file. A null character is written immediately after the last character read into the array. If n is negative or zero, the behavior is undefined.
Returns
The fgets function returns s if successful. If end-of-file is encountered and no characters have been read into the array, the contents of the array remain unchanged and a null pointer is returned. If a read error occurs during the operation, the members of the array have unspecified values and a null pointer is returned.
7.24.7.3 The fputc function
Synopsis
Description
The fputc function writes the character specified by c (converted to an unsigned char) to the output stream pointed to by stream, at the position indicated by the associated file position indicator for the stream (if defined), and advances the indicator appropriately. If the file cannot support positioning requests, or if the stream was opened with append mode, the character is appended to the output stream.
Returns
The fputc function returns the character written. If a write error occurs, the error indicator for the stream is set and fputc returns EOF.
7.24.7.4 The fputs function
Synopsis
Description
The fputs function writes the string pointed to by s to the stream pointed to by stream. The terminating null character is not written.
Returns
The fputs function returns EOF if a write error occurs; otherwise it returns a nonnegative value.
7.24.7.5 The getc function
Synopsis
Description
The getc function is equivalent to fgetc, except that if it is implemented as a macro, it may evaluate stream more than once, so the argument should never be an expression with side effects.
Returns
The getc function returns the next character from the input stream pointed to by stream. If the stream is at end-of-file, the end-of-file indicator for the stream is set and getc returns EOF. If a read error occurs, the error indicator for the stream is set and getc returns EOF.
7.24.7.6 The getchar function
Synopsis
Description
The getchar function is equivalent to getc with the argument stdin.
Returns
The getchar function returns the next character from the input stream pointed to by stdin. If the stream is at end-of-file, the end-of-file indicator for the stream is set and getchar returns EOF. If a read error occurs, the error indicator for the stream is set and getchar returns EOF.
7.24.7.7 The putc function
Synopsis
#include <stdio.h> int putc(int c, FILE *stream);
Description
The putc function is equivalent to fputc, except that if it is implemented as a macro, it may evaluate stream more than once, so that argument should never be an expression with side effects.
Returns
The putc function returns the character written. If a write error occurs, the error indicator for the stream is set and putc returns EOF.
7.24.7.8 The putchar function
Synopsis
#include <stdio.h> int putchar(int c);
Description
The putchar function is equivalent to putc with the second argument stdout.
Returns
The putchar function returns the character written. If a write error occurs, the error indicator for the stream is set and putchar returns EOF.
7.24.7.9 The puts function
Synopsis
Description
The puts function writes the string pointed to by s to the stream pointed to by stdout, and appends a new-line character to the output. The terminating null character is not written.
Returns
The puts function returns EOF if a write error occurs; otherwise it returns a nonnegative value.
7.24.7.10 The ungetc function
Synopsis
Description
The ungetc function pushes the character specified by c (converted to an unsigned char) back onto the input stream pointed to by stream. Pushed-back characters will be returned by subsequent reads on that stream in the reverse order of their pushing. A successful intervening call (with the stream pointed to by stream) to a file positioning function (fseek, fsetpos, or rewind) discards any pushed-back characters for the stream. The external storage corresponding to the stream is unchanged.
One character of pushback is guaranteed. If the ungetc function is called too many times on the same stream without an intervening read or file positioning operation on that stream, the operation can fail.
If the value of c equals that of the macro EOF, the operation fails and the input stream is unchanged.
A successful call to the ungetc function clears the end-of-file indicator for the stream. The value of the file position indicator for the stream after reading or discarding all pushed-back characters shall be the same as it was before the characters were pushed back.348) For a text stream, the value of its file position indicator after a successful call to the ungetc function is unspecified until all pushed-back characters are read or discarded. For a binary stream, its file position indicator is decremented by each successful call to the ungetc function; if its value was zero before a call, it has an indeterminate representation after the call.349)
Returns
The ungetc function returns the character pushed back after conversion, or EOF if the operation fails.
7.24.8 Direct input/output functions
7.24.8.1 The fread function
Synopsis
#include <stdio.h> size_t fread(void * restrict ptr, size_t size, size_t nmemb, FILE * restrict stream);
Description
The fread function reads, into the array pointed to by ptr, up to nmemb elements whose size is specified by size, from the stream pointed to by stream. For each object, size calls are made to the fgetc function and the results stored, in the order read, in an array of unsigned char exactly overlaying the object. The file position indicator for the stream (if defined) is advanced by the number of characters successfully read. If an error occurs, the resulting representation of the file position indicator for the stream is indeterminate. If a partial element is read, its representation is indeterminate.
Returns
The fread function returns the number of elements successfully read, which can be less than nmemb if a read error or end-of-file is encountered. If size or nmemb is zero, ptr may be a null pointer, fread returns zero and the contents of the array and the state of the stream remain unchanged.
7.24.8.2 The fwrite function
Synopsis
#include <stdio.h> size_t fwrite(const void * restrict ptr, size_t size, size_t nmemb, FILE * restrict stream);
Description
The fwrite function writes, from the array pointed to by ptr, up to nmemb elements whose size is specified by size, to the stream pointed to by stream. For each object, size calls are made to the fputc function, taking the values (in order) from an array of unsigned char exactly overlaying the object. The file position indicator for the stream (if defined) is advanced by the number of characters successfully written. If an error occurs, the resulting representation of the file position indicator for the stream is indeterminate.
Returns
The fwrite function returns the number of elements successfully written, which will be less than nmemb only if a write error is encountered. If size or nmemb is zero, ptr may be a null pointer, fwrite returns zero and the state of the stream remains unchanged.
7.24.9 File positioning functions
7.24.9.1 The fgetpos function
Synopsis
Description
The fgetpos function stores the current values of the parse state (if any) and file position indicator for the stream pointed to by stream in the object pointed to by pos. The values stored contain unspecified information usable by the fsetpos function for repositioning the stream to its position at the time of the call to the fgetpos function.
Returns
If successful, the fgetpos function returns zero; on failure, the fgetpos function returns nonzero and stores an implementation-defined positive value in errno.
fsetpos function (7.24.9.3).7.24.9.2 The fseek function
Synopsis
Description
The fseek function sets the file position indicator for the stream pointed to by stream. If a read or write error occurs, the error indicator for the stream is set and fseek fails.
For a binary stream, the new position, measured in characters from the beginning of the file, is obtained by adding offset to the position specified by whence. The specified position is the beginning of the file if whence is SEEK_SET, the current value of the file position indicator if SEEK_CUR,
For a text stream, either offset shall be zero, or offset shall be a value returned by an earlier successful call to the ftell function on a stream associated with the same file and whence shall be SEEK_SET.
After determining the new position, a successful call to the fseek function undoes any effects of the ungetc function on the stream, clears the end-of-file indicator for the stream, and then establishes the new position. After a successful fseek call, the next operation on an update stream may be either input or output.
Returns
The fseek function returns nonzero only for a request that cannot be satisfied.
ftell function (7.24.9.4).7.24.9.3 The fsetpos function
Synopsis
Description
The fsetpos function sets the mbstate_t object (if any) and file position indicator for the stream pointed to by stream according to the value of the object pointed to by pos, which shall be a value obtained from an earlier successful call to the fgetpos function on a stream associated with the same file. If a read or write error occurs, the error indicator for the stream is set and fsetpos fails.
A successful call to the fsetpos function undoes any effects of the ungetc function on the stream, clears the end-of-file indicator for the stream, and then establishes the new parse state and position. After a successful fsetpos call, the next operation on an update stream may be either input or output.
Returns
If successful, the fsetpos function returns zero; on failure, the fsetpos function returns nonzero and stores an implementation-defined positive value in errno.
7.24.9.4 The ftell function
Synopsis
Description
The ftell function obtains the current value of the file position indicator for the stream pointed to by stream. For a binary stream, the value is the number of characters from the beginning of the file. For a text stream, its file position indicator contains unspecified information, usable by the fseek function for returning the file position indicator for the stream to its position at the time of the ftell call; the difference between two such return values is not necessarily a meaningful measure of the number of characters written or read.
Returns
If successful, the ftell function returns the current value of the file position indicator for the stream. On failure, the ftell function returns -1L and stores an implementation-defined positive value in errno.
7.24.9.5 The rewind function
Synopsis
Description
The rewind function sets the file position indicator for the stream pointed to by stream to the beginning of the file. It is equivalent to
(void)fseek(stream, 0L, SEEK_SET)
except that the error indicator for the stream is also cleared.
Returns
The rewind function returns no value.
7.24.10 Error-handling functions
7.24.10.1 The clearerr function
Synopsis
Description
The clearerr function clears the end-of-file and error indicators for the stream pointed to by stream.
Returns
The clearerr function returns no value.
7.24.10.2 The feof function
Synopsis
Description
The feof function tests the end-of-file indicator for the stream pointed to by stream.
Returns
The feof function returns nonzero if and only if the end-of-file indicator is set for stream.
7.24.10.3 The ferror function
Synopsis
Description
The ferror function tests the error indicator for the stream pointed to by stream.
Returns
The ferror function returns nonzero if and only if the error indicator is set for stream.
7.24.10.4 The perror function
Synopsis
Description
The perror function maps the error number in the integer expression errno to an error message. It writes a sequence of characters to the standard error stream thus: first (if s is not a null pointer and the character pointed to by s is not the null character), the string pointed to by s followed by a colon (:) and a space; then an appropriate error message string followed by a new-line character. The contents of the error message strings are the same as those returned by the strerror function with argument errno.
Returns
The perror function returns no value.
strerror function (7.28.6.3).7.25 General utilities <stdlib.h>
7.25.1 General
The header <stdlib.h> declares several types and functions of general utility, and defines several macros.350)
The feature test macro __STDC_VERSION_STDLIB_H__ expands to the token 202ymmL.
The types declared are size_t and wchar_t (both described in 7.22), once_flag (described in 7.30),
div_twhich is a structure type that is the type of the value returned by the div function,ldiv_twhich is a structure type that is the type of the value returned by the ldiv function, andlldiv_twhich is a structure type that is the type of the value returned by the lldiv function.
The macros defined are NULL (described in 7.22); ONCE_FLAG_INIT (described in 7.30);
EXIT_FAILUREandEXIT_SUCCESSwhich expand to integer constant expressions that can be used as the argument to the exit function to return unsuccessful or successful termination status, respectively, to the host environment;RAND_MAXwhich expands to an integer constant expression that is the maximum value returned by the rand function; andMB_CUR_MAXwhich expands to a positive integer expression with type size_t that is the maximum number of bytes in a multibyte character for the extended character set specified by the current locale (category LC_CTYPE), which is never greater than MB_LEN_MAX.
The function
#include <stdlib.h> void call_once(once_flag *flag, void (*func)(void));
is described in 7.30.2.
7.25.2 Numeric conversion functions
7.25.2.1 General
The functions atof, atoi, atol, and atoll are not required to affect the value of the integer expression errno on an error. If the value of the result cannot be represented, the behavior is undefined.
7.25.2.2 The atof function
Synopsis
Description
The atof function converts the initial portion of the string pointed to by nptr to double representation. Except for the behavior on error, it is equivalent to
strtod(nptr, nullptr)
Returns
The atof function returns the converted value.
7.25.2.3 The atoi, atol, and atoll functions
Synopsis
#include <stdlib.h> int atoi(const char *nptr); long int atol(const char *nptr); long long int atoll(const char *nptr);
Description
The atoi, atol, and atoll functions convert the initial portion of the string pointed to by nptr to int, long int, and long long int representation, respectively. Except for the behavior on error, they are equivalent to
atoi: (int)strtol(nptr, nullptr, 10) atol: strtol(nptr, nullptr, 10) atoll: strtoll(nptr, nullptr, 10)
Returns
The atoi, atol, and atoll functions return the converted value.
7.25.2.4 The strfromd, strfromf, and strfroml functions
Synopsis
#include <stdlib.h> int strfromd(char * restrict s, size_t n, const char * restrict format, double fp); int strfromf(char * restrict s, size_t n, const char * restrict format, float fp); int strfroml(char * restrict s, size_t n, const char * restrict format, long double fp);
Description
The strfromd, strfromf, and strfroml functions are equivalent to snprintf(s, n, format, fp) (7.24.6.6), except that the default argument promotions are not applied and the format string shall only contain the character %, an optional precision that does not contain an asterisk *, and one of the conversion specifiers a, A, e, E, f, F, g, or G, which applies to the type (double, float, or long double) indicated by the function suffix (rather than by a length modifier). Use of these functions with any other format string results in undefined behavior.
Returns
The strfromd, strfromf, and strfroml functions return the number of characters that would have been written had n been sufficiently large, not counting the terminating null character. Thus, the null-terminated output has been completely written if and only if the returned value is both nonnegative and less than n.
7.25.2.5 The strfromdN functions
Synopsis
#include <stdlib.h> #ifdef __STDC_IEC_60559_DFP__ int strfromd32(char * restrict s, size_t n, const char * restrict format, _Decimal32 fp); int strfromd64(char * restrict s, size_t n, const char * restrict format, _Decimal64 fp); int strfromd128(char * restrict s, size_t n, const char * restrict format, _Decimal128 fp); #endif
Description
The strfromdN functions are equivalent to snprintf(s, n, format, fp) (7.24.6.6), except the format string contains only the character %, an optional precision that does not contain an asterisk *, and one of the conversion specifiers a, A, e, E, f, F, g, or G, which applies to the type (_Decimal32, _Decimal64, or _Decimal128) indicated by the function suffix (rather than by a length modifier). Use of these functions with any other format string results in undefined behavior.
Returns
The strfromdN functions return the number of characters that would have been written had n been sufficiently large, not counting the terminating null character. Thus, the null-terminated output has been completely written if and only if the returned value is both nonnegative and less than n.
7.25.2.6 The strtod, strtof, and strtold functions
Synopsis
#include <stdlib.h> double strtod(const char * restrict nptr, char ** restrict endptr); float strtof(const char * restrict nptr, char ** restrict endptr); long double strtold(const char * restrict nptr, char ** restrict endptr);
Description
The strtod, strtof, and strtold functions convert the initial portion of the string pointed to by nptr to double, float, and long double representation, respectively. First, they decompose the input string into three parts: an initial, possibly empty, sequence of white-space characters, a subject sequence resembling a floating literal or representing an infinity or NaN; and a final string of one or more unrecognized characters, including the terminating null character of the input string. Then, they attempt to convert the subject sequence to a floating-point number, and return the result.
The expected form of the subject sequence is an optional plus or minus sign, then one of the following:
- decimal form: a nonempty sequence of decimal digits optionally containing a decimal-point character, then an optional exponent part as defined in 6.4.5.3, excluding any digit separators (6.4.5.2);
- hexadecimal form: a
0xor0X, then a nonempty sequence of hexadecimal digits optionally containing a decimal-point character, then an optional binary exponent part as defined in 6.4.5.3, excluding any digit separators; -
INForINFINITY, ignoring case
The subject sequence is defined as the longest initial subsequence of the input string, starting with the first non-white-space character, that is of the expected form. The subject sequence contains no characters if the input string is not of the expected form.
If the subject sequence has the decimal or hexadecimal form, the sequence of characters starting with the first digit or the decimal-point character (whichever occurs first) is interpreted as a floating literal according to the rules of 6.4.5.3, except that the decimal-point character is used in place of a period, and that if neither an exponent part nor a decimal-point character appears in a decimal form, or if a binary exponent part does not appear in a hexadecimal form, an exponent part of the appropriate type with value zero is assumed to follow the last digit in the string. If the subject sequence begins with a minus sign, the sequence is interpreted as arithmetically negated.351)
A character sequence INF or INFINITY is interpreted as an infinity, if representable in the return type, else like a floating literal that is too large for the range of the return type. A character sequence NAN or NAN(n-char-sequenceopt) is interpreted as a quiet NaN, if supported in the return type, else like a subject sequence part that does not have the expected form; the meaning of the n-char sequence is implementation-defined.352) A pointer to the final string is stored in the object pointed to by endptr, provided that endptr is not a null pointer.
If the subject sequence has the hexadecimal form and FLT_RADIX is a power of , the value resulting from the conversion is correctly rounded.
In other than the "C" locale, additional locale-specific subject sequence forms may be accepted.
If the subject sequence is empty or does not have the expected form, no conversion is performed; the value of nptr is stored in the object pointed to by endptr, provided that endptr is not a null pointer.
Recommended practice
If the subject sequence has the hexadecimal form, FLT_RADIX is not a power of , and the result is not exactly representable, the result should be one of the two numbers in the appropriate internal format that are adjacent to the hexadecimal floating source value, with the extra stipulation that the error should have a correct sign for the current rounding direction.
If the subject sequence has the decimal form and at most significant digits, where is the maximum value of the T_DECIMAL_DIG macros (defined in <float.h>), the result should be correctly rounded. If the subject sequence D has the decimal form and more than significant digits, consider the two bounding, adjacent decimal strings L and U, both having significant digits, such that the values of L, D, and U satisfy L ≤D ≤U. The result should be one of the (equal or adjacent) values that would be obtained by correctly rounding L and U according to the current rounding direction, with the extra stipulation that the error with respect to D should have a correct sign for the current rounding direction.353)
Returns
The functions return the converted value, if any. If no conversion could be performed, positive or unsigned zero is returned.
If the correct value overflows and default rounding is in effect (7.12.2), plus or minus HUGE_VAL, HUGE_VALF, or HUGE_VALL is returned (according to the return type and sign of the value); if the
If the result underflows (7.12.2), the functions return a value whose magnitude is no greater than the smallest normalized positive number in the return type; if the integer expression math_errhandling & MATH_ERRNO is nonzero, whether errno acquires the value ERANGE is implementation-defined; if the integer expression math_errhandling & MATH_ERREXCEPT is nonzero, whether the "underflow" floating-point exception is raised is implementation-defined.
7.25.2.7 The strtodN functions
Synopsis
#include <stdlib.h> #ifdef __STDC_IEC_60559_DFP__ _Decimal32 strtod32(const char * restrict nptr, char ** restrict endptr); _Decimal64 strtod64(const char * restrict nptr, char ** restrict endptr); _Decimal128 strtod128(const char * restrict nptr, char ** restrict endptr); #endif
Description
The strtodN functions convert the initial portion of the string pointed to by nptr to decimal floating type representation. First, they decompose the input string into three parts: an initial, possibly empty, sequence of white-space characters; a subject sequence resembling a floating literal or representing an infinity or NaN; and a final string of one or more unrecognized characters, including the terminating null character of the input string. Then, they attempt to convert the subject sequence to a floating-point number, and return the result.
The expected form of the subject sequence is an optional plus or minus sign, then one of the following:
- decimal form: a nonempty sequence of decimal digits optionally containing a decimal-point character, then an optional exponent part as defined in 6.4.5.3, excluding any digit separators (6.4.5.2)
- hexadecimal form: a
0xor0X, then a nonempty sequence of hexadecimal digits optionally containing a decimal-point character, then an optional binary exponent part as defined in 6.4.5.3, excluding any digit separators (6.4.5.2) -
INForINFINITY, ignoring case -
NANorNAN(d-char-sequenceopt), ignoring case in theNANpart, where:
The subject sequence is defined as the longest initial subsequence of the input string, starting with the first non-white-space character, that is of the expected form. The subject sequence contains no characters if the input string is not of the expected form.
If the subject sequence has the decimal or hexadecimal form, the sequence of characters starting with the first digit or the decimal-point character (whichever occurs first) is interpreted as a floating literal according to the rules of 6.4.5.3, except that the decimal-point character is used in place of a period, and that if neither an exponent part nor a decimal-point character appears in a decimal form, or if a binary exponent part does not appear in a hexadecimal form, an exponent part of the appropriate type with value zero is assumed to follow the last digit in the string. If the subject sequence begins with a minus sign, the sequence is interpreted as arithmetically negated before rounding and the sign is set to , else is set to .
If the subject sequence has the decimal form, the value resulting from the conversion is correctly rounded and the coefficient and the quantum exponent are determined by the rules in 6.4.5.3 for a decimal floating literal of decimal type.
If the subject sequence has the hexadecimal form, the value resulting from the conversion is correctly rounded provided the subject sequence has at most significant hexadecimal digits, where is implementation-defined, and is the maximum precision of the supported radix-2 floating types and binary non-arithmetic interchange formats.354) If the value resulting from the conversion is correctly rounded for all subject sequences of hexadecimal form, may be regarded as infinite. If the subject sequence has more than significant hexadecimal digits, the implementation may first round to significant hexadecimal digits according to the applicable decimal rounding direction mode, signaling exceptions as though converting from a wider format, then correctly round the result of the shortened hexadecimal input to the result type. The preferred quantum exponent for the result is if the hexadecimal number is exactly represented in the decimal type; the preferred quantum exponent for the result is the least possible if the hexadecimal number is not exactly represented in the decimal type.
A character sequence INF or INFINITY is interpreted as an infinity. A character sequence NAN or NAN(d-char-sequenceopt), is interpreted as a quiet NaN; the meaning of the d-char sequence is implementation-defined.355) A pointer to the final string is stored in the object pointed to by endptr, provided that endptr is not a null pointer.
In other than the "C" locale, additional locale-specific subject sequence forms may be accepted.
If the subject sequence is empty or does not have the expected form, no conversion is performed; the value of nptr is stored in the object pointed to by endptr, provided that endptr is not a null pointer.
Returns
The strtodN functions return the converted value, if any. If no conversion could be performed, the value of the triple is returned. If the correct value overflows:
- the value of the macro
ERANGEis stored inerrnoif the integer expressionmath_errhandling
& MATH_ERRNO is nonzero;
- the "overflow" floating-point exception is raised if the integer expression
math_errhandling
& MATH_ERREXCEPT is nonzero.
If the result underflows (7.12.2), whether errno acquires the value ERANGE if the integer expression math_errhandling & MATH_ERRNO is nonzero is implementation-defined; if the integer expression math_errhandling & MATH_ERREXCEPT is nonzero, whether the "underflow" floating-point exception is raised is implementation-defined.
EXAMPLE Following are subject sequences of the decimal form and the resulting triples produced by strtod64. For _Decimal64, the precision (maximum coefficient length) is and the quantum exponent range is .
"0" "0.00" "123" "-123" "1.23E3" "1.23E+3" "12.3E+7" "12.0" "12.3" "0.00123" "-1.23E-12" "1234.5E-4"
7.25.2.8 The strtol, strtoll, strtoul, and strtoull functions
Synopsis
#include <stdlib.h> long int strtol(const char * restrict nptr, char ** restrict endptr, int base); long long int strtoll(const char * restrict nptr, char ** restrict endptr, int base); unsigned long int strtoul(const char * restrict nptr, char ** restrict endptr, int base); unsigned long long int strtoull(const char * restrict nptr, char ** restrict endptr, int base);
Description
The strtol, strtoll, strtoul, and strtoull functions convert the initial portion of the string pointed to by nptr to long int, long long int, unsigned long int, and unsigned long long int representation, respectively. First, they decompose the input string into three parts: an initial, possibly empty, sequence of white-space characters, a subject sequence resembling an integer represented in some radix determined by the value of base, and a final string of one or more unrecognized characters, including the terminating null character of the input string. Then, they attempt to convert the subject sequence to an integer, and return the result.
If the value of base is zero, the expected form of the subject sequence is that of an integer literal as described in 6.4.5.2, optionally preceded by a plus or minus sign, but not including an integer suffix or any optional digit separators. If the value of base is between 2 and 36 (inclusive), the expected form of the subject sequence is a sequence of letters and digits representing an integer with the radix specified by base, optionally preceded by a plus or minus sign, but not including an integer suffix or any optional digit separators. The letters from a (or A) through z (or Z) are ascribed the values through ; only letters and digits whose ascribed values are less than that of base are permitted. If the value of base is , the characters 0b or 0B can optionally precede the sequence of letters and digits, following the sign if present. If the value of base is , the characters 0o or 0O can optionally
The subject sequence is defined as the longest initial subsequence of the input string, starting with the first non-white-space character, that is of the expected form. The subject sequence contains no characters if the input string is empty or consists entirely of white-space characters, or if the first non-white-space character is other than a sign or a permissible letter or digit.
If the subject sequence has the expected form and the value of base is zero, the sequence of characters starting with the first digit is interpreted as an integer literal according to the rules of 6.4.5.2. If the subject sequence has the expected form and the value of base is between and , it is used as the base for conversion, ascribing to each letter its value as previously given. If the subject sequence begins with a minus sign, the resulting value is the negative of the converted value; for functions whose return type is an unsigned integer type this action is performed in the return type. A pointer to the final string is stored in the object pointed to by endptr, provided that endptr is not a null pointer.
In other than the "C" locale, additional locale-specific subject sequence forms may be accepted.
If the subject sequence is empty or does not have the expected form, no conversion is performed; the value of nptr is stored in the object pointed to by endptr, provided that endptr is not a null pointer.
Returns
The strtol, strtoll, strtoul, and strtoull functions return the converted value, if any. If no conversion could be performed, zero is returned. If the correct value is outside the range of representable values, LONG_MIN, LONG_MAX, LLONG_MIN, LLONG_MAX, ULONG_MAX, or ULLONG_MAX is returned (according to the return type and sign of the value, if any), and the value of the macro ERANGE is stored in errno.
7.25.3 Pseudo-random sequence generation functions
7.25.3.1 The rand function
Synopsis
Description
The rand function computes a sequence of pseudo-random integers in the range 0 to RAND_MAX inclusive.
The rand function is not required to avoid data races with other calls to pseudo-random sequence generation functions. The implementation shall behave as if no library function calls the rand function.
NOTE There are no guarantees as to the quality of the random sequence produced and some implementations are known to produce sequences with distressingly non-random low-order bits. Applications with particular requirements should use a generator that is known to be sufficient for their needs.
Returns
The rand function returns a pseudo-random integer.
Environmental limits
The value of the RAND_MAX macro shall be at least .
7.25.3.2 The srand function
Synopsis
Description
The srand function uses the argument as a seed for a new sequence of pseudo-random numbers to be returned by subsequent calls to rand. If srand is then called with the same seed value, the sequence of pseudo-random numbers shall be repeated. If rand is called before any calls to srand have been made, the same sequence shall be generated as when srand is first called with a seed value of .
The srand function is not required to avoid data races with other calls to pseudo-random sequence generation functions. The implementation shall behave as if no library function calls the srand function.
Returns
The srand function returns no value.
EXAMPLE The following functions define a portable implementation of rand and srand.
static unsigned long int next = 1; int rand(void) // RAND_MAX assumed to be 32767 { next = next * 1103515245 + 12345; return (unsigned int)(next/65536) % 32768; } void srand(unsigned int seed) { next = seed; }
7.25.4 Memory management functions
7.25.4.1 General
The order and contiguity of storage allocated by successive calls to the aligned_alloc, calloc, malloc, and realloc functions is unspecified. The pointer returned if the allocation succeeds is suitably aligned so that it can be assigned to a pointer to any type of object with a fundamental alignment requirement and size less than or equal to the size requested. It can then be used to access such an object or an array of such objects in the space allocated (until the space is explicitly deallocated). The lifetime of an allocated object extends from the allocation until the deallocation. Each such allocation shall yield a pointer to an object disjoint from any other object. The pointer returned points to the start (lowest byte address) of the allocated space. If the space cannot be allocated, a null pointer is returned. If the size of the space requested is zero, the behavior is implementation-defined: either a null pointer is returned to indicate an error, or the behavior is as if the size were some nonzero value, except that the returned pointer shall not be used to access an object.
For purposes of determining the existence of a data race, memory allocation functions behave as though they accessed only memory locations accessible through their arguments and not other static duration storage. These functions may, however, visibly modify the storage that they allocate or deallocate. Calls to these functions that allocate or deallocate a particular region of memory shall occur in a single total order, and each such deallocation call shall synchronize with the next allocation (if any) in this order.
7.25.4.2 The aligned_alloc function
Synopsis
#include <stdlib.h> void *aligned_alloc(size_t alignment, size_t size);
Description
The aligned_alloc function allocates space for an object whose alignment is specified by alignment,356) whose size is specified by size, and whose bytes have unspecified values. If the value of alignment is not a valid alignment supported by the implementation the function shall fail by returning a null pointer.
Returns
The aligned_alloc function returns either a null pointer or a pointer to the allocated space.
7.25.4.3 The calloc function
Synopsis
Description
The calloc function allocates space for an array of nmemb objects, each of whose size is size. The space is initialized to all bits zero.357)
Returns
The calloc function returns either a pointer to the allocated space or a null pointer if the space cannot be allocated or if the product nmemb * size would wraparound size_t.
7.25.4.4 The free function
Synopsis
Description
The free function causes the space pointed to by ptr to be deallocated, that is, made available for further allocation. If ptr is a null pointer, no action occurs. Otherwise, if the argument does not match a pointer earlier returned by a memory management function, or if the space has been deallocated by a call to free or realloc, the behavior is undefined.
Returns
The free function returns no value.
7.25.4.5 The free_sized function
Synopsis
#include <stdlib.h> void free_sized(void *ptr, size_t size);
Description
If ptr is a null pointer or the result obtained from a call to malloc, realloc, or calloc, where size size is equal to the requested allocation size, this function is equivalent to free(ptr). Otherwise, the behavior is undefined. The result of an aligned_alloc call may not be passed to free_sized.
NOTE A conforming implementation can ignore size and call free.
Recommended practice
Implementations may provide extensions to query the usable size of an allocation, or to determine the usable size of the allocation that would result if a request for some other size were to succeed.
Returns
The free_sized function returns no value.
7.25.4.6 The free_aligned_sized function
Synopsis
#include <stdlib.h> void free_aligned_sized(void *ptr, size_t alignment, size_t size);
Description
If ptr is a null pointer or the result obtained from a call to aligned_alloc, where alignment is equal to the requested allocation alignment and size is equal to the requested allocation size, this function is equivalent to free(ptr). Otherwise, the behavior is undefined. The result of an malloc, calloc, or realloc call may not be passed to free_aligned_sized.
NOTE A conforming implementation can ignore alignment and size and call free.
Recommended practice
Implementations may provide extensions to query the usable size of an allocation, or to determine the usable size of the allocation that would result if a request for some other size were to succeed. Such implementations should allow passing the resulting usable size as the size parameter, and provide functionality equivalent to free in such cases.
Returns
The free_aligned_sized function returns no value.
7.25.4.7 The malloc function
Synopsis
Description
The malloc function allocates space for an object whose size is specified by size and whose bytes have unspecified values.
Returns
The malloc function returns either a null pointer or a pointer to the allocated space.
7.25.4.8 The realloc function
Synopsis
Description
The realloc function deallocates the old object pointed to by ptr and returns a pointer to a new object that has the size specified by size. The contents of the new object shall be the same as that of the old object prior to deallocation, up to the lesser of the new and old sizes. Any bytes in the new object beyond the size of the old object have unspecified values.
If ptr is a null pointer, the realloc function behaves like the malloc function for the specified size. Otherwise, if ptr does not match a pointer earlier returned by a memory management function, or if the space has been deallocated by a call to the free or realloc function, or if the size is zero, the
Returns
The realloc function returns a pointer to the new object (which can have the same value as a pointer to the old object), or a null pointer if the new object has not been allocated.
7.25.5 Communication with the environment
7.25.5.1 The abort function
Synopsis
Description
The abort function causes abnormal program termination to occur, unless the signal SIGABRT is being caught and the signal handler does not return. Whether open streams with unwritten buffered data are flushed, open streams are closed, or temporary files are removed is implementationdefined. An implementation-defined form of the status unsuccessful termination is returned to the host environment by means of the function call raise(SIGABRT).
Returns
The abort function does not return to its caller.
7.25.5.2 The atexit function
Synopsis
Description
The atexit function registers the function pointed to by func, to be called without arguments at normal program termination.358) It is unspecified whether a call to the atexit function that does not happen before the exit function is called will succeed.
Environmental limits
The implementation shall support the registration of at least 32 functions.
Returns
The atexit function returns zero if the registration succeeds, nonzero if it fails.
7.25.5.3 The at_quick_exit function
Synopsis
#include <stdlib.h> int at_quick_exit(void (*func)(void));
Description
The at_quick_exit function registers the function pointed to by func, to be called without arguments should quick_exit be called.359) It is unspecified whether a call to the at_quick_exit function that does not happen before the quick_exit function is called will succeed.
Environmental limits
The implementation shall support the registration of at least 32 functions.
Returns
The at_quick_exit function returns zero if the registration succeeds, nonzero if it fails.
quick_exit function (7.25.5.7).7.25.5.4 The exit function
Synopsis
Description
The exit function causes normal program termination to occur. No functions registered by the at_quick_exit function are called. If a program calls the exit function more than once, or calls the quick_exit function in addition to the exit function, the behavior is undefined.
First, all functions registered by the atexit function are called, in the reverse order of their registration,360) except that a function is called after any previously registered functions that had already been called at the time it was registered. If, during the call to any such function, a call to the longjmp function is made that would terminate the call to the registered function, the behavior is undefined.
Next, all open streams with unwritten buffered data are flushed, all open streams are closed, and all files created by the tmpfile function are removed.
Finally, control is returned to the host environment. If the value of status is zero or EXIT_SUCCESS, an implementation-defined form of the status successful termination is returned. If the value of status is EXIT_FAILURE, an implementation-defined form of the status unsuccessful termination is returned. Otherwise the status returned is implementation-defined.
Returns
The exit function cannot return to its caller.
7.25.5.5 The _Exit function
Synopsis
Description
The _Exit function causes normal program termination to occur and control to be returned to the host environment. No functions registered by the atexit function, the at_quick_exit function, or signal handlers registered by the signal function are called. The status returned to the host environment is determined in the same way as for the exit function (7.25.5.4). Whether open streams with unwritten buffered data are flushed, open streams are closed, or temporary files are removed is implementation-defined.
Returns
The _Exit function cannot return to its caller.
7.25.5.6 The getenv function
Synopsis
Description
The getenv function searches an environment list, provided by the host environment, for a string that matches the string pointed to by name. The set of environment names and the method for altering the environment list are implementation-defined. The getenv function is not required to avoid data races with other threads of execution that modify the environment list.361)
The implementation shall behave as if no library function calls the getenv function.
Returns
The getenv function returns a pointer to a string associated with the matched list member. The string pointed to shall not be modified by the program, but can be overwritten by a subsequent call to the getenv function. If the specified name cannot be found, a null pointer is returned.
7.25.5.7 The quick_exit function
Synopsis
#include <stdlib.h> [[noreturn]] void quick_exit(int status);
Description
The quick_exit function causes normal program termination to occur. No functions registered by the atexit function or signal handlers registered by the signal function are called. If a program calls the quick_exit function more than once, or calls the exit function in addition to the quick_exit function, the behavior is undefined. If a signal is raised while the quick_exit function is executing, the behavior is undefined.
The quick_exit function first calls all functions registered by the at_quick_exit function, in the reverse order of their registration,362) except that a function is called after any previously registered functions that had already been called at the time it was registered. If, during the call to any such function, a call to the longjmp function is made that would terminate the call to the registered function, the behavior is undefined.
Then control is returned to the host environment by means of the function call _Exit(status).
Returns
The quick_exit function cannot return to its caller.
7.25.5.8 The system function
Synopsis
Description
If string is a null pointer, the system function determines whether the host environment has a command processor. If string is not a null pointer, the system function passes the string pointed to by string to that command processor to be executed in a manner which the implementation shall document; this can then cause the program calling system to behave in a non-conforming manner or to terminate.
Returns
If the argument is a null pointer, the system function returns nonzero only if a command processor is available. If the argument is not a null pointer, and the system function does return, it returns an implementation-defined value.
7.25.6 Searching and sorting utilities
7.25.6.1 General
These utilities make use of a comparison function to search or sort arrays of unspecified type. Where an argument declared as size_t nmemb specifies the length of the array for a function, nmemb can have the value zero on a call to that function; the comparison function is not called, a search finds no matching element, and sorting performs no rearrangement. Pointer arguments on such a call may be null pointers.
The implementation shall ensure that the second argument of the comparison function (when called from bsearch), or both arguments (when called from qsort), are pointers to elements of the array.363)
The first argument when called from bsearch shall equal key.
The comparison function shall not alter the contents of the array. The implementation may reorder elements of the array between calls to the comparison function, but shall not alter the contents of any individual element.
When the same objects (consisting of size bytes, irrespective of their current positions in the array) are passed more than once to the comparison function, the results shall be consistent with one another. That is, for qsort they shall define a total ordering on the array, and for bsearch the same object shall always compare the same way with the key.
A sequence point occurs immediately before and immediately after each call to the comparison function, and also between any call to the comparison function and any movement of the objects passed as arguments to that call.
7.25.6.2 The bsearch generic function
Synopsis
#include <stdlib.h> QVoid *bsearch(const void *key, QVoid *base, size_t nmemb, size_t size, int (*compar)(const void *, const void *));
Description
The bsearch generic function searches an array of nmemb objects, the initial element of which is pointed to by base, for an element that matches the object pointed to by key. The size of each element of the array is specified by size.
The comparison function pointed to by compar is called with two arguments that point to the key object and to an array element, in that order. The function shall return an integer less than, equal to, or greater than zero if the key object is considered, respectively, to be less than, to match, or to be greater than the array element. The array shall consist of: all the elements that compare less than, all the elements that compare equal to, and all the elements that compare greater than the key object, in that order.364)
Returns
The bsearch generic function returns a pointer to a matching element of the array, or a null pointer if no match is found. If two elements compare as equal, which element is matched is unspecified.
The bsearch function is generic in the qualification of the type pointed to by the argument base. If this argument is a pointer to a const-qualified object type, the returned pointer will be a pointer to const-qualified void. Otherwise, the argument shall be a pointer to an unqualified object type or a null pointer constant, and the returned pointer will be a pointer to unqualified void.
The external declaration of bsearch has the concrete type:
void * (const void *, const void *, size_t, size_t, int (*) (const void *, const void *))
7.25.6.3 The qsort function
Synopsis
#include <stdlib.h> void qsort(void *base, size_t nmemb, size_t size, int (*compar)(const void *, const void *));
Description
The qsort function sorts an array of nmemb objects, the initial element of which is pointed to by base. The size of each object is specified by size.
The contents of the array are sorted into ascending order according to a comparison function pointed to by compar, which is called with two arguments that point to the objects being compared. The function shall return an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second.
If two elements compare as equal, their order in the resulting sorted array is unspecified.
Returns
The qsort function returns no value.
7.25.7 Integer arithmetic functions
7.25.7.1 The abs, uabs, labs, ulabs, llabs, and ullabs functions
Synopsis
#include <stdlib.h> int abs(int j); unsigned int uabs(int j); long int labs(long int j); unsigned long int ulabs(long int j); long long int llabs(long long int j); unsigned long long int ullabs(long long int j);
Description
The abs, uabs, labs, ulabs, llabs, and ullabs functions compute the absolute value of an integer j. If the result cannot be represented, the behavior is undefined.366)
Returns
The abs, uabs, labs, ulabs, llabs, and ullabs functions return the absolute value.
7.25.7.2 The div, ldiv, and lldiv functions
Synopsis
#include <stdlib.h> div_t div(int numer, int denom); ldiv_t ldiv(long int numer, long int denom); lldiv_t lldiv(long long int numer, long long int denom);
Description
The div, ldiv, and lldiv, functions compute numer/denom and numer%denom in a single operation.
Returns
The div, ldiv, and lldiv functions return a structure of type div_t, ldiv_t, and lldiv_t, respectively, comprising both the quotient and the remainder. The structures shall contain (in either order) the members quot (the quotient) and rem (the remainder), each of which has the same type as the arguments numer and denom. If either part of the result cannot be represented, the behavior is undefined.
7.25.8 Multibyte/wide character conversion functions
7.25.8.1 General
The behavior of the multibyte character functions is affected by the LC_CTYPE category of the current locale. For a state-dependent encoding, each of the mbtowc and wctomb functions is placed into its initial conversion state prior to the first call to the function and can be returned to that state by a call for which its character pointer argument, s, is a null pointer. Subsequent calls with s as other than a null pointer cause the internal conversion state of the function to be altered as necessary. It is implementation-defined whether internal conversion state has thread storage duration, and whether a newly created thread has the same state as the current thread at the time of creation, or the initial conversion state. A call with s as a null pointer causes these functions to return a nonzero value if encodings have state dependency, and zero otherwise.367) It is implementation-defined whether these functions avoid data races with other calls to the same function.
Changing the LC_CTYPE category causes the internal object describing the conversion state of the mbtowc and wctomb functions to have an indeterminate representation.
7.25.8.2 The mblen function
Synopsis
Description
If s is not a null pointer, the mblen function determines the number of bytes contained in the multibyte character pointed to by s. Except that the conversion state of the mbtowc function is not affected, it is equivalent to
mbtowc((wchar_t *)0, (const char *)0, 0); mbtowc((wchar_t *)0, s, n);
Returns
If s is a null pointer, the mblen function returns a nonzero or zero value, if multibyte character encodings, respectively, do or do not have state-dependent encodings. If s is not a null pointer, the mblen function either returns 0 (if s points to the null character), or returns the number of bytes that are contained in the multibyte character (if the next n or fewer bytes form a valid multibyte character), or returns -1 (if they do not form a valid multibyte character).
mbtowc function (7.25.8.3).7.25.8.3 The mbtowc function
Synopsis
Description
If s is not a null pointer, the mbtowc function inspects at most n bytes beginning with the byte pointed to by s to determine the number of bytes needed to complete the next multibyte character (including any shift sequences). If the function determines that the next multibyte character is complete and valid, it determines the value of the corresponding wide character and then, if pwc is not a null pointer, stores that value in the object pointed to by pwc. If the corresponding wide character is the null wide character, the function is left in the initial conversion state.
The implementation shall behave as if no library function calls the mbtowc function.
Returns
If s is a null pointer, the mbtowc function returns a nonzero or zero value, if multibyte character encodings, respectively, do or do not have state-dependent encodings. If s is not a null pointer, the mbtowc function either returns 0 (if s points to the null character), or returns the number of bytes that are contained in the converted multibyte character (if the next n or fewer bytes form a valid multibyte character), or returns -1 (if they do not form a valid multibyte character).
In no case will the value returned be greater than n or the value of the MB_CUR_MAX macro.
7.25.8.4 The wctomb function
Synopsis
Description
The wctomb function determines the number of bytes needed to represent the multibyte character corresponding to the wide character given by wc (including any shift sequences), and stores the multibyte character representation in the array whose first element is pointed to by s (if s is not a null pointer). At most MB_CUR_MAX characters are stored. If wc is a null wide character, a null byte is stored, preceded by any shift sequence needed to restore the initial shift state, and the function is left in the initial conversion state.
The implementation shall behave as if no library function calls the wctomb function.
Returns
If s is a null pointer, the wctomb function returns a nonzero or zero value, if multibyte character encodings, respectively, do or do not have state-dependent encodings. If s is not a null pointer, the wctomb function returns -1 if the value of wc does not correspond to a valid multibyte character, or returns the number of bytes that are contained in the multibyte character corresponding to the value of wc.
In no case will the value returned be greater than the value of the MB_CUR_MAX macro.
7.25.9 Multibyte/wide string conversion functions
7.25.9.1 General
The behavior of the multibyte string functions is affected by the LC_CTYPE category of the current locale.
7.25.9.2 The mbstowcs function
Synopsis
Description
The mbstowcs function converts a sequence of multibyte characters that begins in the initial shift state from the array pointed to by s into a sequence of corresponding wide characters and stores not
No more than n elements will be modified in the array pointed to by pwcs. If copying takes place between objects that overlap, the behavior is undefined.
Returns
If an invalid multibyte character is encountered, the mbstowcs function returns (size_t)(-1). Otherwise, the mbstowcs function returns the number of array elements modified, not including a terminating null wide character, if any.368)
7.25.9.3 The wcstombs function
Synopsis
Description
The wcstombs function converts a sequence of wide characters from the array pointed to by pwcs into a sequence of corresponding multibyte characters that begins in the initial shift state, and stores these multibyte characters into the array pointed to by s, stopping if a multibyte character would exceed the limit of n total bytes or if a null character is stored. Each wide character is converted as if by a call to the wctomb function, except that the conversion state of the wctomb function is not affected.
No more than n bytes will be modified in the array pointed to by s. If copying takes place between objects that overlap, the behavior is undefined.
Returns
If a wide character is encountered that does not correspond to a valid multibyte character, the wcstombs function returns (size_t)(-1). Otherwise, the wcstombs function returns the number of bytes modified, not including a terminating null character, if any.368)
7.25.10 Alignment of memory
7.25.10.1 The memalignment function
Synopsis
#include <stdlib.h> size_t memalignment(const void *p);
Description
The memalignment function accepts a pointer to any object and returns the maximum alignment satisfied by its address value. The alignment may be an extended alignment and may also be beyond the range supported by the implementation for explicit use by alignas.369) If so, it will satisfy all alignments usable by the implementation. The value returned can be compared to the result of alignof, and if it is greater or equal, the alignment requirement for the type operand is satisfied.
Returns
The alignment of the pointer p, which is a power of two. If p is a null pointer, an alignment of zero is returned.
NOTE An alignment of zero indicates that the tested pointer cannot be used to access an object of any type.
7.26 Text transcoding utilities <stdmchar.h>
7.26.1 General
The header <stdmchar.h> declares four status code enumerators, several macros, several types and several functions for transcoding encoded text safely and efficiently. It is meant to supersede conversion utilities from Unicode utilities (7.32) and Extended multibyte and wide character utilities (7.33). It is meant to represent "multi character" functions. These functions can be used to count the number of input that form a complete sequence, count the number of output characters required for a conversion with no additional allocation, validate an input sequence, or transcode text from one encoding to another encoding. Particularly, it provides single unit and multi unit transcoding functions for transcoding by working on code units and code points.
Inputs to the functions in this subclause are read until there is enough information taken in to perform an indivisible unit of work. An indivisible unit is the smallest possible input, as defined by the encoding, that can produce one or more outputs, perform a transformation of any state, or both. The conversion of these indivisible units is called an indivisible unit of work, and they are used to complete the transcoding operations specified in this subclause.
One or more of the following must hold for any given transcoding operation on an attempt to complete an indivisible unit of work:
- enough input is consumed to perform an output or change the state;
- output is written from consuming input, or output is written from the state which causes the state to change; or,
- an error occurs and both the input and output do not change relative to the current indivisible unit of work.
For the multi unit functions, the process acts as if it completes one indivisible unit of work repeatedly. When an error occurs, only the input successfully consumed, the state successfully altered, and the output successfully written according to the last indivisible unit of work are reflected in the output values of the functions in this subclause: no other values are written.
Functions in <stdmchar.h> which use char and wchar_t, or their qualified forms, derive their implementation-defined encodings from the narrow execution encoding or the wide execution encoding (6.2.9), respectively. The other encodings are UTF-8, associated with char8_t, UTF-16, associated with char16_t, and UTF-32, associated with char32_t.
NOTE 1 Each value is treated as code units with an unsigned value and not as a container of octets. This means that the decision of, for example, UTF-16 in big or little endian encoding scheme is decided by the endianness of the code unit type. Only whole code unit values are used (i.e. a UTF-32 code point value of U+1F377 represents a value identical to how U’\U0001F377’ is stored by the implementation).
For the UTF-8, UTF-16, and UTF-32 encodings, collectively referred to as the Unicode encodings, an indivisible unit of work for a read operation shall be the sequence of code units that corresponds to one Unicode code point. The value of each code unit is treated as a sequence of unsigned values. If input is exhausted before a sequence of code units corresponding to one Unicode code point can be reached, then stdc_mcerr_incomplete_input shall be returned. If there is an illegal code unit sequence, then stdc_mcerr_invalid shall be returned. For the implementation-defined execution and wide execution encodings, they have the same aforementioned requirement if the implementation defines it to be one of the Unicode encodings.
NOTE 2 If an implementation chooses to provide, for example, an execution encoding as the input encoding for a transcoding function that is defined to be the same as the UTF-8 encoding, then it is required to read one full complete Unicode code point’s worth of code units. If it cannot, then it returns stdc_mcerr_incomplete_input (if the input sequence is not long enough but does not have any invalid code units in the sequence) or stdc_mcerr_invalid (if the input sequence is not a proper code unit sequence).
NOTE 3 The requirements for Unicode encodings do not apply to derivative encodings defined by the implementation. For example, an implementation may define a "partial UTF-8" execution encoding where it stores every read UTF-8 code unit in the state and, rather than returning stdc_mcerr_incomplete_input, returns stdc_mcerr_ok and produces no output. It may accumulate code units and write out a code point
NOTE 4 The implementation-defined execution, wide execution, literal, and wide literal encodings can also have different behaviors if they do not define themselves as one of the Unicode encodings. For example, if __STDC_ENDIAN_NATIVE__ (7.18.2) is equivalent to __STDC_ENDIAN_LITTLE__, but the wide execution encoding is defined to be "UTF-16 Big Endian" ("UTF16-BE"), then it may be classified as not one of the three recognized Unicode encodings according to this subclause. As such, a sequence of wchar_t elements that is null-terminated produced by transcoding functions in this subclause can behave differently than expected; e.g. L"\U0001F377", if valid and defined to be UTF-16, can potentially not compare equal to a sequence of wchar_t objects produced by successful use of the transcoding functions from the code points U+01F377 and U+000000.
For all functions in this subclause, when a code unit value of 0 (e.g. ’\0’) is encountered in the input, the mbstate_t object in use for the transcoding operation is set to the initial shift state. The output associated with the indivisible unit of work consists of the appropriate null character preceded by any shift sequence necessary to cause the output to be in the initial shift state.
NOTE 5 As described in 7.33.6.1, an object of type mbstate_t can always be set to the initial conversion sequence by initializing it with = {0}; or = {};. An existing mbstate_t object can always be set to the initial conversion sequence by assigning to it from the expressions (mbstate_t){0} or (mbstate_t){}.
Changing the LC_CTYPE category causes any conversion state already in use with the functions in this subclause to be indeterminate.
The macro
__STDC_VERSION_STDMCHAR_H__is an integer constant expression with a value equivalent to 202ymmL.
The types declared are mbstate_t (described in 7.33.1), wchar_t (described in 7.22), char8_t (described in 7.32), char16_t (described in 7.32), char32_t (described in 7.32), size_t (described in 7.22), and;
stdc_mcerrwhich is both an enumerated type and a typedef whose enumerators identify the status codes from a function call described in this subclause.
The macros declared are WCHAR_MIN, WCHAR_MAX, and WCHAR_WIDTH (described in 7.23); WCHAR_UTF8, WCHAR_UTF16, WCHAR_UTF32, MB_UTF8, MB_UTF16, and MB_UTF32 (described in 7.33.1); and,
STDC_C8_MAX STDC_C16_MAX STDC_C32_MAX STDC_MC_MAX STDC_MWC_MAX
which correspond to the maximum output for each single unit conversion function (7.26.2) and its corresponding output type. Each macro shall expand into an integer constant expression with minimum values, as described in Table 7.8.
There is an association of naming convention, types, encoding, and maximums, used to describe the functions in this subclause:
The maximum output macro values specified in Table 7.8 are related to the single unit conversion functions (7.26.2). These functions perform at most one indivisible unit of work, or return an error. The maximum output macro values shall be integer constant expressions large enough that conversions to the single unit conversion function’s specified encoding shall not overflow a buffer of the proper code unit type with that size. The maximum output macro values do not affect the multi unit conversion functions (7.26.3), which perform as many indivisible units of work as is possible until an error occurs, until the output space is exhausted, or until the input is exhausted.
Unlike the functions present in <uchar.h> and <wchar.h>, the functions present in this subclause can write more than one wchar_t value for conversions based on the wide execution encoding to
- :
STDC_MC_MAX1STDC_MWC_MAX1
The enumerators of the enumerated type stdc_mcerr are defined as follows:
stdc_mcerr_ok = 0 stdc_mcerr_invalid = -1, stdc_mcerr_incomplete_input = -2, stdc_mcerr_insufficient_output = -3
Each value represents a specific situation when calling the relevant transcoding functions in <stdmchar.h>:
-
stdc_mcerr_insufficient_output, when the input is correct and an indivisible unit of work can be performed but there is not enough output space to write to; -
stdc_mcerr_incomplete_input, when input has been exhausted and the sequence is not incorrect but there are no more input values; -
stdc_mcerr_invalid, when a unrecorded encoding error occurred; and, -
stdc_mcerr_ok, when the operation was successful (none of the situations described for the other values of this enumerated type apply).
No other value shall be returned from the functions described in this subclause.
Recommended practice
The maximum output macro values are intended for use in making automatic storage duration array declarations. Implementations should choose values for the macros that are spacious enough to accommodate a variety of underlying implementation choices for the target encodings supported by the narrow execution encodings and wide execution encodings, which for some encodings can output more than one UTF-32 code point. A set of values which are most resilient to future additions and changes in implementations is as follows:
#define STDC_C8_MAX 64 #define STDC_C16_MAX 32 #define STDC_C32_MAX 16 #define STDC_MC_MAX 64 #define STDC_MWC_MAX 32
Beyond just the Unicode encodings specified previously, implementations are encouraged to not store partial reads or partial writes in the mbstate_t object with these functions unless as is strictly necessary. Implementations providing additional encodings for use with these functions should, to the extent possible for a given encoding, always define an indivisible unit of work to transcode
7.26.2 Single Unit Sized Conversion Functions
Synopsis
#include <stdmchar.h> stdc_mcerr stdc_mcnrtomcn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mcnrtomwcn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mcnrtoc8n(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mcnrtoc16n(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mcnrtoc32n(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcnrtomcn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcnrtomwcn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcnrtoc8n(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcnrtoc16n(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcnrtoc32n(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8nrtomcn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8nrtomwcn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8nrtoc8n(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8nrtoc16n(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8nrtoc32n(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16nrtomcn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16nrtomwcn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16nrtoc8n(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16nrtoc16n(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16nrtoc32n(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32nrtomcn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32nrtomwcn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32nrtoc8n(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32nrtoc16n(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32nrtoc32n(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state);
Description
Let transcoding function be one of the functions listed previously transcribed in the form
stdc_mcerr stdc_XnrtoYn(size_t*restrict output_size, charY*restrict *restrict output, size_t*restrict input_size, const charX*restrict *restrict input, mbstate_t*restrict state)
An mbstate_t object describes the conversion state for the current conversion if it is not in an unspecified state (as described further later in this subclause) and:
- the conversion is between Unicode encodings;
- or, the input fragment is the start of an encoded sequence in the input encoding and the
mbstate_t object was initialized to the initial conversion state;
- or, the input fragment is a continuation of an encoded sequence and
mbstate_tis the result of having advanced to the input and possibly output positions through the application of prior calls to the same transcoding function.
The behavior is undefined when a function described by this subclause is invoked and *state (or, if state is a null pointer, the mbstate_t object created that is unique to the current invocation) does not describe the conversion state for the current conversion.
The transcoding functions convert from code units of type charX interpreted according to to code units of type charY according to given a conversion state of value *state. This function only performs a single indivisible unit of work. It returns stdc_mcerr_ok if the input is empty. The input is considered empty if input_size is a null pointer or if *input_size is zero if input_size is not a null pointer, and *state is in the initial conversion sequence.
Any time input code unit reads in the following description is used:
- code units are read from
*input, sequentially, and interpreted according to ; - if
*input_sizeis smaller than the necessary amount of sequential reads that must be performed from input to complete an indivisible unit of work, the function does not modify any of*input,*input_size,*output, or*output_size. It returnsstdc_mcerr_incomplete_input; - if an unrecorded encoding error (6.2.9) occurs (e.g. the input read is invalid according to or the input is valid but cannot be converted to ), then the function returns
stdc_mcerr_invalid; - if the function returns
stdc_mcerr_ok, the function decrements*input_sizeby the number of input code units that were read and increments*inputby the number of input code units that were read for the complete indivisible unit of work.
Any time output code unit writes in the following description is used:
- converted code units are potentially written into
*output, sequentially, according to ;
The behavior of the transcoding functions is as follows:
- If
stateis a null pointer, then an automatic storage duration object of typembstate_tis created which is unique to the current invocation. It is initialized to the initial conversion state and a pointer to this object is used whereverstateis used in this paragraph. - Then, if
inputis a null pointer or*inputis a null pointer, then*stateis set to the initial conversion state, the function returnsstdc_mcerr_ok, and no other actions are token. - Otherwise, if
*stateis in an implementation-defined conversion state that requires it, any necessary output code units writes are performed to return*stateto the initial conversion state. - The function performs input code unit reads and subsequently performs the output code unit writes as is necessary to complete an indivisible unit of work.
- The function returns
stdc_mcerr_ok.
NOTE If state is a null pointer, and the function uses e.g. a created automatic storage duration mbstate_t object that is discarded by the end of the invocation, then any potential conversion state contained in the created mbstate_t object and used during processing could become unrecoverable to the program.
Returns
On success or failure, the transcoding functions shall return one of the above error codes (7.26.1). If input is a null pointer or *input is a null pointer, then *state is set to the initial conversion state and no other work is performed.
If the function returns stdc_mcerr_ok, then all of the following is true:
- if
inputand*inputare not null pointers,*inputis incremented by the number of code units read and successfully converted; - if
input_sizeis not a null pointer,*input_sizeis decremented by the number of code units read and successfully converted from the input; - if
outputand*outputare not null pointers,*outputis incremented by the number of code units written to the output; and, - if
output_sizeis not a null pointer,*output_sizeis decremented by the number of code units written to the output.
Otherwise, if an error is returned then none of the above occurs. If the return value is stdc_mcerr_invalid, then *state is in an unspecified state. If the return value is stdc_mcerr_incomplete_input or stdc_mcerr_insufficient_output, then *state is not changed.
Recommended practice
Implementations should take advantage of the information of null pointer values for the output size pointer, output data pointer, or both, to drastically improve performance characteristics for assumed unlimited write space, output counting scenarios, or input validation/counting, respectively.
Implementations should prefer returning an error for an incomplete input sequence over storing intermediate data within the state where possible for non-Unicode encodings. This can make it easier for functionality built on top of the functions in this subclause to report errors without skipping over potentially invalid input data, resulting in potentially more accurate reports. Error handling and recovery also greatly benefit from being able to examine invalid input; avoiding skipping over invalid data by consuming it into a state and reporting no errors means that functionality built on top can potentially discard what should be considered unneeded, already-processed data.
7.26.3 Multi Unit Sized Conversion Functions
Synopsis
#include <stdmchar.h> stdc_mcerr stdc_mcsnrtomcsn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mcsnrtomwcsn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mcsnrtoc8sn(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mcsnrtoc16sn(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mcsnrtoc32sn(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcsnrtomcsn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcsnrtomwcsn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcsnrtoc8sn(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcsnrtoc16sn(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcsnrtoc32sn(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8snrtomwcsn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8snrtomcsn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8snrtoc8sn(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8snrtoc16sn(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8snrtoc32sn(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16snrtomwcsn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16snrtomcsn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16snrtoc8sn(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16snrtoc16sn(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16snrtoc32sn(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32snrtomcsn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32snrtomwcsn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32snrtoc8sn(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32snrtoc16sn(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32snrtoc32sn(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state);
Description
Let multi unit transcoding function in this function be one of the functions listed above transcribed in the form
stdc_mcerr stdc_XsnrtoYsn(size_t*restrict output_size, charY*restrict *restrict output, size_t*restrict input_size, const charX*restrict *restrict input, mbstate_t*restrict state);
with the following properties:
- and be one of the prefixes/suffixes from Table 7.8;
-
charXandcharYbe the associated code unit types for and from Table 7.8; - and, and be the associated encoding types for and from Table 7.8.
The multi unit transcoding functions take an input buffer and possibly an output buffer of the associated code unit types, potentially with their sizes. The functions consume any number of code units to perform a sequence of indivisible units of work, which results in zero or more output code units. The functions repeatedly perform an indivisible unit of work until either an error occurs or the input is exhausted.
An mbstate_t object describes the conversion state for the current conversion if it is not in an unspecified state (as described later in this subclause) and:
- the conversion is between Unicode encodings;
- or, the input fragment is the start of an encoded sequence in the input encoding and the
mbstate_t object was initialized to the initial conversion state;
- or, the input fragment is a continuation of an encoded sequence and
mbstate_tis the result of having advanced to the input and possibly output positions through the application of prior calls to the same transcoding function.
The behavior is undefined when a function described by this subclause is invoked and *state (or, if state is a null pointer, the mbstate_t object created for that case) does not describe the conversion state for the current conversion.
If input_size is a null pointer, input shall either be a null pointer or point to a null pointer. Otherwise, input shall be a pointer to a non-null pointer to an array of at least *input_size elements.
The multi unit transcoding functions convert from code units of type charX interpreted according to to code units of type charY according to given a conversion state of value
*state. The behavior of these functions is as-if the analogous single unit function stdc_XntoYn was repeatedly called, with the same output, output_size, input, input_size, and state parameters, to perform multiple indivisible units of work. The function stops when an error occurs or the input is exhausted (only signified when *input_size is zero and the mbsinit(*state) returns nonzero).
The multi unit transcoding functions behave as-if:
- If
stateis a null pointer, then an automatic storage duration object of typembstate_tis created which is unique to the current invocation. It is initialized to the initial conversion state and a pointer to this object is used whereverstateis used in this paragraph. -
stdc_XnrtoYnis called withoutput_size,output,input_size,input, andstatewith its result stored in a temporary namederr. - If
inputis a null pointer or*inputis a null pointer, returnerr. - If
erris notstdc_mcerr_ok, then returnerr. - Otherwise, if
*input_sizeis greater than zero, go back to (2). - Otherwise, if
mbsinit(*state)returns zero, go back to (2). - Otherwise, return
err.
Returns
On success or failure, the transcoding functions shall return one of the above error codes (7.26.1). If state is not a null pointer and *state is not initialized to the initial conversion state for the function on its first use, or is used after being input into a function whose result is not one of stdc_mcerr_ok, stdc_mcerr_incomplete_input, or stdc_mcerr_insufficient_output, the behavior of the functions is unspecified.
The following is true after the invocation:
-
*inputis incremented by the number of code units read and successfully converted ifinput
and *input are not null pointers. If stdc_mcerr_ok is returned, then all the input is consumed. Otherwise, *input points to the location just after the last successfully completed indivisible unit of work.
-
*input_sizeis decremented by the number of code units read from*inputthat were successfully converted. If no error occurred, then*input_sizeis 0. - if
outputand*outputis not a null pointer,*outputis incremented by the number of code units written from successfully completed indivisible unit of work. - if
output_sizeis not a null pointer,*output_sizeis decremented by the number of code units written to the output or that would have been written to the output.
If the return value is stdc_mcerr_invalid and state is not a null pointer, then *state is in an unspecified state.
NOTE The object unique to the invocation is reused for every call in the second step of the multi unit sized conversion algorithm, and not recreated. If state is a null pointer, and the function uses e.g. a created automatic storage duration mbstate_t object that is discarded by the end of the invocation, then any potential conversion state contained in the created mbstate_t object, and used or accumulated during multi unit processing, could become unrecoverable to the program.
EXAMPLE 1 The following is an example of using a single indivisible unit sized conversion function stdc_mcnrtoc8n to implement a multi unit sized conversion algorithm:
#include <stdmchar.h> stdc_mcerr sample_mcsnrtoc8sn(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t* restrict state) { mbstate_t invocation_unique_internal_state; if (state == nullptr) { invocation_unique_internal_state = (mbstate_t){}; state = &invocation_unique_internal_state; } if (input == nullptr || *input == nullptr) { return stdc_mcnrtoc8n(output_size, output, input_size, input, state); } for (;;) { stdc_mcerr err = stdc_mcnrtoc8n(output_size, output, input_size, input, state); if (err != stdc_mcerr_ok) { return err; } if (*input_size > 0) { continue; } // some execution encodings (6.2.9) may contain // additional output as input gets processed int state_finished = mbsinit(state); if (state_finished == 0) { continue; } return err; } }
EXAMPLE 2 The multi unit sized conversion functions can be used to perform other functionality, such as counting, validation, and more by using a null pointer value for specific arguments:
#include <stdmchar.h> bool is_valid_utf16_from_utf8(size_t str_n, const char8_t str[restrict static str_n]) { stdc_mcerr err = stdc_c8snrtoc16sn(nullptr, nullptr, &str_n, &str); return err == stdc_mcerr_ok; } size_t count_utf16_from_utf8(size_t str_n, const char8_t str[restrict static str_n]) { const size_t utf16_before_n = SIZE_MAX; size_t utf16_after_n = utf16_before_n; stdc_mcerr err = stdc_c8snrtoc16sn(&utf16_after_n, nullptr, &str_n, &str); return err == stdc_mcerr_ok ? utf16_before_n - utf16_after_n : 0; } bool unbounded_conversion_utf16_from_utf8(size_t str_n, const char8_t str[restrict static str_n], char16_t* restrict dest_str) { stdc_mcerr err = stdc_c8snrtoc16sn(nullptr, &dest_str, &str_n, &str); return err == stdc_mcerr_ok; } int main () { const char8_t str[] = u8"\U201CSaw a \U0001F9DC \u2014" u8"didn’t catch her\u2026 \U0001F61E\U201D\n" u8"\t- Sniff"; // includes null terminator const size_t str_n = _Countof(str); if (!is_valid_utf16_from_utf8(str_n, str)) { // input not valid return 1; } size_t utf16_str_n = count_utf16_from_utf8(str_n, str); constexpr size_t utf16_str_max_size = STDC_C16_MAX * (sizeof(str) / sizeof(*str)); char16_t utf16_str[utf16_str_max_size] = {}; if (utf16_str_max_size < utf16_str_n) { // buffer too small return 2; } if (!unbounded_conversion_utf16_from_utf8(str_n, str, utf16_str)) { // write failed return 3; } // At this point, utf16_str is a veritable UTF-16 string. // As noted above, null terminator from utf8_str was included: // utf16_str is a sequence of UTF-16 code units plus the null // terminator, in a suitable form at the end of the UTF-16 string. return 0; }
Recommended practice
The multi unit transcoding functions are explicitly for the purpose of performing conversions on the largest contiguous section of valid data in the shortest amount of time possible. Implementations should take advantage of the information of null pointer values for the output size pointer, output data pointer, or both, to drastically improve performance characteristics for assumed unlimited write space, output counting scenarios, or input validation/counting, respectively.
Implementations should prefer returning an error for an incomplete input sequence over storing intermediate data within the state where possible for non-Unicode encodings. By leaving partial input unconsumed, it can be easier for functionality built on top of the functions in this subclause to report errors without skipping over potentially invalid input data.
7.27 _Noreturn <stdnoreturn.h>
The noreturn macro and the <stdnoreturn.h> header are obsolescent features.
7.28 String handling <string.h>
7.28.1 String function conventions
The header <string.h> declares one type, several functions, several type-generic functions, and defines two macros useful for manipulating arrays of character type and other objects treated as arrays of character type.370) The type is size_t and one of the macros is NULL (both described in 7.22). Various methods are used for determining the lengths of the arrays, but in all cases a char
* or void * argument points to the initial (lowest addressed) character of the array. If an array is accessed beyond the end of an object, the behavior is undefined.
The macro
__STDC_VERSION_STRING_H__is an integer constant expression with a value equivalent to 202ymmL.
Where an argument declared as size_t n specifies the length of the array for a function, n can have the value zero on a call to that function. Unless explicitly stated otherwise in the description of a particular function in this subclause, pointer arguments on such a call may be null pointers. On such a call, a function that locates a character finds no occurrence, a function that compares two character sequences returns zero, and a function that copies characters copies zero characters.
For all functions in this subclause, each character shall be interpreted as if it had the type unsigned char (and therefore every possible object representation is valid and has a different value).
7.28.2 Copying functions
7.28.2.1 The memcpy function
Synopsis
Description
The memcpy function copies n characters from the object pointed to by s2 into the object pointed to by s1. If copying takes place between objects that overlap, the behavior is undefined.
Returns
The memcpy function returns the value of s1.
7.28.2.2 The memccpy function
Synopsis
Description
The memccpy function copies characters from the object pointed to by s2 into the object pointed to by s1, stopping after the first occurrence of character c (converted to an unsigned char) is copied, or after n characters are copied, whichever comes first. If copying takes place between objects that overlap, the behavior is undefined.
Returns
The memccpy function returns a pointer to the character after the copy of c in s1, or a null pointer if c was not found in the first n characters of s2.
7.28.2.3 The memmove function
Synopsis
Description
The memmove function copies n characters from the object pointed to by s2 into the object pointed to by s1. Copying takes place as if the n characters from the object pointed to by s2 are first copied into a temporary array of n characters that does not overlap the objects pointed to by s1 and s2, and then the n characters from the temporary array are copied into the object pointed to by s1.
Returns
The memmove function returns the value of s1.
7.28.2.4 The strcpy function
Synopsis
Description
The strcpy function copies the string pointed to by s2 (including the terminating null character) into the array pointed to by s1. If copying takes place between objects that overlap, the behavior is undefined.
Returns
The strcpy function returns the value of s1.
7.28.2.5 The strncpy function
Synopsis
Description
The strncpy function copies not more than n characters (characters that follow a null character are not copied) from the array pointed to by s2 to the array pointed to by s1.371) If copying takes place between objects that overlap, the behavior is undefined.
If the array pointed to by s2 is a string that is shorter than n characters, null characters are appended to the copy in the array pointed to by s1, until n characters in all have been written.
Returns
The strncpy function returns the value of s1.
7.28.2.6 The strdup function
Synopsis
Description
The strdup function creates a copy of the string pointed to by s in a space allocated as if by a call to malloc.
Returns
The strdup function returns a pointer to the first character of the duplicate string. The returned pointer can be passed to free. If no space can be allocated the strdup function returns a null pointer.
7.28.2.7 The strndup function
Synopsis
Description
The strndup function creates a string initialized with no more than n initial characters of the array pointed to by s and up to the first null character, whichever comes first, in a space allocated as if by a call to malloc. If the array pointed to by s does not contain a null within the first n characters, a null is appended to the copy of the array.
Returns
The strndup function returns a pointer to the first character of the created string. The returned pointer can be passed to free. If space cannot be allocated the strndup function returns a null pointer.
7.28.3 Concatenation functions
7.28.3.1 The strcat function
Synopsis
Description
The strcat function appends a copy of the string pointed to by s2 (including the terminating null character) to the end of the string pointed to by s1. The initial character of s2 overwrites the null character at the end of s1. If copying takes place between objects that overlap, the behavior is undefined.
Returns
The strcat function returns the value of s1.
7.28.3.2 The strncat function
Synopsis
Description
The strncat function appends not more than n characters (a null character and characters that follow it are not appended) from the array pointed to by s2 to the end of the string pointed to by s1. The initial character of s2 overwrites the null character at the end of s1. A terminating null character is always appended to the result.372) If s1 is a null pointer value or copying takes place between objects that overlap, the behavior is undefined.
Returns
The strncat function returns the value of s1.
strlen function (7.28.6.4).7.28.4 Comparison functions
7.28.4.1 General
The sign of a nonzero value returned by the comparison functions memcmp, strcmp, and strncmp is determined by the sign of the difference between the values of the first pair of characters (both interpreted as unsigned char) that differ in the objects being compared.
7.28.4.2 The memcmp function
Synopsis
Description
The memcmp function compares the first n characters of the object pointed to by s1 to the first n characters of the object pointed to by s2.373)
Returns
The memcmp function returns an integer greater than, equal to, or less than zero, accordingly as the object pointed to by s1 is greater than, equal to, or less than the object pointed to by s2.
7.28.4.3 The strcmp function
Synopsis
Description
The strcmp function compares the string pointed to by s1 to the string pointed to by s2.
Returns
The strcmp function returns an integer greater than, equal to, or less than zero, accordingly as the string pointed to by s1 is greater than, equal to, or less than the string pointed to by s2.
7.28.4.4 The strcoll function
Synopsis
Description
The strcoll function compares the string pointed to by s1 to the string pointed to by s2, both interpreted as appropriate to the LC_COLLATE category of the current locale.
Returns
The strcoll function returns an integer greater than, equal to, or less than zero, accordingly as the string pointed to by s1 is greater than, equal to, or less than the string pointed to by s2 when both are interpreted as appropriate to the current locale.
7.28.4.5 The strncmp function
Synopsis
Description
The strncmp function compares not more than n characters (characters that follow a null character are not compared) from the array pointed to by s1 to the array pointed to by s2.
Returns
The strncmp function returns an integer greater than, equal to, or less than zero, accordingly as the possibly null-terminated array pointed to by s1 is greater than, equal to, or less than the possibly null-terminated array pointed to by s2.
7.28.4.6 The strxfrm function
Synopsis
Description
The strxfrm function transforms the string pointed to by s2 and places the resulting string into the array pointed to by s1. The transformation is such that if the strcmp function is applied to two transformed strings, it returns a value greater than, equal to, or less than zero, corresponding to the result of the strcoll function applied to the same two original strings. No more than n characters are placed into the resulting array pointed to by s1, including the terminating null character. If n is zero, s1 is permitted to be a null pointer. If copying takes place between objects that overlap, the behavior is undefined.
Returns
The strxfrm function returns the length of the transformed string (not including the terminating null character). If the value returned is n or more, the members of the array pointed to by s1 have an indeterminate representation.
EXAMPLE The value of the following expression is the size of the array needed to hold the transformation of the string pointed to by s.
1 + strxfrm(nullptr, s, 0)
7.28.5 Search functions
7.28.5.1 Introduction
The stateless search functions in this subclause (memchr, strchr, strpbrk, strrchr, strstr) are generic functions. These functions are generic in the qualification of the array to be searched and will return a result pointer to an element with the same qualification as the passed array. If the array to be searched is const-qualified, the result pointer will be to a const-qualified element. If the array to be searched is not const-qualified,374) the result pointer will be to an unqualified element.
The external declarations of these generic functions have a concrete function type that returns a pointer to an unqualified element (of type char when specified as QChar, and void when specified as QVoid), and accepts a pointer to a const-qualified array of the same type to search. This signature supports all correct uses. If a macro definition of any of these generic functions is suppressed to access an actual function, the external declaration with the corresponding concrete type is visible.375)
The volatile and restrict qualifiers are not accepted on the elements of the array to search.
7.28.5.2 The memchr generic function
Synopsis
Description
The memchr generic function locates the first occurrence of c (converted to an unsigned char) in the initial n characters (each interpreted as unsigned char) of the object pointed to by s. The implementation shall behave as if it reads the characters sequentially and stops as soon as a matching character is found.
Returns
The memchr generic function returns a pointer to the located character, or a null pointer if the character does not occur in the object.
7.28.5.3 The strchr generic function
Synopsis
Description
The strchr generic function locates the first occurrence of c (converted to a char) in the string pointed to by s. The terminating null character is considered to be part of the string.
Returns
The strchr generic function returns a pointer to the located character, or a null pointer if the character does not occur in the string.
7.28.5.4 The strcspn function
Synopsis
Description
The strcspn function computes the length of the maximum initial segment of the string pointed to by s1 which consists entirely of characters not from the string pointed to by s2.
Returns
The strcspn function returns the length of the segment.
7.28.5.5 The strpbrk generic function
Synopsis
Description
The strpbrk generic function locates the first occurrence in the string pointed to by s1 of any character from the string pointed to by s2.
Returns
The strpbrk generic function returns a pointer to the character, or a null pointer if no character from s2 occurs in s1.
7.28.5.6 The strrchr generic function
Synopsis
Description
The strrchr generic function locates the last occurrence of c (converted to a char) in the string pointed to by s. The terminating null character is considered to be part of the string.
Returns
The strrchr generic function returns a pointer to the character, or a null pointer if c does not occur in the string.
7.28.5.7 The strspn function
Synopsis
Description
The strspn function computes the length of the maximum initial segment of the string pointed to by s1 which consists entirely of characters from the string pointed to by s2.
Returns
The strspn function returns the length of the segment.
7.28.5.8 The strstr generic function
Synopsis
Description
The strstr generic function locates the first occurrence in the string pointed to by s1 of the sequence of characters (excluding the terminating null character) in the string pointed to by s2.
Returns
The strstr generic function returns a pointer to the located string, or a null pointer if the string is not found. If s2 points to a string with zero length, the function returns s1.
7.28.5.9 The strtok function
Synopsis
Description
A sequence of calls to the strtok function breaks the string pointed to by s1 into a sequence of tokens, each of which is delimited by a character from the string pointed to by s2. The first call in the sequence has a non-null first argument; subsequent calls in the sequence have a null first argument. If any of the subsequent calls in the sequence is made by a different thread than the first, the behavior is undefined. The separator string pointed to by s2 can be different from call to call.
The first call in the sequence searches the string pointed to by s1 for the first character that is not contained in the current separator string pointed to by s2. If no such character is found, then there are no tokens in the string pointed to by s1 and the strtok function returns a null pointer. If such a character is found, it is the start of the first token.
The strtok function then searches from there for a character that is contained in the current separator string. If no such character is found, the current token extends to the end of the string pointed to by s1, and subsequent searches for a token will return a null pointer. If such a character is found, it is overwritten by a null character, which terminates the current token. The strtok function saves a pointer to the following character, from which the next search for a token will start.
Each subsequent call, with a null pointer as the value of the first argument, starts searching from the saved pointer and behaves as described previously.
The strtok function is not required to avoid data races with other calls to the strtok function.376)
The implementation shall behave as if no library function calls the strtok function.
Returns
The strtok function returns a pointer to the first character of a token, or a null pointer if there is no token.
EXAMPLE
#include <string.h> static char str[] = "?a???b„,#c"; char *t; t = strtok(str, "?"); // ´t´ points to the token "a" t = strtok(nullptr, ","); // ´t´ points to the token "??b" t = strtok(nullptr, "#,"); // ´t´ points to the token "c" t = strtok(nullptr, "?"); // ´t´ is a null pointer
strtok_s function (K.3.7.4.1).7.28.6 Miscellaneous functions
7.28.6.1 The memset function
Synopsis
Description
The memset function copies the value of c (converted to an unsigned char) into each of the first n characters of the object pointed to by s.
Returns
The memset function returns the value of s.
7.28.6.2 The memset_explicit function
Synopsis
#include <string.h> void *memset_explicit(void *s, int c, size_t n);
Description
The memset_explicit function copies the value of c (converted to an unsigned char) into each of the first n characters of the object pointed to by s. The purpose of this function is to make sensitive information stored in the object inaccessible.377)
Returns
The memset_explicit function returns the value of s.
7.28.6.3 The strerror function
Synopsis
Description
The strerror function maps the number in errnum to a message string. Typically, the values for errnum come from errno, but strerror shall map any value of type int to a message.
The strerror function is not required to avoid data races with other calls to the strerror function.378) The implementation shall behave as if no library function calls the strerror function.
Returns
The strerror function returns a pointer to the string, the contents of which are locale-specific. The array pointed to shall not be modified by the program. The behavior is undefined if the returned value is used after a subsequent call to the strerror function, or after the thread which called the function to obtain the returned value has exited.
strerror_s function (K.3.7.5.2).7.28.6.4 The strlen function
Synopsis
Description
The strlen function computes the length of the string pointed to by s.
Returns
The strlen function returns the number of characters that precede the terminating null character.
7.28.6.5 The strnlen function
Synopsis
Description
The strnlen function counts not more than n characters (a null character and characters that follow it are not counted) in the array to which s points. At most the first n characters of s shall be accessed by strnlen. The implementation shall behave as if it reads the characters sequentially and stops as soon as a null character is found.
Returns
The strnlen function returns the number of characters that precede the terminating null character. If there is no null character in the first n characters of s then strnlen returns n.
7.29 Type-generic math <tgmath.h>
The header <tgmath.h> includes the headers <math.h> and <complex.h> and defines several type-generic macros.
The feature test macro __STDC_VERSION_TGMATH_H__ expands to the token 202311L.
This clause specifies a many-to-one correspondence of functions in <math.h> and <complex.h> with type-generic macros.379) Use of a type-generic macro invokes a corresponding function whose type is determined by the types of the arguments for particular parameters called the generic parameters.380)
Of the <math.h> and <complex.h> functions without an f (float) or l (long double) suffix, several have one or more parameters whose corresponding real type is double. For each such function, except the functions that round result to narrower type (7.12.15) (which are covered subsequently in this subclause) and modf, there is a corresponding type-generic macro. The parameters whose corresponding real type is double in the function synopsis are generic parameters.
Some of the <math.h> functions for decimal floating types have no unsuffixed counterpart. Of these functions with a d64 suffix, some have one or more parameters whose type is _Decimal64. For each such function, except decodedecd64, encodedecd64, decodebind64, and encodebind64, there is a corresponding type-generic macro. The parameters whose real type is _Decimal64 in the function synopsis are generic parameters.
If arguments for generic parameters of a type-generic macro are such that some argument has a corresponding real type that is of standard floating type and another argument is of decimal floating type, the behavior is undefined.
Except for the macros for functions that round result to a narrower type (7.12.15), use of a typegeneric macro invokes a function whose generic parameters have the corresponding real type determined by the types of the arguments for the generic parameters as follows:
- Arguments of integer type are regarded as having type
_Decimal64if any argument has decimal floating type, and as having typedoubleotherwise. - If the function has exactly one generic parameter, the type determined is the corresponding real type of the argument for the generic parameter.
- If the function has exactly two generic parameters, the type determined is the corresponding real type determined by the usual arithmetic conversions (6.3.2.8) applied to the arguments for the generic parameters.
- If the function has more than two generic parameters, the type determined is the corresponding real type determined by repeatedly applying the usual arithmetic conversions, first to the first two arguments for generic parameters, then to that result type and the next argument for a generic parameter, and so forth until the usual arithmetic conversions have been applied to the last argument for a generic parameter.
If neither <math.h> and <complex.h> define a function whose generic parameters have the determined corresponding real type, the behavior is undefined.
For each unsuffixed function in <math.h> for which there is a function in <complex.h> with the same name except for a c prefix, the corresponding type-generic macro (for both functions) has the same name as the function in <math.h>. The corresponding type-generic macro for fabs and cabs is fabs. Table 7.9 shows the associations between functions and type-generic macros.
For each unsuffixed function in <math.h> without a c-prefixed counterpart in <complex.h> (except functions that round result to narrower type, modf, and canonicalize), the corresponding typegeneric macro has the same name as the function. These type-generic macros are:
acospi asinpi atan2pi atan2 atanpi cbrt ceil compoundn copysign cospi erfc erf exp10m1 exp10 exp2m1
exp2 expm1 fdim floor fmax fmaximum fmaximum_mag fmaximum_num fmaximum_mag_num fma fmin fminimum fminimum_mag fminimum_num fminimum_mag_num
fmod frexp fromfpx fromfp hypot ilogb ldexp lgamma llogb llrint llround log10p1 log10 log1p log2p1
log2 logb logp1 lrint lround nearbyint nextafter nextdown nexttoward nextup pown powr remainder remquo rint
rootn roundeven round rsqrt scalbln scalbn sinpi tanpi tgamma trunc ufromfpx ufromfp
If all arguments for generic parameters are real, then use of the macro invokes a real function (provided <math.h> defines a function of the determined type); otherwise, use of the macro is undefined.
For each unsuffixed function in <complex.h> that is not a c-prefixed counterpart to a function in <math.h>, the corresponding type-generic macro has the same name as the function. These type-generic macros are:
carg cimag conj cproj creal
Use of the macro with any argument of standard floating or complex type invokes a complex function. Use of the macro with an argument of decimal floating type is undefined.
The functions that round result to a narrower type have type-generic macros whose names are obtained by omitting any suffix from the function names. Thus, the macros with f or d prefix are:
fadd dadd
fsub dsub
fmul dmul
fdiv ddiv
ffma dfma
fsqrt dsqrt
and the macros with d32 or d64 prefix are:
d32add d64add
d32sub d64sub
d32mul d64mul
d32div d64div
d32fma d64fma
d32sqrt d64sqrt
All arguments shall be real. If the macro prefix is f or d, use of an argument of decimal floating type is undefined. If the macro prefix is d32 or d64, use of an argument of standard floating type is undefined. The function invoked is determined as follows:
- If any argument has type
_Decimal128, or if the macro prefix isd64, the function invoked has the name of the macro, with ad128suffix. - Otherwise, if the macro prefix is
d32, the function invoked has the name of the macro, with a
d64 suffix.
- Otherwise, if any argument has type
long double, or if the macro prefix isd, the function invoked has the name of the macro, with anlsuffix. - Otherwise, the function invoked has the name of the macro (with no suffix).
For each d64-suffixed function in <math.h>, except decodedecd64, encodedecd64, decodebind64, and encodebind64, that does not have an unsuffixed counterpart, the corresponding type-generic macro has the name of the function, but without the suffix. These type-generic macros are displayed in Table 7.10:
Table 7.10 — Decimal functions and type-generic macro relations
<math.h> function type-generic macro quantizedN quantize samequantumdN samequantum quantumdN quantum llquantexpdN llquantexp
EXAMPLE With the declarations
#include <tgmath.h> int n; float f; double d; long double ld; float complex fc; double complex dc; long double complex ldc; #ifdef __STDC_IEC_60559_DFP__ _Decimal32 d32; _Decimal64 d64; _Decimal128 d128; #endif
functions invoked by use of type-generic macros are shown in the Table 7.11:
Table 7.11 — Generic macro use to underlying invocation
macro use invocation exp(n) exp(n), the function acosh(f) acoshf(f) sin(d) sin(d), the function atan(ld) atanl(ld) log(fc) clogf(fc) sqrt(dc) csqrt(dc) pow(ldc, f) cpowl(ldc, f) remainder(n, n) remainder(n, n), the function nextafter(d, f) nextafter(d, f), the function nexttoward(f, ld) nexttowardf(f, ld) copysign(n, ld) copysignl(n, ld) ceil(fc) undefined rint(dc) undefined fmaximum(ldc, ld) undefined carg(n) carg(n), the function cproj(f) cprojf(f) creal(d) creal(d), the function cimag(ld) cimagl(ld) fabs(fc) cabsf(fc) carg(dc) carg(dc), the function cproj(ldc) cprojl(ldc) fsub(f, ld) fsubl(f, ld) fdiv(d, n) fdiv(d, n), the function dfma(f, d, ld) dfmal(f, d, ld) dadd(f, f) daddl(f, f) dsqrt(dc) undefined exp(d64) expd64(d64) sqrt(d32) sqrtd32(d32) fmaximum(d64, d128) fmaximumd128(d64, d128) pow(d32, n) powd64(d32, n) remainder(d64, d) undefined creal(d64) undefined remquo(d32, d32, &n) undefined llquantexp(d) undefined quantize(dc) undefined samequantum(n, n) undefined d32sub(d32, d128) d32subd128(d32, d128) d32div(d64, n) d32divd64(d64, n) d64fma(d32, d64, d128) d64fmad128(d32, d64, d128)
7.30 Threads <threads.h>
7.30.1 Introduction
The header <threads.h> includes the header <time.h>, defines macros, and declares types, enumeration constants, and functions that support multiple threads of execution.381)
Implementations that define the macro __STDC_NO_THREADS__ may not provide this header nor support any of its facilities.
The macros are
ONCE_FLAG_INITwhich expands to a value that can be used to initialize an object of type once_flag; andTSS_DTOR_ITERATIONSwhich expands to an integer constant expression representing the maximum number of times that destructors will be called when a thread terminates.
The types are
cnd_twhich is a complete object type that holds an identifier for a condition variable;thrd_twhich is a complete object type that holds an identifier for a thread;tss_twhich is a complete object type that holds an identifier for a thread-specific storage pointer;mtx_twhich is a complete object type that holds an identifier for a mutex;tss_dtor_twhich is the function pointer type void (*)(void*), used for a destructor for a thread-specific storage pointer;thrd_start_twhich is the function pointer type int (*)(void*) that is passed to thrd_create to create a new thread; andonce_flagwhich is a complete object type that holds a flag for use by call_once.
The enumeration constants are
mtx_plainwhich is passed to
mtx_init to create a mutex object that does not support timeout;mtx_recursive mtx_timed thrd_timedout thrd_success thrd_busy thrd_error thrd_nomem
7.30.2 Initialization functions
7.30.2.1 The call_once function
Synopsis
Description
The call_once function uses the once_flag pointed to by flag to ensure that func is called exactly once, the first time the call_once function is called with that value of flag. Completion of an effective call to the call_once function synchronizes with all subsequent calls to the call_once function with the same value of flag.
Returns
The call_once function returns no value.
7.30.3 Condition variable functions
7.30.3.1 The cnd_broadcast function
Synopsis
#include <threads.h> int cnd_broadcast(cnd_t *cond);
Description
The cnd_broadcast function unblocks all the threads that are blocked on the condition variable pointed to by cond at the time of the call. If no threads are blocked on the condition variable pointed to by cond at the time of the call, the function does nothing.
Returns
The cnd_broadcast function returns thrd_success on success, or thrd_error if the request could not be honored.
7.30.3.2 The cnd_destroy function
Synopsis
#include <threads.h> void cnd_destroy(cnd_t *cond);
Description
The cnd_destroy function releases all resources used by the condition variable pointed to by cond. Concurrent access to the condition variable being destroyed, constitutes a data race.
Returns
The cnd_destroy function returns no value.
7.30.3.3 The cnd_init function
Synopsis
Description
The cnd_init function creates a condition variable. If it succeeds it sets the object pointed to by cond to a value that uniquely identifies the newly created condition variable. A thread that calls cnd_wait on a newly created condition variable will block.
Returns
The cnd_init function returns thrd_success on success, or thrd_nomem if no memory could be allocated for the newly created condition, or thrd_error if the request could not be honored.
7.30.3.4 The cnd_signal function
Synopsis
#include <threads.h> int cnd_signal(cnd_t *cond);
Description
The cnd_signal function unblocks one of the threads that are blocked on the condition variable pointed to by cond at the time of the call. If no threads are blocked on the condition variable at the time of the call, the function does nothing and returns success.
Returns
The cnd_signal function returns thrd_success on success or thrd_error if the request could not be honored.
7.30.3.5 The cnd_timedwait function
Synopsis
#include <threads.h> int cnd_timedwait(cnd_t * restrict cond, mtx_t * restrict mtx, const struct timespec * restrict ts);
Description
The cnd_timedwait function atomically unlocks the mutex pointed to by mtx (as if by mtx_unlock) and blocks until the condition variable pointed to by cond is signaled by a call to cnd_signal or to cnd_broadcast, or until after the TIME_UTC-based calendar time pointed to by ts, or until it is unblocked due to an unspecified reason. When the calling thread becomes unblocked it locks (as if by mtx_lock) the object pointed to by mtx before it returns. Prior to the call, the mutex pointed to by mtx shall be locked by the calling thread. Entry and completion of calls with the same mutex pointed to by mtx synchronize as if by calls to mtx_unlock and mtx_lock, respectively.
Returns
The cnd_timedwait function returns thrd_success upon success, or thrd_timedout if the time specified in the call was reached without acquiring the requested resource, or thrd_error if the request could not be honored.
7.30.3.6 The cnd_wait function
Synopsis
Description
The cnd_wait function atomically unlocks the mutex pointed to by mtx (as if by mtx_unlock) and blocks until the condition variable pointed to by cond is signaled by a call to cnd_signal or to cnd_broadcast, or until it is unblocked due to an unspecified reason. When the calling thread becomes unblocked it locks the mutex pointed to by mtx (as if by mtx_lock) before it returns. Prior to the call, the mutex pointed to by mtx shall be locked by the calling thread. Entry and completion of calls with the same mutex pointed to by mtx synchronize as if by calls to mtx_unlock and mtx_lock, respectively.
Returns
The cnd_wait function returns thrd_success on success or thrd_error if the request could not be honored.
7.30.4 Mutex functions
7.30.4.1 General
For purposes of determining the existence of a data race, lock and unlock operations behave as atomic operations. All lock and unlock operations on a particular mutex occur in some particular total order.
NOTE This total order can be viewed as the modification order of the mutex.
7.30.4.2 The mtx_destroy function
Synopsis
#include <threads.h> void mtx_destroy(mtx_t *mtx);
Description
The mtx_destroy function releases any resources used by the mutex pointed to by mtx. No threads can be blocked waiting for the mutex pointed to by mtx.
Returns
The mtx_destroy function returns no value.
7.30.4.3 The mtx_init function
Synopsis
Description
The mtx_init function creates a mutex object with properties indicated by type, which shall have one of these values:
mtx_plain for a simple non-recursive mutex,
mtx_timed for a non-recursive mutex that supports timeout,
mtx_plain | mtx_recursive for a simple recursive mutex, or
mtx_timed | mtx_recursive for a recursive mutex that supports timeout.
If the mtx_init function succeeds, it sets the mutex pointed to by mtx to a value that uniquely identifies the newly created mutex.
Returns
The mtx_init function returns thrd_success on success, or thrd_error if the request could not be honored.
7.30.4.4 The mtx_lock function
Synopsis
Description
The mtx_lock function blocks until it locks the mutex pointed to by mtx. If the mutex is nonrecursive, it shall not be locked by the calling thread. Prior calls to mtx_unlock on the same mutex synchronize with this operation.
Returns
The mtx_lock function returns thrd_success on success, or thrd_error if the request could not be honored.
7.30.4.5 The mtx_timedlock function
Synopsis
#include <threads.h> int mtx_timedlock(mtx_t * restrict mtx, const struct timespec * restrict ts);
Description
The mtx_timedlock function endeavors to block until it locks the mutex pointed to by mtx or until after the TIME_UTC-based calendar time pointed to by ts. The specified mutex shall support timeout. If the operation succeeds, prior calls to mtx_unlock on the same mutex synchronize with this operation.
Returns
The mtx_timedlock function returns thrd_success on success, or thrd_timedout if the time specified was reached without acquiring the requested resource, or thrd_error if the request could not be honored.
7.30.4.6 The mtx_trylock function
Synopsis
#include <threads.h> int mtx_trylock(mtx_t *mtx);
Description
The mtx_trylock function endeavors to lock the mutex pointed to by mtx. If the mutex is already locked, the function returns without blocking. If the operation succeeds, prior calls to mtx_unlock on the same mutex synchronize with this operation.
Returns
The mtx_trylock function returns thrd_success on success, or thrd_busy if the resource requested is already in use, or thrd_error if the request could not be honored. mtx_trylock can spuriously fail to lock an unused resource, in which case it returns thrd_busy.
7.30.4.7 The mtx_unlock function
Synopsis
#include <threads.h> int mtx_unlock(mtx_t *mtx);
Description
The mtx_unlock function unlocks the mutex pointed to by mtx. The mutex pointed to by mtx shall be locked by the calling thread.
Returns
The mtx_unlock function returns thrd_success on success or thrd_error if the request could not be honored.
7.30.5 Thread functions
7.30.5.1 The thrd_create function
Synopsis
#include <threads.h> int thrd_create(thrd_t *thr, thrd_start_t func, void *arg);
Description
The thrd_create function creates a new thread executing func(arg). If the thrd_create function succeeds, it sets the object pointed to by thr to the identifier of the newly created thread. (A thread’s identifier can be reused for a different thread once the original thread has exited and either been detached or joined to another thread.) The completion of the thrd_create function synchronizes with the beginning of the execution of the new thread.
Returning from func has the same behavior as invoking thrd_exit with the value returned from func.
Returns
The thrd_create function returns thrd_success on success, or thrd_nomem if no memory could be allocated for the thread requested, or thrd_error if the request could not be honored.
7.30.5.2 The thrd_current function
Synopsis
#include <threads.h> thrd_t thrd_current(void);
Description
The thrd_current function identifies the thread that called it.
Returns
The thrd_current function returns the identifier of the thread that called it.
7.30.5.3 The thrd_detach function
Synopsis
#include <threads.h> int thrd_detach(thrd_t thr);
Description
The thrd_detach function tells the operating system to dispose of any resources allocated to the thread identified by thr when that thread terminates. The thread identified by thr shall not have been previously detached or joined with another thread.
Returns
The thrd_detach function returns thrd_success on success or thrd_error if the request could not be honored.
7.30.5.4 The thrd_equal function
Synopsis
#include <threads.h> int thrd_equal(thrd_t thr0, thrd_t thr1);
Description
The thrd_equal function will determine whether the thread identified by thr0 refers to the thread identified by thr1.
Returns
The thrd_equal function returns zero if the thread thr0 and the thread thr1 refer to different threads. Otherwise the thrd_equal function returns a nonzero value.
7.30.5.5 The thrd_exit function
Synopsis
Description
For every thread-specific storage key which was created with a non-null destructor and for which the value is non-null, thrd_exit sets the value associated with the key to a null pointer value and then invokes the destructor with its previous value. The order in which destructors are invoked is unspecified.
If after this process there remain keys with both non-null destructors and values, the implementation repeats this process up to TSS_DTOR_ITERATIONS times.
Following this, the thrd_exit function terminates execution of the calling thread and sets its result code to res.
The program terminates normally after the last thread has been terminated. The behavior is as if the program called the exit function with the status EXIT_SUCCESS at thread termination time.
Returns
The thrd_exit function returns no value.
7.30.5.6 The thrd_join function
Synopsis
Description
The thrd_join function joins the thread identified by thr with the current thread by blocking until the other thread has terminated. If the parameter res is not a null pointer, it stores the thread’s result code in the integer pointed to by res. The termination of the other thread synchronizes with the completion of the thrd_join function. The thread identified by thr shall not have been previously detached or joined with another thread.
Returns
The thrd_join function returns thrd_success on success or thrd_error if the request could not be honored.
7.30.5.7 The thrd_sleep function
Synopsis
#include <threads.h> int thrd_sleep(const struct timespec *duration, struct timespec *remaining);
Description
The thrd_sleep function suspends execution of the calling thread until either the interval specified by duration has elapsed or a signal which is not being ignored is received. If interrupted by a signal and the remaining argument is not null, the amount of time remaining (the requested interval minus the time actually slept) is stored in the interval it points to. The duration and remaining arguments can point to the same object.
The suspension time can be longer than requested because the interval is rounded up to an integer multiple of the sleep resolution or because of the scheduling of other activity by the system. But, except for the case of being interrupted by a signal, the suspension time will not be less than that specified, as measured by the system clock TIME_UTC.
Returns
The thrd_sleep function returns zero if the requested time has elapsed, if it has been interrupted by a signal, or a negative value (which can also be ) if it fails.
7.30.5.8 The thrd_yield function
Synopsis
#include <threads.h> void thrd_yield(void);
Description
The thrd_yield function endeavors to permit other threads to run, even if the current thread would ordinarily continue to run.
Returns
The thrd_yield function returns no value.
7.30.6 Thread-specific storage functions
7.30.6.1 The tss_create function
Synopsis
#include <threads.h> int tss_create(tss_t *key, tss_dtor_t dtor);
Description
The tss_create function creates a thread-specific storage pointer with destructor dtor, which can be null.
A null pointer value is associated with the newly created key in all existing threads. Upon subsequent thread creation, the value associated with all keys is initialized to a null pointer value in the new thread.
Destructors associated with thread-specific storage are not invoked at program termination.
The tss_create function shall not be called from within a destructor.
Returns
If the tss_create function is successful, it sets the thread-specific storage pointed to by key to a value that uniquely identifies the newly created pointer and returns thrd_success; otherwise, thrd_error is returned and the thread-specific storage pointed to by key is set to an indeterminate representation.
7.30.6.2 The tss_delete function
Synopsis
#include <threads.h> void tss_delete(tss_t key);
Description
The tss_delete function releases any resources used by the thread-specific storage identified by key. The tss_delete function shall only be called with a value for key that was returned by a call to tss_create before the thread commenced executing destructors.
If tss_delete is called while another thread is executing destructors, whether this will affect the number of invocations of the destructor associated with key on that thread is unspecified.
Calling tss_delete will not result in the invocation of any destructors.
Returns
The tss_delete function returns no value.
7.30.6.3 The tss_get function
Synopsis
Description
The tss_get function returns the value for the current thread held in the thread-specific storage identified by key. The tss_get function shall only be called with a value for key that was returned by a call to tss_create before the thread commenced executing destructors.
Returns
The tss_get function returns the value for the current thread if successful, or zero if unsuccessful.
7.30.6.4 The tss_set function
Synopsis
Description
The tss_set function sets the value for the current thread held in the thread-specific storage identified by key to val. The tss_set function shall only be called with a value for key that was returned by a call to tss_create before the thread commenced executing destructors.
This action will not invoke the destructor associated with the key on the value being replaced.
Returns
The tss_set function returns thrd_success on success or thrd_error if the request could not be honored.
7.31 Date and time <time.h>
7.31.1 Components of time
The header <time.h> defines several macros, and declares types and functions for manipulating time. Many functions deal with a calendar time that represents the current date (according to the Gregorian calendar) and time. Some functions deal with local time, which is the calendar time expressed for some specific time zone, and with Daylight Saving Time, which is a temporary change in the algorithm for determining local time. The local time zone and Daylight Saving Time are implementation-defined.
The feature test macro __STDC_VERSION_TIME_H__ expands to the token 202ymmL.
The other macros defined are NULL (described in 7.22);
CLOCKS_PER_SECwhich expands to an expression with type clock_t (described later in this subclause) that is the number per second of the value returned by the clock function;TIME_UTC TIME_MONOTONICwhich expand to integer constant expressions greater than 0 designating the calendar time and monotonic time bases, respectively. Additional time base macro definitions, beginning with
TIME_ and an uppercase letter, may also be specified by the implementation;382) and,TIME_ACTIVE TIME_THREAD_ACTIVE
which, if defined, expand to integer values, designating overall execution and thread-specific active processing time bases, respectively.
The definition of macros for time bases other than TIME_UTC are optional. If defined, the corresponding time bases are supported by timespec_get and timespec_getres, and their values are positive. If defined, the value of the optional macro TIME_ACTIVE shall be different from the constants TIME_UTC and TIME_MONOTONIC and shall not change during the same program invocation. The optional macro TIME_THREAD_ACTIVE shall not be defined if the implementation does not support threads; its value shall be different from TIME_UTC, TIME_MONOTONIC, and TIME_ACTIVE, it shall be the same for all expansions of the macro for the same thread, and the value provided for one thread shall not be used by a different thread as the base argument of timespec_get or timespec_getres.
The types declared are size_t (described in 7.22);
clock_tandtime_twhich are real types capable of representing times;struct timespecwhich holds an interval specified in seconds and nanoseconds (which may represent a calendar time based on a particular epoch); and
struct tm
The range and precision of times representable in clock_t and time_t are implementation-defined. The timespec structure shall contain at least the following members, in any order. The semantics of the members and their normal ranges are expressed in the comments.383)
time_t tv_sec; // whole seconds -- ≥ 0*/ /* see the following */ tv_nsec; // nanoseconds -- [0, 999999999]*/
The tv_nsec member shall be an implementation-defined signed integer type capable of representing the range [0, 999999999].
The tm structure shall contain at least the following members, in any order.384) The semantics of the members and their normal ranges are expressed in the comments.
int tm_sec; // seconds after the minute -- [0, 60] int tm_min; // minutes after the hour -- [0, 59] int tm_hour; // hours since midnight -- [0, 23] int tm_mday; // day of the month -- [1, 31] int tm_mon; // months since January -- [0, 11] int tm_year; // years since 1900 int tm_wday; // days since Sunday -- [0, 6] int tm_yday; // days since January 1 -- [0, 365] int tm_isdst; // Daylight Saving Time flag
The value of tm_isdst is positive if Daylight Saving Time is in effect, zero if Daylight Saving Time is not in effect, and negative if the information is not available.
7.31.2 Time manipulation functions
7.31.2.1 The clock function
Synopsis
Description
The clock function determines the processor time used.
Returns
The clock function returns the implementation’s best approximation of the active processing time associated with the program execution since the beginning of an implementation-defined era related only to the program invocation. To determine the time in seconds, the value returned by the clock function should be divided by the value of the macro CLOCKS_PER_SEC. If the processor time used is not available, the function returns the value (clock_t)(-1). If the value cannot be represented, the function returns an unspecified value.385)
7.31.2.2 The difftime function
Synopsis
Description
The difftime function computes the difference between two calendar times: time1 - time0.
Returns
The difftime function returns the difference expressed in seconds as a double.
7.31.2.3 The mktime function
Synopsis
Description
The mktime function converts the broken-down time, expressed as local time, in the structure pointed to by timeptr into a calendar time value with the same encoding as that of the values returned by the time function. The original values of the tm_wday and tm_yday components of the structure are ignored, and the original values of the other components are not restricted to the ranges indicated previously. If the local time to be used for the conversion is one that includes Daylight Saving Time adjustments, a positive or zero value for tm_isdst causes the mktime function to perform the conversion as if Daylight Saving Time, respectively, is or is not in effect for the specified time. A negative value causes it to attempt to determine whether Daylight Saving Time is in effect for the specified time; if it determines that Daylight Saving Time is in effect it produces the same result as an equivalent call with a positive tm_isdst value, otherwise it produces the same result as an equivalent call with a tm_isdst value of zero.386) On successful completion, the components of the structure are set to the same values that would be returned by a call to the localtime function with the calculated calendar time as its argument.
Returns
The mktime function returns the specified calendar time encoded as a value of type time_t. If the calendar time cannot be represented in the time_t encoding used for the return value or the value to be returned in the tm_year component of the structure pointed to by timeptr cannot be represented as an int, the function returns the value (time_t)(-1) and does not change the value of the tm_wday component of the structure.
EXAMPLE What day of the week is July 4, 2001?
#include <stdio.h> #include <time.h> static const char *const wday[] = { "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "-unknown-" }; struct tm time_str; /* ... */ time_str.tm_year = 2001 - 1900; time_str.tm_mon = 7 - 1; time_str.tm_mday = 4; time_str.tm_hour = 0; time_str.tm_min = 0; time_str.tm_sec = 1; time_str.tm_isdst = -1; time_str.tm_wday = 7; mktime(&time_str); printf("%s\n", wday[time_str.tm_wday]);
7.31.2.4 The timegm function
Synopsis
Description
The timegm function converts the broken-down time, expressed as UTC time, in the structure pointed to by timeptr into a calendar time value with the same encoding as that of the values returned by the time function. The original values of the tm_wday and tm_yday components of the structure are ignored, and the original values of the other components are not restricted to the ranges indicated previously. On successful completion, the values of the tm_wday and tm_yday components of the structure are set appropriately, and the other components are set to represent the specified calendar time, but with their values forced to the ranges indicated previously; the final value of tm_mday is not set until tm_mon and tm_year are determined.
Returns
The timegm function returns the specified calendar time encoded as a value of type time_t. If the calendar time cannot be represented in the time_t encoding used for the return value or the value to be returned in the tm_year component of the structure pointed to by timeptr cannot be represented as an int, the function returns the value (time_t)(-1) and does not change the value of the tm_wday component of the structure.
7.31.2.5 The time function
Synopsis
Description
The time function determines the current calendar time. The encoding of the value is unspecified.
Returns
The time function returns the implementation’s best approximation to the current calendar time. The value (time_t)(-1) is returned if the calendar time is not available. If timer is not a null pointer, the return value is also assigned to the object it points to.
7.31.2.6 The timespec_get function
Synopsis
#include <time.h> int timespec_get(struct timespec *ts, int base);
Description
The timespec_get function sets the interval pointed to by ts to hold the current calendar time based on the specified time base.
If base is TIME_UTC, the tv_sec member is set to the number of seconds since an implementationdefined epoch, truncated to a whole value and the tv_nsec member is set to the integral number of nanoseconds, rounded to the resolution of the system clock.387) The optional time base TIME_MONOTONIC is the same, but the reference point is an implementation-defined time point; different program invocations can refer to the same or different reference points.388) For the same program invocation, the results of two calls to timespec_get with TIME_MONOTONIC such that the first happens before the second shall not be decreasing. It is implementation-defined if TIME_MONOTONIC
Returns
If the timespec_get function is successful it returns the nonzero value base; otherwise, it returns zero.
Recommended practice
It is recommended practice that timing results of calls to timespec_get with TIME_ACTIVE, if defined, and of calls to clock are as close to each other as their types, value ranges, and resolutions (obtained with timespec_getres and CLOCKS_PER_SEC, respectively) allow. Because of its wider value range and improved indications on error, timespec_get with time base TIME_ACTIVE should be used instead of clock by new code whenever possible.
7.31.2.7 The timespec_getres function
Synopsis
#include <time.h> int timespec_getres(struct timespec *ts, int base);
Description
If ts is non-null and base is supported by the timespec_get function, the timespec_getres function returns the resolution of the time provided by the timespec_get function for base in the timespec structure pointed to by ts. For each supported base, multiple calls to the timespec_getres function during the same program execution shall have identical results.
Returns
If the value base is supported by the timespec_get function, the timespec_getres function returns the nonzero value base; otherwise, it returns zero.
7.31.3 Time conversion functions
7.31.3.1 General
Functions with a _r suffix place the result of the conversion into the buffer referred by buf and return that pointer. These functions and the function strftime shall not be subject to data races, unless the time or calendar state is changed in a multi-thread execution.390)
Functions gmtime and localtime are the same as their counterparts suffixed with _r. In place of the parameter buf, they use a pointer to one or two broken-down time structures. Similarly, an array of char is commonly used by asctime and ctime. Execution of any of the functions that return a pointer to one of these objects may overwrite the information returned from any previous call to one of these functions that uses the same object. These functions are not reentrant and are not required to avoid data races with each other. Accessing the returned pointer after the thread that called the function that returned it has exited results in undefined behavior. The implementation shall behave as if no other library functions call these functions.
7.31.3.2 The asctime function
Synopsis
#include <time.h> [[deprecated]] char *asctime(const struct tm *timeptr);
Description
This function is obsolescent and should be avoided in new code.
The asctime function converts the broken-down time in the structure pointed to by timeptr into a string in the form
Sun Sep 16 01:03:52 1973\n\0
using the equivalent of the following algorithm.
[[deprecated]] char *asctime(const struct tm *timeptr) { static const char wday_name[7][3] = { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" }; static const char mon_name[12][3] = { "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" }; static char result[26]; snprintf(result, 26, "%.3s %.3s%3d %.2d:%.2d:%.2d %d\n", wday_name[timeptr->tm_wday], mon_name[timeptr->tm_mon], timeptr->tm_mday, timeptr->tm_hour, timeptr->tm_min, timeptr->tm_sec, 1900 + timeptr->tm_year); return result; }
If any of the members of the broken-down time contain values that are outside their normal ranges,391) the behavior of the asctime function is undefined. Likewise, if the calculated year exceeds four digits or is less than the year 1000, the behavior is undefined.
Returns
The asctime function returns a pointer to the string.
7.31.3.3 The ctime function
Synopsis
#include <time.h> [[deprecated]] char *ctime(const time_t *timer);
Description
This function is obsolescent and should be avoided in new code.
The ctime function converts the calendar time pointed to by timer to local time in the form of a string. They are equivalent to:
asctime(localtime(timer))Returns
The ctime function returns the pointer returned by the asctime function with that broken-down time as argument.
localtime functions (7.31.3.5).7.31.3.4 The gmtime functions
Synopsis
#include <time.h> struct tm *gmtime(const time_t *timer); struct tm *gmtime_r(const time_t *timer, struct tm *buf);
Description
The gmtime functions convert the calendar time pointed to by timer into a broken-down time, expressed as UTC.
Returns
The gmtime functions return a pointer to the broken-down time, or a null pointer if the specified time cannot be converted to UTC.
7.31.3.5 The localtime functions
Synopsis
#include <time.h> struct tm *localtime(const time_t *timer); struct tm *localtime_r(const time_t *timer, struct tm *buf);
Description
The localtime functions convert the calendar time pointed to by timer into a broken-down time, expressed as local time.
Returns
The localtime functions return a pointer to the broken-down time, or a null pointer if the specified time cannot be converted to local time.
7.31.3.6 The strftime function
Synopsis
#include <time.h> size_t strftime(char * restrict s, size_t maxsize, const char * restrict format, const struct tm * restrict timeptr);
Description
The strftime function places characters into the array pointed to by s as controlled by the string pointed to by format. The format shall be a multibyte character sequence, beginning and ending in its initial shift state. The format string consists of zero or more conversion specifiers and ordinary multibyte characters. A conversion specifier consists of a % character, possibly followed by an E or O modifier character (described later), followed by a character that determines the behavior of the conversion specifier. All ordinary multibyte characters (including the terminating null character) are copied unchanged into the array. If copying takes place between objects that overlap, the behavior is undefined. No more than maxsize characters are placed into the array.
Each conversion specifier shall be replaced by appropriate characters as described in the following list. The appropriate characters shall be determined using the LC_TIME category of the current locale and by the values of zero or more members of the broken-down time structure pointed to by timeptr, as specified in brackets in the description. If any of the specified values is outside the normal range, the characters stored are unspecified.
%a is replaced by the locale’s abbreviated weekday name. [tm_wday]
%A is replaced by the locale’s full weekday name. [tm_wday]
%b is replaced by the locale’s abbreviated month name. [tm_mon]
Some conversion specifiers can be modified by the inclusion of an E or O modifier character to indicate an alternative format or specification. If the alternative format or specification does not exist for the current locale, the modifier is ignored.
%Ec is replaced by the locale’s alternative date and time representation.
%EC is replaced by the name of the base year (period) in the locale’s alternative representation.
%Ex is replaced by the locale’s alternative date representation.
%EX is replaced by the locale’s alternative time representation.
%Ey is replaced by the offset from %EC (year only) in the locale’s alternative representation.
%EY is replaced by the locale’s full alternative year representation.
%Ob is replaced by the locale’s abbreviated alternative month name.
%OB is replaced by the locale’s alternative appropriate full month name.
%Od is replaced by the day of the month, using the locale’s alternative numeric symbols (filled as needed with leading zeros, or with leading spaces if there is no alternative symbol for zero).
%Oe is replaced by the day of the month, using the locale’s alternative numeric symbols (filled as needed with leading spaces).
%OH is replaced by the hour (24-hour clock), using the locale’s alternative numeric symbols.
%OI is replaced by the hour (12-hour clock), using the locale’s alternative numeric symbols.
%Om is replaced by the month, using the locale’s alternative numeric symbols.
%OM is replaced by the minutes, using the locale’s alternative numeric symbols.
%OS is replaced by the seconds, using the locale’s alternative numeric symbols.
%Ou is replaced by the ISO 8601 weekday as a number in the locale’s alternative representation, where Monday is 1.
%OU is replaced by the week number, using the locale’s alternative numeric symbols.
%OV is replaced by the ISO 8601 week number, using the locale’s alternative numeric symbols.
%Ow is replaced by the weekday as a number, using the locale’s alternative numeric symbols.
%OW is replaced by the week number of the year, using the locale’s alternative numeric symbols.
%Oy is replaced by the last 2 digits of the year, using the locale’s alternative numeric symbols.
%g, %G, and %V give values according to the ISO 8601 week-based year. In this system, weeks begin on a Monday and week 1 of the year is the week that includes January 4th, which is also the week that includes the first Thursday of the year, and is also the first week that contains at least four days in the year. If the first Monday of January is the 2nd, 3rd, or 4th, the preceding days are part of the last week of the preceding year; thus, for Saturday 2nd January 1999, %G is replaced by 1998 and %V is replaced by 53. If December 29th, 30th, or 31st is a Monday, it and any following days are part of week 1 of the following year. Thus, for Tuesday 30th December 1997, %G is replaced by 1998 and %V is replaced by 01.
If a conversion specifier is not one of the ones previously specified, the behavior is undefined.
In the "C" locale, the E and O modifiers are ignored and the replacement strings for the following specifiers are:
%a the first three characters of %A.
%A one of "Sunday", "Monday", ..., "Saturday".
Returns
If the total number of resulting characters including the terminating null character is not more than maxsize, the strftime function returns the number of characters placed into the array pointed to by s not including the terminating null character. Otherwise, zero is returned and the members of the array have an indeterminate representation.
7.32 Unicode utilities <uchar.h>
7.32.1 General
The header <uchar.h> declares one macro, a few types, and several functions for manipulating Unicode characters.
The macro
__STDC_VERSION_UCHAR_H__is an integer constant expression with a value equivalent to 202311L.
The types declared are mbstate_t (described in 7.33.1) and size_t (described in 7.22);
char8_twhich is an unsigned integer type used for 8-bit characters and is the same type as unsigned char;char16_twhich is an unsigned integer type used for 16-bit characters and is the same type as uint_least16_t (described in 7.23.2.3); andchar32_twhich is an unsigned integer type used for 32-bit characters and is the same type as uint_least32_t (also described in 7.23.2.3).
7.32.2 Restartable multibyte/wide character conversion functions
7.32.2.1 General
These functions have a parameter, ps, of type pointer to mbstate_t that points to an object that can completely describe the current conversion state of the associated multibyte character sequence, which the functions alter as necessary. If ps is a null pointer, each function uses its own internal mbstate_t object instead, which is initialized prior to the first call to the function to the initial conversion state; the functions are not required to avoid data races with other calls to the same function in this case. It is implementation-defined whether the internal mbstate_t object has thread storage duration; if it has thread storage duration, it is initialized to the initial conversion state prior to the first call to the function on the new thread. The implementation behaves as if no library function calls these functions with a null pointer for ps.
When used in the functions in this subclause, the encoding of char8_t, char16_t, and char32_t objects, and sequences of such objects, is UTF-8, UTF-16, and UTF-32, respectively. Similarly, the encoding of char and wchar_t, and sequences of such objects, is the execution and wide execution encodings (6.2.9), respectively.
7.32.2.2 The mbrtoc8 function
Synopsis
#include <uchar.h> size_t mbrtoc8(char8_t * restrict pc8, const char * restrict s, size_t n, mbstate_t * restrict ps);
Description
If s is a null pointer, the mbrtoc8 function is equivalent to the call:
mbrtoc8(nullptr, "", 1, ps)
In this case, the values of the parameters pc8 and n are ignored.
If s is not a null pointer, the mbrtoc8 function function inspects at most n bytes beginning with the byte pointed to by s to determine the number of bytes needed to complete the next multibyte character (including any shift sequences). If the function determines that the next multibyte character is complete and valid, it determines the values of the corresponding characters and then, if pc8 is not a null pointer, stores the value of the first (or only) such character in the object pointed to by pc8. Subsequent calls will store successive characters without consuming any additional input until all the characters have been stored. If the corresponding character is the null character, the resulting state described is the initial conversion state.
Returns
The mbrtoc8 function returns the first of the following that applies (given the current conversion state):
0 if the next n or fewer bytes complete the multibyte character that corresponds to the null character (which is the value stored).
between 1 and n inclusive if the next n or fewer bytes complete a valid multibyte character (which is the value stored); the value returned is the number of bytes that complete the multibyte character.
(size_t)(-3) if the next character resulting from a previous call has been stored (no bytes from the input have been consumed by this call).
(size_t)(-2) if the next n bytes contribute to an incomplete (but potentially valid) multibyte character, and all n bytes have been processed (no value is stored).392)
(size_t)(-1) if an encoding error occurs, in which case the next n or fewer bytes do not contribute to a complete and valid multibyte character (no value is stored); the value of the macro EILSEQ is stored in errno, and the conversion state is unspecified.
7.32.2.3 The c8rtomb function
Synopsis
Description
If s is a null pointer, the c8rtomb function is equivalent to the call
c8rtomb(buf, u8’\0’, ps)
where buf is an internal buffer.
If s is not a null pointer, the c8rtomb function determines the number of bytes needed to represent the multibyte character that corresponds to the character given or completed by c8 (including any shift sequences), and stores the multibyte character representation in the array whose first element is pointed to by s, or stores nothing if c8 does not represent a complete character. At most MB_CUR_MAX bytes are stored. If c8 is a null character, a null byte is stored, preceded by any shift sequence needed to restore the initial shift state; the resulting state described is the initial conversion state.
Returns
The c8rtomb function returns the number of bytes stored in the array object (including any shift sequences). When c8 is not a valid character, an encoding error occurs: the function stores the value of the macro EILSEQ in errno and returns (size_t)(-1); the conversion state is unspecified.
7.32.2.4 The mbrtoc16 function
Synopsis
#include <uchar.h> size_t mbrtoc16(char16_t * restrict pc16, const char * restrict s, size_t n, mbstate_t * restrict ps);
Description
If s is a null pointer, the mbrtoc16 function is equivalent to the call:
mbrtoc16(nullptr, "", 1, ps)
In this case, the values of the parameters pc16 and n are ignored.
If s is not a null pointer, the mbrtoc16 function inspects at most n bytes beginning with the byte pointed to by s to determine the number of bytes needed to complete the next multibyte character (including any shift sequences). If the function determines that the next multibyte character is complete and valid, it determines the values of the corresponding wide characters and then, if pc16 is not a null pointer, stores the value of the first (or only) such character in the object pointed to by pc16. Subsequent calls will store successive wide characters without consuming any additional input until all the characters have been stored. If the corresponding wide character is the null wide character, the resulting state described is the initial conversion state.
Returns
The mbrtoc16 function returns the first of the following that applies (given the current conversion state):
0 if the next n or fewer bytes complete the multibyte character that corresponds to the null wide character (which is the value stored).
between 1 and n inclusive if the next n or fewer bytes complete a valid multibyte character (which is the value stored); the value returned is the number of bytes that complete the multibyte character.
(size_t)(-3) if the next character resulting from a previous call has been stored (no bytes from the input have been consumed by this call).
(size_t)(-2) if the next n bytes contribute to an incomplete (but potentially valid) multibyte character, and all n bytes have been processed (no value is stored).393)
(size_t)(-1) if an encoding error occurs, in which case the next n or fewer bytes do not contribute to a complete and valid multibyte character (no value is stored); the value of the macro EILSEQ is stored in errno, and the conversion state is unspecified.
7.32.2.5 The c16rtomb function
Synopsis
Description
If s is a null pointer, the c16rtomb function is equivalent to the call
c16rtomb(buf, u’\0’, ps)
where buf is an internal buffer.
If s is not a null pointer, the c16rtomb function determines the number of bytes needed to represent the multibyte character that corresponds to the wide character given or completed by c16 (including any shift sequences), and stores the multibyte character representation in the array whose first element is pointed to by s, or stores nothing if c16 does not represent a complete character. At most MB_CUR_MAX bytes are stored. If c16 is a null wide character, a null byte is stored, preceded by any shift sequence needed to restore the initial shift state; the resulting state described is the initial conversion state.
Returns
The c16rtomb function returns the number of bytes stored in the array object (including any shift sequences). When c16 is not a valid wide character, an encoding error occurs: the function stores the value of the macro EILSEQ in errno and returns (size_t)(-1); the conversion state is unspecified.
7.32.2.6 The mbrtoc32 function
Synopsis
#include <uchar.h> size_t mbrtoc32(char32_t * restrict pc32, const char * restrict s, size_t n, mbstate_t * restrict ps);
Description
If s is a null pointer, the mbrtoc32 function is equivalent to the call:
mbrtoc32(nullptr, "", 1, ps)
In this case, the values of the parameters pc32 and n are ignored.
If s is not a null pointer, the mbrtoc32 function inspects at most n bytes beginning with the byte pointed to by s to determine the number of bytes needed to complete the next multibyte character (including any shift sequences). If the function determines that the next multibyte character is complete and valid, it determines the values of the corresponding wide characters and then, if pc32 is not a null pointer, stores the value of the first (or only) such character in the object pointed to by pc32. Subsequent calls will store successive wide characters without consuming any additional input until all the characters have been stored. If the corresponding wide character is the null wide character, the resulting state described is the initial conversion state.
Returns
The mbrtoc32 function returns the first of the following that applies (given the current conversion state):
0 if the next n or fewer bytes complete the multibyte character that corresponds to the null wide character (which is the value stored).
between 1 and n inclusive if the next n or fewer bytes complete a valid multibyte character (which is the value stored); the value returned is the number of bytes that complete the multibyte character.
(size_t)(-3) if the next character resulting from a previous call has been stored (no bytes from the input have been consumed by this call).
(size_t)(-2) if the next n bytes contribute to an incomplete (but potentially valid) multibyte character, and all n bytes have been processed (no value is stored).394)
(size_t)(-1) if an encoding error occurs, in which case the next n or fewer bytes do not contribute to a complete and valid multibyte character (no value is stored); the value of the macro EILSEQ is stored in errno, and the conversion state is unspecified.
7.32.2.7 The c32rtomb function
Synopsis
Description
If s is a null pointer, the c32rtomb function is equivalent to the call
c32rtomb(buf, U’\0’, ps)
where buf is an internal buffer.
If s is not a null pointer, the c32rtomb function determines the number of bytes needed to represent the multibyte character that corresponds to the wide character given by c32 (including any shift sequences), and stores the multibyte character representation in the array whose first element is pointed to by s. At most MB_CUR_MAX bytes are stored. If c32 is a null wide character, a null byte is stored, preceded by any shift sequence needed to restore the initial shift state; the resulting state described is the initial conversion state.
Returns
The c32rtomb function returns the number of bytes stored in the array object (including any shift sequences). When c32 is not a valid wide character, an encoding error occurs: the function stores the value of the macro EILSEQ in errno and returns (size_t)(-1); the conversion state is unspecified.
7.33 Extended multibyte and wide character utilities <wchar.h>
7.33.1 Introduction
The header <wchar.h> defines several macros, and declares four data types, one tag, and many functions.395)
The macro
__STDC_VERSION_WCHAR_H__is an integer constant expression with a value equivalent to 202ymmL.
The types declared are wchar_t and size_t (both described in 7.22);
mbstate_twhich is a complete object type other than an array type that can hold the conversion state information necessary to convert between sequences of multibyte characters and wide characters;wint_twhich is an integer type unchanged by default argument promotions that can hold any value corresponding to members of the extended character set, as well as at least one value that does not correspond to any member of the extended character set (see subsequent WEOF description);396) andstruct tm
which is declared as an incomplete structure type (the contents are described in 7.31.1).
The macros defined are NULL (described in 7.22); WCHAR_MIN, WCHAR_MAX, and WCHAR_WIDTH (described in 7.23);
WCHAR_UTF8 WCHAR_UTF16 WCHAR_UTF32
which expand to an expression of signed or unsigned integer type (that is potentially not an integer constant expression) whose value is nonzero if:
- the wide execution encoding (6.2.9) is capable of representing every character in the required Unicode set;
- the width of
wchar_tis at least 8, 16, or 32 for UTF-8, UTF-16, or UTF-32, respectively; - and, the values of a sequence of
wchar_tobjects consumed and produced by related character functions have a values consistent with a sequence of code units of the UTF-8, UTF-16, or UTF-32 encodings, respectively;
MB_UTF8 MB_UTF16 MB_UTF32
which expand to an expression of signed or unsigned integer type (that is potentially not an integer constant expression) whose value is nonzero if:
- the execution encoding (6.2.9) is capable of representing every character in the required Unicode set;
WEOFThe functions declared are grouped as follows:
- Functions that perform input and output of wide characters, or multibyte characters, or both;
- Functions that provide wide string numeric conversion;
- Functions that perform general wide string manipulation;
- Functions for wide string date and time conversion; and
- Functions that provide extended capabilities for conversion between multibyte and wide character sequences.
Arguments to the functions in this subclause may point to arrays containing wchar_t values that do not correspond to members of the extended character set. Such values shall be processed according to the specified semantics, except that it is unspecified whether an encoding error occurs if such a value appears in the format string for a function in 7.33.2 or 7.33.5 and the specified semantics do not require that value to be processed by wcrtomb.
Unless explicitly stated otherwise, if the execution of a function described in this subclause causes copying to take place between objects that overlap, the behavior is undefined.
7.33.2 Formatted wide character input/output functions
7.33.2.1 General
The formatted wide character input/output functions shall behave as if there is a sequence point after the actions associated with each specifier.398)
7.33.2.2 The fwprintf function
Synopsis
#include <stdio.h> #include <wchar.h> int fwprintf(FILE * restrict stream, const wchar_t * restrict format, ...);
Description
The fwprintf function writes output to the stream pointed to by stream, under control of the wide string pointed to by format that specifies how subsequent arguments are converted for output. If there are insufficient arguments for the format, the behavior is undefined. If the format is exhausted while arguments remain, the excess arguments are evaluated (as always) but are otherwise ignored. The fwprintf function returns when the end of the format string is encountered.
The format is composed of zero or more directives: ordinary wide characters (not %), which are copied unchanged to the output stream; and conversion specifications, each of which results in
Each conversion specification is introduced by the wide character %. After the %, the following appear in sequence:
- Zero or more flags (in any order) that modify the meaning of the conversion specification.
- An optional minimum field width. If the converted value has fewer wide characters than the field width, it is padded with spaces (by default) on the left (or right, if the left adjustment flag, described later, has been given) to the field width. The field width takes the form of an asterisk
* (described later) or a nonnegative decimal integer.399)
- An optional precision that gives the minimum number of digits to appear for the
b,B,d,i,o,u,
x, and X conversions, the number of digits to appear after the decimal-point wide character for a, A, e, E, f, and F conversions, the maximum number of significant digits for the g and G conversions, or the maximum number of wide characters to be written for s conversions. The precision takes the form of a period (.) followed either by an asterisk * (described later) or by an optional nonnegative decimal integer; if only the period is specified, the precision is taken as zero. If a precision appears with any other conversion specifier, the behavior is undefined.
- An optional length modifier that specifies the size of the argument.
- A conversion specifier wide character that specifies the type of conversion to be applied.
As noted previously, a field width, or precision, or both, may be indicated by an asterisk. In this case, an int argument supplies the field width or precision. The arguments specifying field width, or precision, or both, shall appear (in that order) before the argument (if any) to be converted. A negative field width argument is taken as a - flag followed by a positive field width. A negative precision argument is taken as if the precision were omitted.
The flag wide characters and their meanings are:
- The result of the conversion is left-justified within the field. (It is right-justified if this flag is not specified.)
+ The result of a signed conversion always begins with a plus or minus sign. (It begins with a sign only when a value with a negative sign is converted if this flag is not specified.)400)
space If the first wide character of a signed conversion is not a sign, or if a signed conversion results in no wide characters, a space is prefixed to the result. If the space and + flags both appear, the space flag is ignored.
# The result is converted to an "alternative form". For o conversion, it increases the precision, if and only if necessary, to force the first digit of the result to be a zero (if the value and precision are both 0, a single 0 is printed). For b conversion, a nonzero result has 0b prefixed to it. For the optional B conversion as described later in this subclause, a nonzero result has 0B prefixed to it. For x (or X) conversion, a nonzero result has 0x (or 0X) prefixed to it. For a, A, e, E, f, F, g, and G conversions, the result of converting a floating-point number always contains a decimal-point wide character, even if no digits follow it. (Normally, a decimal-point wide character appears in the result of these conversions only if a digit follows it.) For g and G conversions, trailing zeros are not removed from the result. For other conversions, the behavior is undefined.
0 For b, B, d, i, o, u, x, X, a, A, e, E, f, F, g, and G conversions, leading zeros (following any indication of sign or base) are used to pad to the field width rather than performing space padding, except when converting an infinity or NaN. If the 0 and - flags both appear, the 0 flag is ignored. For b, B, d, i, o, u, x, and X conversions, if a precision is specified, the 0 flag is ignored. For other conversions, the behavior is undefined.
The length modifiers and their meanings are:
hh Specifies that a following b, B, d, i, o, u, x, or X conversion specifier applies to a signed char or unsigned char argument (the argument will have been promoted according to the integer promotions, but its value shall be converted to signed char or unsigned char before printing); or that a following n conversion specifier applies to a pointer to a signed char argument.
h Specifies that a following b, B, d, i, o, u, x, or X conversion specifier applies to a short int or unsigned short int argument (the argument will have been promoted according to the integer promotions, but its value shall be converted to short int or unsigned short int before printing); or that a following n conversion specifier applies to a pointer to a short int argument.
l (ell) Specifies that a following b, B, d, i, o, u, x, or X conversion specifier applies to a long int or unsigned long int argument; that a following n conversion specifier applies to a pointer to a long int argument; that a following c conversion specifier applies to a wint_t argument; that a following s conversion specifier applies to a pointer to a wchar_t argument; or has no effect on a following a, A, e, E, f, F, g, or G conversion specifier.
ll (ell-ell) Specifies that a following b, B, d, i, o, u, x, or X conversion specifier applies to a long long int or unsigned long long int argument; or that a following n conversion specifier applies to a pointer to a long long int argument.
j Specifies that a following b, B, d, i, o, u, x, or X conversion specifier applies to an intmax_t or uintmax_t argument; or that a following n conversion specifier applies to a pointer to an intmax_t argument.
z Specifies that a following b, B, d, i, o, u, x, or X conversion specifier applies to a size_t or the corresponding signed integer type argument; or that a following n conversion specifier applies to a pointer to a signed integer type corresponding to size_t argument.
t Specifies that a following b, B, d, i, o, u, x, or X conversion specifier applies to a ptrdiff_t or the corresponding unsigned integer type argument; or that a following n conversion specifier applies to a pointer to a ptrdiff_t argument.
wN Specifies that a following b, B, d, i, o, u, x, or X conversion specifier applies to an integer argument with a specific width where N is a positive decimal integer with no leading zeros (the argument will have been promoted according to the integer promotions, but its value shall be converted to the unpromoted type); or that a following n conversion specifier applies to a pointer to an integer type argument with a width of N bits. All minimum-width integer types (7.23.2.3) and exact-width integer types (7.23.2.2) defined in the header <stdint.h> shall be supported. Other supported values of N are implementation-defined.
wfN Specifies that a following b, B, d, i, o, u, x, or X conversion specifier applies to a fastest minimum-width integer argument with a specific width where N is a positive decimal integer with no leading zeros (the argument will have been promoted according to the integer promotions, but its value shall be converted to the unpromoted type); or that a following n conversion specifier applies to a pointer to a fastest minimum-width integer type argument with a width of N bits. All fastest minimum-width integer types (7.23.2.4) defined in the header <stdint.h> shall be supported. Other supported values of N are implementation-defined.
L Specifies that a following a, A, e, E, f, F, g, or G conversion specifier applies to a long double argument.
H Specifies that a following a, A, e, E, f, F, g, or G conversion specifier applies to a _Decimal32 argument.
The conversion specifiers and their meanings are:
d,i The int argument is converted to signed decimal in the style [-]dddd. The precision specifies the minimum number of digits to appear; if the value being converted can be represented in fewer digits, it is expanded with leading zeros. The default precision is . The result of converting a zero value with a precision of zero is no wide characters.
b,B,o,u,x,X The unsigned int argument is converted to unsigned binary (b or B), unsigned octal (o), unsigned decimal (u), or unsigned hexadecimal notation (x or X) in the style dddd; the letters abcdef are used for x conversion and the letters ABCDEF for X conversion. The precision specifies the minimum number of digits to appear; if the value being converted can be represented in fewer digits, it is expanded with leading zeros. The default precision is . The result of converting a zero value with a precision of zero is no wide characters. The specifier B is optional and provides the same functionality as b, except for the ## flag as previously specified. The PRIB macros from <inttypes.h> shall only be defined if the implementation follows the specification as given here.
f,F A double argument representing a floating-point number is converted to decimal notation in the style [-]ddd.ddd, where the number of digits after the decimal-point wide character is equal to the precision specification. If the precision is missing, it is taken as 6; if the precision is zero and the # flag is not specified, no decimal-point wide character appears. If a decimal-point wide character appears, at least one digit appears before it. The value is rounded to the appropriate number of digits.
A double argument representing an infinity is converted in one of the styles [-]inf or [-]infinity — which style is implementation-defined. A double argument representing a NaN is converted in one of the styles [-]nan or [-]nan(n-wchar-sequence) — which style, and the meaning of any n-wchar-sequence, is implementation-defined. The F conversion specifier produces INF, INFINITY, or NAN instead of inf, infinity, or nan, respectively.401)
e,E A double argument representing a floating-point number is converted in the style [-]d.ddde±dd, where there is one digit (which is nonzero if the argument is nonzero) before the decimal-point wide character and the number of digits after it is equal to the precision; if the precision is missing, it is taken as 6; if the precision is zero and the # flag is not specified, no decimal-point wide character appears. The value is rounded to the appropriate number of digits. The E conversion specifier produces a number with E instead of e introducing the exponent. The exponent always contains at least two digits, and only as many more digits as necessary to represent the exponent. If the value is zero, the exponent is zero.
A double argument representing an infinity or NaN is converted in the style of an f or F conversion specifier.
g,G A double argument representing a floating-point number is converted in style f or e (or in style F or E in the case of a G conversion specifier), depending on the value converted and the precision. Let equal the precision if nonzero, if the precision is omitted, or if the precision is zero. Then, if a conversion with style E would have an exponent of :
If a conversion specification is invalid, the behavior is undefined.404) fwprintf shall behave as if it uses va_arg with a type argument naming the type resulting from applying the default argument promotions to the type corresponding to the conversion specification and then converting the result of the va_arg expansion to the type corresponding to the conversion specification.405)
In no case does a nonexistent or small field width cause truncation of a field; if the result of a conversion is wider than the field width, the field is expanded to contain the conversion result.
For a and A conversions, if FLT_RADIX is a power of , the value is correctly rounded to a hexadecimal floating number with the given precision.
Recommended practice
For a and A conversions, if FLT_RADIX is not a power of and the result is not exactly representable in the given precision, the result should be one of the two adjacent numbers in hexadecimal floating style with the given precision, with the extra stipulation that the error should have a correct sign for the current rounding direction.
For e, E, f, F, g, and G conversions, if the number of significant decimal digits is at most the maximum value of the T_DECIMAL_DIG macros (defined in <float.h>), then the result should be correctly
The uppercase B format specifier is made optional by the previous description, because it used to be available for extensions in previous versions of this document. Implementations that did not use an uppercase B as their own extension before are encouraged to implement it as previously described.
Returns
The fwprintf function returns the number of wide characters transmitted, or a negative value if an output or encoding error occurred or if the implementation does not support a specified width length modifier.
Environmental limits
The number of wide characters that can be produced by any single conversion shall be at least 4095.
EXAMPLE To print a date and time in the form "Sunday, July 3, 10:02" followed by to five decimal places:
#include <math.h> #include <stdio.h> #include <wchar.h> /* ... */ wchar_t *weekday, *month; // pointers to wide strings int day, hour, min; fwprintf(stdout, L"%ls, %ls %d, %.2d:%.2d\n", weekday, month, day, hour, min); fwprintf(stdout, L"pi = %.5f\n", 4 * atan(1.0));
7.33.2.3 The fwscanf function
Synopsis
#include <stdio.h> #include <wchar.h> int fwscanf(FILE * restrict stream, const wchar_t * restrict format, ...);
Description
The fwscanf function reads input from the stream pointed to by stream, under control of the wide string pointed to by format that specifies the admissible input sequences and how they are to be converted for assignment, using subsequent arguments as pointers to the objects to receive the converted input. If there are insufficient arguments for the format, the behavior is undefined. If the format is exhausted while arguments remain, the excess arguments are evaluated (as always) but are otherwise ignored.
The format is composed of zero or more directives: one or more white-space wide characters, an ordinary wide character (neither % nor a white-space wide character), or a conversion specification. Each conversion specification is introduced by the wide character %. After the %, the following appear in sequence:
- An optional assignment-suppressing wide character
*.
The fwscanf function executes each directive of the format in turn. When all directives have been executed, or if a directive fails (as detailed later in this subclause), the function returns. Failures are described as input failures (due to the occurrence of an encoding error or the unavailability of input characters), or matching failures (due to inappropriate input).
A directive composed of white-space wide character(s) is executed by reading input up to the first non-white-space wide character (which remains unread), or until no more wide characters can be read. The directive never fails.
A directive that is an ordinary wide character is executed by reading the next wide character of the stream. If that wide character differs from the directive, the directive fails and the differing and subsequent wide characters remain unread. Similarly, if end-of-file, an encoding error, or a read error prevents a wide character from being read, the directive fails.
A directive that is a conversion specification defines a set of matching input sequences, as described further in this subclause for each specifier. A conversion specification is executed in the following steps:
Input white-space wide characters are skipped, unless the specification includes a [, c, or n specifier.407)
An input item is read from the stream, unless the specification includes an n specifier. An input item is defined as the longest sequence of input wide characters which does not exceed any specified field width and which is, or is a prefix of, a matching input sequence.408) The first wide character, if any, after the input item remains unread. If the length of the input item is zero, the execution of the directive fails; this condition is a matching failure unless end-of-file, an encoding error, or a read error prevented input from the stream, in which case it is an input failure.
Except in the case of a % specifier, the input item (or, in the case of a %n directive, the count of input wide characters) is converted to a type appropriate to the conversion specifier. If the input item is not a matching sequence, the execution of the directive fails: this condition is a matching failure. Unless assignment suppression was indicated by a *, the result of the conversion is placed in the object pointed to by the first argument following the format argument that has not already received a conversion result. If this object does not have an appropriate type, or if the result of the conversion cannot be represented in the object, the behavior is undefined.
The length modifiers and their meanings are:
hh Specifies that a following b, d, i, o, u, x, X, or n conversion specifier applies to an argument with type pointer to signed char or unsigned char.
h Specifies that a following b, d, i, o, u, x, X, or n conversion specifier applies to an argument with type pointer to short int or unsigned short int.
l (ell) Specifies that a following b, d, i, o, u, x, X, or n conversion specifier applies to an argument with type pointer to long int or unsigned long int; that a following a, A, e, E, f, F, g, or G conversion specifier applies to an argument with type pointer to double; or that a following c, s, or [ conversion specifier applies to an argument with type pointer to wchar_t.
ll (ell-ell) Specifies that a following b, d, i, o, u, x, X, or n conversion specifier applies to an argument with type pointer to long long int or unsigned long long int.
In the following, the type of the corresponding argument for a conversion specifier shall be a pointer to a type determined by the length modifiers, if any, or specified by the conversion specifier. The conversion specifiers and their meanings are:
d Matches an optionally signed decimal integer, whose format is the same as expected for the subject sequence of the wcstol function with the value for the base argument. Unless a length modifier is specified, the corresponding argument shall be a pointer to int.
b Matches an optionally signed binary integer, whose format is the same as expected for the subject sequence of the wcstoul function with the value for the base argument. Unless a length modifier is specified, the corresponding argument shall be a pointer to unsigned int.
i Matches an optionally signed integer, whose format is the same as expected for the subject sequence of the wcstol function with the value for the base argument. Unless a length modifier is specified, the corresponding argument shall be a pointer to int.
o Matches an optionally signed octal integer, whose format is the same as expected for the subject sequence of the wcstoul function with the value for the base argument. Unless a length modifier is specified, the corresponding argument shall be a pointer to unsigned int.
u Matches an optionally signed decimal integer, whose format is the same as expected for the subject sequence of the wcstoul function with the value for the base argument. Unless a length modifier is specified, the corresponding argument shall be a pointer to unsigned int.
The conversion specifiers A, E, F, G, and X are also valid and behave the same as, respectively, a, e, f, g, and x.
Trailing white-space wide characters (including new-line wide characters) are left unread unless matched by a directive. The success of literal matches and suppressed assignments is not directly determinable other than via the %n directive.
Returns
The fwscanf function returns the value of the macro EOF if an input failure occurs before the first conversion (if any) has completed. Otherwise, the function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure or if the implementation does not support a specific width length modifier.
EXAMPLE 1 The call:
#include <stdio.h> #include <wchar.h> /* ... */ int n, i; float x; wchar_t name[50]; n = fwscanf(stdin, L"%d%f%ls", &i, &x, name);with the input line:
25 54.32E-1 thompsonwill assign to n the value , to i the value , to x the value , and to name the sequence thompson\0.
EXAMPLE 2 The call:
#include <stdio.h> #include <wchar.h> /* ... */ int i; float x; double y; fwscanf(stdin, L"%2d%f%*d %lf", &i, &x, &y);with input:
56789 0123 56a72will assign to i the value and to x the value , will skip past 0123, and will assign to y the value . The next wide character read from the input stream will be a.
wcstod, wcstof, and wcstold functions (7.33.4.2.2), the wcstol, wcstoll, wcstoul, and wcstoull functions (7.33.4.2.4), the wcrtomb function (7.33.6.4.4).7.33.2.4 The swprintf function
Synopsis
#include <wchar.h> int swprintf(wchar_t * restrict s, size_t n, const wchar_t * restrict format, ...);
Description
The swprintf function is equivalent to fwprintf, except that the argument s specifies an array of wide characters into which the generated output is to be written, rather than written to a stream. No more than n wide characters are written, including a terminating null wide character, which is always added (unless n is zero).
Returns
The swprintf function returns the number of wide characters written in the array, not counting the terminating null wide character, or a negative value if an encoding error occurred or if n or more wide characters were requested to be written.
7.33.2.5 The swscanf function
Synopsis
Description
The swscanf function is equivalent to fwscanf, except that the argument s specifies a wide string from which the input is to be obtained, rather than from a stream. Reaching the end of the wide string is equivalent to encountering end-of-file for the fwscanf function.
Returns
The swscanf function returns the value of the macro EOF if an input failure occurs before the first conversion (if any) has completed. Otherwise, the swscanf function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
7.33.2.6 The vfwprintf function
Synopsis
#include <stdarg.h> #include <stdio.h> #include <wchar.h> int vfwprintf(FILE * restrict stream, const wchar_t * restrict format, va_list arg);
Description
The vfwprintf function is equivalent to fwprintf, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg invocations). The vfwprintf function does not invoke the va_end macro.410)
Returns
The vfwprintf function returns the number of wide characters transmitted, or a negative value if an output or encoding error occurred.
EXAMPLE The following shows the use of the vfwprintf function in a general error-reporting routine.
#include <stdarg.h> #include <stdio.h> #include <wchar.h> void error(char *function_name, wchar_t *format, ...) { va_list args; va_start(args, format); // print out name of function causing error fwprintf(stderr, L"ERROR in %s: ", function_name); // print out remainder of message vfwprintf(stderr, format, args); va_end(args); }
7.33.2.7 The vfwscanf function
Synopsis
#include <stdarg.h> #include <stdio.h> #include <wchar.h> int vfwscanf(FILE * restrict stream, const wchar_t * restrict format, va_list arg);
Description
The vfwscanf function is equivalent to fwscanf, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg calls). The vfwscanf function does not invoke the va_end macro.410)
Returns
The vfwscanf function returns the value of the macro EOF if an input failure occurs before the first conversion (if any) has completed. Otherwise, the vfwscanf function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
7.33.2.8 The vswprintf function
Synopsis
#include <stdarg.h> #include <wchar.h> int vswprintf(wchar_t * restrict s, size_t n, const wchar_t * restrict format, va_list arg);
Description
The vswprintf function is equivalent to swprintf, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg calls). The vswprintf function does not invoke the va_end macro.410)
Returns
The vswprintf function returns the number of wide characters written in the array, not counting the terminating null wide character, or a negative value if an encoding error occurred or if n or more wide characters were requested to be generated.
7.33.2.9 The vswscanf function
Synopsis
#include <stdarg.h> #include <wchar.h> int vswscanf(const wchar_t * restrict s, const wchar_t * restrict format, va_list arg);
Description
The vswscanf function is equivalent to swscanf, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg calls). The vswscanf function does not invoke the va_end macro.410)
Returns
The vswscanf function returns the value of the macro EOF if an input failure occurs before the first conversion (if any) has completed. Otherwise, the vswscanf function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
7.33.2.10 The vwprintf function
Synopsis
Description
The vwprintf function is equivalent to wprintf, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg calls). The vwprintf function does not invoke the va_end macro.410)
Returns
The vwprintf function returns the number of wide characters transmitted, or a negative value if an output or encoding error occurred.
7.33.2.11 The vwscanf function
Synopsis
Description
The vwscanf function is equivalent to wscanf, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg calls). The vwscanf function does not invoke the va_end macro.410)
Returns
The vwscanf function returns the value of the macro EOF if an input failure occurs before the first conversion (if any) has completed. Otherwise, the vwscanf function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
7.33.2.12 The wprintf function
Synopsis
Description
The wprintf function is equivalent to fwprintf with the argument stdout interposed before the arguments to wprintf.
Returns
The wprintf function returns the number of wide characters transmitted, or a negative value if an output or encoding error occurred.
7.33.2.13 The wscanf function
Synopsis
Description
The wscanf function is equivalent to fwscanf with the argument stdin interposed before the arguments to wscanf.
Returns
The wscanf function returns the value of the macro EOF if an input failure occurs before the first conversion (if any) has completed. Otherwise, the wscanf function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
7.33.3 Wide character input/output functions
7.33.3.1 The fgetwc function
Synopsis
Description
If the end-of-file indicator for the input stream pointed to by stream is not set and a next wide character is present, the fgetwc function obtains that wide character as a wchar_t converted to a wint_t and advances the associated file position indicator for the stream (if defined).
Returns
If the end-of-file indicator for the stream is set, or if the stream is at end-of-file, the end-of-file indicator for the stream is set and the fgetwc function returns WEOF. Otherwise, the fgetwc function returns the next wide character from the input stream pointed to by stream. If a read error occurs, the error indicator for the stream is set and the fgetwc function returns WEOF. If an encoding error occurs (including too few bytes), the error indicator for the stream is set and the value of the macro EILSEQ is stored in errno and the fgetwc function returns WEOF.411)
7.33.3.2 The fgetws function
Synopsis
#include <stdio.h> #include <wchar.h> wchar_t *fgetws(wchar_t * restrict s, int n, FILE * restrict stream);
Description
The fgetws function reads at most one less than the number of wide characters specified by n from the stream pointed to by stream into the array pointed to by s. No additional wide characters are read after a new-line wide character (which is retained) or after end-of-file. A null wide character is written immediately after the last wide character read into the array. If n is negative or zero, the behavior is undefined.
Returns
The fgetws function returns s if successful. If end-of-file is encountered and no characters have been read into the array, the contents of the array remain unchanged and a null pointer is returned. If a read or encoding error occurs during the operation, the array members have an indeterminate representation and a null pointer is returned.
7.33.3.3 The fputwc function
Synopsis
Description
The fputwc function writes the wide character specified by c to the output stream pointed to by stream, at the position indicated by the associated file position indicator for the stream (if defined), and advances the indicator appropriately. If the file cannot support positioning requests, or if the stream was opened with append mode, the character is appended to the output stream.
Returns
The fputwc function returns the wide character written. If a write error occurs, the error indicator for the stream is set and fputwc returns WEOF. If an encoding error occurs, the error indicator for the stream is set and the value of the macro EILSEQ is stored in errno and fputwc returns WEOF.
7.33.3.4 The fputws function
Synopsis
#include <stdio.h> #include <wchar.h> int fputws(const wchar_t * restrict s, FILE * restrict stream);
Description
The fputws function writes the wide string pointed to by s to the stream pointed to by stream. The terminating null wide character is not written.
Returns
The fputws function returns EOF if a write or encoding error occurs; otherwise, it returns a nonnegative value.
7.33.3.5 The fwide function
Synopsis
Description
The fwide function determines the orientation of the stream pointed to by stream. If mode is greater than zero, the function first attempts to make the stream wide oriented. If mode is less than zero, the function first attempts to make the stream byte oriented.412) Otherwise, mode is zero and the function does not alter the orientation of the stream.
Returns
The fwide function returns a value greater than zero if, after the call, the stream has wide orientation, a value less than zero if the stream has byte orientation, or zero if the stream has no orientation.
7.33.3.6 The getwc function
Synopsis
Description
The getwc function is equivalent to fgetwc, except that if it is implemented as a macro, it may evaluate stream more than once, so the argument should never be an expression with side effects.
Returns
The getwc function returns the next wide character from the input stream pointed to by stream, or WEOF.
7.33.3.7 The getwchar function
Synopsis
Description
The getwchar function is equivalent to getwc with the argument stdin.
Returns
The getwchar function returns the next wide character from the input stream pointed to by stdin, or WEOF.
7.33.3.8 The putwc function
Synopsis
Description
The putwc function is equivalent to fputwc, except that if it is implemented as a macro, it may evaluate stream more than once, so that argument should never be an expression with side effects.
Returns
The putwc function returns the wide character written, or WEOF.
7.33.3.9 The putwchar function
Synopsis
Description
The putwchar function is equivalent to putwc with the second argument stdout.
Returns
The putwchar function returns the character written, or WEOF.
7.33.3.10 The ungetwc function
Synopsis
Description
The ungetwc function pushes the wide character specified by c back onto the input stream pointed to by stream. Pushed-back wide characters will be returned by subsequent reads on that stream in the reverse order of their pushing. A successful intervening call (with the stream pointed to by stream) to a file positioning function (fseek, fsetpos, or rewind) discards any pushed-back wide characters for the stream. The external storage corresponding to the stream is unchanged.
One wide character of pushback is guaranteed, even if the call to the ungetwc function follows just after a call to a formatted wide character input function fwscanf, vfwscanf, vwscanf, or wscanf. If the ungetwc function is called too many times on the same stream without an intervening read or file positioning operation on that stream, the operation may fail.
If the value of c equals that of the macro WEOF, the operation fails and the input stream is unchanged.
A successful call to the ungetwc function clears the end-of-file indicator for the stream. The value of the file position indicator for the stream after reading or discarding all pushed-back wide characters is the same as it was before the wide characters were pushed back.413) For a text or binary stream, the value of its file position indicator after a successful call to the ungetwc function is unspecified until all pushed-back wide characters are read or discarded.
Returns
The ungetwc function returns the wide character pushed back, or WEOF if the operation fails.
7.33.4 General wide string utilities
7.33.4.1 General
The header <wchar.h> declares functions for wide string manipulation. Various methods are used for determining the lengths of the arrays, but in all cases a wchar_t* argument points to the initial (lowest addressed) element of the array. If an array is accessed beyond the end of an object, the behavior is undefined.
Where an argument declared as size_t n determines the length of the array for a function, n can have the value zero on a call to that function. Unless explicitly stated otherwise in the description of a particular function in this subclause, pointer arguments on such a call may be null pointers. On such a call, a function that locates a wide character finds no occurrence, a function that compares
7.33.4.2 Wide string numeric conversion functions
7.33.4.2.1 General
This subclause describes wide string analogs of the strtod family of functions (7.25.2.6, 7.25.2.7).414)
7.33.4.2.2 The wcstod, wcstof, and wcstold functions
Synopsis
#include <wchar.h> double wcstod(const wchar_t * restrict nptr, wchar_t ** restrict endptr); float wcstof(const wchar_t * restrict nptr, wchar_t ** restrict endptr); long double wcstold(const wchar_t * restrict nptr, wchar_t ** restrict endptr);
Description
The wcstod, wcstof, and wcstold functions convert the initial portion of the wide string pointed to by nptr to double, float, and long double representation, respectively. First, they decompose the input string into three parts: an initial, possibly empty, sequence of white-space wide characters, a subject sequence resembling a floating literal or representing an infinity or NaN; and a final wide string of one or more unrecognized wide characters, including the terminating null wide character of the input wide string. Then, they attempt to convert the subject sequence to a floating-point number, and return the result.
The expected form of the subject sequence is an optional plus or minus sign, then one of the following:
- decimal form: a nonempty sequence of decimal digits optionally containing a decimal-point wide character, then an optional exponent part as defined for the corresponding single-byte characters in 6.4.5.3, excluding any digit separators (6.4.5.2);
- hexadecimal form: a
0xor0X, then a nonempty sequence of hexadecimal digits optionally containing a decimal-point wide character, then an optional binary exponent part as defined in 6.4.5.3, excluding any digit separators (6.4.5.2); -
INForINFINITY, or any other wide string equivalent except for case -
NANorNAN(n-wchar-sequenceopt), or any other wide string equivalent except for case in theNAN
part, where:
If the subject sequence has the decimal or hexadecimal form, the sequence of wide characters starting with the first digit or the decimal-point wide character (whichever occurs first) is interpreted as a floating literal according to the rules of 6.4.5.3, except that the decimal-point wide character is used in place of a period, and that if neither an exponent part nor a decimal-point wide character appears in a decimal form, or if a binary exponent part does not appear in a hexadecimal form, an exponent part of the appropriate type with value zero is assumed to follow the last digit in the string.
If the subject sequence begins with a minus sign, the sequence is interpreted as arithmetically negated.415)
A wide character sequence INF or INFINITY is interpreted as an infinity, if representable in the return type, else like a floating literal that is too large for the range of the return type. A wide character sequence NAN or NAN(n-wchar-sequenceopt) is interpreted as a quiet NaN, if supported in the return type, else like a subject sequence part that does not have the expected form; the meaning of the n-wchar sequence is implementation-defined.416)
A pointer to the final wide string is stored in the object pointed to by endptr, provided that endptr is not a null pointer.
If the subject sequence has the hexadecimal form and FLT_RADIX is a power of , the value resulting from the conversion is correctly rounded.
In other than the "C" locale, additional locale-specific subject sequence forms may be accepted.
If the subject sequence is empty or does not have the expected form, no conversion is performed; the value of nptr is stored in the object pointed to by endptr, provided that endptr is not a null pointer.
Recommended practice
If the subject sequence has the hexadecimal form, FLT_RADIX is not a power of , and the result is not exactly representable, the result should be one of the two numbers in the appropriate internal format that are adjacent to the hexadecimal floating source value, with the extra stipulation that the error should have a correct sign for the current rounding direction.
If the subject sequence has the decimal form and at most significant digits, where is the maximum value of the T_DECIMAL_DIG macros (defined in <float.h>), the result should be correctly rounded. If the subject sequence D has the decimal form and more than significant digits, consider the two bounding, adjacent decimal strings L and U, both having significant digits, such that the values of L, D, and U satisfy L ≤D ≤U. The result should be one of the (equal or adjacent) values that would be obtained by correctly rounding L and U according to the current rounding direction, with the extra stipulation that the error with respect to D should have a correct sign for the current rounding direction.417)
Returns
The functions return the converted value, if any. If no conversion could be performed, positive or unsigned zero is returned.
If the correct value overflows and default rounding is in effect (7.12.2), plus or minus HUGE_VAL, HUGE_VALF, or HUGE_VALL is returned (according to the return type and sign of the value); if the integer expression math_errhandling & MATH_ERRNO is nonzero, the integer expression errno
If the result underflows (7.12.2), the functions return a value whose magnitude is no greater than the smallest normalized positive number in the return type; if the integer expression math_errhandling & MATH_ERRNO is nonzero, whether errno acquires the value ERANGE is implementation-defined; if the integer expression math_errhandling & MATH_ERREXCEPT is nonzero, whether the "underflow" floating-point exception is raised is implementation-defined.
7.33.4.2.3 The wcstodN functions
Synopsis
#include <wchar.h> #ifdef __STDC_IEC_60559_DFP__ _Decimal32 wcstod32(const wchar_t * restrict nptr, wchar_t ** restrict endptr); _Decimal64 wcstod64(const wchar_t * restrict nptr, wchar_t ** restrict endptr); _Decimal128 wcstod128(const wchar_t * restrict nptr, wchar_t ** restrict endptr); #endif
Description
The wcstodN functions convert the initial portion of the wide string pointed to by nptr to decimal floating type representation. First, they decompose the input wide string into three parts: an initial, possibly empty, sequence of white-space wide characters; a subject sequence resembling a floating literal or representing an infinity or NaN; and a final wide string of one or more unrecognized wide characters, including the terminating null wide character of the input wide string. Then, they attempt to convert the subject sequence to a floating-point number, and return the result.
The expected form of the subject sequence is an optional plus or minus sign, then one of the following:
- decimal form: a nonempty sequence of decimal digits optionally containing a decimal-point wide character, then an optional exponent part as defined in 6.4.5.3, excluding any digit separators (6.4.5.2)
- hexadecimal form: a
0xor0X, then a nonempty sequence of hexadecimal digits optionally containing a decimal-point wide character, then an optional binary exponent part as defined in 6.4.5.3, excluding any digit separators (6.4.5.2) -
INForINFINITY, ignoring case -
NANorNAN(d-wchar-sequenceopt), ignoring case in theNANpart, where:
The subject sequence is defined as the longest initial subsequence of the input wide string, starting with the first non-white-space wide character, that is of the expected form. The subject sequence contains no wide characters if the input wide string is not of the expected form.
If the subject sequence has the decimal or hexadecimal form, the sequence of wide characters starting with the first digit or the decimal-point wide character (whichever occurs first) is interpreted as a floating literal according to the rules of 6.4.5.3, except that the decimal-point wide character is used in place of a period, and that if neither an exponent part nor a decimal-point wide character appears in a decimal form, or if a binary exponent part does not appear in a hexadecimal form, an exponent part of the appropriate type with value zero is assumed to follow the last digit in the wide string. If the subject sequence begins with a minus sign, the sequence is interpreted as arithmetically negated before rounding and the sign is set to , else is set to .
If the subject sequence has the decimal form, the value resulting from the conversion is correctly rounded and the coefficient and the quantum exponent are determined by the rules in 6.4.5.3 for a decimal floating literal of decimal type.
If the subject sequence has the hexadecimal form, the value resulting from the conversion is correctly rounded provided the subject sequence has at most significant hexadecimal digits, where is implementation-defined, and is the maximum precision of the supported radix-2 floating types and binary non-arithmetic interchange formats.418) If the value resulting from the conversion is correctly rounded for all subject sequences of hexadecimal form, may be regarded as infinite. If the subject sequence has more than significant hexadecimal digits, the implementation may first round to significant hexadecimal digits according to the applicable decimal rounding direction mode, signaling exceptions as though converting from a wider format, then correctly round the result of the shortened hexadecimal input to the result type. The preferred quantum exponent for the result is if the hexadecimal number is exactly represented in the decimal type; the preferred quantum exponent for the result is the least possible if the hexadecimal number is not exactly represented in the decimal type.
A wide character sequence INF or INFINITY is interpreted as an infinity. A wide character sequence NAN or NAN(d-wchar-sequenceopt), is interpreted as a quiet NaN; the meaning of the d-wchar sequence is implementation-defined.419) A pointer to the final wide string is stored in the object pointed to by endptr, provided that endptr is not a null pointer.
In other than the "C" locale, additional locale-specific subject sequence forms may be accepted.
If the subject sequence is empty or does not have the expected form, no conversion is performed; the value of nptr is stored in the object pointed to by endptr, provided that endptr is not a null pointer.
Returns
The wcstodN functions return the converted value, if any. If no conversion could be performed, the value of the triple is returned. If the correct value overflows:
- the value of the macro
ERANGEis stored inerrnoif the integer expressionmath_errhandling
& MATH_ERRNO is nonzero;
- the "overflow" floating-point exception is raised if the integer expression
math_errhandling
& MATH_ERREXCEPT is nonzero.
If the result underflows (7.12.2), whether errno acquires the value ERANGE if the integer expression math_errhandling & MATH_ERRNO is nonzero is implementation-defined; if the integer expression math_errhandling & MATH_ERREXCEPT is nonzero, whether the "underflow" floating-point exception is raised is implementation-defined.
7.33.4.2.4 The wcstol, wcstoll, wcstoul, and wcstoull functions
Synopsis
#include <wchar.h> long int wcstol(const wchar_t * restrict nptr, wchar_t ** restrict endptr, int base); long long int wcstoll(const wchar_t * restrict nptr, wchar_t ** restrict endptr, int base); unsigned long int wcstoul(const wchar_t * restrict nptr, wchar_t ** restrict endptr, int base); unsigned long long int wcstoull(const wchar_t * restrict nptr, wchar_t ** restrict endptr, int base);
Description
The wcstol, wcstoll, wcstoul, and wcstoull functions convert the initial portion of the wide string pointed to by nptr to long int, long long int, unsigned long int, and unsigned long long int representation, respectively. First, they decompose the input string into three parts: an initial, possibly empty, sequence of white-space wide characters, a subject sequence resembling an integer represented in some radix determined by the value of base, and a final wide string of one or more unrecognized wide characters, including the terminating null wide character of the input wide string. Then, they attempt to convert the subject sequence to an integer, and return the result.
If the value of base is zero, the expected form of the subject sequence is that of an integer literal as described for the corresponding single-byte characters in 6.4.5.2, optionally preceded by a plus or minus sign, but not including an integer suffix or any optional digit separators (6.4.5.2). If the value of base is between and (inclusive), the expected form of the subject sequence is a sequence of letters and digits representing an integer with the radix specified by base, optionally preceded by a plus or minus sign, but not including an integer suffix or any optional digit separators. The letters from a (or A) through z (or Z) are ascribed the values through ; only letters and digits whose ascribed values are less than that of base are permitted. If the value of base is , the wide characters 0b or 0B can optionally precede the sequence of letters and digits, following the sign if present. If the value of base is , the wide characters 0o or 0O can optionally precede the sequence of letters and digits, following the sign if present. If the value of base is , the wide characters 0x or 0X can optionally precede the sequence of letters and digits, following the sign if present.
The subject sequence is defined as the longest initial subsequence of the input wide string, starting with the first non-white-space wide character, that is of the expected form. The subject sequence contains no wide characters if the input wide string is empty or consists entirely of white-space wide characters, or if the first non-white-space wide character is other than a sign or a permissible letter or digit.
If the subject sequence has the expected form and the value of base is zero, the sequence of wide characters starting with the first digit is interpreted as an integer literal according to the rules of 6.4.5.2. If the subject sequence has the expected form and the value of base is between and , it is used as the base for conversion, ascribing to each letter its value as previously given. If the subject sequence begins with a minus sign, the resulting value is the negative of the converted value; for functions whose return type is an unsigned integer type this action is performed in the return type. A pointer to the final wide string is stored in the object pointed to by endptr, provided that endptr is not a null pointer.
In other than the "C" locale, additional locale-specific subject sequence forms may be accepted.
If the subject sequence is empty or does not have the expected form, no conversion is performed; the value of nptr is stored in the object pointed to by endptr, provided that endptr is not a null pointer.
Returns
The wcstol, wcstoll, wcstoul, and wcstoull functions return the converted value, if any. If no conversion could be performed, zero is returned. If the correct value is outside the range of representable values, LONG_MIN, LONG_MAX, LLONG_MIN, LLONG_MAX, ULONG_MAX, or ULLONG_MAX is returned (according to the return type sign of the value, if any), and the value of the macro ERANGE is stored in errno.
7.33.4.3 Wide string copying functions
7.33.4.3.1 The wcscpy function
Synopsis
Description
The wcscpy function copies the wide string pointed to by s2 (including the terminating null wide character) into the array pointed to by s1.
Returns
The wcscpy function returns the value of s1.
7.33.4.3.2 The wcsncpy function
Synopsis
Description
The wcsncpy function copies not more than n wide characters (those that follow a null wide character are not copied) from the array pointed to by s2 to the array pointed to by s1.420)
If the array pointed to by s2 is a wide string that is shorter than n wide characters, null wide characters are appended to the copy in the array pointed to by s1, until n wide characters in all have been written.
Returns
The wcsncpy function returns the value of s1.
7.33.4.3.3 The wmemcpy function
Synopsis
Description
The wmemcpy function copies n wide characters from the object pointed to by s2 to the object pointed to by s1.
Returns
The wmemcpy function returns the value of s1.
7.33.4.3.4 The wmemmove function
Synopsis
Description
The wmemmove function copies n wide characters from the object pointed to by s2 to the object pointed to by s1. Copying takes place as if the n wide characters from the object pointed to by s2 are first copied into a temporary array of n wide characters that does not overlap the objects pointed to by s1 or s2, and then the n wide characters from the temporary array are copied into the object pointed to by s1.
Returns
The wmemmove function returns the value of s1.
7.33.4.4 Wide string concatenation functions
7.33.4.4.1 The wcscat function
Synopsis
Description
The wcscat function appends a copy of the wide string pointed to by s2 (including the terminating null wide character) to the end of the wide string pointed to by s1. The initial wide character of s2 overwrites the null wide character at the end of s1.
Returns
The wcscat function returns the value of s1.
7.33.4.4.2 The wcsncat function
Synopsis
Description
The wcsncat function appends not more than n wide characters (a null wide character and wide characters that follow it are not appended) from the array pointed to by s2 to the end of the wide string pointed to by s1. The initial wide character of s2 overwrites the null wide character at the end of s1. A terminating null wide character is always appended to the result.421) If s1 is a null pointer value, the behavior is undefined.
Returns
The wcsncat function returns the value of s1.
7.33.4.5 Wide string comparison functions
7.33.4.5.1 General
Unless explicitly stated otherwise, the functions described in this subclause order two wide characters the same way as two integers of the underlying integer type designated by wchar_t.
7.33.4.5.2 The wcscmp function
Synopsis
Description
The wcscmp function compares the wide string pointed to by s1 to the wide string pointed to by s2.
Returns
The wcscmp function returns an integer greater than, equal to, or less than zero, accordingly as the wide string pointed to by s1 is greater than, equal to, or less than the wide string pointed to by s2.
7.33.4.5.3 The wcscoll function
Synopsis
Description
The wcscoll function compares the wide string pointed to by s1 to the wide string pointed to by s2, both interpreted as appropriate to the LC_COLLATE category of the current locale.
Returns
The wcscoll function returns an integer greater than, equal to, or less than zero, accordingly as the wide string pointed to by s1 is greater than, equal to, or less than the wide string pointed to by s2 when both are interpreted as appropriate to the current locale.
7.33.4.5.4 The wcsncmp function
Synopsis
Description
The wcsncmp function compares not more than n wide characters (those that follow a null wide character are not compared) from the array pointed to by s1 to the array pointed to by s2.
Returns
The wcsncmp function returns an integer greater than, equal to, or less than zero, accordingly as the possibly null-terminated array pointed to by s1 is greater than, equal to, or less than the possibly null-terminated array pointed to by s2.
7.33.4.5.5 The wcsxfrm function
Synopsis
Description
The wcsxfrm function transforms the wide string pointed to by s2 and places the resulting wide string into the array pointed to by s1. The transformation is such that if the wcscmp function is applied to two transformed wide strings, it returns a value greater than, equal to, or less than zero, corresponding to the result of the wcscoll function applied to the same two original wide strings. No more than n wide characters are placed into the resulting array pointed to by s1, including the terminating null wide character. If n is zero, s1 is permitted to be a null pointer.
Returns
The wcsxfrm function returns the length of the transformed wide string (not including the terminating null wide character). If the value returned is n or greater, the members of the array pointed to by s1 have an indeterminate representation.
EXAMPLE The value of the following expression is the length of the array needed to hold the transformation of the wide string pointed to by s:
1 + wcsxfrm(nullptr, s, 0)
7.33.4.5.6 The wmemcmp function
Synopsis
Description
The wmemcmp function compares the first n wide characters of the object pointed to by s1 to the first n wide characters of the object pointed to by s2.
Returns
The wmemcmp function returns an integer greater than, equal to, or less than zero, accordingly as the object pointed to by s1 is greater than, equal to, or less than the object pointed to by s2.
7.33.4.6 Wide string search functions
7.33.4.6.1 Introduction
The stateless search functions in this subclause (wcschr, wcspbrk, wcsrchr, wmemchr, wcsstr) are generic functions. These functions are generic in the qualification of the array to be searched and will return a result pointer to an element with the same qualification as the passed array. If the array to be searched is const-qualified, the result pointer will be to a const-qualified element. If the array to be searched is not const-qualified,422) the result pointer will be to an unqualified element.
The external declarations of these generic functions have a concrete function type that returns a pointer to an unqualified element of type wchar_t (indicated by QWchar_t, and accepts a pointer to a const-qualified array of the same type to search. This signature supports all correct uses. If a macro definition of any of these generic functions is suppressed to access an actual function, the external declaration with this concrete type is visible.423)
The volatile and restrict qualifiers are not accepted on the elements of the array to search.
7.33.4.6.2 The wcschr generic function
Synopsis
Description
The wcschr generic function locates the first occurrence of c in the wide string pointed to by s. The terminating null wide character is considered to be part of the wide string.
Returns
The wcschr generic function returns a pointer to the located wide character, or a null pointer if the wide character does not occur in the wide string.
7.33.4.6.3 The wcscspn function
Synopsis
Description
The wcscspn function computes the length of the maximum initial segment of the wide string pointed to by s1 which consists entirely of wide characters not from the wide string pointed to by s2.
Returns
The wcscspn function returns the length of the segment.
7.33.4.6.4 The wcspbrk generic function
Synopsis
Description
The wcspbrk generic function locates the first occurrence in the wide string pointed to by s1 of any wide character from the wide string pointed to by s2.
Returns
The wcspbrk generic function returns a pointer to the wide character in s1, or a null pointer if no wide character from s2 occurs in s1.
7.33.4.6.5 The wcsrchr generic function
Synopsis
Description
The wcsrchr generic function locates the last occurrence of c in the wide string pointed to by s. The terminating null wide character is considered to be part of the wide string.
Returns
The wcsrchr generic function returns a pointer to the wide character, or a null pointer if c does not occur in the wide string.
7.33.4.6.6 The wcsspn function
Synopsis
Description
The wcsspn function computes the length of the maximum initial segment of the wide string pointed to by s1 which consists entirely of wide characters from the wide string pointed to by s2.
Returns
The wcsspn function returns the length of the segment.
7.33.4.6.7 The wcsstr generic function
Synopsis
Description
The wcsstr generic function locates the first occurrence in the wide string pointed to by s1 of the sequence of wide characters (excluding the terminating null wide character) in the wide string pointed to by s2.
Returns
The wcsstr generic function returns a pointer to the located wide string, or a null pointer if the wide string is not found. If s2 points to a wide string with zero length, the function returns s1.
7.33.4.6.8 The wcstok function
Synopsis
#include <wchar.h> wchar_t *wcstok(wchar_t * restrict s1, const wchar_t * restrict s2, wchar_t ** restrict ptr);
Description
A sequence of calls to the wcstok function breaks the wide string pointed to by s1 into a sequence of tokens, each of which is delimited by a wide character from the wide string pointed to by s2. The
The first call in a sequence has a non-null first argument and stores an initial value in the object pointed to by ptr. Subsequent calls in the sequence have a null first argument and the object pointed to by ptr is required to have the value stored by the previous call in the sequence, which is then updated. The separator wide string pointed to by s2 may be different from call to call.
The first call in the sequence searches the wide string pointed to by s1 for the first wide character that is not contained in the current separator wide string pointed to by s2. If no such wide character is found, then there are no tokens in the wide string pointed to by s1 and the wcstok function returns a null pointer. If such a wide character is found, it is the start of the first token.
The wcstok function then searches from there for a wide character that is contained in the current separator wide string. If no such wide character is found, the current token extends to the end of the wide string pointed to by s1, and subsequent searches in the same wide string for a token return a null pointer. If such a wide character is found, it is overwritten by a null wide character, which terminates the current token.
In all cases, the wcstok function stores sufficient information in the pointer pointed to by ptr so that subsequent calls, with a null pointer for s1 and the unmodified pointer value for ptr, shall start searching just past the element overwritten by a null wide character (if any).
Returns
The wcstok function returns a pointer to the first wide character of a token, or a null pointer if there is no token.
EXAMPLE
#include <wchar.h> static wchar_t str1[] = L"?a???b„,#c"; static wchar_t str2[] = L"\t \t"; wchar_t *t, *ptr1, *ptr2; t = wcstok(str1, L"?", &ptr1); // t points to the token L"a" t = wcstok(nullptr, L",", &ptr1); // t points to the token L"??b" t = wcstok(str2, L" \t", &ptr2); // t is a null pointer t = wcstok(nullptr, L"#,", &ptr1); // t points to the token L"c" t = wcstok(nullptr, L"?", &ptr1); // t is a null pointer
7.33.4.6.9 The wmemchr generic function
Synopsis
Description
The wmemchr generic function locates the first occurrence of c in the initial n wide characters of the object pointed to by s.
Returns
The wmemchr generic function returns a pointer to the located wide character, or a null pointer if the wide character does not occur in the object.
7.33.4.7 Miscellaneous functions
7.33.4.7.1 The wcslen function
Synopsis
Description
The wcslen function computes the length of the wide string pointed to by s.
Returns
The wcslen function returns the number of wide characters that precede the terminating null wide character.
7.33.4.7.2 The wcsnlen function
Synopsis
Description
The wcsnlen function counts not more than n wide characters (a null wide character and wide characters that follow it are not counted) in the array to which s points. At most the first n wide characters of s shall be accessed by wcsnlen. The implementation shall behave as if it reads the wide characters sequentially and stops as soon as a null wide character is found.
Returns
The wcsnlen function returns the number of wide characters that precede the terminating null wide character. If there is no null wide character in the first n wide characters of s then wcsnlen returns n.
7.33.4.7.3 The wmemset function
Synopsis
Description
The wmemset function copies the value of c into each of the first n wide characters of the object pointed to by s.
Returns
The wmemset function returns the value of s.
7.33.5 Wide character time conversion functions
7.33.5.1 The wcsftime function
Synopsis
#include <time.h> #include <wchar.h> size_t wcsftime(wchar_t * restrict s, size_t maxsize, const wchar_t * restrict format, const struct tm * restrict timeptr);
Description
The wcsftime function is equivalent to the strftime function, except that:
- The argument
spoints to the initial element of an array of wide characters into which the generated output is to be placed. - The argument
maxsizeindicates the limiting number of wide characters. - The argument
formatis a wide string and the conversion specifiers are replaced by corresponding sequences of wide characters. - The return value indicates the number of wide characters.
Returns
If the total number of resulting wide characters including the terminating null wide character is not more than maxsize, the wcsftime function returns the number of wide characters placed into the array pointed to by s not including the terminating null wide character. Otherwise, zero is returned and the members of the array have an indeterminate representation.
7.33.6 Extended multibyte/wide character conversion utilities
7.33.6.1 General
The header <wchar.h> declares an extended set of functions useful for conversion between multibyte characters and wide characters.
Most of the following functions — those that are listed as "restartable", 7.33.6.4 and 7.33.6.5 — take as a last argument a pointer to an object of type mbstate_t that is used to describe the current conversion state from a particular multibyte character sequence to a wide character sequence (or the reverse) under the rules of a particular setting for the LC_CTYPE category of the current locale.
The initial conversion state corresponds, for a conversion in either direction, to the beginning of a new multibyte character in the initial shift state. A zero-valued mbstate_t object is (at least) one way to describe an initial conversion state. A zero-valued mbstate_t object can be used to initiate conversion involving any multibyte character sequence, in any LC_CTYPE category setting. If an mbstate_t object has been altered by any of the functions described in this subclause, and is then used with a different multibyte character sequence, or in the other conversion direction, or with a different LC_CTYPE category setting than on earlier function calls, the behavior is undefined.424)
On entry, each function takes the described conversion state (either internal or pointed to by an argument) as current. The conversion state described by the referenced object is altered as needed to track the shift state, and the position within a multibyte character, for the associated multibyte character sequence.
7.33.6.2 Single-byte/wide character conversion functions
7.33.6.2.1 The btowc function
Synopsis
Description
The btowc function determines whether c constitutes a valid single-byte character in the initial shift state.
Returns
The btowc function returns WEOF if c has the value EOF or if (unsigned char)c does not constitute a valid single-byte character in the initial shift state. Otherwise, it returns the wide character representation of that character.
7.33.6.2.2 The wctob function
Synopsis
Description
The wctob function determines whether c corresponds to a member of the extended character set whose multibyte character representation is a single byte when in the initial shift state.
Returns
The wctob function returns EOF if c does not correspond to a multibyte character with length one in the initial shift state. Otherwise, it returns the single-byte representation of that character as an unsigned char converted to an int.
7.33.6.3 Conversion state functions
7.33.6.3.1 The mbsinit function
Synopsis
Description
If ps is not a null pointer, the mbsinit function determines whether the referenced mbstate_t object describes an initial conversion state.
Returns
The mbsinit function returns nonzero if ps is a null pointer or if the referenced object describes an initial conversion state; otherwise, it returns zero.
7.33.6.4 Restartable multibyte/wide character conversion functions
7.33.6.4.1 General
These functions differ from the corresponding multibyte character functions of 7.25.8 (mblen, mbtowc, and wctomb) in that they have an extra parameter, ps, of type pointer to mbstate_t that points to an object that can completely describe the current conversion state of the associated multibyte character sequence. If ps is a null pointer, each function uses its own internal mbstate_t object instead, which is initialized prior to the first call to the function to the initial conversion state; the functions are not required to avoid data races with other calls to the same function in this case. It is implementation-defined whether the internal mbstate_t object has thread storage duration; if it has thread storage duration, it is initialized to the initial conversion state prior to the first call to the function on the new thread. The implementation behaves as if no library function calls these functions with a null pointer for ps.
Also unlike their corresponding functions, the return value does not represent whether the encoding is state-dependent.
7.33.6.4.2 The mbrlen function
Synopsis
Description
The mbrlen function is equivalent to the call:
mbrtowc(nullptr, s, n, ps != nullptr ? ps: &internal)
where internal is the mbstate_t object for the mbrlen function, except that the expression designated by ps is evaluated only once.
Returns
The mbrlen function returns a value between zero and n, inclusive, (size_t)(-2), or (size_t)(1).
mbrtowc function (7.33.6.4.3).7.33.6.4.3 The mbrtowc function
Synopsis
#include <wchar.h> size_t mbrtowc(wchar_t * restrict pwc, const char * restrict s, size_t n, mbstate_t * restrict ps);
Description
If s is a null pointer, the mbrtowc function is equivalent to the call:
mbrtowc(nullptr, "", 1, ps)
In this case, the values of the parameters pwc and n are ignored.
If s is not a null pointer, the mbrtowc function inspects at most n bytes beginning with the byte pointed to by s to determine the number of bytes needed to complete the next multibyte character (including any shift sequences). If the function determines that the next multibyte character is complete and valid, it determines the value of the corresponding wide character and then, if pwc is not a null pointer, stores that value in the object pointed to by pwc. If the corresponding wide character is the null wide character, the resulting state described is the initial conversion state.
Returns
The mbrtowc function returns the first of the following that applies (given the current conversion state):
0 if the next n or fewer bytes complete the multibyte character that corresponds to the null wide character (which is the value stored).
between 1 and n inclusive if the next n or fewer bytes complete a valid multibyte character (which is the value stored); the value returned is the number of bytes that complete the multibyte character.
(size_t)(-2) if the next n bytes contribute to an incomplete (but potentially valid) multibyte character, and all n bytes have been processed (no value is stored).425)
(size_t)(-1) if an encoding error occurs, in which case the next n or fewer bytes do not contribute to a complete and valid multibyte character (no value is stored); the value of the macro EILSEQ is stored in errno, and the conversion state is unspecified.
7.33.6.4.4 The wcrtomb function
Synopsis
Description
If s is a null pointer, the wcrtomb function is equivalent to the call
wcrtomb(buf, L’\0’, ps)
where buf is an internal buffer.
If s is not a null pointer, the wcrtomb function determines the number of bytes needed to represent the multibyte character that corresponds to the wide character given by wc (including any shift sequences), and stores the multibyte character representation in the array whose first element is pointed to by s. At most MB_CUR_MAX bytes are stored. If wc is a null wide character, a null byte is
Returns
The wcrtomb function returns the number of bytes stored in the array object (including any shift sequences). When wc is not a valid wide character, an encoding error occurs: the function stores the value of the macro EILSEQ in errno and returns (size_t)(-1); the conversion state is unspecified.
7.33.6.5 Restartable multibyte/wide string conversion functions
7.33.6.5.1 General
These functions differ from the corresponding multibyte string functions of 7.25.9 (mbstowcs and wcstombs) in that they have an extra parameter, ps, of type pointer to mbstate_t that points to an object that can completely describe the current conversion state of the associated multibyte character sequence. If ps is a null pointer, each function uses its own internal mbstate_t object instead, which is initialized prior to the first call to the function to the initial conversion state; the functions are not required to avoid data races with other calls to the same function in this case. It is implementation-defined whether the internal mbstate_t object has thread storage duration; if it has thread storage duration, it is initialized to the initial conversion state prior to the first call to the function on the new thread. The implementation behaves as if no library function calls these functions with a null pointer for ps.
Also unlike their corresponding functions, the conversion source parameter, src, has a pointer-topointer type. When the function is storing the results of conversions (that is, when dst is not a null pointer), the pointer object pointed to by this parameter is updated to reflect the amount of the source processed by that invocation.
7.33.6.5.2 The mbsrtowcs function
Synopsis
#include <wchar.h> size_t mbsrtowcs(wchar_t * restrict dst, const char ** restrict src, size_t len, mbstate_t * restrict ps);
Description
The mbsrtowcs function converts a sequence of multibyte characters that begins in the conversion state described by the object pointed to by ps, from the array indirectly pointed to by src into a sequence of corresponding wide characters. If dst is not a null pointer, the converted characters are stored into the array pointed to by dst. Conversion continues up to and including a terminating null character, which is also stored. Conversion stops earlier in two cases: when a sequence of bytes is encountered that does not form a valid multibyte character, or (if dst is not a null pointer) when len wide characters have been stored into the array pointed to by dst.426) Each conversion takes place as if by a call to the mbrtowc function.
If dst is not a null pointer, the pointer object pointed to by src is assigned either a null pointer (if conversion stopped due to reaching a terminating null character) or the address just past the last multibyte character converted (if any). If conversion stopped due to reaching a terminating null character and if dst is not a null pointer, the resulting state described is the initial conversion state.
Returns
If the input conversion encounters a sequence of bytes that do not form a valid multibyte character, an encoding error occurs: the mbsrtowcs function stores the value of the macro EILSEQ in errno and returns (size_t)(-1); the conversion state is unspecified. Otherwise, it returns the number of multibyte characters successfully converted, not including the terminating null character (if any).
7.33.6.5.3 The wcsrtombs function
Synopsis
#include <wchar.h> size_t wcsrtombs(char * restrict dst, const wchar_t ** restrict src, size_t len, mbstate_t * restrict ps);
Description
The wcsrtombs function converts a sequence of wide characters from the array indirectly pointed to by src into a sequence of corresponding multibyte characters that begins in the conversion state described by the object pointed to by ps. If dst is not a null pointer, the converted characters are then stored into the array pointed to by dst. Conversion continues up to and including a terminating null wide character, which is also stored. Conversion stops earlier in two cases: when a wide character is reached that does not correspond to a valid multibyte character, or (if dst is not a null pointer) when the next multibyte character would exceed the limit of len total bytes to be stored into the array pointed to by dst. Each conversion takes place as if by a call to the wcrtomb function.427)
If dst is not a null pointer, the pointer object pointed to by src is assigned either a null pointer (if conversion stopped due to reaching a terminating null wide character) or the address just past the last wide character converted (if any). If conversion stopped due to reaching a terminating null wide character, the resulting state described is the initial conversion state.
Returns
If conversion stops because a wide character is reached that does not correspond to a valid multibyte character, an encoding error occurs: the wcsrtombs function stores the value of the macro EILSEQ in errno and returns (size_t)(-1); the conversion state is unspecified. Otherwise, it returns the number of bytes in the resulting multibyte character sequence, not including the terminating null character (if any).
7.34 Wide character classification and mapping utilities <wctype.h>
7.34.1 Introduction
The types declared are wint_t described in 7.33.1;
wctrans_twhich is a scalar type that can hold values which represent locale-specific character mappings; andwctype_twhich is a scalar type that can hold values which represent locale-specific character classifications.
The functions declared are grouped as follows:
- Functions that provide wide character classification;
- Extensible functions that provide wide character classification;
- Functions that provide wide character case mapping;
- Extensible functions that provide wide character mapping.
For all functions described in this subclause that accept an argument of type wint_t, the value shall be representable as a wchar_t or shall equal the value of the macro WEOF. If this argument has any other value, the behavior is undefined.
The behavior of these functions is affected by the LC_CTYPE category of the current locale.
7.34.2 Wide character classification utilities
7.34.2.1 General
The header <wctype.h> declares several functions useful for classifying wide characters.
The term printing wide character refers to a member of a locale-specific set of wide characters, each of which occupies at least one printing position on a display device. The term control wide character refers to a member of a locale-specific set of wide characters that are not printing wide characters.
7.34.2.2 Wide character classification functions
7.34.2.2.1 General
The functions in this subclause return nonzero (true) if and only if the value of the argument wc conforms to that in the description of the function.
Each of the following functions returns true for each wide character that corresponds (as if by a call to the wctob function) to a single-byte character for which the corresponding character classification function from 7.4.2 returns true, except that the iswgraph and iswpunct functions may differ with respect to wide characters other than L’ ’ that are both printing and white-space wide characters.429)
wctob function (7.33.6.2.2).7.34.2.2.2 The iswalnum function
Synopsis
Description
The iswalnum function tests for any wide character for which iswalpha or iswdigit is true.
7.34.2.2.3 The iswalpha function
Synopsis
Description
The iswalpha function tests for any wide character for which iswupper or iswlower is true, or any wide character that is one of a locale-specific set of alphabetic wide characters for which none of iswcntrl, iswdigit, iswpunct, or iswspace is true.430)
7.34.2.2.4 The iswblank function
Synopsis
Description
The iswblank function tests for any wide character that is a standard blank wide character or is one of a locale-specific set of wide characters for which iswspace is true and that is used to separate words within a line of text. The standard blank wide characters are the following: space (L’ ’), and horizontal tab (L’\t’). In the "C" locale, iswblank returns true only for the standard blank characters.
7.34.2.2.5 The iswcntrl function
Synopsis
Description
The iswcntrl function tests for any control wide character.
7.34.2.2.6 The iswdigit function
Synopsis
Description
The iswdigit function tests for any wide character that corresponds to a decimal-digit character (as defined in 5.3.1).
7.34.2.2.7 The iswgraph function
Synopsis
Description
The iswgraph function tests for any wide character for which iswprint is true and iswspace is false.431)
7.34.2.2.8 The iswlower function
Synopsis
Description
The iswlower function tests for any wide character that corresponds to a lowercase letter or is one of a locale-specific set of wide characters for which none of iswcntrl, iswdigit, iswpunct, or iswspace is true.
7.34.2.2.9 The iswprint function
Synopsis
Description
The iswprint function tests for any printing wide character.
7.34.2.2.10 The iswpunct function
Synopsis
Description
The iswpunct function tests for any printing wide character that is one of a locale-specific set of punctuation wide characters for which neither iswspace nor iswalnum is true.431)
7.34.2.2.11 The iswspace function
Synopsis
Description
The iswspace function tests for any wide character that corresponds to a locale-specific set of white-space wide characters for which none of iswalnum, iswgraph, or iswpunct is true.
7.34.2.2.12 The iswupper function
Synopsis
Description
The iswupper function tests for any wide character that corresponds to an uppercase letter or is one of a locale-specific set of wide characters for which none of iswcntrl, iswdigit, iswpunct, or iswspace is true.
7.34.2.2.13 The iswxdigit function
Synopsis
Description
The iswxdigit function tests for any wide character that corresponds to a hexadecimal-digit character (as defined in 6.4.5.2).
7.34.2.3 Extensible wide character classification functions
7.34.2.3.1 General
The functions wctype and iswctype provide extensible wide character classification as well as testing equivalent to that performed by the functions described in the previous subclause (7.34.2.2).
7.34.2.3.2 The iswctype function
Synopsis
Description
The iswctype function determines whether the wide character wc has the property described by desc. The current setting of the LC_CTYPE category shall be the same as during the call to wctype that returned the value desc.
Each of the following expressions has a truth-value equivalent to the call to the wide character classification function (7.34.2.2) in the comment that follows the expression:
iswctype(wc, wctype("alnum")) // iswalnum(wc) iswctype(wc, wctype("alpha")) // iswalpha(wc) iswctype(wc, wctype("blank")) // iswblank(wc) iswctype(wc, wctype("cntrl")) // iswcntrl(wc) iswctype(wc, wctype("digit")) // iswdigit(wc) iswctype(wc, wctype("graph")) // iswgraph(wc) iswctype(wc, wctype("lower")) // iswlower(wc) iswctype(wc, wctype("print")) // iswprint(wc) iswctype(wc, wctype("punct")) // iswpunct(wc) iswctype(wc, wctype("space")) // iswspace(wc) iswctype(wc, wctype("upper")) // iswupper(wc) iswctype(wc, wctype("xdigit")) // iswxdigit(wc)
Returns
The iswctype function returns nonzero (true) if and only if the value of the wide character wc has the property described by desc. If desc is zero, the iswctype function returns zero (false).
wctype function (7.34.2.3.3).7.34.2.3.3 The wctype function
Synopsis
Description
The wctype function constructs a value with type wctype_t that describes a class of wide characters identified by the string argument property.
The strings listed in the description of the iswctype function shall be valid in all locales as property arguments to the wctype function.
Returns
If property identifies a valid class of wide characters according to the LC_CTYPE category of the current locale, the wctype function returns a nonzero value that is valid as the second argument to the iswctype function; otherwise, it returns zero.
7.34.3 Wide character case mapping utilities
7.34.3.1 Wide character case mapping functions
7.34.3.1.1 The towlower function
Synopsis
Description
The towlower function converts an uppercase letter to a corresponding lowercase letter.
Returns
If the argument is a wide character for which iswupper is true and there are one or more corresponding wide characters, as specified by the current locale, for which iswlower is true, the towlower function returns one of the corresponding wide characters (always the same one for any given locale); otherwise, the argument is returned unchanged.
7.34.3.1.2 The towupper function
Synopsis
Description
The towupper function converts a lowercase letter to a corresponding uppercase letter.
Returns
If the argument is a wide character for which iswlower is true and there are one or more corresponding wide characters, as specified by the current locale, for which iswupper is true, the towupper function returns one of the corresponding wide characters (always the same one for any given locale); otherwise, the argument is returned unchanged.
7.34.3.2 Extensible wide character case mapping functions
7.34.3.2.1 General
The functions wctrans and towctrans provide extensible wide character mapping as well as case mapping equivalent to that performed by the functions described in the previous subclause (7.34.3.1).
7.34.3.2.2 The towctrans function
Synopsis
Description
The towctrans function maps the wide character wc using the mapping described by desc. The current setting of the LC_CTYPE category shall be the same as during the call to wctrans that returned the value desc.
Each of the following expressions behaves the same as the call to the wide character case mapping function (7.34.3.1) in the comment that follows the expression:
towctrans(wc, wctrans("tolower")) // towlower(wc) towctrans(wc, wctrans("toupper")) // towupper(wc)
Returns
The towctrans function returns the mapped value of wc using the mapping described by desc. If desc is zero, the towctrans function returns the value of wc.
7.34.3.2.3 The wctrans function
Synopsis
Description
The wctrans function constructs a value with type wctrans_t that describes a mapping between wide characters identified by the string argument property.
The strings listed in the description of the towctrans function shall be valid in all locales as property arguments to the wctrans function.
Returns
If property identifies a valid mapping of wide characters according to the LC_CTYPE category of the current locale, the wctrans function returns a nonzero value that is valid as the second argument to the towctrans function; otherwise, it returns zero.
7.35 Future library directions
7.35.1 General
Although grouped under individual headers, all the external names identified as reserved identifiers or potentially reserved identifiers in this subclause remain so regardless of which headers are included in the program.
7.35.2 Complex arithmetic <complex.h>
The function names
cacospi casinpi catanpi ccompoundn ccospi cerfc
cerf cexp10m1 cexp10 cexp2m1 cexp2 cexpm1
clgamma clog10p1 clog10 clog1p clog2p1 clog2
clogp1 cpown cpowr crootn crsqrt csinpi
ctanpi ctgamma
and the same names suffixed with f or l are potentially reserved identifiers and may be added to the declarations in the <complex.h> header.
7.35.3 Character handling <ctype.h>
Function names that begin with either is or to, and a lowercase letter are potentially reserved identifiers and may be added to the declarations in the <ctype.h> header.
7.35.4 Errors <errno.h>
Macros that begin with E and a digit or E and an uppercase letter may be added to the macros defined in the <errno.h> header by a future edition of this document or by an implementation.
7.35.5 Floating-point environment <fenv.h>
Macros that begin with FE_ and an uppercase letter may be added to the macros defined in the <fenv.h> header by a future edition of this document or by an implementation.
7.35.6 Characteristics of floating types <float.h>
Macros that begin with DBL_, DEC32_, DEC64_, DEC128_, DEC_, FLT_, or LDBL_ and an uppercase letter are potentially reserved identifiers and may be added to the macros defined in the <float.h> header.
Use of the DECIMAL_DIG macro is an obsolescent feature. A similar type-specific macro, such as LDBL_DECIMAL_DIG, can be used instead.
The use of FLT_HAS_SUBNORM, DBL_HAS_SUBNORM, and LDBL_HAS_SUBNORM macros is an obsolescent feature.
7.35.7 Format conversion of integer types <inttypes.h>
Macros that begin with either PRI or SCN, and either a lowercase letter, B, or X are potentially reserved identifiers and may be added to the macros defined in the <inttypes.h> header.
Function names that begin with str, or wcs and a lowercase letter are potentially reserved identifiers may be added to the declarations in the <inttypes.h> header.
7.35.8 Localization <locale.h>
Macros that begin with LC_ and an uppercase letter may be added to the macros defined in the <locale.h> header by a future edition of this document or by an implementation.
7.35.9 Mathematics <math.h>
Macros that begin with FP_ and an uppercase letter may be added to the macros defined in the <math.h> header by a future edition of this document or by an implementation.
Macros that begin with MATH_ and an uppercase letter are potentially reserved identifiers and may be added to the macros in the <math.h> header.
Function names that begin with is and a lowercase letter are potentially reserved identifiers and may be added to the declarations in the <math.h> header.
Function names that begin with cr_ are potentially reserved identifiers and may be added to the <math.h> header. The cr_ prefix is intended to indicate a correctly rounded version of the function.
Use of the macros INFINITY, DEC_INFINITY, NAN, and DEC_NAN in <math.h> is an obsolescent feature. Instead, use the same macros in <float.h>.
The optional occurrence of an overflow range error when the function result has integer type and the result is outside the range of the type is an obsolescent feature.
7.35.10 Signal handling <signal.h>
Macros that begin with either SIG and an uppercase letter or SIG_ and an uppercase letter may be added to the macros defined in the <signal.h> header by a future edition of this document or by an implementation.
7.35.11 Atomics <stdatomic.h>
Macros that begin with ATOMIC_ and an uppercase letter are potentially reserved identifiers and may be added to the macros defined in the <stdatomic.h> header. Typedef names that begin with either atomic_ or memory_, and a lowercase letter are potentially reserved identifiers and may be added to the declarations in the <stdatomic.h> header. Enumeration constants that begin with memory_order_ and a lowercase letter are potentially reserved identifiers and may be added to the definition of the memory_order type in the <stdatomic.h> header. Function names that begin with atomic_ and a lowercase letter are potentially reserved identifiers and may be added to the declarations in the <stdatomic.h> header.
7.35.12 Boolean type and values <stdbool.h>
The macro __bool_true_false_are_defined is an obsolescent feature.
7.35.13 Bit and byte utilities <stdbit.h>
Type and function names that begin with stdc_ are potentially reserved identifiers and may be added to the declarations in the <stdbit.h> header.
7.35.14 Checked Arithmetic Functions <stdckdint.h>
Type and function names that begin with ckd_ are potentially reserved identifiers and may be added to the declarations in the <stdckdint.h> header.
7.35.15 Integer types <stdint.h>
Typedef names beginning with int or uint and ending with _t are potentially reserved identifiers and may be added to the types defined in the <stdint.h> header. Macro names beginning with INT or UINT and ending with _MAX, _MIN, _WIDTH, or _C are potentially reserved identifiers and may be added to the macros defined in the <stdint.h> header.
7.35.16 Input/output <stdio.h>
Lowercase letters may be added to the conversion specifiers and length modifiers in fprintf and fscanf. Other characters may be used in extensions. The specifier B for printf may become mandatory in future versions of this document.
The use of ungetc on a binary stream where the file position indicator is zero prior to the call is an obsolescent feature.
7.35.17 General utilities <stdlib.h>
Function names that begin with str or wcs and a lowercase letter are potentially reserved identifiers and may be added to the declarations in the <stdlib.h> header.
Suppressing the macro definition of bsearch to access the actual function is an obsolescent feature.
7.35.18 String handling <string.h>
Function names that begin with str, mem, or wcs and a lowercase letter are potentially reserved identifiers and may be added to the declarations in the <string.h> header.
Suppressing the macro definitions of memchr, strchr, strpbrk, strrchr, or strstr to access the corresponding actual function is an obsolescent feature.
7.35.19 Date and time <time.h>
Macros beginning with TIME_ and an uppercase letter may be added to the macros in the <time.h> header by a future edition of this document or by an implementation.
The time bases TIME_MONOTONIC, TIME_ACTIVE and TIME_THREAD_ACTIVE may become mandatory in future versions of this standard.
7.35.20 Threads <threads.h>
Function names, type names, and enumeration constants that begin with either cnd_, mtx_, thrd_, or tss_, and a lowercase letter are potentially reserved identifiers and may be added to the declarations in the <threads.h> header.
7.35.21 Extended multibyte and wide character utilities <wchar.h>
Function names that begin with wcs and a lowercase letter are potentially reserved identifiers and may be added to the declarations in the <wchar.h> header.
Lowercase letters may be added to the conversion specifiers and length modifiers in fwprintf and fwscanf. Other characters may be used in extensions.
Suppressing the macro definitions of wcschr, wcspbrk, wcsrchr, wmemchr, or wcsstr to access the corresponding actual function is an obsolescent feature.
7.35.22 Wide character classification and mapping utilities <wctype.h>
Function names that begin with is or to and a lowercase letter are potentially reserved identifiers and may be added to the declarations in the <wctype.h> header.
A Language syntax summary
A.1 Notation
A.2 Lexical grammar
A.2.1 Lexical elements
- preprocessing-token:
- header-name
- identifier
- pp-number
- character-literal
- string-literal
- punctuator
- each universal character name that cannot be one of the above
- each non-white-space character that cannot be one of the above
A.2.2 Keywords
- keyword: one of
alignasalignofautoboolbreakcasecharconstconstexprcontinuedefaultdodoubleelseenumexternfalsefloatforgotoifinlineintlongnullptrregisterrestrictreturnshortsignedsizeofstaticstatic_assertstructswitchthread_localtruetypedeftypeoftypeof_unqualunionunsignedvoidvolatilewhile_Atomic_BitInt_Complex_Countof_Decimal128_Decimal32_Decimal64_Generic_Noreturn
A.2.3 Identifiers
- identifier:
- identifier-start
- identifier identifier-continue
- identifier-start:
- nondigit
- XID_Start character
- universal character name of class XID_Start
- nondigit: one of
_ a b c d e f g h i j k l mn o p q r s t u v w x y zA B C D E F G H I J K L MN O P Q R S T U V W X Y Z
- digit: one of
0 1 2 3 4 5 6 7 8 9
A.2.4 Universal character names
- universal-character-name:
\uhex-quad\Uhex-quad hex-quad\u{simple-hexadecimal-digit-sequence}\U{simple-hexadecimal-digit-sequence}
- simple-hexadecimal-digit-sequence:
- hexadecimal-digit
- simple-hexadecimal-digit-sequence hexadecimal-digit
A.2.5 Constants
- integer-literal:
- decimal-literal integer-suffixopt
- octal-literal integer-suffixopt
- hexadecimal-literal integer-suffixopt
- binary-literal integer-suffixopt
- decimal-literal:
- nonzero-digit
- decimal-literal
’opt digit
- hexadecimal-literal:
- hexadecimal-prefix hexadecimal-digit-sequence
- octal-literal:
- prefixed-octal-literal
- unprefixed-octal-literal
- unprefixed-octal-literal:
00 ’opt octal-digit-sequence
- prefixed-octal-literal:
- octal-prefix octal-digit-sequence
- binary-literal:
- binary-prefix binary-digit
- binary-literal
’opt binary-digit
- hexadecimal-prefix: one of
0x 0X
- octal-prefix: one of
0o 0O
- binary-prefix: one of
0b 0B
- nonzero-digit: one of
1 2 3 4 5 6 7 8 9
- hexadecimal-digit-sequence:
- hexadecimal-digit
- hexadecimal-digit-sequence
’opt hexadecimal-digit
- octal-digit-sequence:
- octal-digit
- octal-digit-sequence
’opt octal-digit
- hexadecimal-digit: one of
0 1 2 3 4 5 6 7 8 9a b c d e fA B C D E F
- octal-digit: one of
0 1 2 3 4 5 6 7
- binary-digit: one of
0 1
- integer-suffix:
- unsigned-suffix long-suffixopt
- unsigned-suffix long-long-suffix
- unsigned-suffix bit-precise-int-suffix
- long-suffix unsigned-suffixopt
- long-long-suffix unsigned-suffixopt
- bit-precise-int-suffix unsigned-suffixopt
- bit-precise-int-suffix: one of
wb WB
- unsigned-suffix: one of
u U
- long-suffix: one of
l L
- long-long-suffix: one of
ll LL
- floating-literal:
- decimal-floating-literal
- hexadecimal-floating-literal
- decimal-floating-literal:
- fractional-literal exponent-partopt floating-suffixopt
- digit-sequence exponent-part floating-suffixopt
- hexadecimal-floating-literal:
- hexadecimal-prefix hexadecimal-fractional-literal
- binary-exponent-part floating-suffixopt
- hexadecimal-prefix hexadecimal-digit-sequence
- binary-exponent-part floating-suffixopt
- fractional-literal:
- digit-sequenceopt
.digit-sequence - digit-sequence
.
- exponent-part:
esignopt digit-sequenceEsignopt digit-sequence
- sign: one of
+ -
- digit-sequence:
- digit
- digit-sequence
’opt digit
- hexadecimal-fractional-literal:
- hexadecimal-digit-sequenceopt
.hexadecimal-digit-sequence - hexadecimal-digit-sequence
.
- binary-exponent-part:
psignopt digit-sequencePsignopt digit-sequence
- real-floating-suffix: one of
f l F L df dd dl DF DD DL
- floating-suffix:
- real-floating-suffix complex-suffixopt
- complex-suffix real-floating-suffixopt
- complex-suffix: one of
i I j J
- enumeration-constant:
- identifier
- character-literal:
- encoding-prefixopt
’c-char-sequence’
- encoding-prefix: one of
u8 u U L
- c-char-sequence:
- c-char
- c-char-sequence c-char
- c-char:
- any member of the source character set except
- the single-quote
’, backslash\, or new-line character - escape-sequence
- escape-sequence:
- simple-escape-sequence
- octal-escape-sequence
- hexadecimal-escape-sequence
- universal-character-name
- simple-escape-sequence: one of
\‘ \" \? \\\a \b \f \n \r \t \v
- octal-escape-sequence:
\octal-digit\octal-digit octal-digit\octal-digit octal-digit octal-digit\o{simple-octal-digit-sequence}
- simple-octal-digit-sequence:
- octal-digit
- simple-octal-digit-sequence octal-digit
- hexadecimal-escape-sequence:
\xsimple-hexadecimal-digit-sequence\x{simple-hexadecimal-digit-sequence}
- predefined-constant:
falsetruenullptr
A.2.6 String literals
- string-literal:
- encoding-prefixopt
"s-char-sequenceopt"
- s-char-sequence:
- s-char
- s-char-sequence s-char
- s-char:
- any member of the source character set except
- the double-quote
", backslash\, or new-line character - escape-sequence
A.2.7 Punctuators
- punctuator: one of
[]( ){}.->++--&*+-~!/%<<>><><=>===!=^|&&||?:::;...=*=/=%=+=-=<<=>>=&=^=|=,###<::><%%>%:%:%:
A.2.8 Header names
- header-name:
<h-char-sequence>"q-char-sequence"
- h-char-sequence:
- h-char
- h-char-sequence h-char
- h-char:
- any member of the source character set except
- the new-line character and >
- q-char-sequence:
- q-char
- q-char-sequence q-char
- q-char:
- any member of the source character set except
- the new-line character and
"
A.2.9 Preprocessing numbers
A.3 Phrase structure grammar
A.3.1 Expressions
- primary-expression:
- identifier
- constant
- string-literal
(expression)- generic-selection
- generic-selection:
_Generic(generic-controlling-operand,generic-assoc-list)
- generic-controlling-operand:
- assignment-expression
- type-name
- generic-assoc-list:
- generic-association
- generic-assoc-list
,generic-association
- generic-association:
- type-name
:assignment-expression default :assignment-expression
- postfix-expression:
- primary-expression
- postfix-expression
[expression] - postfix-expression
(argument-expression-listopt) - postfix-expression
.identifier - postfix-expression
->identifier - postfix-expression
++ - postfix-expression
-- - compound-literal
- argument-expression-list:
- assignment-expression
- argument-expression-list
,assignment-expression
- compound-literal:
(storage-class-specifiersopt type-name)braced-initializer
- storage-class-specifiers:
- storage-class-specifier
- storage-class-specifiers storage-class-specifier
- unary-expression:
- postfix-expression
++unary-expression-unary-expression- unary-operator cast-expression
_Countofunary-expression_Countof (type-name)sizeofunary-expressionsizeof (type-name)alignof (type-name)
- unary-operator: one of
&*+-~!
- cast-expression:
- unary-expression
(type-name)cast-expression
- multiplicative-expression:
- cast-expression
- multiplicative-expression
*cast-expression - multiplicative-expression
/cast-expression - multiplicative-expression
%cast-expression
- additive-expression:
- multiplicative-expression
- additive-expression
+multiplicative-expression - additive-expression
-multiplicative-expression
- shift-expression:
- additive-expression
- shift-expression
<<additive-expression - shift-expression
>>additive-expression
- relational-expression:
- shift-expression
- relational-expression
<shift-expression - relational-expression
>shift-expression - relational-expression
<=shift-expression - relational-expression
>=shift-expression
- equality-expression:
- relational-expression
- equality-expression
==relational-expression - equality-expression
!=relational-expression
- AND-expression:
- equality-expression
- AND-expression
&equality-expression
- exclusive-OR-expression:
- AND-expression
- exclusive-OR-expression
^AND-expression
- inclusive-OR-expression:
- exclusive-OR-expression
- inclusive-OR-expression
|exclusive-OR-expression
- logical-AND-expression:
- inclusive-OR-expression
- logical-AND-expression
&&inclusive-OR-expression
- logical-OR-expression:
- logical-AND-expression
- logical-OR-expression
||logical-AND-expression
- conditional-expression:
- logical-OR-expression
- logical-OR-expression
?expression:conditional-expression
- assignment-expression:
- conditional-expression
- unary-expression assignment-operator assignment-expression
- assignment-operator: one of
=*=/=%=+=-=<<=>>=&=^=|=
- expression:
- assignment-expression
- expression
,assignment-expression
- constant-expression:
- conditional-expression
- constant-range-expression:
- constant-expression
...constant-expression
A.3.2 Declarations
- declaration:
- declaration-specifiers init-declarator-listopt
; - attribute-specifier-sequence declaration-specifiers init-declarator-list
; - static_assert-declaration
- attribute-declaration
- declaration-specifiers:
- declaration-specifier attribute-specifier-sequenceopt
- declaration-specifier declaration-specifiers
- declaration-specifier:
- storage-class-specifier
- type-specifier-qualifier
- function-specifier
- init-declarator-list:
- init-declarator
- init-declarator-list
,init-declarator
- init-declarator:
- declarator
- declarator
=initializer
- attribute-declaration:
- attribute-specifier-sequence
;
- simple-declaration:
- attribute-specifier-sequenceopt declaration-specifiers declarator
=initializer
- storage-class-specifier:
autoconstexprexternregisterstaticthread_localtypedef
- type-specifier:
voidcharshortintlongfloatdoublesignedunsigned_BitInt (constant-expression)bool_Complex_Decimal32_Decimal64_Decimal128- atomic-type-specifier
- struct-or-union-specifier
- enum-specifier
- typedef-name
- typeof-specifier
- struct-or-union-specifier:
- struct-or-union attribute-specifier-sequenceopt identifieropt
{member-declaration-list} - struct-or-union attribute-specifier-sequenceopt identifier
- struct-or-union:
structunion
- member-declaration-list:
- member-declaration
- member-declaration-list member-declaration
- member-declaration:
- attribute-specifier-sequenceopt specifier-qualifier-list member-declarator-listopt
; - static_assert-declaration
- specifier-qualifier-list:
- type-specifier-qualifier attribute-specifier-sequenceopt
- type-specifier-qualifier specifier-qualifier-list
- type-specifier-qualifier:
- type-specifier
- type-qualifier
- alignment-specifier
- member-declarator-list:
- member-declarator
- member-declarator-list
,member-declarator
- member-declarator:
- declarator
- declaratoropt
:constant-expression
- enum-specifier:
enumattribute-specifier-sequenceopt identifieropt enum-type-specifieropt{enumerator-list}enumattribute-specifier-sequenceopt identifieropt enum-type-specifieropt{enumerator-list, }enumidentifier enum-type-specifieropt
- enumerator-list:
- enumerator
- enumerator-list
,enumerator
- enumerator:
- enumeration-constant attribute-specifier-sequenceopt
- enumeration-constant attribute-specifier-sequenceopt
=constant-expression
- enum-type-specifier:
:specifier-qualifier-list
- atomic-type-specifier:
_Atomic(type-name)
- typeof-specifier:
typeof (typeof-specifier-argument)typeof_unqual (typeof-specifier-argument)
- typeof-specifier-argument:
- expression
- type-name
- type-qualifier:
constrestrictvolatile_Atomic
- function-specifier:
inline_Noreturn
- alignment-specifier:
alignas(type-name)alignas(constant-expression)
- declarator:
- pointeropt direct-declarator
- direct-declarator:
- identifier attribute-specifier-sequenceopt
(declarator)- array-declarator attribute-specifier-sequenceopt
- function-declarator attribute-specifier-sequenceopt
- array-declarator:
- direct-declarator
[type-qualifier-listopt assignment-expressionopt] - direct-declarator
[statictype-qualifier-listopt assignment-expression] - direct-declarator
[type-qualifier-liststaticassignment-expression] - direct-declarator
[type-qualifier-listopt*]
- function-declarator:
- direct-declarator
(parameter-type-listopt)
- pointer:
*attribute-specifier-sequenceopt type-qualifier-listopt*attribute-specifier-sequenceopt type-qualifier-listopt pointer
- type-qualifier-list:
- type-qualifier
- type-qualifier-list type-qualifier
- parameter-type-list:
- parameter-list
- parameter-list
, ... ...
- parameter-list:
- parameter-declaration
- parameter-list
,parameter-declaration
- parameter-declaration:
- attribute-specifier-sequenceopt declaration-specifiers declarator
- attribute-specifier-sequenceopt declaration-specifiers abstract-declaratoropt
- type-name:
- specifier-qualifier-list abstract-declaratoropt
- abstract-declarator:
- pointer
- pointeropt direct-abstract-declarator
- direct-abstract-declarator:
(abstract-declarator)- array-abstract-declarator attribute-specifier-sequenceopt
- function-abstract-declarator attribute-specifier-sequenceopt
- array-abstract-declarator:
- direct-abstract-declaratoropt
[type-qualifier-listopt assignment-expressionopt] - direct-abstract-declaratoropt
[ statictype-qualifier-listopt assignment-expression] - direct-abstract-declaratoropt
[type-qualifier-liststaticassignment-expression] - direct-abstract-declaratoropt
[ * ]
- function-abstract-declarator:
- direct-abstract-declaratoropt
(parameter-type-listopt)
- typedef-name:
- identifier
- braced-initializer:
{ }{initializer-list}{initializer-list, }
- initializer:
- assignment-expression
- braced-initializer
- initializer-list:
- designationopt initializer
- initializer-list
,designationopt initializer
- designation:
- designator-list
=
- designator-list:
- designator
- designator-list designator
- designator:
[constant-expression].identifier
- static_assert-declaration:
static_assert(constant-expression,string-literal) ;static_assert(constant-expression) ;
- attribute-specifier-sequence:
- attribute-specifier-sequenceopt attribute-specifier
- attribute-specifier:
[ [attribute-list] ]
- attribute-list:
- attributeopt
- attribute-list
,attributeopt
- attribute:
- attribute-token attribute-argument-clauseopt
- attribute-token:
- standard-attribute
- attribute-prefixed-token
- standard-attribute:
- identifier
- attribute-prefixed-token:
- attribute-prefix
::identifier
- attribute-prefix:
- identifier
- attribute-argument-clause:
(balanced-token-sequenceopt)
- balanced-token-sequence:
- balanced-token
- balanced-token-sequence balanced-token
- balanced-token:
(balanced-token-sequenceopt)[balanced-token-sequenceopt]{balanced-token-sequenceopt}- any token other than a parenthesis, a bracket, or a brace
A.3.3 Statements
- statement:
- labeled-statement
- unlabeled-statement
- unlabeled-statement:
- expression-statement
- attribute-specifier-sequenceopt primary-block
- attribute-specifier-sequenceopt jump-statement
- primary-block:
- compound-statement
- selection-statement
- iteration-statement
- secondary-block:
- statement
- label:
- attribute-specifier-sequenceopt identifier
: - attribute-specifier-sequenceopt
caseconstant-range-expression: - attribute-specifier-sequenceopt
caseconstant-expression: - attribute-specifier-sequenceopt
default :
- compound-statement:
{block-item-listopt}
- block-item-list:
- block-item
- block-item-list block-item
- block-item:
- declaration
- unlabeled-statement
- label
- expression-statement:
- expressionopt
; - attribute-specifier-sequence expression
;
- selection-statement:
if (selection-header)secondary-blockif (selection-header)secondary-blockelsesecondary-blockswitch (selection-header)secondary-block
- selection-header:
- expression
- declaration expression
- simple-declaration
- iteration-statement:
while (expression)secondary-blockdosecondary-blockwhile (expression) ;for (expressionopt;expressionopt;expressionopt)secondary-blockfor (declaration expressionopt;expressionopt)secondary-block
- jump-statement:
gotoidentifier;continueidentifieropt;breakidentifieropt;returnexpressionopt;
A.3.4 External definitions
- translation-unit:
- external-declaration
- translation-unit external-declaration
- external-declaration:
- function-definition
- declaration
- function-definition:
- attribute-specifier-sequenceopt declaration-specifiers declarator function-body
- function-body:
- compound-statement
A.4 Preprocessing directives
- preprocessing-file:
- groupopt
- group:
- group-part
- group group-part
- group-part:
- if-section
- control-line
- text-line
#non-directive
- if-section:
- if-group elif-groupsopt else-groupopt endif-line
- if-group:
# ifconstant-expression new-line groupopt# ifdefidentifier new-line groupopt# ifndefidentifier new-line groupopt
- elif-groups:
- elif-group
- elif-groups elif-group
- elif-group:
# elifconstant-expression new-line groupopt# elifdefidentifier new-line groupopt# elifndefidentifier new-line groupopt
- endif-line:
# endifnew-line
- control-line:
# includepp-tokens new-line# embedpp-tokens new-line# defineidentifier replacement-list new-line# defineidentifier lparen identifier-listopt)replacement-list new-line# defineidentifier lparen... )replacement-list new-line# defineidentifier lparen identifier-list, ... )replacement-list new-line# undefidentifier new-line# linepp-tokens new-line# errorpp-tokensopt new-line# warningpp-tokensopt new-line# pragmapp-tokensopt new-line#new-line
- lparen:
- a
(character not immediately preceded by white space
- replacement-list:
- pp-tokensopt
- new-line:
- the new-line character
- identifier-list:
- identifier
- identifier-list
,identifier
- pp-parameter:
- pp-parameter-name pp-parameter-clauseopt
- pp-parameter-name:
- pp-standard-parameter
- pp-prefixed-parameter
- pp-standard-parameter:
- identifier
- pp-prefixed-parameter:
- identifier
::identifier
- pp-parameter-clause:
(pp-balanced-token-sequenceopt)
- pp-balanced-token-sequence:
- pp-balanced-token
- pp-balanced-token-sequence pp-balanced-token
- pp-balanced-token:
(pp-balanced-token-sequenceopt)[pp-balanced-token-sequenceopt]{pp-balanced-token-sequenceopt}- any pp-token other than a parenthesis, a bracket, or a brace
- embed-parameter-sequence:
- pp-parameter
- embed-parameter-sequence pp-parameter
- defined-macro-expression:
definedidentifierdefined (identifier)
- h-preprocessing-token:
- any preprocessing-token other than
>
- header-name-tokens:
- string-literal
<h-pp-tokens>
- has-include-expression:
__has_include (header-name)__has_include (header-name-tokens)
- has-embed-expression:
__has_embed (header-name embed-parameter-sequenceopt)__has_embed (header-name-tokens pp-balanced-token-sequenceopt)
- has-c-attribute-express:
__has_c_attribute (pp-tokens)
- va-opt-replacement:
__VA_OPT__ (pp-tokensopt)
- standard-pragma:
# pragma STDC FP_CONTRACTon-off-switch# pragma STDC FENV_ACCESSon-off-switch# pragma STDC FENV_DEC_ROUNDdec-direction# pragma STDC FENV_ROUNDdirection# pragma STDC CX_LIMITED_RANGEon-off-switch
- on-off-switch: one of
ONOFFDEFAULT
- direction: one of
FE_DOWNWARDFE_TONEARESTFE_TONEARESTFROMZEROFE_TOWARDZEROFE_UPWARDFE_DYNAMIC
- dec-direction: one of
FE_DEC_DOWNWARDFE_DEC_TONEARESTFE_DEC_TONEARESTFROMZEROFE_DEC_TOWARDZEROFE_DEC_UPWARDFE_DEC_DYNAMIC
A.5 Floating-point subject sequence
A.5.1 NaN char sequence
- n-char-sequence:
- digit
- nondigit
- n-char-sequence digit
- n-char-sequence nondigit
A.5.2 NaN wchar_t sequence
- n-wchar-sequence:
- digit
- nondigit
- n-wchar-sequence digit
- n-wchar-sequence nondigit
A.6 Decimal floating-point subject sequence
A.6.1 NaN decimal char sequence
- d-char-sequence:
- digit
- nondigit
- d-char-sequence digit
- d-char-sequence nondigit
A.6.2 NaN decimal wchar_t sequence
- d-wchar-sequence:
- digit
- nondigit
- d-wchar-sequence digit
- d-wchar-sequence nondigit
B Library summary
B.1 Diagnostics <assert.h>
void assert(scalar expression);
B.2 Complex <complex.h>
- :
__STDC_VERSION_COMPLEX_H___Complex_II
#pragma STDC CX_LIMITED_RANGE on-off-switch double complex cacos(double complex z); float complex cacosf(float complex z); long double complex cacosl(long double complex z); double complex casin(double complex z); float complex casinf(float complex z); long double complex casinl(long double complex z); double complex catan(double complex z); float complex catanf(float complex z); long double complex catanl(long double complex z); double complex ccos(double complex z); float complex ccosf(float complex z); long double complex ccosl(long double complex z); double complex csin(double complex z); float complex csinf(float complex z); long double complex csinl(long double complex z); double complex ctan(double complex z); float complex ctanf(float complex z); long double complex ctanl(long double complex z); double complex cacosh(double complex z); float complex cacoshf(float complex z); long double complex cacoshl(long double complex z); double complex casinh(double complex z); float complex casinhf(float complex z); long double complex casinhl(long double complex z); double complex catanh(double complex z); float complex catanhf(float complex z); long double complex catanhl(long double complex z); double complex ccosh(double complex z); float complex ccoshf(float complex z); long double complex ccoshl(long double complex z); double complex csinh(double complex z); float complex csinhf(float complex z); long double complex csinhl(long double complex z); double complex ctanh(double complex z); float complex ctanhf(float complex z); long double complex ctanhl(long double complex z); double complex cexp(double complex z); float complex cexpf(float complex z); long double complex cexpl(long double complex z); double complex clog(double complex z); float complex clogf(float complex z); long double complex clogl(long double complex z); double cabs(double complex z); float cabsf(float complex z); long double cabsl(long double complex z); double complex cpow(double complex x, double complex y); float complex cpowf(float complex x, float complex y); long double complex cpowl(long double complex x, long double complex y); double complex csqrt(double complex z); float complex csqrtf(float complex z); long double complex csqrtl(long double complex z); double carg(double complex z); float cargf(float complex z); long double cargl(long double complex z); double cimag(double complex z); float cimagf(float complex z); long double cimagl(long double complex z); double complex CMPLX(double x, double y); float complex CMPLXF(float x, float y); long double complex CMPLXL(long double x, long double y); double complex conj(double complex z); float complex conjf(float complex z); long double complex conjl(long double complex z); double complex cproj(double complex z); float complex cprojf(float complex z); long double complex cprojl(long double complex z); double creal(double complex z); float crealf(float complex z); long double creall(long double complex z); _FloatN complex cacosfN(_FloatN complex z); _FloatNx complex cacosfNx(_FloatNx complex z); _FloatN complex casinfN(_FloatN complex z); _FloatNx complex casinfNx(_FloatNx complex z); _FloatN complex catanfN(_FloatN complex z); _FloatNx complex catanfNx(_FloatNx complex z); _FloatN complex ccosfN(_FloatN complex z); _FloatNx complex ccosfNx(_FloatNx complex z); _FloatN complex csinfN(_FloatN complex z); _FloatNx complex csinfNx(_FloatNx complex z); _FloatN complex ctanfN(_FloatN complex z); _FloatNx complex ctanfNx(_FloatNx complex z); _FloatN complex cacoshfN(_FloatN complex z); _FloatNx complex cacoshfNx(_FloatNx complex z); _FloatN complex casinhfN(_FloatN complex z); _FloatNx complex casinhfNx(_FloatNx complex z); _FloatN complex catanhfN(_FloatN complex z); _FloatNx complex catanhfNx(_FloatNx complex z); _FloatN complex ccoshfN(_FloatN complex z); _FloatNx complex ccoshfNx(_FloatNx complex z); _FloatN complex csinhfN(_FloatN complex z); _FloatNx complex csinhfNx(_FloatNx complex z); _FloatN complex ctanhfN(_FloatN complex z); _FloatNx complex ctanhfNx(_FloatNx complex z); _FloatN complex cexpfN(_FloatN complex z); _FloatNx complex cexpfNx(_FloatNx complex z); _FloatN complex clogfN(_FloatN complex z); _FloatNx complex clogfNx(_FloatNx complex z); _FloatN cabsfN(_FloatN complex z); _FloatNx cabsfNx(_FloatNx complex z); _FloatN complex cpowfN(_FloatN complex x, _FloatN complex y); _FloatNx complex cpowfNx(_FloatNx complex x, _FloatNx complex y); _FloatN complex csqrtfN(_FloatN complex z); _FloatNx complex csqrtfNx(_FloatNx complex z); _FloatN cargfN(_FloatN complex z); _FloatNx cargfNx(_FloatNx complex z); _FloatN cimagfN(_FloatN complex z); _FloatNx cimagfNx(_FloatNx complex z); _FloatN complex CMPLXFN(_FloatN x, _FloatN y); _FloatNx complex CMPLXFNX(_FloatNx x, _FloatNx y); _FloatN complex conjfN(_FloatN complex z); _FloatNx complex conjfNx(_FloatNx complex z); _FloatN complex cprojfN(_FloatN complex z); _FloatNx complex cprojfNx(_FloatNx complex z); _FloatN crealfN(_FloatN complex z); _FloatNx crealfNx(_FloatNx complex z);
B.3 Character handling <ctype.h>
int isalnum(int c); int isalpha(int c); int isblank(int c); int iscntrl(int c); int isdigit(int c); int isgraph(int c); int islower(int c); int isprint(int c); int ispunct(int c); int isspace(int c); int isupper(int c); int isxdigit(int c); int tolower(int c); int toupper(int c);
B.4 Errors <errno.h>
B.5 Floating-point environment <fenv.h>
- :
FE_DIVBYZEROFE_INEXACTFE_INVALIDFE_OVERFLOWFE_UNDERFLOWFE_ALL_EXCEPTFE_DOWNWARDFE_TONEARESTFE_TONEARESTFROMZEROFE_TOWARDZEROFE_UPWARDFE_DFL_ENV
#pragma STDC FENV_ACCESS on-off-switch #pragma STDC FENV_ROUND direction #pragma STDC FENV_ROUND FE_DYNAMIC int feclearexcept(int excepts); int fegetexceptflag(fexcept_t *flagp, int excepts); int feraiseexcept(int excepts); int fesetexcept(int excepts); int fesetexceptflag(const fexcept_t *flagp, int excepts); int fetestexceptflag(const fexcept_t *flagp, int excepts); int fetestexcept(int excepts); int fegetmode(femode_t *modep); int fegetround(void); int fesetmode(const femode_t *modep); int fesetround(int rnd); int fegetenv(fenv_t *envp); int feholdexcept(fenv_t *envp); int fesetenv(const fenv_t *envp); int feupdateenv(const fenv_t *envp);
- :
FE_DEC_TONEARESTFROMZEROFE_DEC_TOWARDZEROFE_DEC_UPWARD
#pragma STDC FENV_DEC_ROUND dec-direction int fe_dec_getround(void); int fe_dec_setround(int rnd);
B.6 Characteristics of floating types <float.h>
B.6.1 Macros
- :
FLT_IS_IEC_60559DBL_IS_IEC_60559LDBL_IS_IEC_60559FLT_DIGDBL_DIGLDBL_DIGFLT_MIN_EXPDBL_MIN_EXPLDBL_MIN_EXPFLT_MIN_10_EXPDBL_MIN_10_EXPLDBL_MIN_10_EXPFLT_MAX_EXPDBL_MAX_EXPLDBL_MAX_EXPFLT_MAX_10_EXPDBL_MAX_10_EXPLDBL_MAX_10_EXPFLT_MAXDBL_MAXLDBL_MAXFLT_NORM_MAXDBL_NORM_MAXLDBL_NORM_MAXFLT_EPSILONDBL_EPSILONLDBL_EPSILONFLT_MINDBL_MINLDBL_MINFLT_SNANDBL_SNANLDBL_SNANFLT_TRUE_MINDBL_TRUE_MINLDBL_TRUE_MININFINITYNAN
B.6.2 Characteristics of decimal floating types
The following macros are provided only if the implementation defines __STDC_IEC_60559_DFP__. is , and .
DEC_EVAL_METHOD DEC_INFINITY DEC_NAN
DECN_EPSILON DECN_MANT_DIG DECN_MAX_EXP
DECN_MAX DECN_MIN_EXP DECN_MIN
DECN_TRUE_MIN DECN_SNAN
B.6.3 Characteristics of ISO/IEC 60559 interchange and extended types
- :
FLTN_SNANFLTN_TRUE_MINFLTNX_DECIMAL_DIGFLTNX_DIGFLTNX_EPSILONFLTNX_MANT_DIGFLTNX_MAX_10_EXPFLTNX_MAX_EXPFLTNX_MAXFLTNX_MIN_10_EXPFLTNX_MIN_EXPFLTNX_MINFLTNX_SNANFLTNX_TRUE_MINDECN_EPSILONDECN_MANT_DIGDECN_MAX_EXPDECN_MAXDECN_MIN_EXPDECN_MINDECN_SNANDECN_TRUE_MINDECNX_EPSILONDECNX_MANT_DIGDECNX_MAX_EXPDECNX_MAXDECNX_MIN_EXPDECNX_MINDECNX_SNANDECNX_TRUE_MIN
B.7 Format conversion of integer types <inttypes.h>
intmax_t imaxabs(intmax_t j); uintmax_t umaxabs(intmax_t j); imaxdiv_t imaxdiv(intmax_t numer, intmax_t denom); intmax_t strtoimax(const char * restrict nptr, char ** restrict endptr, int base); uintmax_t strtoumax(const char * restrict nptr, char ** restrict endptr, int base); intmax_t wcstoimax(const wchar_t *restrict nptr, wchar_t **restrict endptr, int base); uintmax_t wcstoumax(const wchar_t *restrict nptr, wchar_t **restrict endptr, int base);
B.8 Alternative spellings <iso646.h>
- :
bitandbitorcomplnotnot_eqoror_eqxorxor_eq
B.9 Characteristics of integer types <limits.h>
- :
UINT_WIDTHLONG_WIDTHULONG_WIDTHLLONG_WIDTHULLONG_WIDTHBOOL_MAXSCHAR_MINSCHAR_MAXUCHAR_MAXCHAR_MINCHAR_MAXMB_LEN_MAXSHRT_MINSHRT_MAXUSHRT_MAXINT_MININT_MAXUINT_MAXLONG_MINLONG_MAXULONG_MAXLLONG_MINLLONG_MAXULLONG_MAX
B.10 Localization <locale.h>
- :
LC_ALLLC_COLLATELC_CTYPELC_MONETARYLC_NUMERICLC_TIME
char *setlocale(int category, const char *locale); struct lconv *localeconv(void);
B.11 Mathematics <math.h>
- :
FP_INT_TONEARESTFROMZEROFP_INT_TONEARESTFP_FAST_FMAFP_FAST_FMAFFP_FAST_FMALFP_FAST_FADDFP_FAST_FADDLFP_FAST_DADDLFP_FAST_FSUBFP_FAST_FSUBLFP_FAST_DSUBLFP_FAST_FMULFP_FAST_FMULLFP_FAST_DMULLFP_FAST_FDIVFP_FAST_FDIVLFP_FAST_DDIVLFP_FAST_FSQRTFP_FAST_FSQRTLFP_FAST_DSQRTLFP_FAST_FFMAFP_FAST_FFMALFP_FAST_DFMALFP_ILOGB0FP_ILOGBNANFP_LLOGB0FP_LLOGBNANMATH_ERRNOMATH_ERREXCEPTmath_errhandling
#pragma STDC FP_CONTRACT on-off-switch int fpclassify(real-floatingx); int iscanonical(real-floatingx); int isfinite(real-floatingx); int isinf(real-floatingx); int isnan(real-floatingx); int isnormal(real-floatingx); int signbit(real-floatingx); int issignaling(real-floatingx); int issubnormal(real-floatingx); int iszero(real-floatingx); double acos(double x); float acosf(float x); long double acosl(long double x); double asin(double x); float asinf(float x); long double asinl(long double x); double atan(double x); float atanf(float x); long double atanl(long double x); double atan2(double y, double x); float atan2f(float y, float x); long double atan2l(long double y, long double x); double cos(double x); float cosf(float x); long double cosl(long double x); double sin(double x); float sinf(float x); long double sinl(long double x); double tan(double x); float tanf(float x); long double tanl(long double x); double acospi(double x); float acospif(float x); long double acospil(long double x); double asinpi(double x); float asinpif(float x); long double asinpil(long double x); double atanpi(double x); float atanpif(float x); long double atanpil(long double x); double atan2pi(double y, double x); float atan2pif(float y, float x); long double atan2pil(long double y, long double x); double cospi(double x); float cospif(float x); long double cospil(long double x); double sinpi(double x); float sinpif(float x); long double sinpil(long double x); double tanpi(double x); float tanpif(float x); long double tanpil(long double x); double acosh(double x); float acoshf(float x); long double acoshl(long double x); double asinh(double x); float asinhf(float x); long double asinhl(long double x); double atanh(double x); float atanhf(float x); long double atanhl(long double x); double cosh(double x); float coshf(float x); long double coshl(long double x); double sinh(double x); float sinhf(float x); long double sinhl(long double x); double tanh(double x); float tanhf(float x); long double tanhl(long double x); double exp(double x); float expf(float x); long double expl(long double x); double exp10(double x); float exp10f(float x); long double exp10l(long double x); double exp10m1(double x); float exp10m1f(float x); long double exp10m1l(long double x); double exp2(double x); float exp2f(float x); long double exp2l(long double x); double exp2m1(double x); float exp2m1f(float x); long double exp2m1l(long double x); double expm1(double x); float expm1f(float x); long double expm1l(long double x); double frexp(double value, int *p); float frexpf(float value, int *p); long double frexpl(long double value, int *p); int ilogb(double x); int ilogbf(float x); int ilogbl(long double x); double ldexp(double x, int p); float ldexpf(float x, int p); long double ldexpl(long double x, int p); long int llogb(double x); long int llogbf(float x); long int llogbl(long double x); double log(double x); float logf(float x); long double logl(long double x); double log10(double x); float log10f(float x); long double log10l(long double x); double log10p1(double x); float log10p1f(float x); long double log10p1l(long double x); double log1p(double x); float log1pf(float x); long double log1pl(long double x); double logp1(double x); float logp1f(float x); long double logp1l(long double x); double log2(double x); float log2f(float x); long double log2l(long double x); double log2p1(double x); float log2p1f(float x); long double log2p1l(long double x); double logb(double x); float logbf(float x); long double logbl(long double x); double modf(double value, double *iptr); float modff(float value, float *iptr); long double modfl(long double value, long double *iptr); double scalbn(double x, int n); float scalbnf(float x, int n); long double scalbnl(long double x, int n); double scalbln(double x, long int n); float scalblnf(float x, long int n); long double scalblnl(long double x, long int n); double cbrt(double x); float cbrtf(float x); long double cbrtl(long double x); double compoundn(double x, long long int n); float compoundnf(float x, long long int n); long double compoundnl(long double x, long long int n); double fabs(double x); float fabsf(float x); long double fabsl(long double x); double hypot(double x, double y); float hypotf(float x, float y); long double hypotl(long double x, long double y); double pow(double x, double y); float powf(float x, float y); long double powl(long double x, long double y); double pown(double x, long long int n); float pownf(float x, long long int n); long double pownl(long double x, long long int n); double powr(double y, double x); float powrf(float y, float x); long double powrl(long double y, long double x); double rootn(double x, long long int n); float rootnf(float x, long long int n); long double rootnl(long double x, long long int n); double rsqrt(double x); float rsqrtf(float x); long double rsqrtl(long double x); double sqrt(double x); float sqrtf(float x); long double sqrtl(long double x); double erf(double x); float erff(float x); long double erfl(long double x); double erfc(double x); float erfcf(float x); long double erfcl(long double x); double lgamma(double x); float lgammaf(float x); long double lgammal(long double x); double tgamma(double x); float tgammaf(float x); long double tgammal(long double x); double ceil(double x); float ceilf(float x); long double ceill(long double x); double floor(double x); float floorf(float x); long double floorl(long double x); double nearbyint(double x); float nearbyintf(float x); long double nearbyintl(long double x); double rint(double x); float rintf(float x); long double rintl(long double x); long int lrint(double x); long int lrintf(float x); long int lrintl(long double x); long long int llrint(double x); long long int llrintf(float x); long long int llrintl(long double x); double round(double x); float roundf(float x); long double roundl(long double x); long int lround(double x); long int lroundf(float x); long int lroundl(long double x); long long int llround(double x); long long int llroundf(float x); long long int llroundl(long double x); double roundeven(double x); float roundevenf(float x); long double roundevenl(long double x); double trunc(double x); float truncf(float x); long double truncl(long double x); double fromfp(double x, int rnd, unsigned int width); float fromfpf(float x, int rnd, unsigned int width); long double fromfpl(long double x, int rnd, unsigned int width); double ufromfp(double x, int rnd, unsigned int width); float ufromfpf(float x, int rnd, unsigned int width); long double ufromfpl(long double x, int rnd, unsigned int width); double fromfpx(double x, int rnd, unsigned int width); float fromfpxf(float x, int rnd, unsigned int width); long double fromfpxl(long double x, int rnd, unsigned int width); double ufromfpx(double x, int rnd, unsigned int width); float ufromfpxf(float x, int rnd, unsigned int width); long double ufromfpxl(long double x, int rnd, unsigned int width); double fmod(double x, double y); float fmodf(float x, float y); long double fmodl(long double x, long double y); double remainder(double x, double y); float remainderf(float x, float y); long double remainderl(long double x, long double y); double remquo(double x, double y, int *quo); float remquof(float x, float y, int *quo); long double remquol(long double x, long double y, int *quo); double copysign(double x, double y); float copysignf(float x, float y); long double copysignl(long double x, long double y); double nan(const char *tagp); float nanf(const char *tagp); long double nanl(const char *tagp); double nextafter(double x, double y); float nextafterf(float x, float y); long double nextafterl(long double x, long double y); double nexttoward(double x, long double y); float nexttowardf(float x, long double y); long double nexttowardl(long double x, long double y); double nextup(double x); float nextupf(float x); long double nextupl(long double x); double nextdown(double x); float nextdownf(float x); long double nextdownl(long double x); int canonicalize(double *cx, const double *x); int canonicalizef(float *cx, const float *x); int canonicalizel(long double *cx, const long double *x); double fdim(double x, double y); float fdimf(float x, float y); long double fdiml(long double x, long double y); double fmax(double x, double y); float fmaxf(float x, float y); long double fmaxl(long double x, long double y); double fmin(double x, double y); float fminf(float x, float y); long double fminl(long double x, long double y); double fmaximum(double x, double y); float fmaximumf(float x, float y); long double fmaximuml(long double x, long double y); double fminimum(double x, double y); float fminimumf(float x, float y); long double fminimuml(long double x, long double y); double fmaximum_mag(double x, double y); float fmaximum_magf(float x, float y); long double fmaximum_magl(long double x, long double y); double fminimum_mag(double x, double y); float fminimum_magf(float x, float y); long double fminimum_magl(long double x, long double y); double fmaximum_num(double x, double y); float fmaximum_numf(float x, float y); long double fmaximum_numl(long double x, long double y); double fminimum_num(double x, double y); float fminimum_numf(float x, float y); long double fminimum_numl(long double x, long double y); double fmaximum_mag_num(double x, double y); float fmaximum_mag_numf(float x, float y); long double fmaximum_mag_numl(long double x, long double y); double fminimum_mag_num(double x, double y); float fminimum_mag_numf(float x, float y); long double fminimum_mag_numl(long double x, long double y); double fma(double x, double y, double z); float fmaf(float x, float y, float z); long double fmal(long double x, long double y, long double z); float fadd(double x, double y); float faddl(long double x, long double y); double daddl(long double x, long double y); float fsub(double x, double y); float fsubl(long double x, long double y); double dsubl(long double x, long double y); float fmul(double x, double y); float fmull(long double x, long double y); double dmull(long double x, long double y); float fdiv(double x, double y); float fdivl(long double x, long double y); double ddivl(long double x, long double y); float ffma(double x, double y, double z); float ffmal(long double x, long double y, long double z); double dfmal(long double x, long double y, long double z); float fsqrt(double x); float fsqrtl(long double x); double dsqrtl(long double x); int isgreater(real-floatingx, real-floatingy); int isgreaterequal(real-floatingx, real-floatingy); int isless(real-floatingx, real-floatingy); int islessequal(real-floatingx, real-floatingy); int islessgreater(real-floatingx, real-floatingy); int isunordered(real-floatingx, real-floatingy); int iseqsig(real-floatingx, real-floatingy);
- :
FP_FAST_D32SUBD64FP_FAST_D32SUBD128FP_FAST_D64SUBD128FP_FAST_D32MULD64FP_FAST_D32MULD128FP_FAST_D64MULD128FP_FAST_D32DIVD64FP_FAST_D32DIVD128FP_FAST_D64DIVD128FP_FAST_D32FMAD64FP_FAST_D32FMAD128FP_FAST_D64FMAD128FP_FAST_D32SQRTD64FP_FAST_D32SQRTD128FP_FAST_D64SQRTD128HUGE_VAL_D32HUGE_VAL_D64HUGE_VAL_D128
_Decimal32 acosd32(_Decimal32 x); _Decimal64 acosd64(_Decimal64 x); _Decimal128 acosd128(_Decimal128 x); _Decimal32 asind32(_Decimal32 x); _Decimal64 asind64(_Decimal64 x); _Decimal128 asind128(_Decimal128 x); _Decimal32 atand32(_Decimal32 x); _Decimal64 atand64(_Decimal64 x); _Decimal128 atand128(_Decimal128 x); _Decimal32 atan2d32(_Decimal32 y, _Decimal32 x); _Decimal64 atan2d64(_Decimal64 y, _Decimal64 x); _Decimal128 atan2d128(_Decimal128 y, _Decimal128 x); _Decimal32 cosd32(_Decimal32 x); _Decimal64 cosd64(_Decimal64 x); _Decimal128 cosd128(_Decimal128 x); _Decimal32 sind32(_Decimal32 x); _Decimal64 sind64(_Decimal64 x); _Decimal128 sind128(_Decimal128 x); _Decimal32 tand32(_Decimal32 x); _Decimal64 tand64(_Decimal64 x); _Decimal128 tand128(_Decimal128 x); _Decimal32 acospid32(_Decimal32 x); _Decimal64 acospid64(_Decimal64 x); _Decimal128 acospid128(_Decimal128 x); _Decimal32 asinpid32(_Decimal32 x); _Decimal64 asinpid64(_Decimal64 x); _Decimal128 asinpid128(_Decimal128 x); _Decimal32 atanpid32(_Decimal32 x); _Decimal64 atanpid64(_Decimal64 x); _Decimal128 atanpid128(_Decimal128 x); _Decimal32 atan2pid32(_Decimal32 y, _Decimal32 x); _Decimal64 atan2pid64(_Decimal64 y, _Decimal64 x); _Decimal128 atan2pid128(_Decimal128 y, _Decimal128 x); _Decimal32 cospid32(_Decimal32 x); _Decimal64 cospid64(_Decimal64 x); _Decimal128 cospid128(_Decimal128 x); _Decimal32 sinpid32(_Decimal32 x); _Decimal64 sinpid64(_Decimal64 x); _Decimal128 sinpid128(_Decimal128 x); _Decimal32 tanpid32(_Decimal32 x); _Decimal64 tanpid64(_Decimal64 x); _Decimal128 tanpid128(_Decimal128 x); _Decimal32 acoshd32(_Decimal32 x); _Decimal64 acoshd64(_Decimal64 x); _Decimal128 acoshd128(_Decimal128 x); _Decimal32 asinhd32(_Decimal32 x); _Decimal64 asinhd64(_Decimal64 x); _Decimal128 asinhd128(_Decimal128 x); _Decimal32 atanhd32(_Decimal32 x); _Decimal64 atanhd64(_Decimal64 x); _Decimal128 atanhd128(_Decimal128 x); _Decimal32 coshd32(_Decimal32 x); _Decimal64 coshd64(_Decimal64 x); _Decimal128 coshd128(_Decimal128 x); _Decimal32 sinhd32(_Decimal32 x); _Decimal64 sinhd64(_Decimal64 x); _Decimal128 sinhd128(_Decimal128 x); _Decimal32 tanhd32(_Decimal32 x); _Decimal64 tanhd64(_Decimal64 x); _Decimal128 tanhd128(_Decimal128 x); _Decimal32 expd32(_Decimal32 x); _Decimal64 expd64(_Decimal64 x); _Decimal128 expd128(_Decimal128 x); _Decimal32 exp10d32(_Decimal32 x); _Decimal64 exp10d64(_Decimal64 x); _Decimal128 exp10d128(_Decimal128 x); _Decimal32 exp10m1d32(_Decimal32 x); _Decimal64 exp10m1d64(_Decimal64 x); _Decimal128 exp10m1d128(_Decimal128 x); _Decimal32 exp2d32(_Decimal32 x); _Decimal64 exp2d64(_Decimal64 x); _Decimal128 exp2d128(_Decimal128 x); _Decimal32 exp2m1d32(_Decimal32 x); _Decimal64 exp2m1d64(_Decimal64 x); _Decimal128 exp2m1d128(_Decimal128 x); _Decimal32 expm1d32(_Decimal32 x); _Decimal64 expm1d64(_Decimal64 x); _Decimal128 expm1d128(_Decimal128 x); _Decimal32 frexpd32(_Decimal32 value, int *p); _Decimal64 frexpd64(_Decimal64 value, int *p); _Decimal128 frexpd128(_Decimal128 value, int *p); int ilogbd32(_Decimal32 x); int ilogbd64(_Decimal64 x); int ilogbd128(_Decimal128 x); _Decimal32 ldexpd32(_Decimal32 x, int p); _Decimal64 ldexpd64(_Decimal64 x, int p); _Decimal128 ldexpd128(_Decimal128 x, int p); long int llogbd32(_Decimal32 x); long int llogbd64(_Decimal64 x); long int llogbd128(_Decimal128 x); _Decimal32 logd32(_Decimal32 x); _Decimal64 logd64(_Decimal64 x); _Decimal128 logd128(_Decimal128 x); _Decimal32 log10d32(_Decimal32 x); _Decimal64 log10d64(_Decimal64 x); _Decimal128 log10d128(_Decimal128 x); _Decimal32 log10p1d32(_Decimal32 x); _Decimal64 log10p1d64(_Decimal64 x); _Decimal128 log10p1d128(_Decimal128 x); _Decimal32 log1pd32(_Decimal32 x); _Decimal64 log1pd64(_Decimal64 x); _Decimal128 log1pd128(_Decimal128 x); _Decimal32 logp1d32(_Decimal32 x); _Decimal64 logp1d64(_Decimal64 x); _Decimal128 logp1d128(_Decimal128 x); _Decimal32 log2d32(_Decimal32 x); _Decimal64 log2d64(_Decimal64 x); _Decimal128 log2d128(_Decimal128 x); _Decimal32 log2p1d32(_Decimal32 x); _Decimal64 log2p1d64(_Decimal64 x); _Decimal128 log2p1d128(_Decimal128 x); _Decimal32 logbd32(_Decimal32 x); _Decimal64 logbd64(_Decimal64 x); _Decimal128 logbd128(_Decimal128 x); _Decimal32 modfd32(_Decimal32 x, _Decimal32 *iptr); _Decimal64 modfd64(_Decimal64 x, _Decimal64 *iptr); _Decimal128 modfd128(_Decimal128 x, _Decimal128 *iptr); _Decimal32 scalbnd32(_Decimal32 x, int n); _Decimal64 scalbnd64(_Decimal64 x, int n); _Decimal128 scalbnd128(_Decimal128 x, int n); _Decimal32 scalblnd32(_Decimal32 x, long int n); _Decimal64 scalblnd64(_Decimal64 x, long int n); _Decimal128 scalblnd128(_Decimal128 x, long int n); _Decimal32 cbrtd32(_Decimal32 x); _Decimal64 cbrtd64(_Decimal64 x); _Decimal128 cbrtd128(_Decimal128 x); _Decimal32 compoundnd32(_Decimal32 x, long long int n); _Decimal64 compoundnd64(_Decimal64 x, long long int n); _Decimal128 compoundnd128(_Decimal128 x, long long int n); _Decimal32 fabsd32(_Decimal32 x); _Decimal64 fabsd64(_Decimal64 x); _Decimal128 fabsd128(_Decimal128 x); _Decimal32 hypotd32(_Decimal32 x, _Decimal32 y); _Decimal64 hypotd64(_Decimal64 x, _Decimal64 y); _Decimal128 hypotd128(_Decimal128 x, _Decimal128 y); _Decimal32 powd32(_Decimal32 x, _Decimal32 y); _Decimal64 powd64(_Decimal64 x, _Decimal64 y); _Decimal128 powd128(_Decimal128 x, _Decimal128 y); _Decimal32 pownd32(_Decimal32 x, long long int n); _Decimal64 pownd64(_Decimal64 x, long long int n); _Decimal128 pownd128(_Decimal128 x, long long int n); _Decimal32 powrd32(_Decimal32 y, _Decimal32 x); _Decimal64 powrd64(_Decimal64 y, _Decimal64 x); _Decimal128 powrd128(_Decimal128 y, _Decimal128 x); _Decimal32 rootnd32(_Decimal32 x, long long int n); _Decimal64 rootnd64(_Decimal64 x, long long int n); _Decimal128 rootnd128(_Decimal128 x, long long int n); _Decimal32 rsqrtd32(_Decimal32 x); _Decimal64 rsqrtd64(_Decimal64 x); _Decimal128 rsqrtd128(_Decimal128 x); _Decimal32 sqrtd32(_Decimal32 x); _Decimal64 sqrtd64(_Decimal64 x); _Decimal128 sqrtd128(_Decimal128 x); _Decimal32 erfd32(_Decimal32 x); _Decimal64 erfd64(_Decimal64 x); _Decimal128 erfd128(_Decimal128 x); _Decimal32 erfcd32(_Decimal32 x); _Decimal64 erfcd64(_Decimal64 x); _Decimal128 erfcd128(_Decimal128 x); _Decimal32 lgammad32(_Decimal32 x); _Decimal64 lgammad64(_Decimal64 x); _Decimal128 lgammad128(_Decimal128 x); _Decimal32 tgammad32(_Decimal32 x); _Decimal64 tgammad64(_Decimal64 x); _Decimal128 tgammad128(_Decimal128 x); _Decimal32 ceild32(_Decimal32 x); _Decimal64 ceild64(_Decimal64 x); _Decimal128 ceild128(_Decimal128 x); _Decimal32 floord32(_Decimal32 x); _Decimal64 floord64(_Decimal64 x); _Decimal128 floord128(_Decimal128 x); _Decimal32 nearbyintd32(_Decimal32 x); _Decimal64 nearbyintd64(_Decimal64 x); _Decimal128 nearbyintd128(_Decimal128 x); _Decimal32 rintd32(_Decimal32 x); _Decimal64 rintd64(_Decimal64 x); _Decimal128 rintd128(_Decimal128 x); long int lrintd32(_Decimal32 x); long int lrintd64(_Decimal64 x); long int lrintd128(_Decimal128 x); long long int llrintd32(_Decimal32 x); long long int llrintd64(_Decimal64 x); long long int llrintd128(_Decimal128 x); _Decimal32 roundd32(_Decimal32 x); _Decimal64 roundd64(_Decimal64 x); _Decimal128 roundd128(_Decimal128 x); long int lroundd32(_Decimal32 x); long int lroundd64(_Decimal64 x); long int lroundd128(_Decimal128 x); long long int llroundd32(_Decimal32 x); long long int llroundd64(_Decimal64 x); long long int llroundd128(_Decimal128 x); _Decimal32 roundevend32(_Decimal32 x); _Decimal64 roundevend64(_Decimal64 x); _Decimal128 roundevend128(_Decimal128 x); _Decimal32 truncd32(_Decimal32 x); _Decimal64 truncd64(_Decimal64 x); _Decimal128 truncd128(_Decimal128 x); _Decimal32 fromfpd32(_Decimal32 x, int rnd, unsigned int width); _Decimal64 fromfpd64(_Decimal64 x, int rnd, unsigned int width); _Decimal128 fromfpd128(_Decimal128 x, int rnd, unsigned int width); _Decimal32 ufromfpd32(_Decimal32 x, int rnd, unsigned int width); _Decimal64 ufromfpd64(_Decimal64 x, int rnd, unsigned int width); _Decimal128 ufromfpd128(_Decimal128 x, int rnd, unsigned int width); _Decimal32 fromfpxd32(_Decimal32 x, int rnd, unsigned int width); _Decimal64 fromfpxd64(_Decimal64 x, int rnd, unsigned int width); _Decimal128 fromfpxd128(_Decimal128 x, int rnd, unsigned int width); _Decimal32 ufromfpxd32(_Decimal32 x, int rnd, unsigned int width); _Decimal64 ufromfpxd64(_Decimal64 x, int rnd, unsigned int width); _Decimal128 ufromfpxd128(_Decimal128 x, int rnd, unsigned int width); _Decimal32 fmodd32(_Decimal32 x, _Decimal32 y); _Decimal64 fmodd64(_Decimal64 x, _Decimal64 y); _Decimal128 fmodd128(_Decimal128 x, _Decimal128 y); _Decimal32 remainderd32(_Decimal32 x, _Decimal32 y); _Decimal64 remainderd64(_Decimal64 x, _Decimal64 y); _Decimal128 remainderd128(_Decimal128 x, _Decimal128 y); _Decimal32 copysignd32(_Decimal32 x, _Decimal32 y); _Decimal64 copysignd64(_Decimal64 x, _Decimal64 y); _Decimal128 copysignd128(_Decimal128 x, _Decimal128 y); _Decimal32 nand32(const char *tagp); _Decimal64 nand64(const char *tagp); _Decimal128 nand128(const char *tagp); _Decimal32 nextafterd32(_Decimal32 x, _Decimal32 y); _Decimal64 nextafterd64(_Decimal64 x, _Decimal64 y); _Decimal128 nextafterd128(_Decimal128 x, _Decimal128 y); _Decimal32 nexttowardd32(_Decimal32 x, _Decimal128 y); _Decimal64 nexttowardd64(_Decimal64 x, _Decimal128 y); _Decimal128 nexttowardd128(_Decimal128 x, _Decimal128 y); _Decimal32 nextupd32(_Decimal32 x); _Decimal64 nextupd64(_Decimal64 x); _Decimal128 nextupd128(_Decimal128 x); _Decimal32 nextdownd32(_Decimal32 x); _Decimal64 nextdownd64(_Decimal64 x); _Decimal128 nextdownd128(_Decimal128 x); int canonicalized32(_Decimal32 *cx, const _Decimal32 *x); int canonicalized64(_Decimal64 *cx, const _Decimal64 *x); int canonicalized128(_Decimal128 *cx, const _Decimal128 *x); _Decimal32 fdimd32(_Decimal32 x, _Decimal32 y); _Decimal64 fdimd64(_Decimal64 x, _Decimal64 y); _Decimal128 fdimd128(_Decimal128 x, _Decimal128 y); _Decimal32 fmaxd32(_Decimal32 x, _Decimal32 y); _Decimal64 fmaxd64(_Decimal64 x, _Decimal64 y); _Decimal128 fmaxd128(_Decimal128 x, _Decimal128 y); _Decimal32 fmind32(_Decimal32 x, _Decimal32 y); _Decimal64 fmind64(_Decimal64 x, _Decimal64 y); _Decimal128 fmind128(_Decimal128 x, _Decimal128 y); _Decimal32 fmaximumd32(_Decimal32 x, _Decimal32 y); _Decimal64 fmaximumd64(_Decimal64 x, _Decimal64 y); _Decimal128 fmaximumd128(_Decimal128 x, _Decimal128 y); _Decimal32 fminimumd32(_Decimal32 x, _Decimal32 y); _Decimal64 fminimumd64(_Decimal64 x, _Decimal64 y); _Decimal128 fminimumd128(_Decimal128 x, _Decimal128 y); _Decimal32 fmaximum_magd32(_Decimal32 x, _Decimal32 y); _Decimal64 fmaximum_magd64(_Decimal64 x, _Decimal64 y); _Decimal128 fmaximum_magd128(_Decimal128 x, _Decimal128 y); _Decimal32 fminimum_magd32(_Decimal32 x, _Decimal32 y); _Decimal64 fminimum_magd64(_Decimal64 x, _Decimal64 y); _Decimal128 fminimum_magd128(_Decimal128 x, _Decimal128 y); _Decimal32 fmaximum_numd32(_Decimal32 x, _Decimal32 y); _Decimal64 fmaximum_numd64(_Decimal64 x, _Decimal64 y); _Decimal128 fmaximum_numd128(_Decimal128 x, _Decimal128 y); _Decimal32 fminimum_numd32(_Decimal32 x, _Decimal32 y); _Decimal64 fminimum_numd64(_Decimal64 x, _Decimal64 y); _Decimal128 fminimum_numd128(_Decimal128 x, _Decimal128 y); _Decimal32 fmaximum_mag_numd32(_Decimal32 x, _Decimal32 y); _Decimal64 fmaximum_mag_numd64(_Decimal64 x, _Decimal64 y); _Decimal128 fmaximum_mag_numd128(_Decimal128 x, _Decimal128 y); _Decimal32 fminimum_mag_numd32(_Decimal32 x, _Decimal32 y); _Decimal64 fminimum_mag_numd64(_Decimal64 x, _Decimal64 y); _Decimal128 fminimum_mag_numd128(_Decimal128 x, _Decimal128 y); _Decimal32 fmad32(_Decimal32 x, _Decimal32 y, _Decimal32 z); _Decimal64 fmad64(_Decimal64 x, _Decimal64 y, _Decimal64 z); _Decimal128 fmad128(_Decimal128 x, _Decimal128 y, _Decimal128 z); _Decimal32 d32addd64(_Decimal64 x, _Decimal64 y); _Decimal32 d32addd128(_Decimal128 x, _Decimal128 y); _Decimal64 d64addd128(_Decimal128 x, _Decimal128 y); _Decimal32 d32subd64(_Decimal64 x, _Decimal64 y); _Decimal32 d32subd128(_Decimal128 x, _Decimal128 y); _Decimal64 d64subd128(_Decimal128 x, _Decimal128 y); _Decimal32 d32muld64(_Decimal64 x, _Decimal64 y); _Decimal32 d32muld128(_Decimal128 x, _Decimal128 y); _Decimal64 d64muld128(_Decimal128 x, _Decimal128 y); _Decimal32 d32divd64(_Decimal64 x, _Decimal64 y); _Decimal32 d32divd128(_Decimal128 x, _Decimal128 y); _Decimal64 d64divd128(_Decimal128 x, _Decimal128 y); _Decimal32 d32fmad64(_Decimal64 x, _Decimal64 y, _Decimal64 z); _Decimal32 d32fmad128(_Decimal128 x, _Decimal128 y, _Decimal128 z); _Decimal64 d64fmad128(_Decimal128 x, _Decimal128 y, _Decimal128 z); _Decimal32 d32sqrtd64(_Decimal64 x); _Decimal32 d32sqrtd128(_Decimal128 x); _Decimal64 d64sqrtd128(_Decimal128 x); _Decimal32 quantized32(_Decimal32 x, _Decimal32 y); _Decimal64 quantized64(_Decimal64 x, _Decimal64 y); _Decimal128 quantized128(_Decimal128 x, _Decimal128 y); bool samequantumd32(_Decimal32 x, _Decimal32 y); bool samequantumd64(_Decimal64 x, _Decimal64 y); bool samequantumd128(_Decimal128 x, _Decimal128 y); _Decimal32 quantumd32(_Decimal32 x); _Decimal64 quantumd64(_Decimal64 x); _Decimal128 quantumd128(_Decimal128 x); long long int llquantexpd32(_Decimal32 x); long long int llquantexpd64(_Decimal64 x); long long int llquantexpd128(_Decimal128 x); void encodedecd32(unsigned char encptr[restrict static 4], const _Decimal32 * restrict xptr); void encodedecd64(unsigned char encptr[restrict static 8], const _Decimal64 * restrict xptr); void encodedecd128(unsigned char encptr[restrict static 16], const _Decimal128 * restrict xptr); void decodedecd32(_Decimal32 * restrict xptr, const unsigned char encptr[restrict static 4]); void decodedecd64(_Decimal64 * restrict xptr, const unsigned char encptr[restrict static 8]); void decodedecd128(_Decimal128 * restrict xptr, const unsigned char encptr[restrict static 16]); void encodebind32(unsigned char encptr[restrict static 4], const _Decimal32 * restrict xptr); void encodebind64(unsigned char encptr[restrict static 8], const _Decimal64 * restrict xptr); void encodebind128(unsigned char encptr[restrict static 16], const _Decimal128 * restrict xptr); void decodebind32(_Decimal32 * restrict xptr, const unsigned char encptr[restrict static 4]); void decodebind64(_Decimal64 * restrict xptr, const unsigned char encptr[restrict static 8]); void decodebind128(_Decimal128 * restrict xptr, const unsigned char encptr[restrict static 16]); int totalorder(const double *x, const double *y); int totalorderf(const float *x, const float *y); int totalorderl(const long double *x, const long double *y); int totalordermag(const double *x, const double *y); int totalordermagf(const float *x, const float *y); int totalordermagl(const long double *x, const long double *y); double getpayload(const double *x); float getpayloadf(const float *x); long double getpayloadl(const long double *x); int setpayload(double *res, double pl); int setpayloadf(float *res, float pl); int setpayloadl(long double *res, long double pl); int setpayloadsig(double *res, double pl); int setpayloadsigf(float *res, float pl); int setpayloadsigl(long double *res, long double pl); int totalorderd32(const _Decimal32 *x, const _Decimal32 *y); int totalorderd64(const _Decimal64 *x, const _Decimal64 *y); int totalorderd128(const _Decimal128 *x, const _Decimal128 *y); int totalordermagd32(const _Decimal32 *x, const _Decimal32 *y); int totalordermagd64(const _Decimal64 *x, const _Decimal64 *y); int totalordermagd128(const _Decimal128 *x, const _Decimal128 *y); _Decimal32 getpayloadd32(const _Decimal32 *x); _Decimal64 getpayloadd64(const _Decimal64 *x); _Decimal128 getpayloadd128(const _Decimal128 *x); int setpayloadd32(_Decimal32 *res, _Decimal32 pl); int setpayloadd64(_Decimal64 *res, _Decimal64 pl); int setpayloadd128(_Decimal128 *res, _Decimal128 pl); int setpayloadsigd32(_Decimal32 *res, _Decimal32 pl); int setpayloadsigd64(_Decimal64 *res, _Decimal64 pl); int setpayloadsigd128(_Decimal128 *res, _Decimal128 pl);
- :
HUGE_VAL_FNXHUGE_VAL_DNXFP_FAST_FMAFNFP_FAST_FMADNFP_FAST_FMAFNXFP_FAST_FMADNXFP_FAST_FMADDFNFP_FAST_FMADDFNXFP_FAST_FMXADDFNFP_FAST_FMXADDFNXFP_FAST_FMXMULFNXFP_FAST_DMMULDNFP_FAST_DMMULDNXFP_FAST_DMXMULDNFP_FAST_DMXMULDNXFP_FAST_FMDIVFNFP_FAST_FMDIVFNXFP_FAST_FMXDIVFNFP_FAST_FMXDIVFNXFP_FAST_DMDIVDNFP_FAST_DMDIVDNXFP_FAST_DMXDIVDNFP_FAST_DMXDIVDNXFP_FAST_FMFMAFNFP_FAST_FMFMAFNXFP_FAST_FMXFMAFNFP_FAST_FMXFMAFNXFP_FAST_DMFMADNFP_FAST_DMFMADNXFP_FAST_DMXFMADNFP_FAST_DMXFMADNXFP_FAST_FMSQRTFNFP_FAST_FMSQRTFNXFP_FAST_FMXSQRTFNFP_FAST_FMXSQRTFNXFP_FAST_DMSQRTDNFP_FAST_DMSQRTDNXFP_FAST_DMXSQRTDNFP_FAST_DMXSQRTDNX
_FloatN acosfN(_FloatN x); _FloatNx acosfNx(_FloatNx x); _DecimalN acosdN(_DecimalN x); _DecimalNx acosdNx(_DecimalNx x); _FloatN asinfN(_FloatN x); _FloatNx asinfNx(_FloatNx x); _DecimalN asindN(_DecimalN x); _DecimalNx asindNx(_DecimalNx x); _FloatN atanfN(_FloatN x); _FloatNx atanfNx(_FloatNx x); _DecimalN atandN(_DecimalN x); _DecimalNx atandNx(_DecimalNx x); _FloatN atan2fN(_FloatN y, _FloatN x); _FloatNx atan2fNx(_FloatNx y, _FloatNx x); _DecimalN atan2dN(_DecimalN y, _DecimalN x); _DecimalNx atan2dNx(_DecimalNx y, _DecimalNx x); _FloatN cosfN(_FloatN x); _FloatNx cosfNx(_FloatNx x); _DecimalN cosdN(_DecimalN x); _DecimalNx cosdNx(_DecimalNx x); _FloatN sinfN(_FloatN x); _FloatNx sinfNx(_FloatNx x); _DecimalN sindN(_DecimalN x); _DecimalNx sindNx(_DecimalNx x); _FloatN tanfN(_FloatN x); _FloatNx tanfNx(_FloatNx x); _DecimalN tandN(_DecimalN x); _DecimalNx tandNx(_DecimalNx x); _FloatN acospifN(_FloatN x); _FloatNx acospifNx(_FloatNx x); _DecimalN acospidN(_DecimalN x); _DecimalNx acospidNx(_DecimalNx x); _FloatN asinpifN(_FloatN x); _FloatNx asinpifNx(_FloatNx x); _DecimalN asinpidN(_DecimalN x); _DecimalNx asinpidNx(_DecimalNx x); _FloatN atanpifN(_FloatN x); _FloatNx atanpifNx(_FloatNx x); _DecimalN atanpidN(_DecimalN x); _DecimalNx atanpidNx(_DecimalNx x); _FloatN atan2pifN(_FloatN y, _FloatN x); _FloatNx atan2pifNx(_FloatNx y, _FloatNx x); _DecimalN atan2pidN(_DecimalN y, _DecimalN x); _DecimalNx atan2pidNx(_DecimalNx y, _DecimalNx x); _FloatN cospifN(_FloatN x); _FloatNx cospifNx(_FloatNx x); _DecimalN cospidN(_DecimalN x); _DecimalNx cospidNx(_DecimalNx x); _FloatN sinpifN(_FloatN x); _FloatNx sinpifNx(_FloatNx x); _DecimalN sinpidN(_DecimalN x); _DecimalNx sinpidNx(_DecimalNx x); _FloatN tanpifN(_FloatN x); _FloatNx tanpifNx(_FloatNx x); _DecimalN tanpidN(_DecimalN x); _DecimalNx tanpidNx(_DecimalNx x); _FloatN acoshfN(_FloatN x); _FloatNx acoshfNx(_FloatNx x); _DecimalN acoshdN(_DecimalN x); _DecimalNx acoshdNx(_DecimalNx x); _FloatN asinhfN(_FloatN x); _FloatNx asinhfNx(_FloatNx x); _DecimalN asinhdN(_DecimalN x); _DecimalNx asinhdNx(_DecimalNx x); _FloatN atanhfN(_FloatN x); _FloatNx atanhfNx(_FloatNx x); _DecimalN atanhdN(_DecimalN x); _DecimalNx atanhdNx(_DecimalNx x); _FloatN coshfN(_FloatN x); _FloatNx coshfNx(_FloatNx x); _DecimalN coshdN(_DecimalN x); _DecimalNx coshdNx(_DecimalNx x); _FloatN sinhfN(_FloatN x); _FloatNx sinhfNx(_FloatNx x); _DecimalN sinhdN(_DecimalN x); _DecimalNx sinhdNx(_DecimalNx x); _FloatN tanhfN(_FloatN x); _FloatNx tanhfNx(_FloatNx x); _DecimalN tanhdN(_DecimalN x); _DecimalNx tanhdNx(_DecimalNx x); _FloatN expfN(_FloatN x); _FloatNx expfNx(_FloatNx x); _DecimalN expdN(_DecimalN x); _DecimalNx expdNx(_DecimalNx x); _FloatN exp10fN(_FloatN x); _FloatNx exp10fNx(_FloatNx x); _DecimalN exp10dN(_DecimalN x); _DecimalNx exp10dNx(_DecimalNx x); _FloatN exp10m1fN(_FloatN x); _FloatNx exp10m1fNx(_FloatNx x); _DecimalN exp10m1dN(_DecimalN x); _DecimalNx exp10m1dNx(_DecimalNx x); _FloatN exp2fN(_FloatN x); _FloatNx exp2fNx(_FloatNx x); _DecimalN exp2dN(_DecimalN x); _DecimalNx exp2dNx(_DecimalNx x); _FloatN exp2m1fN(_FloatN x); _FloatNx exp2m1fNx(_FloatNx x); _DecimalN exp2m1dN(_DecimalN x); _DecimalNx exp2m1dNx(_DecimalNx x); _FloatN expm1fN(_FloatN x); _FloatNx expm1fNx(_FloatNx x); _DecimalN expm1dN(_DecimalN x); _DecimalNx expm1dNx(_DecimalNx x); _FloatN frexpfN(_FloatN value, int *exp); _FloatNx frexpfNx(_FloatNx value, int *exp); _DecimalN frexpdN(_DecimalN value, int *exp); _DecimalNx frexpdNx(_DecimalNx value, int *exp); int ilogbfN(_FloatN x); int ilogbfNx(_FloatNx x); int ilogbdN(_DecimalNx x); int ilogbdNx(_DecimalNx x); _FloatN ldexpfN(_FloatN value, int exp); _FloatNx ldexpfNx(_FloatNx value, int exp); _DecimalN ldexpdN(_DecimalN value, int exp); _DecimalNx ldexpdNx(_DecimalNx value, int exp); long int llogbfN(_FloatN x); long int llogbfNx(_FloatNx x); long int llogbdN(_DecimalN x); long int llogbdNx(_DecimalNx x); _FloatN logfN(_FloatN x); _FloatNx logfNx(_FloatNx x); _DecimalN logdN(_DecimalN x); _DecimalNx logdNx(_DecimalNx x); _FloatN log10fN(_FloatN x); _FloatNx log10fNx(_FloatNx x); _DecimalN log10dN(_DecimalN x); _DecimalNx log10dNx(_DecimalNx x); _FloatN log10p1fN(_FloatN x); _FloatNx log10p1fNx(_FloatNx x); _DecimalN log10p1dN(_DecimalN x); _DecimalNx log10p1dNx(_DecimalNx x); _FloatN log1pfN(_FloatN x); _FloatNx log1pfNx(_FloatNx x); _FloatN logp1fN(_FloatN x); _FloatNx logp1fNx(_FloatNx x); _DecimalN log1pdN(_DecimalN x); _DecimalNx log1pdNx(_DecimalNx x); _DecimalN logp1dN(_DecimalN x); _DecimalNx logp1dNx(_DecimalNx x); _FloatN log2fN(_FloatN x); _FloatNx log2fNx(_FloatNx x); _DecimalN log2dN(_DecimalN x); _DecimalNx log2dNx(_DecimalNx x); _FloatN log2p1fN(_FloatN x); _FloatNx log2p1fNx(_FloatNx x); _DecimalN log2p1dN(_DecimalN x); _DecimalNx log2p1dNx(_DecimalNx x); _FloatN logbfN(_FloatN x); _FloatNx logbfNx(_FloatNx x); _DecimalN logbdN(_DecimalN x); _DecimalNx logbdNx(_DecimalNx x); _FloatN modffN(_FloatN x, _FloatN *iptr); _FloatNx modffNx(_FloatNx x, _FloatNx *iptr); _DecimalN modfdN(_DecimalN x, _DecimalN *iptr); _DecimalNx modfdNx(_DecimalNx x, _DecimalNx *iptr); _FloatN scalbnfN(_FloatN value, int exp); _FloatNx scalbnfNx(_FloatNx value, int exp); _DecimalN scalbndN(_DecimalN value, int exp); _DecimalNx scalbndNx(_DecimalNx value, int exp); _FloatN scalblnfN(_FloatN value, long int exp); _FloatNx scalblnfNx(_FloatNx value, long int exp); _DecimalN scalblndN(_DecimalN value, long int exp); _DecimalNx scalblndNx(_DecimalNx value, long int exp); _FloatN cbrtfN(_FloatN x); _FloatNx cbrtfNx(_FloatNx x); _DecimalN cbrtdN(_DecimalN x); _DecimalNx cbrtdNx(_DecimalNx x); _FloatN compoundnfN(_FloatN x, long long int n); _FloatNx compoundnfNx(_FloatNx x, long long int n); _DecimalN compoundndN(_DecimalN x, long long int n); _DecimalNx compoundndNx(_DecimalNx x, long long int n); _FloatN fabsfN(_FloatN x); _FloatNx fabsfNx(_FloatNx x); _DecimalN fabsdN(_DecimalN x); _DecimalNx fabsdNx(_DecimalNx x); _FloatN hypotfN(_FloatN x, _FloatN y); _FloatNx hypotfNx(_FloatNx x, _FloatNx y); _DecimalN hypotdN(_DecimalN x, _DecimalN y); _DecimalNx hypotdNx(_DecimalNx x, _DecimalNx y); _FloatN powfN(_FloatN x, _FloatN y); _FloatNx powfNx(_FloatNx x, _FloatNx y); _DecimalN powdN(_DecimalN x, _DecimalN y); _DecimalNx powdNx(_DecimalNx x, _DecimalNx y); _FloatN pownfN(_FloatN x, long long int n); _FloatNx pownfNx(_FloatNx x, long long int n); _DecimalN powndN(_DecimalN x, long long int n); _DecimalNx powndNx(_DecimalNx x, long long int n); _FloatN powrfN(_FloatN x, _FloatN y); _FloatNx powrfNx(_FloatNx x, _FloatNx y); _DecimalN powrdN(_DecimalN x, _DecimalN y); _DecimalNx powrdNx(_DecimalNx x, _DecimalNx y); _FloatN rootnfN(_FloatN x, long long int n); _FloatNx rootnfNx(_FloatNx x, long long int n); _DecimalN rootndN(_DecimalN x, long long int n); _DecimalNx rootndNx(_DecimalNx x, long long int n); _FloatN rsqrtfN(_FloatN x); _FloatNx rsqrtfNx(_FloatNx x); _DecimalN rsqrtdN(_DecimalN x); _DecimalNx rsqrtdNx(_DecimalNx x); _FloatN sqrtfN(_FloatN x); _FloatNx sqrtfNx(_FloatNx x); _DecimalN sqrtdN(_DecimalN x); _DecimalNx sqrtdNx(_DecimalNx x); _FloatN erffN(_FloatN x); _FloatNx erffNx(_FloatNx x); _DecimalN erfdN(_DecimalN x); _DecimalNx erfdNx(_DecimalNx x); _FloatN erfcfN(_FloatN x); _FloatNx erfcfNx(_FloatNx x); _DecimalN erfcdN(_DecimalN x); _DecimalNx erfcdNx(_DecimalNx x); _FloatN lgammafN(_FloatN x); _FloatNx lgammafNx(_FloatNx x); _DecimalN lgammadN(_DecimalN x); _DecimalNx lgammadNx(_DecimalNx x); _FloatN tgammafN(_FloatN x); _FloatNx tgammafNx(_FloatNx x); _DecimalN tgammadN(_DecimalN x); _DecimalNx tgammadNx(_DecimalNx x); _FloatN ceilfN(_FloatN x); _FloatNx ceilfNx(_FloatNx x); _DecimalN ceildN(_DecimalN x); _DecimalNx ceildNx(_DecimalNx x); _FloatN floorfN(_FloatN x); _FloatNx floorfNx(_FloatNx x); _DecimalN floordN(_DecimalN x); _DecimalNx floordNx(_DecimalNx x); _FloatN nearbyintfN(_FloatN x); _FloatNx nearbyintfNx(_FloatNx x); _DecimalN nearbyintdN(_DecimalN x); _DecimalNx nearbyintdNx(_DecimalNx x); _FloatN rintfN(_FloatN x); _FloatNx rintfNx(_FloatNx x); _DecimalN rintdN(_DecimalN x); _DecimalNx rintdNx(_DecimalNx x); long int lrintfN(_FloatN x); long int lrintfNx(_FloatNx x); long int lrintdN(_DecimalN x); long int lrintdNx(_DecimalNx x); long long int llrintfN(_FloatN x); long long int llrintfNx(_FloatNx x); long long int llrintdN(_DecimalN x); long long int llrintdNx(_DecimalNx x); _FloatN roundfN(_FloatN x); _FloatNx roundfNx(_FloatNx x); _DecimalN rounddN(_DecimalN x); _DecimalNx rounddNx(_DecimalNx x); long int lroundfN(_FloatN x); long int lroundfNx(_FloatNx x); long int lrounddN(_DecimalN x); long int lrounddNx(_DecimalNx x); long long int llroundfN(_FloatN x); long long int llroundfNx(_FloatNx x); long long int llrounddN(_DecimalN x); long long int llrounddNx(_DecimalNx x); _FloatN roundevenfN(_FloatN x); _FloatNx roundevenfNx(_FloatNx x); _DecimalN roundevendN(_DecimalN x); _DecimalNx roundevendNx(_DecimalNx x); _FloatN truncfN(_FloatN x); _FloatNx truncfNx(_FloatNx x); _DecimalN truncdN(_DecimalN x); _DecimalNx truncdNx(_DecimalNx x); _FloatN fromfpfN(_FloatN x, int rnd, unsigned int width); _FloatNx fromfpfNx(_FloatNx x, int rnd, unsigned int width); _DecimalN fromfpdN(_DecimalN x, int rnd, unsigned int width); _DecimalNx fromfpdNx(_DecimalNx x, int rnd, unsigned int width); _FloatN ufromfpfN(_FloatN x, int rnd, unsigned int width); _FloatNx ufromfpfNx(_FloatNx x, int rnd, unsigned int width); _DecimalN ufromfpdN(_DecimalN x, int rnd, unsigned int width); _DecimalNx ufromfpdNx(_DecimalNx x, int rnd, unsigned int width); _FloatN fromfpxfN(_FloatN x, int rnd, unsigned int width); _FloatNx fromfpxfNx(_FloatNx x, int rnd, unsigned int width); _DecimalN fromfpxdN(_DecimalN x, int rnd, unsigned int width); _DecimalNx fromfpxdNx(_DecimalNx x, int rnd, unsigned int width); _FloatN ufromfpxfN(_FloatN x, int rnd, unsigned int width); _FloatNx ufromfpxfNx(_FloatNx x, int rnd, unsigned int width); _DecimalN ufromfpxdN(_DecimalN x, int rnd, unsigned int width); _DecimalNx ufromfpxdNx(_DecimalNx x, int rnd, unsigned int width); _FloatN fmodfN(_FloatN x, _FloatN y); _FloatNx fmodfNx(_FloatNx x, _FloatNx y); _DecimalN fmoddN(_DecimalN x, _DecimalN y); _DecimalNx fmoddNx(_DecimalNx x, _DecimalNx y); _FloatN remainderfN(_FloatN x, _FloatN y); _FloatNx remainderfNx(_FloatNx x, _FloatNx y); _DecimalN remainderdN(_DecimalN x, _DecimalN y); _DecimalNx remainderdNx(_DecimalNx x, _DecimalNx y); _FloatN remquofN(_FloatN x, _FloatN y, int *quo); _FloatNx remquofNx(_FloatNx x, _FloatNx y, int *quo); _FloatN copysignfN(_FloatN x, _FloatN y); _FloatNx copysignfNx(_FloatNx x, _FloatNx y); _DecimalN copysigndN(_DecimalN x, _DecimalN y); _DecimalNx copysigndNx(_DecimalNx x, _DecimalNx y); _FloatN nanfN(const char *tagp); _FloatNx nanfNx(const char *tagp); _DecimalN nandN(const char *tagp); _DecimalNx nandNx(const char *tagp); _FloatN nextafterfN(_FloatN x, _FloatN y); _FloatNx nextafterfNx(_FloatNx x, _FloatNx y); _DecimalN nextafterdN(_DecimalN x, _DecimalN y); _DecimalNx nextafterdNx(_DecimalNx x, _DecimalNx y); _FloatN nextupfN(_FloatN x); _FloatNx nextupfNx(_FloatNx x); _DecimalN nextupdN(_DecimalN x); _DecimalNx nextupdNx(_DecimalNx x); _FloatN nextdownfN(_FloatN x); _FloatNx nextdownfNx(_FloatNx x); _DecimalN nextdowndN(_DecimalN x); _DecimalNx nextdowndNx(_DecimalNx x); int canonicalizefN(_FloatN *cx, const _FloatN *x); int canonicalizefNx(_FloatNx *cx, const _FloatNx *x); int canonicalizedN(_DecimalN *cx, const _DecimalN *x); int canonicalizedNx(_DecimalNx *cx, const _DecimalNx *x); _FloatN fdimfN(_FloatN x, _FloatN y); _FloatNx fdimfNx(_FloatNx x, _FloatNx y); _DecimalN fdimdN(_DecimalN x, _DecimalN y); _DecimalNx fdimdNx(_DecimalNx x, _DecimalNx y); _FloatN fmaximumfN(_FloatN x, _FloatN y); _FloatNx fmaximumfNx(_FloatNx x, _FloatNx y); _DecimalN fmaximumdN(_DecimalN x, _DecimalN y); _DecimalNx fmaximumdNx(_DecimalNx x, _DecimalNx y); _FloatN fminimumfN(_FloatN x, _FloatN y); _FloatNx fminimumfNx(_FloatNx x, _FloatNx y); _DecimalN fminimumdN(_DecimalN x, _DecimalN y); _DecimalNx fminimumdNx(_DecimalNx x, _DecimalNx y); _FloatN fmaximum_magfN(_FloatN x, _FloatN y); _FloatNx fmaximum_magfNx(_FloatNx x, _FloatNx y); _DecimalN fmaximum_magdN(_DecimalN x, _DecimalN y); _DecimalNx fmaximum_magdNx(_DecimalNx x, _DecimalNx y); _FloatN fminimum_magfN(_FloatN x, _FloatN y); _FloatNx fminimum_magfNx(_FloatNx x, _FloatNx y); _DecimalN fminimum_magdN(_DecimalN x, _DecimalN y); _DecimalNx fminimum_magdNx(_DecimalNx x, _DecimalNx y); _FloatN fmaximum_numfN(_FloatN x, _FloatN y); _FloatNx fmaximum_numfNx(_FloatNx x, _FloatNx y); _DecimalN fmaximum_numdN(_DecimalN x, _DecimalN y); _DecimalNx fmaximum_numdNx(_DecimalNx x, _DecimalNx y); _FloatN fminimum_numfN(_FloatN x, _FloatN y); _FloatNx fminimum_numfNx(_FloatNx x, _FloatNx y); _DecimalN fminimum_numdN(_DecimalN x, _DecimalN y); _DecimalNx fminimum_numdNx(_DecimalNx x, _DecimalNx y); _FloatN fmaximum_mag_numfN(_FloatN x, _FloatN y); _FloatNx fmaximum_mag_numfNx(_FloatNx x, _FloatNx y); _DecimalN fmaximum_mag_numdN(_DecimalN x, _DecimalN y); _DecimalNx fmaximum_mag_numdNx(_DecimalNx x, _DecimalNx y); _FloatN fminimum_mag_numfN(_FloatN x, _FloatN y); _FloatNx fminimum_mag_numfNx(_FloatNx x, _FloatNx y); _DecimalN fminimum_mag_numdN(_DecimalN x, _DecimalN y); _DecimalNx fminimum_mag_numdNx(_DecimalNx x, _DecimalNx y); _FloatN fmafN(_FloatN x, _FloatN y, _FloatN z); _FloatNx fmafNx(_FloatNx x, _FloatNx y, _FloatNx z); _DecimalN fmadN(_DecimalN x, _DecimalN y, _DecimalN z); _DecimalNx fmadNx(_DecimalNx x, _DecimalNx y, _DecimalNx z); _FloatM fMaddfN(_FloatN x, _FloatN y); // M < N _FloatM fMaddfNx(_FloatNx x, _FloatNx y); // M ≤ N _FloatMx fMxaddfN(_FloatN x, _FloatN y); // M < N _FloatMx fMxaddfNx(_FloatNx x, _FloatNx y); // M < N _DecimalM dMadddN(_DecimalN x, _DecimalN y); // M < N _DecimalM dMadddNx(_DecimalNx x, _DecimalNx y); // M ≤ N _DecimalMx dMxadddN(_DecimalN x, _DecimalN y); // M ≤ N _DecimalMx dMxadddNx(_DecimalNx x, _DecimalNx y); // M ≤ N _FloatM fMsubfN(_FloatN x, _FloatN y); // M < N _FloatM fMsubfNx(_FloatNx x, _FloatNx y); // M ≤ N _FloatMx fMxsubfN(_FloatN x, _FloatN y); // M < N _FloatMx fMxsubfNx(_FloatNx x, _FloatNx y); // M < N _DecimalM dMsubdN(_DecimalN x, _DecimalN y); // M < N _DecimalM dMsubdNx(_DecimalNx x, _DecimalNx y); // M ≤ N _DecimalMx dMxsubdN(_DecimalN x, _DecimalN y); // M < N _DecimalMx dMxsubdNx(_DecimalNx x, _DecimalNx y); // M < N _FloatM fMmulfN(_FloatN x, _FloatN y); // M < N _FloatM fMmulfNx(_FloatNx x, _FloatNx y); // M ≤ N _FloatMx fMxmulfN(_FloatN x, _FloatN y); // M < N _FloatMx fMxmulfNx(_FloatNx x, _FloatNx y); // M < N _DecimalM dMmuldN(_DecimalN x, _DecimalN y); // M < N _DecimalM dMmuldNx(_DecimalNx x, _DecimalNx y); // M ≤ N _DecimalMx dMxmuldN(_DecimalN x, _DecimalN y); // M < N _DecimalMx dMxmuldNx(_DecimalNx x, _DecimalNx y); // M < N _FloatM fMdivfN(_FloatN x, _FloatN y); // M < N _FloatM fMdivfNx(_FloatNx x, _FloatNx y); // M ≤ N _FloatMx fMxdivfN(_FloatN x, _FloatN y); // M < N _FloatMx fMxdivfNx(_FloatNx x, _FloatNx y); // M < N _DecimalM dMdivdN(_DecimalN x, _DecimalN y); // M < N _DecimalM dMdivdNx(_DecimalNx x, _DecimalNx y); // M ≤ N _DecimalMx dMxdivdN(_DecimalN x, _DecimalN y); // M < N _DecimalMx dMxdivdNx(_DecimalNx x, _DecimalNx y); // M < N _FloatM fMfmafN(_FloatN x, _FloatN y, _FloatN z); // M < N _FloatM fMfmafNx(_FloatNx x, _FloatNx y, _FloatNx z); // M ≤ N _FloatMx fMxfmafN(_FloatN x, _FloatN y, _FloatN z); // M < N _FloatMx fMxfmafNx(_FloatNx x, _FloatNx y, _FloatNx z); // M < N _DecimalM dMfmadN(_DecimalN x, _DecimalN y, _DecimalN z); // M < N _DecimalM dMfmadNx(_DecimalNx x, _DecimalNx y, _DecimalNx z); // M ≤ N _DecimalMx dMxfmadN(_DecimalN x, _DecimalN y, _DecimalN z); // M < N _DecimalMx dMxfmadNx(_DecimalNx x, _DecimalNx y, _DecimalNx z); // M < N _FloatM fMsqrtfN(_FloatN x); // M < N _FloatM fMsqrtfNx(_FloatNx x); // M ≤ N _FloatMx fMxsqrtfN(_FloatN x); // M < N _FloatMx fMxsqrtfNx(_FloatNx x); // M < N _DecimalM dMsqrtdN(_DecimalN x); // M < N _DecimalM dMsqrtdNx(_DecimalNx x); // M ≤ N _DecimalMx dMxsqrtdN(_DecimalN x); // M < N _DecimalMx dMxsqrtdNx(_DecimalNx x); // M < N _DecimalN quantizedN(_DecimalN x, _DecimalN y); _DecimalNx quantizedNx(_DecimalNx x, _DecimalNx y); bool samequantumdN(_DecimalN x, _DecimalN y); bool samequantumdNx(_DecimalNx x, _DecimalNx y); _DecimalN quantumdN(_DecimalN x); _DecimalNx quantumdNx(_DecimalNx x); long long int llquantexpdN(_DecimalN x); long long int llquantexpdNx(_DecimalNx x); void encodedecdN(unsigned char * restrict encptr, const _DecimalN * restrict xptr); void decodedecdN(_DecimalN * restrict xptr, const unsigned char * restrict encptr); void encodebindN(unsigned char * restrict encptr, const _DecimalN * restrict xptr); void decodebindN(_DecimalN * restrict xptr, const unsigned char * restrict encptr); int totalorderfN(const _FloatN *x, const _FloatN *y); int totalorderfNx(const _FloatNx *x, const _FloatNx *y); int totalorderdN(const _DecimalN *x, const _DecimalN *y); int totalorderdNx(const _DecimalNx *x, const _DecimalNx *y); int totalordermagfN(const _FloatN *x, const _FloatN *y); int totalordermagfNx(const _FloatNx *x, const _FloatNx *y); int totalordermagdN(const _DecimalN *x, const _DecimalN *y); int totalordermagdNx(const _DecimalNx *x, const _DecimalNx *y); _FloatN getpayloadfN(const _FloatN *x); _FloatNx getpayloadfNx(const _FloatNx *x); _DecimalN getpayloaddN(const _DecimalN *x); _DecimalNx getpayloaddNx(const _DecimalNx *x); int setpayloadfN(_FloatN *res, _FloatN pl); int setpayloadfNx(_FloatNx *res, _FloatNx pl); int setpayloaddN(_DecimalN *res, _DecimalN pl); int setpayloaddNx(_DecimalNx *res, _DecimalNx pl); int setpayloadsigfN(_FloatN *res, _FloatN pl); int setpayloadsigfNx(_FloatNx *res, _FloatNx pl); int setpayloadsigdN(_DecimalN *res, _DecimalN pl); int setpayloadsigdNx(_DecimalNx *res, _DecimalNx pl); void encodefN(unsigned char encptr[restrict static N/8], const _FloatN * restrict xptr); void decodefN(_FloatN * restrict xptr, const unsigned char encptr[restrict static N/8]); void fMencfN(unsigned char encMptr[restrict static M/8], const unsigned char encNptr[restrict static N/8]); void dMencdecdN(unsigned char encMptr[restrict static M/8], const unsigned char encNptr[restrict static N/8]); void dMencbindN(unsigned char encMptr[restrict static M/8], const unsigned char encNptr[restrict static N/8]);
B.12 Non-local jumps <setjmp.h>
int setjmp(jmp_buf env); [[noreturn]] void longjmp(jmp_buf env, int val);
B.13 Signal handling <signal.h>
- :
SIG_ERRSIG_IGNSIGABRTSIGFPESIGILLSIGINTSIGSEGVSIGTERM
void (*signal(int sig, void (*func)(int)))(int); int raise(int sig);
B.14 Alignment <stdalign.h>
B.15 Varying arguments <stdarg.h>
type va_arg(va_list ap, type); void va_copy(va_list dest, va_list src); void va_end(va_list ap); void va_start(va_list ap, ...);
B.16 Atomics <stdatomic.h>
- :
atomic_boolatomic_charatomic_scharatomic_ucharatomic_shortatomic_ushortatomic_intatomic_uintatomic_longatomic_ulongatomic_llongatomic_ullongatomic_char8_tatomic_char16_tatomic_char32_tatomic_wchar_tatomic_int_least8_tatomic_uint_least8_tatomic_int_least16_tatomic_uint_least16_tatomic_int_least32_tatomic_uint_least32_tatomic_int_least64_tatomic_uint_least64_tatomic_int_fast8_tatomic_uint_fast8_tatomic_int_fast16_tatomic_uint_fast16_tatomic_int_fast32_tatomic_uint_fast32_tatomic_int_fast64_tatomic_uint_fast64_tatomic_intptr_tatomic_uintptr_tatomic_size_tatomic_ptrdiff_tatomic_intmax_tatomic_uintmax_t
void atomic_init(volatile A *obj, C value); type kill_dependency(type y); void atomic_thread_fence(memory_order order); void atomic_signal_fence(memory_order order); bool atomic_is_lock_free(const volatile A *obj); void atomic_store(volatile A *object, C desired); void atomic_store_explicit(volatile A *object, C desired, memory_order order); C atomic_load(const volatile A *object); C atomic_load_explicit(const volatile A *object, memory_order order); C atomic_exchange(volatile A *object, C desired); C atomic_exchange_explicit(volatile A *object, C desired, memory_order order); bool atomic_compare_exchange_strong(volatile A *object, C *expected, C desired); bool atomic_compare_exchange_strong_explicit(volatile A *object, C *expected, C desired, memory_order success, memory_order failure); bool atomic_compare_exchange_weak(volatile A *object, C *expected, C desired); bool atomic_compare_exchange_weak_explicit(volatile A *object, C *expected, C desired, memory_order success, memory_order failure); C atomic_fetch_key(volatile A *object, M operand); C atomic_fetch_key_explicit(volatile A *object, M operand, memory_order order); bool atomic_flag_test_and_set(volatile atomic_flag *object); bool atomic_flag_test_and_set_explicit(volatile atomic_flag *object, memory_order order); void atomic_flag_clear(volatile atomic_flag *object); void atomic_flag_clear_explicit(volatile atomic_flag *object, memory_order order);
B.17 Bit and byte utilities <stdbit.h>
- :
__STDC_ENDIAN_LITTLE____STDC_ENDIAN_NATIVE__
unsigned int stdc_leading_zeros_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_leading_zeros_us(unsigned short value) [[unsequenced]]; unsigned int stdc_leading_zeros_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_leading_zeros_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_leading_zeros_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_leading_zeros(generic_value_type value) [[unsequenced]]; unsigned int stdc_leading_ones_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_leading_ones_us(unsigned short value) [[unsequenced]]; unsigned int stdc_leading_ones_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_leading_ones_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_leading_ones_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_leading_ones(generic_value_type value) [[unsequenced]]; unsigned int stdc_trailing_zeros_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_trailing_zeros_us(unsigned short value) [[unsequenced]]; unsigned int stdc_trailing_zeros_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_trailing_zeros_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_trailing_zeros_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_trailing_zeros(generic_value_type value) [[unsequenced]]; unsigned int stdc_trailing_ones_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_trailing_ones_us(unsigned short value) [[unsequenced]]; unsigned int stdc_trailing_ones_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_trailing_ones_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_trailing_ones_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_trailing_ones(generic_value_type value) [[unsequenced]]; unsigned int stdc_first_leading_zero_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_first_leading_zero_us(unsigned short value) [[unsequenced]]; unsigned int stdc_first_leading_zero_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_first_leading_zero_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_first_leading_zero_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_first_leading_zero(generic_value_type value) [[unsequenced]]; unsigned int stdc_first_leading_one_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_first_leading_one_us(unsigned short value) [[unsequenced]]; unsigned int stdc_first_leading_one_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_first_leading_one_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_first_leading_one_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_first_leading_one(generic_value_type value) [[unsequenced]]; unsigned int stdc_first_trailing_zero_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_first_trailing_zero_us(unsigned short value) [[unsequenced]]; unsigned int stdc_first_trailing_zero_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_first_trailing_zero_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_first_trailing_zero_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_first_trailing_zero(generic_value_type value) [[unsequenced]]; unsigned int stdc_first_trailing_one_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_first_trailing_one_us(unsigned short value) [[unsequenced]]; unsigned int stdc_first_trailing_one_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_first_trailing_one_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_first_trailing_one_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_first_trailing_one(generic_value_type value) [[unsequenced]]; unsigned int stdc_count_zeros_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_count_zeros_us(unsigned short value) [[unsequenced]]; unsigned int stdc_count_zeros_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_count_zeros_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_count_zeros_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_count_zeros(generic_value_type value) [[unsequenced]]; unsigned int stdc_count_ones_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_count_ones_us(unsigned short value) [[unsequenced]]; unsigned int stdc_count_ones_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_count_ones_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_count_ones_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_count_ones(generic_value_type value) [[unsequenced]]; bool stdc_has_single_bit_uc(unsigned char value) [[unsequenced]]; bool stdc_has_single_bit_us(unsigned short value) [[unsequenced]]; bool stdc_has_single_bit_ui(unsigned int value) [[unsequenced]]; bool stdc_has_single_bit_ul(unsigned long int value) [[unsequenced]]; bool stdc_has_single_bit_ull(unsigned long long int value) [[unsequenced]]; bool stdc_has_single_bit(generic_value_type value) [[unsequenced]]; unsigned int stdc_bit_width_uc(unsigned char value) [[unsequenced]]; unsigned int stdc_bit_width_us(unsigned short value) [[unsequenced]]; unsigned int stdc_bit_width_ui(unsigned int value) [[unsequenced]]; unsigned int stdc_bit_width_ul(unsigned long int value) [[unsequenced]]; unsigned int stdc_bit_width_ull(unsigned long long int value) [[unsequenced]]; generic_return_type stdc_bit_width(generic_value_type value) [[unsequenced]]; unsigned char stdc_bit_floor_uc(unsigned char value) [[unsequenced]]; unsigned short stdc_bit_floor_us(unsigned short value) [[unsequenced]]; unsigned int stdc_bit_floor_ui(unsigned int value) [[unsequenced]]; unsigned long int stdc_bit_floor_ul(unsigned long int value) [[unsequenced]]; unsigned long long int stdc_bit_floor_ull(unsigned long long int value) [[unsequenced]]; generic_value_type stdc_bit_floor(generic_value_type value) [[unsequenced]]; unsigned char stdc_bit_ceil_uc(unsigned char value) [[unsequenced]]; unsigned short stdc_bit_ceil_us(unsigned short value) [[unsequenced]]; unsigned int stdc_bit_ceil_ui(unsigned int value) [[unsequenced]]; unsigned long int stdc_bit_ceil_ul(unsigned long int value) [[unsequenced]]; unsigned long long int stdc_bit_ceil_ull(unsigned long long int value) [[unsequenced]]; generic_value_type stdc_bit_ceil(generic_value_type value) [[unsequenced]]; unsigned char stdc_rotate_left_uc(unsigned char value, unsigned int count); unsigned short stdc_rotate_left_us(unsigned short value, unsigned int count); unsigned int stdc_rotate_left_ui(unsigned int value, unsigned int count); unsigned long stdc_rotate_left_ul(unsigned long value, unsigned int count); unsigned long long stdc_rotate_left_ull(unsigned long long value, unsigned int count); generic_value_type stdc_rotate_left( generic_value_type value, generic_count_type count); unsigned char stdc_rotate_right_uc(unsigned char value, unsigned int count); unsigned short stdc_rotate_right_us(unsigned short value, unsigned int count); unsigned int stdc_rotate_right_ui(unsigned int value, unsigned int count); unsigned long stdc_rotate_right_ul(unsigned long value, unsigned int count); unsigned long long stdc_rotate_right_ull(unsigned long long value, unsigned int count); generic_value_type stdc_rotate_right(generic_value_type value, generic_count_type count); void stdc_memreverse8(size_t n, unsigned char ptr[static n]); uintN_t stdc_memreverse8uN(uintN_t value); uint_leastN_t stdc_load8_leuN(const unsigned char ptr[static (N / 8)]); uint_leastN_t stdc_load8_beuN(const unsigned char ptr[static (N / 8)]); uint_leastN_t stdc_load8_aligned_leuN(const unsigned char ptr[static (N / 8)]); uint_leastN_t stdc_load8_aligned_beuN(const unsigned char ptr[static (N / 8)]); int_leastN_t stdc_load8_lesN(const unsigned char ptr[static (N / 8)]); int_leastN_t stdc_load8_besN(const unsigned char ptr[static (N / 8)]); int_leastN_t stdc_load8_aligned_lesN(const unsigned char ptr[static (N / 8)]); int_leastN_t stdc_load8_aligned_besN(const unsigned char ptr[static (N / 8)]); void stdc_store8_leuN(uint_leastN_t value, unsigned char ptr[static (N / 8)]); void stdc_store8_beuN(uint_leastN_t value, unsigned char ptr[static (N / 8)]); void stdc_store8_aligned_leuN(uint_leastN_t value, unsigned char ptr[static (N / 8)]); void stdc_store8_aligned_beuN(uint_leastN_t value, unsigned char ptr[static (N / 8)]); void stdc_store8_lesN(int_leastN_t value, unsigned char ptr[static (N / 8)]); void stdc_store8_besN(int_leastN_t value, unsigned char ptr[static (N / 8)]); void stdc_store8_aligned_lesN(int_leastN_t value, unsigned char ptr[static (N / 8)]); void stdc_store8_aligned_besN(int_leastN_t value, unsigned char ptr[static (N / 8)]);
B.18 Boolean type and values <stdbool.h>
B.19 Checked Integer Operations <stdckdint.h>
bool ckd_add(type1 *result, type2 a, type3 b); bool ckd_sub(type1 *result, type2 a, type3 b); bool ckd_mul(type1 *result, type2 a, type3 b);
B.20 Array count <stdcountof.h>
B.21 Common definitions <stddef.h>
offsetof(type, member-designator ) unreachable()
B.22 Integer types <stdint.h>
- :
UINT_LEASTN_MAXUINT_LEASTN_WIDTHINT_FASTN_MININT_FASTN_MAXINT_FASTN_WIDTHUINT_FASTN_MAXUINT_FASTN_WIDTHINTPTR_MININTPTR_MAXINTPTR_WIDTHUINTPTR_MAXUINTPTR_WIDTHINTMAX_MININTMAX_MAXINTMAX_WIDTHUINTMAX_MAXUINTMAX_WIDTHPTRDIFF_MINPTRDIFF_MAXSIG_ATOMIC_MINSIG_ATOMIC_MAXSIG_ATOMIC_WIDTHSIZE_MAXSIZE_WIDTHWCHAR_MINWCHAR_MAXWCHAR_WIDTHWINT_MINWINT_MAXWINT_WIDTHINTN_C(value)UINTN_C(value)INTMAX_C(value)UINTMAX_C(value)
B.23 Input/output <stdio.h>
- :
_IOLBF_IONBFBUFSIZEOFFOPEN_MAXFILENAME_MAXL_tmpnamSEEK_CURSEEK_ENDSEEK_SETTMP_MAXstderrstdinstdout_PRINTF_NAN_LEN_MAX
int remove(const char *filename); int rename(const char *old, const char *new); FILE *tmpfile(void); char *tmpnam(char *s); int fclose(FILE *stream); int fflush(FILE *stream); FILE *fopen(const char * restrict filename, const char * restrict mode); FILE *freopen(const char * restrict filename, const char * restrict mode, FILE * restrict stream); void setbuf(FILE * restrict stream, char * restrict buf); int setvbuf(FILE * restrict stream, char * restrict buf, int mode, size_t size); int printf(const char * restrict format, ...); int scanf(const char * restrict format, ...); int snprintf(char * restrict s, size_t n, const char * restrict format, ...); int sprintf(char * restrict s, const char * restrict format, ...); int sscanf(const char * restrict s, const char * restrict format, ...); int vfprintf(FILE * restrict stream, const char * restrict format, va_list arg); int vfscanf(FILE * restrict stream, const char * restrict format, va_list arg); int vprintf(const char * restrict format, va_list arg); int vscanf(const char * restrict format, va_list arg); int vsnprintf(char * restrict s, size_t n, const char * restrict format, va_list arg); int vsprintf(char * restrict s, const char * restrict format, va_list arg); int vsscanf(const char * restrict s, const char * restrict format, va_list arg); int fgetc(FILE *stream); char *fgets(char * restrict s, int n, FILE * restrict stream); int fputc(int c, FILE *stream); int fputs(const char * restrict s, FILE * restrict stream); int getc(FILE *stream); int getchar(void); int putc(int c, FILE *stream); int putchar(int c); int puts(const char *s); int ungetc(int c, FILE *stream); size_t fread(void * restrict ptr, size_t size, size_t nmemb, FILE * restrict stream); size_t fwrite(const void * restrict ptr, size_t size, size_t nmemb, FILE * restrict stream); int fgetpos(FILE * restrict stream, fpos_t * restrict pos); int fseek(FILE *stream, long int offset, int whence); int fsetpos(FILE *stream, const fpos_t *pos); long int ftell(FILE *stream); void rewind(FILE *stream); void clearerr(FILE *stream); int feof(FILE *stream); int ferror(FILE *stream); void perror(const char *s); int fprintf(FILE * restrict stream, const char * restrict format, ...); int fscanf(FILE * restrict stream, const char * restrict format, ...); errno_t tmpfile_s(FILE * restrict * restrict streamptr); errno_t tmpnam_s(char *s, rsize_t maxsize); errno_t fopen_s(FILE * restrict * restrict streamptr, const char * restrict filename, const char * restrict mode); errno_t freopen_s(FILE * restrict * restrict newstreamptr, const char * restrict filename, const char * restrict mode, FILE * restrict stream); int fprintf_s(FILE * restrict stream, const char * restrict format, ...); int fscanf_s(FILE * restrict stream, const char * restrict format, ...); int printf_s(const char * restrict format, ...); int scanf_s(const char * restrict format, ...); int snprintf_s(char * restrict s, rsize_t n, const char * restrict format, ...); int sprintf_s(char * restrict s, rsize_t n, const char * restrict format, ...); int sscanf_s(const char * restrict s, const char * restrict format, ...); int vfprintf_s(FILE * restrict stream, const char * restrict format, va_list arg); int vfscanf_s(FILE * restrict stream, const char * restrict format, va_list arg); int vprintf_s(const char * restrict format, va_list arg); int vscanf_s(const char * restrict format, va_list arg); int vsnprintf_s(char * restrict s, rsize_t n, const char * restrict format, va_list arg); int vsprintf_s(char * restrict s, rsize_t n, const char * restrict format, va_list arg); int vsscanf_s(const char * restrict s, const char * restrict format, va_list arg); char *gets_s(char *s, rsize_t n);
B.24 General utilities <stdlib.h>
- :
ldiv_tlldiv_tonce_flagEXIT_FAILUREEXIT_SUCCESSMB_CUR_MAXNULLONCE_FLAG_INITRAND_MAX
void call_once(once_flag *flag, void (*func)(void)); double atof(const char *nptr); int atoi(const char *nptr); long int atol(const char *nptr); long long int atoll(const char *nptr); int strfromd(char * restrict s, size_t n, const char * restrict format, double fp); int strfromf(char * restrict s, size_t n, const char * restrict format, float fp); int strfroml(char * restrict s, size_t n, const char * restrict format, long double fp); double strtod(const char * restrict nptr, char ** restrict endptr); float strtof(const char * restrict nptr, char ** restrict endptr); long double strtold(const char * restrict nptr, char ** restrict endptr); long int strtol(const char * restrict nptr, char ** restrict endptr, int base); long long int strtoll(const char * restrict nptr, char ** restrict endptr, int base); unsigned long int strtoul(const char * restrict nptr, char ** restrict endptr, int base); unsigned long long int strtoull(const char * restrict nptr, char ** restrict endptr, int base); int rand(void); void srand(unsigned int seed); void *aligned_alloc(size_t alignment, size_t size); void *calloc(size_t nmemb, size_t size); void free(void *ptr); void free_sized(void *ptr, size_t size); void free_aligned_sized(void *ptr, size_t alignment, size_t size); void *malloc(size_t size); void *realloc(void *ptr, size_t size); [[noreturn]] void abort(void); int atexit(void (*func)(void)); int at_quick_exit(void (*func)(void)); [[noreturn]] void exit(int status); [[noreturn]] void _Exit(int status); char *getenv(const char *name); [[noreturn]] void quick_exit(int status); int system(const char *string); QVoid *bsearch(const void *key, QVoid *base, size_t nmemb, size_t size, int (*compar)(const void *, const void *)); void qsort(void *base, size_t nmemb, size_t size, int (*compar)(const void *, const void *)); int abs(int j); unsigned int uabs(int j); long int labs(long int j); unsigned long int ulabs(long int j); long long int llabs(long long int j); unsigned long long int ullabs(long long int j); div_t div(int numer, int denom); ldiv_t ldiv(long int numer, long int denom); lldiv_t lldiv(long long int numer, long long int denom); int mblen(const char *s, size_t n); int mbtowc(wchar_t * restrict pwc, const char * restrict s, size_t n); int wctomb(char *s, wchar_t wc); size_t mbstowcs(wchar_t * restrict pwcs, const char * restrict s, size_t n); size_t wcstombs(char * restrict s, const wchar_t * restrict pwcs, size_t n); size_t memalignment(const void *p); int strfromd32(char * restrict s, size_t n, const char * restrict format, _Decimal32 fp); int strfromd64(char * restrict s, size_t n, const char * restrict format, _Decimal64 fp); int strfromd128(char * restrict s, size_t n, const char * restrict format, _Decimal128 fp); _Decimal32 strtod32(const char * restrict nptr, char ** restrict endptr); _Decimal64 strtod64(const char * restrict nptr, char ** restrict endptr); _Decimal128 strtod128(const char * restrict nptr, char ** restrict endptr); int strfromfN(char * restrict s, size_t n, const char * restrict format, _FloatN fp); int strfromfNx(char * restrict s, size_t n, const char * restrict format, _FloatNx fp); int strfromdN(char * restrict s, size_t n, const char * restrict format, _DecimalN fp); int strfromdNx(char * restrict s, size_t n, const char * restrict format, _DecimalNx fp); _FloatN strtofN(const char * restrict nptr, char ** restrict endptr); _FloatNx strtofNx(const char * restrict nptr, char ** restrict endptr); _DecimalN strtodN(const char * restrict nptr, char ** restrict endptr); _DecimalNx strtodNx(const char * restrict nptr, char ** restrict endptr); int strfromencfN(char * restrict s, size_t n, const char * restrict format, const unsigned char encptr[restrict static N/8]); int strfromencdecdN(char * restrict s, size_t n, const char * restrict format, const unsigned char encptr[restrict static N/8]); int strfromencbindN(char * restrict s, size_t n, const char * restrict format, const unsigned char encptr[restrict static N/8]); void strtoencfN(unsigned char encptr[restrict static N/8], const char * restrict nptr, char ** restrict endptr); void strtoencdecdN(unsigned char encptr[restrict static N/8], const char * restrict nptr, char ** restrict endptr); void strtoencbindN(unsigned char encptr[restrict static N/8], const char * restrict nptr, char ** restrict endptr); constraint_handler_t set_constraint_handler_s(constraint_handler_t handler); void abort_handler_s(const char * restrict msg, void * restrict ptr, errno_t error); void ignore_handler_s(const char * restrict msg, void * restrict ptr, errno_t error); errno_t getenv_s(size_t * restrict len, char * restrict value, rsize_t maxsize, const char * restrict name); QVoid *bsearch_s(const void *key, QVoid *base, rsize_t nmemb, rsize_t size, int (*compar)(const void *k, const void *y, void *context), void *context); errno_t qsort_s(void *base, rsize_t nmemb, rsize_t size, int (*compar)(const void *x, const void *y, void *context), void *context); errno_t wctomb_s(int * restrict status, char * restrict s, rsize_t smax, wchar_t wc); errno_t mbstowcs_s(size_t * restrict retval, wchar_t * restrict dst, rsize_t dstmax, const char * restrict src, rsize_t len); errno_t wcstombs_s(size_t * restrict retval, char * restrict dst, rsize_t dstmax, const wchar_t * restrict src, rsize_t len);
B.25 Text transcoding utilities <stdmchar.h>
- :
WCHAR_WIDTHWCHAR_UTF8WCHAR_UTF16WCHAR_UTF32MB_UTF8MB_UTF16MB_UTF32STDC_C8_MAXSTDC_C16_MAXSTDC_C32_MAXSTDC_MC_MAXSTDC_MWC_MAXstdc_mcerr_okstdc_mcerr_invalidstdc_mcerr_incomplete_inputstdc_mcerr_insufficient_output
stdc_mcerr stdc_mcnrtomcn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mcnrtomwcn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mcnrtoc8n(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mcnrtoc16n(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mcnrtoc32n(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcnrtomcn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcnrtomwcn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcnrtoc8n(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcnrtoc16n(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcnrtoc32n(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8nrtomcn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8nrtomwcn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8nrtoc8n(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8nrtoc16n(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8nrtoc32n(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16nrtomcn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16nrtomwcn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16nrtoc8n(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16nrtoc16n(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16nrtoc32n(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32nrtomcn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32nrtomwcn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32nrtoc8n(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32nrtoc16n(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32nrtoc32n(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mcsnrtomcsn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mcsnrtomwcsn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mcsnrtoc8sn(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mcsnrtoc16sn(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mcsnrtoc32sn(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, const char*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcsnrtomcsn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcsnrtomwcsn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcsnrtoc8sn(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcsnrtoc16sn(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_mwcsnrtoc32sn(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, wchar_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8snrtomwcsn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8snrtomcsn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8snrtoc8sn(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8snrtoc16sn(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c8snrtoc32sn(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, const char8_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16snrtomwcsn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16snrtomcsn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16snrtoc8sn(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16snrtoc16sn(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c16snrtoc32sn(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, const char16_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32snrtomcsn(size_t*restrict output_size, char*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32snrtomwcsn(size_t*restrict output_size, wchar_t*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32snrtoc8sn(size_t*restrict output_size, char8_t*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32snrtoc16sn(size_t*restrict output_size, char16_t*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state); stdc_mcerr stdc_c32snrtoc32sn(size_t*restrict output_size, char32_t*restrict *restrict output, size_t*restrict input_size, const char32_t*restrict *restrict input, mbstate_t*restrict state);
B.26 _Noreturn <stdnoreturn.h>
B.27 String handling <string.h>
void *memcpy(void * restrict s1, const void * restrict s2, size_t n); void *memccpy(void * restrict s1, const void * restrict s2, int c, size_t n); void *memmove(void *s1, const void *s2, size_t n); char *strcpy(char * restrict s1, const char * restrict s2); char *strncpy(char * restrict s1, const char * restrict s2, size_t n); char *strdup(const char *s); char *strndup(const char *s, size_t n); char *strcat(char * restrict s1, const char * restrict s2); char *strncat(char * restrict s1, const char * restrict s2, size_t n); int memcmp(const void *s1, const void *s2, size_t n); int strcmp(const char *s1, const char *s2); int strcoll(const char *s1, const char *s2); int strncmp(const char *s1, const char *s2, size_t n); size_t strxfrm(char * restrict s1, const char * restrict s2, size_t n); QVoid *memchr(QVoid *s, int c, size_t n); QChar *strchr(QChar *s, int c); size_t strcspn(const char *s1, const char *s2); QChar *strpbrk(QChar *s1, const char *s2); QChar *strrchr(QChar *s, int c); size_t strspn(const char *s1, const char *s2); QChar *strstr(QChar *s1, const char *s2); char *strtok(char * restrict s1, const char * restrict s2); void *memset(void *s, int c, size_t n); void *memset_explicit(void *s, int c, size_t n); char *strerror(int errnum); size_t strlen(const char *s); size_t strnlen(const char *s, size_t n); errno_t memcpy_s(void * restrict s1, rsize_t s1max, const void * restrict s2, rsize_t n); errno_t memmove_s(void *s1, rsize_t s1max, const void *s2, rsize_t n); errno_t strcpy_s(char * restrict s1, rsize_t s1max, const char * restrict s2); errno_t strncpy_s(char * restrict s1, rsize_t s1max, const char * restrict s2, rsize_t n); errno_t strcat_s(char * restrict s1, rsize_t s1max, const char * restrict s2); errno_t strncat_s(char * restrict s1, rsize_t s1max, const char * restrict s2, rsize_t n); char *strtok_s(char * restrict s1, rsize_t * restrict s1max, const char * restrict s2, char ** restrict ptr); errno_t memset_s(void *s, rsize_t smax, int c, rsize_t n) errno_t strerror_s(char *s, rsize_t maxsize, errno_t errnum); size_t strerrorlen_s(errno_t errnum); size_t strnlen_s(const char *s, size_t maxsize);
B.28 Type-generic math <tgmath.h>
- :
sintancoshsinhtanhexplogpowsqrtfabsacospiasinpiatan2piatan2atanpicbrtceilcompoundncopysigncospierfcerfexp10m1exp10exp2m1exp2expm1fdimfromfpxfromfphypotilogbldexplgammallogbllrintllroundlog10p1log10log1plog2p1log2logblogp1lrintlroundnearbyintnextafternextdownnexttowardnextuppownpowrremainderremquorintrootnroundevenroundrsqrtscalblnscalbnsinpitanpitgammatruncufromfpxufromfpfadddaddfsubdsubfmuldmulfdivddivffmadfmafsqrtdsqrtd64subd32muld64muld32divd64divd32fmad64fmad32sqrtd64sqrtquantizesamequantumquantumllquantexpfMsubfMxsubdMsubdMxsubfMmulfMxmuldMmuldMxmulfMdivfMxdivdMdivdMxdivfMfmafMxfmadMfmadMxfmafMsqrtfMxsqrtdMsqrtdMxsqrt
B.29 Threads <threads.h>
- :
mtx_ttss_dtor_tthrd_start_tonce_flagmtx_plainmtx_recursivemtx_timedthrd_timedoutthrd_successthrd_busythrd_errorthrd_nomem
void call_once(once_flag *flag, void (*func)(void)); int cnd_broadcast(cnd_t *cond); void cnd_destroy(cnd_t *cond); int cnd_init(cnd_t *cond); int cnd_signal(cnd_t *cond); int cnd_timedwait(cnd_t * restrict cond, mtx_t * restrict mtx, const struct timespec * restrict ts); int cnd_wait(cnd_t *cond, mtx_t *mtx); void mtx_destroy(mtx_t *mtx); int mtx_init(mtx_t *mtx, int type); int mtx_lock(mtx_t *mtx); int mtx_timedlock(mtx_t * restrict mtx, const struct timespec * restrict ts); int mtx_trylock(mtx_t *mtx); int mtx_unlock(mtx_t *mtx); int thrd_create(thrd_t *thr, thrd_start_t func, void *arg); thrd_t thrd_current(void); int thrd_detach(thrd_t thr); int thrd_equal(thrd_t thr0, thrd_t thr1); [[noreturn]] void thrd_exit(int res); int thrd_join(thrd_t thr, int *res); int thrd_sleep(const struct timespec *duration, struct timespec *remaining); void thrd_yield(void); int tss_create(tss_t *key, tss_dtor_t dtor); void tss_delete(tss_t key); void *tss_get(tss_t key); int tss_set(tss_t key, void *val);
B.30 Date and time <time.h>
- :
TIME_UTCsize_tclock_ttime_tstructtimespecstructtm
clock_t clock(void); double difftime(time_t time1, time_t time0); time_t mktime(struct tm *timeptr); time_t timegm(struct tm *timeptr); time_t time(time_t *timer); int timespec_get(struct timespec *ts, int base); int timespec_getres(struct timespec *ts, int base); [[deprecated]] char *asctime(const struct tm *timeptr); [[deprecated]] char *ctime(const time_t *timer); struct tm *gmtime(const time_t *timer); struct tm *gmtime_r(const time_t *timer, struct tm *buf); struct tm *localtime(const time_t *timer); struct tm *localtime_r(const time_t *timer, struct tm *buf); size_t strftime(char * restrict s, size_t maxsize, const char * restrict format, const struct tm * restrict timeptr); errno_t asctime_s(char *s, rsize_t maxsize, const struct tm *timeptr); errno_t ctime_s(char *s, rsize_t maxsize, const time_t *timer); struct tm *gmtime_s(const time_t * restrict timer, struct tm * restrict result); struct tm *localtime_s(const time_t * restrict timer, struct tm * restrict result);
B.31 Unicode utilities <uchar.h>
size_t mbrtoc8(char8_t * restrict pc8, const char * restrict s, size_t n, mbstate_t * restrict ps); size_t c8rtomb(char * restrict s, char8_t c8, mbstate_t * restrict ps); size_t mbrtoc16(char16_t * restrict pc16, const char * restrict s, size_t n, mbstate_t * restrict ps); size_t c16rtomb(char * restrict s, char16_t c16, mbstate_t * restrict ps); size_t mbrtoc32(char32_t * restrict pc32, const char * restrict s, size_t n, mbstate_t * restrict ps); size_t c32rtomb(char * restrict s, char32_t c32, mbstate_t * restrict ps);
B.32 Extended multibyte/wide character utilities <wchar.h>
- :
structtmNULLWCHAR_MAXWCHAR_MINWCHAR_WIDTHWCHAR_UTF8WCHAR_UTF16WCHAR_UTF32MB_UTF8MB_UTF16MB_UTF32WEOF
int fwprintf(FILE * restrict stream, const wchar_t * restrict format, ...); int fwscanf(FILE * restrict stream, const wchar_t * restrict format, ...); int swprintf(wchar_t * restrict s, size_t n, const wchar_t * restrict format, ...); int swscanf(const wchar_t * restrict s, const wchar_t * restrict format, ...); int vfwprintf(FILE * restrict stream, const wchar_t * restrict format, va_list arg); int vfwscanf(FILE * restrict stream, const wchar_t * restrict format, va_list arg); int vswprintf(wchar_t * restrict s, size_t n, const wchar_t * restrict format, va_list arg); int vswscanf(const wchar_t * restrict s, const wchar_t * restrict format, va_list arg); int vwprintf(const wchar_t * restrict format, va_list arg); int vwscanf(const wchar_t * restrict format, va_list arg); int wprintf(const wchar_t * restrict format, ...); int wscanf(const wchar_t * restrict format, ...); wint_t fgetwc(FILE *stream); wchar_t *fgetws(wchar_t * restrict s, int n, FILE * restrict stream); wint_t fputwc(wchar_t c, FILE *stream); int fputws(const wchar_t * restrict s, FILE * restrict stream); int fwide(FILE *stream, int mode); wint_t getwc(FILE *stream); wint_t getwchar(void); wint_t putwc(wchar_t c, FILE *stream); wint_t putwchar(wchar_t c); wint_t ungetwc(wint_t c, FILE *stream); double wcstod(const wchar_t * restrict nptr, wchar_t ** restrict endptr); float wcstof(const wchar_t * restrict nptr, wchar_t ** restrict endptr); long double wcstold(const wchar_t * restrict nptr, wchar_t ** restrict endptr); long int wcstol(const wchar_t * restrict nptr, wchar_t ** restrict endptr, int base); long long int wcstoll(const wchar_t * restrict nptr, wchar_t ** restrict endptr, int base); unsigned long int wcstoul(const wchar_t * restrict nptr, wchar_t ** restrict endptr, int base); unsigned long long int wcstoull(const wchar_t * restrict nptr, wchar_t ** restrict endptr, int base); wchar_t *wcscpy(wchar_t * restrict s1, const wchar_t * restrict s2); wchar_t *wcsncpy(wchar_t * restrict s1, const wchar_t * restrict s2, size_t n); wchar_t *wmemcpy(wchar_t * restrict s1, const wchar_t * restrict s2, size_t n); wchar_t *wmemmove(wchar_t *s1, const wchar_t *s2, size_t n); wchar_t *wcscat(wchar_t * restrict s1, const wchar_t * restrict s2); wchar_t *wcsncat(wchar_t * restrict s1, const wchar_t * restrict s2, size_t n); int wcscmp(const wchar_t *s1, const wchar_t *s2); int wcscoll(const wchar_t *s1, const wchar_t *s2); int wcsncmp(const wchar_t *s1, const wchar_t *s2, size_t n); size_t wcsxfrm(wchar_t * restrict s1, const wchar_t * restrict s2, size_t n); int wmemcmp(const wchar_t *s1, const wchar_t *s2, size_t n); QWchar_t *wcschr(QWchar_t *s, wchar_t c); size_t wcscspn(const wchar_t *s1, const wchar_t *s2); QWchar_t *wcspbrk(QWchar_t *s1, const wchar_t *s2); QWchar_t *wcsrchr(QWchar_t *s, wchar_t c); size_t wcsspn(const wchar_t *s1, const wchar_t *s2); QWchar_t *wcsstr(QWchar_t *s1, const wchar_t *s2); wchar_t *wcstok(wchar_t * restrict s1, const wchar_t * restrict s2, wchar_t ** restrict ptr); QWchar_t *wmemchr(QWchar_t *s, wchar_t c, size_t n); size_t wcslen(const wchar_t *s); size_t wcsnlen(const wchar_t *s, size_t n); wchar_t *wmemset(wchar_t *s, wchar_t c, size_t n); size_t wcsftime(wchar_t * restrict s, size_t maxsize, const wchar_t * restrict format, const struct tm * restrict timeptr); wint_t btowc(int c); int wctob(wint_t c); int mbsinit(const mbstate_t *ps); size_t mbrlen(const char * restrict s, size_t n, mbstate_t * restrict ps); size_t mbrtowc(wchar_t * restrict pwc, const char * restrict s, size_t n, mbstate_t * restrict ps); size_t wcrtomb(char * restrict s, wchar_t wc, mbstate_t * restrict ps); size_t mbsrtowcs(wchar_t * restrict dst, const char ** restrict src, size_t len, mbstate_t * restrict ps); size_t wcsrtombs(char * restrict dst, const wchar_t ** restrict src, size_t len, mbstate_t * restrict ps); _Decimal32 wcstod32(const wchar_t * restrict nptr, wchar_t ** restrict endptr); _Decimal64 wcstod64(const wchar_t * restrict nptr, wchar_t ** restrict endptr); _Decimal128 wcstod128(const wchar_t * restrict nptr, wchar_t ** restrict endptr); _FloatN wcstofN(const wchar_t * restrict nptr, wchar_t ** restrict endptr); _FloatNx wcstofNx(const wchar_t * restrict nptr, wchar_t ** restrict endptr); _DecimalN wcstodN(const wchar_t * restrict nptr, wchar_t ** restrict endptr); _DecimalNx wcstodNx(const wchar_t * restrict nptr, wchar_t ** restrict endptr); void wcstoencfN(unsigned char encptr[restrict static N/8], const wchar_t * restrict nptr, wchar_t ** restrict endptr); void wcstoencdecdN(unsigned char encptr[restrict static N/8], const wchar_t * restrict nptr, wchar_t ** restrict endptr); void wcstoencbindN(unsigned char encptr[restrict static N/8], const wchar_t * restrict nptr, wchar_t ** restrict endptr); int fwprintf_s(FILE * restrict stream, const wchar_t * restrict format, ...); int fwscanf_s(FILE * restrict stream, const wchar_t * restrict format, ...); int snwprintf_s(wchar_t * restrict s, rsize_t n, const wchar_t * restrict format, ...); int swprintf_s(wchar_t * restrict s, rsize_t n, const wchar_t * restrict format, ...); int swscanf_s(const wchar_t * restrict s, const wchar_t * restrict format, ...); int vfwprintf_s(FILE * restrict stream, const wchar_t * restrict format, va_list arg); int vfwscanf_s(FILE * restrict stream, const wchar_t * restrict format, va_list arg); int vsnwprintf_s(wchar_t * restrict s, rsize_t n, const wchar_t * restrict format, va_list arg); int vswprintf_s(wchar_t * restrict s, rsize_t n, const wchar_t * restrict format, va_list arg); int vswscanf_s(const wchar_t * restrict s, const wchar_t * restrict format, va_list arg); int vwprintf_s(const wchar_t * restrict format, va_list arg); int vwscanf_s(const wchar_t * restrict format, va_list arg); int wprintf_s(const wchar_t * restrict format, ...); int wscanf_s(const wchar_t * restrict format, ...); errno_t wcscpy_s(wchar_t * restrict s1, rsize_t s1max, const wchar_t * restrict s2); errno_t wcsncpy_s(wchar_t * restrict s1, rsize_t s1max, const wchar_t * restrict s2, rsize_t n); errno_t wmemcpy_s(wchar_t * restrict s1, rsize_t s1max, const wchar_t * restrict s2, rsize_t n); errno_t wmemmove_s(wchar_t *s1, rsize_t s1max, const wchar_t *s2, rsize_t n); errno_t wcscat_s(wchar_t * restrict s1, rsize_t s1max, const wchar_t * restrict s2); errno_t wcsncat_s(wchar_t * restrict s1, rsize_t s1max, const wchar_t * restrict s2, rsize_t n); wchar_t *wcstok_s(wchar_t * restrict s1, rsize_t * restrict s1max, const wchar_t * restrict s2, wchar_t ** restrict ptr); size_t wcsnlen_s(const wchar_t *s, size_t maxsize); errno_t wcrtomb_s(size_t * restrict retval, char * restrict s, rsize_t smax, wchar_t wc, mbstate_t * restrict ps); errno_t mbsrtowcs_s(size_t * restrict retval, wchar_t * restrict dst, rsize_t dstmax, const char ** restrict src, rsize_t len, mbstate_t * restrict ps); errno_t wcsrtombs_s(size_t * restrict retval, char * restrict dst, rsize_t dstmax, const wchar_t ** restrict src, rsize_t len, mbstate_t * restrict ps);
B.33 Wide character classification and mapping utilities <wctype.h>
int iswalnum(wint_t wc); int iswalpha(wint_t wc); int iswblank(wint_t wc); int iswcntrl(wint_t wc); int iswdigit(wint_t wc); int iswgraph(wint_t wc); int iswlower(wint_t wc); int iswprint(wint_t wc); int iswpunct(wint_t wc); int iswspace(wint_t wc); int iswupper(wint_t wc); int iswxdigit(wint_t wc); int iswctype(wint_t wc, wctype_t desc); wctype_t wctype(const char *property); wint_t towlower(wint_t wc); wint_t towupper(wint_t wc); wint_t towctrans(wint_t wc, wctrans_t desc); wctrans_t wctrans(const char *property);
C Sequence points
C.1 Known Sequence Points
The following are the sequence points described in 5.2.2.4:
- Between the evaluations of the function designator and actual arguments in a function call and the actual call. (6.5.3.3).
- Between the evaluations of the first and second operands of the following operators: logical AND
&&(6.5.14); logical OR||(6.5.15); comma,(6.5.18). - Between the evaluations of the first operand of the conditional
?:operator and whichever of the second and third operands is evaluated (6.5.16). - Between the evaluation of a full expression and the next full expression to be evaluated. The following are full expressions: a full declarator for a variably modified type; an initializer that is not part of a compound literal (6.7.11); the expression in an expression statement (6.8.4); the controlling expression of a selection statement (
iforswitch) (6.8.5); the controlling expression of awhileordostatement (6.8.6); each of the (optional) expressions of aforstatement (6.8.6.4); the (optional) expression in areturnstatement (6.8.7.5). - Immediately before a library function returns (7.1.4).
- After the actions associated with each formatted input/output function conversion specifier (7.24.6, 7.33.2).
- Immediately before and immediately after each call to a comparison function, and also between any call to a comparison function and any movement of the objects passed as arguments to that call (7.25.6).
D Universal character names for identifiers
D.1 Introduction
This subclause describes the choices made in application of UAX #31 ("Unicode Identifier and Pattern Syntax") to C of the requirements from UAX #31 and how they do or do not apply to C. For UAX #31, C conforms by meeting the requirements "Default Identifiers" (D.2) and "Equivalent Normalized Identifiers" (D.2). The other requirements, also listed in the following subclauses, are either alternatives not taken or do not apply to C.
D.2 Default Identifiers
D.2.1 General
UAX #31 specifies a default syntax for identifiers based on properties from the Unicode Character Database, UAX #44. The general syntax is
<Identifier> := <Start> <Continue>* (<Medial> <Continue>+)*
where <Start> has the XID_Start property, <Continue> has the XID_Continue property, and <Medial> is a list of characters permitted between continue characters. For C we add the character _ (U+005F, LOW LINE) to the set of permitted Start characters, the Medial set is empty, and the Continue characters are unmodified. In the grammar used in UAX #31, this is
<Identifier> := <Start> <Continue>* <Start> := XID_Start + U+005F <Continue> := <Start> + XID_Continue
Additionally, implementations may add the character $ (U+0024, DOLLAR SIGN) to the set of permitted Start and Continue characters. This is described in the C grammar (6.4.3.1), where identifier is formed from identifier-start or identifier followed by identifier-continue.
D.2.2 Restricted Format Characters
If an implementation of UAX #31 wishes to allow format characters such as ZERO WIDTH JOINER or ZERO WIDTH NON-JOINER it shall define a profile allowing them, or describe precisely which combinations are permitted.
C does not allow format characters in identifiers, so this does not apply.
D.2.3 Stable Identifiers
An implementation of UAX #31 may choose to guarantee that identifiers are stable across versions of the Unicode Standard. Once a string qualifies as an identifier it does so in all future versions. C does not make this guarantee, except to the extent that UAX #31 guarantees the stability of the XID_Start and XID_Continue properties.
D.3 Immutable Identifiers
An implementation may choose to guarantee that the set of identifiers will never change by fixing the set of code points allowed in identifiers forever.
C does not choose to make this guarantee. As scripts are added to Unicode, additional characters in those scripts may become available for use in identifiers.
D.4 Pattern_White_Space and Pattern_Syntax Characters
UAX #31 describes how languages that use or interpret patterns of characters, such as regular expressions or number formats, may describe that syntax with Unicode properties.
C does not do this as part of the language, deferring to library components for such usage of patterns. This requirement does not apply to C.
D.5 Equivalent Normalized Identifiers
UAX #31 requires that implementations describe how identifiers are compared and considered equivalent.
C requires that identifiers be in Normalization Form C and therefore identifiers that compare the same under NFC are equivalent. This is described in 6.4.3.
D.6 Equivalent Case-Insensitive Identifiers
C considers case to be significant in identifier comparison, and does not do any case folding. This requirement does not apply to C
D.7 Filtered Normalized Identifiers
If any characters are excluded from normalization, UAX #31 requires a precise specification of those exclusions.
C does not make any such exclusions.
D.8 Filtered Case-Insensitive Identifiers
C identifiers are case sensitive, and therefore this requirement does not apply.
D.9 Hashtag Identifiers
There are no hashtags in C, so this requirement does not apply.
E Implementation limits
E.1 Introduction
The contents of the header <limits.h> are given in the following subclauses. The values shall all be constant expressions suitable for use in conditional expression inclusion preprocessing directives. The components are described further in 5.3.5.3.2.
E.2 Minimum values
For the following macros, the minimum values shown shall be replaced by implementation-defined values.
#define BOOL_WIDTH 1 // exact value #define CHAR_BIT 8 #define USHRT_WIDTH 16 #define UINT_WIDTH 16 #define ULONG_WIDTH 32 #define ULLONG_WIDTH 64 #define BITINT_MAXWIDTH ULLONG_WIDTH // at minimum as large // as unsigned long long #define MB_LEN_MAX 1
For the following macros, the minimum magnitudes shown shall be replaced by implementationdefined magnitudes with the same sign that are deduced from the prior macros as indicated.432)
_ 2BOOL_WIDTH − 1 #define BOOL MAX 1 // #define CHAR_MAX UCHAR_MAX or SCHAR_MAX #define CHAR_MIN 0 or SCHAR_MIN #define CHAR_WIDTH 8 // CHAR_BIT _ 2UCHAR_WIDTH − 1 #define UCHAR MAX 255 // #define UCHAR_WIDTH 8 // CHAR_BIT _ 2USHRT_WIDTH − 1 #define USHRT MAX 65535 // _ 2SCHAR_WIDTH-1 − 1 #define SCHAR MAX +127 // #define SCHAR_MIN -128 // − 2SCHAR_WIDTH-1 #define SCHAR_WIDTH 8 // CHAR_BIT _ 2SHRT_WIDTH-1 − 1 #define SHRT MAX +32767 // #define SHRT_MIN -32768 // − 2SHRT_WIDTH-1 #define SHRT_WIDTH 16 // USHRT_WIDTH _ 2INT_WIDTH-1 − 1 #define INT MAX +32767 // #define INT_MIN -32768 // − 2INT_WIDTH-1 #define INT_WIDTH 16 // UINT_WIDTH _ 2UINT_WIDTH − 1 #define UINT MAX 65535 // _ 2LONG_WIDTH-1 − 1 #define LONG MAX +2147483647 // #define LONG_MIN -2147483648 // − 2LONG_WIDTH-1 #define LONG_WIDTH 32 // ULONG_WIDTH _ 2LLONG_WIDTH-1 − 1 #define LLONG MAX +9223372036854775807 // #define LLONG_MIN -9223372036854775808 // − 2LLONG_WIDTH-1 #define LLONG_WIDTH 64 // ULLONG_WIDTH _ 2ULONG_WIDTH − 1 #define ULONG MAX 4294967295 // _ 2ULLONG_WIDTH − 1 #define ULLONG MAX 18446744073709551615 //
The contents of the header <float.h> are given in the following subclauses. All integer values, except FLT_ROUNDS, shall be constant expressions suitable for use in #if preprocessing directives;
The values given in the following list shall be replaced by implementation-defined expressions:
#define FLT_EVAL_METHOD #define FLT_ROUNDS #ifdef __STDC_IEC_60559_DFP__ #define DEC_EVAL_METHOD #endif
The values given in the following list shall be replaced by implementation-defined constant expressions that are greater or equal in magnitude (absolute value) to those shown, with the same sign:
#define DBL_DECIMAL_DIG 10 #define DBL_DIG 10 #define DBL_MANT_DIG #define DBL_MAX_10_EXP +37 #define DBL_MAX_EXP #define DBL_MIN_10_EXP -37 #define DBL_MIN_EXP #define DECIMAL_DIG 10 #define FLT_DECIMAL_DIG 6 #define FLT_DIG 6 #define FLT_MANT_DIG #define FLT_MAX_10_EXP +37 #define FLT_MAX_EXP #define FLT_MIN_10_EXP -37 #define FLT_MIN_EXP #define FLT_RADIX 2 #define LDBL_DECIMAL_DIG 10 #define LDBL_DIG 10 #define LDBL_MANT_DIG #define LDBL_MAX_10_EXP +37 #define LDBL_MAX_EXP #define LDBL_MIN_10_EXP -37 #define LDBL_MIN_EXP
The values given in the following list shall be replaced by implementation-defined constant expressions with values that are greater than or equal to those shown:
#define DBL_MAX 1E+37 #define DBL_NORM_MAX 1E+37 #define FLT_MAX 1E+37 #define FLT_NORM_MAX 1E+37 #define LDBL_MAX 1E+37 #define LDBL_NORM_MAX 1E+37
The values given in the following list shall be replaced by implementation-defined constant expressions with (positive) values that are less than or equal to those shown:
#define DBL_EPSILON 1E-9 #define DBL_MIN 1E-37 #define FLT_EPSILON 1E-5 #define FLT_MIN 1E-37 #define LDBL_EPSILON 1E-9 #define LDBL_MIN 1E-37
If the implementation supports decimal floating types, the following macros provide the parameters of these types as exact values.
#ifdef __STDC_IEC_60559_DFP__ #define DEC32_EPSILON 1E-6DF #define DEC32_MANT_DIG 7 #define DEC32_MAX 9.999999E96DF #define DEC32_MAX_EXP 97 #define DEC32_MIN 1E-95DF #define DEC32_MIN_EXP -94 #define DEC32_TRUE_MIN 0.000001E-95DF #define DEC64_EPSILON 1E-15DD #define DEC64_MANT_DIG 16 #define DEC64_MAX 9.999999999999999E384DD #define DEC64_MAX_EXP 385 #define DEC64_MIN 1E-383DD #define DEC64_MIN_EXP -382 #define DEC64_TRUE_MIN 0.000000000000001E-383DD #define DEC128_EPSILON 1E-33DL #define DEC128_MANT_DIG 34 #define DEC128_MAX 9.999999999999999999999999999999999E6144DL #define DEC128_MAX_EXP 6145 #define DEC128_MIN 1E-6143DL #define DEC128_MIN_EXP -6142 #define DEC128_TRUE_MIN 0.000000000000000000000000000000001E-6143DL #endif
F ISO/IEC 60559 floating-point arithmetic
F.1 Introduction
This annex specifies C language support for the ISO/IEC 60559 floating-point standard. The ISO/IEC 60559 floating-point standard is specifically Floating-point arithmetic (ISO/IEC 60559:2020), also designated as IEEE Standard for Floating-Point Arithmetic (IEEE 754–2019). ISO/IEC 60559 generally refers to the floating-point standard, as in ISO/IEC 60559 operation, ISO/IEC 60559 format, etc.
The ISO/IEC 60559 floating-point standard is a minor upgrade to ISO/IEC/IEEE 60559:2011 (IEEE 754-2008). ISO/IEC/IEEE 60559:2011 was a major upgrade to IEC 60559:1989 (IEEE 754–1985), specifying decimal as well as binary floating-point arithmetic.
An implementation that defines __STDC_IEC_60559_BFP__ to 202ymmL shall conform to the specifications in this annex for binary floating-point arithmetic and shall also define __STDC_IEC_559__ to 1.433)
An implementation that defines __STDC_IEC_60559_DFP__ to 202ymmL shall conform to the specifications for decimal floating-point arithmetic in the following subclauses of this annex:
— F.2.2 Infinities and NaNs — F.3 Operations — F.4 Floating to integer conversions — F.6 The return statement — F.7 Contracted expressions — F.8 Floating-point environment — F.9 Optimization — F.10 Mathematics <math.h> and <tgmath.h>
For the purpose of specifying these conformance requirements, the macros, functions, and values mentioned in the subclauses listed prior are understood to refer to the corresponding macros, functions, and values for decimal floating types. Likewise, the "rounding direction mode" is understood to refer to the rounding direction mode for decimal floating-point arithmetic.
Where a binding between the C language and ISO/IEC 60559 is indicated, the ISO/IEC 60559specified behavior is adopted by reference, unless stated otherwise.
F.2 Types
F.2.1 General
The C floating types match the ISO/IEC 60559 formats as follows:
- The
floattype matches the ISO/IEC 60559 binary32 format. - The
doubletype matches the ISO/IEC 60559 binary64 format. - The
long doubletype matches the ISO/IEC 60559 binary128 format, else an ISO/IEC 60559 binary64-extended format,434) else a non-ISO/IEC 60559 extended format, else the ISO/IEC 60559 binary64 format.
Any non-ISO/IEC 60559 extended format used for the long double type shall have more precision than ISO/IEC 60559 binary64 and at least the range of ISO/IEC 60559 binary64.435) The value
Recommended practice
The long double type should match the ISO/IEC 60559 binary128 format, else an ISO/IEC 60559 binary64-extended format.
F.2.2 Infinities and NaNs
As negative and positive infinity are representable in ISO/IEC 60559 formats, all real numbers lie within the range of representable values (5.3.5.3.3).
The NAN and INFINITY macros in <float.h> and the nan functions in <math.h> provide designations for ISO/IEC 60559 quiet NaNs and infinities. The FLT_SNAN, DBL_SNAN, and LDBL_SNAN macros in <float.h> provide designations for ISO/IEC 60559 signaling NaNs.
This annex does not require the full support for signaling NaNs specified in ISO/IEC 60559. This annex uses the term NaN, unless explicitly qualified, to denote quiet NaNs. Where specification of signaling NaNs is not provided, the behavior of signaling NaNs is implementation-defined (either treated as an ISO/IEC 60559 quiet NaN or treated as an ISO/IEC 60559 signaling NaN).436)
Any operator or <math.h> function that raises an "invalid" floating-point exception, if delivering a floating type result, shall return a quiet NaN, unless explicitly specified otherwise.
To support signaling NaNs as specified in ISO/IEC 60559, an implementation should adhere to the following recommended practice.
Recommended practice
Any floating-point operator or <math.h> function or macro with a signaling NaN input, unless explicitly specified otherwise, raises an "invalid" floating-point exception.
NOTE Some functions do not propagate quiet NaN arguments. For example, hypot(x, y) returns infinity if x or y is infinite and the other is a quiet NaN. The recommended practice in this subclause specifies that such functions (and others) raise the "invalid" floating-point exception if an argument is a signaling NaN, which also implies they return a quiet NaN in these cases.
The <fenv.h> header defines the macro FE_SNANS_ALWAYS_SIGNAL if and only if the implementation follows the recommended practice in this subclause. If defined, FE_SNANS_ALWAYS_SIGNAL expands to the integer literal 1.
F.3 Operations
C operators, functions, and function-like macros provide operations specified by ISO/IEC 60559 as shown in Table F.2. In the table, C functions are represented by the function name without a type suffix. Specifications for the C facilities are provided in the listed clauses. The C specifications are intended to match ISO/IEC 60559, unless stated otherwise.
Table F.2 — Operation binding — mathematical operations
ISO/IEC 60559 operation C operation Clause roundToIntegralTiesToEven roundeven 7.12.10.8, F.10.7.8 roundToIntegralTiesAway round 7.12.10.6, F.10.7.6 roundToIntegralTowardZero trunc 7.12.10.9, F.10.7.9 roundToIntegralTowardPositive ceil 7.12.10.1, F.10.7.1 roundToIntegralTowardNegative floor 7.12.10.2, F.10.7.2 roundToIntegralExact rint 7.12.10.4, F.10.7.4 nextUp nextup 7.12.12.5, F.10.9.5 nextDown nextdown 7.12.12.6, F.10.9.6 getPayload getpayload F.10.14.2
The ISO/IEC 60559 requirement that certain of its operations be provided for operands of different formats (of the same radix) is satisfied by C’s usual arithmetic conversions (6.3.2.8) and function-call argument conversions (6.5.3.3). For example, the following operations take float f and double d inputs and produce a long double result:
(long double)f * d powl(f, d)
The functions fmin and fmax have been superseded by fminimum_num and fmaximum_num. The fmin and fmax functions provide the minNum and maxNum operations specified in (the superseded) ISO/IEC/IEEE 60559:2011.
Whether C assignment (6.5.17) (and conversion as if by assignment) to the same format is an ISO/IEC 60559 convertFormat or copy operation437) is implementation-defined, even if <fenv.h> defines the macro FE_SNANS_ALWAYS_SIGNAL (F.2.2). If the return expression of a return statement is evaluated to the floating-point format of the return type, it is implementation-defined whether a convertFormat operation is applied to the result of the return expression.
The unary + and - operators raise no floating-point exceptions, even if the operand is a signaling NaN.
The C classification macros fpclassify, iscanonical, isfinite, isinf, isnan, isnormal, issignaling, issubnormal, iszero, and signbit provide the ISO/IEC 60559 operations indicated in Table F.2 provided their arguments are in the format of their semantic type. Then these macros raise no floating-point exceptions, even if an argument is a signaling NaN.
The signbit macro, providing the ISO/IEC 60559 isSignMinus operation, determines the sign of its argument value as the sign bit of the value’s representation. This applies to all values, including NaNs whose sign bit is not generally interpreted by ISO/IEC 60559.
The C nearbyint functions (7.12.10.3, F.10.7.3) provide the nearbyinteger function recommended in the Appendix to (superseded) ANSI/IEEE 854–1987.
The C nextafter (7.12.12.3, F.10.9.3) and nexttoward (7.12.12.4, F.10.9.4) functions provide the nextafter function recommended in the Appendix to (superseded) IEC 60559:1989 (but with a minor change to better handle signed zeros).
The macros (7.6) FE_DOWNWARD, FE_TONEAREST, FE_TONEARESTFROMZERO, FE_TOWARDZERO, and FE_UPWARD, which are used in conjunction with the fegetround and fesetround functions and the FENV_ROUND pragma, represent the ISO/IEC 60559 rounding-direction attributes roundTowardNegative, roundTiesToEven, roundTiesToAway, roundTowardZero, and roundTowardPositive, respectively, for binary floating-point arithmetic. Support for the roundTiesToAway attribute for binary floating-point arithmetic, and hence for the FE_TONEARESTFROMZERO macro, is optional.
The C fegetenv (7.6.7.2), feholdexcept (7.6.7.3), fesetenv (7.6.7.4) and feupdateenv (7.6.7.5) functions provide a facility to manage the dynamic floating-point environment, comprising the ISO/IEC 60559 status flags and dynamic control modes.
ISO/IEC 60559 requires operations with specified operand and result formats. Therefore, math functions that are bound to ISO/IEC 60559 operations (see Table F.2) shall remove any extra range and precision from arguments or results.
ISO/IEC 60559 requires operations that round their result to formats the same as and wider than the operands, in addition to the operations that round their result to narrower formats (see 7.12.15). Operators (+, -, *, and /) whose evaluation formats are wider than the semantic type (5.3.5.3.3)
Decimal versions of the remquo library function are not provided. (The decimal remainder functions provide the remainder operation defined by ISO/IEC 60559.)
The binding for the convertFormat operation applies to all conversions among ISO/IEC 60559 formats. Therefore, for implementations that conform to this annex, conversions between decimal floating types and standard floating types with ISO/IEC 60559 formats are correctly rounded and raise floating-point exceptions as specified in ISO/IEC 60559.
ISO/IEC 60559 specifies the convertFromHexCharacter and convertToHexCharacter operations only for binary floating-point arithmetic.
The integer literal 10 provides the radix operation defined in ISO/IEC 60559 for decimal floatingpoint arithmetic.
The fe_dec_getround (7.6.6.4) and fe_dec_setround (7.6.6.7) functions provide the getDecimalRoundingDirection and setDecimalRoundingDirection operations defined in ISO/IEC 60559 for decimal floating-point arithmetic. The macros (7.6) FE_DEC_DOWNWARD, FE_DEC_TONEAREST, FE_DEC_TONEARESTFROMZERO, FE_DEC_TOWARDZERO, and FE_DEC_UPWARD, which are used in conjunction with the fe_dec_getround and fe_dec_setround functions and the FENV_DEC_ROUND pragma, represent the ISO/IEC 60559 rounding-direction attributes roundTowardNegative, roundTiesToEven, roundTiesToAway, roundTowardZero, and roundTowardPositive, respectively, for decimal floating-point arithmetic.
The llquantexpdN (7.12.16.4) functions compute the (quantum) exponent defined in ISO/IEC 60559 for decimal numbers viewed as having integer significands.
The C functions in Table F.3 correspond to mathematical operations recommended by ISO/IEC 60559. However, correct rounding, which ISO/IEC 60559 specifies for its operations, is not required for the C functions in the table. 7.35.9 (potentially) reserves cr_ prefixed names for functions fully matching the ISO/IEC 60559 mathematical operations. In the table, the C functions are represented by the function name without a type suffix.
Table F.3 — ISO/IEC 60559 operation to C function
ISO/IEC 60559 operation C function Clause exp exp 7.12.7.1, F.10.4.1 expm1 expm1 7.12.7.6, F.10.4.6 exp2 exp2 7.12.7.4, F.10.4.4 exp2m1 exp2m1 7.12.7.5, F.10.4.5 exp10 exp10 7.12.7.2, F.10.4.2 exp10m1 exp10m1 7.12.7.3, F.10.4.3 log log 7.12.7.11, F.10.4.11 log2 log2 7.12.7.15, F.10.4.15 log10 log10 7.12.7.12, F.10.4.12 logp1 log1p, logp1 7.12.7.14, F.10.4.14 log2p1 log2p1 7.12.7.16, F.10.4.16 log10p1 log10p1 7.12.7.13, F.10.4.13 hypot hypot 7.12.8.4, F.10.5.4 rSqrt rsqrt 7.12.8.9, F.10.5.9 compound compoundn 7.12.8.2, F.10.5.2 rootn rootn 7.12.8.8, F.10.5.8
F.4 Floating to integer conversion
If the integer type is bool, 6.3.2.2 applies and the conversion raises no floating-point exceptions if the floating-point value is not a signaling NaN. Otherwise, if the floating value is infinite or NaN or if the integral part of the floating value exceeds the range of the integer type, then the "invalid" floating-point exception is raised and the resulting value is unspecified. Otherwise, the resulting value is determined by 6.3.2.4. Conversion of an integral floating value that does not exceed the range of the integer type raises no floating-point exceptions; whether conversion of a non-integral floating value raises the "inexact" floating-point exception is unspecified.438)
F.5 Conversions between binary floating types and decimal character sequences
The <float.h> header defines the macro
CR_DECIMAL_DIGif and only if __STDC_WANT_IEC_60559_EXT__ is defined as a macro at the point in the source file where <float.h> is first included. If defined, CR_DECIMAL_DIG expands to an integer constant expression suitable for use in conditional expression inclusion preprocessing directives whose value is a number such that conversions between all supported ISO/IEC 60559 binary formats and character sequences with at most CR_DECIMAL_DIG significant decimal digits are correctly rounded. The value of CR_DECIMAL_DIG shall be at least , where is the maximum value of the T_DECIMAL_DIG macros for ISO/IEC 60559 binary formats. If the implementation correctly rounds for all numbers of significant decimal digits, then CR_DECIMAL_DIG shall have the value of the macro UINTMAX_MAX.
Conversions of types with ISO/IEC 60559 binary formats to character sequences with more than CR_DECIMAL_DIG significant decimal digits shall correctly round to CR_DECIMAL_DIG significant digits and pad zeros on the right.
Conversions from character sequences with more than CR_DECIMAL_DIG significant decimal digits to types with ISO/IEC 60559 binary formats shall correctly round to an intermediate character sequence with CR_DECIMAL_DIG significant decimal digits, according to the applicable rounding direction, and correctly round the intermediate result (having CR_DECIMAL_DIG significant decimal digits) to the destination type. The "inexact" floating-point exception is raised (once) if either conversion is inexact.439) (The second conversion can raise the "overflow" or "underflow" floating-point exception.)
The specification in this subclause assures conversion between ISO/IEC 60559 binary format and decimal character sequence follows all pertinent recommended practice. It also assures conversion from ISO/IEC 60559 format to decimal character sequence with at least T_DECIMAL_DIG digits and back, using to-nearest rounding, is the identity function, where T is the macro prefix for the format.
Functions such as strtod that convert character sequences to floating types honor the rounding direction. Hence, if the rounding direction can be upward or downward, the implementation cannot convert a minus-signed sequence by arithmetically negating the converted unsigned sequence.
NOTE ISO/IEC 60559 specifies that conversion to one-digit character strings using roundTiesToEven, when both choices have an odd least significant digit, produce the value with the larger magnitude. This can happen with 9.5e2 whose nearest neighbors are 9.e2 and 1.e3, both of which have a single odd digit in the significand part.
F.6 The return statement
F.7 Contracted expressions
A contracted expression is correctly rounded (once) and treats infinities, NaNs, signed zeros, subnormals, and the rounding directions in a manner consistent with the basic arithmetic operations covered by ISO/IEC 60559.
Recommended practice
A contracted expression should raise floating-point exceptions in a manner generally consistent with the basic arithmetic operations.
F.8 Floating-point environment
F.8.1 General
The floating-point environment defined in <fenv.h> includes the ISO/IEC 60559 floating-point exception status flags and rounding-direction control modes. It may also include other floating-point status or modes that the implementation provides as extensions.441)
This annex does not include support for ISO/IEC 60559’s optional alternate exception handling. The specification in this annex assumes ISO/IEC 60559 default exception handling: the flag is set, a default result is delivered, and execution continues. Implementations may provide alternate exception handling as an extension.
F.8.2 Environment management
ISO/IEC 60559 requires that floating-point operations implicitly raise floating-point exception status flags, and that rounding control modes can be set explicitly to affect result values of floating-point
F.8.3 Translation
During translation, constant rounding direction modes (7.6.3) are in effect where specified. Elsewhere, during translation the ISO/IEC 60559 default modes are in effect:
- The rounding direction mode is rounding to nearest.
- The rounding precision mode (if supported) is set so that results are not shortened.
- Trapping or stopping (if supported) is disabled on all floating-point exceptions.
Recommended practice
The implementation should produce a diagnostic message for each translation-time floating-point exception, other than "inexact";443) the implementation should then proceed with the translation of the program.
F.8.4 Execution
At program startup the dynamic floating-point environment is initialized as prescribed by ISO/IEC 60559:
- All floating-point exception status flags are cleared.
- The dynamic rounding direction mode is rounding to nearest.
- The dynamic rounding precision mode (if supported) is set so that results are not shortened.
- Trapping or stopping (if supported) is disabled on all floating-point exceptions.
F.8.5 Constant expressions
An arithmetic constant expression of floating type, other than one in an initializer for an object that has static or thread storage duration or that is declared with storage-class specifier constexpr, is evaluated (as if) during execution; thus, it is affected by any operative floating-point control modes and raises floating-point exceptions as required by ISO/IEC 60559 (provided the state for the FENV_ACCESS pragma is "on").444)
EXAMPLE
#include <fenv.h> #pragma STDC FENV_ACCESS ON void f(void) { constexpr double v = 0.0/0.0; // does not raise an exception float w[] = { 0.0/0.0 }; // raises an exception static float x = 0.0/0.0; // does not raise an exception float y = 0.0/0.0; // raises an exception double z = 0.0/0.0; // raises an exception /* ... */ }
For the static and constexpr initializations, the division is done at translation time, raising no (executiontime) floating-point exceptions. On the other hand, for the three automatic initializations the invalid division occurs at execution time.
F.8.6 Initialization
All computation for automatic initialization is done (as if) at execution time; thus, it is affected by any operative modes and raises floating-point exceptions as required by ISO/IEC 60559 (provided the state for the FENV_ACCESS pragma is "on"). All computation for initialization of objects that have static or thread storage duration, or that are declared with storage-class specifier constexpr, is done (as if) at translation time.
EXAMPLE
#include <fenv.h> #pragma STDC FENV_ACCESS ON void f(void) { constexpr float t = (float)1.1e75; // does not raise exceptions float u[] = { 1.1e75 }; // raises exceptions static float v = 1.1e75; // does not raise exceptions float w = 1.1e75; // raises exceptions double x = 1.1e75; // may raise exceptions float y = 1.1e75f; // may raise exceptions long double z = 1.1e75; // does not raise exceptions /* ... */ }
The constexpr initialization of t and the static initialization of v raise no (execution-time) floating-point exceptions because their computation is done at translation time. The automatic initialization of u and w require an execution-time conversion to float of the wider value 1.1e75, which raises floating-point exceptions. The automatic initializations of x and y entail execution-time conversion; however, in some expression evaluation methods, the conversions are not to a narrower format, in which case no floating-point exception is raised.445)
The automatic initialization of z entails execution-time conversion, but not to a narrower format, so no floating-point exception is raised. The conversions of the floating literals 1.1e75 and 1.1e75f to their internal representations occur at translation time in all cases.
F.8.7 Changing the environment
Operations defined in 6.5.1 and functions and macros defined for the standard libraries change floating-point status flags and control modes just as indicated by their specifications (including conformance to ISO/IEC 60559). They do not change flags or modes (so as to be detectable by the user) in any other cases.
If the floating-point exceptions represented by the argument to the feraiseexcept function in <fenv.h> include both "overflow" and "inexact", then "overflow" is raised before "inexact". Similarly, if the represented exceptions include both "underflow" and "inexact", then "underflow" is raised before "inexact".
F.9 Optimization
F.9.1 General
This subclause identifies code transformations that can subvert ISO/IEC 60559-specified behavior, and others that do not.
F.9.2 Global transformations
Floating-point arithmetic operations and external function calls can entail side effects which optimization shall honor, at least where the state of the FENV_ACCESS pragma is "on". The flags and modes in the floating-point environment can be regarded as global variables; floating-point operations (+, *, etc.) implicitly read the modes and write the flags.
Concern about side effects can inhibit code motion and removal of seemingly useless code. For example, in
#include <fenv.h> #pragma STDC FENV_ACCESS ON void f(double x) { /* ... */ for (i = 0; i < n; i++) x + 1; /* ... */ }
x+1 may raise floating-point exceptions, so cannot be removed. Because the loop body may not execute (maybe n), x+1 cannot be moved out of the loop. (Of course these optimizations are valid if the implementation can rule out the nettlesome cases.)
This specification does not require support for trap handlers that maintain information about the order or count of floating-point exceptions. Therefore, between function calls, the side effects due to floating-point exceptions are not required be precise: the actual order and number of occurrences of floating-point exceptions () may vary from what the source code expresses. Thus, the preceding loop could be treated as
if (0 < n) x + 1;
F.9.3 Expression transformations
Valid expression transformations shall preserve numerical values.
The equivalences noted in the following description apply to expressions of standard floating types.
Although similar transformations involving inexact constants generally do not yield equivalent expressions, if the constants are exact then such transformations can be made on ISO/IEC 60559 machines and others that round perfectly.
and The expressions , , and may be regarded as equivalent (on ISO/IEC 60559 machines, among others).446)
The expressions and are not equivalent if can be zero, infinite, or NaN.
The expressions , , and are equivalent (on ISO/IEC 60559 machines, among others).
The expressions and are not equivalent because is but is (in the default rounding direction).447)
The expressions and are not equivalent if is a NaN or infinite.
For expressions of decimal floating types, transformations shall preserve quantum exponents, as well as numerical values (5.3.5.3.4).
EXAMPLE The computation is valid for decimal floating-point expressions , but is not:
= = = =
In the second case, the factor and the result have different quantum exponents, demonstrating that and are not equivalent expressions.
F.9.4 Relational operators
false The expression is true if is a NaN.
true The expression is false if is a NaN.
isless (and similarly for ≤, , ≥) Though equal, these expressions are not equivalent because of side effects when or is a NaN and the state of the FENV_ACCESS pragma is "on". This transformation, which would be desirable if extra code were required to cause the "invalid" floating-point exception for unordered cases, could be performed provided the state of the FENV_ACCESS pragma is "off".
The sense of relational operators shall be maintained. This includes handling unordered cases as expressed by the source code.
EXAMPLE
// calls g and raises "invalid" if a and b are unordered if (a < b) f(); else g();is not equivalent to
// calls f and raises "invalid" if a and b are unordered if (a >= b) g(); else f();nor to
// calls f without raising "invalid" if a and b are unordered if (isgreaterequal(a,b)) g(); else f(); // calls g without raising "invalid" if a and b are unordered if (isless(a,b)) f(); else g(); if (!(a < b)) g(); else f();
F.9.5 Constant arithmetic
The implementation shall honor floating-point exceptions raised by execution-time constant arithmetic wherever the state of the FENV_ACCESS pragma is "on". (See F.8.5 and F.8.6.) An operation on literals that raises no floating-point exception can be folded during translation, except, if the state of the FENV_ACCESS pragma is "on", a further check is required to assure that changing the rounding direction to downward does not alter the sign of the result,448) and implementations that support dynamic rounding precision modes shall assure further that the result of the operation raises no floating-point exception when converted to the semantic type of the operation.
F.10 Mathematics <math.h> and <tgmath.h>
F.10.1 General
This subclause contains specifications of <math.h> and <tgmath.h> facilities that are particularly suited for ISO/IEC 60559 implementations.
The Standard C macro HUGE_VAL and its float and long double analogs, HUGE_VALF and HUGE_VALL, expand to expressions whose values are positive infinities.
For each single-argument function f in <math.h> whose mathematical counterpart is symmetric (even), f(-x) is f(x) for all rounding modes and for all x in the (valid) domain of the function. For each single-argument function f in <math.h> whose mathematical counterpart is antisymmetric (odd), f(-x) is -f(x) for the ISO/IEC 60559 rounding modes roundTiesToEven, roundTiesToAway, and roundTowardZero, and for all x in the (valid) domain of the function. The atan2 and atan2pi functions are odd in their first argument.
Special cases for functions in <math.h> are covered directly or indirectly by ISO/IEC 60559. The functions that ISO/IEC 60559 specifies directly are identified in F.3. The other functions in <math.h> treat infinities, NaNs, signed zeros, subnormals, and (provided the state of the FENV_ACCESS pragma is "on") the floating-point status flags in a manner consistent with ISO/IEC 60559 operations.
The expression math_errhandling & MATH_ERREXCEPT shall evaluate to a nonzero value.
The functions bound to operations in ISO/IEC 60559 (F.3) are fully specified by ISO/IEC 60559, including rounding behaviors and floating-point exceptions.
The "invalid" and "divide-by-zero" floating-point exceptions are raised as specified in subsequent subclauses of this annex.
The "overflow" floating-point exception is raised whenever an infinity — or, because of rounding direction, a maximal-magnitude finite number — is returned in lieu of a finite value whose magnitude is too large.
The "underflow" floating-point exception is raised whenever a computed result is tiny449) and the returned result is inexact.
Whether or when library functions not listed in Table F.2 raise the "inexact" floating-point exception is unspecified, unless stated otherwise.
Whether or when library functions not listed in Table F.2 raise a spurious "underflow" floating-point exception is not specified by this annex.450)
As implied by F.8.7, library functions do not raise spurious "invalid", "overflow", or "divide-by-zero" floating-point exceptions (detectable by the user).
Whether the functions not listed in Table F.2 honor the rounding direction mode is implementationdefined, unless explicitly specified otherwise.
Functions with a NaN argument return a NaN result and raise no floating-point exception, except where explicitly stated otherwise.
The specifications in the following subclauses append to the definitions in <math.h>. For families of functions, the specifications apply to all the functions even though only the principal function is shown. Unless otherwise specified, where the symbol "±" occurs in both an argument and the result, the result has the same sign as the argument.
Recommended practice
ISO/IEC 60559 specifies correct rounding for the operations in Table F.2 recommended by ISO/IEC 60559, and thereby preserves useful mathematical properties such as symmetry, monotonicity, and periodicity. The corresponding functions with (potentially) reserved cr_-prefixed names (7.35.9) do the same. The C functions in the table, however, are not required to be correctly rounded, but implementations should still preserve as many of these useful mathematical properties as possible.
If a function with one or more NaN arguments returns a NaN result, the result should be the same as one of the NaN arguments (after possible type conversion), except perhaps for the sign.
F.10.2 Trigonometric functions
F.10.2.1 The acos functions
-
acosreturns . -
acosreturns a NaN and raises the "invalid" floating-point exception for .
F.10.2.2 The asin functions
-
asinreturns . -
asinreturns a NaN and raises the "invalid" floating-point exception for .
F.10.2.3 The atan functions
F.10.2.4 The atan2 functions
F.10.2.5 The cos functions
-
cosreturns 1. -
cosreturns a NaN and raises the "invalid" floating-point exception.
F.10.2.6 The sin functions
-
sinreturns . -
sinreturns a NaN and raises the "invalid" floating-point exception.
F.10.2.7 The tan functions
-
tanreturns . -
tanreturns a NaN and raises the "invalid" floating-point exception.
F.10.2.8 The acospi functions
-
acospireturns . -
acospireturns a NaN and raises the "invalid" floating-point exception for .
F.10.2.9 The asinpi functions
-
asinpireturns . -
asinpireturns a NaN and raises the "invalid" floating-point exception for .
F.10.2.10 The atanpi functions
F.10.2.11 The atan2pi functions
F.10.2.12 The cospi functions
-
cospireturns 1. -
cospi
returns , for integers .
-
cospireturns a NaN and raises the "invalid" floating-point exception.
F.10.2.13 The sinpi functions
-
sinpireturns . -
sinpireturns , for positive integers . -
sinpireturns a NaN and raises the "invalid" floating-point exception.
F.10.2.14 The tanpi functions
-
tanpireturns . -
tanpireturns , for positive even and negative odd integers . -
tanpireturns , for positive odd and negative even integers . -
tanpi
returns and raises the "divide-by-zero" floating-point exception, for even integers .
-
tanpi
returns and raises the "divide-by-zero" floating-point exception, for odd integers .
F.10.3.3 The atanh functions
-
atanhreturns . -
atanhreturns and raises the "divide-by-zero" floating-point exception. -
atanhreturns a NaN and raises the "invalid" floating-point exception for .
F.10.3.4 The cosh functions
-
coshreturns 1. -
coshreturns .
F.10.3.5 The sinh functions
-
sinhreturns . -
sinhreturns .
F.10.3.6 The tanh functions
-
tanhreturns . -
tanhreturns .
F.10.4 Exponential and logarithmic functions
F.10.4.1 The exp functions
-
expreturns 1. -
expreturns . -
expreturns .
F.10.4.2 The exp10 functions
-
exp10returns 1. -
exp10returns . -
exp10returns .
F.10.4.3 The exp10m1 functions
-
exp10m1returns . -
exp10m1returns . -
exp10m1returns .
F.10.4.4 The exp2 functions
-
exp2returns 1. -
exp2returns . -
exp2returns .
F.10.4.5 The exp2m1 functions
-
exp2m1returns . -
exp2m1returns . -
exp2m1returns .
F.10.4.6 The expm1 functions
-
expm1returns . -
expm1returns . -
expm1returns .
F.10.4.7 The frexp functions
-
frexpreturns , and stores 0 in the object pointed to by . -
frexpreturns , and stores an unspecified value in the object pointed to by . -
frexp(NaN stores an unspecified value in the object pointed to by (and returns a NaN).
frexp raises no floating-point exceptions if value is not a signaling NaN.
The returned value is independent of the current rounding direction mode.
On a binary system, the body of the frexp function may be
{
*p = (value == 0 || !isfinite(value)) ? 0: (int)(1 + logb(value));
return scalbn(value, -(*p));
}F.10.4.8 The ilogb functions
When the correct result is representable in the range of the return type, the returned value is exact and is independent of the current rounding direction mode.
If the correct result is outside the range of the return type, the numeric result is unspecified and the "invalid" floating-point exception is raised.
ilogb, for zero, infinite, or NaN, raises the "invalid" floating-point exception and returns the value specified in 7.12.7.8.
F.10.4.9 The ldexp functions
On a binary system, ldexp(x, exp) is equivalent to scalbn(x, exp).
F.10.4.10 The llogb functions
The llogb functions are equivalent to the ilogb functions, except that the llogb functions determine a result in the long int type.
F.10.4.11 The log functions
-
logreturns and raises the "divide-by-zero" floating-point exception. -
logreturns . -
logreturns a NaN and raises the "invalid" floating-point exception for . -
logreturns .
F.10.4.12 The log10 functions
-
log10returns and raises the "divide-by-zero" floating-point exception. -
log10returns . -
log10returns a NaN and raises the "invalid" floating-point exception for . -
log10returns .
F.10.4.13 The log10p1 functions
-
log10p1returns . -
log10p1returns and raises the "divide-by-zero" floating-point exception. -
log10p1returns a NaN and raises the "invalid" floating-point exception for . -
log10p1returns .
F.10.4.14 The log1p and logp1 functions
-
logp1returns . -
logp1returns and raises the "divide-by-zero" floating-point exception. -
logp1returns a NaN and raises the "invalid" floating-point exception for . -
logp1returns .
The log1p functions are equivalent to the logp1 functions.
F.10.4.15 The log2 functions
-
log2returns and raises the "divide-by-zero" floating-point exception. -
log2returns . -
log2returns a NaN and raises the "invalid" floating-point exception for . -
log2returns .
F.10.4.16 The log2p1 functions
-
log2p1returns . -
log2p1returns and raises the "divide-by-zero" floating-point exception. -
log2p1returns a NaN and raises the "invalid" floating-point exception for . -
log2p1returns .
F.10.4.17 The logb functions
-
logbreturns and raises the "divide-by-zero" floating-point exception. -
logbreturns .
The returned value is exact and is independent of the current rounding direction mode.
F.10.4.18 The modf functions
-
modfreturns a result with the same sign as . -
modfreturns and stores in the object pointed to by . -
modf(NaN stores a NaN in the object pointed to by (and returns a NaN).
The returned values are exact and are independent of the current rounding direction mode.
modf behaves as though implemented by
#include <math.h> #include <fenv.h> #pragma STDC FENV_ACCESS ON double modf(double value, double *iptr) { int save_round = fegetround(); fesetround(FE_TOWARDZERO); *iptr = nearbyint(value); fesetround(save_round); return copysign( isinf(value) ? 0.0: value - (*iptr), value); }
F.10.4.19 The scalbn and scalbln functions
-
scalbnreturns . -
scalbnreturns . -
scalbnreturns .
If the calculation does not overflow or underflow, the returned value is exact and independent of the current rounding direction mode.
F.10.5 Power and absolute value functions
F.10.5.1 The cbrt functions
-
cbrtreturns . -
cbrtreturns .
F.10.5.2 The compoundn functions
-
compoundnreturns for or a NaN. -
compoundnreturns a NaN and raises the "invalid" floating-point exception for . -
compoundnreturns and raises the divide-by-zero floating-point exception for . -
compoundnreturns for . -
compoundnreturns for . -
compoundnreturns for .
F.10.5.3 The fabs functions
-
fabsreturns . -
fabsreturns .
fabs(x) raises no floating-point exceptions, even if x is a signaling NaN. The returned value is independent of the current rounding direction mode.
F.10.5.4 The hypot functions
-
hypot,hypot, andhypotare equivalent. -
hypotreturns the absolute value ofx, ifxis not a NaN. -
hypotreturns , even if is a NaN. -
hypotNaN) returns a NaN, ifxis not .
F.10.5.5 The pow functions
-
powreturns and raises the "divide-by-zero" floating-point exception for an odd integer . -
powreturns and raises the "divide-by-zero" floating-point exception for , finite, and not an odd integer. -
powreturns . -
powreturns for an odd integer . -
powreturns for and not an odd integer. -
powreturns 1. -
powreturns 1 for any , even a NaN. -
powreturns 1 for any , even a NaN. -
powreturns a NaN and raises the "invalid" floating-point exception for finite and finite non-integer . -
powreturns for . -
powreturns for . -
powreturns for . -
powreturns for . -
powreturns for an odd integer . -
powreturns for and not an odd integer. -
powreturns for an odd integer . -
powreturns for and not an odd integer. -
powreturns for . -
powreturns for .
F.10.5.6 The pown functions
-
pownreturns for all not a signaling NaN. -
pownreturns and raises the "divide-by-zero" floating-point exception for odd . -
pownreturns and raises the "divide-by-zero" floating-point exception for even . -
pownreturns for even . -
pownreturns for odd . -
pownis equivalent topownfor not , except that the "divide-by-zero" floating-point exception is not raised.
F.10.5.7 The powr functions
-
powrreturns for finite . -
powrreturns and raises the "divide-by-zero" floating-point exception for finite . -
powrreturns . -
powrreturns for . -
powrreturns for finite . -
powrreturns a NaN and raises the "invalid" floating-point exception. -
powrreturns a NaN and raises the "invalid" floating-point exception for . -
powrreturns a NaN and raises the "invalid" floating-point exception. -
powrreturns a NaN and raises the "invalid" floating-point exception.
F.10.5.8 The rootn functions
-
rootnreturns and raises the "divide-by-zero" floating-point exception for odd . -
rootnreturns and raises the "divide-by-zero" floating-point exception for even . -
rootnreturns for even . -
rootnreturns for odd . -
rootnreturns for . -
rootnreturns for odd . -
rootnreturns a NaN and raises the "invalid" floating-point exception for even . -
rootnreturns for . -
rootnreturns for odd . -
rootnreturns a NaN and raises the "invalid" floating-point exception for even . -
rootnreturns a NaN and raises the "invalid" floating-point exception for all (including NaN). -
rootnreturns a NaN and raises the "invalid" floating-point exception for and even.
F.10.5.9 The rsqrt functions
-
rsqrtreturns and raises the "divide-by-zero" floating-point exception. -
rsqrtreturns a NaN and raises the "invalid" floating-point exception for . -
rsqrtreturns .
F.10.5.10 The sqrt functions
-
sqrtreturns . -
sqrtreturns . -
sqrtreturns a NaN and raises the "invalid" floating-point exception for .
The returned value is dependent on the current rounding direction mode.
F.10.6 Error and gamma functions
F.10.6.1 The erf functions
-
erfreturns . -
erfreturns .
F.10.6.2 The erfc functions
-
erfcreturns 2. -
erfcreturns .
F.10.6.3 The lgamma functions
-
lgammareturns . -
lgammareturns . -
lgammareturns and raises the "divide-by-zero" floating-point exception for a negative integer or zero. -
lgammareturns . -
lgammareturns .
F.10.6.4 The tgamma functions
-
tgammareturns and raises the "divide-by-zero" floating-point exception. -
tgammareturns a NaN and raises the "invalid" floating-point exception for a negative integer. -
tgammareturns a NaN and raises the "invalid" floating-point exception. -
tgammareturns .
F.10.7 Nearest integer functions
F.10.7.1 The ceil functions
-
ceilreturns . -
ceilreturns .
The returned value is exact and is independent of the current rounding direction mode.
The double version of ceil behaves as though implemented by
#include <math.h> #include <fenv.h> #pragma STDC FENV_ACCESS ON double ceil(double x) { double result; int save_round = fegetround(); fesetround(FE_UPWARD); result = nearbyint(x); fesetround(save_round); return result; }
F.10.7.2 The floor functions
-
floorreturns . -
floorreturns .
The returned value is exact and is independent of the current rounding direction mode.
See the sample implementation for ceil in F.10.7.1.
F.10.7.3 The nearbyint functions
The nearbyint functions use ISO/IEC 60559 rounding according to the current rounding direction. They do not raise the "inexact" floating-point exception if the result differs in value from the argument.
-
nearbyintreturns (for all rounding directions). -
nearbyintreturns (for all rounding directions).
F.10.7.4 The rint functions
The rint functions differ from the nearbyint functions only in that they do raise the "inexact" floating-point exception if the result differs in value from the argument.
F.10.7.5 The lrint and llrint functions
The lrint and llrint functions provide floating-to-integer conversion as prescribed by ISO/IEC 60559. They round according to the current rounding direction. If the rounded value is outside the range of the return type, the numeric result is unspecified and the "invalid" floating-point exception is raised. When they raise no other floating-point exception and the result differs from the argument, they raise the "inexact" floating-point exception.
F.10.7.6 The round functions
-
roundreturns . -
roundreturns .
The returned value is independent of the current rounding direction mode.
The double version of round behaves as though implemented by:453)
#include <math.h> #include <fenv.h> #pragma STDC FENV_ACCESS ON double round(double x) { double result; fenv_t save_env; feholdexcept(&save_env); result = rint(x); if (fetestexcept(FE_INEXACT)) { fesetround(FE_TOWARDZERO); result = rint(copysign(0.5 + fabs(x), x)); feclearexcept(FE_INEXACT); } feupdateenv(&save_env); return result; }
F.10.7.7 The lround and llround functions
The lround and llround functions differ from the lrint and llrint functions with the default rounding direction just in that the lround and llround functions round halfway cases away from zero and are not required to raise the "inexact" floating-point exception for non-integer arguments that round to within the range of the return type.
F.10.7.8 The roundeven functions
-
roundevenreturns . -
roundevenreturns .
The returned value is exact and is independent of the current rounding direction mode.
See the sample implementation for ceil in F.10.7.1.
F.10.7.9 The trunc functions
The trunc functions use ISO/IEC 60559 rounding toward zero (regardless of the current rounding direction).
-
truncreturns . -
truncreturns .
The returned value is exact and is independent of the current rounding direction mode.
F.10.7.10 The fromfp and ufromfp functions
The fromfp and ufromfp functions raise the "invalid" floating-point exception and return a NaN if the argument width is zero or if the floating-point argument x is infinite or NaN or rounds to an integral value that is outside the range determined by the argument width (see 7.12.10.10).
These functions do not raise the "inexact" floating-point exception.
F.10.7.11 The fromfpx and ufromfpx functions
The fromfpx and ufromfpx functions raise the "invalid" floating-point exception and return a NaN if the argument width is zero or if the floating-point argument x is infinite or NaN or rounds to an integral value that is outside the range determined by the argument width (see 7.12.10.11).
These functions raise the "inexact" floating-point exception if a valid result differs in value from the floating-point argument x.
F.10.8 Remainder functions
F.10.8.1 The fmod functions
-
fmodreturns for not zero. -
fmodreturns a NaN and raises the "invalid" floating-point exception for infinite or zero (and neither is a NaN). -
fmodreturns for finite .
When subnormal results are supported, the returned value is exact and is independent of the current rounding direction mode.
The double version of fmod behaves as though implemented by
#include <math.h> #include <fenv.h> #pragma STDC FENV_ACCESS ON double fmod(double x, double y) { double result; result = remainder(fabs(x), (y = fabs(y))); if (signbit(result)) result += y; return copysign(result, x); }
F.10.8.2 The remainder functions
-
remainderreturns for not zero. -
remainderreturns a NaN and raises the "invalid" floating-point exception for infinite or zero (and neither is a NaN). -
remainderreturns for finite .
When subnormal results are supported, the returned value is exact and is independent of the current rounding direction mode.
F.10.8.3 The remquo functions
The remquo functions follow the specifications for the remainder functions.
If a NaN is returned, the value stored in the object pointed to by quo is unspecified.
When subnormal results are supported, the returned value is exact and is independent of the current rounding direction mode.
F.10.9 Manipulation functions
F.10.9.1 The copysign functions
copysign raises no floating-point exceptions, even if or is a signaling NaN. The returned value is independent of the current rounding direction mode.
F.10.9.2 The nan functions
All ISO/IEC 60559 implementations support quiet NaNs, in all floating formats.
The returned value is exact and is independent of the current rounding direction mode.
F.10.9.3 The nextafter functions
-
nextafterraises the "overflow" and "inexact" floating-point exceptions for finite and the function value infinite. -
nextafterraises the "underflow" and "inexact" floating-point exceptions for the function value subnormal or zero and .
Even though underflow or overflow can occur, the returned value is independent of the current rounding direction mode.
F.10.9.4 The nexttoward functions
No additional requirements beyond those on nextafter.
Even though underflow or overflow can occur, the returned value is independent of the current rounding direction mode.
F.10.9.5 The nextup functions
-
nextupreturns . -
nextupreturns the largest-magnitude negative finite number in the return type of the function.
nextup(x) raises no floating-point exceptions if x is not a signaling NaN. The returned value is independent of the current rounding direction mode.
F.10.9.6 The nextdown functions
-
nextdownreturns . -
nextdownreturns the largest-magnitude positive finite number in the type of the function.
nextdown(x) raises no floating-point exceptions if x is not a signaling NaN. The returned value is independent of the current rounding direction mode.
F.10.9.7 The canonicalize functions
The canonicalize functions produce454) the canonical version of the representation in the object pointed to by the argument x. If the input *x is a signaling NaN, the "invalid" floating-point exception is raised and a (canonical) quiet NaN (which should be the canonical version of that signaling NaN made quiet) is produced. For quiet NaN, infinity, and finite inputs, the functions raise no floating-point exceptions.
F.10.10 Maximum, minimum, and positive difference functions
F.10.10.1 The fdim functions
No additional requirements.
F.10.10.2 The fmax functions
If just one argument is a NaN, the fmax functions return the other argument (if both arguments are NaNs, the functions return a NaN).
The returned value is exact and is independent of the current rounding direction mode.
The body of the fmax function may be:455)
{
double r = (isgreaterequal(x, y) || isnan(y)) ? x : y;
(void) canonicalize(&r, &r);
return r;
}F.10.10.3 The fmin functions
The fmin functions are analogous to the fmax functions (see F.10.10.2).
The returned value is exact and is independent of the current rounding direction mode.
F.10.10.4 The fmaximum, fminimum, fmaximum_mag, and fminimum_mag functions
These functions treat NaNs like other functions in <math.h> (see F.10). They differ from the corresponding fmaximum_num, fminimum_num, fmaximum_mag_num, and fminimum_mag_num functions only in their treatment of NaNs.
F.10.10.5 The fmaximum_num, fminimum_num, fmaximum_mag_num, and fminimum_mag_num func-
These functions return the number if one argument is a number and the other is a quiet or signaling NaN. If both arguments are NaNs, a quiet NaN is returned. If an argument is a signaling NaN, the "invalid" floating-point exception is raised (even though the function returns the number when the other argument is a number).
F.10.11 Fused multiply-add
F.10.11.1 The fma functions
-
fmacomputes , correctly rounded once. -
fmareturns a NaN and optionally raises the "invalid" floating-point exception if one of and is infinite, the other is zero, and is a NaN. -
fmareturns a NaN and raises the "invalid" floating-point exception if one of and is infinite, the other is zero, and is not a NaN. -
fmareturns a NaN and raises the "invalid" floating-point exception if times is an exact infinity and is also an infinity but with the opposite sign.
F.10.12 Functions that round result to narrower type
The functions that round their result to narrower type (7.12.15) are fully specified in ISO/IEC 60559. The returned value is dependent on the current rounding direction mode.
These functions treat zero and infinite arguments like the corresponding operation or function: +, -,
*, /, fma, or sqrt.
F.10.13 Total order functions
F.10.13.1 General
This subclause specifies the total order functions required by ISO/IEC 60559.
NOTE These functions are specified only in this annex because the functions for standard floating types depend on details of ISO/IEC 60559 formats that are conditionally supported based on if the relevant feature test macro, __STDC_IEC_60559_BFP__ or __STDC_IEC_60559_DFP__, is defined or not.
F.10.13.2 The totalorder functions
Synopsis
#define __STDC_WANT_IEC_60559_EXT__ #include <math.h> #ifdef __STDC_IEC_60559_BFP__ int totalorder(const double *x, const double *y); int totalorderf(const float *x, const float *y); int totalorderl(const long double *x, const long double *y); #endif #ifdef __STDC_IEC_60559_DFP__ int totalorderd32(const _Decimal32 *x, const _Decimal32 *y); int totalorderd64(const _Decimal64 *x, const _Decimal64 *y); int totalorderd128(const _Decimal128 *x, const _Decimal128 *y); #endif
Description
The totalorder functions determine whether the total order relationship, defined by ISO/IEC 60559, is true for the ordered pair of *x, *y. These functions are fully specified in ISO/IEC 60559. These functions are independent of the current rounding direction mode and raise no floating-point exceptions, even if *x or *y is a signaling NaN.
Returns
The totalorder functions return nonzero if and only if the total order relation is true for the ordered pair of *x, *y.
F.10.13.3 The totalordermag functions
Synopsis
#define __STDC_WANT_IEC_60559_EXT__ #include <math.h> #ifdef __STDC_IEC_60559_BFP__ int totalordermag(const double *x, const double *y); int totalordermagf(const float *x, const float *y); int totalordermagl(const long double *x, const long double *y); #endif #ifdef __STDC_IEC_60559_DFP__ int totalordermagd32(const _Decimal32 *x, const _Decimal32 *y); int totalordermagd64(const _Decimal64 *x, const _Decimal64 *y); int totalordermagd128(const _Decimal128 *x, const _Decimal128 *y); #endif
Description
The totalordermag functions determine whether the total order relationship, defined by ISO/IEC 60559, is true for the ordered pair of the magnitudes of *x, *y. These functions are fully specified in ISO/IEC 60559. These functions are independent of the current rounding direction mode and raise no floating-point exceptions, even if *x or *y is a signaling NaN.
Returns
The totalordermag functions return nonzero if and only if the total order relation is true for the ordered pair of the magnitudes of *x, *y.
F.10.14 Payload functions
F.10.14.1 General
ISO/IEC 60559 defines the payload to be information contained in a quiet or signaling NaN. The payload is intended for implementation-defined diagnostic information about the NaN, such as where or how the NaN was created.456) The implementation interprets the payload as a nonnegative integer suitable for use with the functions in this subclause, which get and set payloads. The implementation may restrict which payloads are admissible for the user to set.
NOTE These functions are specified only in this annex because the functions for standard floating types depend on details of ISO/IEC 60559 formats that are conditionally supported based on if the relevant feature test macro, __STDC_IEC_60559_BFP__ or __STDC_IEC_60559_DFP__, is defined or not.
F.10.14.2 The getpayload functions
Synopsis
#define __STDC_WANT_IEC_60559_EXT__ #include <math.h> #ifdef __STDC_IEC_60559_BFP__ double getpayload(const double *x); float getpayloadf(const float *x); long double getpayloadl(const long double *x); #endif #ifdef __STDC_IEC_60559_DFP__ _Decimal32 getpayloadd32(const _Decimal32 *x); _Decimal64 getpayloadd64(const _Decimal64 *x); _Decimal128 getpayloadd128(const _Decimal128 *x); #endif
Description
The getpayload functions extract the payload of a quiet or signaling NaN input and return it as a positive-signed floating-point integer. If *x is not a NaN, the return result is . These functions raise no floating-point exceptions, even if *x is a signaling NaN.
Returns
The getpayload functions return the payload of the NaN input as a positive-signed floating-point integer.
F.10.14.3 The setpayload functions
Synopsis
#define __STDC_WANT_IEC_60559_EXT__ #include <math.h> #ifdef __STDC_IEC_60559_BFP__ int setpayload(double *res, double pl); int setpayloadf(float *res, float pl); int setpayloadl(long double *res, long double pl); #endif #ifdef __STDC_IEC_60559_DFP__ int setpayloadd32(_Decimal32 *res, _Decimal32 pl); int setpayloadd64(_Decimal64 *res, _Decimal64 pl); int setpayloadd128(_Decimal128 *res, _Decimal128 pl); #endif
Description
The setpayload functions create a quiet NaN with the payload specified by pl and a zero sign bit and store that NaN in the object pointed to by *res. If pl is not a floating-point integer representing
Returns
If the setpayload functions stored the specified NaN, they return a zero value, otherwise a nonzero value (and *res is set to ).
F.10.14.4 The setpayloadsig functions
Synopsis
#define __STDC_WANT_IEC_60559_EXT__ #include <math.h> #ifdef __STDC_IEC_60559_BFP__ int setpayloadsig(double *res, double pl); int setpayloadsigf(float *res, float pl); int setpayloadsigl(long double *res, long double pl); #endif #ifdef __STDC_IEC_60559_DFP__ int setpayloadsigd32(_Decimal32 *res, _Decimal32 pl); int setpayloadsigd64(_Decimal64 *res, _Decimal64 pl); int setpayloadsigd128(_Decimal128 *res, _Decimal128 pl); #endif
Description
The setpayloadsig functions create a signaling NaN with the payload specified by pl and a zero sign bit and store that NaN in the object pointed to by *res. If pl is not a floating-point integer representing an admissible payload, *res is set to .
Returns
If the setpayloadsig functions stored the specified NaN, they return a zero value, otherwise a nonzero value (and *res is set to ).
F.10.15 Comparison macros
F.10.15.1 General
Relational operators and their corresponding comparison macros (7.12.18) produce equivalent result values, even if argument values are represented in wider formats. Thus, comparison macro arguments represented in formats wider than their semantic types are not converted to the semantic types, unless the wide evaluation method converts operands of relational operators to their semantic types. The standard wide evaluation methods characterized by FLT_EVAL_METHOD and DEC_EVAL_METHOD equal to 1 or 2 (5.3.5.3.3, 5.3.5.3.4), do not convert operands of relational operators to their semantic types.
F.10.15.2 The iseqsig macro
The equality operator == and the iseqsig macro produce equivalent results, except that the iseqsig macro raises the "invalid" floating-point exception if an argument is a NaN.
G ISO/IEC 60559-compatible complex arithmetic
G.1 Introduction
This annex supplements Annex F to specify complex arithmetic for compatibility with ISO/IEC 60559 real floating-point arithmetic. An implementation that defines __STDC_IEC_60559_COMPLEX__ shall conform to the specifications in this annex.457)
G.2 Conventions
A complex value with at least one infinite part is regarded as an infinity (even if its other part is a quiet NaN). A complex value is a finite number if each of its parts is a finite number (neither infinite nor NaN). A complex value is a zero if each of its parts is a zero.
G.3 Binary operators
G.3.1 General
For most operand types, the value of the result of a binary operator with a complex operand is completely determined, with reference to real arithmetic, by the usual mathematical formula. For some operand types, the usual mathematical formula is problematic because of its treatment of infinities and because of undue overflow or underflow; in these cases the result satisfies certain properties (specified in G.3.2), but is not completely determined.
G.3.2 Multiplicative operators
Semantics
The * and / operators satisfy the following infinity properties for all real and complex operands:458)
- if one operand is an infinity and the other operand is a nonzero finite number or an infinity, then the result of the
*operator is an infinity; - if the first operand is an infinity and the second operand is a finite number, then the result of the
/operator is an infinity; - if the first operand is a finite number and the second operand is an infinity, then the result of the
/operator is a zero; - if the first operand is a nonzero finite number or an infinity and the second operand is a zero, then the result of the
/operator is an infinity.
If both operands of the * operator are complex or if the second operand of the / operator is complex, the operator raises floating-point exceptions if appropriate for the calculation of the parts of the result, and may raise spurious floating-point exceptions.
EXAMPLE 1 Multiplication of double _Complex operands could be implemented as follows.
#include <math.h> #include <complex.h> /* Multiply z * w */ double complex _Cmultd(double complex z, double complex w) { #pragma STDC FP_CONTRACT OFF double a, b, c, d, ac, bd, ad, bc, x, y; a = creal(z); b = cimag(z); c = creal(w); d = cimag(w); ac = a * c; bd = b * d; ad = a * d; bc = b * c; x = ac - bd; y = ad + bc; if (isnan(x) && isnan(y)) { /* Recover infinities that computed as NaN+iNaN */ int recalc = 0; if (isinf(a) || isinf(b)) { // z is infinite /* "Box" the infinity and change NaNs in the other factor to 0 */ a = copysign(isinf(a) ? 1.0: 0.0, a); b = copysign(isinf(b) ? 1.0: 0.0, b); if (isnan(c)) c = copysign(0.0, c); if (isnan(d)) d = copysign(0.0, d); recalc = 1; } if (isinf(c) || isinf(d)) { // w is infinite /* "Box" the infinity and change NaNs in the other factor to 0 */ c = copysign(isinf(c) ? 1.0: 0.0, c); d = copysign(isinf(d) ? 1.0: 0.0, d); if (isnan(a)) a = copysign(0.0, a); if (isnan(b)) b = copysign(0.0, b); recalc = 1; } if (!recalc && (isinf(ac) || isinf(bd) || isinf(ad) || isinf(bc))) { /* Recover infinities from overflow by changing NaNs to 0 */ if (isnan(a)) a = copysign(0.0, a); if (isnan(b)) b = copysign(0.0, b); if (isnan(c)) c = copysign(0.0, c); if (isnan(d)) d = copysign(0.0, d); recalc = 1; } if (recalc) { x = INFINITY * (a * c - b * d); y = INFINITY * (a * d + b * c); } } return CMPLX(x, y); }
This implementation achieves the required treatment of infinities at the cost of only one isnan test in ordinary (finite) cases. It is less than ideal in that undue overflow and underflow can occur.
EXAMPLE 2 Division of two double _Complex operands can be implemented as follows.
#include <math.h> #include <complex.h> /* Divide z / w */ double complex _Cdivd(double complex z, double complex w) { #pragma STDC FP_CONTRACT OFF double a, b, c, d, logbw, denom, x, y; int ilogbw = 0; a = creal(z); b = cimag(z); c = creal(w); d = cimag(w); logbw = logb(fmaximum_num(fabs(c), fabs(d))); if (isfinite(logbw)) { ilogbw = (int)logbw; c = scalbn(c, -ilogbw); d = scalbn(d, -ilogbw); } denom = c * c + d * d; x = scalbn((a * c + b * d) / denom, -ilogbw); y = scalbn((b * c - a * d) / denom, -ilogbw); /* Recover infinities and zeros that computed as NaN+iNaN. */ /* The only cases are nonzero/zero, infinite/finite, and finite/infinite */ if (isnan(x) && isnan(y)) { if ((denom == 0.0) && (!isnan(a) || !isnan(b))) { x = copysign(INFINITY, c) * a; y = copysign(INFINITY, c) * b; } else if ((isinf(a) || isinf(b)) && isfinite(c) && isfinite(d)) { a = copysign(isinf(a) ? 1.0: 0.0, a); b = copysign(isinf(b) ? 1.0: 0.0, b); x = INFINITY * (a * c + b * d); y = INFINITY * (b * c - a * d); } else if ((logbw == INFINITY) && isfinite(a) && isfinite(b)) { c = copysign(isinf(c) ? 1.0: 0.0, c); d = copysign(isinf(d) ? 1.0: 0.0, d); x = 0.0 * (a * c + b * d); y = 0.0 * (b * c - a * d); } } return CMPLX(x, y); }
Scaling the denominator alleviates the main overflow and underflow problem, which is more serious than for multiplication. In the spirit of the preceding multiplication example, this code does not defend against overflow and underflow in the calculation of the numerator. Scaling with the scalbn function, instead of with division, provides better roundoff characteristics.
G.4 Complex arithmetic <complex.h>
G.4.1 General
This subclause contains specifications for the <complex.h> functions that are particularly suited to ISO/IEC 60559 implementations. For families of functions, the specifications apply to all of the functions even though only the principal function is shown. Unless otherwise specified, where the symbol "±" occurs in both an argument and the result, the result has the same sign as the argument.
The functions are continuous onto both sides of their branch cuts, taking into account the sign of zero. For example, csqrt √
.
As complex values are composed of real values, each function may be regarded as computing real values from real values. Except as noted, the functions treat real infinities, NaNs, signed zeros, subnormals, and the floating-point exception flags in a manner consistent with the specifications for real functions in F.10.459)
In subsequent subclauses in G.4 "NaN" refers to a quiet NaN. The behavior of signaling NaNs in this annex is implementation-defined.
The functions cimag, conj, cproj, and creal are fully specified for all implementations, including ISO/IEC 60559 ones, in 7.3.9. These functions raise no floating-point exceptions.
Each of the functions cabs and carg is specified by a formula in terms of a real function (whose special cases are covered in Annex F):
cabs(x + iy ) = hypot ( x, y ) carg(x + iy ) = atan2 ( y, x )
Each of the functions casin, catan, ccos, csin and ctan is specified implicitly by a formula in terms of other complex functions (whose special cases are specified below):
casin(z) = −i casinh(iz) catan(z) = −i catanh(iz) ccos(z) = ccosh(iz) csin(z) = −i csinh(iz) ctan(z) = −i ctanh(iz)
For the other functions, the following subclauses specify behavior for special cases, including treatment of the "invalid" and "divide-by-zero" floating-point exceptions. For families of functions, the specifications apply to all of the functions even though only the principal function is shown. For a function satisfying conj conj, the specifications for the upper half-plane imply the specifications for the lower half-plane; if the function is also either even, , or odd, , then the specifications for the first quadrant imply the specifications for the other three quadrants.
In the following subclauses, is defined as .
G.4.2 Trigonometric functions
G.4.2.1 The cacos functions
-
cacos(conjconj(cacos. -
cacosreturns
.
-
cacosNaN) returns
NaN.
-
cacosreturns
, for finite .
-
cacosNaN) returns NaN NaN and optionally raises the "invalid" floating-point exception, for nonzero finite . -
cacosreturns , for positive-signed finite . -
cacosreturns , for positive-signed finite . -
cacosreturns
.
-
cacosreturns
.
-
cacosNaN) returns NaN (where the sign of the imaginary part of the result is unspecified). -
cacos(NaN returns NaN NaN and optionally raises the "invalid" floating-point exception, for finite . -
cacos(NaN returns NaN . -
cacos(NaN NaN) returns NaN NaN.
G.4.3 Hyperbolic functions
G.4.3.1 The cacosh functions
G.4.3.2 The casinh functions
-
casinh(conjconj(casinhandcasinhis odd. -
casinhreturns . -
casinhreturns
for positive-signed finite .
-
casinhNaN) returns NaN NaN and optionally raises the "invalid" floating-point exception, for finite . -
casinhreturns for positive-signed finite . -
casinhreturns
.
-
casinhNaN) returns NaN. -
casinh(NaN returns NaN . -
casinh(NaN returns NaN NaN and optionally raises the "invalid" floating-point exception, for finite nonzero . -
casinh(NaN returns NaN (where the sign of the real part of the result is unspecified). -
casinh(NaN NaN) returns NaN NaN.
G.4.3.3 The catanh functions
-
catanh(conjconj(catanhandcatanhis odd. -
catanhreturns . -
catanhNaN) returns NaN. -
catanhreturns and raises the "divide-by-zero" floating-point exception. -
catanhreturns
, for finite positive-signed .
G.4.3.4 The ccosh functions
-
ccosh(conjconj(ccoshandccoshis even. -
ccoshreturns . -
ccoshreturns NaN (where the sign of the imaginary part of the result is unspecified) and raises the "invalid" floating-point exception. -
ccoshNaN) returns NaN (where the sign of the imaginary part of the result is unspecified). -
ccoshreturns NaN NaN and raises the "invalid" floating-point exception, for finite nonzero . -
ccoshNaN) returns NaN NaN and optionally raises the "invalid" floating-point exception, for finite nonzero . -
ccoshreturns . -
ccoshreturns , for finite nonzero . -
ccoshreturns NaN (where the sign of the real part of the result is unspecified) and raises the "invalid" floating-point exception. -
ccoshNaN) returns NaN. -
ccosh(NaN returns NaN (where the sign of the imaginary part of the result is unspecified). -
ccosh(NaN returns NaN NaN and optionally raises the "invalid" floating-point exception, for all nonzero numbers . -
ccosh(NaN NaN) returns NaN NaN.
G.4.3.5 The csinh functions
-
csinh(conjconj(csinhandcsinhis odd. -
csinhreturns . -
csinhreturns NaN (where the sign of the real part of the result is unspecified) and raises the "invalid" floating-point exception. -
csinhNaN) returns NaN (where the sign of the real part of the result is unspecified). -
csinhreturns NaN NaN and raises the "invalid" floating-point exception, for positive finite . -
csinhNaN) returns NaN NaN and optionally raises the "invalid" floating-point exception, for finite nonzero .
G.4.3.6 The ctanh functions
-
ctanh(conjconj(ctanhandctanhis odd. -
ctanhreturns . -
ctanhreturns NaN and raises the "invalid" floating-point exception. -
ctanhreturns NaN NaN and raises the "invalid" floating-point exception, for finite nonzero . -
ctanhNaN) returns NaN. -
ctanhNaN) returns NaN NaN and optionally raises the "invalid" floating-point exception, for finite nonzero . -
ctanhreturns , for positive-signed finite . -
ctanhreturns (where the sign of the imaginary part of the result is unspecified). -
ctanhNaN) returns (where the sign of the imaginary part of the result is unspecified). -
ctanh(NaN returns NaN . -
ctanh(NaN returns NaN NaN and optionally raises the "invalid" floating-point exception, for all nonzero numbers . -
ctanh(NaN NaN) returns NaN NaN.
G.4.4 Exponential and logarithmic functions
G.4.4.1 The cexp functions
-
cexp(conjconj(cexp. -
cexpreturns . -
cexpreturns NaN NaN and raises the "invalid" floating-point exception, for finite . -
cexpNaN) returns NaN NaN and optionally raises the "invalid" floating-point exception, for finite . -
cexpreturns . -
cexpreturns , for finite .
G.4.4.2 The clog functions
-
clog(conjconj(clog. -
clogreturns and raises the "divide-by-zero" floating-point exception. -
clogreturns and raises the "divide-by-zero" floating-point exception. -
clogreturns
, for finite .
-
clogNaN) returns NaN NaN and optionally raises the "invalid" floating-point exception, for finite . -
clogreturns , for finite positive-signed . -
clogreturns , for finite positive-signed . -
clogreturns
.
-
clogreturns
.
-
clogNaN) returns NaN. -
clog(NaN returns NaN NaN and optionally raises the "invalid" floating-point exception, for finite . -
clog(NaN returns NaN. -
clog(NaN NaN) returns NaN NaN.
G.4.5 Power and absolute-value functions
G.4.5.1 The cpow functions
The cpow functions raise floating-point exceptions if appropriate for the calculation of the parts of the result, and may also raise spurious floating-point exceptions.460)
G.4.5.2 The csqrt functions
-
csqrt(conjconj(csqrt. -
csqrtreturns . -
csqrtreturns , for all (including NaN). -
csqrtNaN) returns NaN NaN and optionally raises the "invalid" floating-point exception, for finite . -
csqrtreturns , for finite positive-signed . -
csqrtreturns , for finite positive-signed . -
csqrtNaN) returns NaN (where the sign of the imaginary part of the result is unspecified). -
csqrtNaN) returns NaN. -
csqrt(NaN returns NaN NaN and optionally raises the "invalid" floating-point exception, for finite . -
csqrt(NaN NaN) returns NaN NaN.
H ISO/IEC 60559 interchange and extended types
H.1 Introduction
This annex specifies extension types for programming language C that have the arithmetic interchange and extended floating-point formats specified in ISO/IEC 60559. This annex also includes functions that support the non-arithmetic interchange formats in that standard. This annex was adapted from ISO/IEC TS 18661-3:2015, Floating-point extensions for C —Interchange and extended types.
An implementation that defines __STDC_IEC_60559_TYPES__ to 202ymmL shall conform to the specifications in this annex. An implementation may define __STDC_IEC_60559_TYPES__ only if it defines __STDC_IEC_60559_BFP__, indicating support for ISO/IEC 60559 binary floating-point arithmetic, or defines __STDC_IEC_60559_DFP__, indicating support for ISO/IEC 60559 decimal floatingpoint arithmetic (or defines both). Where a binding between the C language and ISO/IEC 60559 is indicated, the ISO/IEC 60559-specified behavior is adopted by reference, unless stated otherwise.
H.2 Types
H.2.1 General
This clause specifies types that support ISO/IEC 60559 arithmetic interchange and extended formats. The encoding conversion functions (H.11.4) and numeric conversion functions for encodings (H.12.4, H.12.5) support the non-arithmetic interchange formats specified in ISO/IEC 60559.
H.2.2 Interchange floating types
ISO/IEC 60559 specifies interchange formats, and their encodings, which can be used for the exchange of floating-point data between implementations. These formats are identified by their radix (binary or decimal) and their storage width N. Table H.1, Table H.2, Table H.3, and Table H.4 give the C floating-point model parameters461) (5.3.5.3.3) for the ISO/IEC 60559 interchange formats, where the function round() rounds to the nearest integer.
Table H.1 — Binary interchange format parameters
Parameter binary16 binary32 binary64 binary128 , storage width in bits 16 32 64 128 , precision in binary digits (bits) 11 24 53 113 , maximum exponent 16 128 1024 16384 , minimum exponent
Table H.2 — Binary interchange format parameters for arbitrary
Parameter binary () , storage width in bits , a multiple of 32 , precision in binary digits (bits) , maximum exponent
, minimum exponent
EXAMPLE For the binary160 format, , and . For the decimal160 format, , and .
Types designated:
_FloatNwhere is 16, 32, 64, or ≥128 and a multiple of 32; and, types designated_DecimalNwhere 32 and a multiple of 32, are collectively called the interchange floating types. Each interchange floating type has the ISO/IEC 60559 interchange format corresponding to its width () and radix (2 for _FloatN, 10 for _DecimalN). Each interchange floating type is not compatible with any other type.
An implementation that defines __STDC_IEC_60559_BFP__ and __STDC_IEC_60559_TYPES__ shall provide _Float32 and _Float64 as interchange floating types with the same representation and alignment requirements as float and double, respectively. If the implementation’s long double type supports an ISO/IEC 60559 interchange format of width , then the implementation shall also provide the type _FloatN as an interchange floating type with the same representation and alignment requirements as long double. The implementation may provide other radix-2 interchange floating types _FloatN; the set of such types supported is implementation-defined.
An implementation that defines __STDC_IEC_60559_DFP__ provides the decimal floating types _Decimal32, _Decimal64, and _Decimal128 (6.2.5). If the implementation also defines __STDC_IEC_60559_TYPES__, it may provide other radix-10 interchange floating types _DecimalN; the set of such types supported is implementation-defined.
H.2.3 Non-arithmetic interchange formats
An implementation supports ISO/IEC 60559 non-arithmetic interchange formats by providing the associated encoding-to-encoding conversion functions (H.11.4.3) in <math.h> and the string-fromencoding functions (H.12.4) and string-to-encoding functions (H.12.5) in <stdlib.h>.
An implementation that defines __STDC_IEC_60559_BFP__ and __STDC_IEC_60559_TYPES__ supports some ISO/IEC 60559 radix-2 interchange formats as arithmetic formats by providing types _FloatN (as well as float and double) with those formats. The implementation may support other ISO/IEC 60559 radix-2 interchange formats as non-arithmetic formats; the set of such formats supported is implementation-defined.
An implementation that defines __STDC_IEC_60559_DFP__ and __STDC_IEC_60559_TYPES__ supports some ISO/IEC 60559 radix-10 interchange formats as arithmetic formats by providing types
H.2.4 Extended floating types
For each of its basic formats, ISO/IEC 60559 specifies an extended format whose maximum exponent and precision exceed those of the basic format it is associated with. Extended formats are intended for arithmetic with more precision and exponent range than is available in the basic formats used for the input data. The extra precision and range often mitigate round-off error and eliminate overflow and underflow in intermediate computations. Table H.5 gives the minimum values of these parameters, as defined for the C floating-point model (5.3.5.3.3). For all ISO/IEC 60559 extended (and interchange) formats, .
Table H.5 — Extended format parameters for floating-point numbers
Extended formats associated with: Parameter binary32 binary64 binary128 decimal64 decimal128 digits ≥ 32 64 128 22 40 1024 16384 65536 6145 24577
Types designated _Float32x, _Float64x, _Float128x, _Decimal64x, and _Decimal128x support the corresponding ISO/IEC 60559 extended formats and are collectively called the extended floating types. The set of values of _Float32x is a subset of the set of values of _Float64x; the set of values of _Float64x is a subset of the set of values of _Float128x. The set of values of _Decimal64x is a subset of the set of values of _Decimal128x. Each extended floating type is not compatible with any other type. An implementation that defines __STDC_IEC_60559_BFP__ and __STDC_IEC_60559_TYPES__ shall provide _Float32x, and may provide one or both of the types _Float64x and _Float128x. An implementation that defines __STDC_IEC_60559_DFP__ and __STDC_IEC_60559_TYPES__ shall provide _Decimal64x, and may provide _Decimal128x. Which (if any) of the optional extended floating types are provided is implementation-defined.
NOTE 1 ISO/IEC 60559 does not specify an extended format associated with the decimal32 format, nor does this annex specify an extended type associated with the _Decimal32 type.
NOTE 2 The _Float32x type can have the same format as double. The _Decimal64x type can have the same format as _Decimal128.
H.2.5 Classification of real floating types
6.2.5 defines standard floating types as a collective name for the types float, double and long double and it defines decimal floating types as a collective name for the types _Decimal32, _Decimal64, and _Decimal128.
H.2.2 defines interchange floating types and H.2.4 defines extended floating types.
The types _FloatN and _FloatNx are collectively called binary floating types.
This subclause broadens decimal floating types to include the types _DecimalN and _DecimalNx, introduced in this annex, as well as _Decimal32, _Decimal64, and _Decimal128.
This subclause broadens real floating types to include all interchange floating types and extended floating types, as well as standard floating types.
Thus, in this annex, real floating types are classified as follows:
- standard floating types, composed of
float,double,long double; - decimal floating types, composed of
_DecimalN,_DecimalNx;
NOTE Standard floating types (which have an implementation-defined radix) are not included in either binary floating types (which always have radix 2) or decimal floating types (which always have radix 10).
H.2.6 Complex types
This subclause broadens the C complex types (6.2.5) to also include similar types whose corresponding real parts have binary floating types. For the types _FloatN and _FloatNx, there are complex types designated respectively as _FloatN _Complex and _FloatNx _Complex. (Complex types are a conditional feature that implementations are not required to support; see 6.10.10.4.)
H.3 Characteristics in <float.h>
This subclause enhances the FLT_EVAL_METHOD and DEC_EVAL_METHOD macros to apply to the types introduced in this annex.
If FLT_RADIX is 2, the value of FLT_EVAL_METHOD (5.3.5.3.3) characterizes the use of evaluation formats for standard floating types and for binary floating types:
indeterminable;
0 evaluate all operations and literals, whose semantic type comprises a set of values that is a strict subset of the values of float, to the range and precision of float; evaluate all other operations and literals to the range and precision of the semantic type;
1 evaluate operations and literals, whose semantic type comprises a set of values that is a strict subset of the values of double, to the range and precision of double; evaluate all other operations and literals to the range and precision of the semantic type;
2 evaluate operations and literals, whose semantic type comprises a set of values that is a strict subset of the values of long double, to the range and precision of long double; evaluate all other operations and literals to the range and precision of the semantic type;
where _FloatN is a supported interchange floating type, evaluate operations and literals, whose semantic type comprises a set of values that is a strict subset of the values of _FloatN, to the range and precision of _FloatN; evaluate all other operations and literals to the range and precision of the semantic type;
where _FloatNx is a supported extended floating type, evaluate operations and literals, whose semantic type comprises a set of values that is a strict subset of the values of _FloatNx, to the range and precision of _FloatNx; evaluate all other operations and literals to the range and precision of the semantic type.
If FLT_RADIX is not 2, the use of evaluation formats for operations and literals of binary floating types is implementation-defined.
The implementation-defined value of DEC_EVAL_METHOD (5.3.5.3.4) characterizes the use of evaluation formats for decimal floating types:
indeterminable;
0 evaluate all operations and literals just to the range and precision of the type;
1 evaluate operations and literals, whose semantic type comprises a set of values that is a strict subset of the values of _Decimal64, to the range and precision of _Decimal64; evaluate all other operations and literals to the range and precision of the semantic type;
This subclause also specifies <float.h> macros, analogous to the macros for standard floating types, that characterize binary floating types in terms of the model presented in 5.3.5.3.3. This subclause generalizes the specification of characteristics in 5.3.5.3.4 to include the decimal floating types introduced in this annex. The prefix FLTN_ indicates the type _FloatN or the non-arithmetic binary interchange format of width . The prefix FLTNX_ indicates the type _FloatNx. The prefix DECN_ indicates the type _DecimalN or the non-arithmetic decimal interchange format of width . The prefix DECNX_ indicates the type _DecimalNx. The type parameters , , and for extended floating types are for the extended floating type itself, not for the basic format that it extends.
If __STDC_WANT_IEC_60559_TYPES_EXT__ is defined (by the user) at the point in the code where <float.h> is first included, the following applies (H.8). For each interchange or extended floating type that the implementation provides, <float.h> shall define the associated macros in the following lists. Conversely, for each such type that the implementation does not provide, <float.h> shall not define the associated macros in the following list, except, the implementation shall define the macros FLTN_DECIMAL_DIG and FLTN_DIG if it supports the ISO/IEC 60559 non-arithmetic binary interchange format of width (H.2.3).
The signaling NaN macros
FLTN_SNAN DECN_SNAN FLTNX_SNAN DECNX_SNAN
expand to constant expressions of types _FloatN, _DecimalN, _FloatNx, and _DecimalNx respectively, representing a signaling NaN. If a signaling NaN macro, optionally preceded by the unary + or - operator, is used as an initializer that is evaluated at translation time to initialize an object of the same type, the object is initialized with a signaling NaN value.
The integer values given in the following lists shall be replaced by integer constant expressions:
- radix of exponent representation, (2 for binary, 10 for decimal)
For the standard floating types, this value is implementation-defined and is specified by the macro FLT_RADIX. For the interchange and extended floating types there is no corresponding macro; the radix is an inherent property of the types.
- The number of bits in the floating-point significand,
FLTN_MANT_DIG FLTNX_MANT_DIG
- The number of digits in the coefficient,
DECN_MANT_DIG DECNX_MANT_DIG FLTN_DECIMAL_DIG FLTNX_DECIMAL_DIG FLTN_DIG FLTNX_DIG FLTN_MIN_EXP FLTNX_MIN_EXP DECN_MIN_EXP DECNX_MIN_EXP FLTN_MIN_10_EXP FLTNX_MIN_10_EXP FLTN_MAX_EXP FLTNX_MAX_EXP DECN_MAX_EXP DECNX_MAX_EXP FLTN_MAX_10_EXP FLTNX_MAX_10_EXP FLTN_MAX FLTNX_MAX DECN_MAX DECNX_MAX FLTN_EPSILON FLTNX_EPSILON DECN_EPSILON DECNX_EPSILON FLTN_MIN FLTNX_MIN DECN_MIN DECNX_MIN FLTN_TRUE_MIN FLTNX_TRUE_MIN DECN_TRUE_MIN DECNX_TRUE_MIN
H.4 Conversions
H.4.1 General
This subclause enhances the usual arithmetic conversions (6.3.2.8) to handle interchange and extended floating types. It supports the ISO/IEC 60559 recommendation against allowing implicit conversions of operands to obtain a common type where the conversion is between types where neither is a subset of (or equivalent to) the other.
This subclause also broadens the operation binding in F.3 for the ISO/IEC 60559 convertFormat operation to apply to ISO/IEC 60559 arithmetic and non-arithmetic formats.
H.4.2 Real floating and integer
When a finite value of interchange or extended floating type is converted to an integer type other than bool, the fractional part is discarded (i.e. the value is truncated toward zero). If the value of the integral part cannot be represented by the integer type, the "invalid" floating-point exception shall be raised and the result of the conversion is unspecified.
When a value of integer type is converted to an interchange or extended floating type, if the value being converted can be represented exactly in the new type, it is unchanged. If the value being converted cannot be represented exactly, the result shall be correctly rounded with exceptions raised as specified in ISO/IEC 60559.
H.4.3 Usual arithmetic conversions
If either operand is of floating type, the common real type is determined as follows:
- If one operand has decimal floating type, the other operand shall not have standard floating type, binary floating type, or complex type.
- If only one operand has a floating type, the other operand is converted to the corresponding real type of the operand of floating type.
- If both operands have the same corresponding real type, no further conversion is needed.
- If both operands have floating types and neither of the sets of values of their corresponding real types is a subset of (or equivalent to) the other, the behavior is undefined.
- Otherwise, if both operands are floating types and the sets of values of their corresponding real types are not equivalent, the operand whose set of values of its corresponding real type is a strict subset of the set of values of the corresponding real type of the other operand is
H.4.4 Arithmetic and non-arithmetic formats
The operation binding in F.3 for the ISO/IEC 60559 convertFormat operation applies to ISO/IEC 60559 arithmetic and non-arithmetic formats as follows:
- For conversions between arithmetic formats supported by floating types (same or different radix) – casts and implicit conversions.
- For same-radix conversions between non-arithmetic interchange formats – encoding-toencoding conversion functions (H.11.4.3).
- For conversions between non-arithmetic interchange formats (same or different radix) – compositions of string-from-encoding functions (H.12.4) (converting exactly) and string-to-encoding functions (H.12.5).
- For same-radix conversions from interchange formats supported by interchange floating types to non-arithmetic interchange formats – compositions of encode functions (H.11.4.2.2, 7.12.17.2, 7.12.17.4) and encoding-to-encoding functions (H.11.4.3).
- For same radix conversions from non-arithmetic interchange formats to interchange formats supported by interchange floating types – compositions of encoding-to-encoding conversion functions (H.11.4.3) and decode functions (H.11.4.2.3, 7.12.17.3, 7.12.17.5). See the example in H.11.4.3.2.
- For conversions from non-arithmetic interchange formats to arithmetic formats supported by floating types (same or different radix) – compositions of string-from-encoding functions (H.12.4) (converting exactly) and numeric conversion functions
strtod, etc. (7.25.2.6, 7.25.2.7). See the example in H.12.3. - For conversions from arithmetic formats supported by floating types to non-arithmetic interchange formats (same or different radix) – compositions of numeric conversion functions
strfromd, etc. (7.25.2.4, 7.25.2.5) (converting exactly) and string-to-encoding functions (H.12.5).
H.5 Lexical Elements
H.5.1 Keywords
This subclause expands the list of keywords (6.4.2) to also include:
-
_FloatN, where is 16, 32, 64, or ≥128 and a multiple of 32 -
_Float32x -
_Float64x -
_Float128x -
_DecimalN, where is 96 or 128 and a multiple of 32 -
_Decimal64x -
_Decimal128x
H.5.2 Literals
This subclause specifies literals of interchange and extended floating types.
A floating suffix dN, DN, dNx, or DNx shall not be used in a hexadecimal-floating-literal.
A floating suffix shall designate a type that the implementation provides.
If a floating literal is suffixed by fN or FN, it has type _FloatN. If suffixed by fNx or FNx, it has type _FloatNx. If suffixed by dN or DN, it has type _DecimalN. If suffixed by dNx or DNx, it has type _DecimalNx.
The quantum exponent of a floating literal of decimal floating type is the same as for the result value of the corresponding strtodN or strtodNx function (H.12.3) for the same numeric string.
NOTE 1 For 32, 64, and 128, the suffixes dN and DN in this subclause for literals of type _DecimalN are equivalent alternatives to the suffixes df, dd, dl, DF, DD, and DL in 6.4.5.3 for the same types.
NOTE 2 It follows from here and from 6.4.5.3 that the valid combinations of such an expanded real floating suffix with a complex suffix correspond to the supported complex types as described in H.2.5.
H.6 Expressions
This subclause expands the specification of expressions to also cover interchange and extended floating types.
Operators involving operands of interchange or extended floating type are evaluated according to the semantics of ISO/IEC 60559, including production of decimal floating-point results with the preferred quantum exponent as specified in ISO/IEC 60559 (see 5.3.5.3.4).
For multiplicative operators (6.5.6), additive operators (6.5.7), relational operators (6.5.9), equality operators (6.5.10), and compound assignment operators (6.5.17.3), if either operand has decimal floating type, the other operand shall not have standard floating type, binary floating type, or complex type.
For conditional operators (6.5.16), if the second or third operand has decimal floating type, the other of those operands shall not have standard floating type, binary floating type, or complex type.
The equivalence of expressions noted in F.9.3 apply to expressions of binary floating types, as well as standard floating types.
H.7 Declarations
This subclause expands the list of type specifiers (6.7.3) to also include:
-
_FloatN, where is 16, 32, 64, or ≥128 and a multiple of 32 -
_Float32x -
_Float64x -
_Float128x -
_DecimalN, where is 96 or 128 and a multiple of 32 -
_Decimal64x -
_Decimal128x
The type specifiers _FloatN (where is 16, 32, 64, or and a multiple of 32), _Float32x, _Float64x, _Float128x, _DecimalN (where is 96 or 128 and a multiple of 32), _Decimal64x, and _Decimal128x shall not be used if the implementation does not support the corresponding types (see 6.10.10.4 and H.2).
This subclause also expands the list under Constraints in 6.7.3 to also include:
-
_FloatN, where is 16, 32, 64, or ≥128 and a multiple of 32 -
_Float32x -
_Float64x -
_Float128x -
_DecimalN, where is 96 or 128 and a multiple of 32 -
_Decimal64x -
_Decimal128x -
_FloatN_Complex, where is 16, 32, 64, or ≥128 and a multiple of 32 -
_Float32x _Complex -
_Float64x _Complex -
_Float128x _Complex
H.8 Identifiers in standard headers
The identifiers added to library headers by this annex are defined or declared by their respective headers only if the macro __STDC_WANT_IEC_60559_TYPES_EXT__ is defined (by the user) at the point in the code where the appropriate header is first included.
H.9 Complex arithmetic <complex.h>
This subclause specifies complex functions for corresponding real types that are binary floating types.
Each function synopsis in 7.3 specifies a family of functions including a principal function with one or more double complex parameters and a double complex or double return value. This subclause expands the synopsis to also include other functions, with the same name as the principal function but with fN and fNx suffixes, which are corresponding functions whose parameters and return values have corresponding real types _FloatN and _FloatNx.
The following function prototypes are added to the synopses of the respective subclauses in 7.3. For each binary floating type that the implementation provides, <complex.h> shall declare the
_FloatN complex cacosfN(_FloatN complex z); _FloatNx complex cacosfNx(_FloatNx complex z); _FloatN complex casinfN(_FloatN complex z); _FloatNx complex casinfNx(_FloatNx complex z); _FloatN complex catanfN(_FloatN complex z); _FloatNx complex catanfNx(_FloatNx complex z); _FloatN complex ccosfN(_FloatN complex z); _FloatNx complex ccosfNx(_FloatNx complex z); _FloatN complex csinfN(_FloatN complex z); _FloatNx complex csinfNx(_FloatNx complex z); _FloatN complex ctanfN(_FloatN complex z); _FloatNx complex ctanfNx(_FloatNx complex z); _FloatN complex cacoshfN(_FloatN complex z); _FloatNx complex cacoshfNx(_FloatNx complex z); _FloatN complex casinhfN(_FloatN complex z); _FloatNx complex casinhfNx(_FloatNx complex z); _FloatN complex catanhfN(_FloatN complex z); _FloatNx complex catanhfNx(_FloatNx complex z); _FloatN complex ccoshfN(_FloatN complex z); _FloatNx complex ccoshfNx(_FloatNx complex z); _FloatN complex csinhfN(_FloatN complex z); _FloatNx complex csinhfNx(_FloatNx complex z); _FloatN complex ctanhfN(_FloatN complex z); _FloatNx complex ctanhfNx(_FloatNx complex z); _FloatN complex cexpfN(_FloatN complex z); _FloatNx complex cexpfNx(_FloatNx complex z); _FloatN complex clogfN(_FloatN complex z); _FloatNx complex clogfNx(_FloatNx complex z); _FloatN cabsfN(_FloatN complex z); _FloatNx cabsfNx(_FloatNx complex z); _FloatN complex cpowfN(_FloatN complex x, _FloatN complex y); _FloatNx complex cpowfNx(_FloatNx complex x, _FloatNx complex y); _FloatN complex csqrtfN(_FloatN complex z); _FloatNx complex csqrtfNx(_FloatNx complex z); _FloatN cargfN(_FloatN complex z); _FloatNx cargfNx(_FloatNx complex z); _FloatN cimagfN(_FloatN complex z); _FloatNx cimagfNx(_FloatNx complex z); _FloatN complex CMPLXFN(_FloatN x, _FloatN y); _FloatNx complex CMPLXFNX(_FloatNx x, _FloatNx y); _FloatN complex conjfN(_FloatN complex z); _FloatNx complex conjfNx(_FloatNx complex z); _FloatN complex cprojfN(_FloatN complex z); _FloatNx complex cprojfNx(_FloatNx complex z); _FloatN crealfN(_FloatN complex z); _FloatNx crealfNx(_FloatNx complex z);
For the functions listed in "future library directions" for <complex.h> (7.35.2), the possible suffixes are expanded to also include fN and fNx.
H.10 Floating-point environment
This subclause broadens the effects of the floating-point environment (7.6) to apply to types and formats specified in this annex.
The same floating-point status flags are used by floating-point operations for all floating types, including those types introduced in this annex, and by conversions for ISO/IEC 60559 non-arithmetic interchange formats.
Both the dynamic rounding direction mode accessed by fegetround and fesetround and the FENV_ROUND rounding control pragma apply to operations for binary floating types, as well as for standard floating types, and also to conversions for radix-2 non-arithmetic interchange formats. Likewise, both the dynamic rounding direction mode accessed by fe_dec_getround and fe_dec_setround and the FENV_DEC_ROUND rounding control pragmas apply to operations for all the decimal floating types, including those decimal floating types introduced in this annex, and to conversions for radix-10 non-arithmetic interchange formats.
Table 7.1, which describes functions affected by constant rounding modes for standard floating types, applies also for binary floating types. Each <math.h> function family listed in the table indicates the family of functions of all standard and binary floating types (for example, the acos family includes acosf, acosl, acosfN, and acosfNx as well as acos). The fMencfN, strfromencfN, and strtoencfN functions are also affected by these constant rounding modes.
Table 7.2, which desctibes functions affected by constant rounding modes for decimal floating types, each <math.h> function family indicates the family of functions of all decimal floating types (for example, the acos family includes acosdN and acosdNx). The dMencbindN, dMencdecdN, strfromencbindN, strfromencdecdN, strtoencbindN, and strtoencdecdN functions are also affected by these constant rounding modes.
H.11 Mathematics <math.h>
H.11.1 General
This subclause specifies types, functions, and macros for interchange and extended floating types, generally corresponding to those specified in 7.12 and F.10.
All classification macros (7.12.4) and comparison macros (7.12.18) naturally extend to handle interchange and extended floating types. For comparison macros, if neither of the sets of values of the argument formats is a subset of (or equivalent to) the other, the behavior is undefined.
This subclause also specifies encoding conversion functions that are part of support for the nonarithmetic interchange formats in ISO/IEC 60559 (see H.2.3).
Most function synopses in 7.12 specify a family of functions including a principal function with one or more double parameters, a double return value, or both. The synopses are expanded to also include functions with the same name as the principal function but with fN, fNx, dN, and dNx suffixes, which are corresponding functions whose parameters, return values, or both are of types _FloatN, _FloatNx, _DecimalN, and _DecimalNx, respectively.
For each interchange or extended floating type that the implementation provides, <math.h> shall define the associated types and macros and declare the associated functions (see H.8). Conversely, for each such type that the implementation does not provide, <math.h> shall not define the associated types and macros or declare the associated functions unless explicitly specified otherwise.
EXAMPLE If the supported standard and binary floating types are as shown in Table H.6:
Table H.6 — Example supported types
Type ISO/IEC 60559 format _Float16 binary16 float, _Float32 binary32 double, _Float64, _Float32x binary64 long double, _Float64x 80-bit binary64-extended _Float128 binary128
then Table H.7 gives the types with _t suffixes for various values for a FLT_EVAL_METHOD of a given value :
Table H.7 — _t type (vertical) vs. (horizontal) relation
_t type 0 1 2 32 _Float16_t float double long double _Float32 float_t float double long double float _Float32_t _Float32 double long double _Float32 double_t double double long double double _Float64_t _Float64 _Float64 long double _Float64 long_double_t long double long double long double long double _Float128_t _Float128 _Float128 _Float128 _Float128
H.11.2 Macros
The macros
HUGE_VAL_FN HUGE_VAL_FNX HUGE_VAL_DN HUGE_VAL_DNX
expand to constant expressions of types _FloatN, _DecimalN, _FloatNx, and _DecimalNx, respectively, representing positive infinity.
The macros
FP_FAST_FMAFN FP_FAST_FMAFNX FP_FAST_FMADN FP_FAST_FMADNX
are, respectively, _FloatN, _DecimalN, _FloatNx, and _DecimalNx analogues of FP_FAST_FMA.
The macros in the following lists are interchange and extended floating type analogues of FP_FAST_FADD, FP_FAST_FADDL, FP_FAST_DADDL, etc.
For , the macros
FP_FAST_FMADDFN FP_FAST_DMADDDN FP_FAST_FMSUBFN FP_FAST_DMSUBDN FP_FAST_FMMULFN FP_FAST_DMMULDN FP_FAST_FMDIVFN FP_FAST_DMDIVDN FP_FAST_FMFMAFN FP_FAST_DMFMADN FP_FAST_FMSQRTFN FP_FAST_DMSQRTDN
characterize the corresponding functions whose arguments are of an interchange floating type of width and whose return type is an interchange floating type of width .
For , the macros
FP_FAST_FMADDFNX FP_FAST_DMADDDNX FP_FAST_FMSUBFNX FP_FAST_DMSUBDNX FP_FAST_FMMULFNX FP_FAST_DMMULDNX FP_FAST_FMDIVFNX FP_FAST_DMDIVDNX FP_FAST_FMFMAFNX FP_FAST_DMFMADNX FP_FAST_FMSQRTFNX FP_FAST_DMSQRTDNX
characterize the corresponding functions whose arguments are of an extended floating type that extends a format of width and whose return type is an interchange floating type of width .
For , the macros
FP_FAST_FMXADDFN FP_FAST_DMXADDDN FP_FAST_FMXSUBFN FP_FAST_DMXSUBDN FP_FAST_FMXMULFN FP_FAST_DMXMULDN FP_FAST_FMXDIVFN FP_FAST_DMXDIVDN FP_FAST_FMXFMAFN FP_FAST_DMXFMADN FP_FAST_FMXSQRTFN FP_FAST_DMXSQRTDN
For , the macros
FP_FAST_FMXADDFNX FP_FAST_DMXADDDNX FP_FAST_FMXSUBFNX FP_FAST_DMXSUBDNX FP_FAST_FMXMULFNX FP_FAST_DMXMULDNX FP_FAST_FMXDIVFNX FP_FAST_DMXDIVDNX FP_FAST_FMXFMAFNX FP_FAST_DMXFMADNX FP_FAST_FMXSQRTFNX FP_FAST_DMXSQRTDNX
characterize the corresponding functions whose arguments are of an extended floating type that extends a format of width and whose return type is an extended floating type that extends a format of width .
H.11.3 Functions
This subclause adds the following functions to the synopses of the respective subclauses in 7.12.
7.12.5 Trigonometric functions
_FloatN acosfN(_FloatN x); _FloatNx acosfNx(_FloatNx x); _DecimalN acosdN(_DecimalN x); _DecimalNx acosdNx(_DecimalNx x); _FloatN asinfN(_FloatN x); _FloatNx asinfNx(_FloatNx x); _DecimalN asindN(_DecimalN x); _DecimalNx asindNx(_DecimalNx x); _FloatN atanfN(_FloatN x); _FloatNx atanfNx(_FloatNx x); _DecimalN atandN(_DecimalN x); _DecimalNx atandNx(_DecimalNx x); _FloatN atan2fN(_FloatN y, _FloatN x); _FloatNx atan2fNx(_FloatNx y, _FloatNx x); _DecimalN atan2dN(_DecimalN y, _DecimalN x); _DecimalNx atan2dNx(_DecimalNx y, _DecimalNx x); _FloatN cosfN(_FloatN x); _FloatNx cosfNx(_FloatNx x); _DecimalN cosdN(_DecimalN x); _DecimalNx cosdNx(_DecimalNx x); _FloatN sinfN(_FloatN x); _FloatNx sinfNx(_FloatNx x); _DecimalN sindN(_DecimalN x); _DecimalNx sindNx(_DecimalNx x); _FloatN tanfN(_FloatN x); _FloatNx tanfNx(_FloatNx x); _DecimalN tandN(_DecimalN x); _DecimalNx tandNx(_DecimalNx x); _FloatN acospifN(_FloatN x); _FloatNx acospifNx(_FloatNx x); _DecimalN acospidN(_DecimalN x); _DecimalNx acospidNx(_DecimalNx x); _FloatN asinpifN(_FloatN x); _FloatNx asinpifNx(_FloatNx x); _DecimalN asinpidN(_DecimalN x); _DecimalNx asinpidNx(_DecimalNx x); _FloatN atanpifN(_FloatN x); _FloatNx atanpifNx(_FloatNx x); _DecimalN atanpidN(_DecimalN x); _DecimalNx atanpidNx(_DecimalNx x); _FloatN atan2pifN(_FloatN y, _FloatN x); _FloatNx atan2pifNx(_FloatNx y, _FloatNx x); _DecimalN atan2pidN(_DecimalN y, _DecimalN x); _DecimalNx atan2pidNx(_DecimalNx y, _DecimalNx x); _FloatN cospifN(_FloatN x); _FloatNx cospifNx(_FloatNx x); _DecimalN cospidN(_DecimalN x); _DecimalNx cospidNx(_DecimalNx x); _FloatN sinpifN(_FloatN x); _FloatNx sinpifNx(_FloatNx x); _DecimalN sinpidN(_DecimalN x); _DecimalNx sinpidNx(_DecimalNx x); _FloatN tanpifN(_FloatN x); _FloatNx tanpifNx(_FloatNx x); _DecimalN tanpidN(_DecimalN x); _DecimalNx tanpidNx(_DecimalNx x); _FloatN acoshfN(_FloatN x); _FloatNx acoshfNx(_FloatNx x); _DecimalN acoshdN(_DecimalN x); _DecimalNx acoshdNx(_DecimalNx x); _FloatN asinhfN(_FloatN x); _FloatNx asinhfNx(_FloatNx x); _DecimalN asinhdN(_DecimalN x); _DecimalNx asinhdNx(_DecimalNx x); _FloatN atanhfN(_FloatN x); _FloatNx atanhfNx(_FloatNx x); _DecimalN atanhdN(_DecimalN x); _DecimalNx atanhdNx(_DecimalNx x); _FloatN coshfN(_FloatN x); _FloatNx coshfNx(_FloatNx x); _DecimalN coshdN(_DecimalN x); _DecimalNx coshdNx(_DecimalNx x); _FloatN sinhfN(_FloatN x); _FloatNx sinhfNx(_FloatNx x); _DecimalN sinhdN(_DecimalN x); _DecimalNx sinhdNx(_DecimalNx x); _FloatN tanhfN(_FloatN x); _FloatNx tanhfNx(_FloatNx x); _DecimalN tanhdN(_DecimalN x); _DecimalNx tanhdNx(_DecimalNx x); _FloatN expfN(_FloatN x); _FloatNx expfNx(_FloatNx x); _DecimalN expdN(_DecimalN x); _DecimalNx expdNx(_DecimalNx x); _FloatN exp10fN(_FloatN x); _FloatNx exp10fNx(_FloatNx x); _DecimalN exp10dN(_DecimalN x); _DecimalNx exp10dNx(_DecimalNx x); _FloatN exp10m1fN(_FloatN x); _FloatNx exp10m1fNx(_FloatNx x); _DecimalN exp10m1dN(_DecimalN x); _DecimalNx exp10m1dNx(_DecimalNx x); _FloatN exp2fN(_FloatN x); _FloatNx exp2fNx(_FloatNx x); _DecimalN exp2dN(_DecimalN x); _DecimalNx exp2dNx(_DecimalNx x); _FloatN exp2m1fN(_FloatN x); _FloatNx exp2m1fNx(_FloatNx x); _DecimalN exp2m1dN(_DecimalN x); _DecimalNx exp2m1dNx(_DecimalNx x); _FloatN expm1fN(_FloatN x); _FloatNx expm1fNx(_FloatNx x); _DecimalN expm1dN(_DecimalN x); _DecimalNx expm1dNx(_DecimalNx x); _FloatN frexpfN(_FloatN value, int *exp); _FloatNx frexpfNx(_FloatNx value, int *exp); _DecimalN frexpdN(_DecimalN value, int *exp); _DecimalNx frexpdNx(_DecimalNx value, int *exp); int ilogbfN(_FloatN x); int ilogbfNx(_FloatNx x); int ilogbdN(_DecimalNx x); int ilogbdNx(_DecimalNx x); _FloatN ldexpfN(_FloatN value, int exp); _FloatNx ldexpfNx(_FloatNx value, int exp); _DecimalN ldexpdN(_DecimalN value, int exp); _DecimalNx ldexpdNx(_DecimalNx value, int exp); long int llogbfN(_FloatN x); long int llogbfNx(_FloatNx x); long int llogbdN(_DecimalN x); long int llogbdNx(_DecimalNx x); _FloatN logfN(_FloatN x); _FloatNx logfNx(_FloatNx x); _DecimalN logdN(_DecimalN x); _DecimalNx logdNx(_DecimalNx x); _FloatN log10fN(_FloatN x); _FloatNx log10fNx(_FloatNx x); _DecimalN log10dN(_DecimalN x); _DecimalNx log10dNx(_DecimalNx x); _FloatN log10p1fN(_FloatN x); _FloatNx log10p1fNx(_FloatNx x); _DecimalN log10p1dN(_DecimalN x); _DecimalNx log10p1dNx(_DecimalNx x); _FloatN log1pfN(_FloatN x); _FloatNx log1pfNx(_FloatNx x); _FloatN logp1fN(_FloatN x); _FloatNx logp1fNx(_FloatNx x); _DecimalN log1pdN(_DecimalN x); _DecimalNx log1pdNx(_DecimalNx x); _DecimalN logp1dN(_DecimalN x); _DecimalNx logp1dNx(_DecimalNx x); _FloatN log2fN(_FloatN x); _FloatNx log2fNx(_FloatNx x); _DecimalN log2dN(_DecimalN x); _DecimalNx log2dNx(_DecimalNx x); _FloatN log2p1fN(_FloatN x); _FloatNx log2p1fNx(_FloatNx x); _DecimalN log2p1dN(_DecimalN x); _DecimalNx log2p1dNx(_DecimalNx x); _FloatN logbfN(_FloatN x); _FloatNx logbfNx(_FloatNx x); _DecimalN logbdN(_DecimalN x); _DecimalNx logbdNx(_DecimalNx x); _FloatN modffN(_FloatN x, _FloatN *iptr); _FloatNx modffNx(_FloatNx x, _FloatNx *iptr); _DecimalN modfdN(_DecimalN x, _DecimalN *iptr); _DecimalNx modfdNx(_DecimalNx x, _DecimalNx *iptr); _FloatN scalbnfN(_FloatN value, int exp); _FloatNx scalbnfNx(_FloatNx value, int exp); _DecimalN scalbndN(_DecimalN value, int exp); _DecimalNx scalbndNx(_DecimalNx value, int exp); _FloatN scalblnfN(_FloatN value, long int exp); _FloatNx scalblnfNx(_FloatNx value, long int exp); _DecimalN scalblndN(_DecimalN value, long int exp); _DecimalNx scalblndNx(_DecimalNx value, long int exp); _FloatN cbrtfN(_FloatN x); _FloatNx cbrtfNx(_FloatNx x); _DecimalN cbrtdN(_DecimalN x); _DecimalNx cbrtdNx(_DecimalNx x); _FloatN compoundnfN(_FloatN x, long long int n); _FloatNx compoundnfNx(_FloatNx x, long long int n); _DecimalN compoundndN(_DecimalN x, long long int n); _DecimalNx compoundndNx(_DecimalNx x, long long int n); _FloatN fabsfN(_FloatN x); _FloatNx fabsfNx(_FloatNx x); _DecimalN fabsdN(_DecimalN x); _DecimalNx fabsdNx(_DecimalNx x); _FloatN hypotfN(_FloatN x, _FloatN y); _FloatNx hypotfNx(_FloatNx x, _FloatNx y); _DecimalN hypotdN(_DecimalN x, _DecimalN y); _DecimalNx hypotdNx(_DecimalNx x, _DecimalNx y); _FloatN powfN(_FloatN x, _FloatN y); _FloatNx powfNx(_FloatNx x, _FloatNx y); _DecimalN powdN(_DecimalN x, _DecimalN y); _DecimalNx powdNx(_DecimalNx x, _DecimalNx y); _FloatN pownfN(_FloatN x, long long int n); _FloatNx pownfNx(_FloatNx x, long long int n); _DecimalN powndN(_DecimalN x, long long int n); _DecimalNx powndNx(_DecimalNx x, long long int n); _FloatN powrfN(_FloatN x, _FloatN y); _FloatNx powrfNx(_FloatNx x, _FloatNx y); _DecimalN powrdN(_DecimalN x, _DecimalN y); _DecimalNx powrdNx(_DecimalNx x, _DecimalNx y); _FloatN rootnfN(_FloatN x, long long int n); _FloatNx rootnfNx(_FloatNx x, long long int n); _DecimalN rootndN(_DecimalN x, long long int n); _DecimalNx rootndNx(_DecimalNx x, long long int n); _FloatN rsqrtfN(_FloatN x); _FloatNx rsqrtfNx(_FloatNx x); _DecimalN rsqrtdN(_DecimalN x); _DecimalNx rsqrtdNx(_DecimalNx x); _FloatN sqrtfN(_FloatN x); _FloatNx sqrtfNx(_FloatNx x); _DecimalN sqrtdN(_DecimalN x); _DecimalNx sqrtdNx(_DecimalNx x); _FloatN erffN(_FloatN x); _FloatNx erffNx(_FloatNx x); _DecimalN erfdN(_DecimalN x); _DecimalNx erfdNx(_DecimalNx x); _FloatN erfcfN(_FloatN x); _FloatNx erfcfNx(_FloatNx x); _DecimalN erfcdN(_DecimalN x); _DecimalNx erfcdNx(_DecimalNx x); _FloatN lgammafN(_FloatN x); _FloatNx lgammafNx(_FloatNx x); _DecimalN lgammadN(_DecimalN x); _DecimalNx lgammadNx(_DecimalNx x); _FloatN tgammafN(_FloatN x); _FloatNx tgammafNx(_FloatNx x); _DecimalN tgammadN(_DecimalN x); _DecimalNx tgammadNx(_DecimalNx x); _FloatN ceilfN(_FloatN x); _FloatNx ceilfNx(_FloatNx x); _DecimalN ceildN(_DecimalN x); _DecimalNx ceildNx(_DecimalNx x); _FloatN floorfN(_FloatN x); _FloatNx floorfNx(_FloatNx x); _DecimalN floordN(_DecimalN x); _DecimalNx floordNx(_DecimalNx x); _FloatN nearbyintfN(_FloatN x); _FloatNx nearbyintfNx(_FloatNx x); _DecimalN nearbyintdN(_DecimalN x); _DecimalNx nearbyintdNx(_DecimalNx x); _FloatN rintfN(_FloatN x); _FloatNx rintfNx(_FloatNx x); _DecimalN rintdN(_DecimalN x); _DecimalNx rintdNx(_DecimalNx x); long int lrintfN(_FloatN x); long int lrintfNx(_FloatNx x); long int lrintdN(_DecimalN x); long int lrintdNx(_DecimalNx x); long long int llrintfN(_FloatN x); long long int llrintfNx(_FloatNx x); long long int llrintdN(_DecimalN x); long long int llrintdNx(_DecimalNx x); _FloatN roundfN(_FloatN x); _FloatNx roundfNx(_FloatNx x); _DecimalN rounddN(_DecimalN x); _DecimalNx rounddNx(_DecimalNx x); long int lroundfN(_FloatN x); long int lroundfNx(_FloatNx x); long int lrounddN(_DecimalN x); long int lrounddNx(_DecimalNx x); long long int llroundfN(_FloatN x); long long int llroundfNx(_FloatNx x); long long int llrounddN(_DecimalN x); long long int llrounddNx(_DecimalNx x); _FloatN roundevenfN(_FloatN x); _FloatNx roundevenfNx(_FloatNx x); _DecimalN roundevendN(_DecimalN x); _DecimalNx roundevendNx(_DecimalNx x); _FloatN truncfN(_FloatN x); _FloatNx truncfNx(_FloatNx x); _DecimalN truncdN(_DecimalN x); _DecimalNx truncdNx(_DecimalNx x); _FloatN fromfpfN(_FloatN x, int rnd, unsigned int width); _FloatNx fromfpfNx(_FloatNx x, int rnd, unsigned int width); _DecimalN fromfpdN(_DecimalN x, int rnd, unsigned int width); _DecimalNx fromfpdNx(_DecimalNx x, int rnd, unsigned int width); _FloatN ufromfpfN(_FloatN x, int rnd, unsigned int width); _FloatNx ufromfpfNx(_FloatNx x, int rnd, unsigned int width); _DecimalN ufromfpdN(_DecimalN x, int rnd, unsigned int width); _DecimalNx ufromfpdNx(_DecimalNx x, int rnd, unsigned int width); _FloatN fromfpxfN(_FloatN x, int rnd, unsigned int width); _FloatNx fromfpxfNx(_FloatNx x, int rnd, unsigned int width); _DecimalN fromfpxdN(_DecimalN x, int rnd, unsigned int width); _DecimalNx fromfpxdNx(_DecimalNx x, int rnd, unsigned int width); _FloatN ufromfpxfN(_FloatN x, int rnd, unsigned int width); _FloatNx ufromfpxfNx(_FloatNx x, int rnd, unsigned int width); _DecimalN ufromfpxdN(_DecimalN x, int rnd, unsigned int width); _DecimalNx ufromfpxdNx(_DecimalNx x, int rnd, unsigned int width); _FloatN fmodfN(_FloatN x, _FloatN y); _FloatNx fmodfNx(_FloatNx x, _FloatNx y); _DecimalN fmoddN(_DecimalN x, _DecimalN y); _DecimalNx fmoddNx(_DecimalNx x, _DecimalNx y); _FloatN remainderfN(_FloatN x, _FloatN y); _FloatNx remainderfNx(_FloatNx x, _FloatNx y); _DecimalN remainderdN(_DecimalN x, _DecimalN y); _DecimalNx remainderdNx(_DecimalNx x, _DecimalNx y); _FloatN remquofN(_FloatN x, _FloatN y, int *quo); _FloatNx remquofNx(_FloatNx x, _FloatNx y, int *quo); _FloatN copysignfN(_FloatN x, _FloatN y); _FloatNx copysignfNx(_FloatNx x, _FloatNx y); _DecimalN copysigndN(_DecimalN x, _DecimalN y); _DecimalNx copysigndNx(_DecimalNx x, _DecimalNx y); _FloatN nanfN(const char *tagp); _FloatNx nanfNx(const char *tagp); _DecimalN nandN(const char *tagp); _DecimalNx nandNx(const char *tagp); _FloatN nextafterfN(_FloatN x, _FloatN y); _FloatNx nextafterfNx(_FloatNx x, _FloatNx y); _DecimalN nextafterdN(_DecimalN x, _DecimalN y); _DecimalNx nextafterdNx(_DecimalNx x, _DecimalNx y); _FloatN nextupfN(_FloatN x); _FloatNx nextupfNx(_FloatNx x); _DecimalN nextupdN(_DecimalN x); _DecimalNx nextupdNx(_DecimalNx x); _FloatN nextdownfN(_FloatN x); _FloatNx nextdownfNx(_FloatNx x); _DecimalN nextdowndN(_DecimalN x); _DecimalNx nextdowndNx(_DecimalNx x); int canonicalizefN(_FloatN *cx, const _FloatN *x); int canonicalizefNx(_FloatNx *cx, const _FloatNx *x); int canonicalizedN(_DecimalN *cx, const _DecimalN *x); int canonicalizedNx(_DecimalNx *cx, const _DecimalNx *x); _FloatN fdimfN(_FloatN x, _FloatN y); _FloatNx fdimfNx(_FloatNx x, _FloatNx y); _DecimalN fdimdN(_DecimalN x, _DecimalN y); _DecimalNx fdimdNx(_DecimalNx x, _DecimalNx y); _FloatN fmaximumfN(_FloatN x, _FloatN y); _FloatNx fmaximumfNx(_FloatNx x, _FloatNx y); _DecimalN fmaximumdN(_DecimalN x, _DecimalN y); _DecimalNx fmaximumdNx(_DecimalNx x, _DecimalNx y); _FloatN fminimumfN(_FloatN x, _FloatN y); _FloatNx fminimumfNx(_FloatNx x, _FloatNx y); _DecimalN fminimumdN(_DecimalN x, _DecimalN y); _DecimalNx fminimumdNx(_DecimalNx x, _DecimalNx y); _FloatN fmaximum_magfN(_FloatN x, _FloatN y); _FloatNx fmaximum_magfNx(_FloatNx x, _FloatNx y); _DecimalN fmaximum_magdN(_DecimalN x, _DecimalN y); _DecimalNx fmaximum_magdNx(_DecimalNx x, _DecimalNx y); _FloatN fminimum_magfN(_FloatN x, _FloatN y); _FloatNx fminimum_magfNx(_FloatNx x, _FloatNx y); _DecimalN fminimum_magdN(_DecimalN x, _DecimalN y); _DecimalNx fminimum_magdNx(_DecimalNx x, _DecimalNx y); _FloatN fmaximum_numfN(_FloatN x, _FloatN y); _FloatNx fmaximum_numfNx(_FloatNx x, _FloatNx y); _DecimalN fmaximum_numdN(_DecimalN x, _DecimalN y); _DecimalNx fmaximum_numdNx(_DecimalNx x, _DecimalNx y); _FloatN fminimum_numfN(_FloatN x, _FloatN y); _FloatNx fminimum_numfNx(_FloatNx x, _FloatNx y); _DecimalN fminimum_numdN(_DecimalN x, _DecimalN y); _DecimalNx fminimum_numdNx(_DecimalNx x, _DecimalNx y); _FloatN fmaximum_mag_numfN(_FloatN x, _FloatN y); _FloatNx fmaximum_mag_numfNx(_FloatNx x, _FloatNx y); _DecimalN fmaximum_mag_numdN(_DecimalN x, _DecimalN y); _DecimalNx fmaximum_mag_numdNx(_DecimalNx x, _DecimalNx y); _FloatN fminimum_mag_numfN(_FloatN x, _FloatN y); _FloatNx fminimum_mag_numfNx(_FloatNx x, _FloatNx y); _DecimalN fminimum_mag_numdN(_DecimalN x, _DecimalN y); _DecimalNx fminimum_mag_numdNx(_DecimalNx x, _DecimalNx y); _FloatN fmafN(_FloatN x, _FloatN y, _FloatN z); _FloatNx fmafNx(_FloatNx x, _FloatNx y, _FloatNx z); _DecimalN fmadN(_DecimalN x, _DecimalN y, _DecimalN z); _DecimalNx fmadNx(_DecimalNx x, _DecimalNx y, _DecimalNx z); _FloatM fMaddfN(_FloatN x, _FloatN y); // M < N _FloatM fMaddfNx(_FloatNx x, _FloatNx y); // M ≤ N _FloatMx fMxaddfN(_FloatN x, _FloatN y); // M < N _FloatMx fMxaddfNx(_FloatNx x, _FloatNx y); // M < N _DecimalM dMadddN(_DecimalN x, _DecimalN y); // M < N _DecimalM dMadddNx(_DecimalNx x, _DecimalNx y); // M ≤ N _DecimalMx dMxadddN(_DecimalN x, _DecimalN y); // M ≤ N _DecimalMx dMxadddNx(_DecimalNx x, _DecimalNx y); // M ≤ N _FloatM fMsubfN(_FloatN x, _FloatN y); // M < N _FloatM fMsubfNx(_FloatNx x, _FloatNx y); // M ≤ N _FloatMx fMxsubfN(_FloatN x, _FloatN y); // M < N _FloatMx fMxsubfNx(_FloatNx x, _FloatNx y); // M < N _DecimalM dMsubdN(_DecimalN x, _DecimalN y); // M < N _DecimalM dMsubdNx(_DecimalNx x, _DecimalNx y); // M ≤ N _DecimalMx dMxsubdN(_DecimalN x, _DecimalN y); // M < N _DecimalMx dMxsubdNx(_DecimalNx x, _DecimalNx y); // M < N _FloatM fMmulfN(_FloatN x, _FloatN y); // M < N _FloatM fMmulfNx(_FloatNx x, _FloatNx y); // M ≤ N _FloatMx fMxmulfN(_FloatN x, _FloatN y); // M < N _FloatMx fMxmulfNx(_FloatNx x, _FloatNx y); // M < N _DecimalM dMmuldN(_DecimalN x, _DecimalN y); // M < N _DecimalM dMmuldNx(_DecimalNx x, _DecimalNx y); // M ≤ N _DecimalMx dMxmuldN(_DecimalN x, _DecimalN y); // M < N _DecimalMx dMxmuldNx(_DecimalNx x, _DecimalNx y); // M < N _FloatM fMdivfN(_FloatN x, _FloatN y); // M < N _FloatM fMdivfNx(_FloatNx x, _FloatNx y); // M ≤ N _FloatMx fMxdivfN(_FloatN x, _FloatN y); // M < N _FloatMx fMxdivfNx(_FloatNx x, _FloatNx y); // M < N _DecimalM dMdivdN(_DecimalN x, _DecimalN y); // M < N _DecimalM dMdivdNx(_DecimalNx x, _DecimalNx y); // M ≤ N _DecimalMx dMxdivdN(_DecimalN x, _DecimalN y); // M < N _DecimalMx dMxdivdNx(_DecimalNx x, _DecimalNx y); // M < N _FloatM fMfmafN(_FloatN x, _FloatN y, _FloatN z); // M < N _FloatM fMfmafNx(_FloatNx x, _FloatNx y, _FloatNx z); // M ≤ N _FloatMx fMxfmafN(_FloatN x, _FloatN y, _FloatN z); // M < N _FloatMx fMxfmafNx(_FloatNx x, _FloatNx y, _FloatNx z); // M < N _DecimalM dMfmadN(_DecimalN x, _DecimalN y, _DecimalN z); // M < N _DecimalM dMfmadNx(_DecimalNx x, _DecimalNx y, _DecimalNx z); // M ≤ N _DecimalMx dMxfmadN(_DecimalN x, _DecimalN y, _DecimalN z); // M < N _DecimalMx dMxfmadNx(_DecimalNx x, _DecimalNx y, _DecimalNx z); // M < N _FloatM fMsqrtfN(_FloatN x); // M < N _FloatM fMsqrtfNx(_FloatNx x); // M ≤ N _FloatMx fMxsqrtfN(_FloatN x); // M < N _FloatMx fMxsqrtfNx(_FloatNx x); // M < N _DecimalM dMsqrtdN(_DecimalN x); // M < N _DecimalM dMsqrtdNx(_DecimalNx x); // M ≤ N _DecimalMx dMxsqrtdN(_DecimalN x); // M < N _DecimalMx dMxsqrtdNx(_DecimalNx x); // M < N _DecimalN quantizedN(_DecimalN x, _DecimalN y); _DecimalNx quantizedNx(_DecimalNx x, _DecimalNx y); bool samequantumdN(_DecimalN x, _DecimalN y); bool samequantumdNx(_DecimalNx x, _DecimalNx y); _DecimalN quantumdN(_DecimalN x); _DecimalNx quantumdNx(_DecimalNx x); long long int llquantexpdN(_DecimalN x); long long int llquantexpdNx(_DecimalNx x); void encodedecdN(unsigned char * restrict encptr, const _DecimalN * restrict xptr); void decodedecdN(_DecimalN * restrict xptr, const unsigned char * restrict encptr); void encodebindN(unsigned char * restrict encptr, const _DecimalN * restrict xptr); void decodebindN(_DecimalN * restrict xptr, const unsigned char * restrict encptr); int totalorderfN(const _FloatN *x, const _FloatN *y); int totalorderfNx(const _FloatNx *x, const _FloatNx *y); int totalorderdN(const _DecimalN *x, const _DecimalN *y); int totalorderdNx(const _DecimalNx *x, const _DecimalNx *y); int totalordermagfN(const _FloatN *x, const _FloatN *y); int totalordermagfNx(const _FloatNx *x, const _FloatNx *y); int totalordermagdN(const _DecimalN *x, const _DecimalN *y); int totalordermagdNx(const _DecimalNx *x, const _DecimalNx *y); _FloatN getpayloadfN(const _FloatN *x); _FloatNx getpayloadfNx(const _FloatNx *x); _DecimalN getpayloaddN(const _DecimalN *x); _DecimalNx getpayloaddNx(const _DecimalNx *x); int setpayloadfN(_FloatN *res, _FloatN pl); int setpayloadfNx(_FloatNx *res, _FloatNx pl); int setpayloaddN(_DecimalN *res, _DecimalN pl); int setpayloaddNx(_DecimalNx *res, _DecimalNx pl); int setpayloadsigfN(_FloatN *res, _FloatN pl); int setpayloadsigfNx(_FloatNx *res, _FloatNx pl); int setpayloadsigdN(_DecimalN *res, _DecimalN pl); int setpayloadsigdNx(_DecimalNx *res, _DecimalNx pl);
The specification of the frexp functions (7.12.7.7) applies to the functions for binary floating types like those for standard floating types: the exponent is an integral power of 2 and, when applicable, value equals *exp.
The specification of the ldexp functions (7.12.7.9) applies to the functions for binary floating types like those for standard floating types: they return x exp.
The specification of the scalbn and scalbln functions (7.12.7.19) applies to binary floating types, with .
H.11.4 Encoding conversion functions
H.11.4.1 General
This subclause introduces <math.h> functions that, together with the numerical conversion functions for encodings in H.12, support the non-arithmetic interchange formats specified by ISO/IEC 60559. Support for these formats is an optional feature of this annex. Implementations that do not support non-arithmetic interchange formats are not required to declare the functions in this subclause.
Non-arithmetic interchange formats are not associated with floating types. Arrays of element type unsigned char are used as parameters for conversion functions, to represent encodings in interchange formats that may be non-arithmetic formats.
H.11.4.2 Encode and decode functions
H.11.4.2.1 General
This subclause specifies functions to map representations in binary floating types to and from encodings in unsigned char arrays.
H.11.4.2.2 The encodefN functions
Synopsis
#define __STDC_WANT_IEC_60559_TYPES_EXT__ #include <math.h> void encodefN(unsigned char encptr[restrict static N/8], const _FloatN * restrict xptr);
Description
The encodefN functions convert *xptr into an ISO/IEC 60559 binary encoding and store the resulting encoding as an /8 element array, with 8 bits per array element, in the object pointed to by encptr. The order of bytes in the array follows the endianness specified with __STDC_ENDIAN_NATIVE__ (7.18.2). These functions preserve the value of *xptr and raise no floating-point exceptions. If *xptr is non-canonical, these functions can produce a canonical encoding.
Returns
The encodefN functions return no value.
H.11.4.2.3 The decodefN functions
Synopsis
#define __STDC_WANT_IEC_60559_TYPES_EXT__ #include <math.h> void decodefN(_FloatN * restrict xptr, const unsigned char encptr[restrict static N/8]);
Description
The decodefN functions interpret the /8 element array pointed to by encptr as an ISO/IEC 60559 binary encoding, with 8 bits per array element. The order of bytes in the array follows the endianness specified with __STDC_ENDIAN_NATIVE__ (7.18.2). These functions convert the given encoding into a representation in the type _FloatN, and store the result in the object pointed to by xptr. These functions preserve the encoded value and raise no floating-point exceptions. If the encoding is non-canonical, these functions can produce a canonical representation.
Returns
The decodefN functions return no value.
See Example in H.11.4.3.2.
H.11.4.3 Encoding-to-encoding conversion functions
H.11.4.3.1 General
An implementation shall declare an fMencfN function for each and equal to the width of a supported ISO/IEC 60559 arithmetic or non-arithmetic binary interchange format, . An implementation shall provide both dMencdecdN and dMencbindN functions for each and equal to the width of a supported ISO/IEC 60559 arithmetic or non-arithmetic decimal interchange format, .
H.11.4.3.2 The fMencfN functions
Synopsis
#define __STDC_WANT_IEC_60559_TYPES_EXT__ #include <math.h> void fMencfN(unsigned char encMptr[restrict static M/8], const unsigned char encNptr[restrict static N/8]);
Description
The fMencfN functions convert between ISO/IEC 60559 binary interchange formats. These functions interpret the /8 element array pointed to by encNptr as an encoding of width bits. They convert the encoding to an encoding of width bits and store the resulting encoding as an /8 element array in the object pointed to by encMptr. The conversion rounds and raises floating-point exceptions as specified in ISO/IEC 60559. The order of bytes in the arrays follows the endianness specified with __STDC_ENDIAN_NATIVE__ (7.18.2).
Returns
These functions return no value.
EXAMPLE If the ISO/IEC 60559 binary16 format is supported as a non-arithmetic format, data in binary16 format can be converted to type float as follows:
#define __STDC_WANT_IEC_60559_TYPES_EXT__ #include <math.h> unsigned char b16[2]; // for input binary16 datum float f; // for result unsigned char b32[4]; _Float32 f32; // store input binary16 datum in array b16 ... f32encf16(b32, b16); decodef32(&f32, b32); f = f32; ...
H.11.4.3.3 The dMencdecdN and dMencbindN functions
Synopsis
#define __STDC_WANT_IEC_60559_TYPES_EXT__ #include <math.h> void dMencdecdN(unsigned char encMptr[restrict static M/8], const unsigned char encNptr[restrict static N/8]); void dMencbindN(unsigned char encMptr[restrict static M/8], const unsigned char encNptr[restrict static N/8]);
Description
The dMencdecdN and dMencbindN functions convert between ISO/IEC 60559 decimal interchange formats that use the same encoding scheme. The dMencdecdN functions convert between formats using the encoding scheme based on decimal encoding of the significand. The dMencbindN functions convert between formats using the encoding scheme based on binary encoding of the significand. These functions interpret the /8 element array pointed to by encNptr as an encoding of width bits. They convert the encoding to an encoding of width bits and store the resulting encoding as an /8 element array in the object pointed to by encMptr. The conversion rounds and raises floating-point exceptions as specified in ISO/IEC 60559. The order of bytes in the arrays follows the endianness specified with __STDC_ENDIAN_NATIVE__ (7.18.2).
Returns
These functions return no value.
H.12 Numeric conversion functions <stdlib.h>
H.12.1 General
This clause expands the specification of numeric conversion functions in <stdlib.h> (7.25.2) to also include conversions of strings from and to interchange and extended floating types. The conversions from floating are provided by functions analogous to the strfromd function. The conversions to floating are provided by functions analogous to the strtod function.
This clause also specifies functions to convert strings from and to ISO/IEC 60559 interchange format encodings.
For each interchange or extended floating type that the implementation provides, <stdlib.h> shall declare the associated functions specified in the following subclauses in H.12.2 and H.12.3 (see H.8). Conversely, for each such type that the implementation does not provide, <stdlib.h> shall not declare the associated functions.
For each ISO/IEC 60559 arithmetic or non-arithmetic format that the implementation supports, <stdlib.h> shall declare the associated functions specified the following subclauses in H.12.4 and H.12.5 (see H.8). Conversely, for each such format that the implementation does not provide, <stdlib.h> shall not declare the associated functions.
H.12.2 String from floating
This subclause expands 7.25.2.4 and 7.25.2.5 to also include functions for the interchange and extended floating types. It adds to the synopsis in 7.25.2.4 the prototypes
int strfromfN(char * restrict s, size_t n, const char * restrict format, _FloatN fp); int strfromfNx(char * restrict s, size_t n, const char * restrict format, _FloatNx fp);It encompasses the prototypes in 7.25.2.5 by replacing them with
int strfromdN(char * restrict s, size_t n, const char * restrict format, _DecimalN fp); int strfromdNx(char * restrict s, size_t n, const char * restrict format, _DecimalNx fp);
The descriptions and returns for the added functions are analogous to the ones in 7.25.2.4 and 7.25.2.5.
H.12.3 String to floating
This subclause expands 7.25.2.6, 7.33.4.2.2, 7.25.2.7, and 7.33.4.2.3 to also include functions for the interchange and extended floating types.
It adds to the synopsis in 7.25.2.6 the prototypes
_FloatN strtofN(const char * restrict nptr, char ** restrict endptr); _FloatNx strtofNx(const char * restrict nptr, char ** restrict endptr);It adds to the synopsis in 7.33.4.2.2 the prototypes
_FloatN wcstofN(const wchar_t * restrict nptr, wchar_t ** restrict endptr); _FloatNx wcstofNx(const wchar_t * restrict nptr, wchar_t ** restrict endptr); _DecimalN strtodN(const char * restrict nptr, char ** restrict endptr); _DecimalNx strtodNx(const char * restrict nptr, char ** restrict endptr); _DecimalN wcstodN(const wchar_t * restrict nptr, wchar_t ** restrict endptr); _DecimalNx wcstodNx(const wchar_t * restrict nptr, wchar_t ** restrict endptr);
The descriptions and returns for the added functions are analogous to the ones in 7.25.2.6, 7.33.4.2.2, 7.25.2.7, and 7.33.4.2.3.
EXAMPLE If the ISO/IEC 60559 binary128 format is supported as a non-arithmetic format, data in binary128 format can be converted to type _Decimal128 as follows:
#define __STDC_WANT_IEC_60559_TYPES_EXT__ #include <stdlib.h> #define MAXSIZE 41 // > intermediate hex string length // for the "C" locale unsigned char b128[16]; // for input binary128 datum _Decimal128 d128; // for result char s[MAXSIZE]; // store input binary128 datum in array b128 ... strfromencf128(s, MAXSIZE, "%a", b128); d128 = strtod128(s, nullptr); ...
Use of "%a" for formatting assures an exact conversion of the value in binary format to character sequence. The value of that character sequence will be correctly rounded to _Decimal128, as specified previously in this subclause. Assuming a single-byte decimal-point character as in the "C" locale, the array s for the output of strfromencf128 need have no greater size than 41, which is the maximum length of strings of the form
where there are up to 29 hexadecimal digits and has 5 digits plus 1 for the null character.
H.12.4 String from encoding
H.12.4.1 General
An implementation shall declare the strfromencfN function for each equal to the width of a supported ISO/IEC 60559 arithmetic or non-arithmetic binary interchange format. An implementation shall declare both the strfromencdecdN and strfromencbindN functions for each equal to the width of a supported ISO/IEC 60559 arithmetic or non-arithmetic decimal interchange format.
H.12.4.2 The strfromencfN functions
Synopsis
#define __STDC_WANT_IEC_60559_TYPES_EXT__ #include <stdlib.h> int strfromencfN(char * restrict s, size_t n, const char * restrict format, const unsigned char encptr[restrict static N/8]);
Description
The strfromencfN functions are similar to the strfromfN functions, except the input is the value of the /8 element array pointed to by encptr, interpreted as an ISO/IEC 60559 binary encoding.
Returns
The strfromencfN functions return the same values as corresponding strfromfN functions.
H.12.4.3 The strfromencdecdN and strfromencbindN functions
Synopsis
#define __STDC_WANT_IEC_60559_TYPES_EXT__ #include <stdlib.h> int strfromencdecdN(char * restrict s, size_t n, const char * restrict format, const unsigned char encptr[restrict static N/8]); int strfromencbindN(char * restrict s, size_t n, const char * restrict format, const unsigned char encptr[restrict static N/8]);
Description
The strfromencdecdN functions are similar to the strfromdN functions except the input is the value of the /8 element array pointed to by encptr, interpreted as an ISO/IEC 60559 decimal encoding in the coding scheme based on decimal encoding of the significand. The strfromencbindN functions are similar to the strfromdN functions except the input is the value of the /8 element array pointed to by encptr, interpreted as an ISO/IEC 60559 decimal encoding in the coding scheme based on binary encoding of the significand. The order of bytes in the array follows the endianness specified with __STDC_ENDIAN_NATIVE__ (7.18.2).
Returns
The strfromencdecdN and strfromencbindN functions return the same values as corresponding strfromdN functions.
H.12.5 String to encoding
H.12.5.1 General
An implementation shall declare the strtoencfN and wcstoencfN functions for each equal to the width of a supported ISO/IEC 60559 arithmetic or non-arithmetic binary interchange format. An implementation shall declare the strtoencdecdN, strtoencbindN, wcstoencdecdN, and wcstoencbindN functions for each equal to the width of a supported ISO/IEC 60559 arithmetic or non-arithmetic decimal interchange format.
H.12.5.2 The strtoencfN functions
Synopsis
#define __STDC_WANT_IEC_60559_TYPES_EXT__ #include <stdlib.h> void strtoencfN(unsigned char encptr[restrict static N/8], const char * restrict nptr, char ** restrict endptr);
Description
The strtoencfN functions are similar to the strtofN functions, except they store an ISO/IEC 60559 encoding of the result as an /8 element array in the object pointed to by encptr. The order of bytes in the array follows the endianness specified with __STDC_ENDIAN_NATIVE__ (7.18.2).
Returns
These functions return no value.
H.12.5.3 The wcstoencfN functions
Synopsis
#define __STDC_WANT_IEC_60559_TYPES_EXT__ #include <wchar.h> void wcstoencfN(unsigned char encptr[restrict static N/8], const wchar_t * restrict nptr, wchar_t ** restrict endptr);
Description
The wcstoencfN functions are similar to the wcstofN functions, except they store an ISO/IEC 60559 encoding of the result as an /8 element array in the object pointed to by encptr. The order of bytes in the array follows the endianness specified with __STDC_ENDIAN_NATIVE__ (7.18.2).
Returns
These functions return no value.
H.12.5.4 The strtoencdecdN and strtoencbindN functions
Synopsis
#define __STDC_WANT_IEC_60559_TYPES_EXT__ #include <stdlib.h> void strtoencdecdN(unsigned char encptr[restrict static N/8], const char * restrict nptr, char ** restrict endptr); void strtoencbindN(unsigned char encptr[restrict static N/8], const char * restrict nptr, char ** restrict endptr);
Description
The strtoencdecdN and strtoencbindN functions are similar to the strtodN functions, except they store an ISO/IEC 60559 encoding of the result as an /8 element array in the object pointed to by encptr. The strtoencdecdN functions produce an encoding in the encoding scheme based on decimal encoding of the significand. The strtoencbindN functions produce an encoding in the encoding scheme based on binary encoding of the significand. The order of bytes in the array follows the endianness specified with __STDC_ENDIAN_NATIVE__ (7.18.2).
Returns
These functions return no value.
H.12.5.5 The wcstoencdecdN and wcstoencbindN functions
Synopsis
#define __STDC_WANT_IEC_60559_TYPES_EXT__ #include <wchar.h> void wcstoencdecdN(unsigned char encptr[restrict static N/8], const wchar_t * restrict nptr, wchar_t ** restrict endptr); void wcstoencbindN(unsigned char encptr[restrict static N/8], const wchar_t * restrict nptr, wchar_t ** restrict endptr);
Description
The wcstoencdecdN and wcstoencbindN functions are similar to the wcstodN functions, except they store an ISO/IEC 60559 encoding of the result as an /8 element array in the object pointed to by encptr. The wcstoencdecdN functions produce an encoding in the encoding scheme based on decimal encoding of the significand. The wcstoencbindN functions produce an encoding in the encoding scheme based on binary encoding of the significand. The order of bytes in the array follows the endianness specified with __STDC_ENDIAN_NATIVE__ (7.18.2).
Returns
These functions return no value.
H.13 Type-generic macros <tgmath.h>
This clause enhances the specification of type-generic macros in <tgmath.h> (7.29) to apply to interchange and extended floating types, as well as standard floating types.
If arguments for generic parameters of a type-generic macro are such that some argument has a corresponding real type that is a standard floating type or a binary floating type and another argument is of decimal floating type, the behavior is undefined.
The treatment of arguments of integer type in 7.29 is expanded to cases where another argument has extended type. Arguments of integer type are regarded as having type:
-
_Decimal64x, if any argument has a decimal extended type; otherwise -
_Float32x, if any argument has a binary extended type; otherwise -
_Decimal64, if any argument has decimal type; otherwise -
double
Use of the macros carg, cimag, conj, cproj, or creal with any argument of standard floating type, binary floating type, or complex type invokes a complex function. Use of the macro with an argument of a decimal floating type results in undefined behavior.
The functions that round results to a narrower type have type-generic macros whose names are obtained by omitting any suffix from the function names. Thus, the macros with f or d prefix are (as in 7.29):
fadd fmul ffma dadd dmul dfma fsub fdiv fsqrt dsub ddiv dsqrt
and the macros with fM, fMx, dM, or dMx prefix are:
fMadd fMxmul dMfma fMsub fMxdiv dMsqrt fMmul fMxfma dMxadd fMdiv fMxsqrt dMxsub fMfma dMadd dMxmul fMsqrt dMsub dMxdiv fMxadd dMmul dMxfma fMxsub dMdiv dMxsqrt
All arguments are generic. If any argument is not real, use of the macro results in undefined behavior. The following specification uses the notation to mean the values of are a subset of (or the same as) the values of . The generic parameter type for the function invoked by the macro is determined as follows:
- First, obtain a preliminary type for the generic parameters: if all arguments are of integer type, then is
doubleif the macro prefix isf,d,fN, orfNxand is_Decimal64if the macro prefix isdNordNx; otherwise (if some argument is not of integer type), apply the rules (for determining the corresponding real type of the generic parameters) in 7.29 for macros that do not round result to narrower type, using the usual arithmetic conversion rules in H.4.3, to obtain .
EXAMPLE
With the declarations
#define __STDC_WANT_IEC_60559_TYPES_EXT__ #include <tgmath.h> int n; double d; long double ld; double complex dc; _Float32x f32x; _Float64 f64; _Float64x f64x; _Float128 f128; _Float64x complex f64xc;
functions invoked by use of type-generic macros are shown in the following Table H.11 and Table H.12. means the values of are a subset of (or the same as) the values of type2, and type1 ⊂type2 means the values of are a strict subset of the values of :
Some type-generic macros that round the result to a narrower type function behave as shown in Table H.12.
I Common warnings
I.1 Introduction
An implementation may generate warnings in many situations to help find a source of unintended behavior during the translation or execution of a program. Many such situations are not specified as part of this document.
I.2 Common situations
The following are a few of the common situations where an implementation may generate a warning:
- A new
structoruniontype appears in a function prototype (6.2.1, 6.7.3.4). - A block with initialization of an object that has automatic storage duration is jumped into (6.2.4).
- An implicit narrowing conversion is encountered, such as the assignment of a
long intor adoubleto anint, or a pointer tovoidto a pointer to any type other than a character type (6.3). - A hexadecimal floating literal cannot be represented exactly in its evaluation format (6.4.5.3).
- An ordinary character literal includes more than one character or a wide character literal includes more than one multibyte character (6.4.5.5).
- The characters
/*are found in a comment (6.4.8). - An "unordered" binary operator (not comma,
&&, or||) contains a side effect to an lvalue in one operand, and a side effect to, or an access to the value of, the identical lvalue in the other operand (6.5.1). - An object is defined but not used (6.7).
- A value is given to an object of an enumerated type other than by assignment of an enumeration constant that is a member of that type, or an enumeration object that has the same type, or the value of a function that returns the same enumerated type (6.7.3.3).
- An aggregate has a partly bracketed initialization (6.7.9).
- A statement cannot be reached (6.8).
- A statement with no apparent effect is encountered (6.8).
- A constant expression is used as the controlling expression of a selection statement (6.8.5).
- An incorrectly formed preprocessing group is encountered while skipping a preprocessing group (6.10.2).
- An unrecognized
#pragmadirective is encountered (6.10.8).
J Portability issues
J.1 Unspecified behavior
The following are unspecified:
(1) The manner and timing of static initialization (5.2.2).
(2) The termination status returned to the hosted environment if the return type of main is not compatible with int (5.2.2.3.4).
(3) The values of objects that are neither lock-free atomic objects nor of type volatile
sig_atomic_t and the state of the floating-point environment, when the processing of the abstract machine is interrupted by receipt of a signal (5.2.2.4).
(4) The behavior of the display device if a printing character is written when the active position is at the final position of a line (5.3.3).
(5) The behavior of the display device if a backspace character is written when the active position is at the initial position of a line (5.3.3).
(6) The behavior of the display device if a horizontal tab character is written when the active position is at or past the last defined horizontal tabulation position (5.3.3).
(7) The behavior of the display device if a vertical tab character is written when the active position is at or past the last defined vertical tabulation position (5.3.3).
(8) How an extended source character that does not correspond to a universal character name counts toward the significant initial characters in an external identifier (5.3.5.2).
(9) Many aspects of the representations of types (6.2.6).
(10) The value of padding bytes when storing values in structures or unions (6.2.6.1).
(11) The values of bytes that correspond to union members other than the one last stored into (6.2.6.1).
(12) The representation used when storing a value in an object that has more than one object representation for that value (6.2.6.1).
(13) The values of any padding bits in integer representations (6.2.6.2).
(14) Whether two string literals result in distinct arrays (6.4.6).
(15) The order in which subexpressions are evaluated and the order in which side effects take place, except as specified for the function-call (), &&, ||, ?:, and comma operators (6.5.1).
(16) The order in which the function designator, arguments, and subexpressions within the arguments are evaluated in a function call (6.5.3.3).
(17) The order of side effects among compound literal initialization list expressions (6.5.3.6).
(18) The order in which the operands of an assignment operator are evaluated (6.5.17).
(19) The alignment of the addressable storage unit allocated to hold a bit-field (6.7.3.2).
(20) Whether a call to an inline function uses the inline definition or the external definition of the function (6.7.5).
(21) Whether a size expression is evaluated when it is part of the operand of a sizeof operator and changing the value of the size expression would not affect the result of the operator (6.7.7.3).
J.2 Undefined behavior
The behavior is undefined in the following circumstances:
(1) A "shall" or "shall not" requirement that appears outside of a constraint is violated (Clause 4).
(2) A program in a hosted environment does not define a function named main using one of the specified forms (5.2.2.3.2).
(3) The execution of a program contains a data race (5.2.2.5).
(4) A character not in the basic source character set is encountered in a source file, except in an identifier, a character literal, a string literal, a header name, a comment, or a preprocessing token that is never converted to a token (5.3.1).
(5) An identifier, comment, string literal, character literal, or header name contains an invalid multibyte character or does not begin and end in the initial shift state (5.3.2).
(6) An object is referred to outside of its lifetime (6.2.4).
(7) The value of a pointer to an object whose lifetime has ended is used (6.2.4).
(8) The value of an object with automatic storage duration is used while the object has an indeterminate representation (6.2.4, 6.7.11, 6.8).
(9) A non-value representation is read by an lvalue expression that does not have character type (6.2.6.1).
(10) A non-value representation is produced by a side effect that modifies any part of the object using an lvalue expression that does not have character type (6.2.6.1).
(11) Two declarations of the same object or function specify types that are not compatible (6.2.7).
(12) A program requires the formation of a composite type from a variable length array type whose size is specified by an expression that is not evaluated (6.2.7).
(13) Conversion to or from an integer type produces a value outside the range that can be represented (6.3.2.4).
(14) Demotion of one real floating type to another produces a value outside the range that can be represented (6.3.2.5).
(15) An lvalue does not designate an object when evaluated (6.3.3.1).
(16) An lvalue designating an object of automatic storage duration that could have been declared with the register storage class is used in a context that requires the value of the designated object, but the object is uninitialized. (6.3.3.1).
(17) Conversion of a pointer to an integer type produces a value outside the range that can be represented (6.3.3.3).
(18) Conversion between two pointer types produces a result that is incorrectly aligned (6.3.3.3).
(19) A pointer is used to call a function whose type is not compatible with the referenced type (6.3.3.3).
(20) An unmatched ’ or " character is encountered on a logical source line during tokenization (6.4).
(21) A reserved keyword token is used in translation phase 7 or 8 (5.2.1.2) for some purpose other than as a keyword (6.4.2).
(22) A universal character name in an identifier does not designate a character whose encoding falls into one of the specified ranges (6.4.3.1).
J.3 Implementation-defined behavior
J.3.1 General
A conforming implementation is required to document its choice of behavior in each of the areas listed in this subclause. The following are implementation-defined:
J.3.2 Translation
(1) How a diagnostic is identified (3.15, 5.2.1.3).
(2) Whether each nonempty sequence of white-space characters other than new-line is retained or replaced by one space character in translation phase 3 (5.2.1.2).
J.3.3 Environment
(1) The mapping between physical source file multibyte characters and the source character set in translation phase 1 (5.2.1.2).
(2) The name and type of the function called at program startup in a freestanding environment (5.2.2.2).
(3) The effect of program termination in a freestanding environment (5.2.2.2).
(4) An alternative manner in which the main function may be defined (5.2.2.3.2).
(5) The values given to the strings pointed to by the argv argument to main (5.2.2.3.2).
(6) What constitutes an interactive device (5.2.2.4).
(7) Whether a program can have more than one thread of execution in a freestanding environment (5.2.2.5).
(8) The set of signals, their semantics, and their default handling (7.14).
(9) Signal values other than SIGFPE, SIGILL, and SIGSEGV that correspond to a computational exception (7.14.2.1).
(10) Signals for which the equivalent of signal(sig, SIG_IGN); is executed at program startup (7.14.2.1).
(11) The set of environment names and the method for altering the environment list used by the
getenv function (7.25.5.6).
(12) The manner of execution of the string by the system function (7.25.5.8).
J.3.4 Identifiers
(1) Which additional multibyte characters may appear in identifiers and their correspondence to universal character names (6.4.3).
(2) The number of significant initial characters in an identifier (5.3.5.2, 6.4.3).
J.3.5 Characters
(1) The number of bits in a byte (3.7).
(2) The values of the members of the execution character set (5.3.1).
(3) The unique value of the member of the execution character set produced for each of the standard alphabetic escape sequences (5.3.3).
(4) The value of a char object into which has been stored any character other than a member of the basic execution character set (6.2.5).
(5) Which of signed char or unsigned char has the same range, representation, and behavior as "plain" char (6.2.5, 6.3.2.1).
(6) The literal encoding, which maps of the characters of the execution character set to the values in a character literal or string literal (6.2.9, 6.4.5.5).
(7) The wide literal encoding, of the characters of the execution character set to the values in a
wchar_t character literal or wchar_t string literal (6.2.9, 6.4.5.5).
(8) The mapping of members of the source character set (in character literals and string literals) to members of the execution character set (6.4.5.5, 5.2.1.2).
(9) The value of an ordinary character literal containing more than one character or containing a character or escape sequence that does not map to a single-byte execution character (6.4.5.5).
(10) The value of a wide character literal containing more than one multibyte character or a single multibyte character that maps to multiple members of the extended execution character set, or containing a multibyte character or escape sequence not represented in the extended execution character set (6.4.5.5).
(11) The current locale used to convert a wide character literal consisting of a single multibyte character that maps to a member of the extended execution character set into a corresponding wide character code (6.4.5.5).
(12) The current locale used to convert a wide string literal into corresponding wide character codes (6.4.6).
(13) The value of a string literal containing a multibyte character or escape sequence not represented in the execution character set (6.4.6).
(14) The encoding of wchar_t where the macro __STDC_ISO_10646__ is not defined (6.10.10.3).
J.3.6 Integers
(1) Any extended integer types that exist in the implementation (6.2.5).
(2) The rank of any extended integer type relative to another extended integer type with the same precision (6.3.2.1).
(3) The result of, or the signal raised by, converting an integer to a signed integer type when the value cannot be represented in an object of that type (6.3.2.3).
(4) The results of some bitwise operations on signed integers (6.5.1).
J.3.7 Floating-point
(1) The accuracy of the floating-point operations and of the library functions in <math.h> and <complex.h> that return floating-point results (5.3.5.3.3).
(2) The accuracy of the conversions between floating-point internal representations and string representations performed by the library functions in <stdio.h>, <stdlib.h>, and <wchar.h> (5.3.5.3.3).
(3) The rounding behaviors characterized by non-standard values of FLT_ROUNDS (5.3.5.3.3).
(4) The evaluation methods characterized by non-standard negative values of FLT_EVAL_METHOD
(5.3.5.3.3).
(5) The evaluation methods characterized by non-standard negative values of DEC_EVAL_METHOD
(5.3.5.3.4).
(6) If decimal floating types are supported (6.2.5).
(7) The direction of rounding when an integer is converted to a floating-point number that cannot exactly represent the original value (6.3.2.4).
(8) The direction of rounding when a floating-point number is converted to a narrower floatingpoint number (6.3.2.5).
(9) How the nearest representable value or the larger or smaller representable value immediately adjacent to the nearest representable value is chosen for certain floating literals (6.4.5.3).
(10) Whether and how floating expressions are contracted when not disallowed by the
FP_CONTRACT pragma (6.5.1).
(11) The default state for the FENV_ACCESS pragma (7.6.2).
(12) Additional floating-point exceptions, rounding modes, environments, and classifications, and their macro names (7.6, 7.12).
(13) The default state for the FP_CONTRACT pragma (7.12.3).
J.3.8 Constant expressions
(1) Whether or not an expression not explicitly sanctioned by this document is an extended constant expression, whether or not such extended constant expressions can be used in the same contexts as this document, and whether or not such extended constant expressions can affect potentially detectable semantic changes in the program (6.6.1).
J.3.9 Arrays and pointers
(1) The result of converting a pointer to an integer or vice versa (6.3.3.3).
(2) The size of the result of subtracting two pointers to elements of the same array (6.5.7).
(3) An lvalue having array type is converted to a pointer to the initial element of the array, and the array object has register storage class (6.3.3.1).
J.3.10 Hints
(1) The extent to which suggestions made by using the register storage-class specifier are effective (6.7.2).
(2) The extent to which suggestions made by using the inline function specifier are effective (6.7.5).
J.3.11 Structures, unions, enumerations, and bit-fields
(1) Whether a "plain" int bit-field is treated as a signed int bit-field or as an unsigned int bit-field (6.7.3, 6.7.3.2).
(2) Allowable bit-field types other than bool, signed int, unsigned int, and bit-precise integer types (6.7.3.2).
(3) Whether atomic types are permitted for bit-fields (6.7.3.2).
(4) Whether a bit-field can straddle a storage-unit boundary (6.7.3.2).
(5) The order of allocation of bit-fields within a unit (6.7.3.2).
(6) The alignment of non-bit-field members of structures (6.7.3.2). This should present no problem unless binary data written by one implementation is read by another.
(7) The integer type compatible with each enumerated type without fixed underlying type (6.7.3.3).
(8) A structure or union is defined without any named members (including those specified indirectly via anonymous structures and unions) (6.7.3.2).
J.3.12 Qualifiers
(1) What constitutes an access to an object that has volatile-qualified type (6.7.4).
(2) The specification of a function type includes any type qualifiers (6.7.4).
J.3.13 Types
(1) A program forms the composite type of an enumerated type and a non-enumeration integer type (6.2.7).
(2) Whether or not it is supported for a declaration for which a type is inferred to contain a pointer, array, or function declarator (6.7.10).
(3) Whether or not it is supported for a declaration for which a type is inferred to contain no or more than one declarators (6.7.10).
J.3.14 Preprocessing directives
(1) The locations within #pragma directives where header name preprocessing tokens are recognized (6.4, 6.4.8).
(2) How sequences in both forms of header names are mapped to headers or external source file names (6.4.8).
(3) Whether the value of a character literal in a constant expression that controls conditional inclusion matches the value of the same character literal in the execution character set (6.10.2).
(4) Whether the value of a single-character character literal in a constant expression that controls conditional inclusion may have a negative value (6.10.2).
(5) The places that are searched for an included < > delimited header, and how the places are specified or the header is identified (6.10.3).
(6) How the named source file is searched for in an included " " delimited header name (6.10.3).
(7) How the named resource file is searched for in an embedded " " delimited resource name (6.10.4).
(8) The method by which preprocessing tokens (possibly resulting from macro expansion) in a #include directive are combined into a header name (6.10.3).
J.3.15 Library functions
(1) Any library facilities available to a freestanding program, other than the minimal set required by Clause 4 (5.2.2.2).
(2) The format of the diagnostic printed by the assert macro (7.2.2.1).
(3) The representation of the floating-point status flags stored by the fegetexceptflag function (7.6.5.3).
(4) Whether the feraiseexcept function raises the "inexact" floating-point exception in addition to the "overflow" or "underflow" floating-point exception (7.6.5.4).
(5) Strings other than "C" and "" that may be passed as the second argument to the setlocale
function (7.11.2).
(6) The types defined for float_t and double_t when the value of the FLT_EVAL_METHOD macro is less than 0 (7.12).
(7) The types defined for _Decimal32_t and _Decimal64_t when the value of the DEC_EVAL_METHOD macro is less than 0 (7.12).
(8) Domain errors for the mathematics functions, other than those required by this document (7.12.2).
(9) The values returned by the mathematics functions on domain errors or pole errors (7.12.2).
(10) The values returned by the mathematics functions on underflow range errors, whether errno
is set to the value of the macro ERANGE when the integer expression math_errhandling & MATH_ERRNO is nonzero, and whether the "underflow" floating-point exception is raised when the integer expression math_errhandling & MATH_ERREXCEPT is nonzero. (7.12.2).
(11) Whether a domain error occurs or zero is returned when an fmod function has a second argument of zero (7.12.11.1).
(12) Whether a domain error occurs or zero is returned when a remainder function has a second argument of zero (7.12.11.2).
(13) The base-2 logarithm of the modulus used by the remquo functions in reducing the quotient (7.12.11.3).
(14) Whether a domain error occurs or zero is returned when a remquo function has a second argument of zero (7.12.11.3).
(15) Whether a byte copy of va_list can be used in place of the original (7.16.1).
J.3.16 Architecture
(1) The values or expressions assigned to the macros specified in the headers <float.h>, <limits.h>, and <stdint.h> (5.3.5.3, 7.23).
(2) The result of attempting to indirectly access an object with automatic or thread storage duration from a thread other than the one with which it is associated (6.2.4).
(3) The number, order, and encoding of bytes in any object (when not explicitly specified in this document) (6.2.6.1).
(4) Whether any extended alignments are supported and the contexts in which they are supported (6.2.8).
(5) Valid alignment values other than those returned by an alignof expression for basic types, if any (6.2.8).
(6) Whether any atomic types have fundamental alignment (6.2.8).
(7) The value of the result of the sizeof and alignof operators (6.5.4.5).
J.4 Locale-specific behavior
The following characteristics of a hosted environment are locale-specific and are required to be documented by the implementation:
(1) Additional members of the source and execution character sets beyond the basic character set (5.3.1).
(2) The presence, meaning, and representation of additional multibyte characters in the execution character set beyond the basic character set (5.3.2).
(3) The shift states used for the encoding of multibyte characters (5.3.2).
(4) The direction of writing of successive printing characters (5.3.3).
(5) The decimal-point character (7.1.1).
(6) The set of printing characters (7.4, 7.34.2).
(7) The set of control characters (7.4, 7.34.2).
(8) The sets of characters tested for by the isalpha, isblank, islower, ispunct, isspace,
isupper, iswalpha, iswblank, iswlower, iswpunct, iswspace, or iswupper functions (7.4.2.3, 7.4.2.4, 7.4.2.8, 7.4.2.10, 7.4.2.11, 7.4.2.12, 7.34.2.2.3, 7.34.2.2.4, 7.34.2.2.8, 7.34.2.2.10, 7.34.2.2.11, 7.34.2.2.12).
(9) The native environment (7.11.2).
(10) Additional subject sequences accepted by the numeric conversion functions (7.25.2, 7.33.4.2).
(11) The collation sequence of the execution character set (7.28.4.4, 7.33.4.5.3).
(12) The contents of the error message strings set up by the strerror function (7.28.6.3).
(13) The formats for time and date (7.31.3.6, 7.33.5.1).
(14) Character mappings that are supported by the towctrans function (7.34.1).
(15) Character classifications that are supported by the iswctype function (7.34.1).
J.5 Common extensions
J.5.1 General
The following extensions are widely used in many systems, but are not portable to all implementations. The inclusion of any extension that may cause a strictly conforming program to become invalid renders an implementation nonconforming. Examples of such extensions are new keywords, extra library functions declared in standard headers, or predefined macros with names that do not begin with an underscore.
J.5.2 Environment arguments
In a hosted environment, the main function receives a third argument, char *envp[], that points to a null-terminated array of pointers to char, each of which points to a string that provides information about the environment for this execution of the program (5.2.2.3.2).
J.5.3 Specialized identifiers
Characters other than the underscore _, letters, and digits, that are not part of the basic source character set (such as the dollar sign $, or characters in national character sets) may appear in an identifier (6.4.3).
J.5.4 Lengths and cases of identifiers
J.5.5 Scopes of identifiers
A function identifier, or the identifier of an object the declaration of which contains the keyword extern, has file scope (6.2.1).
J.5.6 Writable string literals
String literals are modifiable (in which case, identical string literals should denote distinct objects) (6.4.6).
J.5.7 Other arithmetic types
Additional arithmetic types, such as __int128 or double double, and their appropriate conversions are defined (6.2.5, 6.3.2). Additional floating types may have more range or precision than long double, may be used for evaluating expressions of other floating types, and may be used to define float_t or double_t. Additional floating types may also have less range or precision than float.
J.5.8 Function pointer casts
A pointer to an object or to void may be cast to a pointer to a function, allowing data to be invoked as a function (6.5.5).
A pointer to a function may be cast to a pointer to an object or to void, allowing a function to be inspected or modified (for example, by a debugger) (6.5.5).
J.5.9 Extended bit-field types
A bit-field may be declared with a type other than bool, unsigned int, signed int, or a bit-precise integer type, with an appropriate maximum width (6.7.3.2).
J.5.10 The fortran keyword
The fortran function specifier may be used in a function declaration to indicate that calls suitable for FORTRAN should be generated, or that a different representation for the external name is to be generated (6.7.5).
J.5.11 The asm keyword
The asm keyword may be used to insert assembly language directly into the translator output (6.8). The most common implementation is via a statement of the form:
asm (character-string-literal );J.5.12 Type inference
A declaration for which a type is inferred (6.7.10) may additionally accept pointer declarators, function declarators, and may have more than one declarator.
J.5.13 Multiple external definitions
There may be more than one external definition for the identifier of an object, with or without the explicit use of the keyword extern; if the definitions disagree, or more than one is initialized, the behavior is undefined (6.9.3).
J.5.14 Predefined macro names
Macro names that do not begin with an underscore, describing the translation and execution environments, are defined by the implementation before translation begins (6.10.10).
J.5.15 Floating-point status flags
If any floating-point status flags are set on normal termination after all calls to functions registered by the atexit function have been made (see 7.25.5.4), the implementation writes some diagnostics indicating the fact to the stderr stream, if it is still open,
J.5.16 Extra arguments for signal handlers
Handlers for specific signals are called with extra arguments in addition to the signal number (7.14.2.1).
J.5.17 Additional stream types and file-opening modes
Additional file-opening modes may be specified by characters appended to the mode argument of the fopen function (7.24.5.3).
J.5.18 Defined file position indicator
The file position indicator is decremented by each successful call to the ungetc or ungetwc function for a text stream, except if its value was zero before a call (7.24.7.10, 7.33.3.10).
J.5.19 Math error reporting
Functions declared in <complex.h> and <math.h> raise SIGFPE to report errors instead of, or in addition to, setting errno or raising floating-point exceptions (7.3, 7.12).
J.6 Reserved identifiers and keywords
J.6.1 General
A lot of identifier preprocessing tokens are used for specific purposes in regular clauses or appendices from translation phase 3 (5.2.1.2) onwards. Using any of these for a purpose different from their description in this document, even if the use is in a context where they are normatively permitted, may have an impact on the portability of code and should thus be avoided.
J.6.2 Rule based identifiers
The following 53 regular expressions characterize identifiers that are systematically reserved by some clause in this document.
ATOMIC_[A-Z][a-zA-Z0-9_]* DBL_[A-Z][a-zA-Z0-9_]* DEC128_[A-Z][a-zA-Z0-9_]* DEC32_[A-Z][a-zA-Z0-9_]* DEC64_[A-Z][a-zA-Z0-9_]* DEC_[A-Z][a-zA-Z0-9_]* E[0-9A-Z][a-zA-Z0-9_]* FE_[A-Z][a-zA-Z0-9_]* FLT_[A-Z][a-zA-Z0-9_]* FP_[A-Z][a-zA-Z0-9_]* INT[a-zA-Z0-9_]*_C INT[a-zA-Z0-9_]*_MAX INT[a-zA-Z0-9_]*_MIN INT[a-zA-Z0-9_]*_WIDTH LC_[A-Z][a-zA-Z0-9_]* LDBL_[A-Z][a-zA-Z0-9_]* MATH_[A-Z][a-zA-Z0-9_]* PRI[a-zBX][a-zA-Z0-9_]* SCN[a-zBX][a-zA-Z0-9_]* SIG[A-Z][a-zA-Z0-9_]* SIG_[A-Z][a-zA-Z0-9_]* TIME_[A-Z][a-zA-Z0-9_]* UINT[a-zA-Z0-9_]*_C UINT[a-zA-Z0-9_]*_MAX UINT[a-zA-Z0-9_]*_WIDTH [a-zA-Z0-9_]*_DECIMAL_DIG [a-zA-Z0-9_]*_DIG
[a-zA-Z0-9_]*_EPSILON [a-zA-Z0-9_]*_MANT_DIG [a-zA-Z0-9_]*_MAX_10_EXP [a-zA-Z0-9_]*_MAX_EXP [a-zA-Z0-9_]*_MAX [a-zA-Z0-9_]*_MIN_10_EXP [a-zA-Z0-9_]*_MIN_EXP [a-zA-Z0-9_]*_MIN [a-zA-Z0-9_]*_SNAN [a-zA-Z0-9_]*_TRUE_MIN _[a-zA-Z_][a-zA-Z0-9_]* atomic_[a-z][a-zA-Z0-9_]* ckd_[a-z][a-zA-Z0-9_]* cnd_[a-z][a-zA-Z0-9_]* cr_[a-z][a-zA-Z0-9_]* int[a-zA-Z0-9_]*_t is[a-z][a-zA-Z0-9_]* mem[a-z][a-zA-Z0-9_]* mtx_[a-z][a-zA-Z0-9_]* stdc_[a-z][a-zA-Z0-9_]* str[a-z][a-zA-Z0-9_]* thrd_[a-z][a-zA-Z0-9_]* to[a-z][a-zA-Z0-9_]* tss_[a-z][a-zA-Z0-9_]* uint[a-zA-Z0-9_]*_t wcs[a-z][a-zA-Z0-9_]*
The following 921 identifiers, keywords or families thereof match these patterns and have particular semantics provided by this document. Each family includes a placeholder, N, standing for an integer representing a type width. For example, intN_t.
atomic_bool ATOMIC_BOOL_LOCK_FREE atomic_char atomic_char16_t ATOMIC_CHAR16_T_LOCK_FREE atomic_char32_t ATOMIC_CHAR32_T_LOCK_FREE atomic_char8_t ATOMIC_CHAR8_T_LOCK_FREE ATOMIC_CHAR_LOCK_FREE atomic_compare_exchange atomic_compare_exchange_strong atomic_compare_exchange_strong_explicit atomic_compare_exchange_weak atomic_compare_exchange_weak_explicit atomic_exchange atomic_exchange_explicit atomic_fetch atomic_fetch_add atomic_fetch_add_explicit atomic_fetch_and atomic_fetch_and_explicit atomic_fetch_or atomic_fetch_or_explicit atomic_fetch_sub atomic_fetch_sub_explicit atomic_fetch_xor atomic_fetch_xor_explicit atomic_flag atomic_flag_clear atomic_flag_clear_explicit ATOMIC_FLAG_INIT atomic_flag_test_and_set atomic_flag_test_and_set_explicit atomic_init atomic_int atomic_intmax_t atomic_intptr_t atomic_int_fast16_t atomic_int_fast32_t atomic_int_fast64_t atomic_int_fast8_t atomic_int_least16_t atomic_int_least32_t atomic_int_least64_t atomic_int_least8_t ATOMIC_INT_LOCK_FREE atomic_is_lock_free atomic_llong ATOMIC_LLONG_LOCK_FREE atomic_load atomic_load_explicit atomic_long ATOMIC_LONG_LOCK_FREE ATOMIC_POINTER_LOCK_FREE atomic_ptrdiff_t atomic_schar
atomic_short ATOMIC_SHORT_LOCK_FREE atomic_signal_fence atomic_size_t atomic_store atomic_store_explicit atomic_thread_fence atomic_uchar atomic_uint atomic_uintmax_t atomic_uintptr_t atomic_uint_fast16_t atomic_uint_fast32_t atomic_uint_fast64_t atomic_uint_fast8_t atomic_uint_least16_t atomic_uint_least32_t atomic_uint_least64_t atomic_uint_least8_t atomic_ullong atomic_ulong atomic_ushort atomic_wchar_t ATOMIC_WCHAR_T_LOCK_FREE BOOL_MAX CHAR_MAX CHAR_MIN ckd_add ckd_mul ckd_sub cnd_broadcast cnd_destroy cnd_init cnd_signal cnd_t cnd_timedwait cnd_wait CR_DECIMAL_DIG DBL_DECIMAL_DIG DBL_DIG DBL_EPSILON DBL_HAS_SUBNORM DBL_IS_IEC_60559 DBL_MANT_DIG DBL_MAX DBL_MAX_10_EXP DBL_MAX_EXP DBL_MIN DBL_MIN_10_EXP DBL_MIN_EXP DBL_NORM_MAX DBL_SNAN DBL_TRUE_MIN DEC128_EPSILON DEC128_MANT_DIG DEC128_MAX DEC128_MAX_EXP
- :
FLT_MAX_EXPFLT_MINFLT_MIN_10_EXPFLT_MIN_EXPFLT_NORM_MAXFLT_RADIXFLT_ROUNDSFLT_SNANFLT_TRUE_MINFOPEN_MAXFP_CONTRACTFP_FAST_D32ADDD128FP_FAST_D32ADDD64FP_FAST_D32DIVD128FP_FAST_D32DIVD64FP_FAST_D32FMAD128FP_FAST_D32FMAD64FP_FAST_D32MULD128FP_FAST_D32MULD64FP_FAST_D32SQRTD128FP_FAST_D32SQRTD64FP_FAST_D32SUBD128FP_FAST_D32SUBD64FP_FAST_D64ADDD128FP_FAST_D64DIVD128FP_FAST_D64FMAD128FP_FAST_D64MULD128FP_FAST_D64SQRTD128FP_FAST_D64SUBD128FP_FAST_DADDLFP_FAST_DDIVLFP_FAST_DFMALFP_FAST_DMULLFP_FAST_DSQRTLFP_FAST_DSUBLFP_FAST_FADDFP_FAST_FADDLFP_FAST_FDIVFP_FAST_FDIVLFP_FAST_FFMAFP_FAST_FFMALFP_FAST_FMAFP_FAST_FMAD128FP_FAST_FMAD32FP_FAST_FMAD64FP_FAST_FMAFFP_FAST_FMALFP_FAST_FMULFP_FAST_FMULLFP_FAST_FSQRTFP_FAST_FSQRTLFP_FAST_FSUBFP_FAST_FSUBLFP_ILOGB0FP_ILOGBNANFP_INFINITEFP_INT_DOWNWARDFP_INT_TONEARESTFP_INT_TONEARESTFROMZEROFP_INT_TOWARDZEROFP_INT_UPWARDissubnormalisunorderedisupperiswalnumiswalphaiswblankiswcntrliswctypeiswdigitiswgraphiswloweriswprintiswpunctiswspaceiswupperiswxdigitisxdigitiszeroLC_ALLLC_COLLATELC_CTYPELC_MONETARYLC_NUMERICLC_TIMELDBL_DECIMAL_DIGLDBL_DIGLDBL_EPSILONLDBL_HAS_SUBNORMLDBL_IS_IEC_60559LDBL_MANT_DIGLDBL_MAXLDBL_MAX_10_EXPLDBL_MAX_EXPLDBL_MINLDBL_MIN_10_EXPLDBL_MIN_EXPLDBL_NORM_MAXLDBL_SNANLDBL_TRUE_MINLLONG_MAXLLONG_MINLONG_MAXLONG_MINMATH_ERREXCEPTMATH_ERRNOMB_CUR_MAXMB_LEN_MAXmemalignmentmemccpymemchrmemcmpmemcpymemcpy_smemmovememmove_smemory_ordermemory_order_acquirememory_order_acq_relmemory_order_consumememory_order_relaxedmemory_order_releaseSCNiFASTNSCNiLEASTNSCNiMAXSCNiPTRSCNoNSCNoFASTNSCNoLEASTNSCNoMAXSCNoPTRSCNuNSCNuFASTNSCNuLEASTNSCNuMAXSCNuPTRSCNxNSCNxFASTNSCNxLEASTNSCNxMAXSCNxPTRSHRT_MAXSHRT_MINSIGABRTSIGFPESIGILLSIGINTSIGSEGVSIGTERMSIG_ATOMIC_MAXSIG_ATOMIC_MINSIG_ATOMIC_WIDTHSIG_DFLSIG_ERRSIG_IGNSIZE_MAXstdc_bit_ceilstdc_bit_ceil_ucstdc_bit_ceil_uistdc_bit_ceil_ulstdc_bit_ceil_ullstdc_bit_ceil_usstdc_bit_floorstdc_bit_floor_ucstdc_bit_floor_uistdc_bit_floor_ulstdc_bit_floor_ullstdc_bit_floor_usstdc_bit_widthstdc_bit_width_ucstdc_bit_width_uistdc_bit_width_ulstdc_bit_width_ullstdc_bit_width_usstdc_c16nrtoc16nstdc_c16nrtoc32nstdc_c16nrtoc8nstdc_c16nrtomcnstdc_c16nrtomwcnstdc_c16snrtoc16snstdc_c16snrtoc32snstdc_c16snrtoc8snstdc_c16snrtomcsnstdc_has_single_bit_ucstdc_has_single_bit_uistdc_has_single_bit_ulstdc_has_single_bit_ullstdc_has_single_bit_usstdc_leading_onesstdc_leading_ones_ucstdc_leading_ones_uistdc_leading_ones_ulstdc_leading_ones_ullstdc_leading_ones_usstdc_leading_zerosstdc_leading_zeros_ucstdc_leading_zeros_uistdc_leading_zeros_ulstdc_leading_zeros_ullstdc_leading_zeros_usstdc_load8_aligned_besNstdc_load8_aligned_beuNstdc_load8_aligned_lesNstdc_load8_aligned_leuNstdc_load8_besNstdc_load8_beuNstdc_load8_lesNstdc_load8_leuNstdc_mcerrstdc_mcerr_incomplete_inputstdc_mcerr_insufficient_outputstdc_mcerr_invalidstdc_mcerr_okstdc_mcnrtoc16nstdc_mcnrtoc32nstdc_mcnrtoc8nstdc_mcnrtomcnstdc_mcnrtomwcnstdc_mcsnrtoc16snstdc_mcsnrtoc32snstdc_mcsnrtoc8snstdc_mcsnrtomcsnstdc_mcsnrtomwcsnSTDC_MC_MAXstdc_memreverse8stdc_memreverse8Nstdc_memreverse8uNstdc_mwcnrtoc16nstdc_mwcnrtoc32nstdc_mwcnrtoc8nstdc_mwcnrtomcnstdc_mwcnrtomwcnstdc_mwcsnrtoc16snstdc_mwcsnrtoc32snstdc_mwcsnrtoc8snstdc_mwcsnrtomcsnstdc_mwcsnrtomwcsnSTDC_MWC_MAXstdc_rotate_leftstdc_rotate_left_ucstdc_rotate_left_uistdc_rotate_left_ulstdc_rotate_left_ullstdc_rotate_left_usstrtodNstrtod128strtod32strtod64strtofstrtoimaxstrtokstrtok_sstrtolstrtoldstrtollstrtoulstrtoullstrtoumaxstructstrxfrmthrd_busythrd_createthrd_currentthrd_detachthrd_equalthrd_errorthrd_exitthrd_jointhrd_nomemthrd_sleepthrd_start_tthrd_successthrd_tthrd_timedoutthrd_yieldTIME_ACTIVETIME_MONOTONICTIME_THREAD_ACTIVETIME_UTCTMP_MAXtolowertotalordertotalorderd128totalorderd32totalorderd64totalorderftotalorderltotalordermagtotalordermagd128totalordermagd32totalordermagd64totalordermagftotalordermagltouppertowctranstowlowertowuppertss_createtss_deletetss_dtor_ttss_gettss_settss_tUCHAR_MAXUINTN_Cwcstokwcstok_swcstolwcstoldwcstollwcstombswcstombs_swcstoulwcstoullwcstoumaxwcsxfrmWINT_MAXWINT_MIN_Alignas_Alignof_Atomic_BitInt_Bool_Complex_Complex_I_Countof_DecimalN_DecimalNx_DecimalN_t_Decimal128_Decimal128x_Decimal32_Decimal32_t_Decimal64_Decimal64x_Decimal64_t_Exit_FloatN_FloatNx_FloatN_t_Float128_Float128x_Float128_t_Float16_Float16_t_Float32_Float32x_Float32_t_Float64_Float64x_Float64_t_Generic_IOFBF_IOLBF_IONBF_Noreturn_Pragma_PRINTF_NAN_LEN_MAX_Static_assert_Thread_local__bool_true_false_are_defined__COUNTER____cplusplus__DATE____deprecated____fallthrough____STDC_VERSION_ASSERT_H____STDC_VERSION_COMPLEX_H____STDC_VERSION_FENV_H____STDC_VERSION_FLOAT_H____STDC_VERSION_INTTYPES_H____STDC_VERSION_LIMITS_H____STDC_VERSION_MATH_H____STDC_VERSION_SETJMP_H____STDC_VERSION_STDARG_H____STDC_VERSION_STDATOMIC_H____STDC_VERSION_STDBIT_H____STDC_VERSION_STDCKDINT_H____STDC_VERSION_STDCOUNTOF_H____STDC_VERSION_STDDEF_H____STDC_VERSION_STDINT_H____STDC_VERSION_STDIO_H____STDC_VERSION_STDLIB_H____STDC_VERSION_STDMCHAR_H____STDC_VERSION_STRING_H____STDC_VERSION_TGMATH_H____STDC_VERSION_TIME_H____STDC_VERSION_UCHAR_H____STDC_VERSION_WCHAR_H____STDC_VERSION____STDC_WANT_IEC_60559_EXT____STDC_WANT_IEC_60559_TYPES_EXT____STDC_WANT_LIB_EXT1____STDC_WIDE_LITERAL_UTF16____STDC_WIDE_LITERAL_UTF32____STDC_WIDE_LITERAL_UTF8____STDC____suffix____TIME____unsequenced____VA_ARGS____VA_OPT_____Noreturn__
J.6.3 Particular identifiers or keywords
The following 1242 identifiers, keywords or families of identifiers are not covered by the previously listed matching patterns and have particular semantics provided by this document.
abort abort_handler_s abs acos acosd128 acosd32 acosd64 acosf acosh acoshd128 acoshd32 acoshd64 acoshf acoshl acosl acospi acospid128
acospid32 acospid64 acospif acospil alignas aligned_alloc alignof and and_eq asctime asctime_s asin asind128 asind32 asind64 asinf asinh
asinhd128 asinhd32 asinhd64 asinhf asinhl asinl asinpi asinpid128 asinpid32 asinpid64 asinpif asinpil assert atan atan2 atan2d128 atan2d32
atan2d64 atan2f atan2l atan2pi atan2pid128 atan2pid32 atan2pid64 atan2pif atan2pil atand128 atand32 atand64 atanf atanh atanhd128 atanhd32 atanhd64
- :
casinpilcatancatanfcatanhcatanhfcatanhlcatanlcatanpicatanpifcatanpilcbrtcbrtd128cbrtd32cbrtd64cbrtfcbrtlccompoundnccompoundnfccompoundnlccosccosfccoshccoshfccoshlccoslccospiccospifccospilceilceild128ceild32ceild64ceilfceillcerfcerfccerfcfcerfclcerffcerflcexpcexp10cexp10fcexp10lcexp10m1cexp10m1fcexp10m1lcexp2cexp2fcexp2lcexp2m1cexp2m1fcexp2m1lcexpfcexplcexpm1cexpm1fcexpm1lcharchar16_tchar32_tchar8_tCHAR_BITCHAR_WIDTHcimagcimagfcimaglclearerrclgammaclgammafclgammalclockCLOCKS_PER_SECclock_tclogclog10clog10fclog10lclog10p1clog10p1fclog10p1lclog1pclog1pfclog1plclog2clog2fclog2lclog2p1clog2p1fclog2p1lclogfcloglclogp1clogp1fclogp1lCMPLXCMPLXFCMPLXLcomplComplexcompoundncompoundnd128compoundnd32compoundnd64compoundnfcompoundnlconjconjfconjlconstconstexprconstraint_handler_tcontinuecopysigncopysignd128copysignd32copysignd64copysignfcopysignlcoscosd128cosd32cosd64cosfcoshcoshd128coshd32coshd64coshfcoshlcoslcospicospid128cospid32cospid64cospifcospilcountofcpowcpowfcpowlcpowncpownfcpownlcpowrcpowrfcpowrlcprojcprojfcprojlcrealcrealfcreallcrootncrootnfcrootnlcrsqrtcrsqrtfcrsqrtlcsincsinfcsinhcsinhfcsinhlcsinlcsinpicsinpifcsinpilcsqrtcsqrtfcsqrtlctanctanfctanhctanhfctanhlctanlctanpictanpifctanpilctgammactgammafctgammaldsqrtdsqrtldsubdsublelifelifdefelifndefelseembedencodebindNencodebind128encodebind32encodebind64encodedecdNencodedecd128encodedecd32encodedecd64endifenumerferfcerfcd128erfcd32erfcd64erfcferfclerfd128erfd32erfd64erfferflerrnoerrno_terrorexitexpexp10exp10d128exp10d32exp10d64exp10fexp10lexp10m1exp10m1d128exp10m1d32exp10m1d64exp10m1fexp10m1lexp2exp2d128exp2d32exp2d64exp2fexp2lexp2m1exp2m1d128exp2m1d32exp2m1d64exp2m1fexp2m1lexpd128expd32expd64expfexplexpm1expm1d128expm1d32expm1d64expm1fexpm1lexternfabsfabsd128fabsd32fabsd64fabsffabslfaddfaddlfallthroughfalsefclosefdimfdimd128fdimd32fdimd64fdimffdimlfdivfdivlfeclearexceptfegetenvfegetexceptflagfegetmodefegetroundfeholdexceptfemode_tFENV_ACCESSFENV_DEC_ROUNDFENV_ROUNDfenv_tfeofferaiseexceptferrorfesetenvfesetexceptfesetexceptflagfesetmodefesetroundfetestexceptfetestexceptflagfeupdateenvfexcept_tfe_dec_getroundfe_dec_setroundfflushffmaffmalfgetcfgetposfgetsfgetwcfgetwsFILEfloatfloat_tfloorfloord128floord32floord64floorffloorlfmafmad128fmad32fmad64fmaffmalfmaxfmaxd128fmaxd32fmaxd64fmaxffmaximumfmaximumd128fmaximumd32fmaximumd64fmaximumffmaximumlfmaximum_magfmaximum_magd128fmaximum_magd32fmaximum_magd64fmaximum_magffmaximum_maglfmaximum_mag_numfmaximum_mag_numd128fmaximum_mag_numd32fmaximum_mag_numd64fmaximum_mag_numffmaximum_mag_numlfmaximum_numfmaximum_numd128fmaximum_numd32fmaximum_numd64fmaximum_numffmaximum_numlfmaxlfminfmind128fmind32fmind64fminffminimumfminimumd128fminimumd32fminimumd64fminimumffminimumlfminimum_magfminimum_magd128fminimum_magd32fscanf_sfseekfsetposfsqrtfsqrtlfsubfsublftellfwidefwprintffwprintf_sfwritefwscanffwscanf_sgetcgetchargetenvgetenv_sgetpayloadgetpayloadd128getpayloadd32getpayloadd64getpayloadfgetpayloadlgets_sgetwcgetwchargmtimegmtime_rgmtime_sgotogroupingHUGE_VALHUGE_VALFHUGE_VALLHUGE_VAL_D128HUGE_VAL_D32HUGE_VAL_D64hypothypotd128hypotd32hypotd64hypotfhypotlIififdefifndefif_emptyignore_handler_silogbilogbd128ilogbd32ilogbd64ilogbfilogblimaginaryimaxabsimaxdivimaxdiv_tincludeINFINITYinlineintint_curr_symbolint_frac_digitsint_n_cs_precedesint_n_sep_by_spaceint_n_sign_posnint_p_cs_precedesint_p_sep_by_spaceint_p_sign_posnjmp_bufkill_dependencylabslconvldexpldexpd128ldexpd32ldexpd64ldexpfldexplldivldiv_tlgammalgammad128lgammad32lgammad64lgammaflgammallimitlinellabslldivlldiv_tllogbllogbd128llogbd32llogbd64llogbfllogblLLONG_WIDTHllquantexpllquantexpdNllquantexpd128llquantexpd32llquantexpd64llrintllrintd128llrintd32llrintd64llrintfllrintlllroundllroundd128llroundd32llroundd64llroundfllroundllocaleconvlocaltimelocaltime_rlocaltime_sloglog10log10d128log10d32log10d64log10flog10llog10p1log10p1d128log10p1d32log10p1d64log10p1flog10p1llog1plog1pd128log1pd32log1pd64log1pflog1pllog2log2d128log2d32log2d64log2flog2llog2p1log2p1d128log2p1d32log2p1d64log2p1flog2p1llogblogbd128logbd32logbd64logbflogbllogd128logd32logd64logflogllogp1logp1d128logp1d32logp1d64logp1flogp1llonglongjmplong_double_tLONG_WIDTHlrintlrintd128lrintd32lrintd64lrintflrintllroundlroundd128nextdownfnextdownlnexttowardnexttowardd128nexttowardd32nexttowardd64nexttowardfnexttowardlnextupnextupd128nextupd32nextupd64nextupfnextuplnodiscardnoreturnnotnot_eqNULLnullptrnullptr_tn_cs_precedesn_sep_by_spacen_sign_posnOFFoffsetofONonce_flagONCE_FLAG_INIToror_eqperrorpositive_signpowpowd128powd32powd64powfpowf32powf64powlpownpownd128pownd32pownd64pownfpownlpowrpowrd128powrd32powrd64powrfpowrlpragmaprefixprintfprintf_sptrdiff_tPTRDIFF_WIDTHputcputcharputsputwcputwcharp_cs_precedesp_sep_by_spacep_sign_posnqsortqsort_squantizequantizedNquantized128quantized32quantized64quantumquantumdNquantumd128quantumd32quantumd64quick_exitquotraiserandreallocregisterremremainderremainderd128remainderd32remainderd64remainderfremainderlremoveremquoremquofremquolrenamereproduciblerestrictreturnrewindrintrintd128rintd32rintd64rintfrintlrootnrootnd128rootnd32rootnd64rootnfrootnlroundroundd128roundd32roundd64roundevenroundevend128roundevend32roundevend64roundevenfroundevenlroundfroundlrsize_trsqrtrsqrtd128rsqrtd32rsqrtd64rsqrtfrsqrtlsamequantumsamequantumdNsamequantumd128samequantumd32samequantumd64scalblnscalblnd128scalblnd32scalblnd64scalblnfscalblnlscalbnscalbnd128scalbnd32scalbnd64scalbnfscalbnlscanfscanf_sSCHAR_WIDTHSEEK_CURSEEK_ENDSEEK_SETsetbufsetjmpsetlocalesetpayloadsetpayloadd128setpayloadd32setpayloadd64setpayloadfsetpayloadlsetpayloadsigsetpayloadsigd128setpayloadsigd32setpayloadsigd64setpayloadsigfsetpayloadsiglsetvbufset_constraint-_handler_sshortSHRT_WIDTHsignalsignbitsignedsig_atomic_tsinsind128sind32sind64tanftanhtanhd128tanhd32tanhd64tanhftanhltanltanpitanpid128tanpid32tanpid64tanpiftanpiltgammatgammad128tgammad32tgammad64tgammaftgammalthousands_septhread_localtimetimegmtimespectimespec_gettimespec_getrestime_ttmtmpfiletmpfile_stmpnamtmpnam_sTMP_MAX_Stm_hourtm_isdsttm_mdaytm_mintm_montm_sectm_wdaytm_ydaytm_yeartruetrunctruncd128truncd32truncd64truncftrunclTSS_DTOR_ITERATIONStv_nsectv_sectypedeftypeoftypeof_unqualuabsUCHAR_WIDTHufromfpufromfpd128ufromfpd32ufromfpd64ufromfpfufromfplufromfpxufromfpxd128ufromfpxd32ufromfpxd64ufromfpxfufromfpxlulabsullabsULLONG_WIDTHULONG_WIDTHumaxabsundefungetcungetwcunionunreachableunsequencedunsignedUSHRT_WIDTHva_argva_copyva_endva_listva_startvfprintfvfprintf_svfscanfvfscanf_svfwprintfvfwprintf_svfwscanfvfwscanf_svoidvolatilevprintfvprintf_svscanfvscanf_svsnprintfvsnprintf_svsnwprintf_svsprintfvsprintf_svsscanfvsscanf_svswprintfvswprintf_svswscanfvswscanf_svwprintfvwprintf_svwscanfvwscanf_swarningwchar_tWCHAR_UTF16WCHAR_UTF32WCHAR_UTF8WCHAR_WIDTHwcrtombwcrtomb_swctobwctombwctomb_swctranswctrans_twctypewctype_tWEOFwhilewint_tWINT_WIDTHwmemchrwmemcmpwmemcpywmemcpy_swmemmovewmemmove_swmemsetwprintfwprintf_swscanfwscanf_sxorxor_eq
K Bounds-checking interfaces
K.1 Background
Traditionally, the C Library has contained many functions that trust the programmer to provide output character arrays big enough to hold the result being produced. Not only do these functions not check that the arrays are big enough, they frequently lack the information needed to perform such checks. While it is possible to write safe, robust, and error-free code using the existing library, the library tends to promote programming styles that lead to mysterious failures if a result is too big for the provided array.
A common programming style is to declare character arrays large enough to handle most practical cases. However, if these arrays are not large enough to handle the resulting strings, data can be written past the end of the array overwriting other data and program structures. The program never gets any indication that a problem exists, and so never has a chance to recover or to fail gracefully.
Worse, this style of programming has compromised the security of computers and networks. Buffer overflows can often be exploited to run arbitrary code with the permissions of the vulnerable (defective) program.
If the programmer writes runtime checks to verify lengths before calling library functions, then those runtime checks frequently duplicate work done inside the library functions, which discover string lengths as a side effect of doing their job.
This annex provides alternative library functions that promote safer, more secure programming. The alternative functions verify that output buffers are large enough for the intended result and return a failure indicator if they are not. Data is never written past the end of an array. All string results are null terminated.
This annex also addresses another problem that complicates writing robust code: functions that are not reentrant because they return pointers to static objects owned by the function. Such functions can be troublesome because a previously returned result can change if the function is called again, perhaps by another thread.
K.2 Scope
This annex specifies a series of optional extensions that can be useful in the mitigation of security vulnerabilities in programs, and comprise new functions, macros, and types declared or defined in existing standard headers.
An implementation that defines __STDC_LIB_EXT1__ shall conform to the specifications in this annex.463)
This annex should be read as if it were merged into the parallel structure of named subclauses of Clause 7.
K.3 Library
K.3.1 Introduction
K.3.1.1 Standard headers
The functions, macros, and types declared or defined in this annex and its subclauses are not declared or defined by their respective headers if __STDC_WANT_LIB_EXT1__ is defined as a macro which expands to the integer literal 0 at the point in the source file where the appropriate header is first included.
The functions, macros, and types declared or defined in this annex and its subclauses are declared and defined by their respective headers if __STDC_WANT_LIB_EXT1__ is defined as a macro which
It is implementation-defined whether the functions, macros, and types declared or defined in this annex and its subclauses are declared or defined by their respective headers if __STDC_WANT_LIB_EXT1__ is not defined as a macro at the point in the source file where the appropriate header is first included.465)
Within a preprocessing translation unit, __STDC_WANT_LIB_EXT1__ shall be defined identically for all inclusions of any headers from this annex. If __STDC_WANT_LIB_EXT1__ is defined differently for any such inclusion, the implementation shall issue a diagnostic as if a preprocessor error directive were used.
K.3.1.2 Reserved identifiers
Each macro name in any of the following subclauses is reserved for use as specified if it is defined by any of its associated headers when included; unless explicitly stated otherwise (see 7.1.4).
All identifiers with external linkage in any of the following subclauses are reserved for use as identifiers with external linkage if any of them are used by the program. None of them are reserved if none of them are used.
Each identifier with file scope listed in any of the following subclauses is reserved for use as a macro name and as an identifier with file scope in the same name space if it is defined by any of its associated headers when included.
K.3.1.3 Use of errno
An implementation can set errno for the functions defined in this annex, but is not required to.
K.3.1.4 Runtime-constraint violations
Most functions in this annex include as part of their specification a list of runtime-constraints. These runtime-constraints are requirements on the program using the library.466)
Implementations shall verify that the runtime-constraints for a function are not violated by the program. If a runtime-constraint is violated, the implementation shall call the currently registered runtime-constraint handler (see set_constraint_handler_s in <stdlib.h>). Multiple runtimeconstraint violations in the same call to a library function result in only one call to the runtimeconstraint handler. It is unspecified which one of the multiple runtime-constraint violations cause the handler to be called.
If the runtime-constraints section for a function states an action to be performed when a runtimeconstraint violation occurs, the function shall perform the action before calling the runtime-constraint handler. If the runtime-constraints section lists actions that are prohibited when a runtime-constraint violation occurs, then such actions are prohibited to the function both before calling the handler and after the handler returns.
The runtime-constraint handler is permitted not to return. If the handler does return, the library function whose runtime-constraint was violated shall return some indication of failure as given by the returns section in the function’s specification.
K.3.2 Errors <errno.h>
The header <errno.h> defines a type.
The type is
errno_tK.3.3 Common definitions <stddef.h>
The header <stddef.h> defines a type.
K.3.4 Integer types <stdint.h>
The header <stdint.h> defines a macro.
The macro is
RSIZE_MAXwhich expands to a value of type size_t. It can be an expression that is not constant. Functions that have parameters of type rsize_t consider it a runtime-constraint violation if the values of those parameters are greater than RSIZE_MAX.
Recommended practice
Extremely large object sizes are frequently a sign that an object’s size was calculated incorrectly. For example, negative numbers appear as very large positive numbers when converted to an unsigned type like size_t. Also, some implementations do not support objects as large as the maximum value that can be represented by type size_t.
For those reasons, it is sometimes beneficial to restrict the range of object sizes to detect programming errors. For implementations targeting machines with large address spaces, it is recommended that RSIZE_MAX be defined as the smaller of the size of the largest object supported or (SIZE_MAX >> 1), even if this limit is smaller than the size of some legitimate, but very large, objects. Implementations targeting machines with small address spaces may wish to define RSIZE_MAX as SIZE_MAX, which means that there is no object size that is considered a runtime-constraint violation.
K.3.5 Input/output <stdio.h>
K.3.5.1 General
The header <stdio.h> defines several macros and two types.
The macros are
L_tmpnam_swhich expands to an integer constant expression that is the size needed for an array of char large enough to hold a temporary file name string generated by the tmpnam_s function;TMP_MAX_Swhich expands to an integer constant expression that is the maximum number of unique file names that can be generated by the tmpnam_s function.
The types are
errno_t rsize_t
K.3.5.2 Operations on files
K.3.5.2.1 The tmpfile_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdio.h> errno_t tmpfile_s(FILE * restrict * restrict streamptr);
Runtime-constraints
streamptr shall not be a null pointer.
If there is a runtime-constraint violation, tmpfile_s does not attempt to create a file.
Description
The tmpfile_s function creates a temporary binary file that is different from any other existing file and that will automatically be removed when it is closed or at program termination. If the program terminates abnormally, whether an open temporary file is removed is implementation-defined. The file is opened for update with "wb+" mode with the meaning that mode has in the fopen_s function (including the mode’s effect on exclusive access and file permissions).
If the file was created successfully, then the pointer to FILE pointed to by streamptr will be set to the pointer to the object controlling the opened file. Otherwise, the pointer to FILE pointed to by streamptr will be set to a null pointer.
Recommended practice
Returns
The tmpfile_s function returns zero if it created the file. If it did not create the file or there was a runtime-constraint violation, tmpfile_s returns a nonzero value.
K.3.5.2.2 The tmpnam_s function
Synopsis
Runtime-constraints
s shall not be a null pointer. maxsize shall be less than or equal to RSIZE_MAX. maxsize shall be greater than the length of the generated file name string.
Description
The tmpnam_s function generates a string that is a valid file name and that is not the same as the name of an existing file.469) The function is potentially capable of generating TMP_MAX_S different
The tmpnam_s function generates a different string each time it is called.
It is assumed that s points to an array of at least maxsize characters. This array will be set to the generated string, as specified in the rest of this subclause.
The implementation shall behave as if no library function except tmpnam calls the tmpnam_s function.470)
Recommended practice
After a program obtains a file name using the tmpnam_s function and before the program creates a file with that name, the possibility exists that someone else can create a file with that same name. To avoid this race condition, the tmpfile_s function should be used instead of tmpnam_s when possible. One situation that requires the use of the tmpnam_s function is when the program needs to create a temporary directory rather than a temporary file.
Implementations should take care in choosing the patterns used for names returned by tmpnam_s. For example, making a thread ID part of the names avoids the race condition and possible conflict when multiple programs run simultaneously by the same user generate the same temporary file names.
Returns
If no suitable string can be generated, or if there is a runtime-constraint violation, the tmpnam_s function:
- if
sis not null andmaxsizeis both greater than zero and not greater thanRSIZE_MAX, writes a null character tos[0] - returns a nonzero value.
Otherwise, the tmpnam_s function writes the string in the array pointed to by s and returns zero.
Environmental limits
The value of the macro TMP_MAX_S shall be at least 25.
K.3.5.3 File access functions
K.3.5.3.1 The fopen_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdio.h> errno_t fopen_s(FILE * restrict * restrict streamptr, const char * restrict filename, const char * restrict mode);
Runtime-constraints
None of streamptr, filename, or mode shall be a null pointer.
If there is a runtime-constraint violation, fopen_s does not attempt to open a file. Furthermore, if streamptr is not a null pointer, fopen_s sets *streamptr to the null pointer.
Description
The fopen_s function opens the file whose name is the string pointed to by filename, and associates a stream with it.
The mode string shall be as described for fopen, with the addition that modes starting with the character ’w’ or ’a’ can be preceded by the character ’u’, see the following: remove function to remove such files when their use is ended, and before program termination. 470)An implementation can have tmpnam call tmpnam_s (perhaps so there is only one naming convention for temporary files), but this is not required.
Opening a file with exclusive mode (’x’ as a character in the mode argument) fails if the file already exists or cannot be created. The check for the existence of the file and the creation of the file if it does not exist is atomic with respect to other threads and processes. If the implementation is not capable of performing the check for the existence of the file and the creation of the file atomically, it shall fail instead of performing a non-atomic check and creation.
Opening a file with private mode (’p’ as a character in the mode argument) creates a file whose contents cannot be accessed by other means at any point in time including after program end, and whose filename may be ignored by implementations except to identify which storage ought to hold the file. If the implementation is not capable of creating private files, it shall fail.
If the file was opened successfully, then the pointer to FILE pointed to by streamptr will be set to the pointer to the object controlling the opened file. Otherwise, the pointer to FILE pointed to by streamptr will be set to a null pointer.
Returns
The fopen_s function returns zero if it opened the file. If it did not open the file or if there was a runtime-constraint violation, fopen_s returns a nonzero value.
K.3.5.3.2 The freopen_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdio.h> errno_t freopen_s(FILE * restrict * restrict newstreamptr, const char * restrict filename, const char * restrict mode, FILE * restrict stream);
Runtime-constraints
None of newstreamptr, mode, and stream shall be a null pointer.
If there is a runtime-constraint violation, freopen_s neither attempts to close any file associated with stream nor attempts to open a file. Furthermore, if newstreamptr is not a null pointer, fopen_s sets *newstreamptr to the null pointer.
Description
The freopen_s function opens the file whose name is the string pointed to by filename and associates the stream pointed to by stream with it. The mode argument has the same meaning as in the fopen_s function (including the mode’s effect on exclusive access and file permissions).
If filename is a null pointer, the freopen_s function attempts to change the mode of the stream to that specified by mode, as if the name of the file currently associated with the stream had been used. It is implementation-defined which changes of mode are permitted (if any), and under what circumstances.
The freopen_s function first attempts to close any file that is associated with stream. Failure to close the file is ignored. The error and end-of-file indicators for the stream are cleared.
If the file was opened successfully, then the pointer to FILE pointed to by newstreamptr will be set to the value of stream. Otherwise, the pointer to FILE pointed to by newstreamptr will be set to a null pointer.
Returns
The freopen_s function returns zero if it opened the file. If it did not open the file or there was a runtime-constraint violation, freopen_s returns a nonzero value.
K.3.5.4 Formatted input/output functions
K.3.5.4.1 General
Unless explicitly stated otherwise, if the execution of a function described in this subclause causes copying to take place between objects that overlap, the objects take on unspecified values.
K.3.5.4.2 The fprintf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdio.h> int fprintf_s(FILE * restrict stream, const char * restrict format, ...);
Runtime-constraints
Neither stream nor format shall be a null pointer. The %n specifier471) (modified or not by flags, field width, or precision) shall not appear in the string pointed to by format. Any argument to fprintf_s corresponding to a %s specifier shall not be a null pointer.
If there is a runtime-constraint violation, the472) fprintf_s function does not attempt to produce further output, and it is unspecified to what extent fprintf_s produced output before discovering the runtime-constraint violation.
Description
The fprintf_s function is equivalent to the fprintf function except for the previously listed explicit runtime-constraints.
Returns
The fprintf_s function returns the number of characters transmitted, or a negative value if an output error, encoding error, or runtime-constraint violation occurred.
K.3.5.4.3 The fscanf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdio.h> int fscanf_s(FILE * restrict stream, const char * restrict format, ...);
Runtime-constraints
Neither stream nor format shall be a null pointer. Any argument indirected though to store converted input shall not be a null pointer.
If there is a runtime-constraint violation, the473) fscanf_s function does not attempt to perform further input, and it is unspecified to what extent fscanf_s performed input before discovering the runtime-constraint violation.
Description
The fscanf_s function is equivalent to fscanf except that the c, s, and [ conversion specifiers apply to a pair of arguments (unless assignment suppression is indicated by a *). The first of these arguments is the same as for fscanf. That argument is immediately followed in the argument list by the second argument, which has type rsize_t and gives the number of elements in the array pointed to by the first argument of the pair. If the first argument points to a scalar object, it is considered to be an array of one element.474)
A matching failure occurs if the number of elements in a receiving object is insufficient to hold the converted input (including any trailing null character).
Returns
The fscanf_s function returns the value of the macro EOF if an input failure occurs before any conversion or if there is a runtime-constraint violation. Otherwise, the fscanf_s function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
EXAMPLE 1 The call:
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdio.h> /* ... */ int n, i; float x; char name[50]; n = fscanf_s(stdin, "%d%f%s", &i, &x, name, (rsize_t) 50);with the input line:
25 54.32E-1 thompsonwill assign to n the value , to i the value , to x the value , and to name the sequence thompson\0.
EXAMPLE 2 The call:
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdio.h> /* ... */ int n; char s[5]; n = fscanf_s(stdin, "%s", s, sizeof s);with the input line:
hellowill assign to n the value because a matching failure occurred because the sequence hello\0 requires an array of six characters to store it.
K.3.5.4.4 The printf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdio.h> int printf_s(const char * restrict format, ...);
Runtime-constraints
format shall not be a null pointer. The %n specifier475) (modified or not by flags, field width, or precision) shall not appear in the string pointed to by format. Any argument to printf_s corresponding to a %s specifier shall not be a null pointer.
If there is a runtime-constraint violation, the printf_s function does not attempt to produce further output, and it is unspecified to what extent printf_s produced output before discovering the runtime-constraint violation.
Description
The printf_s function is equivalent to the printf function except for the previously listed explicit runtime-constraints.
Returns
The printf_s function returns the number of characters transmitted, or a negative value if an output error, encoding error, or runtime-constraint violation occurred.
K.3.5.4.5 The scanf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdio.h> int scanf_s(const char * restrict format, ...);
Runtime-constraints
format shall not be a null pointer. Any argument indirected though to store converted input shall not be a null pointer.
If there is a runtime-constraint violation, the scanf_s function does not attempt to perform further input, and it is unspecified to what extent scanf_s performed input before discovering the runtimeconstraint violation.
Description
The scanf_s function is equivalent to fscanf_s with the argument stdin interposed before the arguments to scanf_s.
Returns
The scanf_s function returns the value of the macro EOF if an input failure occurs before any conversion or if there is a runtime-constraint violation. Otherwise, the scanf_s function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
K.3.5.4.6 The snprintf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdio.h> int snprintf_s(char * restrict s, rsize_t n, const char * restrict format, ...);
Runtime-constraints
Neither s nor format shall be a null pointer. n shall neither equal zero nor be greater than RSIZE_MAX. The %n specifier476) (modified or not by flags, field width, or precision) shall not appear in the string pointed to by format. Any argument to snprintf_s corresponding to a %s specifier shall not be a null pointer. No encoding error shall occur.
If there is a runtime-constraint violation, then if s is not a null pointer and n is greater than zero and not greater than RSIZE_MAX, then the snprintf_s function sets s[0] to the null character.
Description
The snprintf_s function is equivalent to the snprintf function except for the previously listed explicit runtime-constraints.
The snprintf_s function, unlike sprintf_s, will truncate the result to fit within the array pointed to by s.
Returns
The snprintf_s function returns the number of characters that would have been written had n been sufficiently large, not counting the terminating null character, or a negative value if a runtimeconstraint violation occurred. Thus, the null-terminated output has been completely written if and only if the returned value is both nonnegative and less than n.
K.3.5.4.7 The sprintf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdio.h> int sprintf_s(char * restrict s, rsize_t n, const char * restrict format, ...);
Runtime-constraints
Neither s nor format shall be a null pointer. n shall neither equal zero nor be greater than RSIZE_MAX. The number of characters (including the trailing null) required for the result to be written to the array pointed to by s shall not be greater than n. The %n specifier477) (modified or not by flags, field width, or precision) shall not appear in the string pointed to by format. Any argument to sprintf_s corresponding to a %s specifier shall not be a null pointer. No encoding error shall occur.
If there is a runtime-constraint violation, then if s is not a null pointer and n is greater than zero and not greater than RSIZE_MAX, then the sprintf_s function sets s[0] to the null character.
Description
The sprintf_s function is equivalent to the sprintf function except for the parameter n and the previously listed explicit runtime-constraints.
The sprintf_s function, unlike snprintf_s, treats a result too big for the array pointed to by s as a runtime-constraint violation.
Returns
If no runtime-constraint violation occurred, the sprintf_s function returns the number of characters written in the array, not counting the terminating null character. If an encoding error occurred, sprintf_s returns a negative value. If any other runtime-constraint violation occurred, sprintf_s returns zero.
K.3.5.4.8 The sscanf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdio.h> int sscanf_s(const char * restrict s, const char * restrict format, ...);
Runtime-constraints
Neither s nor format shall be a null pointer. Any argument indirected though to store converted input shall not be a null pointer.
If there is a runtime-constraint violation, the sscanf_s function does not attempt to perform further input, and it is unspecified to what extent sscanf_s performed input before discovering the runtimeconstraint violation.
Description
The sscanf_s function is equivalent to fscanf_s, except that input is obtained from a string (specified by the argument s) rather than from a stream. Reaching the end of the string is equivalent to encountering end-of-file for the fscanf_s function. If copying takes place between objects that overlap, the objects take on unspecified values.
Returns
The sscanf_s function returns the value of the macro EOF if an input failure occurs before any conversion or if there is a runtime-constraint violation. Otherwise, the sscanf_s function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
K.3.5.4.9 The vfprintf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdarg.h> #include <stdio.h> int vfprintf_s(FILE * restrict stream, const char * restrict format, va_list arg);
Runtime-constraints
Neither stream nor format shall be a null pointer. The %n specifier478) (modified or not by flags, field width, or precision) shall not appear in the string pointed to by format. Any argument to vfprintf_s corresponding to a %s specifier shall not be a null pointer.
If there is a runtime-constraint violation, the vfprintf_s function does not attempt to produce further output, and it is unspecified to what extent vfprintf_s produced output before discovering the runtime-constraint violation.
Description
The vfprintf_s function is equivalent to the vfprintf function except for the previously listed explicit runtime-constraints.
Returns
The vfprintf_s function returns the number of characters transmitted, or a negative value if an output error, encoding error, or runtime-constraint violation occurred.
K.3.5.4.10 The vfscanf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdarg.h> #include <stdio.h> int vfscanf_s(FILE * restrict stream, const char * restrict format, va_list arg);
Runtime-constraints
Neither stream nor format shall be a null pointer. Any argument indirected though to store converted input shall not be a null pointer.
If there is a runtime-constraint violation, the vfscanf_s function does not attempt to perform further input, and it is unspecified to what extent vfscanf_s performed input before discovering the runtime-constraint violation.
Description
The vfscanf_s function is equivalent to fscanf_s, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg invocations). The vfscanf_s function does not invoke the va_end macro.479)
Returns
The vfscanf_s function returns the value of the macro EOF if an input failure occurs before any conversion or if there is a runtime-constraint violation. Otherwise, the vfscanf_s function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
K.3.5.4.11 The vprintf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdarg.h> #include <stdio.h> int vprintf_s(const char * restrict format, va_list arg);
Runtime-constraints
format shall not be a null pointer. The %n specifier480) (modified or not by flags, field width, or precision) shall not appear in the string pointed to by format. Any argument to vprintf_s corresponding to a %s specifier shall not be a null pointer.
If there is a runtime-constraint violation, the vprintf_s function does not attempt to produce further output, and it is unspecified to what extent vprintf_s produced output before discovering the runtime-constraint violation.
Description
The vprintf_s function is equivalent to the vprintf function except for the previously listed explicit runtime-constraints.
Returns
The vprintf_s function returns the number of characters transmitted, or a negative value if an output error, encoding error, or runtime-constraint violation occurred.
K.3.5.4.12 The vscanf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdarg.h> #include <stdio.h> int vscanf_s(const char * restrict format, va_list arg);
Runtime-constraints
format shall not be a null pointer. Any argument indirected though to store converted input shall not be a null pointer.
If there is a runtime-constraint violation, the vscanf_s function does not attempt to perform further input, and it is unspecified to what extent vscanf_s performed input before discovering the runtimeconstraint violation.
Description
The vscanf_s function is equivalent to scanf_s, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg invocations). The vscanf_s function does not invoke the va_end macro.481)
Returns
The vscanf_s function returns the value of the macro EOF if an input failure occurs before any conversion or if there is a runtime-constraint violation. Otherwise, the vscanf_s function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
K.3.5.4.13 The vsnprintf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdarg.h> #include <stdio.h> int vsnprintf_s(char * restrict s, rsize_t n, const char * restrict format, va_list arg);
Runtime-constraints
Neither s nor format shall be a null pointer. n shall neither equal zero nor be greater than RSIZE_MAX. The %n specifier482) (modified or not by flags, field width, or precision) shall not appear in the string pointed to by format. Any argument to vsnprintf_s corresponding to a %s specifier shall not be a null pointer. No encoding error shall occur.
If there is a runtime-constraint violation, then if s is not a null pointer and n is greater than zero and not greater than RSIZE_MAX, then the vsnprintf_s function sets s[0] to the null character.
Description
The vsnprintf_s function is equivalent to the vsnprintf function except for the previously listed explicit runtime-constraints.
The vsnprintf_s function, unlike vsprintf_s, will truncate the result to fit within the array pointed to by s.
Returns
The vsnprintf_s function returns the number of characters that would have been written had n been sufficiently large, not counting the terminating null character, or a negative value if a runtimeconstraint violation occurred. Thus, the null-terminated output has been completely written if and only if the returned value is both nonnegative and less than n.
K.3.5.4.14 The vsprintf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdarg.h> #include <stdio.h> int vsprintf_s(char * restrict s, rsize_t n, const char * restrict format, va_list arg);
Runtime-constraints
Neither s nor format shall be a null pointer. n shall neither equal zero nor be greater than RSIZE_MAX. The number of characters (including the trailing null) required for the result to be written to the array pointed to by s shall not be greater than n. The %n specifier483) (modified or not by flags, field width, or precision) shall not appear in the string pointed to by format. Any argument to vsprintf_s corresponding to a %s specifier shall not be a null pointer. No encoding error shall occur.
If there is a runtime-constraint violation, then if s is not a null pointer and n is greater than zero and not greater than RSIZE_MAX, then the vsprintf_s function sets s[0] to the null character.
Description
The vsprintf_s function is equivalent to the vsprintf function except for the parameter n and the previously listed explicit runtime-constraints.
The vsprintf_s function, unlike vsnprintf_s, treats a result too big for the array pointed to by s as a runtime-constraint violation.
Returns
If no runtime-constraint violation occurred, the vsprintf_s function returns the number of characters written in the array, not counting the terminating null character. If an encoding error occurred, vsprintf_s returns a negative value. If any other runtime-constraint violation occurred, vsprintf_s returns zero.
K.3.5.4.15 The vsscanf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdarg.h> #include <stdio.h> int vsscanf_s(const char * restrict s, const char * restrict format, va_list arg);
Runtime-constraints
Neither s nor format shall be a null pointer. Any argument indirected though to store converted input shall not be a null pointer.
If there is a runtime-constraint violation, the vsscanf_s function does not attempt to perform further input, and it is unspecified to what extent vsscanf_s performed input before discovering the runtime-constraint violation.
Description
The vsscanf_s function is equivalent to sscanf_s, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg calls). The vsscanf_s function does not invoke the va_end macro.484)
Returns
The vsscanf_s function returns the value of the macro EOF if an input failure occurs before any conversion or if there is a runtime-constraint violation. Otherwise, the vscanf_s function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
K.3.5.5 Character input/output functions
K.3.5.5.1 The gets_s function
Synopsis
Runtime-constraints
s shall not be a null pointer. n shall neither be equal to zero nor be greater than RSIZE_MAX. A newline character, end-of-file, or read error shall occur within reading n-1 characters from stdin.485)
If there is a runtime-constraint violation, characters are read and discarded from stdin until a new-line character is read, or end-of-file or a read error occurs, and if s is not a null pointer, s[0] is set to the null character.
Description
The gets_s function reads at most one less than the number of characters specified by n from the stream pointed to by stdin, into the array pointed to by s. No additional characters are read after a new-line character (which is discarded) or after end-of-file. The discarded new-line character does not count towards number of characters read. A null character is written immediately after the last character read into the array.
If end-of-file is encountered and no characters have been read into the array, or if a read error occurs during the operation, then s[0] is set to the null character, and the other elements of s take unspecified values.
Recommended practice
The fgets function allows properly-written programs to safely process input lines too long to store in the result array. In general this requires that callers of fgets pay attention to the presence or absence of a new-line character in the result array. It is recommended to use fgets (along with any needed processing based on new-line characters) instead of gets_s.
Returns
The gets_s function returns s if successful. If there was a runtime-constraint violation, or if end-offile is encountered and no characters have been read into the array, or if a read error occurs during the operation, then a null pointer is returned.
K.3.6 General utilities <stdlib.h>
K.3.6.1 General
The header <stdlib.h> defines three types.
The types are
errno_twhich is type int; andrsize_twhich is the type size_t; andconstraint_handler_twhich has the following definitiontypedef void (*constraint_handler_t)( const char * restrict msg, void * restrict ptr, errno_t error);
K.3.6.2 Runtime-constraint handling
K.3.6.2.1 The set_constraint_handler_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdlib.h> constraint_handler_t set_constraint_handler_s(constraint_handler_t handler);
Description
The set_constraint_handler_s function sets the runtime-constraint handler to be handler. The runtime-constraint handler is the function to be called when a library function detects a runtimeconstraint violation. Only the most recent handler registered with set_constraint_handler_s is called when a runtime-constraint violation occurs.
When the handler is called, it is passed the following arguments in the following order:
- A pointer to a character string describing the runtime-constraint violation.
- A null pointer or a pointer to an implementation-defined object.
- If the function calling the handler has a return type declared as
errno_t, the return value of the function is passed. Otherwise, a positive value of typeerrno_tis passed.
The implementation has a default constraint handler that is used if no calls to the set_constraint_handler_s function have been made. The behavior of the default handler is implementation-defined, and it can cause the program to exit or abort.
If the handler argument to set_constraint_handler_s is a null pointer, the implementation default handler becomes the current constraint handler.
Returns
K.3.6.2.2 The abort_handler_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdlib.h> void abort_handler_s(const char * restrict msg, void * restrict ptr, errno_t error);
Description
A pointer to the abort_handler_s function shall be a suitable argument to the set_constraint_handler_s function.
The abort_handler_s function writes a message on the standard error stream in an implementationdefined format. The message shall include the string pointed to by msg. The abort_handler_s function then calls the abort function.487)
Returns
The abort_handler_s function does not return to its caller.
K.3.6.2.3 The ignore_handler_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdlib.h> void ignore_handler_s(const char * restrict msg, void * restrict ptr, errno_t error);
Description
A pointer to the ignore_handler_s function shall be a suitable argument to the set_constraint_handler_s function.
Returns
The ignore_handler_s function returns no value.
K.3.6.3 Communication with the environment
K.3.6.3.1 The getenv_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdlib.h> errno_t getenv_s(size_t * restrict len, char * restrict value, rsize_t maxsize, const char * restrict name);
Runtime-constraints
name shall not be a null pointer. maxsize shall not be greater than RSIZE_MAX. If maxsize is not equal to zero, then value shall not be a null pointer.
If there is a runtime-constraint violation, the integer pointed to by len is set to 0 (if len is not null), and the environment list is not searched.
Description
The getenv_s function searches an environment list, provided by the host environment, for a string that matches the string pointed to by name.
If that name is found then getenv_s performs the following actions. If len is not a null pointer, the length of the string associated with the matched list member is stored in the integer pointed to by len. If the length of the associated string is less than maxsize, then the associated string is copied to the array pointed to by value.
If that name is not found then getenv_s performs the following actions. If len is not a null pointer, zero is stored in the integer pointed to by len. If maxsize is greater than zero, then value[0] is set to the null character.
The set of environment names and the method for altering the environment list are implementationdefined. The getenv_s function is not required to avoid data races with other threads of execution that modify the environment list.489)
Returns
The getenv_s function returns zero if the specified name is found and the associated string was successfully stored in value. Otherwise, a nonzero value is returned.
K.3.6.4 Searching and sorting utilities
K.3.6.4.1 General
These utilities make use of a comparison function to search or sort arrays of unspecified type. Where an argument declared as size_t nmemb specifies the length of the array for a function, if nmemb has the value zero on a call to that function, then the comparison function is not called, a search finds no matching element, sorting performs no rearrangement, and the pointer to the array can be null.
The implementation shall ensure that the second argument of the comparison function (when called from bsearch_s), or both arguments (when called from qsort_s), are pointers to elements of the array.490) The first argument when called from bsearch_s shall equal key.
The comparison function shall not alter the contents of either the array or search key. The implementation may reorder elements of the array between calls to the comparison function, but shall not otherwise alter the contents of any individual element.
When the same objects (consisting of size bytes, irrespective of their current positions in the array) are passed more than once to the comparison function, the results shall be consistent with one another. That is, for qsort_s they shall define a total ordering on the array, and for bsearch_s the same object shall always compare the same way with the key.
A sequence point occurs immediately before and immediately after each call to the comparison function, and also between any call to the comparison function and any movement of the objects passed as arguments to that call.
K.3.6.4.2 The bsearch_s generic function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdlib.h> QVoid *bsearch_s(const void *key, QVoid *base, rsize_t nmemb, rsize_t size, int (*compar)(const void *k, const void *y, void *context), void *context);
Runtime-constraints
Neither nmemb nor size shall be greater than RSIZE_MAX. If nmemb is not equal to zero, then none of key, base, or compar shall be a null pointer.
If there is a runtime-constraint violation, the bsearch_s generic function does not search the array.
Description
The bsearch_s generic function searches an array of nmemb objects, the initial element of which is pointed to by base, for an element that matches the object pointed to by key. The size of each element of the array is specified by size.
The comparison function pointed to by compar is called with three arguments. The first two point to the key object and to an array element, in that order. The function shall return an integer less than, equal to, or greater than zero if the key object is considered, respectively, to be less than, to match, or to be greater than the array element. The array shall consist of: all the elements that compare less than, all the elements that compare equal to, and all the elements that compare greater than the key object, in that order.491) The third argument to the comparison function is the context argument passed to bsearch_s. The sole use of context by bsearch_s is to pass it to the comparison function.492)
Returns
The bsearch_s generic function returns a pointer to a matching element of the array, or a null pointer if no match is found or there is a runtime-constraint violation. If two elements compare as equal, which element is matched is unspecified.
The bsearch_s generic function is generic in the qualification of the type pointed to by the argument base. If this argument is a pointer to a const-qualified object type, the returned pointer will be a pointer to const-qualified void. Otherwise, the argument shall be a pointer to an unqualified object type or a null pointer constant,493) and the returned pointer will be a pointer to unqualified void
The external declaration of bsearch_s has the concrete type:
void * (const void *, const void *, rsize_t, rsize_t, int (*) (const void *, const void *), void *)
K.3.6.4.3 The qsort_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdlib.h> errno_t qsort_s(void *base, rsize_t nmemb, rsize_t size, int (*compar)(const void *x, const void *y, void *context), void *context);
Runtime-constraints
Neither nmemb nor size shall be greater than RSIZE_MAX. If nmemb is not equal to zero, then neither base nor compar shall be a null pointer.
If there is a runtime-constraint violation, the qsort_s function does not sort the array.
Description
The qsort_s function sorts an array of nmemb objects, the initial element of which is pointed to by base. The size of each object is specified by size.
The contents of the array are sorted into ascending order according to a comparison function pointed to by compar, which is called with three arguments. The first two point to the objects being compared. The function shall return an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second. The third argument to the comparison function is the context argument passed to qsort_s. The sole use of context by qsort_s is to pass it to the comparison function.495)
If two elements compare as equal, their relative order in the resulting sorted array is unspecified.
Returns
The qsort_s function returns zero if there was no runtime-constraint violation. Otherwise, a nonzero value is returned.
K.3.6.5 Multibyte/wide character conversion functions
K.3.6.5.1 General
The behavior of the multibyte character functions is affected by the LC_CTYPE category of the current locale. For a state-dependent encoding, each function is placed into its initial conversion state by a call for which its character pointer argument, s, is a null pointer. Subsequent calls with s as other than a null pointer cause the internal conversion state of the function to be altered as necessary. A call with s as a null pointer causes these functions to set the int pointed to by their status argument to a nonzero value if encodings have state dependency, and zero otherwise.496)
Changing the LC_CTYPE category causes the internal object describing the conversion state of these functions to have an indeterminate representation.
K.3.6.5.2 The wctomb_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdlib.h> errno_t wctomb_s(int * restrict status, char * restrict s, rsize_t smax, wchar_t wc);
Runtime-constraints
Let denote the number of bytes needed to represent the multibyte character corresponding to the wide character given by wc (including any shift sequences).
If s is not a null pointer, then smax shall not be less than , and smax shall not be greater than RSIZE_MAX. If s is a null pointer, then smax shall equal zero.
If there is a runtime-constraint violation, wctomb_s does not modify the int pointed to by status, and if s is not a null pointer, no more than smax elements in the array pointed to by s will be accessed.
Description
The wctomb_s function determines and stores the multibyte character representation of wc in the array whose first element is pointed to by s (if s is not a null pointer). The number of characters stored never exceeds MB_CUR_MAX or smax. If wc is a null wide character, a null byte is stored, preceded by any shift sequence needed to restore the initial shift state, and the function is left in the initial conversion state.
The implementation shall behave as if no library function calls the wctomb_s function.
If s is a null pointer, the wctomb_s function stores into the int pointed to by status a nonzero or zero value, if multibyte character encodings, respectively, do or do not have state-dependent encodings.
If s is not a null pointer, the wctomb_s function stores into the int pointed to by status either or if wc, respectively, does or does not correspond to a valid multibyte character.
In no case will the int pointed to by status be set to a value greater than the MB_CUR_MAX macro.
Returns
The wctomb_s function returns zero if successful, and a nonzero value if there was a runtimeconstraint violation or wc did not correspond to a valid multibyte character.
K.3.6.6 Multibyte/wide string conversion functions
K.3.6.6.1 General
The behavior of the multibyte string functions is affected by the LC_CTYPE category of the current locale.
K.3.6.6.2 The mbstowcs_s function
Synopsis
#include <stdlib.h> errno_t mbstowcs_s(size_t * restrict retval, wchar_t * restrict dst, rsize_t dstmax, const char * restrict src, rsize_t len);
Runtime-constraints
Neither retval nor src shall be a null pointer. If dst is not a null pointer, then neither len nor dstmax shall be greater than RSIZE_MAX/sizeof(wchar_t). If dst is a null pointer, then dstmax shall equal zero. If dst is not a null pointer, then dstmax shall not equal zero. If dst is not a null pointer and len is not less than dstmax, then a null character shall occur within the first dstmax multibyte characters of the array pointed to by src.
If there is a runtime-constraint violation, then mbstowcs_s does the following. If retval is not a null pointer, then mbstowcs_s sets *retval to (size_t)(-1). If dst is not a null pointer and dstmax is greater than zero and not greater than RSIZE_MAX/sizeof(wchar_t), then mbstowcs_s sets dst[0] to the null wide character.
Description
The mbstowcs_s function converts a sequence of multibyte characters that begins in the initial shift state from the array pointed to by src into a sequence of corresponding wide characters. If dst is not a null pointer, the converted characters are stored into the array pointed to by dst. Conversion continues up to and including a terminating null character, which is also stored. Conversion stops earlier in two cases: when a sequence of bytes is encountered that does not form a valid multibyte character, or (if dst is not a null pointer) when len wide characters have been stored into the array pointed to by dst.497) If dst is not a null pointer and no null wide character was stored into the array pointed to by dst, then dst[len] is set to the null wide character. Each conversion takes place as if by a call to the mbrtowc function.
Regardless of whether dst is or is not a null pointer, if the input conversion encounters a sequence of bytes that do not form a valid multibyte character, an encoding error occurs: the mbstowcs_s function stores the value (size_t)(-1) into *retval. Otherwise, the mbstowcs_s function stores into
*retval the number of multibyte characters successfully converted, not including the terminating null character (if any).
All elements following the terminating null wide character (if any) written by mbstowcs_s in the array of dstmax wide characters pointed to by dst take unspecified values when mbstowcs_s returns.498)
If copying takes place between objects that overlap, the objects take on unspecified values.
Returns
The mbstowcs_s function returns zero if no runtime-constraint violation and no encoding error occurred. Otherwise, a nonzero value is returned.
K.3.6.6.3 The wcstombs_s function
Synopsis
#include <stdlib.h> errno_t wcstombs_s(size_t * restrict retval, char * restrict dst, rsize_t dstmax, const wchar_t * restrict src, rsize_t len);
Runtime-constraints
Neither retval nor src shall be a null pointer. If dst is not a null pointer, then len shall not be greater than RSIZE_MAX/sizeof(wchar_t) and dstmax shall be nonzero and not greater than RSIZE_MAX. If dst is a null pointer, then dstmax shall equal zero. If dst is not a null pointer and len is not less than dstmax, then the conversion shall have been stopped (see the following) because a terminating null wide character was reached or because an encoding error occurred.
If there is a runtime-constraint violation, then wcstombs_s does the following. If retval is not a null pointer, then wcstombs_s sets *retval to (size_t)(-1). If dst is not a null pointer and dstmax is greater than zero and not greater than RSIZE_MAX, then wcstombs_s sets dst[0] to the null character.
Description
The wcstombs_s function converts a sequence of wide characters from the array pointed to by src into a sequence of corresponding multibyte characters that begins in the initial shift state. If dst is not a null pointer, the converted characters are then stored into the array pointed to by dst. Conversion continues up to and including a terminating null wide character, which is also stored. Conversion stops earlier in two cases:
- when a wide character is reached that does not correspond to a valid multibyte character;
Regardless of whether dst is or is not a null pointer, if the input conversion encounters a wide character that does not correspond to a valid multibyte character, an encoding error occurs: the wcstombs_s function stores the value (size_t)(-1) into *retval. Otherwise, the wcstombs_s function stores into *retval the number of bytes in the resulting multibyte character sequence, not including the terminating null character (if any).
All elements following the terminating null character (if any) written by wcstombs_s in the array of dstmax elements pointed to by dst take unspecified values when wcstombs_s returns.500)
If copying takes place between objects that overlap, the objects take on unspecified values.
Returns
The wcstombs_s function returns zero if no runtime-constraint violation and no encoding error occurred. Otherwise, a nonzero value is returned.
K.3.7 String handling <string.h>
K.3.7.1 General
The header <string.h> defines two types.
K.3.7.2 Copying functions
K.3.7.2.1 The memcpy_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <string.h> errno_t memcpy_s(void * restrict s1, rsize_t s1max, const void * restrict s2, rsize_t n);
Runtime-constraints
Neither s1 nor s2 shall be a null pointer. Neither s1max nor n shall be greater than RSIZE_MAX. n shall not be greater than s1max. Copying shall not take place between objects that overlap.
If there is a runtime-constraint violation, the memcpy_s function stores zeros in the first s1max characters of the object pointed to by s1 if s1 is not a null pointer and s1max is not greater than RSIZE_MAX.
Description
The memcpy_s function copies n characters from the object pointed to by s2 into the object pointed to by s1.
Returns
The memcpy_s function returns zero if there was no runtime-constraint violation. Otherwise, a nonzero value is returned.
K.3.7.2.2 The memmove_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <string.h> errno_t memmove_s(void *s1, rsize_t s1max, const void *s2, rsize_t n);
Runtime-constraints
Neither s1 nor s2 shall be a null pointer. Neither s1max nor n shall be greater than RSIZE_MAX. n shall not be greater than s1max.
If there is a runtime-constraint violation, the memmove_s function stores zeros in the first s1max characters of the object pointed to by s1 if s1 is not a null pointer and s1max is not greater than RSIZE_MAX.
Description
The memmove_s function copies n characters from the object pointed to by s2 into the object pointed to by s1. This copying takes place as if the n characters from the object pointed to by s2 are first copied into a temporary array of n characters that does not overlap the objects pointed to by s1 or s2, and then the n characters from the temporary array are copied into the object pointed to by s1.
Returns
The memmove_s function returns zero if there was no runtime-constraint violation. Otherwise, a nonzero value is returned.
K.3.7.2.3 The strcpy_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <string.h> errno_t strcpy_s(char * restrict s1, rsize_t s1max, const char * restrict s2);
Runtime-constraints
Neither s1 nor s2 shall be a null pointer. s1max shall not be greater than RSIZE_MAX. s1max shall not equal zero. s1max shall be greater than strnlen_s(s2, s1max). Copying shall not take place between objects that overlap.
If there is a runtime-constraint violation, then if s1 is not a null pointer and s1max is greater than zero and not greater than RSIZE_MAX, then strcpy_s sets s1[0] to the null character.
Description
The strcpy_s function copies the string pointed to by s2 (including the terminating null character) into the array pointed to by s1.
All elements following the terminating null character (if any) written by strcpy_s in the array of s1max characters pointed to by s1 take unspecified values when strcpy_s returns.501)
Returns
The strcpy_s function returns zero502) if there was no runtime-constraint violation. Otherwise, a nonzero value is returned.
K.3.7.2.4 The strncpy_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <string.h> errno_t strncpy_s(char * restrict s1, rsize_t s1max, const char * restrict s2, rsize_t n);
Runtime-constraints
Neither s1 nor s2 shall be a null pointer. Neither s1max nor n shall be greater than RSIZE_MAX. s1max shall not equal zero. If n is not less than s1max, then s1max shall be greater than strnlen_s(s2, s1max). Copying shall not take place between objects that overlap.
If there is a runtime-constraint violation, then if s1 is not a null pointer and s1max is greater than zero and not greater than RSIZE_MAX, then strncpy_s sets s1[0] to the null character.
Description
The strncpy_s function copies not more than n successive characters (characters that follow a null character are not copied) from the array pointed to by s2 to the array pointed to by s1. If no null character was copied from s2, then s1[n] is set to a null character.
All elements following the terminating null character (if any) written by strncpy_s in the array of s1max characters pointed to by s1 take unspecified values when strncpy_s returns a nonzero value.503)
Returns
The strncpy_s function returns zero504) if there was no runtime-constraint violation. Otherwise, a nonzero value is returned.
EXAMPLE The strncpy_s function can be used to copy a string without the danger that the result will not be null terminated or that characters will be written past the end of the destination array.
#define __STDC_WANT_LIB_EXT1__ 1 #include <string.h> /* ... */ char src1[100] = "hello"; char src2[7] = {’g’, ’o’, ’o’, ’d’, ’b’, ’y’, ’e’}; char dst1[6], dst2[5], dst3[5]; int r1, r2, r3; r1 = strncpy_s(dst1, 6, src1, 100); r2 = strncpy_s(dst2, 5, src2, 7); r3 = strncpy_s(dst3, 5, src2, 4);
The first call will assign to r1 the value zero and to dst1 the sequence hello\0.
The second call will assign to r2 a nonzero value and to dst2 the sequence \0.
The third call will assign to r3 the value zero and to dst3 the sequence good\0.
K.3.7.3 Concatenation functions
K.3.7.3.1 The strcat_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <string.h> errno_t strcat_s(char * restrict s1, rsize_t s1max, const char * restrict s2);
Runtime-constraints
Let denote the value s1max - strnlen_s(s1, s1max) upon entry to strcat_s.
Neither s1 nor s2 shall be a null pointer. s1max shall not be greater than RSIZE_MAX. s1max shall not equal zero. shall not equal zero.505) shall be greater than strnlen_s(s2. Copying shall not take place between objects that overlap.
If there is a runtime-constraint violation, then if s1 is not a null pointer and s1max is greater than zero and not greater than RSIZE_MAX, then strcat_s sets s1[0] to the null character.
Description
The strcat_s function appends a copy of the string pointed to by s2 (including the terminating null character) to the end of the string pointed to by s1. The initial character from s2 overwrites the null character at the end of s1.
All elements following the terminating null character (if any) written by strcat_s in the array of s1max characters pointed to by s1 take unspecified values when strcat_s returns.506)
Returns
The strcat_s function returns zero507) if there was no runtime-constraint violation. Otherwise, a nonzero value is returned.
K.3.7.3.2 The strncat_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <string.h> errno_t strncat_s(char * restrict s1, rsize_t s1max, const char * restrict s2, rsize_t n);
Runtime-constraints
Let denote the value s1max - strnlen_s(s1, s1max) upon entry to strncat_s.
Neither s1 nor s2 shall be a null pointer. Neither s1max nor n shall be greater than RSIZE_MAX. s1max shall not equal zero. shall not equal zero.508) If n is not less than , then shall be greater than strnlen_s(s2. Copying shall not take place between objects that overlap.
If there is a runtime-constraint violation, then if s1 is not a null pointer and s1max is greater than zero and not greater than RSIZE_MAX, then strncat_s sets s1[0] to the null character.
Description
The strncat_s function appends not more than n successive characters (characters that follow a null character are not copied) from the array pointed to by s2 to the end of the string pointed to by s1. The initial character from s2 overwrites the null character at the end of s1. If no null character was copied from s2, then s1[s1max- +n] is set to a null character.
All elements following the terminating null character (if any) written by strncat_s in the array of s1max characters pointed to by s1 take unspecified values when strncat_s returns.509)
Returns
The strncat_s function returns zero510) if there was no runtime-constraint violation. Otherwise, a nonzero value is returned.
EXAMPLE The strncat_s function can be used to copy a string without the danger that the result will not be null terminated or that characters will be written past the end of the destination array.
#define __STDC_WANT_LIB_EXT1__ 1 #include <string.h> /* ... */ char s1[100] = "good"; char s2[6] = "hello"; char s3[6] = "hello"; char s4[7] = "abc"; char s5[1000] = "bye"; int r1, r2, r3, r4; r1 = strncat_s(s1, 100, s5, 1000); r2 = strncat_s(s2, 6, "", 1); r3 = strncat_s(s3, 6, "X", 2); r4 = strncat_s(s4, 7, "defghijklmn", 3);
After the first call r1 will have the value zero and s1 will contain the sequence goodbye\0.
After the second call r2 will have the value zero and s2 will contain the sequence hello\0.
After the third call r3 will have a nonzero value and s3 will contain the sequence \0.
After the fourth call r4 will have the value zero and s4 will contain the sequence abcdef\0.
K.3.7.4 Search functions
K.3.7.4.1 The strtok_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <string.h> char *strtok_s(char * restrict s1, rsize_t * restrict s1max, const char * restrict s2, char ** restrict ptr);
Runtime-constraints
None of s1max, s2, or ptr shall be a null pointer. If s1 is a null pointer, then *ptr shall not be a null pointer. The value of *s1max shall not be greater than RSIZE_MAX. The end of the token found shall occur within the first *s1max characters of s1 for the first call, and shall occur within the first
*s1max characters of where searching resumes on subsequent calls.
If there is a runtime-constraint violation, the strtok_s function does not indirect through the s1 or s2 pointers, and does not store a value in the object pointed to by ptr.
Description
A sequence of calls to the strtok_s function breaks the string pointed to by s1 into a sequence of tokens, each of which is delimited by a character from the string pointed to by s2. The fourth argument points to a caller-provided char pointer into which the strtok_s function stores information necessary for it to continue scanning the same string.
The first call in a sequence has a non-null first argument and s1max points to an object whose value is the number of elements in the character array pointed to by the first argument. The first call stores an initial value in the object pointed to by ptr and updates the value pointed to by s1max to reflect the number of elements that remain in relation to ptr. Subsequent calls in the sequence have a null first argument and the objects pointed to by s1max and ptr are required to have the values stored by the previous call in the sequence, which are then updated. The separator string pointed to by s2 can be different from call to call.
The first call in the sequence searches the string pointed to by s1 for the first character that is not contained in the current separator string pointed to by s2. If no such character is found, then there are no tokens in the string pointed to by s1 and the strtok_s function returns a null pointer. If such a character is found, it is the start of the first token.
The strtok_s function then searches from there for the first character in s1 that is contained in the current separator string. If no such character is found, the current token extends to the end of the string pointed to by s1, and subsequent searches in the same string for a token return a null pointer. If such a character is found, it is overwritten by a null character, which terminates the current token.
In all cases, the strtok_s function stores sufficient information in the pointer pointed to by ptr so that subsequent calls, with a null pointer for s1 and the unmodified pointer value for ptr, shall start searching just past the element overwritten by a null character (if any).
Returns
The strtok_s function returns a pointer to the first character of a token, or a null pointer if there is no token or there is a runtime-constraint violation.
EXAMPLE
#define __STDC_WANT_LIB_EXT1__ 1 #include <string.h> static char str1[] = "?a???b„,#c"; static char str2[] = "\t \t"; char *t, *ptr1, *ptr2; rsize_t max1 = _Countof(str1); rsize_t max2 = _Countof(str2); t = strtok_s(str1, &max1, "?", &ptr1); // t points to the token "a" t = strtok_s(nullptr, &max1, ",", &ptr1); // t points to the token "??b" t = strtok_s(str2, &max2, " \t", &ptr2); // t is a null pointer t = strtok_s(nullptr, &max1, "#,", &ptr1); // t points to the token "c" t = strtok_s(nullptr, &max1, "?", &ptr1); // t is a null pointer
K.3.7.5 Miscellaneous functions
K.3.7.5.1 The memset_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <string.h> errno_t memset_s(void *s, rsize_t smax, int c, rsize_t n)
Runtime-constraints
s shall not be a null pointer. Neither smax nor n shall be greater than RSIZE_MAX. n shall not be greater than smax.
If there is a runtime-constraint violation, then if s is not a null pointer and smax is not greater than RSIZE_MAX, the memset_s function stores the value of c (converted to an unsigned char) into each of the first smax characters of the object pointed to by s.
Description
The memset_s function copies the value of c (converted to an unsigned char) into each of the first n characters of the object pointed to by s. Unlike memset, any call to the memset_s function shall be evaluated strictly according to the rules of the abstract machine as described in 5.2.2.4. That is, any call to the memset_s function shall assume that the memory indicated by s and n may be accessible in the future and thus contains the values indicated by c.
Returns
The memset_s function returns zero if there was no runtime-constraint violation. Otherwise, a nonzero value is returned.
K.3.7.5.2 The strerror_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <string.h> errno_t strerror_s(char *s, rsize_t maxsize, errno_t errnum);
Runtime-constraints
s shall not be a null pointer. maxsize shall not be greater than RSIZE_MAX. maxsize shall not equal zero.
If there is a runtime-constraint violation, then the array (if any) pointed to by s is not modified.
Description
The strerror_s function maps the number in errnum to a locale-specific message string. Typically, the values for errnum come from errno, but strerror_s shall map any value of type int to a message.
If the length of the desired string is less than maxsize, then the string is copied to the array pointed to by s.
Otherwise, if maxsize is greater than zero, then maxsize-1 characters are copied from the string to the array pointed to by s and then s[maxsize-1] is set to the null character. Then, if maxsize is greater than 3, then s[maxsize-2], s[maxsize-3], and s[maxsize-4] are set to the character period (.).
Returns
The strerror_s function returns zero if the length of the desired string was less than maxsize and there was no runtime-constraint violation. Otherwise, the strerror_s function returns a nonzero value.
K.3.7.5.3 The strerrorlen_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <string.h> size_t strerrorlen_s(errno_t errnum);
Description
The strerrorlen_s function calculates the length of the (untruncated) locale-specific message string that the strerror_s function maps to errnum.
Returns
The strerrorlen_s function returns the number of characters (not including the null character) in the full message string.
K.3.7.5.4 The strnlen_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <string.h> size_t strnlen_s(const char *s, size_t maxsize);
Description
The strnlen_s function counts not more than maxsize characters (a null character and characters that follow it are not counted) in the array to which s points. At most the first maxsize characters of s shall be accessed by strnlen_s. The implementation shall behave as if it reads the characters sequentially and stops as soon as a null character is found.
Returns
Otherwise, the strnlen_s function returns the number of characters that precede the terminating null character. If there is no null character in the first maxsize characters of s then strnlen_s returns maxsize.
K.3.8 Date and time <time.h>
K.3.8.1 General
The header <time.h> defines two types.
K.3.8.2 Components of time
A broken-down time is normalized if the values of the members of the tm structure are in their normal ranges.512)
K.3.8.3 Time conversion functions
K.3.8.3.1 General
Like the strftime function, the asctime_s and ctime_s functions do not return a pointer to a static object, and other library functions are permitted to call them.
K.3.8.3.2 The asctime_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <time.h> errno_t asctime_s(char *s, rsize_t maxsize, const struct tm *timeptr);
Runtime-constraints
Neither s nor timeptr shall be a null pointer. maxsize shall not be less than 26 and shall not be greater than RSIZE_MAX. The broken-down time pointed to by timeptr shall be normalized. The calendar year represented by the broken-down time pointed to by timeptr shall not be less than calendar year 0 and shall not be greater than calendar year 9999.
If there is a runtime-constraint violation, there is no attempt to convert the time, and s[0] is set to a null character if s is not a null pointer and maxsize is not zero and is not greater than RSIZE_MAX.
Description
The asctime_s function converts the normalized broken-down time in the structure pointed to by timeptr into a 26 character (including the null character) string in the form
Sun Sep 16 01:03:52 1973\n\0The fields making up this string are (in order):
- The name of the day of the week represented by
timeptr->tm_wdayusing the following three character weekday names:Sun,Mon,Tue,Wed,Thu,Fri, andSat. - The character space.
- The name of the month represented by
timeptr->tm_monusing the following three character month names:Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov, andDec. - The character space.
- The value of
timeptr->tm_mdayas if printed using thefprintfformat"%2d". - The character space.
- The value of
timeptr->tm_houras if printed using thefprintfformat"%.2d". - The character colon.
- The value of
timeptr->tm_minas if printed using thefprintfformat"%.2d". - The character colon.
- The value of
timeptr->tm_secas if printed using thefprintfformat"%.2d". - The character space.
- The value of
timeptr->tm_year+ 1900as if printed using thefprintfformat"%4d". - The character new line.
- The null character.
Recommended practice
Returns
The asctime_s function returns zero if the time was successfully converted and stored into the array pointed to by s. Otherwise, it returns a nonzero value.
K.3.8.3.3 The ctime_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <time.h> errno_t ctime_s(char *s, rsize_t maxsize, const time_t *timer);
Runtime-constraints
Neither s nor timer shall be a null pointer. maxsize shall not be less than 26 and shall not be greater than RSIZE_MAX.
If there is a runtime-constraint violation, s[0] is set to a null character if s is not a null pointer and maxsize is not equal zero and is not greater than RSIZE_MAX.
Description
The ctime_s function converts the calendar time pointed to by timer to local time in the form of a string. It is equivalent to
asctime_s(s, maxsize, localtime_s(timer, &(struct tm){ 0 }))
Recommended practice
Returns
The ctime_s function returns zero if the time was successfully converted and stored into the array pointed to by s. Otherwise, it returns a nonzero value.
K.3.8.3.4 The gmtime_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <time.h> struct tm *gmtime_s(const time_t * restrict timer, struct tm * restrict result);
Runtime-constraints
Neither timer nor result shall be a null pointer.
If there is a runtime-constraint violation, there is no attempt to convert the time.
Description
The gmtime_s function converts the calendar time pointed to by timer into a broken-down time, expressed as UTC. The broken-down time is stored in the structure pointed to by result.
Returns
The gmtime_s function returns result, or a null pointer if the specified time cannot be converted to UTC or there is a runtime-constraint violation.
K.3.8.3.5 The localtime_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <time.h> struct tm *localtime_s(const time_t * restrict timer, struct tm * restrict result);
Runtime-constraints
Neither timer nor result shall be a null pointer.
If there is a runtime-constraint violation, there is no attempt to convert the time.
Description
The localtime_s function converts the calendar time pointed to by timer into a broken-down time, expressed as local time. The broken-down time is stored in the structure pointed to by result.
Returns
The localtime_s function returns result, or a null pointer if the specified time cannot be converted to local time or there is a runtime-constraint violation.
K.3.9 Extended multibyte and wide character utilities <wchar.h>
K.3.9.1 General
The header <wchar.h> defines two types.
Unless explicitly stated otherwise, if the execution of a function described in this subclause causes copying to take place between objects that overlap, the objects take on unspecified values.
K.3.9.2 Formatted wide character input/output functions
K.3.9.2.1 The fwprintf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <wchar.h> int fwprintf_s(FILE * restrict stream, const wchar_t * restrict format, ...);
Runtime-constraints
Neither stream nor format shall be a null pointer. The %n specifier513) (modified or not by flags, field width, or precision) shall not appear in the wide string pointed to by format. Any argument to fwprintf_s corresponding to a %s specifier shall not be a null pointer.
If there is a runtime-constraint violation, the fwprintf_s function does not attempt to produce further output, and it is unspecified to what extent fwprintf_s produced output before discovering the runtime-constraint violation.
Description
The fwprintf_s function is equivalent to the fwprintf function except for the previously listed explicit runtime-constraints.
Returns
The fwprintf_s function returns the number of wide characters transmitted, or a negative value if an output error, encoding error, or runtime-constraint violation occurred.
K.3.9.2.2 The fwscanf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdio.h> #include <wchar.h> int fwscanf_s(FILE * restrict stream, const wchar_t * restrict format, ...);
Runtime-constraints
Neither stream nor format shall be a null pointer. Any argument indirected though to store converted input shall not be a null pointer.
If there is a runtime-constraint violation, the fwscanf_s function does not attempt to perform further input, and it is unspecified to what extent fwscanf_s performed input before discovering the runtime-constraint violation.
Description
The fwscanf_s function is equivalent to fwscanf except that the c, s, and [ conversion specifiers apply to a pair of arguments (unless assignment suppression is indicated by a *). The first of these arguments is the same as for fwscanf. That argument is immediately followed in the argument list by the second argument, which has type size_t and gives the number of elements in the array pointed to by the first argument of the pair. If the first argument points to a scalar object, it is considered to be an array of one element.514)
A matching failure occurs if the number of elements in a receiving object is insufficient to hold the converted input (including any trailing null character).
Returns
The fwscanf_s function returns the value of the macro EOF if an input failure occurs before any conversion or if there is a runtime-constraint violation. Otherwise, the fwscanf_s function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
K.3.9.2.3 The snwprintf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <wchar.h> int snwprintf_s(wchar_t * restrict s, rsize_t n, const wchar_t * restrict format, ...);
Runtime-constraints
Neither s nor format shall be a null pointer. n shall neither equal zero nor be greater than RSIZE_MAX/sizeof(wchar_t). The %n specifier515) (modified or not by flags, field width, or precision) shall not appear in the wide string pointed to by format. Any argument to snwprintf_s corresponding to a %s specifier shall not be a null pointer. No encoding error shall occur.
If there is a runtime-constraint violation, then if s is not a null pointer and n is greater than zero and not greater than RSIZE_MAX/sizeof(wchar_t), then the snwprintf_s function sets s[0] to
Description
The snwprintf_s function is equivalent to the swprintf function except for the previously listed explicit runtime-constraints.
The snwprintf_s function, unlike swprintf_s, will truncate the result to fit within the array pointed to by s.
Returns
The snwprintf_s function returns the number of wide characters that would have been written had n been sufficiently large, not counting the terminating wide null character, or a negative value if a runtime-constraint violation occurred. Thus, the null-terminated output has been completely written if and only if the returned value is both nonnegative and less than n.
K.3.9.2.4 The swprintf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <wchar.h> int swprintf_s(wchar_t * restrict s, rsize_t n, const wchar_t * restrict format, ...);
Runtime-constraints
Neither s nor format shall be a null pointer. n shall neither equal zero nor be greater than RSIZE_MAX/sizeof(wchar_t). The number of wide characters (including the trailing null) required for the result to be written to the array pointed to by s shall not be greater than n. The %n specifier516) (modified or not by flags, field width, or precision) shall not appear in the wide string pointed to by format. Any argument to swprintf_s corresponding to a %s specifier shall not be a null pointer. No encoding error shall occur.
If there is a runtime-constraint violation, then if s is not a null pointer and n is greater than zero and not greater than RSIZE_MAX/sizeof(wchar_t), then the swprintf_s function sets s[0] to the null wide character.
Description
The swprintf_s function is equivalent to the swprintf function except for the previously listed explicit runtime-constraints.
The swprintf_s function, unlike snwprintf_s, treats a result too big for the array pointed to by s as a runtime-constraint violation.
Returns
If no runtime-constraint violation occurred, the swprintf_s function returns the number of wide characters written in the array, not counting the terminating null wide character. If an encoding error occurred or if n or more wide characters are requested to be written, swprintf_s returns a negative value. If any other runtime-constraint violation occurred, swprintf_s returns zero.
K.3.9.2.5 The swscanf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <wchar.h> int swscanf_s(const wchar_t * restrict s, const wchar_t * restrict format, ...);
Runtime-constraints
Neither s nor format shall be a null pointer. Any argument indirected though to store converted input shall not be a null pointer.
If there is a runtime-constraint violation, the swscanf_s function does not attempt to perform further input, and it is unspecified to what extent swscanf_s performed input before discovering the runtime-constraint violation.
Description
The swscanf_s function is equivalent to fwscanf_s, except that the argument s specifies a wide string from which the input is to be obtained, rather than from a stream. Reaching the end of the wide string is equivalent to encountering end-of-file for the fwscanf_s function.
Returns
The swscanf_s function returns the value of the macro EOF if an input failure occurs before any conversion or if there is a runtime-constraint violation. Otherwise, the swscanf_s function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
K.3.9.2.6 The vfwprintf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdarg.h> #include <stdio.h> #include <wchar.h> int vfwprintf_s(FILE * restrict stream, const wchar_t * restrict format, va_list arg);
Runtime-constraints
Neither stream nor format shall be a null pointer. The %n specifier517) (modified or not by flags, field width, or precision) shall not appear in the wide string pointed to by format. Any argument to vfwprintf_s corresponding to a %s specifier shall not be a null pointer.
If there is a runtime-constraint violation, the vfwprintf_s function does not attempt to produce further output, and it is unspecified to what extent vfwprintf_s produced output before discovering the runtime-constraint violation.
Description
The vfwprintf_s function is equivalent to the vfwprintf function except for the previously listed explicit runtime-constraints.
Returns
The vfwprintf_s function returns the number of wide characters transmitted, or a negative value if an output error, encoding error, or runtime-constraint violation occurred.
K.3.9.2.7 The vfwscanf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdarg.h> #include <stdio.h> #include <wchar.h> int vfwscanf_s(FILE * restrict stream, const wchar_t * restrict format, va_list arg);
Runtime-constraints
Neither stream nor format shall be a null pointer. Any argument indirected though to store converted input shall not be a null pointer.
If there is a runtime-constraint violation, the vfwscanf_s function does not attempt to perform further input, and it is unspecified to what extent vfwscanf_s performed input before discovering the runtime-constraint violation.
Description
The vfwscanf_s function is equivalent to fwscanf_s, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg invocations). The vfwscanf_s function does not invoke the va_end macro.518)
Returns
The vfwscanf_s function returns the value of the macro EOF if an input failure occurs before any conversion or if there is a runtime-constraint violation. Otherwise, the vfwscanf_s function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
K.3.9.2.8 The vsnwprintf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdarg.h> #include <wchar.h> int vsnwprintf_s(wchar_t * restrict s, rsize_t n, const wchar_t * restrict format, va_list arg);
Runtime-constraints
Neither s nor format shall be a null pointer. n shall neither equal zero nor be greater than RSIZE_MAX/sizeof(wchar_t). The %n specifier519) (modified or not by flags, field width, or precision) shall not appear in the wide string pointed to by format. Any argument to vsnwprintf_s corresponding to a %s specifier shall not be a null pointer. No encoding error shall occur.
If there is a runtime-constraint violation, then if s is not a null pointer and n is greater than zero and not greater than RSIZE_MAX/sizeof(wchar_t), then the vsnwprintf_s function sets s[0] to the null wide character.
Description
The vsnwprintf_s function is equivalent to the vswprintf function except for the previously listed explicit runtime-constraints.
The vsnwprintf_s function, unlike vswprintf_s, will truncate the result to fit within the array pointed to by s.
Returns
The vsnwprintf_s function returns the number of wide characters that would have been written had n been sufficiently large, not counting the terminating null character, or a negative value if a runtime-constraint violation occurred. Thus, the null-terminated output has been completely written if and only if the returned value is both nonnegative and less than n.
K.3.9.2.9 The vswprintf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdarg.h> #include <wchar.h> int vswprintf_s(wchar_t * restrict s, rsize_t n, const wchar_t * restrict format, va_list arg);
Runtime-constraints
Neither s nor format shall be a null pointer. n shall neither equal zero nor be greater than RSIZE_MAX/sizeof(wchar_t). The number of wide characters (including the trailing null) required for the result to be written to the array pointed to by s shall not be greater than n. The %n specifier520) (modified or not by flags, field width, or precision) shall not appear in the wide string pointed to by format. Any argument to vswprintf_s corresponding to a %s specifier shall not be a null pointer. No encoding error shall occur.
If there is a runtime-constraint violation, then if s is not a null pointer and n is greater than zero and not greater than RSIZE_MAX/sizeof(wchar_t), then the vswprintf_s function sets s[0] to the null wide character.
Description
The vswprintf_s function is equivalent to the vswprintf function except for the previously listed explicit runtime-constraints.
The vswprintf_s function, unlike vsnwprintf_s, treats a result too big for the array pointed to by s as a runtime-constraint violation.
Returns
If no runtime-constraint violation occurred, the vswprintf_s function returns the number of wide characters written in the array, not counting the terminating null wide character. If an encoding error occurred or if n or more wide characters are requested to be written, vswprintf_s returns a negative value. If any other runtime-constraint violation occurred, vswprintf_s returns zero.
K.3.9.2.10 The vswscanf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdarg.h> #include <wchar.h> int vswscanf_s(const wchar_t * restrict s, const wchar_t * restrict format, va_list arg);
Runtime-constraints
Neither s nor format shall be a null pointer. Any argument indirected though to store converted input shall not be a null pointer.
If there is a runtime-constraint violation, the vswscanf_s function does not attempt to perform further input, and it is unspecified to what extent vswscanf_s performed input before discovering the runtime-constraint violation.
Description
The vswscanf_s function is equivalent to swscanf_s, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg
Returns
The vswscanf_s function returns the value of the macro EOF if an input failure occurs before any conversion or if there is a runtime-constraint violation. Otherwise, the vswscanf_s function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
K.3.9.2.11 The vwprintf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdarg.h> #include <wchar.h> int vwprintf_s(const wchar_t * restrict format, va_list arg);
Runtime-constraints
format shall not be a null pointer. The %n specifier522) (modified or not by flags, field width, or precision) shall not appear in the wide string pointed to by format. Any argument to vwprintf_s corresponding to a %s specifier shall not be a null pointer.
If there is a runtime-constraint violation, the vwprintf_s function does not attempt to produce further output, and it is unspecified to what extent vwprintf_s produced output before discovering the runtime-constraint violation.
Description
The vwprintf_s function is equivalent to the vwprintf function except for the previously listed explicit runtime-constraints.
Returns
The vwprintf_s function returns the number of wide characters transmitted, or a negative value if an output error, encoding error, or runtime-constraint violation occurred.
K.3.9.2.12 The vwscanf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <stdarg.h> #include <wchar.h> int vwscanf_s(const wchar_t * restrict format, va_list arg);
Runtime-constraints
format shall not be a null pointer. Any argument indirected though to store converted input shall not be a null pointer.
If there is a runtime-constraint violation, the vwscanf_s function does not attempt to perform further input, and it is unspecified to what extent vwscanf_s performed input before discovering the runtime-constraint violation.
Description
The vwscanf_s function is equivalent to wscanf_s, with the varying argument list replaced by arg, which shall have been initialized by the va_start macro (and possibly subsequent va_arg
Returns
The vwscanf_s function returns the value of the macro EOF if an input failure occurs before any conversion or if there is a runtime-constraint violation. Otherwise, the vwscanf_s function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
K.3.9.2.13 The wprintf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <wchar.h> int wprintf_s(const wchar_t * restrict format, ...);
Runtime-constraints
format shall not be a null pointer. The %n specifier524) (modified or not by flags, field width, or precision) shall not appear in the wide string pointed to by format. Any argument to wprintf_s corresponding to a %s specifier shall not be a null pointer.
If there is a runtime-constraint violation, the wprintf_s function does not attempt to produce further output, and it is unspecified to what extent wprintf_s produced output before discovering the runtime-constraint violation.
Description
The wprintf_s function is equivalent to the wprintf function except for the previously listed explicit runtime-constraints.
Returns
The wprintf_s function returns the number of wide characters transmitted, or a negative value if an output error, encoding error, or runtime-constraint violation occurred.
K.3.9.2.14 The wscanf_s function
Synopsis
#define __STDC_WANT_LIB_EXT1__ 1 #include <wchar.h> int wscanf_s(const wchar_t * restrict format, ...);
Runtime-constraints
format shall not be a null pointer. Any argument indirected though to store converted input shall not be a null pointer.
If there is a runtime-constraint violation, the wscanf_s function does not attempt to perform further input, and it is unspecified to what extent wscanf_s performed input before discovering the runtimeconstraint violation.
Description
The wscanf_s function is equivalent to fwscanf_s with the argument stdin interposed before the arguments to wscanf_s.
Returns
The wscanf_s function returns the value of the macro EOF if an input failure occurs before any conversion or if there is a runtime-constraint violation. Otherwise, the wscanf_s function returns the number of input items assigned, which can be fewer than provided for, or even zero, in the event of an early matching failure.
K.3.9.3 General wide string utilities
K.3.9.3.1 Wide string copying functions
K.3.9.3.1.1 The wcscpy_s function
#define __STDC_WANT_LIB_EXT1__ 1 #include <wchar.h> errno_t wcscpy_s(wchar_t * restrict s1, rsize_t s1max, const wchar_t * restrict s2);
Neither s1 nor s2 shall be a null pointer. s1max shall not be greater than RSIZE_MAX/sizeof(wchar_t). s1max shall not equal zero. s1max shall be greater than wcsnlen_s(s2, s1max). Copying shall not take place between objects that overlap.
If there is a runtime-constraint violation, then if s1 is not a null pointer and s1max is greater than zero and not greater than RSIZE_MAX/sizeof(wchar_t), then wcscpy_s sets s1[0] to the null wide character.
The wcscpy_s function copies the wide string pointed to by s2 (including the terminating null wide character) into the array pointed to by s1.
All elements following the terminating null wide character (if any) written by wcscpy_s in the array of s1max wide characters pointed to by s1 take unspecified values when wcscpy_s returns.525)
The wcscpy_s function returns zero526) if there was no runtime-constraint violation. Otherwise, a nonzero value is returned.
K.3.9.3.1.2 The wcsncpy_s function
#define __STDC_WANT_LIB_EXT1__ 1 #include <wchar.h> errno_t wcsncpy_s(wchar_t * restrict s1, rsize_t s1max, const wchar_t * restrict s2, rsize_t n);
Neither s1 nor s2 shall be a null pointer. Neither s1max nor n shall be greater than RSIZE_MAX/sizeof(wchar_t). s1max shall not equal zero. If n is not less than s1max, then s1max shall be greater than wcsnlen_s(s2, s1max). Copying shall not take place between objects that overlap.
If there is a runtime-constraint violation, then if s1 is not a null pointer and s1max is greater than zero and not greater than RSIZE_MAX/sizeof(wchar_t), then wcsncpy_s sets s1[0] to the null wide character.
Description
The wcsncpy_s function copies not more than n successive wide characters (wide characters that follow a null wide character are not copied) from the array pointed to by s2 to the array pointed to by s1. If no null wide character was copied from s2, then s1[n] is set to a null wide character.
All elements following the terminating null wide character (if any) written by wcsncpy_s in the array of s1max wide characters pointed to by s1 take unspecified values when wcsncpy_s returns.527)
Returns
The wcsncpy_s function returns zero528) if there was no runtime-constraint violation. Otherwise, a nonzero value is returned.
EXAMPLE The wcsncpy_s function can be used to copy a wide string without the danger that the result will not be null terminated or that wide characters will be written past the end of the destination array.
#define __STDC_WANT_LIB_EXT1__ 1 #include <wchar.h> /* ... */ wchar_t src1[100] = L"hello"; wchar_t src2[7] = {L’g’, L’o’, L’o’, L’d’, L’b’, L’y’, L’e’}; wchar_t dst1[6], dst2[5], dst3[5]; int r1, r2, r3; r1 = wcsncpy_s(dst1, 6, src1, 100); r2 = wcsncpy_s(dst2, 5, src2, 7); r3 = wcsncpy_s(dst3, 5, src2, 4);
The first call will assign to r1 the value zero and to dst1 the sequence of wide characters hello\0.
The second call will assign to r2 a nonzero value and to dst2 the sequence of wide characters \0.
The third call will assign to r3 the value zero and to dst3 the sequence of wide characters good\0.
K.3.9.3.1.3 The wmemcpy_s function
#define __STDC_WANT_LIB_EXT1__ 1 #include <wchar.h> errno_t wmemcpy_s(wchar_t * restrict s1, rsize_t s1max, const wchar_t * restrict s2, rsize_t n);
Neither s1 nor s2 shall be a null pointer. Neither s1max nor n shall be greater than RSIZE_MAX/sizeof(wchar_t). n shall not be greater than s1max. Copying shall not take place between objects that overlap.
If there is a runtime-constraint violation, the wmemcpy_s function stores zeros in the first s1max wide characters of the object pointed to by s1 if s1 is not a null pointer and s1max is not greater than RSIZE_MAX/sizeof(wchar_t).
The wmemcpy_s function copies n successive wide characters from the object pointed to by s2 into the object pointed to by s1.
The wmemcpy_s function returns zero if there was no runtime-constraint violation. Otherwise, a nonzero value is returned.
K.3.9.3.1.4 The wmemmove_s function
#define __STDC_WANT_LIB_EXT1__ 1 #include <wchar.h> errno_t wmemmove_s(wchar_t *s1, rsize_t s1max, const wchar_t *s2, rsize_t n);
Neither s1 nor s2 shall be a null pointer. Neither s1max nor n shall be greater than RSIZE_MAX/sizeof(wchar_t). n shall not be greater than s1max.
If there is a runtime-constraint violation, the wmemmove_s function stores zeros in the first s1max wide characters of the object pointed to by s1 if s1 is not a null pointer and s1max is not greater than RSIZE_MAX/sizeof(wchar_t).
The wmemmove_s function copies n successive wide characters from the object pointed to by s2 into the object pointed to by s1. This copying takes place as if the n wide characters from the object pointed to by s2 are first copied into a temporary array of n wide characters that does not overlap the objects pointed to by s1 or s2, and then the n wide characters from the temporary array are copied into the object pointed to by s1.
The wmemmove_s function returns zero if there was no runtime-constraint violation. Otherwise, a nonzero value is returned.
K.3.9.3.2 Wide string concatenation functions
K.3.9.3.2.1 The wcscat_s function
#define __STDC_WANT_LIB_EXT1__ 1 #include <wchar.h> errno_t wcscat_s(wchar_t * restrict s1, rsize_t s1max, const wchar_t * restrict s2);
Let denote the value s1max - wcsnlen_s(s1, s1max) upon entry to wcscat_s.
Neither s1 nor s2 shall be a null pointer. s1max shall not be greater than RSIZE_MAX/sizeof(wchar_t). s1max shall not equal zero. shall not equal zero.529) shall be greater than wcsnlen_s(s2. Copying shall not take place between objects that overlap.
If there is a runtime-constraint violation, then if s1 is not a null pointer and s1max is greater than zero and not greater than RSIZE_MAX/sizeof(wchar_t), then wcscat_s sets s1[0] to the null wide character.
The wcscat_s function appends a copy of the wide string pointed to by s2 (including the terminating null wide character) to the end of the wide string pointed to by s1. The initial wide character from s2 overwrites the null wide character at the end of s1.
All elements following the terminating null wide character (if any) written by wcscat_s in the array of s1max wide characters pointed to by s1 take unspecified values when wcscat_s returns.530)
Returns
The wcscat_s function returns zero531) if there was no runtime-constraint violation. Otherwise, a nonzero value is returned.
K.3.9.3.2.2 The wcsncat_s function
#define __STDC_WANT_LIB_EXT1__ 1 #include <wchar.h> errno_t wcsncat_s(wchar_t * restrict s1, rsize_t s1max, const wchar_t * restrict s2, rsize_t n);
Let denote the value s1max - wcsnlen_s(s1, s1max) upon entry to wcsncat_s.
Neither s1 nor s2 shall be a null pointer. Neither s1max nor n shall be greater than RSIZE_MAX/sizeof(wchar_t). s1max shall not equal zero. shall not equal zero.532) If n is not less than , then shall be greater than wcsnlen_s(s2. Copying shall not take place between objects that overlap.
If there is a runtime-constraint violation, then if s1 is not a null pointer and s1max is greater than zero and not greater than RSIZE_MAX/sizeof(wchar_t), then wcsncat_s sets s1[0] to the null wide character.
The wcsncat_s function appends not more than n successive wide characters (wide characters that follow a null wide character are not copied) from the array pointed to by s2 to the end of the wide string pointed to by s1. The initial wide character from s2 overwrites the null wide character at the end of s1. If no null wide character was copied from s2, then s1[s1max- +n] is set to a null wide character.
All elements following the terminating null wide character (if any) written by wcsncat_s in the array of s1max wide characters pointed to by s1 take unspecified values when wcsncat_s returns.533)
The wcsncat_s function returns zero534) if there was no runtime-constraint violation. Otherwise, a nonzero value is returned.
EXAMPLE The wcsncat_s function can be used to copy a wide string without the danger that the result will not be null terminated or that wide characters will be written past the end of the destination array.
#define __STDC_WANT_LIB_EXT1__ 1 #include <wchar.h> /* ... */ wchar_t s1[100] = L"good"; wchar_t s2[6] = L"hello"; wchar_t s3[6] = L"hello"; wchar_t s4[7] = L"abc"; wchar_t s5[1000] = L"bye"; int r1, r2, r3, r4; r1 = wcsncat_s(s1, 100, s5, 1000); r2 = wcsncat_s(s2, 6, L"", 1); r3 = wcsncat_s(s3, 6, L"X", 2); r4 = wcsncat_s(s4, 7, L"defghijklmn", 3);
K.3.9.3.3 Wide string search functions
K.3.9.3.3.1 The wcstok_s function
#define __STDC_WANT_LIB_EXT1__ 1 #include <wchar.h> wchar_t *wcstok_s(wchar_t * restrict s1, rsize_t * restrict s1max, const wchar_t * restrict s2, wchar_t ** restrict ptr);
None of s1max, s2, or ptr shall be a null pointer. If s1 is a null pointer, then *ptr shall not be a null pointer. The value of *s1max shall not be greater than RSIZE_MAX/sizeof(wchar_t). The end of the token found shall occur within the first *s1max wide characters of s1 for the first call, and shall occur within the first *s1max wide characters of where searching resumes on subsequent calls.
If there is a runtime-constraint violation, the wcstok_s function does not indirect through the s1 or s2 pointers, and does not store a value in the object pointed to by ptr.
A sequence of calls to the wcstok_s function breaks the wide string pointed to by s1 into a sequence of tokens, each of which is delimited by a wide character from the wide string pointed to by s2. The fourth argument points to a caller-provided wchar_t pointer into which the wcstok_s function stores information necessary for it to continue scanning the same wide string.
The first call in a sequence has a non-null first argument and s1max points to an object whose value is the number of elements in the wide character array pointed to by the first argument. The first call stores an initial value in the object pointed to by ptr and updates the value pointed to by s1max to reflect the number of elements that remain in relation to ptr. Subsequent calls in the sequence have a null first argument and the objects pointed to by s1max and ptr are required to have the values stored by the previous call in the sequence, which are then updated. The separator wide string pointed to by s2 can be different from call to call.
The first call in the sequence searches the wide string pointed to by s1 for the first wide character that is not contained in the current separator wide string pointed to by s2. If no such wide character is found, then there are no tokens in the wide string pointed to by s1 and the wcstok_s function returns a null pointer. If such a wide character is found, it is the start of the first token.
The wcstok_s function then searches from there for the first wide character in s1 that is contained in the current separator wide string. If no such wide character is found, the current token extends to the end of the wide string pointed to by s1, and subsequent searches in the same wide string for a token return a null pointer. If such a wide character is found, it is overwritten by a null wide character, which terminates the current token.
In all cases, the wcstok_s function stores sufficient information in the pointer pointed to by ptr so that subsequent calls, with a null pointer for s1 and the unmodified pointer value for ptr, shall start searching just past the element overwritten by a null wide character (if any).
The wcstok_s function returns a pointer to the first wide character of a token, or a null pointer if there is no token or there is a runtime-constraint violation.
EXAMPLE
#define __STDC_WANT_LIB_EXT1__ 1 #include <wchar.h> static wchar_t str1[] = L"?a???b„,#c"; static wchar_t str2[] = L"\t \t"; wchar_t *t, *ptr1, *ptr2; rsize_t max1 = wcslen(str1)+1; rsize_t max2 = wcslen(str2)+1; t = wcstok_s(str1, &max1, "?", &ptr1); // t points to the token "a" t = wcstok_s(nullptr, &max1, ",", &ptr1); // t points to the token "??b" t = wcstok_s(str2, &max2, " \t", &ptr2); // t is a null pointer t = wcstok_s(nullptr, &max1, "#,", &ptr1); // t points to the token "c" t = wcstok_s(nullptr, &max1, "?", &ptr1); // t is a null pointer
K.3.9.3.4 Miscellaneous functions
K.3.9.3.4.1 The wcsnlen_s function
#define __STDC_WANT_LIB_EXT1__ 1 #include <wchar.h> size_t wcsnlen_s(const wchar_t *s, size_t maxsize);
The wcsnlen_s function counts not more than maxsize wide characters (a null wide character and wide characters that follow it are not counted) in the array to which s points. At most the first maxsize wide characters of s shall be accessed by wcsnlen_s. The implementation shall behave as if it reads the wide characters sequentially and stops as soon as a null wide character is found.
Otherwise, the wcsnlen_s function returns the number of wide characters that precede the terminating null wide character. If there is no null wide character in the first maxsize wide characters of s then wcsnlen_s returns maxsize.
K.3.9.4 Extended multibyte/wide character conversion utilities
K.3.9.4.1 Restartable multibyte/wide character conversion functions
K.3.9.4.1.1 General
Unlike wcrtomb, wcrtomb_s does not permit the ps parameter (the pointer to the conversion state) to be a null pointer.
K.3.9.4.1.2 The wcrtomb_s function
#include <wchar.h> errno_t wcrtomb_s(size_t * restrict retval, char * restrict s, rsize_t smax, wchar_t wc, mbstate_t * restrict ps);
Neither retval nor ps shall be a null pointer. If s is not a null pointer, then smax shall not equal zero and shall not be greater than RSIZE_MAX. If s is not a null pointer, then smax shall not be less
If there is a runtime-constraint violation, then wcrtomb_s does the following. If s is not a null pointer and smax is greater than zero and not greater than RSIZE_MAX, then wcrtomb_s sets s[0] to the null character. If retval is not a null pointer, then wcrtomb_s sets *retval to (size_t)(-1).
Description
If s is a null pointer, the wcrtomb_s function is equivalent to the call
wcrtomb_s(&retval, buf, _Countof buf, L’\0’, ps)
where retval and buf are internal objects of the appropriate types, and the size of buf is greater than MB_CUR_MAX.
If s is not a null pointer, the wcrtomb_s function determines the number of bytes needed to represent the multibyte character that corresponds to the wide character given by wc (including any shift sequences), and stores the multibyte character representation in the array whose first element is pointed to by s. At most MB_CUR_MAX bytes are stored. If wc is a null wide character, a null byte is stored, preceded by any shift sequence needed to restore the initial shift state; the resulting state described is the initial conversion state.
If wc does not correspond to a valid multibyte character, an encoding error occurs: the wcrtomb_s function stores the value (size_t)(-1) into *retval and the conversion state is unspecified. Otherwise, the wcrtomb_s function stores into *retval the number of bytes (including any shift sequences) stored in the array pointed to by s.
Returns
The wcrtomb_s function returns zero if no runtime-constraint violation and no encoding error occurred. Otherwise, a nonzero value is returned.
K.3.9.4.2 Restartable multibyte/wide string conversion functions
K.3.9.4.2.1 General
Unlike mbsrtowcs and wcsrtombs, mbsrtowcs_s and wcsrtombs_s do not permit the ps parameter (the pointer to the conversion state) to be a null pointer.
K.3.9.4.2.2 The mbsrtowcs_s function
#include <wchar.h> errno_t mbsrtowcs_s(size_t * restrict retval, wchar_t * restrict dst, rsize_t dstmax, const char ** restrict src, rsize_t len, mbstate_t * restrict ps);
None of retval, src, *src, or ps shall be null pointers. If dst is not a null pointer, then neither len nor dstmax shall be greater than RSIZE_MAX/sizeof(wchar_t). If dst is a null pointer, then dstmax shall equal zero. If dst is not a null pointer, then dstmax shall not equal zero. If dst is not a null pointer and len is not less than dstmax, then a null character shall occur within the first dstmax multibyte characters of the array pointed to by *src.
If there is a runtime-constraint violation, then mbsrtowcs_s does the following. If retval is not a null pointer, then mbsrtowcs_s sets *retval to (size_t)(-1). If dst is not a null pointer and dstmax is greater than zero and not greater than RSIZE_MAX/sizeof(wchar_t), then mbsrtowcs_s sets dst[0] to the null wide character.
The mbsrtowcs_s function converts a sequence of multibyte characters that begins in the conversion state described by the object pointed to by ps, from the array indirectly pointed to by src into a
If dst is not a null pointer, the pointer object pointed to by src is assigned either a null pointer (if conversion stopped due to reaching a terminating null character) or the address just past the last multibyte character converted (if any). If conversion stopped due to reaching a terminating null character and if dst is not a null pointer, the resulting state described is the initial conversion state.
Regardless of whether dst is or is not a null pointer, if the input conversion encounters a sequence of bytes that do not form a valid multibyte character, an encoding error occurs: the mbsrtowcs_s function stores the value (size_t)(-1) into *retval and the conversion state is unspecified. Otherwise, the mbsrtowcs_s function stores into *retval the number of multibyte characters successfully converted, not including the terminating null character (if any).
All elements following the terminating null wide character (if any) written by mbsrtowcs_s in the array of dstmax wide characters pointed to by dst take unspecified values when mbsrtowcs_s returns.537)
If copying takes place between objects that overlap, the objects take on unspecified values.
Returns
The mbsrtowcs_s function returns zero if no runtime-constraint violation and no encoding error occurred. Otherwise, a nonzero value is returned.
K.3.9.4.2.3 The wcsrtombs_s function
#include <wchar.h> errno_t wcsrtombs_s(size_t * restrict retval, char * restrict dst, rsize_t dstmax, const wchar_t ** restrict src, rsize_t len, mbstate_t * restrict ps);
None of retval, src, *src, or ps shall be null pointers. If dst is not a null pointer, then neither len shall be greater than RSIZE_MAX/sizeof(wchar_t) nor dstmax shall be greater than RSIZE_MAX. If dst is a null pointer, then dstmax shall equal zero. If dst is not a null pointer, then dstmax shall not equal zero. If dst is not a null pointer and len is not less than dstmax, then the conversion shall have been stopped (see the following) because a terminating null wide character was reached or because an encoding error occurred.
If there is a runtime-constraint violation, then wcsrtombs_s does the following. If retval is not a null pointer, then wcsrtombs_s sets *retval to (size_t)(-1). If dst is not a null pointer and dstmax is greater than zero and not greater than RSIZE_MAX, then wcsrtombs_s sets dst[0] to the null character.
The wcsrtombs_s function converts a sequence of wide characters from the array indirectly pointed to by src into a sequence of corresponding multibyte characters that begins in the conversion state described by the object pointed to by ps. If dst is not a null pointer, the converted characters are then stored into the array pointed to by dst. Conversion continues up to and including a terminating null wide character, which is also stored. Conversion stops earlier in two cases:
If dst is not a null pointer, the pointer object pointed to by src is assigned either a null pointer (if conversion stopped due to reaching a terminating null wide character) or the address just past the last wide character converted (if any). If conversion stopped due to reaching a terminating null wide character, the resulting state described is the initial conversion state.
Regardless of whether dst is or is not a null pointer, if the input conversion encounters a wide character that does not correspond to a valid multibyte character, an encoding error occurs: the wcsrtombs_s function stores the value (size_t)(-1) into *retval and the conversion state is unspecified. Otherwise, the wcsrtombs_s function stores into *retval the number of bytes in the resulting multibyte character sequence, not including the terminating null character (if any).
All elements following the terminating null character (if any) written by wcsrtombs_s in the array of dstmax elements pointed to by dst take unspecified values when wcsrtombs_s returns.539)
If copying takes place between objects that overlap, the objects take on unspecified values.
Returns
The wcsrtombs_s function returns zero if no runtime-constraint violation and no encoding error occurred. Otherwise, a nonzero value is returned.
L Analyzability
L.1 Scope
This Annex specifies optional behavior that can aid in the analyzability of C programs.
An implementation that defines __STDC_ANALYZABLE__ shall conform to the specifications in this annex (see also 6.10.10.4).540)
L.2 Requirements
If the program performs a trap (3.27), the implementation is permitted to invoke a runtime-constraint handler. Any such semantics are implementation-defined.
All undefined behavior shall be limited to bounded undefined behavior, except for the following which are permitted to result in critical undefined behavior:
- An object is referred to outside of its lifetime (6.2.4).
- A store is performed to an object that has two incompatible declarations (6.2.7),
- A pointer is used to call a function whose type is not compatible with the referenced type (6.2.7, 6.3.3.3, 6.5.3.3).
- An lvalue does not designate an object when evaluated (6.3.3.1).
- The program attempts to modify a string literal (6.4.6).
- The operand of the unary
*operator has an invalid value (6.5.4.3). - Addition or subtraction of a pointer into, or just beyond, an array object and an integer type produces a result that points just beyond the array object and is used as the operand of a unary
* operator that is evaluated (6.5.7).
- An attempt is made to modify an object defined with a const-qualified type through use of an lvalue with non-const-qualified type (6.7.4).
- An argument to a function or macro defined in the standard library has an invalid value or a type not expected by a variadic function (7.1.4).
- The
longjmpfunction is called with ajmp_bufargument where the most recent invocation of thesetjmpmacro in the same invocation of the program with the correspondingjmp_bufargument is nonexistent, or the invocation was from another thread of execution, or the function containing the invocation has terminated execution in the interim, or the invocation was within the scope of an identifier with variably modified type and execution has left that scope in the interim (7.13.3.1). - The value of a pointer that refers to space deallocated by a call to the
free,free_sized,
free_aligned_sized or realloc function is used (7.25.4).
M Change History
M.1 Attribute Changes
The attribute feature was introduced in the fifth edition of this document, as detailed in the change list in M.3. Table M.1 illustrates what usage of the __has_c_attribute preprocessor conditional expression should return in the latest edition, previous values, and the change associated with that value.
Programs and implementations can use Table M.1 to know what values were being used at any specific point in time, leading up to the publication of this document. The value at the bottom of a particular row in Table M.1 is the latest value and corresponds with the behavior for the given attribute described in this document.
Table M.1: __has_c_attribute values and associated changes
attribute tokens value semantic and/or syntactic changes deprecated 201904L Initial introduction. 202311L Harmonized for fifth edition. fallthrough 201904L Initial introduction.
201910L Expanded locations where fallthrough provides diagnostics due to improvements in specification of blocks. 202311L Harmonized for fifth edition. maybe_unused 201904L Initial introduction. 202106L maybe_unused may appertain to labels. 202311L Harmonized for fifth edition. nodiscard 201904L Initial introduction.
202003L
Added a form which accepts a string literal for diagnostic purposes, e.g. nodiscard("should have a reason"). 202311L Harmonized for fifth edition. noreturn 202202L Initial introduction. 202311L Harmonized for fifth edition. reproducible 202207L Initial introduction. 202311L Harmonized for fifth edition. unsequenced 202207L Initial introduction. 202311L Harmonized for fifth edition.
M.3 Fifth Edition
Major changes in this fifth edition (__STDC_VERSION__ 202311L) include:
- add new keywords such as
bool,static_assert,true,false,thread_localand others, and allowed implementations to provide macros for the older spelling with a leading underscore followed by a capital letter as well as defining old and new keywords as macros to enable transition of programs easily; - removed integer width constraints and obsolete sign representations (so-called "1’s complement" and "sign-magnitude");
- added a one-argument version of
static_assert; - removed support for function definitions with identifier lists;
- mandated function declarations whose parameter list is empty be treated the same as a parameter list which only contain a single
void; - harmonization with ISO/IEC 9945 (POSIX):
• extended month name formats for strftime
• integration of functions: gmtime_r, localtime_r, memccpy, strdup, strndup
- harmonization with floating-point standard ISO/IEC 60559:
• integration of binary floating-point technical specification ISO/IEC TS 18661-1:2014
• integration of decimal floating-point technical specification ISO/IEC TS 18661-2:2015
• integration of floating-point types technical specification ISO/IEC TS 18661-3:2015
M.4 Fourth Edition
There were no major changes in the fourth edition (__STDC_VERSION__ 201710L), only technical corrections and clarifications.
M.5 Third Edition
Major changes in the third edition (__STDC_VERSION__ 201112L) included:
- conditional (optional) features (including some that were previously mandatory)
- support for multiple threads of execution including an improved memory sequencing model, atomic objects, and thread storage (
<stdatomic.h>and<threads.h>) - additional floating-point characteristic macros (
<float.h>) - querying and specifying alignment of objects (
<stdalign.h>,<stdlib.h>) - Unicode characters and strings (
<uchar.h>) (originally specified in ISO/IEC TR 19769:2004) - type-generic expressions
- static assertions
- anonymous structures and unions
- no-return functions
- macros to create complex numbers (
<complex.h>) - support for opening files for exclusive access
- removed the
getsfunction (<stdio.h>) - added the
aligned_alloc,at_quick_exit, andquick_exitfunctions (<stdlib.h>) - (conditional) support for bounds-checking interfaces (originally specified in ISO/IEC TR 24731– 1:2007)
- (conditional) support for analyzability
M.6 Second Edition
Major changes in the second edition (__STDC_VERSION__ 199901L) included:
- restricted character set support via digraphs and
<iso646.h>(originally specified in ISO/IEC 9899:1990/Amd 1:1995) - wide character library support in
<wchar.h>and<wctype.h>(originally specified in ISO/IEC 9899:1990/Amd 1:1995) - more precise aliasing rules via effective type
- restricted pointers
- variable length arrays
M.7 First Edition, Amendment 1
Major changes in the amendment to the first edition (__STDC_VERSION__ 199409L) included:
- addition of the predefined
__STDC_VERSION__macro - restricted character set support via digraphs and
<iso646.h> - wide character library support in
<wchar.h>and<wctype.h>
Bibliography
Index
- :
...(ellipsis punctuator), 70, 137, 191/(division operator), 87/(slash punctuator), 70/* */(comment delimiters), 72//(comment delimiter), 72/=(division assignment operator), 97/=(slash-equal punctuator), 70:(colon punctuator), 70, 111:>(alternative spelling of]), 70:>(colon greater punctuator), 70;(semicolon punctuator), 70, 103, 111, 162, 165, 166<(less punctuator), 70<(less-than operator), 90<:(alternative spelling of[), 70<:(less-colon punctuator), 70<<(left-shift operator), 90<<(less-less punctuator), 70<<=(left-shift assignment operator), 97<<=(less-less equal punctuator), 70<=(less-equal punctuator), 70<=(less-than-or-equal-to operator), 90<%(alternative spelling of{), 70<%(less-percent punctuator), 70=(equal-sign punctuator), 70, 103, 115, 143=(simple assignment operator), 96==(equal-equal punctuator), 70==(equality operator), 91>(greater punctuator), 70>(greater-than operator), 90>=(greater-equal punctuator), 70>=(greater-than-or-equal-to operator), 90>>(greater greater punctuator), 70>>(right-shift operator), 90>>=(greater-greater-equal punctuator), 70>>=(right-shift assignment operator), 97?(question-mark punctuator), 70?:(conditional operator), 17, 94[(opening bracket punctuator), 70[ ](array subscript operator), 76, 84, 204[ ](brackets punctuator), 134, 144#format flag, 353, 452%(percent punctuator), 70%(remainder operator), 87%:(alternative spelling of#), 70%:(percent-colon punctuator), 70%:%:(alternative spelling of##), 70%:%:(percent-percent punctuator), 70%=(percent-equal punctuator), 70%=(remainder assignment operator), 97%>(alternative spelling of}), 70%>(percent-greater punctuator), 70%Aconversion specifier, 355, 441, 455%Bconversion specifier, 355, 442, 454%Cconversion specifier, 442%Dconversion specifier, 442%Econversion specifier, 355, 454%Fconversion specifier, 355, 442, 454
__STDC__ predefined macro, 200 __TIME__ predefined macro, 200, 651 __VA_ARGS__ predefined macro, 190, 191, 192, 724 __VA_OPT__ predefined macro, 190, 191, 192, 722 __bool_true_false_are_defined obsolescent, 333, 493, 539 __cplusplus predefined macro, 199 __func__ defined identifier, 56, 57, 210, 639, 725 __has_c_attribute preprocessing operator, 150, 152–156, 158, 178, 179, 199, 719 __has_embed preprocessing operator, 53, 71, 178, 179, 199 __has_include preprocessing operator, 53, 71, 178, 179, 199, 722 __nodiscard__ attribute, 150 __pp_param__ pp-parameter placeholder, 177 _aligned function name piece, 331, 332 _explicit function name piece, 310 _r function name piece, 439 _t typedef suffix, 493 address constant, 100 | (bitwise inclusive OR operator), 92 | (vertical-line punctuator), 70 |= (bitwise inclusive OR assignment operator), 97 |= (vertical-line-equal punctuator), 70 || (logical OR operator), 17, 93 || (vertical-vertical punctuator), 70 ~ (bitwise complement operator), 84 ~ (tilde punctuator), 70 0 format flag, 353, 452 <1/a.h> header, 71
A type name placeholder, 310, 311, 315, 317, 319, 536 abort function, 210, 301–303, 311, 346, 389, 542, 642, 643, 653, 685 abort_handler_s function, 543, 685 abs function, 207, 208, 393, 542, 720 abs macro, 207, 208 absolute-value function complex, 216, 599 integer, 239, 393 real, 271, 580 abstract declarator, 139 abstract machine, 14 access, 8, 127 access (verb), 3 acos function, 228, 257, 421, 516, 612 acos function family, 228, 229 acos type-generic function, 421, 548, 567, 574, 612 acosd128 function, 257, 521 acosd128 function family, 229 acosd32 function, 257, 521 acosd32 function family, 229 acosd64 function, 257, 521 acosd64 function family, 229 acosdN function family, 528, 612, 615 acosdNx function family, 528, 612, 615 acosf function, 228, 257, 516, 612 acosfN function family, 528, 612, 615 acosfNx function family, 528, 612, 615 acosh function, 262, 421, 517
acosh function family, 228, 229 acosh type-generic function, 421, 548, 567, 576 acoshd128 function, 262, 522 acoshd32 function, 262, 522 acoshd64 function, 262, 522 acoshdN function family, 529, 616 acoshdNx function family, 529, 616 acoshf function, 262, 423, 517 acoshfN function family, 529, 616 acoshfNx function family, 529, 616 acoshl function, 262, 517 acosl function, 228, 257, 516, 612 acospi function, 259, 517 acospi function family, 228, 229 acospi type-generic function, 421, 548, 567, 575 acospid128 function, 259, 522 acospid32 function, 259, 522 acospid64 function, 259, 522 acospidN function family, 528, 615 acospidNx function family, 528, 615 acospif function, 259, 517 acospifN function family, 528, 615 acospifNx function family, 528, 615 acospil function, 259, 517 acquire fence, 314 acquire operation, 17 active position, 21 add and round to narrower type, 290 addition assignment operator (+=), 97 addition operator (+), 77, 84, 88 additive expression, 88 address operator (&), 51, 84 address-free, 315 adjustment, 80 aggregate initialization, 145 aggregate type, 41 alert, 21 alert escape sequence (\a), 21, 66 aliasing, 74 alignas alignment specifier, 45, 54, 132, 199, 396 alignas keyword, 54, 495 aligned_alloc function, 386, 387, 388, 542, 637, 645, 653, 723 alignment, 3, 45, 387 pointer, 43, 52 structure/union member, 112 alignment header, 304 alignment of memory, 396 alignment specifier, 132 alignof keyword, 54, 495 alignof operator, 45, 46, 51, 54, 83, 84, 85, 99, 100, 132, 135, 171, 199, 396, 653, 720 allocated storage order and contiguity, 386 alternative spellings header, 241 and macro, 241, 515 AND operator bitwise (&), 92 bitwise assignment (&=), 97 logical (&&), 93 AND operator
- :
atomic_compare_exchange_strong_explicit%A, 355, 441, 455%B, 355, 442, 454FP_FAST_D32ADDD64macro, 251, 521FP_FAST_D32DIVD128macro, 251, 521FP_FAST_D32DIVD64macro, 251, 521FP_FAST_D32FMAD128macro, 251, 521FP_FAST_D32FMAD64macro, 251, 521FP_FAST_D32MULD128macro, 251, 521FP_FAST_D32MULD64macro, 251, 521FP_FAST_D32SQRTD128macro, 251, 521FP_FAST_D32SQRTD64macro, 251, 521FP_FAST_D32SUBD128macro, 251, 521FP_FAST_D32SUBD64macro, 251, 521FP_FAST_D64ADDD128macro, 251, 521FP_FAST_D64DIVD128macro, 251, 521FP_FAST_D64FMAD128macro, 251, 521FP_FAST_D64MULD128macro, 251, 521FP_FAST_D64SQRTD128macro, 251, 521FP_FAST_D64SUBD128macro, 251, 521FP_FAST_DADDLmacro, 251, 516, 614FP_FAST_DDIVLmacro, 251, 516FP_FAST_DFMALmacro, 251, 516FP_FAST_DMADDDNmacro family, 528, 614FP_FAST_DMADDDNXmacro family, 528, 614FP_FAST_DMDIVDNmacro family, 528, 614FP_FAST_DMDIVDNXmacro family, 528, 614FP_FAST_DMFMADNmacro family, 528, 614FP_FAST_DMFMADNXmacro family, 528, 614FP_FAST_DMMULDNmacro family, 528, 614FP_FAST_DMMULDNXmacro family, 528, 614FP_FAST_DMSQRTDNmacro family, 528, 614FP_FAST_DMSQRTDNXmacro family, 528, 614FP_FAST_DMSUBDNmacro family, 528, 614FP_FAST_DMSUBDNXmacro family, 528, 614FP_FAST_DMULLmacro, 251, 516FP_FAST_DMXADDDNmacro family, 528, 614FP_FAST_DMXADDDNXmacro family, 528, 615FP_FAST_DMXDIVDNmacro family, 528, 614FP_FAST_DMXDIVDNXmacro family, 528, 615FP_FAST_DMXFMADNmacro family, 528, 614FP_FAST_DMXFMADNXmacro family, 528, 615FP_FAST_DMXMULDNmacro family, 528, 614FP_FAST_DMXMULDNXmacro family, 528, 615FP_FAST_DMXSQRTDNmacro family, 528, 614FP_FAST_DMXSQRTDNXmacro family, 528, 615FP_FAST_DMXSUBDNmacro family, 528, 614FP_FAST_DMXSUBDNXmacro family, 528, 615FP_FAST_DSQRTLmacro, 251, 516FP_FAST_DSUBLmacro, 251, 516FP_FAST_FADDmacro, 251, 516, 614FP_FAST_FADDLmacro, 251, 516, 614FP_FAST_FDIVmacro, 251, 516FP_FAST_FDIVLmacro, 251, 516FP_FAST_FFMAmacro, 251, 516FP_FAST_FFMALmacro, 251, 516FP_FAST_FMAmacro, 251, 516, 614FP_FAST_FMAD128macro, 251, 521FP_FAST_FMAD32macro, 251, 521FP_FAST_FMAD64macro, 251, 521FP_FAST_FMADDFNmacro family, 527, 614FP_FAST_FMADDFNXmacro family, 527, 614FP_FAST_FMADNmacro family, 527, 614FP_FAST_FMADNXmacro family, 527, 614Jfloating suffix, 62jfloating suffix, 62jformat modifier, 354, 361, 453, 459jmp_buftypedef, 299, 300, 535, 718localtime_rfunction, 441, 550, 720localtime_sfunction, 550, 700, 701logfunction, 252, 268, 269, 421, 518logfunction family, 228, 229logtype-generic function, 421, 548, 566, 578log10function, 268, 518log10function family, 228, 229log10type-generic function, 421, 549, 566, 579log10d128function, 268, 523log10d32function, 268, 523log10d64function, 268, 523log10dNfunction family, 530, 617log10dNxfunction family, 530, 617log10ffunction, 268, 518log10fNfunction family, 530, 617log10fNxfunction family, 530, 617log10lfunction, 268, 518log10p1function, 268, 269, 518log10p1function family, 228, 229log10p1type-generic function, 421, 549, 566, 579log10p1d128function, 268, 523log10p1d32function, 268, 523log10p1d64function, 268, 523log10p1dNfunction family, 530, 618log10p1dNxfunction family, 530, 618log10p1ffunction, 268, 518log10p1fNfunction family, 530, 618log10p1fNxfunction family, 530, 618log10p1lfunction, 268, 518log1pfunction, 269, 518log1pfunction family, 228, 229log1ptype-generic function, 421, 549, 566, 579log1pd128function, 269, 523log1pd32function, 269, 523log1pd64function, 269, 523log1pdNfunction family, 530, 618log1pdNxfunction family, 530, 618log1pffunction, 269, 518log1pfNfunction family, 530, 618log1pfNxfunction family, 530, 618log1plfunction, 269, 518log2function, 269, 518log2function family, 228, 229log2type-generic function, 421, 549, 566, 579log2d128function, 269, 523log2d32function, 269, 523log2d64function, 269, 523log2dNfunction family, 530, 618log2dNxfunction family, 530, 618log2ffunction, 269, 518log2fNfunction family, 530, 618log2fNxfunction family, 530, 618log2lfunction, 269, 518log2p1function, 269, 270, 518log2p1function family, 228, 229log2p1type-generic function, 421, 549, 566, 579log2p1d128function, 270, 523log2p1d32function, 270, 523log2p1d64function, 270, 523log2p1dNfunction family, 530, 618log2p1dNxfunction family, 530, 618
1)This implies that a conforming implementation reserves no identifiers other than those explicitly reserved in this document.
2)Strictly conforming programs are intended to be maximally portable among conforming implementations. Conforming programs can depend upon nonportable features of a conforming implementation.
3)This requires implementations to behave as if these separate phases occur, even though many are typically folded together in practice. Source files, translation units, and translated translation units necessarily can be stored as files or through/within any other implementation-defined medium. There is no expectation of any one-to-one correspondence between these entities and any external representation. The description is conceptual only, and does not specify any particular implementation.
4)As described in 6.4, the process of dividing a source file’s characters into preprocessing tokens is context-dependent. For example, see the handling of < within a #include preprocessing directive.
5)An implementation can convert each instance of the same non-corresponding source character to a different member of the execution character set.
6)In accordance with 6.2.4, the lifetimes of objects with automatic storage duration declared in main will have ended in the former case, even where they would not have in the latter.
7)ISO/IEC 60559 requires certain user-accessible status flags and control modes. Floating-point operations implicitly set the status flags; modes affect result values of floating-point operations. Implementations that support such floating-point state are required to regard changes to it as side effects — see Annex F for details. The floating-point environment library <fenv.h> provides a programming facility for indicating when these side effects matter, freeing the implementations in other cases.
8)The executions of unsequenced evaluations can interleave. Indeterminately sequenced evaluations cannot interleave, but can be executed in any order.
9)The execution can usually be viewed as an interleaving of all the threads. However, some kinds of atomic operations, for example, allow executions inconsistent with a simple interleaving as described in this subclause.
10)The "carries a dependency" relation is a subset of the "sequenced before" relation, and is similarly strictly intra-thread.
11)The "dependency-ordered before" relation is analogous to the "synchronizes with" relation, but uses release/consume in place of release/acquire.
12)Implementations are encouraged to avoid imposing fixed translation limits whenever possible.
13)See "future language directions" (6.11.3).
14)In particular, there are macros for the standard integer types (6.2.5) and for typedef names as specified in the header <stdint.h> (7.23).
15)This value is exact.
16)The floating-point model is intended to clarify the description of each floating-point characteristic and does not require the floating-point arithmetic of the implementation to be identical.
17)The evaluation method determines evaluation formats of expressions involving all floating types, not just real types. For example, if FLT_EVAL_METHOD is 1, then the product of two float _Complex operands is represented in the double _Complex format, and its parts are evaluated to double.
18)The floating-point model in ISO/IEC 60559 sums powers of from zero, so the values of the exponent limits are one less than shown here.
19)That means, that the outer declaration is not visible for the initializer.
20)There is no linkage between different identifiers.
21)A function declaration can contain the storage-class specifier static only if it is at file scope; see 6.7.2.
22)As specified in 6.2.1, the later declaration can hide the prior declaration.
23)There is only one name space for tags even though three are possible.
24)The term "constant address" means that two pointers to the object constructed at possibly different times will compare equal. The address can be different during two different executions of the same program.
25)In the case of a volatile object, the last store is not required to be explicit in the program.
26)Leaving the innermost block containing the declaration, or jumping to a point in that block or an embedded block prior to the declaration, leaves the scope of the declaration.
27)The address of such an object is taken implicitly when an array member is accessed.
28)An incomplete type can only be used when the size of an object of that type is not needed. It is not needed, for example, when a typedef name is declared to be a specifier for a structure or union, or when a pointer to or a function returning a structure or union is being declared. The specification has to be complete before such a function is called or defined.
29)A type can be incomplete or complete throughout an entire translation unit, or it can change states at different points within a translation unit.
30)Thus, _BitInt(3) is not the same type as _BitInt(4).
31)Implementation-defined keywords have the form of an identifier reserved for any use as described in 7.1.3.
32)Any statement in this document about signed integer types also applies to the bit-precise signed integer types and the extended signed integer types, unless otherwise noted.
33)Any statement in this document about unsigned integer types also applies to the bit-precise unsigned integer types and the extended unsigned integer types, unless otherwise specified.
34)The same representation and alignment requirements are meant to imply interchangeability as arguments to functions, return values from functions, and members of unions.
35)See "future language directions" (6.11.1).
36)ISO/IEC 60559 specifies decimal32 as a data-interchange format that does not require arithmetic support; however, _Decimal32 is a fully supported arithmetic type.
37)CHAR_MIN, defined in <limits.h>, will have one of the values or SCHAR_MIN, and this can be used to distinguish the two options. Irrespective of the choice made, char is a separate type from the other two and is not compatible with either.
38)Note that aggregate type does not include union type because an object with union type can only contain one member at a time.
39)That is, any complete type that is not an array type has a known constant size. For types that are not derived, for pointer types and for atomic types this follows directly from their definitions. For structure and union types this is because they are composed of members that all have a known constant size, see 6.7.3.2. For array types specific rules apply to determine if they have known constant size, see 6.7.7.3.
40)See 6.7.4 regarding qualified array and function types.
41)The same representation and alignment requirements are meant to imply interchangeability as arguments to functions, return values from functions, and members of unions.
42)This does not apply to the _Atomic qualifier. Qualifiers do not have any direct effect on the array type itself, but affect conversion rules for pointer types that reference an array type.
43)Thus, an automatic variable can be initialized to a non-value representation without causing undefined behavior, but the value of the variable cannot be used until a proper value is stored in it.
44)It is possible for objects x and y with the same effective type T to have the same value when they are accessed as objects of type T, but to have different values in other contexts. In particular, if == is defined for type T, then x == y does not imply that memcmp(&x, &y, sizeof(T)) == 0. Furthermore, x == y does not necessarily imply that x and y have the same value; other operations on values of type T can distinguish between them.
45)Two types are not expected to be identical to be compatible.
46)A structure, union, or enumerated type without a tag or an incomplete structure, union or enumerated type is not compatible with any other structure, union or enum type declared in the same translation unit.
47)The notion of "same type" affects redeclarations of typedef names and tags in the same scope.
48)As specified in 6.2.1, the later declaration can hide the prior declaration.
49)Every over-aligned type is, or contains, a structure or union type with a member to which an extended alignment has been applied, or an atomic type that does not have a fundamental alignment.
50)E.g. unsigned _BitInt(7) : 2 is a bit-field that can hold the values , , , , and converts to unsigned _BitInt(7).
51)The rules describe arithmetic on the mathematical value, not the value of a given type of expression.
52)The remaindering operation performed when a value of integer type is converted to unsigned type is not necessary to be performed when a value of real floating type is converted to unsigned type. Thus, the range of portable real floating values is Utype_MAX .
53)See 6.3.2.2.
54)For example, addition of a double _Complex and a float entails just the conversion of the float operand to double (and yields a double _Complex result).
55)The name "lvalue" comes originally from the assignment expression E1 = E2, in which the left operand E1 is required to be a (modifiable) lvalue. It is perhaps better considered as representing an object "locator value". What is sometimes called "rvalue" is in this document described as the "value of an expression". An obvious example of an lvalue is an identifier of an object. As a further example, if E is a unary expression that is a pointer to an object, *E is an lvalue that designates the object to which E points.
56)Because this conversion does not occur, the operand of the sizeof operator remains a function designator and violates the constraints in 6.5.4.5
57)The macro NULL is defined in <stddef.h> (and other headers) as a null pointer constant; see 7.22.
58)The mapping functions for converting a pointer to an integer or an integer to a pointer are intended to be consistent with the addressing structure of the execution environment.
59)In general, the concept "correctly aligned" is transitive: if a pointer to type is correctly aligned for a pointer to type , which in turn is correctly aligned for a pointer to type , then a pointer to type is correctly aligned for a pointer to type .
60)An additional category, placemarkers, is used internally in translation phase 4 (see 6.10.5.4); it cannot occur in source files.
61)These alternative keywords are obsolescent features and should not be used for new code and development.
62)The intent of this specification is to allow but not force the implementation of the corresponding feature by means of a predefined macro.
63)On systems that cannot accept extended characters in external identifiers, an encoding of the universal character name can be used in forming such identifiers. For example, some otherwise unused character or sequence of characters can be used to encode the \u in a universal character name.
64)This allows a reserved identifier that matches the spelling of a keyword to be used as a macro name by the program.
65)Because the name __func__ is reserved for any use by the implementation (7.1.3), if any other identifier is explicitly declared using the name __func__ then the behavior is undefined.
66)The disallowed characters are the characters in the basic character set and the code positions reserved by ISO/IEC 10646 for control characters, the character DELETE, the S-zone (reserved for use by UTF-16), and characters too large to be encoded by ISO/IEC 10646. Disallowed universal character escape sequences can still be specified with hexadecimal and octal escape sequences (6.4.5.5).
67)Implementations that define the macro __STDC_NO_COMPLEX__ may not support complex types. For these implementations, a literal with a complex suffix presents a constraint violation.
68)Hexadecimal floating literals can be used to obtain exact values in the semantic type that are independent of the evaluation format. Casts produce values in the semantic type, though depend on the rounding mode and can raise the inexact floating-point exception.
69)1.23, 1.230, 123e-2, 123e-02, and 1.23L are all different source forms and thus can convert to a different internal format and value (though they can use the same internal format and value).
70)That is, assuming the default translation rounding-direction mode is not changed by an FENV_DEC_ROUND pragma (7.6.4).
71)The specification for the library functions recommends more accurate conversion than required for floating literals (see 7.25.2.6).
72)The semantics of these characters were discussed in 5.3.3. If any other character follows a backslash, the result is not a token and a diagnostic is required. See "future language directions" (6.11.4).
73)For example u8’ab’ violates this constraint.
74)The constants false and true promote to type int, see 6.3.2.1. When used for arithmetic, in translation phase 4 (5.2.1.2), they are signed values and the result of such arithmetic is consistent with the results of later translation phases.
75)A string literal may not be a string (see 7.1.1), because a null character can be embedded in it by a \0 escape sequence.
76)These tokens are sometimes called "digraphs".
77)Thus [ and <: behave differently when "stringized" (see 6.10.5.3), but can otherwise be freely interchanged.
78)Thus, sequences of characters that resemble escape sequences cause undefined behavior.
79)For an example of a header name preprocessing token used in a #pragma directive, see 6.10.11.
80)Thus, /* . .. */ comments do not nest.
81)This paragraph renders undefined statement expressions such as
82)The syntax specifies the precedence of operators in the evaluation of an expression, which is the same as the order of the major subclauses of this subclause, highest precedence first. Thus, for example, the expressions allowed as the operands of the binary + operator (6.5.7) are those expressions defined in 6.5.2 through 6.5.7. The exceptions are cast expressions (6.5.5) as operands of unary operators (6.5.4), and an operand contained between any of the following pairs of operators: grouping parentheses () (6.5.2), generic selection parentheses () (6.5.2.1), subscripting brackets [] (6.5.3.2), function-call parentheses () (6.5.3.3), and the conditional operator ?: (6.5.16). Within each major subclause, the operators have the same precedence. Left- or right-associativity is indicated in each subclause by the syntax for the expressions discussed therein.
83)In an expression that is evaluated more than once during the execution of a program, unsequenced and indeterminately sequenced evaluations of its subexpressions can be performed inconsistently in different evaluations.
84)Allocated objects have no declared type.
85)The object needs to have valid alignment and size for the effective type to be accessed and the type of the lvalue needs to have at least the qualifications of the declared type of the object, if any.
86)The intent of this list is to specify those circumstances in which an object can or cannot be aliased.
87)The intermediate operations in the contracted expression are evaluated as if to infinite range and precision, while the final operation is rounded to the format determined by the expression evaluation method. A contracted expression can also omit the raising of floating-point exceptions.
88)This license is specifically intended to allow implementations to exploit fast machine instructions that combine multiple C operators. As contractions potentially undermine predictability, and can even decrease accuracy for containing expressions, their use needs to be well-defined and clearly documented.
89)An identifier designating an enumeration constant is a primary expression through the constant production, not the identifier production.
90)An lvalue conversion drops type qualifiers.
91)Most often, this is the result of converting an identifier that is a function designator.
92)A function can change the values of its parameters, but these changes cannot affect the values of the arguments. On the other hand, it is possible to pass a pointer to an object, and the function can then change the value of the object pointed to. A parameter declared to have array or function type is adjusted to have a pointer type as described in 6.7.7.4.
93)In other words, function executions do not interleave with each other.
94)If the member used to read the contents of a union object is not the same as the member last used to store a value in the object the appropriate part of the object representation of the value is reinterpreted as an object representation in the new type as described in 6.2.6 (a process sometimes called type punning). This can possibly be a non-value representation.
95)If &E is a valid pointer expression (where & is the address of operator, which generates a pointer to its operand), the expression (&E)->MOS is the same as E.MOS.
96)For example, a data race would occur if access to the entire structure or union in one thread conflicts with access to a member from another thread, where at least one access is a modification. Members can be safely accessed using a non-atomic object which is assigned to or from the atomic object.
97)Where a pointer to an atomic object can be formed and E has integer type, E++ is equivalent to the following code sequence where T is the type of E:
98)If the storage-class specifiers contain the same storage-class specifier more than once, the following constraint is violated.
99)This differs from a cast expression. For example, a cast specifies a conversion to scalar types or void only, and the result of a cast expression is not an lvalue.
100)For example, subobjects without explicit initializers are initialized to zero.
101)This allows implementations to share storage for string literals and constant compound literals with the same or overlapping representations.
102)Thus, &*E is equivalent to E (even if E is a null pointer), and &(E1[E2]) to ((E1)+(E2)). It is always true that if E is a function designator or an lvalue that is a valid operand of the unary & operator, *&E is a function designator or an lvalue equal to E. If *P is an lvalue and T is the name of an object pointer type, *(T)P is an lvalue that has a type compatible with that to which T points. Among the invalid values for dereferencing a pointer by the unary * operator are a null pointer, an address inappropriately aligned for the type of object pointed to, and the address of an object after the end of its lifetime.
103)When applied to a parameter declared to have array or function type, the sizeof operator yields the size of the adjusted (pointer) type (see 6.9.2).
104)A cast does not yield an lvalue.
105)This is often called "truncation toward zero".
106)Thus, the expression ptr + N (where ptr is a null pointer value) is defined to result in a null pointer value when N is zero and has undefined behavior otherwise.
107)The expression a<b<c is not interpreted as in ordinary mathematics. As the syntax indicates, it means (a<b)<c; in other words, "if a is less than b, compare 1 to c; otherwise, compare 0 to c".
108)Because of the precedences, a<b == c<d is 1 whenever a<b and c<d have the same truth-value.
109)Two objects can be adjacent in memory because they are adjacent elements of a larger array or adjacent members of a structure with no padding between them, or because the implementation chose to place them so, even though they are unrelated. If prior invalid pointer operations (such as accesses outside array bounds) produced undefined behavior, subsequent comparisons also produce undefined behavior.
110)If a second or third operand of type nullptr_t is used and the other operand is not a pointer and does not have type nullptr_t itself, a constraint is violated even if that other operand is a null pointer constant such as 0.
111)A conditional expression does not yield an lvalue.
112)The implementation is permitted to read the object to determine the value but is not required to, even when the object has volatile-qualified type.
113)The asymmetric appearance of these constraints with respect to type qualifiers is due to the conversion (specified in 6.3.3.1) that changes lvalues to "the value of the expression" and thus removes any type qualifiers that were applied to the type of the expression (for example, it removes const but not volatile from the type int volatile * const).
114)As described in 6.2.6.1, a store to an object with atomic type is done with memory_order_seq_cst semantics.
115)A comma operator does not yield an lvalue.
116)These are the integer constant expressions that are used for conditional inclusion (6.10.2) and binary resource inclusion (6.10.4).
117)The operand of a typeof (6.7.3.6), sizeof, _Countof, or alignof operator is usually not evaluated (6.5.4.5).
118)An integer constant expression is required in contexts such as the size of a bit-field member of a structure, the value of an enumeration constant, and the size of a non-variable length array. Further constraints that apply to the integer constant expressions used in conditional-inclusion preprocessing directives are discussed in 6.10.2.
119)A named constant or compound literal constant of integer type and value zero is a null pointer constant. A named constant or compound literal constant with a pointer type and a value null is a null pointer but not a null pointer constant; it can only be used to initialize a pointer object if its type implicitly converts to the target type.
120)Named constants or compound literal constants with arithmetic type, including names of constexpr objects, are valid in offset computations such as array subscripts or in pointer casts, as long as the expressions in which they occur form integer constant expressions. In contrast, names of other objects, even if const-qualified and with static storage duration, are not valid.
121)For example, in the declaration int arr_or_vla[(int)+1.0];, while possible to be computed by some implementations as an array with a size of one, it is implementation-defined whether this results in a variable length array declaration or a declaration of an array of known constant size of automatic storage duration. The choice depends on whether (int)+1.0 is an extended integer constant expression.
122)The use of evaluation formats as characterized by FLT_EVAL_METHOD and DEC_EVAL_METHOD also applies to evaluation in the translation environment.
123)Thus, in the following initialization,
124)A range is not itself usable as a value and therefore does not have any specific type or representation, or perform any type conversion.
125)In function definitions (but not in function declarations that are not part of a function definition) the adjusted type of a parameter needs to be complete (see 6.7.7.4).
126)Function definitions have a different syntax, described in 6.9.2.
127)It is recommended that implementations that accept such declarations follow the semantics of the corresponding feature in ISO/IEC 14882.
128)subject to the same constraints as all other declarations with initializers
129)See "future language directions" (6.11.7).
130)All assignment expressions of such an initializer, if any, are constant expressions or string literals, see 6.7.11.
131)In the context of arithmetic conversions, 6.3.2 describes the details of changes of value that occur if values of arithmetic expressions are stored in the objects that for example have a different signedness, excess precision or quantum exponent. Whenever such a change of value is necessary, the constraint is violated.
132)The named constant or compound literal constant corresponding to an object declared with storage-class specifier constexpr and pointer type is a constant expression with a value null, and thus a null pointer and an address constant. Thus, such a named constant is a valid initializer for other constexpr declarations, provided the pointer types match accordingly. However, even if it has type void* it is not a null pointer constant.
133)The implementation can treat any register declaration simply as an auto declaration. However, whether or not addressable storage is used, the address of any part of an object declared with storage-class specifier register cannot be computed, either explicitly (by use of the unary & operator as discussed in 6.5.4.3) or implicitly (by converting an array name to a pointer as discussed in 6.3.3.1).
134)While the number of bits in a bool object is at least CHAR_BIT, the width of a bool is just 1 bit.
135)For further rules affecting compatibility and completeness of structure or union types, see 6.2.7 and 6.7.3.4.
136)A structure or union cannot contain a member with a variably modified type because member names are not ordinary identifiers as defined in 6.2.3.
137)The unary & (address-of) operator cannot be applied to a bit-field object; thus, there are no pointers to or arrays of bit-field objects.
138)As specified in 6.7.3, if the actual type specifier used is int or a typedef-name defined as int, then it is implementationdefined whether the bit-field is signed or unsigned. This includes an int type specifier produced using the typeof specifiers (6.7.3.6).
139)An unnamed bit-field structure member is useful for padding to conform to externally imposed layouts.
140)The specifier qualifier list is not a context listed in 6.7.6 as permitted for alignment specifiers, so the presence of an alignment specifier in the list violates a constraint.
141)Thus, the identifiers of enumeration constants declared in the same scope are all required to be distinct from each other and from other identifiers declared in ordinary declarators.
142)Therefore, a constraint has been violated.
143)An implementation can delay the choice of which integer type until all enumeration constants have been seen.
144)For further rules affecting compatibility and completeness of enumerated types see 6.2.7 and 6.7.3.4.
145)The integer type selected during processing of the enumerator list (before completion) of the enumeration can sometimes not be the same as the compatible implementation-defined integer type selected for the completed enumeration.
146)This means in particular that if the compatible type is bool, values of the enumerated type behave in all aspects the same as bool, conversion to the enumerated type behaves the same as bool (6.3.2.2), and the members only have values false and true. If it is a signed integer type and the constant expression of an enumeration constant overflows, a constraint for constant expressions (6.6.1) is violated.
147)As specified in 6.7.3.2, the type specifier can be followed by a ; or a member declaration list.
148)If there is no identifier, the type can, within the translation unit, only be referred to by the declaration of which it is a part. Of course, when the declaration is of a typedef name, subsequent declarations can make use of that typedef name to declare objects having the specified structure, union, or enumerated type.
149)A similar construction for an enum that does not contain a fixed underlying type does not exist. Enumerations with a fixed underlying type are always complete after the enum type specifier.
150)When applied to a parameter declared to have array or function type, the typeof operators yield the adjusted (pointer) type (see 6.9.2).
151)If the typeof specifier argument is itself a typeof specifier, the operand will be evaluated before evaluating the current typeof operator. This happens recursively until a typeof specifier is no longer the operand.
152)_Atomic ( type-name ), with parentheses, is considered an _Atomic-qualified type.
153)The implementation can place a const object that is not volatile in a read-only region of storage. Moreover, the implementation is not expected to allocate storage for such an object if its address is never used.
154)This applies to those objects that behave as if they were defined with qualified types, even if they are never actually defined as objects in the program (such as an object at a memory-mapped input/output address).
155)A volatile declaration can be used to describe an object corresponding to a memory-mapped input/output port or an object accessed by an asynchronously interrupting function. Actions on objects so declared are not allowed to be "optimized out" by an implementation or reordered except as permitted by the rules for evaluating expressions.
156)For example, a statement that assigns a value returned by malloc to a single pointer establishes this association between the allocated object and the pointer.
157)This can occur with typedefs. This rule does not apply to the _Atomic qualifier. Qualifiers do not have any direct effect on the array type itself, but affect conversion rules for pointer types that reference an array type.
158)In other words, E depends on the value of P itself rather than on the value of an object referenced indirectly through P. For example, if identifier p has type (int **restrict), then the pointer expressions p and p+1 are based on the restricted pointer object designated by p, but the pointer expressions *p and p[1] are not.
159)By using, for example, an alternative to the usual function call mechanism, such as "inline substitution". Inline substitution is not textual substitution, nor does it create a new function. Therefore, for example, the expansion of a macro
160)For example, an implementation can possibly never perform inline substitution, or can only perform inline substitutions to calls in the scope of an inline declaration.
161)Because an inline definition is distinct from the corresponding external definition and from any other corresponding inline definitions in other translation units, all corresponding objects with static storage duration are also distinct in each of the definitions.
162)An alignment specification of zero also does not affect other alignment specifications in the same declaration.
163)When several "array of" specifications are adjacent, a multidimensional array is declared.
164)The array is considered identically qualified to T according to 6.2.5.
165)They cannot be used in function declarations that are definitions (see 6.7.7.4 and 6.9.2).
166)Variable length arrays with automatic storage duration are a conditional feature that implementations are not required to support; see 6.10.10.4.
167)The macros defined in the <stdarg.h> header (7.16) can be used to access arguments that correspond to the ellipsis in variadic functions.
168)As indicated by the syntax, empty parentheses in a type name are interpreted as "function with no parameters", rather than redundant parentheses around the omitted identifier.
169)The scope rules as described in 6.2.1 also prohibit the use of the identifier of the declarator within the assignment expression.
170)It is recommended that implementations that accept different forms of direct declarators follow the syntax and semantics of the corresponding feature in ISO/IEC 14882.
171)A representation with all bits zero results in a decimal floating-point zero with the most negative exponent.
172)If the object being initialized does not have automatic storage duration, this case violates a constraint unless the expression is a named constant or compound literal constant (6.6.1).
173)If the initializer list for a subaggregate or contained union does not begin with a left brace, its subobjects are initialized as usual, but the subaggregate or contained union does not become the current object: current objects are associated only with brace-enclosed initializer lists.
174)After a union member is initialized, the next object is not the next member of the union; instead, it is the next subobject of an object containing the union.
175)Thus, a designator can only specify a strict subobject of the aggregate or union that is associated with the surrounding brace pair. Note, too, that each separate designator list is independent.
176)Any initializer for the subobject which is overridden and so not used to initialize that subobject can potentially not be evaluated at all.
177)In particular, the evaluation order can be the same or different as the order of subobject initialization.
178)Thus, the attributes [[nodiscard]] and [[__nodiscard__]] can be freely interchanged. Implementations are encouraged to behave similarly for attribute tokens (including attribute prefixed tokens) they provide.
179)Standard attributes specified by this document can be parsed but ignored by an implementation without changing the semantics of a correct program; the same is not true for attributes not specified by this document.
180)In particular, deprecated is appropriate for names and entities that are obsolescent, insecure, unsafe, or otherwise unfit for purpose.
181)[[_Noreturn]] and [[noreturn]] are equivalent attributes to support code that includes <stdnoreturn.h>, because that header defines noreturn as a macro that expands to _Noreturn.
182)That is, they appear in the attributes right after the closing parenthesis of the parameter list, independently of whether the function type is, for example, used directly to declare a function or whether it is used in a pointer to function type.
183)If several declarations of the same function or function pointer are visible, regardless whether an attribute is present at several or just one of the declarators, it is attached to the type of the corresponding function definition, function pointer object, or function pointer value.
184)That is, the fact that a function has one of these properties is in general not determined by the specification of the translation unit in which it is found; other translation units and specific run time conditions also condition the possible assertion of the properties.
185)The initializations of the parameters is sequenced during the function call.
186)This considers the evaluation of the function call itself, not the evaluation of a full function call expression. Such an evaluation is sequenced after all evaluations that determine and the call arguments, if any, have been performed.
187)This considers the evaluation of the function call itself, not the evaluation of a full function call expression. Such an evaluation is sequenced after all evaluations that determine and the call arguments, if any, have been performed.
188)A function call of an unsequenced function can be executed as early as the function pointer value, the values of the arguments and all objects that are accessible through them, and all values of globally accessible state have been determined, and it can be executed as late as the arguments and the objects they possibly target are unchanged and as any of its return value or modified pointed-to arguments are accessed.
189)A statement may therefore be named by more than one label.
190)Such as assignments, and function calls which have side effects.
191)The controlling expression is implicitly the initialized value of the declared object, if the selection header only has a declaration. The implementation is permitted to re-read the object to determine the value, but is not required to do so, even when the object has volatile-qualified type.
192)That is, the declaration: precedes the switch statement; appears in the selection header; or, it follows the last case or default label associated with the switch that is in the block containing the declaration.
193)Even if the controlling expression has the same value as one of the operands to the empty range expression.
194)Code jumped over is not executed. In particular, the controlling expression of a for or while statement is not evaluated before entering the loop body, nor is clause-1 (6.8.6.4) of a for statement.
195)An omitted controlling expression is replaced by a nonzero constant, which is a constant expression.
196)This is intended to allow compiler transformations such as removal of empty loops even when termination cannot be proven.
197)Thus, clause-1 specifies initialization for the loop, possibly declaring one or more variables for use in the loop; the controlling expression, expression-2, specifies an evaluation made before each iteration, such that execution of the loop continues until the expression compares equal to 0; and expression-3 specifies an operation (such as incrementing) that is performed after each iteration.
198)Following the contin: label in the 2nd example is a null statement. The null statement in the first and third example is implied by the label (6.8.3).
199)The return statement is not an assignment. The overlap restriction of 6.5.17.2 does not apply to the case of function return. The representation of floating-point values can have wider range or precision than implied by the type; a cast can be used to remove this extra range and precision.
200)For a hosted implementation, this function is called main (5.2.2.3.2).
201)If an identifier declared with external linkage is not used in an expression, there need be no external definition for it.
202)The visibility scope of a parameter in a function definition starts when its declaration is completed, extends to following parameter declarations, to possible attributes that follow the parameter type list, and then to the entire function body. The lifetime of each instance of a parameter starts when the declaration is evaluated starting a call and ends when that call terminates.
203)A parameter that has no declared name is inaccessible within the function body.
204)A parameter identifier cannot be redeclared in the function body except in an enclosed block.
205)Thus, preprocessing directives are commonly called "lines". These "lines" have no other syntactic significance, as all white space is equivalent except in certain situations during preprocessing (see the # ordinary string literal creation operator in 6.10.5.3, for example).
206)An unrecognized preprocessor prefixed parameter is a constraint violation, except within has_embed expressions (6.10.2).
207)Because the controlling constant expression is evaluated during translation phase 4, all identifiers either are or are not macro names — there simply are no keywords, enumeration constants, etc.
208)As indicated by the syntax, no preprocessing tokens are allowed to follow a #else or #endif directive before the terminating new-line character. However, comments can appear anywhere in a source file, including within a preprocessing directive.
209)Adjacent string literals are not concatenated into a single string literal (see the translation phases in 5.2.1.2); thus, an expansion that results in two string literals is an invalid directive.
210)This constraint helps ensure data is neither filled with padding values nor truncated in a given environment, and helps ensure the data is portable with respect to usages of memcpy (7.28.2.1) with character type arrays initialized from the data.
211)For example, an embed element width of 8 will yield a range of values from to , inclusive.
212)Adjacent string literals are not concatenated into a single string literal (see the translation phases in 5.2.1.2); thus, an expansion that results in two string literals is an invalid directive.
213)By macro-replacement time, all character literals and string literals are preprocessing tokens, not sequences possibly containing identifier-like subsequences (see 5.2.1.2, translation phases), they are never scanned for macro names or parameters.
214)Despite the name, a non-directive is a preprocessing directive.
215)Placemarker preprocessing tokens do not appear in the syntax because they are temporary entities that exist only within translation phase 4 (5.2.1.2).
216)Because a new-line is explicitly included as part of the #line directive, the number of new-line characters read while processing to the first pp-token can be different depending on whether the implementation uses a one-pass preprocessor. Therefore, there are two possible values for the line number following a directive of the form ##line __LINE__ new-line.
217)An implementation is not required to perform macro replacement in pragmas, but it is permitted except for in standard pragmas (where STDC immediately follows pragma). If the result of macro replacement in a non-standard pragma has the same form as a standard pragma, the behavior is still implementation-defined; an implementation is permitted to behave as if it were the standard pragma, but is not required to.
218)See "future language directions" (6.11.8).
219)See "future language directions" (6.11.9).
220)The presumed source file name and line number can be changed by the #line directive.
221)See Annex M for the values in previous editions of this document. The intention is that this will remain an integer literal of type long int that is increased with each edition of this document.
222)The functions that make use of the decimal-point character are the numeric conversion functions (7.25.2, 7.33.4.2) and the formatted input/output functions (7.24.6, 7.33.2).
223)For state-dependent encodings, the values for MB_CUR_MAX and MB_LEN_MAX are thus required to be large enough to count all the bytes in any complete multibyte character plus at least one adjacent shift sequence of maximum length. Whether these counts provide for more than one shift sequence is the implementation’s choice.
224)A header is not necessarily a source file, nor are the < and > delimited sequences in header names necessarily valid source file names.
225)The headers <complex.h>, <stdatomic.h>, and <threads.h> are conditional features that implementations can support but are not required to; see 6.10.10.4.
226)As with other evaluations, a floating-point exception could still be raised in the context of an expression that uses that macro replacement.
227)All library functions have external linkage.
228)A potentially reserved identifier becomes a reserved identifier when an implementation begins using it or a future standard reserves it, but is otherwise available for use by the programmer.
229)The list of reserved identifiers with external linkage includes math_errhandling, setjmp, va_copy, and va_end.
230)This includes, for example, passing a valid pointer that points one-past-the-end of an array along with a size of 0, or using any valid pointer with a size of 0. It also applies to functions which take a pointer to the start of array and a size describing that array, where the pointer is the null pointer and the size is exactly 0.
231)This means that an implementation is required to provide an actual function for each library function, even if it also provides a macro for that function.
232)However, such macros can sometimes not contain the sequence points that the corresponding function calls do.
233)Because external identifiers and some macro names beginning with an underscore are reserved, implementations can provide special semantics for such names. For example, the identifier _BUILTIN_abs can be used to indicate generation of in-line code for the abs function. Thus, the appropriate header can specify
234)Thus, a signal handler cannot, in general, call standard library functions.
235)This means, for example, that an implementation is not permitted to use a static object for internal purposes without synchronization because it can cause a data race even in programs that do not explicitly share objects between threads. Similarly, an implementation of memcpy is not permitted to copy bytes beyond the specified length of the destination object and then restore the original values because it can cause a data race if the program shared those bytes between threads.
236)This allows implementations to parallelize operations if there are no visible side effects.
237)The message written can be of the form:
238)See "future library directions" (7.35.2).
240)For a complex variable z, z and CMPLX(creal(z), cimag(z)) are equivalent expressions.
241)For a complex variable z, z and CMPLX(creal(z), cimag(z)) are equivalent expressions.
242)See "future library directions" (7.35.3).
243)In an implementation that uses the seven-bit US ASCII character set, the printing characters are those whose values lie from 0x20 (space) through 0x7E (tilde); the control characters are those whose values lie from 0 (NUL) through 0x1F (US), and the character 0x7F (DEL).
244)The functions islower and isupper test true or false separately for each of these additional characters; all four combinations are possible.
245)The macro errno is not expected to be the identifier of an object. Expansion to a modifiable lvalue resulting from a function call (for example, (*errno())) is a viable implementation strategy.
246)Thus, a program that uses errno for error checking would set it to zero before a library function call, then inspect it before a subsequent library function call. Of course, a library function can save the value of errno on entry and then set it to zero, as long as the original value is restored if errno’s value is still zero just before the return.
247)See "future library directions" (7.35.4).
248)This header is designed to support the floating-point exception status flags and rounding-direction control modes required by ISO/IEC 60559, and other similar floating-point state information. It is also designed to facilitate code portability among all systems.
249)A floating-point status flag is not an object and can be set more than once within an expression.
250)With these conventions, a programmer can safely assume default floating-point control modes (or be unaware of them). The responsibilities associated with accessing the floating-point environment fall on the programmer or program that does so explicitly.
251)The implementation supports a floating-point exception if there are circumstances where a call to at least one of the functions in 7.6.5, using the macro as the appropriate argument, will succeed. It is not necessary for all the functions to succeed all the time.
252)See "future library directions" (7.35.5).
253)The macros are typically distinct powers of two.
254)See "future library directions" (7.35.5).
255)Even though the rounding direction macros can expand to constants corresponding to the values of FLT_ROUNDS, they are not required to do so.
256)See "future library directions" (7.35.5).
257)The purpose of the FENV_ACCESS pragma is to allow certain optimizations that can subvert flag tests and mode changes (e.g. global common subexpression elimination, code motion, and constant folding). In general, if the state of FENV_ACCESS is "off", the translator can assume that the flags are not tested, and that default modes are in effect, except where specified otherwise by an FENV_ROUND pragma.
258)The side effects impose a temporal ordering that requires two evaluations of x + 1. On the other hand, without the #pragma STDC FENV_ACCESS ON pragma, and assuming the default state is "off", just one evaluation of x + 1 would suffice.
259)The functions fetestexcept, feraiseexcept, and feclearexcept support the basic abstraction of flags that are either set or clear. An implementation can endow floating-point status flags with more information — for example, the address of the code which first raised the floating-point exception; the functions fegetexceptflag and fesetexceptflag deal with the full content of flags.
260)The effect is intended to be similar to that of floating-point exceptions raised by arithmetic operations. Hence, implementation extensions associated with raising a floating-point exception (for example, enabled traps or ISO/IEC 60559 alternate exception handling) should be honored. The specification in F.8.7 is in the same spirit.
261)Implementation extensions like traps for floating-point exceptions and ISO/IEC 60559 exception handling do not occur.
262)This mechanism allows testing several floating-point exceptions with just one function call.
263)ISO/IEC 60559 systems have a default non-stop mode, and typically at least one other mode for trap handling or aborting; if the system provides only the non-stop mode then installing it is trivial. For such systems, the feholdexcept function can be used in conjunction with the feupdateenv function to write routines that hide spurious floating-point exceptions from their callers.
264)See "future library directions" (7.35.7).
265)For any given type, the corresponding macros for fprintf and fscanf functions can be distinct.
266)Only the absolute value of the most negative number is not representable for imaxabs.
267)ISO/IEC 9945 specifies locale and charmap formats that can be used to specify locales for C.
268)See "future library directions" (7.35.8).
269)The only functions in 7.4 whose behavior is not affected by the current locale are isdigit and isxdigit.
270)The implementation is thus required to arrange to encode in a string the various categories due to a heterogeneous locale when category has the value LC_ALL.
271)Particularly on systems with wide expression evaluation, a <math.h> function can pass arguments and return values in wider format than the synopsis prototype indicates.
272)The types float_t and double_t are intended to be the implementation’s most efficient types at least as wide as float and double, respectively. For FLT_EVAL_METHOD equal 0, 1, or 2, the type float_t is the narrowest type used by the implementation to evaluate floating expressions.
273)HUGE_VAL, HUGE_VALF, and HUGE_VALL can be positive infinities in an implementation that supports infinities.
274)Typically, the FP_FAST_FMA macro is defined if and only if the fma function is implemented directly with a hardware multiply-add instruction. Software implementations are expected to be substantially slower.
275)In an implementation that supports infinities, this allows an infinity as an argument to be a domain error if the mathematical domain of the function does not include the infinity.
276)Ordinary accuracy is determined by the implementation. It refers to the accuracy of the function where results are not compromised by extreme magnitude.
277)The term underflow here is intended to encompass both "gradual underflow" as in ISO/IEC 60559 and also "flush-to-zero" underflow. ISO/IEC 60559 underflow can occur in cases where the magnitude of the rounded result (accurate to the full precision of the type) equals the minimum normalized number in the format.
278)Math errors are being indicated by the floating-point exception flags rather than by errno.
279)Because an expression can be evaluated with greater range and precision than its type has, it is important to know the type that classification is based on. For example, a normal long double value can become subnormal when converted to double, and zero when converted to float.
280)For the isnan macro, the type for determination does not matter unless the implementation supports NaNs in the evaluation type but not in the semantic type.
281)The signbit macro determines the sign of all values, including infinities, zeros, and NaNs.
282)F.3 specifies that issignaling (and all the other classification macros), raise no floating-point exception if the argument is a variable, or any other expression whose value is represented in the format of its semantic type, even if the value is a signaling NaN.
283)For small magnitude x, expm1(x) is expected to be more accurate than exp(x)-1.
284)Unspecified cases include numbers that are not described by the model for floating-point numbers in 5.3.5.3.3.
285)The logp1 functions are preferred for name consistency with the log10p1 and log2p1 functions.
286)For small magnitude x, logp1(x) is expected to be more accurate than log(1 + x).
287)Restricting the domain to that of the formula y x is intended to better meet expectations for a continuous power function and to allow implementations with fewer tests for special cases.
289)The argument values are converted to the return type of the function, even by a macro implementation of the function.
290)The result of the nexttoward functions is determined in the return type of the function, without loss of range or precision in a floating second argument.
291)Arguments x and cx can point to the same object.
292)Quiet NaN arguments are treated as missing data: if one argument is a quiet NaN and the other numeric, then the fmax functions choose the numeric value. See F.10.10.2.
293)The fmin functions are analogous to the fmax functions in their treatment of quiet NaNs.
294)In some cases the destination type can sometimes not be narrower than the parameter types. For example, double potentially is not narrower than long double.
295)ISO/IEC 60559 requires that the built-in relational operators raise the "invalid" floating-point exception if the operands compare unordered, as an error indicator for programs written without consideration of NaNs; the result in these cases is false.
296)If any argument is of integer type, or any other type that is not a real floating type, the behavior is undefined.
297)Whether an argument represented in a format wider than its semantic type is converted to the semantic type is unspecified.
298)These functions are useful for dealing with unusual conditions encountered in a low-level function of a program.
299)For example, by executing a return statement or because another longjmp call has caused a transfer to a setjmp invocation in a function earlier in the set of nested calls.
300)This includes, but is not limited to, the floating-point environment and the state of open files.
301)See "future library directions" (7.35.10). The names of the signal numbers reflect the following terms (respectively): abort, floating-point exception, illegal instruction, interrupt, segmentation violation, and termination.
302)This includes functions called indirectly via standard library functions (e.g. a SIGABRT handler called via the abort function).
303)If any signal is generated by an asynchronous signal handler, the behavior is undefined.
304)A pointer to a va_list can be created and passed to another function, in which case the original function can make further use of the original list after the other function returns.
305)For conciseness only, this subclause refers to va_copy and va_end just as "macros". This is to be understood as a short-hand, not as a constraint on possible implementations.
306)Such types are in particular pointers to qualified or unqualified versions of void.
307)See "future library directions" (7.35.11).
308)See "future library directions" (7.35.11).
309)See "future library directions" (7.35.11).
310)obj can be a null pointer.
311)See "future library directions" (7.35.11).
312)The same representation and alignment requirements are meant to imply interchangeability as arguments to functions, return values from functions, and members of unions.
313)Bit-precise integer types do not perform integer promotion in these expressions and therefore prevent potential undefined behavior from a literal implementation which would use value in place of no_promote_value (e.g., from a function call such as stdc_rotate_left_us(0xFFFF, 15) with an unsigned short width of 16 with an int width of 24).
314)Bit-precise integer types do not perform integer promotion in these expressions and therefore prevent potential undefined behavior from a literal implementation which would use value in place of no_promote_value (e.g., from a function call such as stdc_rotate_right_us(0xFFFF, 15) with an unsigned short width of 16 with an int width of 24).
315)See "future library directions" (7.35.15).
316)Some of these types can denote implementation-defined extended integer types.
317)The designated type is not guaranteed to be fastest for all purposes; if the implementation has no clear grounds for choosing one type over another, it will simply pick some integer type satisfying the signedness and width requirements.
318)Thus this type is capable of representing any value of any unsigned integer type with the possible exception of bit-precise integer types and particular extended integer types that are wider than unsigned long long.
319)The exact-width and pointer-holding integer types are optional.
320)A freestanding implementation is not expected to provide all these types.
321)Of course, file name string contents are subject to other system-specific constraints; therefore all possible strings of length FILENAME_MAX cannot be expected to be opened successfully.
322)If the implementation only uses the [-]NAN style, then _PRINTF_NAN_LEN_MAX would have the value 4.
323)An implementation does not need to distinguish between text streams and binary streams. In such an implementation, there need be no new-line characters in a text stream nor any limit to the length of a line.
324)The three predefined streams stdin, stdout, and stderr are unoriented at program startup.
325)Setting the file position indicator to end-of-file, as with fseek(file, 0, SEEK_END), has undefined behavior for a binary stream (because of possible trailing null characters) or for any stream with state-dependent encoding that does not assuredly end in the initial shift state.
326)Among the reasons the implementation can cause the rename function to fail are that the file is open or that it is necessary to copy its contents to effectuate its renaming.
327)Files created using strings generated by the tmpnam function are temporary only in the sense that their names are not expected to collide with those generated by conventional naming rules for the implementation. It is still necessary to use the remove function to remove such files when their use is ended, and before program termination.
328)If the string begins with one of the listed mode sequences, the implementation can choose to ignore the remaining characters, or it can use them to select different kinds of a file (some of which can potentially not conform to the properties in 7.24.2).
329)The primary use of the freopen function is to change the file associated with a standard text stream (stderr, stdin, or stdout), as those identifiers are not required to be modifiable lvalues to which the value returned by the fopen function can be assigned.
330)The buffer has to have a lifetime at least as great as the open stream, so not closing the stream before a buffer that has automatic storage duration is deallocated upon block exit results in undefined behavior.
331)The fprintf functions perform writes to memory for the %n specifier.
332)0 is taken as a flag, not as the beginning of a field width.
333)The results of all floating conversions of a negative zero, and of negative values that round to zero, include a minus sign.
334)When applied to infinite and NaN values, the -, +, and space flag characters have their usual meaning; the # and 0 flag characters have no effect.
335)Binary implementations can choose the hexadecimal digit to the left of the decimal-point character so that subsequent digits align to nibble (4-bit) boundaries. This implementation choice affects numerical values printed with a precision P that is insufficient to represent all values exactly. Implementations with different conventions about the most significant hexadecimal digit will round at different places, affecting the numerical value of the hexadecimal result. For example, possible printed output for the code
336)The formatting precision is sufficient to distinguish values of the source type if where (not a power of 2) and are the base and precision of the source type (5.3.5.3.3). A smaller potentially suffices depending on the implementation’s scheme for determining the digit to the left of the decimal-point character.
337)No special provisions are made for multibyte characters.
338)Redundant shift sequences can result if multibyte characters have a state-dependent encoding.
339)See "future library directions" (7.35.16).
340)The behavior is undefined when the types differ as specified for va_arg 7.16.2.2.
341)For binary-to-decimal conversion, the result format’s values are the numbers representable with the given format specifier. The number of significant digits is determined by the format specifier, and in the case of fixed-point conversion by the source value as well.
342)These white-space characters are not counted against a specified field width.
343)fscanf pushes back at most one input character onto the input stream. Therefore, some sequences that are acceptable to strtod, strtol, etc., are unacceptable to fscanf.
344)No special provisions are made for multibyte characters in the matching rules used by the c, s, and [ conversion specifiers — the extent of the input field is determined on a byte-by-byte basis. The resulting field is nevertheless a sequence of multibyte characters that begins in the initial shift state.
345)See "future library directions" (7.35.16).
346)As the functions vfprintf, vfscanf, vprintf, vscanf, vsnprintf, vsprintf, and vsscanf invoke the va_arg macro, arg after the return has an indeterminate representation.
347)An end-of-file and a read error can be distinguished by use of the feof and ferror functions.
348)A file positioning function can further modify the file position indicator after discarding any pushed-back characters.
349)See "future library directions" (7.35.16).
350)See "future library directions" (7.35.17).
351)It is unspecified whether a minus-signed sequence is converted to a negative number directly or by arithmetically negating the value resulting from converting the corresponding unsigned sequence (see F.5); the two methods can yield different results if rounding is toward positive or negative infinity. In either case, the functions honor the sign of zero if floating-point arithmetic supports signed zeros.
352)An implementation can use the n-char sequence to determine extra information to be represented in the NaN’s significand.
353) is sufficiently large that L and U will usually correctly round to the same internal floating value, but if not will correctly round to adjacent values.
354)Non-arithmetic interchange formats are an optional feature in Annex H.
355)An implementation can use the d-char sequence to determine extra information to be represented in the NaN’s significand.
356)The alignment requirements from 7.25.4 also apply even if the requested alignment is less strict.
357)This is not expected to be the same as the representation of floating-point zero or a null pointer constant.
358)The atexit function registrations are distinct from the at_quick_exit registrations, so applications potentially need to call both registration functions with the same argument.
359)The at_quick_exit function registrations are distinct from the atexit registrations, so applications potentially need to call both registration functions with the same argument.
360)Each function is called as many times as it was registered, and in the correct order with respect to other registered functions.
361)Many implementations provide non-standard functions that modify the environment list.
362)Each function is called as many times as it was registered, and in the correct order with respect to other registered functions.
363)That is, if the value passed is p, then the following expressions are always nonzero:
364)In practice, the entire array is sorted according to the comparison function.
365)This is an obsolescent feature.
366)Only the absolute value of the most negative number is not representable for abs, labs, and llabs.
367)If the locale employs special bytes to change the shift state, these bytes do not produce separate wide character codes, but are grouped with an adjacent multibyte character.
368)The array will not be null-terminated if the value returned is n.
369)The actual alignment of an object can be stricter than the alignment requested for an object by alignas or (implicitly) by an allocation function, but will always satisfy it.
370)See "future library directions" (7.35.18).
371)Thus, if there is no null character in the first n characters of the array pointed to by s2, the result will not be nullterminated.
372)Thus, the maximum number of characters that can end up in the array pointed to by s1 is strlen(s1)+n+1.
373)The unused bytes used as padding for purposes of alignment within structure objects take on unspecified values when a value is stored in the object (see 6.2.6.1). Strings shorter than their allocated space and unions can also cause problems in comparison.
374)The null pointer constant is not a pointer to a const-qualified type, and therefore the result expression has the type of a pointer to an unqualified element.
375)This is an obsolescent feature.
376)The strtok_s function can be used instead to avoid data races.
377)The intention is that the memory store is always performed (i.e. never elided), regardless of optimizations. This is in contrast to calls to the memset function (7.28.6.1)
378)The strerror_s function can be used instead to avoid data races.
379)Like other function-like macros in standard libraries, each type-generic macro can be suppressed to make available the corresponding ordinary function.
380)If the type of the argument is not compatible with the type of the parameter for the selected function, the behavior is undefined.
381)See "future library directions" (7.35.20).
382)See future library directions (7.35). Implementations can define additional time bases, but are only required to support a real time clock based on UTC.
383)The tv_sec member is a linear count of seconds and potentially does not have the normal semantics of a time_t.
384)The range [0, 60] for tm_sec allows for a positive leap second.
385)This can be due to overflow of the clock_t type.
386)If the broken-down time specifies a time that is either skipped over or repeated when a transition to or from Daylight Saving Time occurs, it is unspecified whether the mktime function produces the same result as an equivalent call with a positive tm_isdst value or as an equivalent call with a tm_isdst value of zero.
387)Although a struct timespec object describes times with nanosecond resolution, the available resolution is system dependent and can even be greater than 1 second.
388)Commonly, this reference point is the boot time of the execution environment or the start of the execution.
389)The execution environment can, for example, lack the ability to track physical time that elapsed during suspension in a low power consumption mode.
390)This does not mean that these functions are forbidden to read global state that describes the time and calendar settings of the execution, such as the LC_TIME locale or the implementation-defined specification of the local time zone. Only the setting of that state by setlocale or by means of implementation-defined functions can constitute races.
391)See 7.31.1.
392)When n has at least the value of the MB_CUR_MAX macro, this case can only occur if s points at a sequence of redundant shift sequences (for implementations with state-dependent encodings).
393)When n has at least the value of the MB_CUR_MAX macro, this case can only occur if s points at a sequence of redundant shift sequences (for implementations with state-dependent encodings).
394)When n has at least the value of the MB_CUR_MAX macro, this case can only occur if s points at a sequence of redundant shift sequences (for implementations with state-dependent encodings).
395)See "future library directions" (7.35.21).
396)wchar_t and wint_t can be the same integer type.
397)The value of the macro WEOF can differ from that of EOF and the value can be positive.
398)The fwprintf functions perform writes to memory for the %n specifier.
399)0 is taken as a flag, not as the beginning of a field width.
400)The results of all floating conversions of a negative zero, and of negative values that round to zero, include a minus sign.
401)When applied to infinite and NaN values, the -, +, and space flag wide characters have their usual meaning; the # and 0 flag wide characters have no effect.
402)Binary implementations can choose the hexadecimal digit to the left of the decimal-point wide character so that subsequent digits align to nibble (4-bit) boundaries. This implementation choice affects numerical values printed with a precision P that is insufficient to represent all values exactly. Implementations with different conventions about the most significant hexadecimal digit will round at different places, affecting the numerical value of the hexadecimal result. For example, possible printed output for the code
403)The formatting precision is sufficient to distinguish values of the source type if where (not a power of 2) and are the base and precision of the source type (5.3.5.3.3). A smaller potentially suffices depending on the implementation’s scheme for determining the digit to the left of the decimal-point wide character.
404)See "future library directions" (7.35.21).
405)The behavior is undefined when the types differ as specified for va_arg 7.16.2.2.
406)For binary-to-decimal conversion, the result format’s values are the numbers representable with the given format specifier. The number of significant digits is determined by the format specifier, and in the case of fixed-point conversion by the source value as well.
407)These white-space wide characters are not counted against a specified field width.
408)fwscanf pushes back at most one input wide character onto the input stream. Therefore, some sequences that are acceptable to wcstod, wcstol, etc., are unacceptable to fwscanf.
409)See "future library directions" (7.35.21).
410)As the functions vfwprintf, vswprintf, vfwscanf, vwprintf, vwscanf, and vswscanf invoke the va_arg macro, the representation of arg after the return is indeterminate.
411)An end-of-file and a read error can be distinguished by use of the feof and ferror functions. Also, errno will be set to EILSEQ by input/output functions only if an encoding error occurs.
412)If the orientation of the stream has already been determined, fwide does not change it.
413)A file positioning function can further modify the file position indicator after discarding any pushed-back wide characters.
414)Wide string analogs of the strfromd family of functions (7.25.2.6, 7.25.2.7) are not provided because those conversions can be done by using mbstowcs (7.25.9.2) to convert the result of strfromd, strfromf, and similar to wide string. For example, the following converts double d to wide string ws with at most n-1 non-null wide characters, using style g formatting, and computes the number nc of wide characters that would have been written had n been sufficiently large, not counting the terminating null wide character.
415)It is unspecified whether a minus-signed sequence is converted to a negative number directly or by arithmetically negating the value resulting from converting the corresponding unsigned sequence (see F.5); the two methods can yield different results if rounding is toward positive or negative infinity. In either case, the functions honor the sign of zero if floating-point arithmetic supports signed zeros.
416)An implementation can use the n-wchar sequence to determine extra information to be represented in the NaN’s significand.
417) is sufficiently large that L and U will usually correctly round to the same internal floating value, but if not will correctly round to adjacent values.
418)Non-arithmetic interchange formats are an optional feature in Annex H.
419)An implementation can use the d-wchar sequence to determine extra information to be represented in the NaN’s significand.
420)Thus, if there is no null wide character in the first n wide characters of the array pointed to by s2, the result will not be null-terminated.
421)Thus, the maximum number of wide characters that can end up in the array pointed to by s1 is wcslen(s1)+n+1.
422)The null pointer constant is not a pointer to a const-qualified type, and therefore the result expression has the type of a pointer to an unqualified element.
423)This is an obsolescent feature.
424)Thus, a particular mbstate_t object can be used, for example, with both the mbrtowc and mbsrtowcs functions as long as they are used to step sequentially through the same multibyte character string.
425)When n has at least the value of the MB_CUR_MAX macro, this case can only occur if s points at a sequence of redundant shift sequences (for implementations with state-dependent encodings).
426)Thus, the value of len is ignored if dst is a null pointer.
427)If conversion stops because a terminating null wide character has been reached, the bytes stored include those necessary to reach the initial shift state immediately before the null byte.
428)See "future library directions" (7.35.22).
429)For example, if the expression isalpha(wctob(wc)) evaluates to true, then the call iswalpha(wc) also returns true. But, if the expression isgraph(wctob(wc)) evaluates to true (which cannot occur for wc == L’ ’ of course), then either iswgraph(wc) or iswprint(wc) && iswspace(wc) is true, but not both.
430)The functions iswlower and iswupper test true or false separately for each of these additional wide characters; all four combinations are possible.
431)The behavior of the iswgraph and iswpunct functions can differ from their corresponding functions in 7.4.2 with respect to printing, white-space, single-byte execution characters other than ’ ’.
432)For the minimum value of a signed integer type there is no expression consisting of a minus sign and a decimal literal of that same type. The numbers in the table are only given as indications for the values and do not represent suitable expressions to be used for these macros.
433)Implementations that do not define either of __STDC_IEC_60559_BFP__ and __STDC_IEC_559__ are not required to conform to these specifications. New code should not use the obsolescent macro __STDC_IEC_559__ to test for conformance to this annex.
434)ISO/IEC 60559 binary64-extended formats include the common 80-bit ISO/IEC 60559 format.
435)A non-ISO/IEC 60559 long double type provides signed infinities, signed zeros, and NaNs, as its values include all double values.
436)Because NaNs created by ISO/IEC 60559 arithmetic operations are always quiet, quiet NaNs (along with infinities) are sufficient for closure of the arithmetic.
437)Where the source and destination formats are the same, convertFormat operations differ from copy operations in that convertFormat operations raise the "invalid" floating-point exception on signaling NaN inputs and do not propagate non-canonical encodings.
438)ISO/IEC 60559 recommends that implicit floating-to-integer conversions raise the "inexact" floating-point exception for non-integer in-range values. In those cases where it matters, library functions can be used to effect such conversions with or without raising the "inexact" floating- point exception. See fromfp, ufromfp, fromfpx, ufromfpx, rint, lrint, llrint, and nearbyint in <math.h>.
439)The intermediate conversion is exact only if all input digits after the first CR_DECIMAL_DIG digits are .
440)Assignment removes any extra range and precision.
441)Dynamic rounding precision and trap enablement modes are examples of such extensions.
442)If the state for the FENV_ACCESS pragma is "off", the implementation is free to assume the dynamic floating-point control modes will be the default ones and the floating-point status flags will not be tested, which allows certain optimizations (see F.9).
443)As floating literals are converted to appropriate internal representations at translation time, their conversion is subject to constant or default rounding modes and raises no execution-time floating-point exceptions (even where the state of the FENV_ACCESS pragma is "on"). Library functions, for example strtod, provide execution-time conversion of numeric strings.
444)Where the state for the FENV_ACCESS pragma is "on", results of inexact expressions like 1.0/3.0 are affected by rounding modes set at execution time, and expressions such as 0.0/0.0 and 1.0/0.0 generate execution-time floating-point exceptions. The programmer can achieve the efficiency of translation-time evaluation through static initialization, such as
445)Use of float_t and double_t variables increases the likelihood of translation-time computation. For example, the automatic initialization
446)Implementations can have non-required features that invalidate these and other transformations that remove arithmetic operators. Examples include strict support for signaling NaNs (an optional feature) and alternate exception handling (not included in this specification).
447)ISO/IEC 60559 prescribes a signed zero to preserve mathematical identities across certain discontinuities. Examples include: is and conj(csqrt is csqrt(conj, for complex .
448)0-0 yields -0 instead of +0 just when the rounding direction is downward.
449)Tiny generally indicates having a magnitude in the subnormal range. See ISO/IEC 60559 for details about detecting tininess.
450)It is intended that spurious "underflow" and "inexact" floating-point exceptions are raised only if avoiding them would be too costly. 7.12.2 specifies that if math_errhandling & MATH_ERREXCEPT is nonzero, then an "underflow" floating-point exception shall not be raised unless an underflow range error occurs.
451)atan2 does not raise the "invalid" floating-point exception, nor does atan2 raise the "divide-by-zero" floatingpoint exception.
452)atan2pi does not raise the "invalid" floating-point exception, nor does atan2pi raise the "divide-by-zero" floating-point exception.
453)This code does not handle signaling NaNs as required of implementations that define FE_SNANS_ALWAYS_SIGNAL.
454)As if *x * 1e0 were computed.
455)If possible, fmax is sensitive to the sign of zero, for example fmax ideally returns . Note also that this implementation does not handle signaling NaNs as required of implementations that define FE_SNANS_ALWAYS_SIGNAL.
456)For the purpose of determining value inclusion (as in 6.2.5, 7.12, and H.11), quiet NaN representations can be regarded as having the same value, regardless of payloads.
457)Implementations that do not define __STDC_IEC_60559_COMPLEX__ are not required to conform to these specifications.
458)These properties are already implied for those cases covered in 6.5.6 but are required for all cases (at least where the state for CX_LIMITED_RANGE (7.3.4) is "off").
459)As noted in G.2, a complex value with at least one infinite part is regarded as an infinity even if its other part is a quiet NaN.
460)This allows cpow to be implemented as cexpclog without precluding implementations that treat special cases more carefully.
461)In ISO/IEC 60559, normal floating-point numbers are expressed with the first significant digit to the left of the radix point. Hence the exponent in the C model (shown in Table H.1, Table H.2 Table H.3, and Table H.4) is 1 more than the exponent of the same number in the ISO/IEC 60559 model.
462)All cases where float is expected to have the same format as another type are covered in the preceding paragraphs.
463)Implementations that do not define __STDC_LIB_EXT1__ are not required to conform to these specifications.
464)Future revisions of this document can define meanings for other values of __STDC_WANT_LIB_EXT1__.
465)7.1.3 reserves certain names and patterns of names that an implementation can use in headers. All other names are not reserved, and a conforming implementation is not permitted to use them. While some of the names defined in this annex and its subclauses are (potentially) reserved, others are not. If an unreserved name is defined in a header when __STDC_WANT_LIB_EXT1__ is defined as 0, the implementation is not conforming.
466)Although runtime-constraints replace many cases of undefined behavior, undefined behavior still exists in this annex. Implementations are free to detect any case of undefined behavior and treat it as a runtime-constraint violation by calling the runtime-constraint handler. This license comes directly from the definition of undefined behavior.
467)As a matter of programming style, errno_t can be used as the type of something that deals only with the values that can be found in errno. For example, a function which returns the value of errno can be declared as having the return type errno_t.
468)See the description of the RSIZE_MAX macro in <stdint.h>.
469)Files created using strings generated by the tmpnam_s function are temporary only in the sense that their names are not expected to collide with those generated by conventional naming rules for the implementation. It is still necessary to use the
471)It is not a runtime-constraint violation for the characters %n to appear in sequence in the string pointed at by format when those characters are not a interpreted as a %n specifier. For example, if the entire format string was %%n.
472)Because an implementation can treat any undefined behavior as a runtime-constraint violation, an implementation can treat any unsupported specifiers in the string pointed to by format as a runtime-constraint violation.
473)Because an implementation can treat any undefined behavior as a runtime-constraint violation, an implementation can treat any unsupported specifiers in the string pointed to by format as a runtime-constraint violation.
474)If the format is known at translation time, an implementation can issue a diagnostic for any argument used to store the result from a c, s, or [ conversion specifier if that argument is not followed by an argument of a type compatible with
475)It is not a runtime-constraint violation for the characters %n to appear in sequence in the string pointed at by format when those characters are not a interpreted as a %n specifier. For example, if the entire format string was %%n.
476)It is not a runtime-constraint violation for the characters %n to appear in sequence in the string pointed at by format when those characters are not a interpreted as a %n specifier. For example, if the entire format string was %%n.
477)It is not a runtime-constraint violation for the characters %n to appear in sequence in the string pointed at by format when those characters are not a interpreted as a %n specifier. For example, if the entire format string was %%n.
478)It is not a runtime-constraint violation for the characters %n to appear in sequence in the string pointed at by format when those characters are not a interpreted as a %n specifier. For example, if the entire format string was %%n.
479)As the functions vfprintf_s, vfscanf_s, vprintf_s, vscanf_s, vsnprintf_s, vsprintf_s, and vsscanf_s invoke the va_arg macro, the representation of arg after the return is indeterminate.
480)It is not a runtime-constraint violation for the characters %n to appear in sequence in the string pointed at by format when those characters are not a interpreted as a %n specifier. For example, if the entire format string was %%n.
481)As the functions vfprintf_s, vfscanf_s, vprintf_s, vscanf_s, vsnprintf_s, vsprintf_s, and vsscanf_s invoke the va_arg macro, the representation of arg after the return is indeterminate.
482)It is not a runtime-constraint violation for the characters %n to appear in sequence in the string pointed at by format when those characters are not a interpreted as a %n specifier. For example, if the entire format string was %%n.
483)It is not a runtime-constraint violation for the characters %n to appear in sequence in the string pointed at by format when those characters are not a interpreted as a %n specifier. For example, if the entire format string was %%n.
484)As the functions vfprintf_s, vfscanf_s, vprintf_s, vscanf_s, vsnprintf_s, vsprintf_s, and vsscanf_s invoke the va_arg macro, the value of arg after the return is indeterminate.
485)The gets_s function, unlike the historical gets function, makes it a runtime-constraint violation for a line of input to overflow the buffer to store it. Unlike the fgets function, gets_s maintains a one-to-one relationship between input lines and successful calls to gets_s. Programs that use gets expect such a relationship.
486)If the previous handler was registered by calling set_constraint_handler_s with a null pointer argument, a pointer to the implementation default handler is returned (not null).
487)Many implementations invoke a debugger when the abort function is called.
488)If the runtime-constraint handler is set to the ignore_handler_s function, any library function in which a runtimeconstraint violation occurs will return to its caller. The caller can determine whether a runtime-constraint violation occurred based on the library function’s specification (usually, the library function returns a nonzero errno_t).
489)Many implementations provide non-standard functions that modify the environment list.
490)That is, if the value passed is p, then the following expressions are always valid and nonzero:
491)In practice, this means that the entire array has been sorted according to the comparison function.
492)The context argument is for the use of the comparison function in performing its duties. For example, it can specify a collating sequence used by the comparison function.
493)If the argument is a null pointer and the call is executed, the behavior is undefined.
494)This is an obsolescent feature.
495)The context argument is for the use of the comparison function in performing its duties. For example, it can specify a collating sequence used by the comparison function.
496)If the locale employs special bytes to change the shift state, these bytes do not produce separate wide character codes, but are grouped with an adjacent multibyte character.
497)Thus, the value of len is ignored if dst is a null pointer.
498)This allows an implementation to attempt converting the multibyte string before discovering a terminating null character did not occur where required.
499)If conversion stops because a terminating null wide character has been reached, the bytes stored include those necessary to reach the initial shift state immediately before the null byte. However, if the conversion stops before a terminating null wide character has been reached, the result will be null terminated, but potentially not end in the initial shift state.
500)When len is not less than dstmax, the implementation can fill the array before discovering a runtime-constraint violation.
501)This allows an implementation to copy characters from s2 to s1 while simultaneously checking if any of those characters are null. Such an approach can write a character to every element of s1 before discovering that the first element was set to the null character.
502)A zero return value implies that all the requested characters from the string pointed to by s2 fit within the array pointed to by s1 and that the result in s1 is null terminated.
503)This allows an implementation to copy characters from s2 to s1 while simultaneously checking if any of those characters are null. Such an approach can write a character to every element of s1 before discovering that the first element was set to the null character.
504)A zero return value implies that all of he requested characters from the string pointed to by s2 fit within the array pointed to by s1 and that the result in s1 is null terminated.
505)Zero means that s1 was not null terminated upon entry to strcat_s.
506)This allows an implementation to append characters from s2 to s1 while simultaneously checking if any of those characters are null. Such an approach can write a character to every element of s1 before discovering that the first element was set to the null character.
507)A zero return value implies that all the requested characters from the string pointed to by s2 were appended to the string pointed to by s1 and that the result in s1 is null terminated.
508)Zero means that s1 was not null terminated upon entry to strncat_s.
509)This allows an implementation to append characters from s2 to s1 while simultaneously checking if any of those characters are null. Such an approach can write a character to every element of s1 before discovering that the first element was set to the null character.
510)A zero return value implies that all the requested characters from the string pointed to by s2 were appended to the string pointed to by s1 and that the result in s1 is null terminated.
511)The strnlen_s function has no runtime-constraints. This lack of runtime-constraints along with the values returned for a null pointer or an unterminated string argument make strnlen_s useful in algorithms that gracefully handle such exceptional data.
512)The normal ranges are defined in 7.31.1.
513)It is not a runtime-constraint violation for the wide characters %n to appear in sequence in the wide string pointed at by format when those wide characters are not a interpreted as a %n specifier. For example, if the entire format string was L"%%n".
514)If the format is known at translation time, an implementation can issue a diagnostic for any argument used to store the result from a c, s, or [ conversion specifier if that argument is not followed by an argument of a type compatible with rsize_t. A limited amount of checking can be done if even if the format is not known at translation time. For example, an implementation can issue a diagnostic for each argument after format that has of type pointer to one of char, signed char, unsigned char, or void that is not followed by an argument of a type compatible with rsize_t. The diagnostic can warn that unless the pointer is being used with a conversion specifier using the hh length modifier, a length argument is expected to follow the pointer argument. Another useful diagnostic can flag any non-pointer argument following format that did not have a type compatible with rsize_t.
515)It is not a runtime-constraint violation for the wide characters %n to appear in sequence in the wide string pointed at by format when those wide characters are not a interpreted as a %n specifier. For example, if the entire format string was L"%%n".
516)It is not a runtime-constraint violation for the wide characters %n to appear in sequence in the wide string pointed at by format when those wide characters are not a interpreted as a %n specifier. For example, if the entire format string was L"%%n".
517)It is not a runtime-constraint violation for the wide characters %n to appear in sequence in the wide string pointed at by format when those wide characters are not a interpreted as a %n specifier. For example, if the entire format string was L"%%n".
518)As the functions vfwscanf_s, vwscanf_s, and vswscanf_s invoke the va_arg macro, the representation of arg after the return is indeterminate.
519)It is not a runtime-constraint violation for the wide characters %n to appear in sequence in the wide string pointed at by format when those wide characters are not a interpreted as a %n specifier. For example, if the entire format string was L"%%n".
520)It is not a runtime-constraint violation for the wide characters %n to appear in sequence in the wide string pointed at by format when those wide characters are not a interpreted as a %n specifier. For example, if the entire format string was L"%%n".
521)As the functions vfwscanf_s, vwscanf_s, and vswscanf_s invoke the va_arg macro, the representation of arg after the return is indeterminate.
522)It is not a runtime-constraint violation for the wide characters %n to appear in sequence in the wide string pointed at by format when those wide characters are not a interpreted as a %n specifier. For example, if the entire format string was L"%%n".
523)As the functions vfwscanf_s, vwscanf_s, and vswscanf_s invoke the va_arg macro, the representation of arg after the return is indeterminate.
524)It is not a runtime-constraint violation for the wide characters %n to appear in sequence in the wide string pointed at by format when those wide characters are not a interpreted as a %n specifier. For example, if the entire format string was L"%%n".
525)This allows an implementation to copy wide characters from s2 to s1 while simultaneously checking if any of those wide characters are null. Such an approach can write a wide character to every element of s1 before discovering that the first element was set to the null wide character.
526)A zero return value implies that all the requested wide characters from the string pointed to by s2 fit within the array pointed to by s1 and that the result in s1 is null terminated.
527)This allows an implementation to copy wide characters from s2 to s1 while simultaneously checking if any of those wide characters are null. Such an approach can write a wide character to every element of s1 before discovering that the first element was set to the null wide character.
528)A zero return value implies that all the requested wide characters from the string pointed to by s2 fit within the array pointed to by s1 and that the result in s1 is null terminated.
529)Zero means that s1 was not null terminated upon entry to wcscat_s.
530)This allows an implementation to append wide characters from s2 to s1 while simultaneously checking if any of those wide characters are null. Such an approach can write a wide character to every element of s1 before discovering that the first element was set to the null wide character.
531)A zero return value implies that all the requested wide characters from the wide string pointed to by s2 were appended to the wide string pointed to by s1 and that the result in s1 is null terminated.
532)Zero means that s1 was not null terminated upon entry to wcsncat_s.
533)This allows an implementation to append wide characters from s2 to s1 while simultaneously checking if any of those wide characters are null. Such an approach can write a wide character to every element of s1 before discovering that the first element was set to the null wide character.
534)A zero return value implies that all the requested wide characters from the wide string pointed to by s2 were appended to the wide string pointed to by s1 and that the result in s1 is null terminated.
535)The wcsnlen_s function has no runtime-constraints. This lack of runtime-constraints along with the values returned for a null pointer or an unterminated wide string argument make wcsnlen_s useful in algorithms that gracefully handle such exceptional data.
536)Thus, the value of len is ignored if dst is a null pointer.
537)This allows an implementation to attempt converting the multibyte string before discovering a terminating null character did not occur where required.
538)If conversion stops because a terminating null wide character has been reached, the bytes stored include those necessary to reach the initial shift state immediately before the null byte. However, if the conversion stops before a terminating null wide character has been reached, the result will be null terminated, but does not necessarily end in the initial shift state.
539)When len is not less than dstmax, the implementation can fill the array before discovering a runtime-constraint violation.
540)Implementations that do not define __STDC_ANALYZABLE__ are not required to conform to these specifications.