-
-
Notifications
You must be signed in to change notification settings - Fork 593
/
dmodule.d
1504 lines (1379 loc) · 49.6 KB
/
dmodule.d
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
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* Compiler implementation of the
* $(LINK2 http://www.dlang.org, D programming language).
*
* Copyright: Copyright (C) 1999-2019 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/dmodule.d, _dmodule.d)
* Documentation: https://dlang.org/phobos/dmd_dmodule.html
* Coverage: https://codecov.io/gh/dlang/dmd/src/master/src/dmd/dmodule.d
*/
module dmd.dmodule;
import core.stdc.stdio;
import core.stdc.stdlib;
import core.stdc.string;
import dmd.aggregate;
import dmd.arraytypes;
import dmd.astcodegen;
import dmd.compiler;
import dmd.gluelayer;
import dmd.dimport;
import dmd.dmacro;
import dmd.doc;
import dmd.dscope;
import dmd.dsymbol;
import dmd.dsymbolsem;
import dmd.errors;
import dmd.expression;
import dmd.expressionsem;
import dmd.globals;
import dmd.id;
import dmd.identifier;
import dmd.parse;
import dmd.root.file;
import dmd.root.filename;
import dmd.root.outbuffer;
import dmd.root.port;
import dmd.root.rmem;
import dmd.semantic2;
import dmd.semantic3;
import dmd.utils;
import dmd.visitor;
version(Windows) {
extern (C) char* getcwd(char* buffer, size_t maxlen);
} else {
import core.sys.posix.unistd : getcwd;
}
/* =========================== ===================== */
/********************************************
* Look for the source file if it's different from filename.
* Look for .di, .d, directory, and along global.path.
* Does not open the file.
* Input:
* filename as supplied by the user
* global.path
* Returns:
* NULL if it's not different from filename.
*/
private const(char)[] lookForSourceFile(const(char)[] filename)
{
/* Search along global.path for .di file, then .d file.
*/
const sdi = FileName.forceExt(filename, global.hdr_ext);
if (FileName.exists(sdi) == 1)
return sdi;
scope(exit) FileName.free(sdi.ptr);
const sd = FileName.forceExt(filename, global.mars_ext);
if (FileName.exists(sd) == 1)
return sd;
scope(exit) FileName.free(sd.ptr);
if (FileName.exists(filename) == 2)
{
/* The filename exists and it's a directory.
* Therefore, the result should be: filename/package.d
* iff filename/package.d is a file
*/
const ni = FileName.combine(filename, "package.di");
if (FileName.exists(ni) == 1)
return ni;
FileName.free(ni.ptr);
const n = FileName.combine(filename, "package.d");
if (FileName.exists(n) == 1)
return n;
FileName.free(n.ptr);
}
if (FileName.absolute(filename))
return null;
if (!global.path)
return null;
for (size_t i = 0; i < global.path.dim; i++)
{
const p = (*global.path)[i].toDString();
const(char)[] n = FileName.combine(p, sdi);
if (FileName.exists(n) == 1) {
return n;
}
FileName.free(n.ptr);
n = FileName.combine(p, sd);
if (FileName.exists(n) == 1) {
return n;
}
FileName.free(n.ptr);
const b = FileName.removeExt(filename);
n = FileName.combine(p, b);
FileName.free(b.ptr);
if (FileName.exists(n) == 2)
{
const n2i = FileName.combine(n, "package.di");
if (FileName.exists(n2i) == 1)
return n2i;
FileName.free(n2i.ptr);
const n2 = FileName.combine(n, "package.d");
if (FileName.exists(n2) == 1) {
return n2;
}
FileName.free(n2.ptr);
}
FileName.free(n.ptr);
}
return null;
}
// function used to call semantic3 on a module's dependencies
void semantic3OnDependencies(Module m)
{
if (!m)
return;
if (m.semanticRun > PASS.semantic3)
return;
m.semantic3(null);
foreach (i; 1 .. m.aimports.dim)
semantic3OnDependencies(m.aimports[i]);
}
/**
* Converts a chain of identifiers to the filename of the module
*
* Params:
* packages = the names of the "parent" packages
* ident = the name of the child package or module
*
* Returns:
* the filename of the child package or module
*/
private const(char)[] getFilename(Identifiers* packages, Identifier ident)
{
const(char)[] filename = ident.toString();
if (packages == null || packages.dim == 0)
return filename;
OutBuffer buf;
OutBuffer dotmods;
auto modAliases = &global.params.modFileAliasStrings;
void checkModFileAlias(const(char)[] p)
{
/* Check and replace the contents of buf[] with
* an alias string from global.params.modFileAliasStrings[]
*/
dotmods.writestring(p);
foreach_reverse (const m; *modAliases)
{
const q = strchr(m, '=');
assert(q);
if (dotmods.offset == q - m && memcmp(dotmods.peekChars(), m, q - m) == 0)
{
buf.reset();
auto rhs = q[1 .. strlen(q)];
if (rhs.length > 0 && (rhs[$ - 1] == '/' || rhs[$ - 1] == '\\'))
rhs = rhs[0 .. $ - 1]; // remove trailing separator
buf.writestring(rhs);
break; // last matching entry in ms[] wins
}
}
dotmods.writeByte('.');
}
foreach (pid; *packages)
{
const p = pid.toString();
buf.writestring(p);
if (modAliases.dim)
checkModFileAlias(p);
version (Windows)
enum FileSeparator = '\\';
else
enum FileSeparator = '/';
buf.writeByte(FileSeparator);
}
buf.writestring(filename);
if (modAliases.dim)
checkModFileAlias(filename);
buf.writeByte(0);
filename = buf.extractSlice()[0 .. $ - 1];
return filename;
}
enum PKG : int
{
unknown, // not yet determined whether it's a package.d or not
module_, // already determined that's an actual package.d
package_, // already determined that's an actual package
}
/***********************************************************
*/
extern (C++) class Package : ScopeDsymbol
{
PKG isPkgMod = PKG.unknown;
uint tag; // auto incremented tag, used to mask package tree in scopes
Module mod; // !=null if isPkgMod == PKG.module_
final extern (D) this(const ref Loc loc, Identifier ident)
{
super(loc, ident);
__gshared uint packageTag;
this.tag = packageTag++;
}
override const(char)* kind() const
{
return "package";
}
/****************************************************
* Input:
* packages[] the pkg1.pkg2 of pkg1.pkg2.mod
* Returns:
* the symbol table that mod should be inserted into
* Output:
* *pparent the rightmost package, i.e. pkg2, or NULL if no packages
* *ppkg the leftmost package, i.e. pkg1, or NULL if no packages
*/
extern (D) static DsymbolTable resolve(Identifiers* packages, Dsymbol* pparent, Package* ppkg)
{
DsymbolTable dst = Module.modules;
Dsymbol parent = null;
//printf("Package::resolve()\n");
if (ppkg)
*ppkg = null;
if (packages)
{
for (size_t i = 0; i < packages.dim; i++)
{
Identifier pid = (*packages)[i];
Package pkg;
Dsymbol p = dst.lookup(pid);
if (!p)
{
pkg = new Package(Loc.initial, pid);
dst.insert(pkg);
pkg.parent = parent;
pkg.symtab = new DsymbolTable();
}
else
{
pkg = p.isPackage();
assert(pkg);
// It might already be a module, not a package, but that needs
// to be checked at a higher level, where a nice error message
// can be generated.
// dot net needs modules and packages with same name
// But we still need a symbol table for it
if (!pkg.symtab)
pkg.symtab = new DsymbolTable();
}
parent = pkg;
dst = pkg.symtab;
if (ppkg && !*ppkg)
*ppkg = pkg;
if (pkg.isModule())
{
// Return the module so that a nice error message can be generated
if (ppkg)
*ppkg = cast(Package)p;
break;
}
}
}
if (pparent)
*pparent = parent;
return dst;
}
override final inout(Package) isPackage() inout
{
return this;
}
/**
* Checks if pkg is a sub-package of this
*
* For example, if this qualifies to 'a1.a2' and pkg - to 'a1.a2.a3',
* this function returns 'true'. If it is other way around or qualified
* package paths conflict function returns 'false'.
*
* Params:
* pkg = possible subpackage
*
* Returns:
* see description
*/
final bool isAncestorPackageOf(const Package pkg) const
{
if (this == pkg)
return true;
if (!pkg || !pkg.parent)
return false;
return isAncestorPackageOf(pkg.parent.isPackage());
}
override Dsymbol search(const ref Loc loc, Identifier ident, int flags = SearchLocalsOnly)
{
//printf("%s Package.search('%s', flags = x%x)\n", toChars(), ident.toChars(), flags);
flags &= ~SearchLocalsOnly; // searching an import is always transitive
if (!isModule() && mod)
{
// Prefer full package name.
Dsymbol s = symtab ? symtab.lookup(ident) : null;
if (s)
return s;
//printf("[%s] through pkdmod: %s\n", loc.toChars(), toChars());
return mod.search(loc, ident, flags);
}
return ScopeDsymbol.search(loc, ident, flags);
}
override void accept(Visitor v)
{
v.visit(this);
}
final Module isPackageMod()
{
if (isPkgMod == PKG.module_)
{
return mod;
}
return null;
}
/**
* Checks for the existence of a package.d to set isPkgMod appropriately
* if isPkgMod == PKG.unknown
*/
final void resolvePKGunknown()
{
if (isModule())
return;
if (isPkgMod != PKG.unknown)
return;
Identifiers packages;
for (Dsymbol s = this.parent; s; s = s.parent)
packages.insert(0, s.ident);
if (lookForSourceFile(getFilename(&packages, ident)))
Module.load(Loc(), &packages, this.ident);
else
isPkgMod = PKG.package_;
}
}
/***********************************************************
*/
extern (C++) final class Module : Package
{
extern (C++) __gshared Module rootModule;
extern (C++) __gshared DsymbolTable modules; // symbol table of all modules
extern (C++) __gshared Modules amodules; // array of all modules
extern (C++) __gshared Dsymbols deferred; // deferred Dsymbol's needing semantic() run on them
extern (C++) __gshared Dsymbols deferred2; // deferred Dsymbol's needing semantic2() run on them
extern (C++) __gshared Dsymbols deferred3; // deferred Dsymbol's needing semantic3() run on them
extern (C++) __gshared uint dprogress; // progress resolving the deferred list
static void _init()
{
modules = new DsymbolTable();
}
/**
* Deinitializes the global state of the compiler.
*
* This can be used to restore the state set by `_init` to its original
* state.
*/
static void deinitialize()
{
modules = modules.init;
}
extern (C++) __gshared AggregateDeclaration moduleinfo;
const(char)[] arg; // original argument name
ModuleDeclaration* md; // if !=null, the contents of the ModuleDeclaration declaration
const FileName srcfile; // input source file
const FileName objfile; // output .obj file
const FileName hdrfile; // 'header' file
FileName docfile; // output documentation file
FileBuffer* srcBuffer; // set during load(), free'd in parse()
uint errors; // if any errors in file
uint numlines; // number of lines in source file
bool isHdrFile; // if it is a header (.di) file
bool isDocFile; // if it is a documentation input file, not D source
bool isPackageFile; // if it is a package.d
Strings contentImportedFiles; // array of files whose content was imported
int needmoduleinfo;
int selfimports; // 0: don't know, 1: does not, 2: does
/*************************************
* Return true if module imports itself.
*/
bool selfImports()
{
//printf("Module::selfImports() %s\n", toChars());
if (selfimports == 0)
{
for (size_t i = 0; i < amodules.dim; i++)
amodules[i].insearch = 0;
selfimports = imports(this) + 1;
for (size_t i = 0; i < amodules.dim; i++)
amodules[i].insearch = 0;
}
return selfimports == 2;
}
int rootimports; // 0: don't know, 1: does not, 2: does
/*************************************
* Return true if module imports root module.
*/
bool rootImports()
{
//printf("Module::rootImports() %s\n", toChars());
if (rootimports == 0)
{
for (size_t i = 0; i < amodules.dim; i++)
amodules[i].insearch = 0;
rootimports = 1;
for (size_t i = 0; i < amodules.dim; ++i)
{
Module m = amodules[i];
if (m.isRoot() && imports(m))
{
rootimports = 2;
break;
}
}
for (size_t i = 0; i < amodules.dim; i++)
amodules[i].insearch = 0;
}
return rootimports == 2;
}
int insearch;
Identifier searchCacheIdent;
Dsymbol searchCacheSymbol; // cached value of search
int searchCacheFlags; // cached flags
/**
* A root module is one that will be compiled all the way to
* object code. This field holds the root module that caused
* this module to be loaded. If this module is a root module,
* then it will be set to `this`. This is used to determine
* ownership of template instantiation.
*/
Module importedFrom;
Dsymbols* decldefs; // top level declarations for this Module
Modules aimports; // all imported modules
uint debuglevel; // debug level
Identifiers* debugids; // debug identifiers
Identifiers* debugidsNot; // forward referenced debug identifiers
uint versionlevel; // version level
Identifiers* versionids; // version identifiers
Identifiers* versionidsNot; // forward referenced version identifiers
Macro* macrotable; // document comment macros
Escape* escapetable; // document comment escapes
size_t nameoffset; // offset of module name from start of ModuleInfo
size_t namelen; // length of module name in characters
extern (D) this(const ref Loc loc, const(char)[] filename, Identifier ident, int doDocComment, int doHdrGen)
{
super(loc, ident);
const(char)[] srcfilename;
//printf("Module::Module(filename = '%s', ident = '%s')\n", filename, ident.toChars());
this.arg = filename;
srcfilename = FileName.defaultExt(filename, global.mars_ext);
if (global.run_noext && global.params.run &&
!FileName.ext(filename) &&
FileName.exists(srcfilename) == 0 &&
FileName.exists(filename) == 1)
{
FileName.free(srcfilename.ptr);
srcfilename = FileName.removeExt(filename); // just does a mem.strdup(filename)
}
else if (!FileName.equalsExt(srcfilename, global.mars_ext) &&
!FileName.equalsExt(srcfilename, global.hdr_ext) &&
!FileName.equalsExt(srcfilename, "dd"))
{
error("source file name '%.*s' must have .%.*s extension",
cast(int)srcfilename.length, srcfilename.ptr,
cast(int)global.mars_ext.length, global.mars_ext.ptr);
fatal();
}
srcfile = FileName(srcfilename);
objfile = setOutfilename(global.params.objname, global.params.objdir, filename, global.obj_ext);
if (doDocComment)
setDocfile();
if (doHdrGen)
hdrfile = setOutfilename(global.params.hdrname, global.params.hdrdir, arg, global.hdr_ext);
escapetable = new Escape();
}
extern (D) this(const(char)[] filename, Identifier ident, int doDocComment, int doHdrGen)
{
this(Loc.initial, filename, ident, doDocComment, doHdrGen);
}
static Module create(const(char)* filename, Identifier ident, int doDocComment, int doHdrGen)
{
return create(filename.toDString, ident, doDocComment, doHdrGen);
}
extern (D) static Module create(const(char)[] filename, Identifier ident, int doDocComment, int doHdrGen)
{
return new Module(Loc.initial, filename, ident, doDocComment, doHdrGen);
}
static Module load(Loc loc, Identifiers* packages, Identifier ident)
{
//printf("Module::load(ident = '%s')\n", ident.toChars());
// Build module filename by turning:
// foo.bar.baz
// into:
// foo\bar\baz
const(char)[] filename = getFilename(packages, ident);
// Look for the source file
if (const result = lookForSourceFile(filename))
filename = result; // leaks
auto m = new Module(loc, filename, ident, 0, 0);
if (!m.read(loc))
return null;
if (global.params.verbose)
{
OutBuffer buf;
if (packages)
{
foreach (pid; *packages)
{
buf.writestring(pid.toString());
buf.writeByte('.');
}
}
buf.printf("%s\t(%s)", ident.toChars(), m.srcfile.toChars());
message("import %s", buf.peekChars());
}
m = m.parse();
// Call onImport here because if the module is going to be compiled then we
// need to determine it early because it affects semantic analysis. This is
// being done after parsing the module so the full module name can be taken
// from whatever was declared in the file.
if (!m.isRoot() && Compiler.onImport(m))
{
m.importedFrom = m;
assert(m.isRoot());
}
Compiler.loadModule(m);
return m;
}
override const(char)* kind() const
{
return "module";
}
/*********************************************
* Combines things into output file name for .html and .di files.
* Input:
* name Command line name given for the file, NULL if none
* dir Command line directory given for the file, NULL if none
* arg Name of the source file
* ext File name extension to use if 'name' is NULL
* global.params.preservePaths get output path from arg
* srcfile Input file - output file name must not match input file
*/
extern(D) FileName setOutfilename(const(char)[] name, const(char)[] dir, const(char)[] arg, const(char)[] ext)
{
const(char)[] docfilename;
if (name)
{
docfilename = name;
}
else
{
const(char)[] argdoc;
OutBuffer buf;
if (arg == "__stdin.d")
{
version (Posix)
import core.sys.posix.unistd : getpid;
else version (Windows)
import core.sys.windows.winbase : getpid = GetCurrentProcessId;
buf.printf("__stdin_%d.d", getpid());
arg = buf.peekSlice();
}
if (global.params.preservePaths)
argdoc = arg;
else
argdoc = FileName.name(arg);
// If argdoc doesn't have an absolute path, make it relative to dir
if (!FileName.absolute(argdoc))
{
//FileName::ensurePathExists(dir);
argdoc = FileName.combine(dir, argdoc);
}
docfilename = FileName.forceExt(argdoc, ext);
}
if (FileName.equals(docfilename, srcfile.toString()))
{
error("source file and output file have same name '%s'", srcfile.toChars());
fatal();
}
return FileName(docfilename);
}
extern (D) void setDocfile()
{
docfile = setOutfilename(global.params.docname.toDString, global.params.docdir.toDString, arg, global.doc_ext);
}
/**
* Loads the source buffer from the given read result into `this.srcBuffer`.
*
* Will take ownership of the buffer located inside `readResult`.
*
* Params:
* loc = the location
* readResult = the result of reading a file containing the source code
*
* Returns: `true` if successful
*/
bool loadSourceBuffer(const ref Loc loc, ref File.ReadResult readResult)
{
//printf("Module::loadSourceBuffer('%s') file '%s'\n", toChars(), srcfile.toChars());
// take ownership of buffer
srcBuffer = new FileBuffer(readResult.extractData());
if (readResult.success)
return true;
if (FileName.equals(srcfile.toString(), "object.d"))
{
.error(loc, "cannot find source code for runtime library file 'object.d'");
errorSupplemental(loc, "dmd might not be correctly installed. Run 'dmd -man' for installation instructions.");
const dmdConfFile = global.inifilename.length ? FileName.canonicalName(global.inifilename) : "not found";
errorSupplemental(loc, "config file: %.*s", cast(int)dmdConfFile.length, dmdConfFile.ptr);
}
else
{
// if module is not named 'package' but we're trying to read 'package.d', we're looking for a package module
bool isPackageMod = (strcmp(toChars(), "package") != 0) && (strcmp(srcfile.name(), "package.d") == 0 || (strcmp(srcfile.name(), "package.di") == 0));
if (isPackageMod)
.error(loc, "importing package '%s' requires a 'package.d' file which cannot be found in '%s'", toChars(), srcfile.toChars());
else
error(loc, "is in file '%s' which cannot be read", srcfile.toChars());
}
if (!global.gag)
{
/* Print path
*/
if (global.path)
{
foreach (i, p; *global.path)
fprintf(stderr, "import path[%llu] = %s\n", cast(ulong)i, p);
}
else
fprintf(stderr, "Specify path to file '%s' with -I switch\n", srcfile.toChars());
fatal();
}
return false;
}
/**
* Reads the file from `srcfile` and loads the source buffer.
*
* Params:
* loc = the location
*
* Returns: `true` if successful
* See_Also: loadSourceBuffer
*/
bool read(const ref Loc loc)
{
if (srcBuffer)
return true; // already read
//printf("Module::read('%s') file '%s'\n", toChars(), srcfile.toChars());
auto readResult = File.read(srcfile.toChars());
return loadSourceBuffer(loc, readResult);
}
/// syntactic parse
Module parse()
{
scope diagnosticReporter = new StderrDiagnosticReporter(global.params.useDeprecated);
return parse!ASTCodegen(diagnosticReporter);
}
/// ditto
extern (D) Module parse(AST)(DiagnosticReporter diagnosticReporter)
{
enum Endian { little, big}
enum SourceEncoding { utf16, utf32}
/*
* Convert a buffer from UTF32 to UTF8
* Params:
* Endian = is the buffer big/little endian
* buf = buffer of UTF32 data
* Returns:
* input buffer reencoded as UTF8
*/
char[] UTF32ToUTF8(Endian endian)(const(char)[] buf)
{
static if (endian == Endian.little)
alias readNext = Port.readlongLE;
else
alias readNext = Port.readlongBE;
if (buf.length & 3)
{
error("odd length of UTF-32 char source %u", buf.length);
fatal();
}
const (uint)[] eBuf = cast(const(uint)[])buf;
OutBuffer dbuf;
dbuf.reserve(eBuf.length);
foreach (i; 0 .. eBuf.length)
{
const u = readNext(&eBuf[i]);
if (u & ~0x7F)
{
if (u > 0x10FFFF)
{
error("UTF-32 value %08x greater than 0x10FFFF", u);
fatal();
}
dbuf.writeUTF8(u);
}
else
dbuf.writeByte(u);
}
dbuf.writeByte(0); //add null terminator
return dbuf.extractSlice();
}
/*
* Convert a buffer from UTF16 to UTF8
* Params:
* Endian = is the buffer big/little endian
* buf = buffer of UTF16 data
* Returns:
* input buffer reencoded as UTF8
*/
char[] UTF16ToUTF8(Endian endian)(const(char)[] buf)
{
static if (endian == Endian.little)
alias readNext = Port.readwordLE;
else
alias readNext = Port.readwordBE;
if (buf.length & 1)
{
error("odd length of UTF-16 char source %u", buf.length);
fatal();
}
const (ushort)[] eBuf = cast(const(ushort)[])buf;
OutBuffer dbuf;
dbuf.reserve(eBuf.length);
//i will be incremented in the loop for high codepoints
foreach (ref i; 0 .. eBuf.length)
{
uint u = readNext(&eBuf[i]);
if (u & ~0x7F)
{
if (0xD800 <= u && u < 0xDC00)
{
i++;
if (i >= eBuf.length)
{
error("surrogate UTF-16 high value %04x at end of file", u);
fatal();
}
const u2 = readNext(&eBuf[i]);
if (u2 < 0xDC00 || 0xE000 <= u2)
{
error("surrogate UTF-16 low value %04x out of range", u2);
fatal();
}
u = (u - 0xD7C0) << 10;
u |= (u2 - 0xDC00);
}
else if (u >= 0xDC00 && u <= 0xDFFF)
{
error("unpaired surrogate UTF-16 value %04x", u);
fatal();
}
else if (u == 0xFFFE || u == 0xFFFF)
{
error("illegal UTF-16 value %04x", u);
fatal();
}
dbuf.writeUTF8(u);
}
else
dbuf.writeByte(u);
}
dbuf.writeByte(0); //add a terminating null byte
return dbuf.extractSlice();
}
const(char)* srcname = srcfile.toChars();
//printf("Module::parse(srcname = '%s')\n", srcname);
isPackageFile = (strcmp(srcfile.name(), "package.d") == 0 ||
strcmp(srcfile.name(), "package.di") == 0);
const(char)[] buf = cast(const(char)[]) srcBuffer.data;
bool needsReencoding = true;
bool hasBOM = true; //assume there's a BOM
Endian endian;
SourceEncoding sourceEncoding;
if (buf.length >= 2)
{
/* Convert all non-UTF-8 formats to UTF-8.
* BOM : http://www.unicode.org/faq/utf_bom.html
* 00 00 FE FF UTF-32BE, big-endian
* FF FE 00 00 UTF-32LE, little-endian
* FE FF UTF-16BE, big-endian
* FF FE UTF-16LE, little-endian
* EF BB BF UTF-8
*/
if (buf[0] == 0xFF && buf[1] == 0xFE)
{
endian = Endian.little;
sourceEncoding = buf.length >= 4 && buf[2] == 0 && buf[3] == 0
? SourceEncoding.utf32
: SourceEncoding.utf16;
}
else if (buf[0] == 0xFE && buf[1] == 0xFF)
{
endian = Endian.big;
sourceEncoding = SourceEncoding.utf16;
}
else if (buf.length >= 4 && buf[0] == 0 && buf[1] == 0 && buf[2] == 0xFE && buf[3] == 0xFF)
{
endian = Endian.big;
sourceEncoding = SourceEncoding.utf32;
}
else if (buf.length >= 3 && buf[0] == 0xEF && buf[1] == 0xBB && buf[2] == 0xBF)
{
needsReencoding = false;//utf8 with BOM
}
else
{
/* There is no BOM. Make use of Arcane Jill's insight that
* the first char of D source must be ASCII to
* figure out the encoding.
*/
hasBOM = false;
if (buf.length >= 4 && buf[1] == 0 && buf[2] == 0 && buf[3] == 0)
{
endian = Endian.little;
sourceEncoding = SourceEncoding.utf32;
}
else if (buf.length >= 4 && buf[0] == 0 && buf[1] == 0 && buf[2] == 0)
{
endian = Endian.big;
sourceEncoding = SourceEncoding.utf32;
}
else if (buf.length >= 2 && buf[1] == 0) //try to check for UTF-16
{
endian = Endian.little;
sourceEncoding = SourceEncoding.utf16;
}
else if (buf[0] == 0)
{
endian = Endian.big;
sourceEncoding = SourceEncoding.utf16;
}
else {
// It's UTF-8
needsReencoding = false;
if (buf[0] >= 0x80)
{
error("source file must start with BOM or ASCII character, not \\x%02X", buf[0]);
fatal();
}
}
}
//throw away BOM
if (hasBOM)
{
if (!needsReencoding) buf = buf[3..$];// utf-8 already
else if (sourceEncoding == SourceEncoding.utf32) buf = buf[4..$];
else buf = buf[2..$]; //utf 16
}
}
// Assume the buffer is from memory and has not be read from disk. Assume UTF-8.
else if (buf.length >= 1 && (buf[0] == '\0' || buf[0] == 0x1A))
needsReencoding = false;
//printf("%s, %d, %d, %d\n", srcfile.name.toChars(), needsReencoding, endian == Endian.little, sourceEncoding == SourceEncoding.utf16);
if (needsReencoding)
{
if (sourceEncoding == SourceEncoding.utf16)
{
buf = endian == Endian.little
? UTF16ToUTF8!(Endian.little)(buf)
: UTF16ToUTF8!(Endian.big)(buf);
}
else
{
buf = endian == Endian.little
? UTF32ToUTF8!(Endian.little)(buf)
: UTF32ToUTF8!(Endian.big)(buf);
}
}
/* If it starts with the string "Ddoc", then it's a documentation
* source file.
*/
if (buf.length>= 4 && buf[0..4] == "Ddoc")
{
comment = buf.ptr + 4;
isDocFile = true;
if (!docfile)
setDocfile();
return this;
}
/* If it has the extension ".dd", it is also a documentation
* source file. Documentation source files may begin with "Ddoc"
* but do not have to if they have the .dd extension.
* https://issues.dlang.org/show_bug.cgi?id=15465
*/
if (FileName.equalsExt(arg, "dd"))
{
comment = buf.ptr; // the optional Ddoc, if present, is handled above.
isDocFile = true;
if (!docfile)
setDocfile();
return this;
}
/* If it has the extension ".di", it is a "header" file.
*/
if (FileName.equalsExt(arg, "di"))
{
isHdrFile = true;
}
{
scope p = new Parser!AST(this, buf, cast(bool) docfile, diagnosticReporter);
p.nextToken();
members = p.parseModule();
md = p.md;
numlines = p.scanloc.linnum;
if (p.errors)
++global.errors;
}
srcBuffer.destroy();