1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
|
/**
* Compiler implementation of the
* $(LINK2 http://www.dlang.org, D programming language).
*
* Copyright: Copyright (C) 1999-2018 by The D Language Foundation, All Rights Reserved
* Authors: $(LINK2 http://www.digitalmars.com, Walter Bright)
* License: $(LINK2 http://www.boost.org/LICENSE_1_0.txt, Boost License 1.0)
* Source: $(LINK2 https://github.com/dlang/dmd/blob/master/src/dmd/dstruct.d, _dstruct.d)
* Documentation: https://dlang.org/phobos/dmd_dstruct.html
* Coverage: https://codecov.io/gh/dlang/dmd/src/master/src/dmd/dstruct.d
*/
module dmd.dstruct;
import dmd.aggregate;
import dmd.arraytypes;
import dmd.declaration;
import dmd.dmodule;
import dmd.dscope;
import dmd.dsymbol;
import dmd.dsymbolsem;
import dmd.dtemplate;
import dmd.errors;
import dmd.expression;
import dmd.expressionsem;
import dmd.func;
import dmd.globals;
import dmd.id;
import dmd.identifier;
import dmd.mtype;
import dmd.opover;
import dmd.semantic3;
import dmd.target;
import dmd.tokens;
import dmd.typesem;
import dmd.typinf;
import dmd.visitor;
/***************************************
* Search sd for a member function of the form:
* `extern (D) string toString();`
* Params:
* sd = struct declaration to search
* Returns:
* FuncDeclaration of `toString()` if found, `null` if not
*/
extern (C++) FuncDeclaration search_toString(StructDeclaration sd)
{
Dsymbol s = search_function(sd, Id.tostring);
FuncDeclaration fd = s ? s.isFuncDeclaration() : null;
if (fd)
{
__gshared TypeFunction tftostring;
if (!tftostring)
{
tftostring = new TypeFunction(null, Type.tstring, 0, LINK.d);
tftostring = tftostring.merge().toTypeFunction();
}
fd = fd.overloadExactMatch(tftostring);
}
return fd;
}
/***************************************
* Request additional semantic analysis for TypeInfo generation.
* Params:
* sc = context
* t = type that TypeInfo is being generated for
*/
extern (C++) void semanticTypeInfo(Scope* sc, Type t)
{
extern (C++) final class FullTypeInfoVisitor : Visitor
{
alias visit = Visitor.visit;
public:
Scope* sc;
override void visit(Type t)
{
Type tb = t.toBasetype();
if (tb != t)
tb.accept(this);
}
override void visit(TypeNext t)
{
if (t.next)
t.next.accept(this);
}
override void visit(TypeBasic t)
{
}
override void visit(TypeVector t)
{
t.basetype.accept(this);
}
override void visit(TypeAArray t)
{
t.index.accept(this);
visit(cast(TypeNext)t);
}
override void visit(TypeFunction t)
{
visit(cast(TypeNext)t);
// Currently TypeInfo_Function doesn't store parameter types.
}
override void visit(TypeStruct t)
{
//printf("semanticTypeInfo.visit(TypeStruct = %s)\n", t.toChars());
StructDeclaration sd = t.sym;
/* Step 1: create TypeInfoDeclaration
*/
if (!sc) // inline may request TypeInfo.
{
Scope scx;
scx._module = sd.getModule();
getTypeInfoType(sd.loc, t, &scx);
sd.requestTypeInfo = true;
}
else if (!sc.minst)
{
// don't yet have to generate TypeInfo instance if
// the typeid(T) expression exists in speculative scope.
}
else
{
getTypeInfoType(sd.loc, t, sc);
sd.requestTypeInfo = true;
// https://issues.dlang.org/show_bug.cgi?id=15149
// if the typeid operand type comes from a
// result of auto function, it may be yet speculative.
unSpeculative(sc, sd);
}
/* Step 2: If the TypeInfo generation requires sd.semantic3, run it later.
* This should be done even if typeid(T) exists in speculative scope.
* Because it may appear later in non-speculative scope.
*/
if (!sd.members)
return; // opaque struct
if (!sd.xeq && !sd.xcmp && !sd.postblit && !sd.dtor && !sd.xhash && !search_toString(sd))
return; // none of TypeInfo-specific members
// If the struct is in a non-root module, run semantic3 to get
// correct symbols for the member function.
if (sd.semanticRun >= PASS.semantic3)
{
// semantic3 is already done
}
else if (TemplateInstance ti = sd.isInstantiated())
{
if (ti.minst && !ti.minst.isRoot())
Module.addDeferredSemantic3(sd);
}
else
{
if (sd.inNonRoot())
{
//printf("deferred sem3 for TypeInfo - sd = %s, inNonRoot = %d\n", sd.toChars(), sd.inNonRoot());
Module.addDeferredSemantic3(sd);
}
}
}
override void visit(TypeClass t)
{
}
override void visit(TypeTuple t)
{
if (t.arguments)
{
for (size_t i = 0; i < t.arguments.dim; i++)
{
Type tprm = (*t.arguments)[i].type;
if (tprm)
tprm.accept(this);
}
}
}
}
if (sc)
{
if (!sc.func)
return;
if (sc.intypeof)
return;
if (sc.flags & (SCOPE.ctfe | SCOPE.compile))
return;
}
scope FullTypeInfoVisitor v = new FullTypeInfoVisitor();
v.sc = sc;
t.accept(v);
}
enum StructFlags : int
{
none = 0x0,
hasPointers = 0x1, // NB: should use noPointers as in ClassFlags
}
enum StructPOD : int
{
no, // struct is not POD
yes, // struct is POD
fwd, // POD not yet computed
}
/***********************************************************
* All `struct` declarations are an instance of this.
*/
extern (C++) class StructDeclaration : AggregateDeclaration
{
bool zeroInit; // !=0 if initialize with 0 fill
bool hasIdentityAssign; // true if has identity opAssign
bool hasIdentityEquals; // true if has identity opEquals
bool hasNoFields; // has no fields
FuncDeclarations postblits; // Array of postblit functions
FuncDeclaration postblit; // aggregate postblit
FuncDeclaration xeq; // TypeInfo_Struct.xopEquals
FuncDeclaration xcmp; // TypeInfo_Struct.xopCmp
FuncDeclaration xhash; // TypeInfo_Struct.xtoHash
extern (C++) __gshared FuncDeclaration xerreq; // object.xopEquals
extern (C++) __gshared FuncDeclaration xerrcmp; // object.xopCmp
structalign_t alignment; // alignment applied outside of the struct
StructPOD ispod; // if struct is POD
// For 64 bit Efl function call/return ABI
Type arg1type;
Type arg2type;
// Even if struct is defined as non-root symbol, some built-in operations
// (e.g. TypeidExp, NewExp, ArrayLiteralExp, etc) request its TypeInfo.
// For those, today TypeInfo_Struct is generated in COMDAT.
bool requestTypeInfo;
extern (D) this(const ref Loc loc, Identifier id, bool inObject)
{
super(loc, id);
zeroInit = false; // assume false until we do semantic processing
ispod = StructPOD.fwd;
// For forward references
type = new TypeStruct(this);
if (inObject)
{
if (id == Id.ModuleInfo && !Module.moduleinfo)
Module.moduleinfo = this;
}
}
static StructDeclaration create(Loc loc, Identifier id, bool inObject)
{
return new StructDeclaration(loc, id, inObject);
}
override Dsymbol syntaxCopy(Dsymbol s)
{
StructDeclaration sd =
s ? cast(StructDeclaration)s
: new StructDeclaration(loc, ident, false);
return ScopeDsymbol.syntaxCopy(sd);
}
final void semanticTypeInfoMembers()
{
if (xeq &&
xeq._scope &&
xeq.semanticRun < PASS.semantic3done)
{
uint errors = global.startGagging();
xeq.semantic3(xeq._scope);
if (global.endGagging(errors))
xeq = xerreq;
}
if (xcmp &&
xcmp._scope &&
xcmp.semanticRun < PASS.semantic3done)
{
uint errors = global.startGagging();
xcmp.semantic3(xcmp._scope);
if (global.endGagging(errors))
xcmp = xerrcmp;
}
FuncDeclaration ftostr = search_toString(this);
if (ftostr &&
ftostr._scope &&
ftostr.semanticRun < PASS.semantic3done)
{
ftostr.semantic3(ftostr._scope);
}
if (xhash &&
xhash._scope &&
xhash.semanticRun < PASS.semantic3done)
{
xhash.semantic3(xhash._scope);
}
if (postblit &&
postblit._scope &&
postblit.semanticRun < PASS.semantic3done)
{
postblit.semantic3(postblit._scope);
}
if (dtor &&
dtor._scope &&
dtor.semanticRun < PASS.semantic3done)
{
dtor.semantic3(dtor._scope);
}
}
override final Dsymbol search(const ref Loc loc, Identifier ident, int flags = SearchLocalsOnly)
{
//printf("%s.StructDeclaration::search('%s', flags = x%x)\n", toChars(), ident.toChars(), flags);
if (_scope && !symtab)
dsymbolSemantic(this, _scope);
if (!members || !symtab) // opaque or semantic() is not yet called
{
error("is forward referenced when looking for `%s`", ident.toChars());
return null;
}
return ScopeDsymbol.search(loc, ident, flags);
}
override const(char)* kind() const
{
return "struct";
}
override final void finalizeSize()
{
//printf("StructDeclaration::finalizeSize() %s, sizeok = %d\n", toChars(), sizeok);
assert(sizeok != Sizeok.done);
//printf("+StructDeclaration::finalizeSize() %s, fields.dim = %d, sizeok = %d\n", toChars(), fields.dim, sizeok);
fields.setDim(0); // workaround
// Set the offsets of the fields and determine the size of the struct
uint offset = 0;
bool isunion = isUnionDeclaration() !is null;
for (size_t i = 0; i < members.dim; i++)
{
Dsymbol s = (*members)[i];
s.setFieldOffset(this, &offset, isunion);
}
if (type.ty == Terror)
return;
// 0 sized struct's are set to 1 byte
if (structsize == 0)
{
hasNoFields = true;
structsize = 1;
alignsize = 1;
}
// Round struct size up to next alignsize boundary.
// This will ensure that arrays of structs will get their internals
// aligned properly.
if (alignment == STRUCTALIGN_DEFAULT)
structsize = (structsize + alignsize - 1) & ~(alignsize - 1);
else
structsize = (structsize + alignment - 1) & ~(alignment - 1);
sizeok = Sizeok.done;
//printf("-StructDeclaration::finalizeSize() %s, fields.dim = %d, structsize = %d\n", toChars(), fields.dim, structsize);
if (errors)
return;
// Calculate fields[i].overlapped
if (checkOverlappedFields())
{
errors = true;
return;
}
// Determine if struct is all zeros or not
zeroInit = true;
foreach (vd; fields)
{
if (vd._init)
{
// Should examine init to see if it is really all 0's
zeroInit = false;
break;
}
else if (!vd.type.isZeroInit(loc))
{
zeroInit = false;
break;
}
}
auto tt = Target.toArgTypes(type);
size_t dim = tt.arguments.dim;
if (dim >= 1)
{
assert(dim <= 2);
arg1type = (*tt.arguments)[0].type;
if (dim == 2)
arg2type = (*tt.arguments)[1].type;
}
}
/***************************************
* Fit elements[] to the corresponding types of the struct's fields.
*
* Params:
* loc = location to use for error messages
* sc = context
* elements = explicit arguments used to construct object
* stype = the constructed object type.
* Returns:
* false if any errors occur,
* otherwise true and elements[] are rewritten for the output.
*/
final bool fit(const ref Loc loc, Scope* sc, Expressions* elements, Type stype)
{
if (!elements)
return true;
size_t nfields = fields.dim - isNested();
size_t offset = 0;
for (size_t i = 0; i < elements.dim; i++)
{
Expression e = (*elements)[i];
if (!e)
continue;
e = resolveProperties(sc, e);
if (i >= nfields)
{
if (i == fields.dim - 1 && isNested() && e.op == TOK.null_)
{
// CTFE sometimes creates null as hidden pointer; we'll allow this.
continue;
}
.error(loc, "more initializers than fields (%d) of `%s`", nfields, toChars());
return false;
}
VarDeclaration v = fields[i];
if (v.offset < offset)
{
.error(loc, "overlapping initialization for `%s`", v.toChars());
return false;
}
offset = cast(uint)(v.offset + v.type.size());
Type t = v.type;
if (stype)
t = t.addMod(stype.mod);
Type origType = t;
Type tb = t.toBasetype();
const hasPointers = tb.hasPointers();
if (hasPointers)
{
if ((stype.alignment() < Target.ptrsize ||
(v.offset & (Target.ptrsize - 1))) &&
(sc.func && sc.func.setUnsafe()))
{
.error(loc, "field `%s.%s` cannot assign to misaligned pointers in `@safe` code",
toChars(), v.toChars());
return false;
}
}
/* Look for case of initializing a static array with a too-short
* string literal, such as:
* char[5] foo = "abc";
* Allow this by doing an explicit cast, which will lengthen the string
* literal.
*/
if (e.op == TOK.string_ && tb.ty == Tsarray)
{
StringExp se = cast(StringExp)e;
Type typeb = se.type.toBasetype();
TY tynto = tb.nextOf().ty;
if (!se.committed &&
(typeb.ty == Tarray || typeb.ty == Tsarray) &&
(tynto == Tchar || tynto == Twchar || tynto == Tdchar) &&
se.numberOfCodeUnits(tynto) < (cast(TypeSArray)tb).dim.toInteger())
{
e = se.castTo(sc, t);
goto L1;
}
}
while (!e.implicitConvTo(t) && tb.ty == Tsarray)
{
/* Static array initialization, as in:
* T[3][5] = e;
*/
t = tb.nextOf();
tb = t.toBasetype();
}
if (!e.implicitConvTo(t))
t = origType; // restore type for better diagnostic
e = e.implicitCastTo(sc, t);
L1:
if (e.op == TOK.error)
return false;
(*elements)[i] = doCopyOrMove(sc, e);
}
return true;
}
/***************************************
* Determine if struct is POD (Plain Old Data).
*
* POD is defined as:
* $(OL
* $(LI not nested)
* $(LI no postblits, destructors, or assignment operators)
* $(LI no `ref` fields or fields that are themselves non-POD)
* )
* The idea being these are compatible with C structs.
*
* Returns:
* true if struct is POD
*/
final bool isPOD()
{
// If we've already determined whether this struct is POD.
if (ispod != StructPOD.fwd)
return (ispod == StructPOD.yes);
ispod = StructPOD.yes;
if (enclosing || postblit || dtor)
ispod = StructPOD.no;
// Recursively check all fields are POD.
for (size_t i = 0; i < fields.dim; i++)
{
VarDeclaration v = fields[i];
if (v.storage_class & STC.ref_)
{
ispod = StructPOD.no;
break;
}
Type tv = v.type.baseElemOf();
if (tv.ty == Tstruct)
{
TypeStruct ts = cast(TypeStruct)tv;
StructDeclaration sd = ts.sym;
if (!sd.isPOD())
{
ispod = StructPOD.no;
break;
}
}
}
return (ispod == StructPOD.yes);
}
override final inout(StructDeclaration) isStructDeclaration() inout
{
return this;
}
override void accept(Visitor v)
{
v.visit(this);
}
}
/***********************************************************
* Unions are a variation on structs.
*/
extern (C++) final class UnionDeclaration : StructDeclaration
{
extern (D) this(const ref Loc loc, Identifier id)
{
super(loc, id, false);
}
override Dsymbol syntaxCopy(Dsymbol s)
{
assert(!s);
auto ud = new UnionDeclaration(loc, ident);
return StructDeclaration.syntaxCopy(ud);
}
override const(char)* kind() const
{
return "union";
}
override inout(UnionDeclaration) isUnionDeclaration() inout
{
return this;
}
override void accept(Visitor v)
{
v.visit(this);
}
}
|