7b70c135df65d538a52506517d5955f2d1442f23
[dwarf-doc.git] / dwarf5 / latexdoc / typeentries.tex
1 \chapter{Type Entries}
2 \label{chap:typeentries}
3 This section presents the debugging information entries
4 that describe program types: base types, modified types and
5 user-defined types.
6
7
8 \section{Base Type Entries}
9 \label{chap:basetypeentries}
10
11 \textit{A base type is a data type that is not defined in terms of
12 other data types. 
13 \addtoindexx{fundamental type|see{base type entry}}
14 Each programming language has a set of base
15 types that are considered to be built into that language.}
16
17 A base type is represented by a debugging information entry
18 with the tag \DWTAGbasetypeTARG.
19
20 A \addtoindex{base type entry}
21 may have a \DWATname{} attribute\addtoindexx{name attribute}
22 whose value is
23 a null-terminated string containing the name of the base type
24 as recognized by the programming language of the compilation
25 unit containing the base type entry.
26
27 A base type entry has 
28 \addtoindexx{encoding attribute}
29 a \DWATencoding{} attribute describing
30 how the base type is encoded and is to be interpreted. 
31 The \DWATencoding{} attribute is described in
32 Section \referfol{chap:basetypeencodings}.
33
34 A base type entry
35 may have a \DWATendianity{} attribute
36 \addtoindexx{endianity attribute}
37 as described in 
38 Section \refersec{chap:dataobjectentries}. 
39 If omitted, the encoding assumes the representation that
40 is the default for the target architecture.
41
42 \needlines{4}
43 A base type entry has a
44 \addtoindexx{byte size attribute}
45 \DWATbytesize{}\hypertarget{chap:DWATbytesizedataobjectordatatypesize}{}
46 attribute or a
47 \addtoindexx{bit size attribute}
48 \DWATbitsize{}\hypertarget{chap:DWATbitsizebasetypebitsize}{} 
49 attribute whose \livelink{chap:classconstant}{integer constant} value
50 (see Section \refersec{chap:byteandbitsizes}) 
51 is the amount of storage needed to hold a value of the type.
52
53 \needlines{5}
54 \textit{For example, the 
55 \addtoindex{C} type \texttt{int} on a machine that uses 32-bit
56 integers is represented by a base type entry with a name
57 attribute whose value is \doublequote{int}, an encoding attribute
58 whose value is \DWATEsigned{}
59 and a byte size attribute whose value is 4.}
60
61 If the value of an object of the given type does not fully
62 occupy the storage described by a byte size 
63 attribute,\hypertarget{chap:DWATdatabitoffsetbasetypebitlocation}{}
64 the base type entry may also have a 
65 \DWATbitsizeDEFN{} and a \DWATdatabitoffsetDEFN{} attribute,
66 \addtoindexx{bit size attribute}
67 \addtoindexx{data bit offset attribute}
68 both of whose values are
69 \livelink{chap:classconstant}{integer constant} values
70 (see Section \refersec{chap:staticanddynamicvaluesofattributes}). 
71 The bit size
72 attribute describes the actual size in bits used to represent
73 values of the given type. The data bit offset attribute is the
74 offset in bits from the beginning of the containing storage to
75 the beginning of the value. Bits that are part of the offset
76 are padding. 
77 If this attribute is omitted a default data bit offset
78 of zero is assumed.
79
80 A \DWTAGbasetype{} entry may have additional attributes that
81 augment certain of the base type encodings; these are described
82 in the following section.
83
84 \subsection{Base Type Encodings}
85 \label{chap:basetypeencodings}
86 A base type entry has 
87 \addtoindexx{encoding attribute}
88 a \DWATencoding{} attribute describing
89 how the base type is encoded and is to be interpreted. The 
90 value of this attribute is an integer of class \CLASSconstant.
91 The set of values and their meanings for the
92 \DWATencoding{} attribute is given in 
93 Table \refersec{tab:encodingattributevalues}.
94
95 \textit{In Table \ref{tab:encodingattributevalues}, encodings
96 are shown in groups that have similar characteristics purely
97 for presentation purposes. These groups are not part of this
98 DWARF specification.}
99
100 \newcommand{\EncodingGroup}[1]{\multicolumn{2}{l}{\hspace{2cm}\bfseries\textit{#1}}}
101 \begin{table}[!ht]
102 \caption{Encoding attribute values}
103 \label{tab:encodingattributevalues}
104 \centering
105 \begin{tabular}{l|P{8cm}}
106 \hline
107 \bfseries Name & \bfseries Meaning\\ \hline
108
109 \EncodingGroup{Simple encodings} \\
110 \DWATEbooleanTARG      & true or false \\
111 \DWATEaddressTARG{}    & linear machine address$^a$ \\
112 \DWATEsignedTARG       & signed binary integer \\
113 \DWATEsignedcharTARG   & signed character \\
114 \DWATEunsignedTARG     & unsigned binary integer \\
115 \DWATEunsignedcharTARG & unsigned character \\
116
117 \EncodingGroup{Character encodings} \\
118 \DWATEASCIITARG{} & \addtoindex{ISO/IEC 646:1991 character} 
119                     \addtoindexx{ASCII character} \\
120 \DWATEUCSTARG{}   & \addtoindex{ISO/IEC 10646-1:1993 character (UCS-4)} 
121                     \addtoindexx{UCS character} \\
122 \DWATEUTFTARG{}   & \addtoindex{ISO/IEC 10646-1:1993 character}
123                     \addtoindexx{UTF character} \\
124
125 \EncodingGroup{Scaled encodings} \\
126 \DWATEsignedfixedTARG{} & signed fixed-point scaled integer \\
127 \DWATEunsignedfixedTARG & unsigned fixed-point scaled integer \\
128
129 \EncodingGroup{Floating-point encodings} \\
130 \DWATEfloatTARG          & binary floating-point number \\
131 \DWATEcomplexfloatTARG   & complex binary floating-point number \\
132 \DWATEimaginaryfloatTARG & imaginary binary floating-point number \\
133 \DWATEdecimalfloatTARG{} & \addtoindex{IEEE 754R decimal floating-point number} \\ 
134
135 \EncodingGroup{Decimal string encodings} \\
136 \DWATEpackeddecimalTARG & packed decimal number\\
137 \DWATEnumericstringTARG & numeric string \\
138 \DWATEeditedTARG        & edited string \\
139
140 \hline
141 \multicolumn{2}{l}{$^a$For segmented addresses, see Section \refersec{chap:segmentedaddresses}} \\
142 \end{tabular}
143 \end{table}
144
145 \subsubsection{Simple Encodings}
146 \label{chap:simpleencodings}
147 Types with simple encodings are widely supported in many
148 programming languages and are not discussed further.
149
150 \needlines{6}
151 \subsubsection{Character Encodings}
152 \label{chap:characterencodings}
153 \DWATEUTF{} 
154 specifies the \addtoindex{Unicode} string encoding
155 (see the Universal Character Set standard,
156 ISO/IEC 10646\dash 1:1993).
157 \addtoindexx{ISO 10646 character set standard}
158
159 \textit{For example, the \addtoindex{C++} type char16\_t is
160 represented by a base type entry with a name attribute whose
161 value is \doublequote{char16\_t}, an encoding attribute whose value
162 is \DWATEUTF{} and a byte size attribute whose value is 2.}
163
164 \needlines{4}
165 \DWATEASCII{} and \DWATEUCS{} specify encodings for
166 the \addtoindex{Fortran 2003} string kinds 
167 \texttt{ASCII}\index{ASCII@\texttt{ASCII} (Fortran string kind)} (ISO/IEC 646:1991) and
168 \texttt{ISO\_10646}\index{ISO\_10646@\texttt{ISO\_10646} (Fortran string kind)} (UCS-4 in ISO/IEC 10646:2000).
169 \addtoindexx{ISO 10646 character set standard}
170
171 \subsubsection{Scaled Encodings}
172 \label{chap:scaledencodings}
173 The \DWATEsignedfixed{} and \DWATEunsignedfixed{} entries
174 describe signed and unsigned fixed\dash point binary data types,
175 respectively.
176
177 The fixed binary type encodings have a
178 \DWATdigitcount{} attribute\addtoindexx{digit count attribute}
179 with the same interpretation as described for the
180 \DWATEpackeddecimal{} and \DWATEnumericstring{} base type encodings
181 (see Section \refersec{chap:decimalstringencodings}).
182
183 \needlines{4}
184 For a data type with a decimal scale factor, the fixed binary
185 type entry has a \DWATdecimalscale{} attribute 
186 \addtoindexx{decimal scale attribute}
187 with the same interpretation as described for the 
188 \DWATEpackeddecimal{} and \DWATEnumericstring{} base types
189 (see Section \refersec{chap:decimalstringencodings}).
190
191 For\hypertarget{chap:DWATbinaryscalebinaryscalefactorforfixedpointtype}{}
192 a data type with a binary scale factor, the fixed
193 binary type entry has a \DWATbinaryscaleNAME{} attribute. 
194 The \DWATbinaryscaleDEFN{} attribute\addtoindexx{binary scale attribute} 
195 is an \livelink{chap:classconstant}{integer constant} value
196 that represents the exponent of the base two scale factor to
197 be applied to an instance of the type.  Zero scale puts the
198 binary point immediately to the right of the least significant
199 bit. Positive scale moves the binary point to the right and
200 implies that additional zero bits on the right are not stored
201 in an instance of the type. Negative scale moves the binary
202 point to the left; if the absolute value of the scale is
203 larger than the number of bits, this implies additional zero
204 bits on the left are not stored in an instance of the type.
205
206 For\hypertarget{chap:DWATsmallscalefactorforfixedpointtype}{}
207 a data type with a non-decimal and non-binary scale factor,
208 the fixed binary type entry has a \DWATsmallDEFN{} attribute which
209 \addtoindexx{small attribute} references a 
210 \DWTAGconstant{} entry. The scale factor value
211 is interpreted in accordance with the value defined by the
212 \DWTAGconstant{} entry. The value represented is the product
213 of the integer value in memory and the associated constant
214 entry for the type.
215
216 \textit{The \DWATsmall{} attribute is defined with the 
217 \addtoindex{Ada} \texttt{small} attribute in mind.}
218
219 \needlines{6}
220 \subsubsection{Floating-Point Encodings}
221 \label{chap:floatingpointencodings}
222 Types with binary floating-point encodings 
223 (\DWATEfloat{}, \DWATEcomplexfloat{} and \DWATEimaginaryfloat{})
224 are supported in many
225 programming languages and are not discussed further.
226
227 \DWATEdecimalfloat{} specifies 
228 floating-point representations that have a power-of-ten
229 exponent, such as specified in IEEE 754R.
230
231 \subsubsection{Decimal String Encodings}
232 \label{chap:decimalstringencodings}
233 The \DWATEpackeddecimalDEFN{} and \DWATEnumericstringDEFN{} 
234 base type encodings
235 represent packed and unpacked decimal string numeric data
236 types, respectively, either of which may be either 
237 \addtoindexx{decimal scale attribute}
238 signed
239 \addtoindexx{decimal sign attribute}
240 or 
241 \addtoindexx{digit count attribute}
242 unsigned. These 
243 base types are used in combination with
244 \DWATdecimalsign, 
245 \DWATdigitcount{} and 
246 \DWATdecimalscale{}
247 attributes.
248
249 \needlines{5}
250 A\hypertarget{chap:DWATdecimalsigndecimalsignrepresentation}{}
251 \DWATdecimalsignDEFN{} attribute 
252 \addtoindexx{decimal sign attribute}
253 is an \livelink{chap:classconstant}{integer constant} that
254 conveys the representation of the sign of the decimal type
255 (see Table \refersec{tab:decimalsignattributevalues}). 
256 Its \livelink{chap:classconstant}{integer constant} value is interpreted to
257 mean that the type has a leading overpunch, trailing overpunch,
258 leading separate or trailing separate sign representation or,
259 alternatively, no sign at all.
260
261 \begin{table}[ht]
262 \caption{Decimal sign attribute values}
263 \label{tab:decimalsignattributevalues}
264 \centering
265 \begin{tabular}{l|P{9cm}}
266 \hline
267  Name & Meaning \\
268 \hline
269 \DWDSunsignedTARG{} &  Unsigned \\
270 \DWDSleadingoverpunchTARG{} & Sign
271 is encoded in the most significant digit in a target-dependent  manner \\
272 \DWDStrailingoverpunchTARG{} & Sign
273 is encoded in the least significant digit in a target-dependent manner \\
274 \DWDSleadingseparateTARG{} 
275 & Decimal type: Sign is a \doublequote{+} or \doublequote{-} character 
276 to the left of the most significant digit. \\
277 \DWDStrailingseparateTARG{} 
278 & Decimal type: Sign is a \doublequote{+} or \doublequote{-} character 
279 to the right of the least significant digit. \\
280 &Packed decimal type: Least significant nibble contains
281 a target\dash dependent value
282 indicating positive or negative. \\
283 \hline
284 \end{tabular}
285 \end{table}
286
287 \needlines{4}
288 The\hypertarget{chap:DWATdecimalscaledecimalscalefactor}{}
289 \DWATdecimalscaleDEFN{} attribute 
290 \addtoindexx{decimal scale attribute}
291 is an integer constant value
292 that represents the exponent of the base ten scale factor to
293 be applied to an instance of the type. A scale of zero puts the
294 decimal point immediately to the right of the least significant
295 digit. Positive scale moves the decimal point to the right
296 and implies that additional zero digits on the right are not
297 stored in an instance of the type. Negative scale moves the
298 decimal point to the left; if the absolute value of the scale
299 is larger than the digit count, this implies additional zero
300 digits on the left are not stored in an instance of the type.
301
302 The\hypertarget{chap:DWATdigitcountdigitcountforpackeddecimalornumericstringtype}{} 
303 \DWATdigitcountDEFN{} attribute 
304 \addtoindexx{digit count attribute}
305 is an \livelink{chap:classconstant}{integer constant}
306 value that represents the number of digits in an instance of
307 the type.
308
309 The\hypertarget{chap:DWATpicturestringpicturestringfornumericstringtype}{}
310 \DWATEedited{} base type is used to represent an edited
311 numeric or alphanumeric data type. It is used in combination
312 with a \DWATpicturestringDEFN{} attribute whose value is a 
313 null\dash terminated string containing the target\dash dependent picture
314 string associated with the type.
315
316 If the edited base type entry describes an edited numeric
317 data type, the edited type entry has a \DWATdigitcount{} and a
318 \DWATdecimalscale{} attribute.\addtoindexx{decimal scale attribute}
319 These attributes have the same
320 interpretation as described for the 
321 \DWATEpackeddecimal{} and
322 \DWATEnumericstring{} base 
323 types. If the edited type entry
324 describes an edited alphanumeric data type, the edited type
325 entry does not have these attributes.
326
327 \textit{The presence or absence of the \DWATdigitcount{} and
328 \DWATdecimalscale{} attributes\addtoindexx{decimal scale attribute}
329 allows a debugger to easily
330 distinguish edited numeric from edited alphanumeric, although
331 in principle the digit count and scale are derivable by
332 interpreting the picture string.}
333
334
335 \section{Unspecified Type Entries}
336 \label{chap:unspecifiedtypeentries}
337 \addtoindexx{unspecified type entry}
338 \addtoindexx{void type|see{unspecified type entry}}
339 Some languages have constructs in which a type 
340 may be left unspecified or the absence of a type
341 may be explicitly indicated.
342
343 An unspecified (implicit, unknown, ambiguous or nonexistent)
344 type is represented by a debugging information entry with
345 the tag \DWTAGunspecifiedtypeTARG. 
346 If a name has been given
347 to the type, then the corresponding unspecified type entry
348 has a \DWATname{} attribute 
349 \addtoindexx{name attribute}
350 whose value is
351 a null\dash terminated
352 string containing the name.
353
354 \textit{The interpretation of this debugging information entry is
355 intentionally left flexible to allow it to be interpreted
356 appropriately in different languages. For example, in 
357 \addtoindex{C} and \addtoindex{C++}
358 the language implementation can provide an unspecified type
359 entry with the name \doublequote{void} which can be referenced by the
360 type attribute of pointer types and typedef declarations for
361 'void' (see 
362 Sections \refersec{chap:typemodifierentries} and 
363 %The following reference was valid, so the following is probably correct.
364 Section \refersec{chap:typedefentries}, 
365 respectively). As another
366 example, in \addtoindex{Ada} such an unspecified type entry can be referred
367 to by the type attribute of an access type where the denoted
368 \addtoindexx{incomplete type (Ada)}
369 type is incomplete (the name is declared as a type but the
370 definition is deferred to a separate compilation unit).}
371
372 \textit{\addtoindex{C++} permits using the 
373 \autoreturntype{} specifier for the return type of a member function declaration. 
374 The actual return type is deduced based on the definition of the 
375 function, so it may not be known when the function is declared.  The language 
376 implementation can provide an unspecified type entry with the name \texttt{auto} which 
377 can be referenced by the return type attribute of a function declaration entry.  
378 When the function is later defined, the \DWTAGsubprogram{} entry for the definition
379 includes a reference to the actual return type.}
380
381
382 \section{Type Modifier Entries}
383 \label{chap:typemodifierentries}
384 \addtoindexx{type modifier entry}
385 \addtoindexx{type modifier|see{atomic type entry}}
386 \addtoindexx{type modifier|see{constant type entry}}
387 \addtoindexx{type modifier|see{reference type entry}}
388 \addtoindexx{type modifier|see{restricted type entry}}
389 \addtoindexx{type modifier|see{packed type entry}}
390 \addtoindexx{type modifier|see{pointer type entry}}
391 \addtoindexx{type modifier|see{shared type entry}}
392 \addtoindexx{type modifier|see{volatile type entry}}
393 A base or user\dash defined type may be modified in different ways
394 in different languages. A type modifier is represented in
395 DWARF by a debugging information entry with one of the tags
396 given in Table \refersec{tab:typemodifiertags}.
397
398 If a name has been given to the modified type in the source
399 program, then the corresponding modified type entry has
400 a \DWATname{} attribute 
401 \addtoindexx{name attribute}
402 whose value is a null\dash terminated
403 string containing the modified type name. 
404
405 Each of the type modifier entries has 
406 \addtoindexx{type attribute}
407
408 \DWATtype{} attribute,
409 whose value is a \livelink{chap:classreference}{reference} 
410 to a debugging information entry
411 describing a base type, a user-defined type or another type
412 modifier.
413
414 A modified type entry describing a 
415 \addtoindexx{pointer type entry}
416 pointer or \addtoindex{reference type}
417 (using \DWTAGpointertype,
418 \DWTAGreferencetype{} or
419 \DWTAGrvaluereferencetype) 
420 % Another instance of no-good-place-to-put-index entry.
421 may have
422 a\hypertarget{chap:DWATadressclasspointerorreferencetypes}{}
423 \DWATaddressclassDEFN{}\addtoindexx{address class attribute} 
424 attribute to describe how objects having the given pointer
425 or reference type are dereferenced.
426
427 A modified type entry describing a \addtoindex{UPC} shared qualified type
428 (using \DWTAGsharedtype) may have a
429 \DWATcount{} attribute
430 \addtoindexx{count attribute}
431 whose value is a constant expressing the (explicit or implied) blocksize specified for the
432 type in the source. If no count attribute is present, then the \doublequote{infinite}
433 blocksize is assumed.
434
435 When multiple type modifiers are chained together to modify
436 a base or user-defined type, the tree ordering reflects the
437 semantics of the 
438 \addtoindexx{reference type entry, lvalue|see{reference type entry}}
439 applicable language 
440 \addtoindexx{reference type entry, rvalue|see{rvalue reference type entry}}
441 rather 
442 \addtoindexx{parameter|see{macro formal parameter list}}
443 than 
444 \addtoindexx{parameter|see{\textit{this} parameter}}
445 the 
446 \addtoindexx{parameter|see{variable parameter attribute}}
447 textual
448 \addtoindexx{parameter|see{optional parameter attribute}}
449 order 
450 \addtoindexx{parameter|see{unspecified parameters entry}}
451 in 
452 \addtoindexx{parameter|see{template value parameter entry}}
453 the 
454 \addtoindexx{parameter|see{template type parameter entry}}
455 source 
456 \addtoindexx{parameter|see{formal parameter entry}}
457 presentation.
458
459 \begin{table}[ht]
460 \caption{Type modifier tags}
461 \label{tab:typemodifiertags}
462 \centering
463 \begin{tabular}{l|P{9cm}}
464 \hline
465 Name&Meaning\\ \hline
466 \DWTAGatomictypeTARG{} & 
467     atomic qualified type 
468     (for example, in C) 
469     \addtoindexx{atomic qualified type entry} \addtoindexx{C} \\
470 \DWTAGconsttypeTARG{} &  
471     const qualified type 
472     (for example in C, C++)
473     \addtoindexx{const qualified type entry} \addtoindexx{C} \addtoindexx{C++} \\
474 \DWTAGimmutabletypeTARG &
475     immutable type 
476     (for example, in \addtoindex{D})
477     \addtoindexx{immutable type} \\
478 \DWTAGpackedtypeTARG & 
479     packed type\addtoindexx{packed type entry} 
480     (for example in Ada, Pascal)
481     \addtoindexx{packed qualified type entry} \addtoindexx{Ada} \addtoindexx{Pascal} \\
482 \DWTAGpointertypeTARG{} & 
483     pointer to an object of the type being modified 
484     \addtoindexx{pointer qualified type entry} \\
485 \DWTAGreferencetypeTARG & 
486     reference to (lvalue of) an object of the type \mbox{being} modified 
487     \addtoindexx{reference type entry}
488     \addtoindexx{reference qualified type entry} \\
489 \DWTAGrestricttypeTARG &  
490     restrict qualified type
491     \addtoindexx{restricted type entry}
492     \addtoindexx{restrict qualified type} \addtoindexx{C} \\
493 \DWTAGrvaluereferencetypeTARG{} &
494     rvalue reference to an object of the type \mbox{being} modified  
495     (for example, in \addtoindex{C++}) 
496     \addtoindexx{rvalue reference type entry}
497     \addtoindexx{restricted type entry}
498     \addtoindexx{rvalue reference qualified type entry} \\
499 \DWTAGsharedtypeTARG &
500     shared qualified type 
501     (for example, in \addtoindex{UPC}) 
502     \addtoindexx{shared qualified type entry} \\
503 \DWTAGvolatiletypeTARG & 
504     volatile qualified type 
505     (for example, in \addtoindex{C}, \addtoindex{C++}) 
506     \addtoindexx{volatile qualified type entry} \\
507 \hline
508 \end{tabular}
509 \end{table}
510
511 \needlines{6}
512 \textit{As examples of how type modifiers are ordered, consider the following
513 \addtoindex{C} declarations:}
514 \par % Needed to end paragraph before listing so that it gets a line number
515 \begin{nlnlisting}
516    const unsigned char * volatile p;
517 \end{nlnlisting}
518
519 \textit{This represents a volatile pointer to a constant
520 character. It is encoded in DWARF as:}
521 \par % Needed to end paragraph before listing so that it gets a line number
522 \nolinenumbers
523 \begin{dwflisting}
524 \begin{alltt}
525         \DWTAGvariable(p) -->
526             \DWTAGvolatiletype -->
527                 \DWTAGpointertype -->
528                     \DWTAGconsttype -->
529                         \DWTAGbasetype(unsigned char)
530 \end{alltt}
531 \end{dwflisting}
532
533 \condlinenumbers
534 \textit{On the other hand}
535 \par % Needed to end paragraph before listing so that it gets a line number
536 \begin{nlnlisting}                        
537    volatile unsigned char * const restrict p;
538 \end{nlnlisting}
539 \textit{represents a restricted constant
540 pointer to a volatile character. This is encoded as:}
541 \par % Needed to end paragraph before listing so that it gets a line number
542 \nolinenumbers
543 \begin{dwflisting}
544 \begin{alltt}
545         \DWTAGvariable(p) -->
546             \DWTAGrestricttype -->
547                 \DWTAGconsttype -->
548                     \DWTAGpointertype -->
549                         \DWTAGvolatiletype -->
550                             \DWTAGbasetype(unsigned char)
551 \end{alltt}
552 \end{dwflisting}
553
554 \condlinenumbers
555 \section{Typedef Entries}
556 \label{chap:typedefentries}
557 A named type that is defined in terms of another type
558 definition is represented by a debugging information entry with
559 \addtoindexx{typedef entry}
560 the tag \DWTAGtypedefTARG. 
561 The typedef entry has a \DWATname{} attribute 
562 \addtoindexx{name attribute}
563 whose value is a null\dash terminated string containing
564 the name of the typedef.
565
566 The typedef entry may also contain 
567 \addtoindexx{type attribute}
568
569 \DWATtype{} attribute whose
570 value is a \livelink{chap:classreference}{reference} 
571 to the type named by the typedef. If
572 the debugging information entry for a typedef represents
573 a declaration of the type that is not also a definition,
574 it does not contain a type attribute.
575
576 \textit{Depending on the language, a named type that is defined in
577 terms of another type may be called a type alias, a subtype,
578 a constrained type and other terms. A type name declared with
579 no defining details may be termed an 
580 \addtoindexx{incomplete type}
581 incomplete, forward or hidden type. 
582 While the DWARF \DWTAGtypedef{} entry was
583 originally inspired by the like named construct in 
584 \addtoindex{C} and \addtoindex{C++},
585 it is broadly suitable for similar constructs (by whatever
586 source syntax) in other languages.}
587
588 \section{Array Type Entries}
589 \label{chap:arraytypeentries}
590 \label{chap:DWTAGgenericsubrange}
591
592 \textit{Many languages share the concept of an \doublequote{array,} which is
593 \addtoindexx{array type entry}
594 a table of components of identical type.}
595
596 An array type is represented by a debugging information entry
597 with the tag \DWTAGarraytypeTARG. 
598 If a name has been given to
599 \addtoindexx{array!declaration of type}
600 the array type in the source program, then the corresponding
601 array type entry has a \DWATname{} attribute 
602 \addtoindexx{name attribute}
603 whose value is a
604 null-terminated string containing the array type name.
605
606 The\hypertarget{chap:DWATorderingarrayrowcolumnordering}{}
607 array type entry describing a multidimensional array may
608 \addtoindexx{array!element ordering}
609 have a \DWATorderingDEFN{} attribute whose 
610 \livelink{chap:classconstant}{integer constant} value is
611 interpreted to mean either row-major or column-major ordering
612 of array elements. The set of values and their meanings
613 for the ordering attribute are listed in 
614 Table \referfol{tab:arrayordering}. 
615 If no
616 ordering attribute is present, the default ordering for the
617 source language (which is indicated by the 
618 \DWATlanguage{}
619 attribute 
620 \addtoindexx{language attribute}
621 of the enclosing compilation unit entry) is assumed.
622
623 \begin{simplenametable}[1.8in]{Array ordering}{tab:arrayordering}
624 \DWORDcolmajorTARG{} \\
625 \DWORDrowmajorTARG{} \\
626 \end{simplenametable}
627
628 An array type entry has 
629 \addtoindexx{type attribute}
630 a \DWATtype{} attribute
631 describing
632 \addtoindexx{array!element type}
633 the type of each element of the array.
634
635 If the amount of storage allocated to hold each element of an
636 object of the given array type is different from the amount
637 \addtoindexx{stride attribute|see{bit stride attribute or byte stride attribute}}
638 of storage that is normally allocated to hold an individual object
639 of\hypertarget{chap:DWATbitstridearrayelementstrideofarraytype}{}
640 the\hypertarget{chap:DWATbytestridearrayelementstrideofarraytype}{}
641 indicated element type, then the array type entry has either a
642 \addtoindexx{byte stride attribute}
643 \DWATbytestrideDEFN{} 
644 or a
645 \addtoindexx{bit stride attribute}
646 \DWATbitstrideDEFN{}
647 attribute, whose value 
648 (see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
649 is the size of each
650 element of the array.
651
652 The array type entry may have either a \DWATbytesize{} or a
653 \DWATbitsize{} attribute 
654 (see Section \refersec{chap:byteandbitsizes}), 
655 whose value is the
656 amount of storage needed to hold an instance of the array type.
657
658 \textit{If the size of the array can be determined statically at
659 compile time, this value can usually be computed by multiplying
660 the number of array elements by the size of each element.}
661
662
663 Each array dimension is described by a debugging information
664 entry with either the 
665 \addtoindexx{subrange type entry!as array dimension}
666 tag \DWTAGsubrangetype{} or the 
667 \addtoindexx{enumeration type entry!as array dimension}
668 tag
669 \DWTAGenumerationtype. These entries are
670 children of the
671 array type entry and are ordered to reflect the appearance of
672 the dimensions in the source program (that is, leftmost dimension
673 first, next to leftmost second, and so on).
674
675 \textit{In languages that have no concept of a 
676 \doublequote{multidimensional array} (for example, 
677 \addtoindex{C}), an array of arrays may
678 be represented by a debugging information entry for a
679 multidimensional array.}
680
681 Alternatively, for an array with dynamic rank the array dimensions 
682 are described by a debugging information entry with the tag
683 \DWTAGgenericsubrangeTARG.
684 This entry has the same attributes as a
685 \DWTAGsubrangetype{} entry; however,
686 there is just one \DWTAGgenericsubrangeNAME{} entry and it describes all of the
687 dimensions of the array.
688 If \DWTAGgenericsubrangeNAME{}
689 is used, the number of dimensions must be specified using a
690 \DWATrank{} attribute. See also Section
691 \refersec{chap:DWATrank}.
692
693 %\needlines{5}
694 Other attributes especially applicable to arrays are
695 \DWATallocated, 
696 \DWATassociated{} and 
697 \DWATdatalocation,
698 which are described in 
699 Section \refersec{chap:dynamicpropertiesoftypes}. 
700 For relevant examples, see also Appendix \refersec{app:fortranarrayexample}.
701
702 \section{Coarray Type Entries}
703 \label{chap:coarraytypeentries}
704 \addtoindexx{coarray}
705 \textit{In Fortran, a \doublequote{coarray} is an array whose
706 elements are located in different processes rather than in the
707 memory of one process. The individual elements
708 of a coarray can be scalars or arrays.
709 Similar to arrays, coarrays have \doublequote{codimensions} that are 
710 indexed using a \doublequote{coindex} or multiple \doublequote{coindices}.
711 \addtoindexx{codimension|see{coarray}}
712 \addtoindexx{coindex|see{coarray}}
713 }
714
715 A coarray type is represented by a debugging information entry 
716 with the tag \DWTAGcoarraytypeTARG.
717 If a name has been given to the 
718 coarray type in the source, then the corresponding coarray type 
719 entry has a \DWATname{} attribute whose value is a null-terminated 
720 string containing the array type name.
721
722 A coarray entry has one or more \DWTAGsubrangetype{} child entries,
723 one for each codimension. It also has a \DWATtype{} attribute 
724 describing the type of each element of the coarray.
725
726 \textit{In a coarray application, the run-time number of processes in the application
727 is part of the coindex calculation.  It is represented in the Fortran source by
728 a coindex which is declared with a \doublequote{*} as the upper bound.  To express this
729 concept in DWARF, the \DWTAGsubrangetype{} child entry for that index has 
730 only a lower bound and no upper bound.}
731
732 \textit{How coarray elements are located and how coindices are 
733 converted to process specifications is implementation-defined.}
734
735 \needlines{8}
736 \section{Structure, Union, Class and Interface Type Entries}
737 \label{chap:structureunionclassandinterfacetypeentries}
738
739 \textit{The languages 
740 \addtoindex{C}, 
741 \addtoindex{C++}, and 
742 \addtoindex{Pascal}, among others, allow the
743 programmer to define types that are collections of related
744 \addtoindexx{structure type entry}
745 components. 
746 In \addtoindex{C} and \addtoindex{C++}, these collections are called
747 \doublequote{structures.} 
748 In \addtoindex{Pascal}, they are called \doublequote{records.}
749 The components may be of different types. The components are
750 called \doublequote{members} in \addtoindex{C} and 
751 \addtoindex{C++}, and \doublequote{fields} in \addtoindex{Pascal}.}
752
753 \textit{The components of these collections each exist in their
754 own space in computer memory. The components of a \addtoindex{C} or \addtoindex{C++}
755 \doublequote{union} all coexist in the same memory.}
756
757 \textit{\addtoindex{Pascal} and 
758 other languages have a \doublequote{discriminated union,}
759 \addtoindexx{discriminated union|see {variant entry}}
760 also called a \doublequote{variant record.} Here, selection of a
761 number of alternative substructures (\doublequote{variants}) is based
762 on the value of a component that is not part of any of those
763 substructures (the \doublequote{discriminant}).}
764
765 \textit{\addtoindex{C++} and 
766 \addtoindex{Java} have the notion of \doublequote{class,} which is in some
767 ways similar to a structure. A class may have \doublequote{member
768 functions} which are subroutines that are within the scope
769 of a class or structure.}
770
771 \textit{The \addtoindex{C++} notion of 
772 structure is more general than in \addtoindex{C}, being
773 equivalent to a class with minor differences. Accordingly,
774 in the following discussion, statements about 
775 \addtoindex{C++} classes may
776 be understood to apply to \addtoindex{C++} structures as well.}
777
778 \subsection{Structure, Union and Class Type Entries}
779 \label{chap:structureunionandclasstypeentries}
780 Structure, union, and class types are represented by debugging
781 \addtoindexx{structure type entry}
782 information entries 
783 \addtoindexx{union type entry}
784 with 
785 \addtoindexx{class type entry}
786 the tags 
787 \DWTAGstructuretypeTARG,
788 \DWTAGuniontypeTARG, 
789 and \DWTAGclasstypeTARG,
790 respectively. If a name has been given to the structure,
791 union, or class in the source program, then the corresponding
792 structure type, union type, or class type entry has a
793 \DWATname{} attribute 
794 \addtoindexx{name attribute}
795 whose value is a null\dash terminated string
796 containing the type name.
797
798 The members of a structure, union, or class are represented
799 by debugging information entries that are owned by the
800 corresponding structure type, union type, or class type entry
801 and appear in the same order as the corresponding declarations
802 in the source program.
803
804 A structure, union, or class type may have a \DWATexportsymbolsDEFN{}
805 attribute\addtoindexx{export symbols (of structure, class or union) attribute} 
806 \livetarg{chap:DWATexportsymbolsofstructunionclass}{}
807 which indicates that all member names defined within 
808 the structure, union, or class may be referenced as if they were
809 defined within the containing structure, union, or class. 
810
811 \textit{This may be used to describe anonymous structures, unions 
812 and classes in \addtoindex{C} or \addtoindex{C++}}.
813
814 A\hypertarget{chap:DWATbitsizedatamemberbitsize}{} 
815 structure type, union type or class type entry may have
816 either a \DWATbytesize{} or a \DWATbitsize{} attribute 
817 (see Section \refersec{chap:byteandbitsizes}), 
818 whose value is the amount of storage needed
819 to hold an instance of the structure, union or class type,
820 including any padding.
821   
822 An incomplete structure, union or class type 
823 \addtoindexx{incomplete structure/union/class}
824 \addtoindexx{incomplete type}
825 is represented by a structure, union or class
826 entry that does not have a byte size attribute and that has
827 \addtoindexx{declaration attribute}
828 a \DWATdeclaration{} attribute.
829
830 If the complete declaration of a type has been placed 
831 in\hypertarget{chap:DWATsignaturetypesignature}{}
832 a separate \addtoindex{type unit}
833 (see Section \refersec{chap:typeunitentries}), 
834 an incomplete declaration 
835 \addtoindexx{incomplete type}
836 of that type in the compilation unit may provide
837 the unique 8-byte signature of the type using a
838 \addtoindexx{type signature}
839 \DWATsignatureDEFN{} attribute.
840
841 If a structure, union or class entry represents the definition
842 of a structure, union or class member corresponding to a prior
843 incomplete structure, union or class, the entry may have a
844 \DWATspecification{} attribute 
845 \addtoindexx{specification attribute}
846 whose value is a \livelink{chap:classreference}{reference} to
847 the debugging information entry representing that incomplete
848 declaration.
849
850 Structure, union and class entries containing the
851 \DWATspecification{} attribute 
852 \addtoindexx{specification attribute}
853 do not need to duplicate
854 information provided by the declaration entry referenced by the
855 specification attribute.  In particular, such entries do not
856 need to contain an attribute for the name of the structure,
857 union or class they represent if such information is already
858 provided in the declaration.
859
860 \textit{For \addtoindex{C} and \addtoindex{C++}, 
861 data 
862 \addtoindexx{data member|see {member entry (data)}}
863 member declarations occurring within
864 the declaration of a structure, union or class type are
865 considered to be \doublequote{definitions} of those members, with
866 the exception of \doublequote{static} data members, whose definitions
867 appear outside of the declaration of the enclosing structure,
868 union or class type. Function member declarations appearing
869 within a structure, union or class type declaration are
870 definitions only if the body of the function also appears
871 within the type declaration.}
872
873 If the definition for a given member of the structure, union
874 or class does not appear within the body of the declaration,
875 that member also has a debugging information entry describing
876 its definition. That latter entry has a 
877 \DWATspecification{} attribute 
878 \addtoindexx{specification attribute}
879 referencing the debugging information entry
880 owned by the body of the structure, union or class entry and
881 representing a non-defining declaration of the data, function
882 or type member. The referenced entry will not have information
883 about the location of that member (low and high PC attributes
884 for function members, location descriptions for data members)
885 and will have a \DWATdeclaration{} attribute.
886
887 \needlines{5}
888 \textit{Consider a nested class whose 
889 definition occurs outside of the containing class definition, as in:}
890
891 \begin{nlnlisting}
892 struct A {
893     struct B;
894 };
895 struct A::B { ... };
896 \end{nlnlisting}
897
898 \textit{The two different structs can be described in 
899 different compilation units to 
900 facilitate DWARF space compression 
901 (see Appendix \refersec{app:usingcompilationunits}).}
902
903 \needlines{4}
904 A structure type, union type or class type entry may have a
905 \DWATcallingconventionDEFN{} attribute,
906 \addtoindexx{calling convention attribute!for types} 
907 whose value indicates whether a value of the type 
908 is passed by reference 
909 or passed by value. The set of calling convention codes for use with types 
910 \addtoindexx{calling convention codes!for types}
911 is\hypertarget{chap:DWATcallingconventionfortypes}{}
912 given in Table \referfol{tab:callingconventioncodesfortypes}.
913
914 \begin{simplenametable}[2.2in]{Calling convention codes for types}{tab:callingconventioncodesfortypes}
915 \DWCCnormal             \\
916 \DWCCpassbyvalueTARG        \\
917 \DWCCpassbyreferenceTARG    \\
918 \end{simplenametable}
919
920 If this attribute is not present, or its value is
921 \DWCCnormalNAME, the convention to be used for an object of the
922 given type is assumed to be unspecified.
923
924 \textit{Note that \DWCCnormalNAME{} is also used as a calling convention 
925 code for certain subprograms 
926 (see Table \refersec{tab:callingconventioncodesforsubroutines}).}
927
928 \textit{If unspecified, a consumer may be able to deduce the calling
929 convention based on knowledge of the type and the ABI.}
930
931
932 \subsection{Interface Type Entries}
933 \label{chap:interfacetypeentries}
934
935 \textit{The \addtoindex{Java} language defines \doublequote{interface} types. 
936 An interface
937 \addtoindexx{interface type entry}
938 in \addtoindex{Java} is similar to a \addtoindex{C++} or 
939 \addtoindex{Java} class with only abstract
940 methods and constant data members.}
941
942 Interface types 
943 \addtoindexx{interface type entry}
944 are represented by debugging information
945 entries with the 
946 tag \DWTAGinterfacetypeTARG.
947
948 An interface type entry has 
949 a \DWATname{} attribute,
950 \addtoindexx{name attribute}
951 whose value is a null\dash terminated string containing the 
952 type name.
953
954 The members of an interface are represented by debugging
955 information entries that are owned by the interface type
956 entry and that appear in the same order as the corresponding
957 declarations in the source program.
958
959 \subsection{Derived or Extended Structures, Classes and Interfaces}
960 \label{chap:derivedorextendedstructsclasesandinterfaces}
961
962 \textit{In \addtoindex{C++}, a class (or struct) 
963 may 
964 \addtoindexx{derived type (C++)|see{inheritance entry}}
965 be \doublequote{derived from} or be a
966 \doublequote{subclass of} another class. 
967 In \addtoindex{Java}, an interface may \doublequote{extend}
968 \addtoindexx{extended type (Java)|see{inheritance entry}}
969 one 
970 \addtoindexx{implementing type (Java)|see{inheritance entry}}
971 or more other interfaces, and a class may \doublequote{extend} another
972 class and/or \doublequote{implement} one or more interfaces. All of these
973 relationships may be described using the following. Note that
974 in \addtoindex{Java}, 
975 the distinction between extends and implements is
976 implied by the entities at the two ends of the relationship.}
977
978 A class type or interface type entry that describes a
979 derived, extended or implementing class or interface owns
980 \addtoindexx{implementing type (Java)|see{inheritance entry}}
981 debugging information entries describing each of the classes
982 or interfaces it is derived from, extending or implementing,
983 respectively, ordered as they were in the source program. Each
984 such entry has 
985 \addtoindexx{inheritance entry}
986 the 
987 tag \DWTAGinheritanceTARG.
988
989 \needlines{4}
990 An inheritance entry 
991 \addtoindexx{type attribute}
992 has 
993 \addtoindexx{inheritance entry}
994
995 \DWATtype{} attribute whose value is
996 a reference to the debugging information entry describing the
997 class or interface from which the parent class or structure
998 of the inheritance entry is derived, extended or implementing.
999
1000 An\hypertarget{chap:DWATdatamemberlocationinheritedmemberlocation}{} 
1001 inheritance entry\addtoindexx{inheritance entry}
1002 for a class that derives from or extends
1003 another class or struct also has a 
1004 \DWATdatamemberlocationDEFN{} attribute, 
1005 \addtoindexx{data member location attribute}
1006 whose value describes the location of the beginning
1007 of the inherited type relative to the beginning address of the
1008 instance of the derived class. If that value is a constant, it is the offset
1009 in bytes from the beginning of the class to the beginning of
1010 the instance of the inherited type. Otherwise, the value must be a location
1011 description. In this latter case, the beginning address of
1012 the instance of the derived class is pushed on the expression stack before
1013 the \addtoindex{location description}
1014 is evaluated and the result of the
1015 evaluation is the location of the instance of the inherited type.
1016
1017 \textit{The interpretation of the value of this attribute for
1018 inherited types is the same as the interpretation for data
1019 members 
1020 (see Section \referfol{chap:datamemberentries}).  }
1021
1022 An\hypertarget{chap:DWATaccessibilitycppinheritedmembers}{} 
1023 \addtoindexx{inheritance entry}
1024 inheritance entry may have a
1025 \hyperlink{chap:DWATaccessibilityattribute}{\DWATaccessibilityNAME}
1026 attribute.\addtoindexx{accessibility attribute}
1027 If no accessibility attribute is present, private access 
1028 is assumed for an entry of a class and public access is 
1029 assumed for an entry of a struct, union or interface.
1030
1031 If the class referenced by the \addtoindex{inheritance entry}
1032 serves as a \addtoindex{C++} virtual base class, the 
1033 inheritance entry has a 
1034 \hyperlink{chap:DWATvirtualityvirtualityindication}{\DWATvirtualityNAME} 
1035 attribute.
1036
1037 \textit{For a \addtoindex{C++} virtual base, the 
1038 \addtoindex{data member location attribute}
1039 will usually consist of a non-trivial 
1040 \addtoindex{location description}.}
1041
1042 \subsection{Access Declarations}
1043 \label{chap:accessdeclarations}
1044
1045 \textit{In \addtoindex{C++}, a derived class may contain access declarations that
1046 change the accessibility of individual class members from the
1047 overall accessibility specified by the inheritance declaration.
1048 A single access declaration may refer to a set of overloaded
1049 names.}
1050
1051 If a derived class or structure contains access declarations,
1052 each such declaration may be represented by a debugging
1053 information entry with the tag \DWTAGaccessdeclarationTARG.
1054 \addtoindexx{access declaration entry}
1055 Each such entry is a child of the class or structure type entry.
1056
1057 An access declaration entry has a \DWATname{} attribute, 
1058 whose value is a null-terminated string representing the name 
1059 used in the declaration,
1060 including any class or structure qualifiers.
1061
1062 An\hypertarget{chap:DWATaccessdeclaration}{} 
1063 access declaration entry also has a
1064 \hyperlink{chap:DWATaccessibilityattribute}{\DWATaccessibilityNAME}
1065 \addtoindexx{accessibility attribute}
1066 attribute describing the declared accessibility of the named entities.
1067
1068
1069 \needlines{6}
1070 \subsection{Friends}
1071 \label{chap:friends}
1072
1073 Each\hypertarget{chap:DWATfriendfriendrelationship}{} 
1074 friend\addtoindexx{friend entry}
1075 declared by a structure, union or class
1076 type may be represented by a debugging information entry
1077 that is a child of the structure, union or class type entry;
1078 the friend entry has the tag \DWTAGfriendTARG.
1079
1080 A friend entry has a \DWATfriendDEFN{} attribute,
1081 \addtoindexx{friend attribute} whose value is
1082 a reference to the debugging information entry describing
1083 the declaration of the friend.
1084
1085
1086 \subsection{Data Member Entries}
1087 \label{chap:datamemberentries}
1088
1089 A data member (as opposed to a member function) is
1090 represented by a debugging information entry with the 
1091 tag \DWTAGmemberTARG. 
1092 The 
1093 \addtoindexx{member entry (data)}
1094 member entry for a named member has
1095 a \DWATname{} attribute 
1096 \addtoindexx{name attribute}
1097 whose value is a null\dash terminated
1098 string containing the member name.
1099 If the member entry describes an 
1100 \addtoindex{anonymous union},
1101 the name attribute is omitted or the value of the attribute
1102 consists of a single zero byte.
1103
1104 The data member entry has a 
1105 \DWATtype{} attribute\addtoindexx{type attribute} to denote
1106 \addtoindexx{member entry (data)} the type of that member.
1107
1108 A data member entry may have a 
1109 \hyperlink{chap:DWATaccessibilityattribute}{\DWATaccessibilityNAME}
1110 attribute.\addtoindexx{accessibility attribute} 
1111 If no accessibility attribute is present, private
1112 access is assumed for an member of a class and public access
1113 is assumed for an member of a structure, union, or interface.
1114
1115 A\hypertarget{chap:DWATmutablemutablepropertyofmemberdata}{}
1116 data member entry \addtoindexx{member entry (data)}
1117 may have a 
1118 \addtoindexx{mutable attribute}
1119 \DWATmutableDEFN{} attribute,
1120 which is a \livelink{chap:classflag}{flag}. 
1121 This attribute indicates whether the data
1122 member was declared with the mutable storage class specifier.
1123
1124 The beginning of a data member 
1125 \addtoindexx{beginning of a data member} 
1126 is described relative to
1127 \addtoindexx{beginning of an object}
1128 the beginning of the object in which it is immediately
1129 contained. In general, the beginning is characterized by
1130 both an address and a bit offset within the byte at that
1131 address. When the storage for an entity includes all of
1132 the bits in the beginning byte, the beginning bit offset is
1133 defined to be zero.
1134
1135 The\hypertarget{chap:DWATdatabitoffsetdatamemberbitlocation}{}
1136 member\hypertarget{chap:DWATdatamemberlocationdatamemberlocation}{} 
1137 entry \addtoindexx{member entry (data)}
1138 corresponding to a data member that is defined
1139 in a structure, union or class may have either a 
1140 \DWATdatamemberlocationDEFN{} attribute
1141 \addtoindexx{data member location attribute}
1142 or a \DWATdatabitoffsetDEFN{} attribute. 
1143 \addtoindexx{data bit offset attribute}
1144 If the beginning of the data member is the same as
1145 the beginning of the containing entity then neither attribute
1146 is required.
1147
1148 \needlines{4}
1149 For a \DWATdatamemberlocation{} attribute
1150 \addtoindexx{data member location attribute}
1151 there are two cases:
1152 \begin{enumerate}[1. ]
1153 \item If the value is an 
1154 \livelink{chap:classconstant}{integer constant}, 
1155 it is the offset
1156 in bytes from the beginning of the containing entity. If
1157 the beginning of the containing entity has a non-zero bit
1158 offset then the beginning of the member entry has that same
1159 bit offset as well.
1160
1161 \item Otherwise, the value must be a \addtoindex{location description}.
1162 In
1163 this case, the beginning of the containing entity must be byte
1164 aligned. The beginning address is pushed on the DWARF stack
1165 before the \addtoindex{location} description is evaluated; the result of
1166 the evaluation is the base address of the member entry.
1167
1168 \textit{The push on the DWARF expression stack of the base address of
1169 the containing construct is equivalent to execution of the
1170 \DWOPpushobjectaddress{} operation 
1171 (see Section \refersec{chap:stackoperations});
1172 \DWOPpushobjectaddress{} therefore 
1173 is not needed at the
1174 beginning of a \addtoindex{location description} for a data member. 
1175 The
1176 result of the evaluation is a location---either an address or
1177 the name of a register, not an offset to the member.}
1178
1179 \textit{A \DWATdatamemberlocation{} 
1180 attribute 
1181 \addtoindexx{data member location attribute}
1182 that has the form of a
1183 \addtoindex{location description} is not valid for a data member contained
1184 in an entity that is not byte aligned because DWARF operations
1185 do not allow for manipulating or computing bit offsets.}
1186
1187 \end{enumerate}
1188
1189 \needlines{4}
1190 For a \DWATdatabitoffset{} attribute, 
1191 the value is an \livelink{chap:classconstant}{integer constant} 
1192 (see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
1193 that specifies the number of bits
1194 from the beginning of the containing entity to the beginning
1195 of the data member. This value must be greater than or equal
1196 to zero, but is not limited to less than the number of bits
1197 per byte.
1198
1199 If the size of a data member is not the same as the size
1200 of the type given for the data member, the data member has
1201 either a \DWATbytesize\addtoindexx{byte size attribute} 
1202 or a \DWATbitsize{} attribute\addtoindexx{bit size attribute} whose
1203 \livelink{chap:classconstant}{integer constant} value 
1204 (see Section \refersec{chap:staticanddynamicvaluesofattributes}) 
1205 is the amount
1206 of storage needed to hold the value of the data member.
1207
1208 \textit{For showing nested and packed records and arrays, 
1209 see Appendix \refersec{app:pascalexample} and 
1210 \refersec{app:ccppbitfieldexamples}.}
1211
1212
1213 \subsection{Member Function Entries}
1214 \label{chap:memberfunctionentries}
1215
1216 A member function is represented by a 
1217 \addtoindexx{member function entry}
1218 debugging information entry 
1219 with the 
1220 \addtoindexx{subprogram entry!as member function}
1221 tag \DWTAGsubprogram.
1222 The member function entry
1223 may contain the same attributes and follows the same rules
1224 as non-member global subroutine entries 
1225 (see Section \refersec{chap:subroutineandentrypointentries}).
1226
1227 \needlines{4}
1228 \textit{In particular, if the member function entry is an
1229 instantiation of a member function template, it follows the 
1230 same rules as function template instantiations (see Section 
1231 \refersec{chap:functiontemplateinstantiations}).
1232 }
1233
1234 A member function entry may have a 
1235 \hyperlink{chap:DWATaccessibilityattribute}{\DWATaccessibilityNAME}
1236 \addtoindexx{accessibility attribute}
1237 attribute. If no accessibility attribute is present, private
1238 access is assumed for an entry of a class and public access
1239 is assumed for an entry of a structure, union or interface.
1240
1241 If the member function entry describes a virtual function,
1242 then that entry has a
1243 \hyperlink{chap:DWATvirtualityvirtualityindication}{\DWATvirtualityNAME} 
1244 attribute.
1245
1246 If\hypertarget{chap:DWATexplicitexplicitpropertyofmemberfunction}{}
1247 the member function entry describes an explicit member
1248 function, then that entry has a
1249 \addtoindexx{explicit attribute}
1250 \DWATexplicitDEFN{} attribute.
1251
1252 An\hypertarget{chap:DWATvtableelemlocationvirtualfunctiontablevtableslot}{}
1253 entry for a virtual function also has a
1254 \DWATvtableelemlocationDEFN{}
1255 \addtoindexi{attribute}{vtable element location attribute} whose value contains
1256 a \addtoindex{location description} 
1257 yielding the address of the slot
1258 for the function within the virtual function table for the
1259 enclosing class. The address of an object of the enclosing
1260 type is pushed onto the expression stack before the location
1261 description is evaluated.
1262
1263 If\hypertarget{chap:DWATobjectpointerobjectthisselfpointerofmemberfunction}{}
1264 the member function entry describes a non-static member
1265 \addtoindexx{this pointer attribute|see{object pointer attribute}}
1266 function, then that entry 
1267 \addtoindexx{self pointer attribute|see{object pointer attribute}}
1268 has 
1269 \addtoindexx{object pointer attribute}
1270 a \DWATobjectpointerDEFN{} attribute
1271 whose value is a \livelink{chap:classreference}{reference} 
1272 to the formal parameter entry
1273 that corresponds to the object for which the function is
1274 called. The name attribute of that formal parameter is defined
1275 by the current language (for example, 
1276 \texttt{this} for \addtoindex{C++} or \texttt{self}
1277 for \addtoindex{Objective C} 
1278 and some other languages). That parameter
1279 also has a \DWATartificial{} attribute whose value is true.
1280
1281 Conversely, if the member function entry describes a static
1282 member function, the entry does not have a
1283 \addtoindexx{object pointer attribute}
1284 \DWATobjectpointer{} attribute.
1285
1286 \textit{In \addtoindex{C++}, non-static member functions can have const-volatile
1287 qualifiers, which affect the type of the first formal parameter (the
1288 \doublequote{\texttt{this}}-pointer).}
1289  
1290 If the member function entry describes a non-static member
1291 function that has a const\dash volatile qualification, then
1292 the entry describes a non-static member function whose
1293 object formal parameter has a type that has an equivalent
1294 const-volatile qualification.
1295
1296 \textit{Beginning in \addtoindex{C++11}, non-static member 
1297 functions can also have one of the ref-qualifiers, \& and \&\&. 
1298 These do not change the type of the
1299 \doublequote{\texttt{this}}-pointer, but they do affect the types of 
1300 object values on which the function can be invoked.}
1301
1302 \needlines{6}
1303 The member function entry may have an \DWATreferenceDEFN{} attribute
1304 \livetarg{chap:DWATreferenceofnonstaticmember}{}
1305 to indicate a non-static member function that can only be called on
1306 lvalue objects, or the \DWATrvaluereferenceDEFN{} attribute 
1307 \livetarg{chap:DWATrvaluereferenceofnonstaticmember}{}
1308 to indicate that it can only be called on prvalues and xvalues.
1309
1310 \textit{The lvalue, prvalue and xvalue concepts are defined in the
1311 \addtoindex{C++11} and later standards.}
1312
1313 If a subroutine entry represents the defining declaration
1314 of a member function and that definition appears outside of
1315 the body of the enclosing class declaration, the subroutine
1316 entry has a 
1317 \DWATspecification{} attribute, 
1318 \addtoindexx{specification attribute}
1319 whose value is
1320 a reference to the debugging information entry representing
1321 the declaration of this function member. The referenced entry
1322 will be a child of some class (or structure) type entry.
1323
1324 \needlines{6}
1325 Subroutine entries containing the
1326 \DWATspecification{} attribute 
1327 \addtoindexx{specification attribute}
1328 do not need to duplicate information provided
1329 by the declaration entry referenced by the specification
1330 attribute. In particular, such entries do not need to contain
1331 a name attribute giving the name of the function member whose 
1332 definition they represent.  
1333 Similarly, such entries do not need to contain a return type 
1334 attribute, unless the return type on the declaration was 
1335 unspecified (for example, the declaration used the 
1336 \addtoindex{C++} \autoreturntype{} specifier).
1337
1338 \textit{In \addtoindex{C++}, a member function may be declared 
1339 as deleted. This prevents the compiler from generating a default
1340 implementation of a special member function such as a
1341 constructor or destructor, and can affect overload resolution
1342 when used on other member functions.}
1343
1344 If the member function entry has been declared as deleted,
1345 then that entry has a \DWATdeletedDEFN{}\livetarg{chap:DWATdeleteddef}{}
1346 attribute.\addtoindexx{deleted attribute}
1347
1348 \textit{In \addtoindex{C++}, a special member function may be 
1349 declared as defaulted, which explicitly declares a default
1350 compiler-generated implementation of the function. The
1351 declaration may have different effects on the calling
1352 convention used for objects of its class, depending on
1353 whether the default declaration is made inside or outside the
1354 class.}
1355
1356 If the member function has been declared as defaulted, 
1357 then the entry has a \DWATdefaultedDEFN{}\livetarg{chap:DWATdefaulteddef}{}
1358 attribute\addtoindexx{defaulted attribute}
1359 whose integer constant value indicates whether, and if so,
1360 how, that member is defaulted. The possible values and
1361 their meanings are shown in 
1362 Table \referfol{tab:defaultedattributevaluenames}.
1363
1364 \needlines{8}
1365 \begin{centering}
1366   \setlength{\extrarowheight}{0.1cm}
1367 \begin{longtable}{l|l}
1368   \caption{Defaulted attribute names} \label{tab:defaultedattributevaluenames} \\
1369   \hline \bfseries Defaulted attribute name & \bfseries Meaning \\ \hline
1370 \endfirsthead
1371   \bfseries Defaulted attribute name & \bfseries Meaning \\ \hline
1372 \endhead
1373   \hline \emph{Continued on next page}
1374 \endfoot
1375 \endlastfoot
1376 \DWDEFAULTEDnoTARG        & Not declared default \\
1377 \DWDEFAULTEDinclassTARG   & Defaulted within the class \\
1378 \DWDEFAULTEDoutofclassTARG& Defaulted outside of the class \\
1379 \hline
1380 \end{longtable}
1381 \end{centering}
1382
1383 \textit{An artificial member function (that is, a compiler-generated
1384 copy that does not appear in the source) does not have a
1385 \DWATdefaultedNAME{} attribute.}
1386
1387 \needlines{5}
1388 \subsection{Class Template Instantiations}
1389 \label{chap:classtemplateinstantiations}
1390
1391 \textit{In \addtoindex{C++} a class template is a generic definition of a class
1392 type that may be instantiated when an instance of the class
1393 is declared or defined. The generic description of the class may include
1394 parameterized types, parameterized compile-time constant
1395 values, and/or parameterized run-time constant addresses. 
1396 DWARF does not represent the generic template
1397 definition, but does represent each instantiation.}
1398
1399 A class template instantiation is represented by a
1400 debugging information entry with the tag \DWTAGclasstype,
1401 \DWTAGstructuretype{} or 
1402 \DWTAGuniontype. With the following
1403 exceptions, such an entry will contain the same attributes
1404 and have the same types of child entries as would an entry
1405 for a class type defined explicitly using the instantiation
1406 types and values. The exceptions are:
1407
1408 \begin{enumerate}[1. ]
1409 \item Template parameters are described and referenced as
1410 specified in Section \refersec{chap:templateparameters}.
1411
1412 %\needlines{4}
1413 \item If the compiler has generated a special compilation unit to
1414 hold the 
1415 \addtoindexx{template instantiation!and special compilation unit}
1416 template instantiation and that special compilation
1417 unit has a different name from the compilation unit containing
1418 the template definition, the name attribute for the debugging
1419 information entry representing the special compilation unit
1420 is empty or omitted.
1421
1422 %\needlines{4}
1423 \item If the class type entry representing the template
1424 instantiation or any of its child entries contains declaration
1425 coordinate attributes, those attributes refer to
1426 the source for the template definition, not to any source
1427 generated artificially by the compiler.
1428 \end{enumerate}
1429
1430 \needlines{4}
1431 \subsection{Variant Entries}
1432 \label{chap:variantentries}
1433
1434 A variant part of a structure is represented by a debugging
1435 information entry\addtoindexx{variant part entry} with the 
1436 tag \DWTAGvariantpartTARG{} and is
1437 owned by the corresponding structure type entry.
1438
1439 If the variant part has a discriminant, the discriminant 
1440 is\hypertarget{chap:DWATdiscrdiscriminantofvariantpart}{}
1441 represented by a \addtoindexx{discriminant (entry)}
1442 separate debugging information entry which
1443 is a child of the variant part entry. This entry has the form
1444 of a \addtoindexx{member entry (data)!as discriminant}
1445 structure data member entry. The variant part entry will
1446 have a 
1447 \DWATdiscrDEFN{} attribute \addtoindexx{discriminant attribute}
1448 whose value is a \livelink{chap:classreference}{reference} to
1449 the member entry for the discriminant.
1450
1451 If the variant part does not have a discriminant (tag field),
1452 the variant part entry has \addtoindexx{type attribute}
1453 a \DWATtype{} attribute to represent
1454 the tag type.
1455
1456 Each variant of a particular variant part is represented 
1457 by\hypertarget{chap:DWATdiscrvaluediscriminantvalue}{}
1458 a debugging information entry\addtoindexx{variant entry} with the 
1459 tag \DWTAGvariantTARG{}
1460 and is a child of the variant part entry. The value that
1461 selects a given variant may be represented in one of three
1462 ways. The variant entry may have a \DWATdiscrvalueDEFN{} 
1463 attribute\addtoindexx{discriminant value attribute}
1464 whose value represents the discriminant value selecting 
1465 this variant. The value of this
1466 attribute is encoded as an LEB128 number. The number is signed
1467 if the tag type for the variant part containing this variant
1468 is a signed type. The number is unsigned if the tag type is
1469 an unsigned type.
1470
1471 \needlines{5}
1472 Alternatively,\hypertarget{chap:DWATdiscrlistlistofdiscriminantvalues}{}
1473 the variant entry may contain a
1474 \addtoindexx{discriminant list attribute}
1475 \DWATdiscrlistDEFN{}
1476 attribute, whose value represents a list of discriminant
1477 values. This list is represented by any of the 
1478 \livelink{chap:classblock}{block} forms and may contain a 
1479 mixture of discriminant values and discriminant ranges. 
1480 Each item on the list is prefixed with a discriminant value
1481 descriptor that determines whether the list item represents
1482 a single label or a label range. A single case label is
1483 represented as an LEB128 number as defined above for the
1484 \addtoindexx{discriminant value attribute}
1485 \DWATdiscrvalue{} 
1486 attribute. A label range is represented by
1487 two LEB128 numbers, the low value of the range followed by the
1488 high value. Both values follow the rules for signedness just
1489 described. The discriminant value descriptor is an integer
1490 constant that may have one of the values given in 
1491 Table \refersec{tab:discriminantdescriptorvalues}.
1492
1493 \begin{simplenametable}[1.4in]{Discriminant descriptor values}{tab:discriminantdescriptorvalues}
1494 \DWDSClabelTARG{} \\
1495 \DWDSCrangeTARG{} \\
1496 \end{simplenametable}
1497
1498 \needlines{4}
1499 If a variant entry has neither a \DWATdiscrvalue{}
1500 attribute nor a \DWATdiscrlist{} attribute, or if it has
1501 a \DWATdiscrlist{} attribute with 0 size, the variant is a
1502 default variant.
1503
1504 The components selected by a particular variant are represented
1505 by debugging information entries owned by the corresponding
1506 variant entry and appear in the same order as the corresponding
1507 declarations in the source program.
1508
1509 \needlines{6}
1510 \section{Condition Entries}
1511 \label{chap:conditionentries}
1512
1513 \textit{COBOL has the notion of 
1514 \addtoindexx{level-88 condition, COBOL}
1515 a \doublequote{level\dash 88 condition} that
1516 associates a data item, called the conditional variable, with
1517 a set of one or more constant values and/or value ranges.
1518 % Note: the {} after \textquoteright (twice) is necessary to assure a following space separator
1519 Semantically, the condition is \textquoteleft true\textquoteright{}
1520 if the conditional
1521 variable's value matches any of the described constants,
1522 and the condition is \textquoteleft false\textquoteright{} otherwise.}
1523
1524 The \DWTAGconditionTARG{}
1525 debugging information entry\addtoindexx{condition entry}
1526 describes a
1527 logical condition that tests whether a given data item\textquoteright s
1528 value matches one of a set of constant values. If a name
1529 has been given to the condition, the condition entry has a
1530 \DWATname{} attribute
1531 \addtoindexx{name attribute}
1532 whose value is a null\dash terminated string
1533 giving the condition name.
1534
1535 \needlines{4}
1536 The condition entry's parent entry describes the conditional
1537 variable; normally this will be a \DWTAGvariable,
1538 \DWTAGmember{} or 
1539 \DWTAGformalparameter{} entry.
1540 If 
1541 \addtoindexx{formal parameter entry}
1542 the parent
1543 entry has an array type, the condition can test any individual
1544 element, but not the array as a whole. The condition entry
1545 implicitly specifies a \doublequote{comparison type} that is the
1546 type of an array element if the parent has an array type;
1547 otherwise it is the type of the parent entry.
1548
1549 %\needlines{4}
1550 The condition entry owns \DWTAGconstant{} and/or
1551 \DWTAGsubrangetype{} entries that describe the constant
1552 values associated with the condition. If any child entry 
1553 \addtoindexx{type attribute}
1554 has a \DWATtype{} attribute, that attribute describes
1555 a type compatible with the comparison type (according to the 
1556 source language); otherwise the child\textquoteright{}s type 
1557 is the same as the comparison type.
1558
1559 \textit{For conditional variables with alphanumeric types, COBOL
1560 permits a source program to provide ranges of alphanumeric
1561 constants in the condition. Normally a subrange type entry
1562 does not describe ranges of strings; however, this can be
1563 represented using bounds attributes that are references to
1564 constant entries describing strings. A subrange type entry may
1565 refer to constant entries that are siblings of the subrange
1566 type entry.}
1567
1568
1569 \section{Enumeration Type Entries}
1570 \label{chap:enumerationtypeentries}
1571
1572 \textit{An \doublequote{enumeration type} is a scalar that can assume one of
1573 a fixed number of symbolic values.}
1574
1575 An enumeration type is represented by a debugging information
1576 entry with the tag 
1577 \DWTAGenumerationtypeTARG.
1578
1579 If a name has been given to the enumeration type in the source
1580 program, then the corresponding enumeration type entry has
1581 a \DWATname{} attribute
1582 \addtoindexx{name attribute}
1583 whose value is a null\dash terminated
1584 string containing the enumeration type name.
1585
1586 The \addtoindex{enumeration type entry}
1587 may have 
1588 \addtoindexx{type attribute}
1589 a \DWATtype{} attribute
1590 which refers to the underlying data type used to implement
1591 the enumeration. The entry also may have a
1592 \DWATbytesize{} attribute or 
1593 \DWATbitsize{}
1594 attribute, whose value 
1595 (see Section \refersec{chap:byteandbitsizes}) 
1596 is the amount of storage 
1597 required to hold an instance of the enumeration. If no 
1598 \DWATbytesize{} or \DWATbitsize{}
1599 attribute is present, the size for holding an instance of the 
1600 enumeration is given by the size of the underlying data type.
1601
1602 \needlines{4}
1603 If an enumeration type has type safe 
1604 \addtoindexx{type safe enumeration types}
1605 semantics such that
1606
1607 \begin{enumerate}[1. ]
1608 \item Enumerators are contained in the scope of the enumeration type, and/or
1609
1610 \item Enumerators are not implicitly converted to another type
1611 \end{enumerate}
1612
1613 then the \addtoindex{enumeration type entry} may 
1614 \addtoindexx{enum class|see{type-safe enumeration}}
1615 have a \DWATenumclassDEFN{}
1616 attribute, which is a \livelink{chap:classflag}{flag}. 
1617 In a language that offers only
1618 one kind of enumeration declaration, this attribute is not
1619 required.
1620
1621 \textit{In \addtoindex{C} or \addtoindex{C++}, 
1622 the underlying type will be the appropriate
1623 integral type determined by the compiler from the properties 
1624 of\hypertarget{chap:DWATenumclasstypesafeenumerationdefinition}{}
1625 the enumeration literal values. 
1626 A \addtoindex{C++} type declaration written
1627 using enum class declares a strongly typed enumeration and
1628 is represented using \DWTAGenumerationtype{} 
1629 in combination with \DWATenumclass.}
1630
1631 Each enumeration literal is represented by a debugging
1632 \addtoindexx{enumeration literal|see{enumeration entry}}
1633 information entry with the 
1634 tag \DWTAGenumeratorTARG. 
1635 Each
1636 such entry is a child of the 
1637 \addtoindex{enumeration type entry}, and the
1638 enumerator entries appear in the same order as the declarations
1639 of the enumeration literals in the source program.
1640
1641 \needlines{4}
1642 Each \addtoindex{enumerator entry} has a \DWATname{} attribute, whose
1643 \addtoindexx{name attribute}
1644 value is a null-terminated string containing the name of 
1645 the\hypertarget{chap:DWATconstvalueenumerationliteralvalue}{}
1646 enumeration literal.
1647 Each enumerator entry also has a 
1648 \DWATconstvalueDEFN{} attribute,
1649 \addtoindexx{constant value attribute}
1650 whose value is the actual numeric value of the enumerator as
1651 represented on the target system.
1652
1653 \needlines{4}
1654 If the enumeration type occurs as the description of a
1655 \addtoindexx{enumeration type entry!as array dimension}
1656 dimension of an array type, and the stride for that 
1657 dimension\hypertarget{chap:DWATbytestrideenumerationstridedimensionofarraytype}{}
1658 is different than what would otherwise be determined, 
1659 then\hypertarget{chap:DWATbitstrideenumerationstridedimensionofarraytype}{}
1660 the enumeration type entry has either a
1661 \addtoindexx{byte stride attribute} 
1662 \DWATbytestrideDEFN{} or
1663 \addtoindexx{bit stride attribute}
1664 \DWATbitstrideDEFN{} attribute which specifies the separation
1665 between successive elements along the dimension as described
1666 in Section \refersec{chap:staticanddynamicvaluesofattributes}. 
1667 The value of the \DWATbitstride{} attribute
1668 is interpreted as bits and 
1669 the value of the \DWATbytestride{} attribute is interpreted 
1670 as bytes.
1671
1672
1673 \section{Subroutine Type Entries}
1674 \label{chap:subroutinetypeentries}
1675
1676 \textit{It is possible in \addtoindex{C}
1677 to declare pointers to subroutines
1678 that return a value of a specific type. In both 
1679 \addtoindex{C} and \addtoindex{C++},
1680 it is possible to declare pointers to subroutines that not
1681 only return a value of a specific type, but accept only
1682 arguments of specific types. The type of such pointers would
1683 be described with a \doublequote{pointer to} modifier applied to a
1684 user\dash defined type.}
1685
1686 \needlines{4}
1687 A subroutine type is represented by a debugging information
1688 entry with the 
1689 \addtoindexx{subroutine type entry}
1690 tag \DWTAGsubroutinetypeTARG. 
1691 If a name has
1692 been given to the subroutine type in the source program,
1693 then the corresponding subroutine type entry has 
1694 a \DWATname{} attribute 
1695 \addtoindexx{name attribute}
1696 whose value is a null\dash terminated string containing
1697 the subroutine type name.
1698
1699 If the subroutine type describes a function that returns
1700 a value, then the subroutine type entry has a
1701 \addtoindexx{type attribute}
1702 \DWATtype{}
1703 attribute to denote the type returned by the subroutine. If
1704 the types of the arguments are necessary to describe the
1705 subroutine type, then the corresponding subroutine type
1706 entry owns debugging information entries that describe the
1707 arguments. These debugging information entries appear in the
1708 order that the corresponding argument types appear in the
1709 source program.
1710
1711 \textit{In \addtoindex{C} there 
1712 is a difference between the types of functions
1713 declared using function prototype style declarations and
1714 those declared using non-prototype declarations.}
1715
1716
1717 \hypertarget{chap:DWATprototypedsubroutineprototype}{}
1718 subroutine entry declared with a function prototype style
1719 declaration may have 
1720 \addtoindexx{prototyped attribute}
1721
1722 \DWATprototypedDEFN{} attribute, which is
1723 a \livelink{chap:classflag}{flag}.
1724
1725 \needlines{4}
1726 Each debugging information entry owned by a subroutine
1727 type entry corresponds to either a formal parameter or the sequence of
1728 unspecified parameters of the subprogram type:
1729
1730 \begin{enumerate}[1. ]
1731 \item A formal parameter of a parameter list (that has a
1732 specific type) is represented by a debugging information entry
1733 with the tag \DWTAGformalparameter. 
1734 Each formal parameter
1735 entry has 
1736 \addtoindexx{type attribute}
1737 a \DWATtype{} attribute that refers to the type of
1738 the formal parameter.
1739
1740 \item The unspecified parameters of a variable parameter list
1741 \addtoindexx{unspecified parameters entry}
1742 are 
1743 \addtoindexx{\texttt{...} parameters|see{unspecified parameters entry}}
1744 represented by a debugging information entry with the
1745 tag \DWTAGunspecifiedparameters.
1746 \end{enumerate}
1747
1748 \textit{\addtoindex{C++} const-volatile qualifiers are encoded as 
1749 part of the type of the \doublequote{\texttt{this}}-pointer.
1750 \addtoindex{C++11} reference and rvalue-reference qualifiers are 
1751 encoded using the \DWATreference{} and \DWATrvaluereference{} attributes, 
1752 respectively. 
1753 See also Section \refersec{chap:memberfunctionentries}.}
1754
1755 \needlines{4}
1756 A subroutine type entry may have the \DWATreference{} or
1757 \DWATrvaluereference{} attribute to indicate that it describes the
1758 type of a member function with reference or rvalue-reference 
1759 semantics, respectively.
1760
1761 \needlines{6}
1762 \section{String Type Entries}
1763 \label{chap:stringtypeentries}
1764
1765 \textit{A \doublequote{string} is a sequence of characters that have specific
1766 \addtoindexx{string type entry}
1767 semantics and operations that distinguish them from arrays of
1768 characters. 
1769 \addtoindex{Fortran} is one of the languages that has a string
1770 type. Note that \doublequote{string} in this context refers to a target
1771 machine concept, not the class string as used in this document
1772 (except for the name attribute).}
1773
1774 A string type is represented by a debugging information entry
1775 with the tag \DWTAGstringtypeTARG. 
1776 If a name has been given to
1777 the string type in the source program, then the corresponding
1778 string type entry has a 
1779 \DWATname{} attribute
1780 \addtoindexx{name attribute}
1781 whose value is a null-terminated string containing the string type name.
1782
1783 A string type entry may have a \DWATtypeDEFN{} 
1784 \livetargi{chap:DWAATtypeofstringtype}{attribute}{type attribute!of string type entry}
1785 describing how each character is encoded and is to be interpreted.  
1786 The value of this attribute is a \CLASSreference{} to a 
1787 \DWTAGbasetype{} base type entry.  If the attribute is absent, 
1788 then the character is encoded using the system default.
1789
1790 \textit{The 
1791 \addtoindex{Fortran 2003} language standard allows string 
1792 types that are composed of different types of (same sized) characters. 
1793 While there is no standard list of character kinds, the kinds
1794 \texttt{ASCII}\index{ASCII@\texttt{ASCII} (Fortran string kind)} (see \DWATEASCII), 
1795 \texttt{ISO\_10646}\index{ISO\_10646@\texttt{ISO\_10646} (Fortran string kind)}
1796 \addtoindexx{ISO 10646 character set standard}
1797 (see \DWATEUCS) and 
1798 \texttt{DEFAULT}\index{DEFAULT@\texttt{DEFAULT} (Fortran string kind)}
1799 are defined.}
1800
1801 \needlines{4}
1802 The string type entry may have a 
1803 \DWATbytesize{} attribute or 
1804 \DWATbitsize{}
1805 attribute, whose value 
1806 (see Section \refersec{chap:byteandbitsizes}) 
1807 is the amount of
1808 storage needed to hold a value of the string type.
1809
1810 The\hypertarget{chap:DWATstringlengthstringlengthofstringtype}{}
1811 string type entry may also have a 
1812 \DWATstringlengthDEFN{} attribute\addtoindexx{string length attribute}
1813 whose value is 
1814 \bb
1815 either a \livelink{chap:classreference}{reference}
1816 (see Section \ref{chap:staticanddynamicvaluesofattributes})
1817 yielding the length of the string
1818 or a \addtoindex{location description} yielding the location
1819 \eb
1820 where the length of the string is stored in the program.
1821 If the \DWATstringlengthNAME{} attribute is not present, the size
1822 of the string is assumed to be the amount of storage that is
1823 allocated for the string (as specified by the \DWATbytesize{}
1824 or \DWATbitsize{} attribute).
1825
1826 The string type entry may also have a 
1827 \DWATstringlengthbytesizeDEFN{} or
1828 \DWATstringlengthbitsizeDEFN{} attribute,
1829 \addtoindexx{string length size attribute}
1830 \addtoindexx{string length attribute!size of length data}
1831 whose value (see Section \refersec{chap:byteandbitsizes}) 
1832 is the size of the data to be retrieved from the location
1833 referenced by the \DWATstringlength{} attribute. If no byte or bit
1834 size attribute is present, the size of the data to be retrieved
1835 is the same as the 
1836 \addtoindex{size of an address} on the target machine.
1837
1838 \needlines{8}
1839 \addtoindexx{DWARF Version 5}   % Avoid italics
1840 \textit{Prior to DWARF Version 5, the meaning of a 
1841 \DWATbytesize{} attribute depended on the presence of the
1842 \DWATstringlength{} attribute:
1843 \begin{itemize}
1844 \item If \DWATstringlength{} was present, \DWATbytesize{} 
1845         specified the size of the length data to be retrieved 
1846         from the location specified by the \DWATstringlength{} attribute.
1847 \item If \DWATstringlength{} was not present, \DWATbytesize{}
1848         specified the amount of storage allocated for objects
1849         of the string type.
1850 \end{itemize}
1851 In \DWARFVersionV{}, \DWATbytesize{} always specifies the amount of storage 
1852 allocated for objects of the string type.}
1853
1854 \needlines{6}
1855 \section{Set Type Entries}
1856 \label{chap:settypeentries}
1857
1858 \textit{\addtoindex{Pascal} provides the concept of a \doublequote{set,} which represents
1859 a group of values of ordinal type.}
1860
1861 A set is represented by a debugging information entry with
1862 the tag \DWTAGsettypeTARG. 
1863 \addtoindexx{set type entry}
1864 If a name has been given to the
1865 set type, then the set type entry has 
1866 a \DWATname{} attribute
1867 \addtoindexx{name attribute}
1868 whose value is a null\dash terminated string containing the
1869 set type name.
1870
1871 The set type entry has a
1872 \addtoindexx{type attribute}
1873 \DWATtype{} attribute to denote the
1874 type of an element of the set.
1875
1876 \needlines{4}
1877 If the amount of storage allocated to hold each element of an
1878 object of the given set type is different from the amount of
1879 storage that is normally allocated to hold an individual object
1880 of the indicated element type, then the set type entry has
1881 either a \DWATbytesize{} attribute, or 
1882 \DWATbitsize{} attribute
1883 whose value (see Section \refersec{chap:byteandbitsizes}) is
1884 the amount of storage needed to hold a value of the set type.
1885
1886 \needlines{5}
1887 \section{Subrange Type Entries}
1888 \label{chap:subrangetypeentries}
1889
1890 \textit{Several languages support the concept of a \doublequote{subrange}
1891 type. Objects of the subrange type can represent only a contiguous 
1892 subset (range) of values from the type on which the subrange is defined.
1893 Subrange types may also be used to represent the bounds of array dimensions.}
1894
1895 A subrange type is represented by a debugging information
1896 entry with the tag 
1897 \DWTAGsubrangetypeTARG.\addtoindexx{subrange type entry} 
1898 If a name has been given to the subrange type, then the 
1899 subrange type entry has a 
1900 \DWATname{} attribute\addtoindexx{name attribute}
1901 whose value is a null-terminated
1902 string containing the subrange type name.
1903
1904 The tag \DWTAGgenericsubrange{}
1905 is used to describe arrays with a dynamic rank. See Section
1906 \refersec{chap:DWTAGgenericsubrange}.
1907
1908 The subrange entry may have a 
1909 \DWATtype{} attribute\addtoindexx{type attribute} to describe
1910 the type of object, called the basis type, of whose values
1911 this subrange is a subset.
1912
1913 If the amount of storage allocated to hold each element of an
1914 object of the given subrange type is different from the amount
1915 of storage that is normally allocated to hold an individual
1916 object of the indicated element type, then the subrange
1917 type entry has a 
1918 \DWATbytesize{} attribute or 
1919 \DWATbitsize{}
1920 attribute, whose value 
1921 (see Section \refersec{chap:staticanddynamicvaluesofattributes})
1922 is the amount of storage needed to hold a value of the subrange type.
1923
1924 The\hypertarget{chap:DWATthreadsscaledupcarrayboundthreadsscalfactor}{}
1925 subrange entry may have a 
1926 \DWATthreadsscaledDEFN{} attribute\addtoindexx{threads scaled attribute},
1927 which is a \livelink{chap:classflag}{flag}. 
1928 If present, this attribute indicates whether
1929 this subrange represents a \addtoindex{UPC} array bound which is scaled
1930 by the runtime \texttt{THREADS} value (the number of \addtoindex{UPC} threads in
1931 this execution of the program).
1932
1933 \textit{This allows the representation of a \addtoindex{UPC} shared array such as}
1934
1935 \begin{nlnlisting}
1936 int shared foo[34*THREADS][10][20];
1937 \end{nlnlisting}
1938
1939 \needlines{4}
1940 The\hypertarget{chap:DWATlowerboundlowerboundofsubrange}{}
1941 subrange\hypertarget{chap:DWATupperboundupperboundofsubrange}{}
1942 entry may have the attributes 
1943 \DWATlowerboundDEFN{}
1944 \addtoindexx{lower bound attribute}
1945 and \DWATupperboundDEFN{}
1946 \addtoindexx{upper bound attribute} to specify, respectively, the lower
1947 and upper bound values of the subrange. The 
1948 \DWATupperboundNAME{} 
1949 attribute\hypertarget{chap:DWATcountelementsofsubrangetype}{}
1950 may be replaced by a
1951 \addtoindexx{count attribute!default}
1952 \addtoindexx{count attribute}
1953 \DWATcountDEFN{} attribute, 
1954 whose value describes the number of elements in the subrange 
1955 rather than the value of the last element. The value of each 
1956 of these attributes is determined as described in 
1957 Section \refersec{chap:staticanddynamicvaluesofattributes}.
1958
1959 If the lower bound value is missing, the value is assumed to
1960 be a language-dependent default constant as defined in
1961 Table \refersec{tab:languageencodings}.
1962 \addtoindexx{lower bound attribute!default}
1963
1964 If the upper bound and count are missing, then the upper bound value is 
1965 \textit{unknown}.\addtoindexx{upper bound attribute!default unknown}
1966
1967 If the subrange entry has no type attribute describing the
1968 basis type, the basis type is determined as follows:
1969 \begin{enumerate}[1. ]
1970 \item
1971 If there is a lower bound attribute that references an object,
1972 the basis type is assumed to be the same as the type of that object.
1973 \item
1974 Otherwise, if there is an upper bound or count attribute that references
1975 an object, the basis type is assumed to be the same as the type of that object.
1976 \item
1977 Otherwise, the type is
1978 assumed to be the same type, in the source language of the
1979 compilation unit containing the subrange entry, as a signed
1980 integer with the same size as an address on the target machine.
1981 \end{enumerate}
1982
1983 If the subrange type occurs as the description of a dimension
1984 of an array type, and the stride for that dimension 
1985 is\hypertarget{chap:DWATbytestridesubrangestridedimensionofarraytype}{}
1986 different than what would otherwise be determined, 
1987 then\hypertarget{chap:DWATbitstridesubrangestridedimensionofarraytype}{}
1988 the subrange type entry has either a
1989 \addtoindexx{byte stride attribute}
1990 \DWATbytestrideDEFN{} or
1991 \DWATbitstrideDEFN{} attribute 
1992 \addtoindexx{bit stride attribute}
1993 which specifies the separation
1994 between successive elements along the dimension as described in 
1995 Section \refersec{chap:byteandbitsizes}.
1996
1997 \textit{Note that the stride can be negative.}
1998
1999 \needlines{4}
2000 \section{Pointer to Member Type Entries}
2001 \label{chap:pointertomembertypeentries}
2002
2003 \textit{In \addtoindex{C++}, a 
2004 pointer to a data or function member of a class or
2005 structure is a unique type.}
2006
2007 A debugging information entry representing the type of an
2008 object that is a pointer to a structure or class member has
2009 the tag \DWTAGptrtomembertypeTARG.
2010
2011 If the \addtoindex{pointer to member type} has a name, the 
2012 \addtoindexx{pointer to member type entry}
2013 pointer to member entry has a
2014 \DWATname{} attribute, 
2015 \addtoindexx{name attribute}
2016 whose value is a
2017 null\dash terminated string containing the type name.
2018
2019 The \addtoindex{pointer to member} entry 
2020 has 
2021 \addtoindexx{type attribute}
2022 a \DWATtype{} attribute to
2023 describe the type of the class or structure member to which
2024 objects of this type may point.
2025
2026 The \addtoindexx{pointer to member} entry 
2027 also\hypertarget{chap:DWATcontainingtypecontainingtypeofpointertomembertype}{}
2028 has a \DWATcontainingtypeDEFN{} attribute, 
2029 \addtoindexx{containing type (of pointer) attribute}
2030 whose value is a \livelink{chap:classreference}{reference} to a debugging
2031 information entry for the class or structure to whose members
2032 objects of this type may point.
2033
2034 The\hypertarget{chap:DWATuselocationmemberlocationforpointertomembertype}{}
2035 \addtoindex{pointer to member entry} has a 
2036 \DWATuselocationDEFN{} attribute
2037 \addtoindexx{use location attribute}
2038 whose value is a 
2039 \addtoindex{location description} that computes the
2040 address of the member of the class to which the pointer to
2041 member entry points.
2042
2043 \needlines{4}
2044 \textit{The method used to find the address of a given member of a
2045 class or structure is common to any instance of that class
2046 or structure and to any instance of the pointer or member
2047 type. The method is thus associated with the type entry,
2048 rather than with each instance of the type.}
2049
2050 The \DWATuselocation{} description is used in conjunction
2051 with the location descriptions for a particular object of the
2052 given \addtoindex{pointer to member type} and for a particular structure or
2053 class instance. The \DWATuselocation{} 
2054 attribute expects two values to be 
2055 \addtoindexi{pushed}{address!implicit push for member operator}
2056 onto the DWARF expression stack before
2057 the \DWATuselocation{} description is evaluated.
2058 The first value 
2059 \addtoindexi{pushed}{address!implicit push for member operator}
2060 is the value of the \addtoindex{pointer to member} object
2061 itself. The second value 
2062 \addtoindexi{pushed}{address!implicit push for member operator} 
2063 is the base address of the
2064 entire structure or union instance containing the member
2065 whose address is being calculated.
2066
2067 \needlines{6}
2068 \textit{For an expression such as}
2069
2070 \begin{nlnlisting}
2071     object.*mbr_ptr
2072 \end{nlnlisting}
2073 \textit{where \texttt{mbr\_ptr} has some \addtoindex{pointer to member type}, a debugger should:}
2074 \begin{enumerate}[1. ]
2075 \item \textit{Push the value of \texttt{mbr\_ptr} onto the DWARF expression stack.}
2076 \item \textit{Push the base address of \texttt{object} onto the DWARF expression stack.}
2077 \item \textit{Evaluate the \DWATuselocation{} description 
2078 given in the type of \texttt{mbr\_ptr}.}
2079 \end{enumerate}
2080
2081
2082 \section{File Type Entries}
2083 \label{chap:filetypeentries}
2084
2085 \textit{Some languages, such as \addtoindex{Pascal}, 
2086 provide a data type to represent 
2087 files.}
2088
2089 A file type is represented by a debugging information entry
2090 with 
2091 \addtoindexx{file type entry}
2092 the tag
2093 \DWTAGfiletypeTARG. 
2094 If the file type has a name,
2095 the file type entry has a \DWATname{} attribute,
2096 \addtoindexx{name attribute}
2097 whose value
2098 is a null\dash terminated string containing the type name.
2099
2100 The file type entry has 
2101 \addtoindexx{type attribute}
2102 a \DWATtype{} attribute describing
2103 the type of the objects contained in the file.
2104
2105 The file type entry also has a 
2106 \DWATbytesize{}\addtoindexx{byte size attribute} or
2107 \DWATbitsize{}\addtoindexx{bit size attribute} attribute, whose value 
2108 (see Section \refersec{chap:staticanddynamicvaluesofattributes})
2109 is the amount of storage need to hold a value of the file type.
2110
2111 \section{Dynamic Type Entries}
2112 \label{chap:dynamictypeentries}
2113 \textit{Some languages such as 
2114 \addtoindex{Fortran 90}, provide types whose values
2115 may be dynamically allocated or associated with a variable
2116 under explicit program control. However, unlike the
2117 pointer type in \addtoindex{C} or 
2118 \addtoindex{C++}, the indirection involved in accessing
2119 the value of the variable is generally implicit, that is, not
2120 indicated as part of the program source.}
2121
2122 A dynamic type entry is used to declare a dynamic type that is 
2123 \doublequote{just like} another non-dynamic type without needing to
2124 replicate the full description of that other type.
2125
2126 A dynamic type is represented by a debugging information entry
2127 with the tag \DWTAGdynamictypeTARG. If a name has been given to the
2128 dynamic type, then the dynamic type has a \DWATname{} attribute 
2129 whose value is a null-terminated string containing the dynamic
2130 type name.
2131         
2132 A dynamic type entry has a \DWATtype{} attribute whose value is a
2133 reference to the type of the entities that are dynamically allocated.
2134         
2135 A dynamic type entry also has a \DWATdatalocation, and may also
2136 have \DWATallocated{} and/or \DWATassociated{} attributes as 
2137 described in Section \refersec{chap:dynamicpropertiesoftypes}. 
2138 A \DWATdatalocation, \DWATallocated{} or \DWATassociated{} attribute 
2139 may not occur on a dynamic type entry if the same kind of attribute 
2140 already occurs on the type referenced by the \DWATtype{} attribute.
2141
2142
2143 \needlines{6}
2144 \section{Template Alias Entries}
2145 \label{chap:templatealiasentries}
2146
2147 \textit{In \addtoindex{C++}, a template alias is a form of typedef that has template
2148 parameters.  DWARF does not represent the template alias definition
2149 but does represent instantiations of the alias.}
2150
2151 A type named using a template alias is represented
2152 by a debugging information entry 
2153 \addtoindexx{template alias entry}
2154 with the tag
2155 \DWTAGtemplatealiasTARG. 
2156 The template alias entry has a
2157 \DWATname{} attribute 
2158 \addtoindexx{name attribute}
2159 whose value is a null\dash terminated string
2160 containing the name of the template alias.
2161 The template alias entry has child entries describing the template
2162 actual parameters (see Section \refersec{chap:templateparameters}).
2163
2164
2165 \section{Dynamic Properties of Types}
2166 \label{chap:dynamicpropertiesoftypes}
2167 \textit{The \DWATdatalocation, \DWATallocated{} and \DWATassociated{}
2168 attributes described in this section are motivated for use with
2169 \DWTAGdynamictype{} entries but can be used for any other type as well.}
2170
2171 \needlines{6}
2172 \subsection{Data Location}
2173 \label{chap:datalocation}
2174
2175 \textit{Some languages may represent objects using descriptors to hold
2176 information, including a location and/or run\dash time parameters,
2177 about the data that represents the value for that object.}
2178
2179 The\hypertarget{chap:DWATdatalocationindirectiontoactualdata}{}
2180 \DWATdatalocationDEFN{} attribute 
2181 \addtoindexx{data (indirect) location attribute}
2182 may be used with any type that provides one or more levels of 
2183 \addtoindexx{hidden indirection|see{data location attribute}}
2184 hidden indirection
2185 and/or run-time parameters in its representation. Its value
2186 is a \addtoindex{location description}. 
2187 The result of evaluating this
2188 description yields the location of the data for an object.
2189 When this attribute is omitted, the address of the data is
2190 the same as the address of the object.
2191
2192 \needlines{5}
2193 \textit{This location description will typically begin with
2194 \DWOPpushobjectaddress{} 
2195 which loads the address of the
2196 object which can then serve as a descriptor in subsequent
2197 calculation. For an example using 
2198 \DWATdatalocation{} 
2199 for a \addtoindex{Fortran 90 array}, see 
2200 Appendix \refersec{app:fortranarrayexample}.}
2201
2202 \subsection{Allocation and Association Status}
2203 \label{chap:allocationandassociationstatus}
2204
2205 \textit{Some languages, such as \addtoindex{Fortran 90},
2206 provide types whose values
2207 may be dynamically allocated or associated with a variable
2208 under explicit program control.}
2209
2210 The\hypertarget{chap:DWATallocatedallocationstatusoftypes}{}
2211 \DWATallocatedDEFN{} attribute\addtoindexx{allocated attribute}
2212 may be used with any
2213 type for which objects of the type can be explicitly allocated
2214 and deallocated. The presence of the attribute indicates that
2215 objects of the type are allocatable and deallocatable. The
2216 integer value of the attribute (see below) specifies whether
2217 an object of the type is currently allocated or not.
2218
2219 \needlines{4}
2220 The\hypertarget{chap:DWATassociatedassociationstatusoftypes}{} 
2221 \DWATassociatedDEFN{} attribute 
2222 may 
2223 \addtoindexx{associated attribute}
2224 optionally be used with
2225 any type for which objects of the type can be dynamically
2226 associated with other objects. The presence of the attribute
2227 indicates that objects of the type can be associated. The
2228 integer value of the attribute (see below) indicates whether
2229 an object of the type is currently associated or not.
2230
2231 The value of these attributes is determined as described in
2232 Section \refersec{chap:staticanddynamicvaluesofattributes}.
2233 A non-zero value is interpreted as allocated or associated,
2234 and zero is interpreted as not allocated or not associated.
2235
2236 \textit{For \addtoindex{Fortran 90}, 
2237 if the \DWATassociated{} 
2238 attribute is present,
2239 the type has the POINTER property where either the parent
2240 variable is never associated with a dynamic object or the
2241 implementation does not track whether the associated object
2242 is static or dynamic. If the \DWATallocated{} attribute is
2243 present and the \DWATassociated{} attribute is not, the type
2244 has the ALLOCATABLE property. If both attributes are present,
2245 then the type should be assumed to have the POINTER property
2246 (and not ALLOCATABLE); the \DWATallocated{} attribute may then
2247 be used to indicate that the association status of the object
2248 resulted from execution of an ALLOCATE statement rather than
2249 pointer assignment.}
2250
2251 \textit{For examples using 
2252 \DWATallocated{} for \addtoindex{Ada} and 
2253 \addtoindex{Fortran 90}
2254 arrays, 
2255 see Appendix \refersec{app:aggregateexamples}.}
2256
2257 \subsection{Array Rank}
2258 \label{chap:DWATrank}
2259 \addtoindexx{array!assumed-rank}
2260 \addtoindexx{assumed-rank array|see{array, assumed-rank}}
2261 \textit{The Fortran language supports \doublequote{assumed-rank arrays}. The
2262   rank (the number of dimensions) of an assumed-rank array is unknown
2263   at compile time. The Fortran runtime stores the rank in an array
2264   descriptor.}
2265
2266 The presence of 
2267 the\hypertarget{chap:DWATrankofdynamicarray}{\DWATrankINDX}
2268 attribute indicates that an array's rank
2269 (number of dimensions) is dynamic, and therefore unknown at compile
2270 time. The value of the \DWATrankDEFN{} attribute is either an integer constant
2271 or a DWARF expression whose evaluation yields the dynamic rank.
2272
2273 The bounds of an array with dynamic rank are described using a
2274 \DWTAGgenericsubrange{} entry, which  
2275 is the dynamic rank array equivalent of
2276 \DWTAGsubrangetype. The
2277 difference is that a \DWTAGgenericsubrange{} entry contains generic
2278 lower/upper bound and stride expressions that need to be evaluated for
2279 each dimension. Before any expression contained in a
2280 \DWTAGgenericsubrange{} can be evaluated, the dimension for which the
2281 expression is to be evaluated needs to be pushed onto the stack. The
2282 expression will use it to find the offset of the respective field in
2283 the array descriptor metadata.
2284
2285 \textit{A producer is free to choose any layout for the
2286   array descriptor. In particular, the upper and lower bounds and
2287   stride values do not need to be bundled into a structure or record,
2288   but could be laid end to end in the containing descriptor, pointed
2289   to by the descriptor, or even allocated independently of the
2290   descriptor.}
2291
2292 Dimensions are enumerated $0$ to $\mathit{rank}-1$ in source program
2293 order.
2294
2295 \textit{For an example in Fortran 2008, see
2296   Section~\refersec{app:assumedrankexample}.}
2297