v1.31.0 marks our first transition to ES6 classes, but only for PDPjs initially (which is why there must be both /lib and /es6 files in the shared folder for now)

2016-12-18 11:31:53 -08:00 · 2016-12-18 11:31:53 -08:00 · f4f6181923
commit f4f6181923
parent dcdedb3513
999 changed files with 22351 additions and 211342 deletions
--- a/modules/shared/es6/dumpapi.js
+++ b/modules/shared/es6/dumpapi.js
@ -0,0 +1,85 @@
+/**
+ * @fileoverview Disk APIs, as defined by diskdump.js and consumed by disk.js
+ * @author <a href="mailto:Jeff@pcjs.org">Jeff Parsons</a>
+ * @copyright © Jeff Parsons 2012-2016
+ *
+ * This file is part of PCjs, a computer emulation software project at <http://pcjs.org/>.
+ *
+ * PCjs is free software: you can redistribute it and/or modify it under the terms of the
+ * GNU General Public License as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * PCjs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+ * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with PCjs.  If not,
+ * see <http://www.gnu.org/licenses/gpl.html>.
+ *
+ * You are required to include the above copyright notice in every modified copy of this work
+ * and to display that copyright notice when the software starts running; see COPYRIGHT in
+ * <http://pcjs.org/modules/shared/lib/defines.js>.
+ *
+ * Some PCjs files also attempt to load external resource files, such as character-image files,
+ * ROM files, and disk image files. Those external resource files are not considered part of PCjs
+ * for purposes of the GNU General Public License, and the author does not claim any copyright
+ * as to their contents.
+ */
+
+"use strict";
+
+/*
+ * Our "DiskDump API", such as it was, used to look like:
+ *
+ *      http://jsmachines.net/bin/convdisk.php?disk=/disks/pc/dos/ibm/2.00/PCDOS200-DISK1.json&format=img
+ *
+ * To make it (a bit) more "REST-like", the above request now looks like:
+ *
+ *      http://www.pcjs.org/api/v1/dump?disk=/disks/pc/dos/ibm/2.00/PCDOS200-DISK1.json&format=img
+ *
+ * Similarly, our "FileDump API" used to look like:
+ *
+ *      http://jsmachines.net/bin/convrom.php?rom=/devices/pc/rom/5150/1981-04-24/PCBIOS-REV1.rom&format=json
+ *
+ * and that request now looks like:
+ *
+ *      http://www.pcjs.org/api/v1/dump?file=/devices/pc/rom/5150/1981-04-24/PCBIOS-REV1.rom&format=json
+ *
+ * I don't think it makes sense to avoid "query" parameters, because blending the path of a disk image with the
+ * the rest of the URL would be (a) confusing, and (b) more work to parse.
+ */
+var DumpAPI = {
+    ENDPOINT:       "/api/v1/dump",
+    QUERY: {
+        DIR:        "dir",      // value is path of a directory (DiskDump only)
+        DISK:       "disk",     // value is path of a disk image (DiskDump only)
+        FILE:       "file",     // value is path of a ROM image file (FileDump only)
+        IMG:        "img",      // alias for DISK
+        PATH:       "path",     // value is path of a one or more files (DiskDump only)
+        FORMAT:     "format",   // value is one of FORMAT values below
+        COMMENTS:   "comments", // value is either "true" or "false"
+        DECIMAL:    "decimal",  // value is either "true" to force all numbers to decimal, "false" or undefined otherwise
+        MBHD:       "mbhd",     // value is hard drive size in Mb (formerly "mbsize") (DiskDump only) (DEPRECATED)
+        SIZE:       "size"      // value is target disk size in Kb (supersedes "mbhd") (DiskDump only)
+    },
+    FORMAT: {
+        JSON:       "json",     // default
+        JSON_GZ:    "gz",       // gzip is currently used ONLY for compressed JSON
+        DATA:       "data",     // same as "json", but built without JSON.stringify() (DiskDump only)
+        HEX:        "hex",      // deprecated
+        OCTAL:      "octal",    // displays data as octal words
+        BYTES:      "bytes",    // displays data as hex bytes; normally used only when comments are enabled
+        WORDS:      "words",    // displays data as hex words; normally used only when comments are enabled
+        IMG:        "img",      // returns the raw disk data (ie, using a Buffer object) (DiskDump only)
+        ROM:        "rom"       // returns the raw file data (ie, using a Buffer object) (FileDump only)
+    }
+};
+
+/*
+ * Because we use an overloaded API endpoint (ie, one that's shared with the FileDump module), we must
+ * also provide a list of commands which, when combined with the endpoint, define a unique request.
+ */
+DumpAPI.asDiskCommands = [DumpAPI.QUERY.DIR, DumpAPI.QUERY.DISK, DumpAPI.QUERY.PATH];
+DumpAPI.asFileCommands = [DumpAPI.QUERY.FILE];
+
+export default DumpAPI;