summaryrefslogtreecommitdiffstats
path: root/toolkit/components/ctypes/ctypes.jsm
diff options
context:
space:
mode:
Diffstat (limited to 'toolkit/components/ctypes/ctypes.jsm')
-rw-r--r--toolkit/components/ctypes/ctypes.jsm23
1 files changed, 23 insertions, 0 deletions
diff --git a/toolkit/components/ctypes/ctypes.jsm b/toolkit/components/ctypes/ctypes.jsm
new file mode 100644
index 000000000..f22d01184
--- /dev/null
+++ b/toolkit/components/ctypes/ctypes.jsm
@@ -0,0 +1,23 @@
+/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */
+/* 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/. */
+
+this.EXPORTED_SYMBOLS = [ "ctypes" ];
+
+/*
+ * This is the js module for ctypes. Import it like so:
+ * Components.utils.import("resource://gre/modules/ctypes.jsm");
+ *
+ * This will create a 'ctypes' object, which provides an interface to describe
+ * and instantiate C types and call C functions from a dynamic library.
+ *
+ * For documentation on the API, see:
+ * https://developer.mozilla.org/en/js-ctypes/js-ctypes_reference
+ *
+ */
+
+// Initialize the ctypes object. You do not need to do this yourself.
+const init = Components.classes["@mozilla.org/jsctypes;1"].createInstance();
+init();
+