@qooxdoo/framework 7.9.2 → 8.0.0-beta.1

package/source/class/qx/core/check/ICheck.js

@@ -0,0 +1,75 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Type checking interface
+ */
+qx.Interface.define("qx.core.check.ICheck", {
+  members: {
+    /**
+     * Tests whether the value matches the compatibility constraints in this check
+     *
+     * @param {*} value
+     * @param {qx.core.Object} thisObj the object that the value is a property of
+     * @return {Boolean}
+     */
+    matches(value, thisObj) {},
+
+    /**
+     * Tests whether the value is nullable
+     *
+     * @return {Boolean}
+     */
+    isNullable() {},
+
+    /**
+     * By default, the references to the values (current, init, ...) of the
+     * property will be stored as references on the object. When disposing
+     * this object, the references will not be deleted. Setting the
+     * dereference key to true tells the property system to delete all
+     * connections made by this property on dispose. This can be necessary for
+     * disconnecting DOM objects to allow the garbage collector to work
+     *
+     * Properties can be explicitly set to dereference, but the ICheck allows the property
+     * to detect this, based on the type of the property.
+     *
+     * Most implementations will return `false`
+     *
+     * @return {Boolean}
+     */
+    needsDereference() {},
+
+    /**
+     * Tests whether this check is compatible with another check, ie this check
+     * is a subclass of the other check or directly compatible
+     *
+     * @param {qx.core.check.ICheck} check
+     * @return {boolean}
+     */
+    isCompatible(check) {},
+
+    /**
+     * Attempts to coerce the value to match the constraints in this check
+     *
+     * @param {*} value
+     * @param {qx.core.Object} thisObj the object that the value is a property of
+     * @return {* | null} the coerced value, or null if coercion is not possible
+     */
+    coerce(value, thisObj) {}
+  }
+});

package/source/class/qx/core/check/IsOneOfCheck.js

@@ -0,0 +1,63 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Implementation of check for any value
+ */
+qx.Bootstrap.define("qx.core.check.IsOneOfCheck", {
+  extend: qx.core.check.AbstractCheck,
+
+  construct(values, nullable) {
+    super(nullable);
+    this.__values = values;
+  },
+
+  members: {
+    /** @type{Array} list of allowed values */
+    __values: null,
+
+    /**
+     * @override
+     */
+    _matchesImpl(value) {
+      if (value === null) {
+        return null;
+      }
+
+      if (this.__values.indexOf(value) !== -1) {
+        return true;
+      }
+
+      return false;
+    },
+
+    /**
+     * @override
+     */
+    isCompatible(check) {
+      if (check instanceof qx.core.check.IsOneOfCheck) {
+        for (let i = 0; i < this.__values.length; i++) {
+          if (check.__values.indexOf(this.__values[i]) === -1) {
+            return false;
+          }
+        }
+      }
+      return true;
+    }
+  }
+});

package/source/class/qx/core/check/JsDocCheck.js

@@ -0,0 +1,71 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Implementation of check for any value
+ * @ignore(require)
+ */
+qx.Bootstrap.define("qx.core.check.JsDocCheck", {
+  extend: Object,
+  implement: qx.core.check.ICheck,
+
+  construct(jsdoc, nullable) {
+    super();
+    let s = "jsdoctypeparser";
+    const { parse } = require(s);
+    this.__ast = parse(jsdoc);
+    this.__nullable = nullable;
+  },
+
+  members: {
+    /** @type{*} the AST from jsdoctypeparser */
+    __ast: null,
+
+    /** @type{Boolean} whether null is allowed */
+    __nullable: null,
+
+    /**
+     * @override
+     */
+    matches(value) {
+      console.log(`JSDoc type checking is not yet implemented`);
+      return true;
+    },
+
+    /**
+     * @override
+     */
+    isNullable() {
+      return this.__nullable;
+    },
+
+    /**
+     * @override
+     */
+    isCompatible(check) {
+      return true;
+    },
+
+    /**
+     * @override
+     */
+    needsDereference() {
+      return false;
+    }
+  }
+});

package/source/class/qx/core/check/SimpleCheck.js

@@ -0,0 +1,42 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Type checking for basic, native types
+ */
+qx.Bootstrap.define("qx.core.check.SimpleCheck", {
+  extend: qx.core.check.AbstractCheck,
+  implement: qx.core.check.ICheck,
+
+  construct(matches, nullable) {
+    super(nullable);
+    this.__matches = matches;
+  },
+
+  members: {
+    /** @type{Function} passed a value and returns true if the value matches this check */
+    __matches: null,
+
+    /**
+     * @override
+     */
+    _matchesImpl(value, thisObj) {
+      return this.__matches.call(thisObj, value);
+    }
+  }
+});

package/source/class/qx/core/check/standard/ArrayCheck.js

@@ -0,0 +1,49 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Type checking for basic, native types
+ */
+qx.Bootstrap.define("qx.core.check.standard.ArrayCheck", {
+  extend: qx.core.check.AbstractCheck,
+
+  members: {
+    /**
+     * @override
+     */
+    _matchesImpl(value) {
+      return qx.lang.Type.isArray(value);
+    },
+
+    /**
+     * @override
+     */
+    _coerceImpl(value) {
+      if (value === null) {
+        return [];
+      }
+      if (qx.lang.Type.isArray(value)) {
+        return value;
+      }
+      if (value instanceof qx.data.Array) {
+        return value.toArray();
+      }
+      return [value];
+    }
+  }
+});

package/source/class/qx/core/check/standard/BooleanCheck.js

@@ -0,0 +1,47 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Type checking for basic, native types
+ */
+qx.Bootstrap.define("qx.core.check.standard.BooleanCheck", {
+  extend: qx.core.check.AbstractCheck,
+
+  members: {
+    /**
+     * @override
+     */
+    _matchesImpl(value) {
+      return qx.lang.Type.isBoolean(value);
+    },
+
+    /**
+     * @override
+     */
+    _coerceImpl(value) {
+      if (typeof value === "string") {
+        if (value === "true" || value === "1") {
+          return true;
+        }
+      } else if (typeof value === "number") {
+        return value !== 0;
+      }
+      return null;
+    }
+  }
+});

package/source/class/qx/core/check/standard/ClassCheck.js

@@ -0,0 +1,33 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Type checking for basic, native types
+ */
+qx.Bootstrap.define("qx.core.check.standard.ClassCheck", {
+  extend: qx.core.check.AbstractCheck,
+
+  members: {
+    /**
+     * @override
+     */
+    _matchesImpl(value) {
+      return value.$$type === "Class";
+    }
+  }
+});

package/source/class/qx/core/check/standard/ColorCheck.js

@@ -0,0 +1,33 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Type checking for basic, native types
+ */
+qx.Bootstrap.define("qx.core.check.standard.ColorCheck", {
+  extend: qx.core.check.AbstractCheck,
+
+  members: {
+    /**
+     * @override
+     */
+    _matchesImpl(value) {
+      return qx.lang.Type.isString(value) && qx.util.ColorUtil.isValidPropertyValue(value);
+    }
+  }
+});

package/source/class/qx/core/check/standard/DateCheck.js

@@ -0,0 +1,49 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Type checking for basic, native types
+ */
+qx.Bootstrap.define("qx.core.check.standard.DateCheck", {
+  extend: qx.core.check.AbstractCheck,
+
+  members: {
+    /**
+     * @override
+     */
+    _matchesImpl(value) {
+      return value instanceof Date;
+    },
+
+    /**
+     * @override
+     */
+    _coerceImpl(value) {
+      if (value === null) {
+        return null;
+      }
+      if (value instanceof Date) {
+        return value;
+      }
+      if (typeof value === "string" || qx.lang.Type.isNumber(value)) {
+        return new Date(value);
+      }
+      return null;
+    }
+  }
+});

package/source/class/qx/core/check/standard/DecoratorCheck.js

@@ -0,0 +1,33 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Type checking for basic, native types
+ */
+qx.Bootstrap.define("qx.core.check.standard.DecoratorCheck", {
+  extend: qx.core.check.AbstractCheck,
+
+  members: {
+    /**
+     * @override
+     */
+    _matchesImpl(value) {
+      return qx.theme.manager.Decoration.getInstance().isValidPropertyValue(value);
+    }
+  }
+});

package/source/class/qx/core/check/standard/DocumentCheck.js

@@ -0,0 +1,40 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Type checking for basic, native types
+ */
+qx.Bootstrap.define("qx.core.check.standard.DocumentCheck", {
+  extend: qx.core.check.AbstractCheck,
+
+  members: {
+    /**
+     * @override
+     */
+    _matchesImpl(value) {
+      return value.nodeType === 9 && !!value.documentElement;
+    },
+
+    /**
+     * @override
+     */
+    needsDereference() {
+      return true;
+    }
+  }
+});

package/source/class/qx/core/check/standard/ElementCheck.js

@@ -0,0 +1,40 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Type checking for basic, native types
+ */
+qx.Bootstrap.define("qx.core.check.standard.ElementCheck", {
+  extend: qx.core.check.AbstractCheck,
+
+  members: {
+    /**
+     * @override
+     */
+    _matchesImpl(value) {
+      return value.nodeType === 1 && !!value.attributes;
+    },
+
+    /**
+     * @override
+     */
+    needsDereference() {
+      return true;
+    }
+  }
+});

package/source/class/qx/core/check/standard/ErrorCheck.js

@@ -0,0 +1,46 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Type checking for basic, native types
+ */
+qx.Bootstrap.define("qx.core.check.standard.ErrorCheck", {
+  extend: qx.core.check.AbstractCheck,
+
+  members: {
+    /**
+     * @override
+     */
+    _matchesImpl(value) {
+      return value instanceof Error;
+    },
+
+    /**
+     * @override
+     */
+    _coerceImpl(value) {
+      if (value === null) {
+        return null;
+      }
+      if (value instanceof Error) {
+        return value;
+      }
+      return new Error(String(value));
+    }
+  }
+});

package/source/class/qx/core/check/standard/EventCheck.js

@@ -0,0 +1,40 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Type checking for basic, native types
+ */
+qx.Bootstrap.define("qx.core.check.standard.EventCheck", {
+  extend: qx.core.check.AbstractCheck,
+
+  members: {
+    /**
+     * @override
+     */
+    _matchesImpl(value) {
+      return value.type !== undefined;
+    },
+
+    /**
+     * @override
+     */
+    needsDereference() {
+      return true;
+    }
+  }
+});

package/source/class/qx/core/check/standard/FontCheck.js

@@ -0,0 +1,33 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Type checking for basic, native types
+ */
+qx.Bootstrap.define("qx.core.check.standard.FontCheck", {
+  extend: qx.core.check.AbstractCheck,
+
+  members: {
+    /**
+     * @override
+     */
+    _matchesImpl(value) {
+      return qx.theme.manager.Font.getInstance().isDynamic(value);
+    }
+  }
+});