DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Mercurial (7cdabf0e8c3b)

VCS Links

Line Code
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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/. */

/**
 * Synchronous front-end for the JavaScript OS.File library.
 * Windows implementation.
 *
 * This front-end is meant to be imported by a worker thread.
 */

/* eslint-env mozilla/chrome-worker, node */
/* global OS */

// eslint-disable-next-line no-lone-blocks
{
  if (typeof Components != "undefined") {
    // We do not wish osfile_win_front.jsm to be used directly as a main thread
    // module yet.
    throw new Error(
      "osfile_win_front.jsm cannot be used from the main thread yet"
    );
  }

  (function(exports) {
    "use strict";

    // exports.OS.Win is created by osfile_win_back.jsm
    if (exports.OS && exports.OS.File) {
      return; // Avoid double-initialization
    }

    let SharedAll = require("resource://gre/modules/osfile/osfile_shared_allthreads.jsm");
    let Path = require("resource://gre/modules/osfile/ospath.jsm");
    let SysAll = require("resource://gre/modules/osfile/osfile_win_allthreads.jsm");
    exports.OS.Win.File._init();
    let Const = exports.OS.Constants.Win;
    let WinFile = exports.OS.Win.File;
    let Type = WinFile.Type;

    // Mutable thread-global data
    // In the Windows implementation, methods |read| and |write|
    // require passing a pointer to an uint32 to determine how many
    // bytes have been read/written. In C, this is a benigne operation,
    // but in js-ctypes, this has a cost. Rather than re-allocating a
    // C uint32 and a C uint32* for each |read|/|write|, we take advantage
    // of the fact that the state is thread-private -- hence that two
    // |read|/|write| operations cannot take place at the same time --
    // and we use the following global mutable values:
    let gBytesRead = new ctypes.uint32_t(0);
    let gBytesReadPtr = gBytesRead.address();
    let gBytesWritten = new ctypes.uint32_t(0);
    let gBytesWrittenPtr = gBytesWritten.address();

    // Same story for GetFileInformationByHandle
    let gFileInfo = new Type.FILE_INFORMATION.implementation();
    let gFileInfoPtr = gFileInfo.address();

    /**
     * Representation of a file.
     *
     * You generally do not need to call this constructor yourself. Rather,
     * to open a file, use function |OS.File.open|.
     *
     * @param fd A OS-specific file descriptor.
     * @param {string} path File path of the file handle, used for error-reporting.
     * @constructor
     */
    let File = function File(fd, path) {
      exports.OS.Shared.AbstractFile.call(this, fd, path);
      this._closeResult = null;
    };
    File.prototype = Object.create(exports.OS.Shared.AbstractFile.prototype);

    /**
     * Close the file.
     *
     * This method has no effect if the file is already closed. However,
     * if the first call to |close| has thrown an error, further calls
     * will throw the same error.
     *
     * @throws File.Error If closing the file revealed an error that could
     * not be reported earlier.
     */
    File.prototype.close = function close() {
      if (this._fd) {
        let fd = this._fd;
        this._fd = null;
        // Call |close(fd)|, detach finalizer if any
        // (|fd| may not be a CDataFinalizer if it has been
        // instantiated from a controller thread).
        let result = WinFile._CloseHandle(fd);
        if (typeof fd == "object" && "forget" in fd) {
          fd.forget();
        }
        if (result == -1) {
          this._closeResult = new File.Error(
            "close",
            ctypes.winLastError,
            this._path
          );
        }
      }
      if (this._closeResult) {
        throw this._closeResult;
      }
    };

    /**
     * Read some bytes from a file.
     *
     * @param {C pointer} buffer A buffer for holding the data
     * once it is read.
     * @param {number} nbytes The number of bytes to read. It must not
     * exceed the size of |buffer| in bytes but it may exceed the number
     * of bytes unread in the file.
     * @param {*=} options Additional options for reading. Ignored in
     * this implementation.
     *
     * @return {number} The number of bytes effectively read. If zero,
     * the end of the file has been reached.
     * @throws {OS.File.Error} In case of I/O error.
     */
    File.prototype._read = function _read(buffer, nbytes, options) {
      // |gBytesReadPtr| is a pointer to |gBytesRead|.
      throw_on_zero(
        "read",
        WinFile.ReadFile(this.fd, buffer, nbytes, gBytesReadPtr, null),
        this._path
      );
      return gBytesRead.value;
    };

    /**
     * Write some bytes to a file.
     *
     * @param {Typed array} buffer A buffer holding the data that must be
     * written.
     * @param {number} nbytes The number of bytes to write. It must not
     * exceed the size of |buffer| in bytes.
     * @param {*=} options Additional options for writing. Ignored in
     * this implementation.
     *
     * @return {number} The number of bytes effectively written.
     * @throws {OS.File.Error} In case of I/O error.
     */
    File.prototype._write = function _write(buffer, nbytes, options) {
      if (this._appendMode) {
        // Need to manually seek on Windows, as O_APPEND is not supported.
        // This is, of course, a race, but there is no real way around this.
        this.setPosition(0, File.POS_END);
      }
      // |gBytesWrittenPtr| is a pointer to |gBytesWritten|.
      throw_on_zero(
        "write",
        WinFile.WriteFile(this.fd, buffer, nbytes, gBytesWrittenPtr, null),
        this._path
      );
      return gBytesWritten.value;
    };

    /**
     * Return the current position in the file.
     */
    File.prototype.getPosition = function getPosition(pos) {
      return this.setPosition(0, File.POS_CURRENT);
    };

    /**
     * Change the current position in the file.
     *
     * @param {number} pos The new position. Whether this position
     * is considered from the current position, from the start of
     * the file or from the end of the file is determined by
     * argument |whence|.  Note that |pos| may exceed the length of
     * the file.
     * @param {number=} whence The reference position. If omitted
     * or |OS.File.POS_START|, |pos| is relative to the start of the
     * file.  If |OS.File.POS_CURRENT|, |pos| is relative to the
     * current position in the file. If |OS.File.POS_END|, |pos| is
     * relative to the end of the file.
     *
     * @return The new position in the file.
     */
    File.prototype.setPosition = function setPosition(pos, whence) {
      if (whence === undefined) {
        whence = Const.FILE_BEGIN;
      }
      let pos64 = ctypes.Int64(pos);
      // Per MSDN, while |lDistanceToMove| (low) is declared as int32_t, when
      // providing |lDistanceToMoveHigh| as well, it should countain the
      // bottom 32 bits of the 64-bit integer. Hence the following |posLo|
      // cast is OK.
      let posLo = new ctypes.uint32_t(ctypes.Int64.lo(pos64));
      posLo = ctypes.cast(posLo, ctypes.int32_t);
      let posHi = new ctypes.int32_t(ctypes.Int64.hi(pos64));
      let result = WinFile.SetFilePointer(
        this.fd,
        posLo.value,
        posHi.address(),
        whence
      );
      // INVALID_SET_FILE_POINTER might be still a valid result, as it
      // represents the lower 32 bit of the int64 result. MSDN says to check
      // both, INVALID_SET_FILE_POINTER and a non-zero winLastError.
      if (result == Const.INVALID_SET_FILE_POINTER && ctypes.winLastError) {
        throw new File.Error("setPosition", ctypes.winLastError, this._path);
      }
      pos64 = ctypes.Int64.join(posHi.value, result);
      return Type.int64_t.project(pos64);
    };

    /**
     * Fetch the information on the file.
     *
     * @return File.Info The information on |this| file.
     */
    File.prototype.stat = function stat() {
      throw_on_zero(
        "stat",
        WinFile.GetFileInformationByHandle(this.fd, gFileInfoPtr),
        this._path
      );
      return new File.Info(gFileInfo, this._path);
    };

    /**
     * Set the last access and modification date of the file.
     * The time stamp resolution is 1 second at best, but might be worse
     * depending on the platform.
     *
     * @param {Date,number=} accessDate The last access date. If numeric,
     * milliseconds since epoch. If omitted or null, then the current date
     * will be used.
     * @param {Date,number=} modificationDate The last modification date. If
     * numeric, milliseconds since epoch. If omitted or null, then the current
     * date will be used.
     *
     * @throws {TypeError} In case of invalid parameters.
     * @throws {OS.File.Error} In case of I/O error.
     */
    File.prototype.setDates = function setDates(accessDate, modificationDate) {
      accessDate = Date_to_FILETIME(
        "File.prototype.setDates",
        accessDate,
        this._path
      );
      modificationDate = Date_to_FILETIME(
        "File.prototype.setDates",
        modificationDate,
        this._path
      );
      throw_on_zero(
        "setDates",
        WinFile.SetFileTime(
          this.fd,
          null,
          accessDate.address(),
          modificationDate.address()
        ),
        this._path
      );
    };

    /**
     * Set the file's access permission bits.
     */
    File.prototype.setPermissions = function setPermissions(options = {}) {
      if (!("winAttributes" in options)) {
        return;
      }
      let oldAttributes = WinFile.GetFileAttributes(this._path);
      if (oldAttributes == Const.INVALID_FILE_ATTRIBUTES) {
        throw new File.Error("setPermissions", ctypes.winLastError, this._path);
      }
      let newAttributes = toFileAttributes(
        options.winAttributes,
        oldAttributes
      );
      throw_on_zero(
        "setPermissions",
        WinFile.SetFileAttributes(this._path, newAttributes),
        this._path
      );
    };

    /**
     * Flushes the file's buffers and causes all buffered data
     * to be written.
     * Disk flushes are very expensive and therefore should be used carefully,
     * sparingly and only in scenarios where it is vital that data survives
     * system crashes. Even though the function will be executed off the
     * main-thread, it might still affect the overall performance of any
     * running application.
     *
     * @throws {OS.File.Error} In case of I/O error.
     */
    File.prototype.flush = function flush() {
      throw_on_zero("flush", WinFile.FlushFileBuffers(this.fd), this._path);
    };

    // The default sharing mode for opening files: files are not
    // locked against being reopened for reading/writing or against
    // being deleted by the same process or another process.
    // This is consistent with the default Unix policy.
    const DEFAULT_SHARE =
      Const.FILE_SHARE_READ | Const.FILE_SHARE_WRITE | Const.FILE_SHARE_DELETE;

    // The default flags for opening files.
    const DEFAULT_FLAGS = Const.FILE_ATTRIBUTE_NORMAL;

    /**
     * Open a file
     *
     * @param {string} path The path to the file.
     * @param {*=} mode The opening mode for the file, as
     * an object that may contain the following fields:
     *
     * - {bool} truncate If |true|, the file will be opened
     *  for writing. If the file does not exist, it will be
     *  created. If the file exists, its contents will be
     *  erased. Cannot be specified with |create|.
     * - {bool} create If |true|, the file will be opened
     *  for writing. If the file exists, this function fails.
     *  If the file does not exist, it will be created. Cannot
     *  be specified with |truncate| or |existing|.
     * - {bool} existing. If the file does not exist, this function
     *  fails. Cannot be specified with |create|.
     * - {bool} read If |true|, the file will be opened for
     *  reading. The file may also be opened for writing, depending
     *  on the other fields of |mode|.
     * - {bool} write If |true|, the file will be opened for
     *  writing. The file may also be opened for reading, depending
     *  on the other fields of |mode|.
     * - {bool} append If |true|, the file will be opened for appending,
     *  meaning the equivalent of |.setPosition(0, POS_END)| is executed
     *  before each write. The default is |true|, i.e. opening a file for
     *  appending. Specify |append: false| to open the file in regular mode.
     *
     * If neither |truncate|, |create| or |write| is specified, the file
     * is opened for reading.
     *
     * Note that |false|, |null| or |undefined| flags are simply ignored.
     *
     * @param {*=} options Additional options for file opening. This
     * implementation interprets the following fields:
     *
     * - {number} winShare If specified, a share mode, as per
     * Windows function |CreateFile|. You can build it from
     * constants |OS.Constants.Win.FILE_SHARE_*|. If unspecified,
     * the file uses the default sharing policy: it can be opened
     * for reading and/or writing and it can be removed by other
     * processes and by the same process.
     * - {number} winSecurity If specified, Windows security
     * attributes, as per Windows function |CreateFile|. If unspecified,
     * no security attributes.
     * - {number} winAccess If specified, Windows access mode, as
     * per Windows function |CreateFile|. This also requires option
     * |winDisposition| and this replaces argument |mode|. If unspecified,
     * uses the string |mode|.
     * - {number} winDisposition If specified, Windows disposition mode,
     * as per Windows function |CreateFile|. This also requires option
     * |winAccess| and this replaces argument |mode|. If unspecified,
     * uses the string |mode|.
     *
     * @return {File} A file object.
     * @throws {OS.File.Error} If the file could not be opened.
     */
    File.open = function Win_open(path, mode = {}, options = {}) {
      let share =
        options.winShare !== undefined ? options.winShare : DEFAULT_SHARE;
      let security = options.winSecurity || null;
      let flags =
        options.winFlags !== undefined ? options.winFlags : DEFAULT_FLAGS;
      let template = options.winTemplate ? options.winTemplate._fd : null;
      let access;
      let disposition;

      mode = OS.Shared.AbstractFile.normalizeOpenMode(mode);

      // The following option isn't a generic implementation of access to paths
      // of arbitrary lengths. It allows for the specific case of writing to an
      // Alternate Data Stream on a file whose path length is already close to
      // MAX_PATH. This implementation is safe with a full path as input, if
      // the first part of the path comes from local configuration and the
      // file without the ADS was successfully opened before, so we know the
      // path is valid.
      if (options.winAllowLengthBeyondMaxPathWithCaveats) {
        // Use the \\?\ syntax to allow lengths beyond MAX_PATH. This limited
        // implementation only supports a DOS local path or UNC path as input.
        let isUNC =
          path.length >= 2 &&
          (path[0] == "\\" || path[0] == "/") &&
          (path[1] == "\\" || path[1] == "/");
        let pathToUse = "\\\\?\\" + (isUNC ? "UNC\\" + path.slice(2) : path);
        // Use GetFullPathName to normalize slashes into backslashes. This is
        // required because CreateFile won't do this for the \\?\ syntax.
        let buffer_size = 512;
        let array = new (ctypes.ArrayType(ctypes.char16_t, buffer_size))();
        let expected_size = throw_on_zero(
          "open",
          WinFile.GetFullPathName(pathToUse, buffer_size, array, 0)
        );
        if (expected_size > buffer_size) {
          // We don't need to allow an arbitrary path length for now.
          throw new File.Error("open", ctypes.winLastError, path);
        }
        path = array.readString();
      }

      if ("winAccess" in options && "winDisposition" in options) {
        access = options.winAccess;
        disposition = options.winDisposition;
      } else if (
        ("winAccess" in options && !("winDisposition" in options)) ||
        (!("winAccess" in options) && "winDisposition" in options)
      ) {
        throw new TypeError(
          "OS.File.open requires either both options " +
            "winAccess and winDisposition or neither"
        );
      } else {
        if (mode.read) {
          access |= Const.GENERIC_READ;
        }
        if (mode.write) {
          access |= Const.GENERIC_WRITE;
        }
        // Finally, handle create/existing/trunc
        if (mode.trunc) {
          if (mode.existing) {
            // It seems that Const.TRUNCATE_EXISTING is broken
            // in presence of links (source, anyone?). We need
            // to open normally, then perform truncation manually.
            disposition = Const.OPEN_EXISTING;
          } else {
            disposition = Const.CREATE_ALWAYS;
          }
        } else if (mode.create) {
          disposition = Const.CREATE_NEW;
        } else if (mode.read && !mode.write) {
          disposition = Const.OPEN_EXISTING;
        } else if (mode.existing) {
          disposition = Const.OPEN_EXISTING;
        } else {
          disposition = Const.OPEN_ALWAYS;
        }
      }

      let file = error_or_file(
        WinFile.CreateFile(
          path,
          access,
          share,
          security,
          disposition,
          flags,
          template
        ),
        path
      );

      file._appendMode = !!mode.append;

      if (!(mode.trunc && mode.existing)) {
        return file;
      }
      // Now, perform manual truncation
      file.setPosition(0, File.POS_START);
      throw_on_zero("open", WinFile.SetEndOfFile(file.fd), path);
      return file;
    };

    /**
     * Checks if a file or directory exists
     *
     * @param {string} path The path to the file.
     *
     * @return {bool} true if the file exists, false otherwise.
     */
    File.exists = function Win_exists(path) {
      try {
        let file = File.open(path, FILE_STAT_MODE, FILE_STAT_OPTIONS);
        file.close();
        return true;
      } catch (x) {
        return false;
      }
    };

    /**
     * Remove an existing file.
     *
     * @param {string} path The name of the file.
     * @param {*=} options Additional options.
     *   - {bool} ignoreAbsent If |false|, throw an error if the file does
     *     not exist. |true| by default.
     *
     * @throws {OS.File.Error} In case of I/O error.
     */
    File.remove = function remove(path, options = {}) {
      if (WinFile.DeleteFile(path)) {
        return;
      }

      if (
        ctypes.winLastError == Const.ERROR_FILE_NOT_FOUND ||
        ctypes.winLastError == Const.ERROR_PATH_NOT_FOUND
      ) {
        if (!("ignoreAbsent" in options) || options.ignoreAbsent) {
          return;
        }
      } else if (ctypes.winLastError == Const.ERROR_ACCESS_DENIED) {
        // Save winLastError before another ctypes call.
        let lastError = ctypes.winLastError;
        let attributes = WinFile.GetFileAttributes(path);
        if (attributes != Const.INVALID_FILE_ATTRIBUTES) {
          if (!(attributes & Const.FILE_ATTRIBUTE_READONLY)) {
            throw new File.Error("remove", lastError, path);
          }
          let newAttributes = attributes & ~Const.FILE_ATTRIBUTE_READONLY;
          if (
            WinFile.SetFileAttributes(path, newAttributes) &&
            WinFile.DeleteFile(path)
          ) {
            return;
          }
        }
      }

      throw new File.Error("remove", ctypes.winLastError, path);
    };

    /**
     * Remove an empty directory.
     *
     * @param {string} path The name of the directory to remove.
     * @param {*=} options Additional options.
     *   - {bool} ignoreAbsent If |false|, throw an error if the directory
     *     does not exist. |true| by default
     */
    File.removeEmptyDir = function removeEmptyDir(path, options = {}) {
      let result = WinFile.RemoveDirectory(path);
      if (!result) {
        if (
          (!("ignoreAbsent" in options) || options.ignoreAbsent) &&
          ctypes.winLastError == Const.ERROR_FILE_NOT_FOUND
        ) {
          return;
        }
        throw new File.Error("removeEmptyDir", ctypes.winLastError, path);
      }
    };

    /**
     * Create a directory and, optionally, its parent directories.
     *
     * @param {string} path The name of the directory.
     * @param {*=} options Additional options. This
     * implementation interprets the following fields:
     *
     * - {C pointer} winSecurity If specified, security attributes
     * as per winapi function |CreateDirectory|. If unspecified,
     * use the default security descriptor, inherited from the
     * parent directory.
     * - {bool} ignoreExisting If |false|, throw an error if the directory
     * already exists. |true| by default
     * - {string} from If specified, the call to |makeDir| creates all the
     * ancestors of |path| that are descendants of |from|. Note that |from|
     * and its existing descendants must be user-writeable and that |path|
     * must be a descendant of |from|.
     * Example:
     *   makeDir(Path.join(profileDir, "foo", "bar"), { from: profileDir });
     *  creates directories profileDir/foo, profileDir/foo/bar
     */
    File._makeDir = function makeDir(path, options = {}) {
      let security = options.winSecurity || null;
      let result = WinFile.CreateDirectory(path, security);

      if (result) {
        return;
      }

      if ("ignoreExisting" in options && !options.ignoreExisting) {
        throw new File.Error("makeDir", ctypes.winLastError, path);
      }

      if (ctypes.winLastError == Const.ERROR_ALREADY_EXISTS) {
        return;
      }

      // If the user has no access, but it's a root directory, no error should be thrown
      let splitPath = OS.Path.split(path);
      // Removing last component if it's empty
      // An empty last component is caused by trailing slashes in path
      // This is always the case with root directories
      if (splitPath.components[splitPath.components.length - 1].length === 0) {
        splitPath.components.pop();
      }
      // One component consisting of a drive letter implies a directory root.
      if (
        ctypes.winLastError == Const.ERROR_ACCESS_DENIED &&
        splitPath.winDrive &&
        splitPath.components.length === 1
      ) {
        return;
      }

      throw new File.Error("makeDir", ctypes.winLastError, path);
    };

    /**
     * Copy a file to a destination.
     *
     * @param {string} sourcePath The platform-specific path at which
     * the file may currently be found.
     * @param {string} destPath The platform-specific path at which the
     * file should be copied.
     * @param {*=} options An object which may contain the following fields:
     *
     * @option {bool} noOverwrite - If true, this function will fail if
     * a file already exists at |destPath|. Otherwise, if this file exists,
     * it will be erased silently.
     *
     * @throws {OS.File.Error} In case of any error.
     *
     * General note: The behavior of this function is defined only when
     * it is called on a single file. If it is called on a directory, the
     * behavior is undefined and may not be the same across all platforms.
     *
     * General note: The behavior of this function with respect to metadata
     * is unspecified. Metadata may or may not be copied with the file. The
     * behavior may not be the same across all platforms.
     */
    File.copy = function copy(sourcePath, destPath, options = {}) {
      throw_on_zero(
        "copy",
        WinFile.CopyFile(sourcePath, destPath, options.noOverwrite || false),
        sourcePath
      );
    };

    /**
     * Move a file to a destination.
     *
     * @param {string} sourcePath The platform-specific path at which
     * the file may currently be found.
     * @param {string} destPath The platform-specific path at which the
     * file should be moved.
     * @param {*=} options An object which may contain the following fields:
     *
     * @option {bool} noOverwrite - If set, this function will fail if
     * a file already exists at |destPath|. Otherwise, if this file exists,
     * it will be erased silently.
     * @option {bool} noCopy - If set, this function will fail if the
     * operation is more sophisticated than a simple renaming, i.e. if
     * |sourcePath| and |destPath| are not situated on the same drive.
     *
     * @throws {OS.File.Error} In case of any error.
     *
     * General note: The behavior of this function is defined only when
     * it is called on a single file. If it is called on a directory, the
     * behavior is undefined and may not be the same across all platforms.
     *
     * General note: The behavior of this function with respect to metadata
     * is unspecified. Metadata may or may not be moved with the file. The
     * behavior may not be the same across all platforms.
     */
    File.move = function move(sourcePath, destPath, options = {}) {
      let flags = 0;
      if (!options.noCopy) {
        flags = Const.MOVEFILE_COPY_ALLOWED;
      }
      if (!options.noOverwrite) {
        flags = flags | Const.MOVEFILE_REPLACE_EXISTING;
      }
      throw_on_zero(
        "move",
        WinFile.MoveFileEx(sourcePath, destPath, flags),
        sourcePath
      );

      // Inherit NTFS permissions from the destination directory
      // if possible.
      if (Path.dirname(sourcePath) === Path.dirname(destPath)) {
        // Skip if the move operation was the simple rename,
        return;
      }
      // The function may fail for various reasons (e.g. not all
      // filesystems support NTFS permissions or the user may not
      // have the enough rights to read/write permissions).
      // However we can safely ignore errors. The file was already
      // moved. Setting permissions is not mandatory.
      let dacl = new ctypes.voidptr_t();
      let sd = new ctypes.voidptr_t();
      WinFile.GetNamedSecurityInfo(
        destPath,
        Const.SE_FILE_OBJECT,
        Const.DACL_SECURITY_INFORMATION,
        null /* sidOwner*/,
        null /* sidGroup*/,
        dacl.address(),
        null /* sacl*/,
        sd.address()
      );
      // dacl will be set only if the function succeeds.
      if (!dacl.isNull()) {
        WinFile.SetNamedSecurityInfo(
          destPath,
          Const.SE_FILE_OBJECT,
          Const.DACL_SECURITY_INFORMATION |
            Const.UNPROTECTED_DACL_SECURITY_INFORMATION,
          null /* sidOwner*/,
          null /* sidGroup*/,
          dacl,
          null /* sacl*/
        );
      }
      // sd will be set only if the function succeeds.
      if (!sd.isNull()) {
        WinFile.LocalFree(Type.HLOCAL.cast(sd));
      }
    };

    /**
     * A global value used to receive data during time conversions.
     */
    let gSystemTime = new Type.SystemTime.implementation();
    let gSystemTimePtr = gSystemTime.address();

    /**
     * Utility function: convert a FILETIME to a JavaScript Date.
     */
    let FILETIME_to_Date = function FILETIME_to_Date(fileTime, path) {
      if (fileTime == null) {
        throw new TypeError("Expecting a non-null filetime");
      }
      throw_on_zero(
        "FILETIME_to_Date",
        WinFile.FileTimeToSystemTime(fileTime.address(), gSystemTimePtr),
        path
      );
      // Windows counts hours, minutes, seconds from UTC,
      // JS counts from local time, so we need to go through UTC.
      let utc = Date.UTC(
        gSystemTime.wYear,
        gSystemTime.wMonth - 1,
        /* Windows counts months from 1, JS from 0*/ gSystemTime.wDay,
        gSystemTime.wHour,
        gSystemTime.wMinute,
        gSystemTime.wSecond,
        gSystemTime.wMilliSeconds
      );
      return new Date(utc);
    };

    /**
     * Utility function: convert Javascript Date to FileTime.
     *
     * @param {string} fn Name of the calling function.
     * @param {Date,number} date The date to be converted. If omitted or null,
     * then the current date will be used. If numeric, assumed to be the date
     * in milliseconds since epoch.
     */
    let Date_to_FILETIME = function Date_to_FILETIME(fn, date, path) {
      if (typeof date === "number") {
        date = new Date(date);
      } else if (!date) {
        date = new Date();
      } else if (typeof date.getUTCFullYear !== "function") {
        throw new TypeError(
          "|date| parameter of " +
            fn +
            " must be a " +
            "|Date| instance or number"
        );
      }
      gSystemTime.wYear = date.getUTCFullYear();
      // Windows counts months from 1, JS from 0.
      gSystemTime.wMonth = date.getUTCMonth() + 1;
      gSystemTime.wDay = date.getUTCDate();
      gSystemTime.wHour = date.getUTCHours();
      gSystemTime.wMinute = date.getUTCMinutes();
      gSystemTime.wSecond = date.getUTCSeconds();
      gSystemTime.wMilliseconds = date.getUTCMilliseconds();
      let result = new OS.Shared.Type.FILETIME.implementation();
      throw_on_zero(
        "Date_to_FILETIME",
        WinFile.SystemTimeToFileTime(gSystemTimePtr, result.address()),
        path
      );
      return result;
    };

    /**
     * Iterate on one directory.
     *
     * This iterator will not enter subdirectories.
     *
     * @param {string} path The directory upon which to iterate.
     * @param {*=} options An object that may contain the following field:
     * @option {string} winPattern Windows file name pattern; if set,
     * only files matching this pattern are returned.
     *
     * @throws {File.Error} If |path| does not represent a directory or
     * if the directory cannot be iterated.
     * @constructor
     */
    File.DirectoryIterator = function DirectoryIterator(path, options) {
      exports.OS.Shared.AbstractFile.AbstractIterator.call(this);
      if (options && options.winPattern) {
        this._pattern = path + "\\" + options.winPattern;
      } else {
        this._pattern = path + "\\*";
      }
      this._path = path;

      // Pre-open the first item.
      this._first = true;
      this._findData = new Type.FindData.implementation();
      this._findDataPtr = this._findData.address();
      this._handle = WinFile.FindFirstFile(this._pattern, this._findDataPtr);
      if (this._handle == Const.INVALID_HANDLE_VALUE) {
        let error = ctypes.winLastError;
        this._findData = null;
        this._findDataPtr = null;
        if (error == Const.ERROR_FILE_NOT_FOUND) {
          // Directory is empty, let's behave as if it were closed
          SharedAll.LOG("Directory is empty");
          this._closed = true;
          this._exists = true;
        } else if (error == Const.ERROR_PATH_NOT_FOUND) {
          // Directory does not exist, let's throw if we attempt to walk it
          SharedAll.LOG("Directory does not exist");
          this._closed = true;
          this._exists = false;
        } else {
          throw new File.Error("DirectoryIterator", error, this._path);
        }
      } else {
        this._closed = false;
        this._exists = true;
      }
    };

    File.DirectoryIterator.prototype = Object.create(
      exports.OS.Shared.AbstractFile.AbstractIterator.prototype
    );

    /**
     * Fetch the next entry in the directory.
     *
     * @return null If we have reached the end of the directory.
     */
    File.DirectoryIterator.prototype._next = function _next() {
      // Bailout if the directory does not exist
      if (!this._exists) {
        throw File.Error.noSuchFile(
          "DirectoryIterator.prototype.next",
          this._path
        );
      }
      // Bailout if the iterator is closed.
      if (this._closed) {
        return null;
      }
      // If this is the first entry, we have obtained it already
      // during construction.
      if (this._first) {
        this._first = false;
        return this._findData;
      }

      if (WinFile.FindNextFile(this._handle, this._findDataPtr)) {
        return this._findData;
      }
      let error = ctypes.winLastError;
      this.close();
      if (error == Const.ERROR_NO_MORE_FILES) {
        return null;
      }
      throw new File.Error("iter (FindNextFile)", error, this._path);
    };

    /**
     * Return the next entry in the directory, if any such entry is
     * available.
     *
     * Skip special directories "." and "..".
     *
     * @return By definition of the iterator protocol, either
     * `{value: {File.Entry}, done: false}` if there is an unvisited entry
     * in the directory, or `{value: undefined, done: true}`, otherwise.
     */
    File.DirectoryIterator.prototype.next = function next() {
      // FIXME: If we start supporting "\\?\"-prefixed paths, do not forget
      // that "." and ".." are absolutely normal file names if _path starts
      // with such prefix
      for (let entry = this._next(); entry != null; entry = this._next()) {
        let name = entry.cFileName.readString();
        if (name == "." || name == "..") {
          continue;
        }
        return {
          value: new File.DirectoryIterator.Entry(entry, this._path),
          done: false,
        };
      }
      return { value: undefined, done: true };
    };

    File.DirectoryIterator.prototype.close = function close() {
      if (this._closed) {
        return;
      }
      this._closed = true;
      if (this._handle) {
        // We might not have a handle if the iterator is closed
        // before being used.
        throw_on_zero("FindClose", WinFile.FindClose(this._handle), this._path);
        this._handle = null;
      }
    };

    /**
     * Determine whether the directory exists.
     *
     * @return {boolean}
     */
    File.DirectoryIterator.prototype.exists = function exists() {
      return this._exists;
    };

    File.DirectoryIterator.Entry = function Entry(win_entry, parent) {
      if (
        !win_entry.dwFileAttributes ||
        !win_entry.ftCreationTime ||
        !win_entry.ftLastAccessTime ||
        !win_entry.ftLastWriteTime
      ) {
        throw new TypeError();
      }

      // Copy the relevant part of |win_entry| to ensure that
      // our data is not overwritten prematurely.
      let isDir = !!(
        win_entry.dwFileAttributes & Const.FILE_ATTRIBUTE_DIRECTORY
      );
      let isSymLink = !!(
        win_entry.dwFileAttributes & Const.FILE_ATTRIBUTE_REPARSE_POINT
      );

      let winCreationDate = FILETIME_to_Date(
        win_entry.ftCreationTime,
        this._path
      );
      let winLastWriteDate = FILETIME_to_Date(
        win_entry.ftLastWriteTime,
        this._path
      );
      let winLastAccessDate = FILETIME_to_Date(
        win_entry.ftLastAccessTime,
        this._path
      );

      let name = win_entry.cFileName.readString();
      if (!name) {
        throw new TypeError("Empty name");
      }

      if (!parent) {
        throw new TypeError("Empty parent");
      }
      this._parent = parent;

      let path = Path.join(this._parent, name);

      SysAll.AbstractEntry.call(
        this,
        isDir,
        isSymLink,
        name,
        winCreationDate,
        winLastWriteDate,
        winLastAccessDate,
        path
      );
    };
    File.DirectoryIterator.Entry.prototype = Object.create(
      SysAll.AbstractEntry.prototype
    );

    /**
     * Return a version of an instance of
     * File.DirectoryIterator.Entry that can be sent from a worker
     * thread to the main thread. Note that deserialization is
     * asymmetric and returns an object with a different
     * implementation.
     */
    File.DirectoryIterator.Entry.toMsg = function toMsg(value) {
      if (!(value instanceof File.DirectoryIterator.Entry)) {
        throw new TypeError(
          "parameter of " +
            "File.DirectoryIterator.Entry.toMsg must be a " +
            "File.DirectoryIterator.Entry"
        );
      }
      let serialized = {};
      for (let key in File.DirectoryIterator.Entry.prototype) {
        serialized[key] = value[key];
      }
      return serialized;
    };

    /**
     * Information on a file.
     *
     * To obtain the latest information on a file, use |File.stat|
     * (for an unopened file) or |File.prototype.stat| (for an
     * already opened file).
     *
     * @constructor
     */
    File.Info = function Info(stat, path) {
      let isDir = !!(stat.dwFileAttributes & Const.FILE_ATTRIBUTE_DIRECTORY);
      let isSymLink = !!(
        stat.dwFileAttributes & Const.FILE_ATTRIBUTE_REPARSE_POINT
      );

      let winBirthDate = FILETIME_to_Date(stat.ftCreationTime, this._path);
      let lastAccessDate = FILETIME_to_Date(stat.ftLastAccessTime, this._path);
      let lastWriteDate = FILETIME_to_Date(stat.ftLastWriteTime, this._path);

      let value = ctypes.UInt64.join(stat.nFileSizeHigh, stat.nFileSizeLow);
      let size = Type.uint64_t.importFromC(value);
      let winAttributes = {
        readOnly: !!(stat.dwFileAttributes & Const.FILE_ATTRIBUTE_READONLY),
        system: !!(stat.dwFileAttributes & Const.FILE_ATTRIBUTE_SYSTEM),
        hidden: !!(stat.dwFileAttributes & Const.FILE_ATTRIBUTE_HIDDEN),
      };

      SysAll.AbstractInfo.call(
        this,
        path,
        isDir,
        isSymLink,
        size,
        winBirthDate,
        lastAccessDate,
        lastWriteDate,
        winAttributes
      );
    };
    File.Info.prototype = Object.create(SysAll.AbstractInfo.prototype);

    /**
     * Return a version of an instance of File.Info that can be sent
     * from a worker thread to the main thread. Note that deserialization
     * is asymmetric and returns an object with a different implementation.
     */
    File.Info.toMsg = function toMsg(stat) {
      if (!(stat instanceof File.Info)) {
        throw new TypeError("parameter of File.Info.toMsg must be a File.Info");
      }
      let serialized = {};
      for (let key in File.Info.prototype) {
        serialized[key] = stat[key];
      }
      return serialized;
    };

    /**
     * Fetch the information on a file.
     *
     * Performance note: if you have opened the file already,
     * method |File.prototype.stat| is generally much faster
     * than method |File.stat|.
     *
     * Platform-specific note: under Windows, if the file is
     * already opened without sharing of the read capability,
     * this function will fail.
     *
     * @return {File.Information}
     */
    File.stat = function