summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorClombrong <clombrong@egregore.fun>2025-04-19 12:51:26 +0200
committerClombrong <cromblong@egregore.fun>2025-04-19 12:51:26 +0200
commit4dc8b3c4019549378bbf59a85b54a7eef9f55855 (patch)
treed6f7cc9e6a9abed32d920934421a5da5b06c10c2
init: Oh no. This one is real.
add README and COPYING license files instantiate all dune stanzas setup dune with guix shell and direnv, using merlin for project setup
-rw-r--r--.dir-locals.el5
-rw-r--r--.envrc5
-rw-r--r--.gitignore29
-rw-r--r--COPYING165
-rw-r--r--README.md15
-rw-r--r--dune-project30
-rw-r--r--flesh.opam32
-rw-r--r--lib/dune3
-rw-r--r--manifest.scm15
-rw-r--r--test/dune2
-rw-r--r--test/flesh.ml0
11 files changed, 301 insertions, 0 deletions
diff --git a/.dir-locals.el b/.dir-locals.el
new file mode 100644
index 0000000..31be82f
--- /dev/null
+++ b/.dir-locals.el
@@ -0,0 +1,5 @@
+((nil
+ (eval
+ . (let ((opam-share (car (process-lines "opam" "var" "share"))))
+ (when (and opam-share (file-directory-p opam-share))
+ (add-to-list 'load-path (expand-file-name "emacs/site-lisp" opam-share)))))))
diff --git a/.envrc b/.envrc
new file mode 100644
index 0000000..d7e0600
--- /dev/null
+++ b/.envrc
@@ -0,0 +1,5 @@
+eval $(guix shell --search-paths)
+eval $(opam env)
+# OCaml needs this to locate some shims.
+export OCAMLPATH=$OPAM_SWITCH_PREFIX/lib:$OCAMLPATH
+export EMACSLOADPATH="$(opam var share)/emacs/site-lisp:$EMACSLOADPATH"
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..a18e084
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,29 @@
+*.annot
+*.cmo
+*.cma
+*.cmi
+*.a
+*.o
+*.cmx
+*.cmxs
+*.cmxa
+
+# ocamlbuild working directory
+_build/
+
+# ocamlbuild targets
+*.byte
+*.native
+
+# oasis generated files
+setup.data
+setup.log
+
+# Merlin configuring file for Vim and Emacs
+.merlin
+
+# Dune generated files
+*.install
+
+# Local OPAM switch
+_opam/
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..0a04128
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,165 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+ This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+ 0. Additional Definitions.
+
+ As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+ "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+ An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+ A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+ The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+ The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+ 1. Exception to Section 3 of the GNU GPL.
+
+ You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+ 2. Conveying Modified Versions.
+
+ If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+ a) under this License, provided that you make a good faith effort to
+ ensure that, in the event an Application does not supply the
+ function or data, the facility still operates, and performs
+ whatever part of its purpose remains meaningful, or
+
+ b) under the GNU GPL, with none of the additional permissions of
+ this License applicable to that copy.
+
+ 3. Object Code Incorporating Material from Library Header Files.
+
+ The object code form of an Application may incorporate material from
+a header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+ a) Give prominent notice with each copy of the object code that the
+ Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the object code with a copy of the GNU GPL and this license
+ document.
+
+ 4. Combined Works.
+
+ You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+ a) Give prominent notice with each copy of the Combined Work that
+ the Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
+ document.
+
+ c) For a Combined Work that displays copyright notices during
+ execution, include the copyright notice for the Library among
+ these notices, as well as a reference directing the user to the
+ copies of the GNU GPL and this license document.
+
+ d) Do one of the following:
+
+ 0) Convey the Minimal Corresponding Source under the terms of this
+ License, and the Corresponding Application Code in a form
+ suitable for, and under terms that permit, the user to
+ recombine or relink the Application with a modified version of
+ the Linked Version to produce a modified Combined Work, in the
+ manner specified by section 6 of the GNU GPL for conveying
+ Corresponding Source.
+
+ 1) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (a) uses at run time
+ a copy of the Library already present on the user's computer
+ system, and (b) will operate properly with a modified version
+ of the Library that is interface-compatible with the Linked
+ Version.
+
+ e) Provide Installation Information, but only if you would otherwise
+ be required to provide such information under section 6 of the
+ GNU GPL, and only to the extent that such information is
+ necessary to install and execute a modified version of the
+ Combined Work produced by recombining or relinking the
+ Application with a modified version of the Linked Version. (If
+ you use option 4d0, the Installation Information must accompany
+ the Minimal Corresponding Source and Corresponding Application
+ Code. If you use option 4d1, you must provide the Installation
+ Information in the manner specified by section 6 of the GNU GPL
+ for conveying Corresponding Source.)
+
+ 5. Combined Libraries.
+
+ You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+ a) Accompany the combined library with a copy of the same work based
+ on the Library, uncombined with any other library facilities,
+ conveyed under the terms of this License.
+
+ b) Give prominent notice with the combined library that part of it
+ is a work based on the Library, and explaining where to find the
+ accompanying uncombined form of the same work.
+
+ 6. Revised Versions of the GNU Lesser General Public License.
+
+ The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+ If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9554d9d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# Flesh interface
+
+> I will always regard the first instance of a flesh interface to have occurred in
+> [Triblenka](https://en.wikipedia.org/wiki/Treblinka_extermination_camp), 1944. The geologic disturbances, partial
+> tunnels, so-called interdimensionality, and wealth of clearly segmented bodies leave no doubt of its existence. The
+> Soviets have documented this.
+
+_Flesh_ (or Flesh interface) is a high-level, cross-platform XMPP library, developed in pure OCaml.
+
+One of the goals of _Flesh_ is to have code that can run natively on major operating systems, and compile with
+Js_of_ocaml for use in web applications.
+
+Later, it should be able to use Wasm_of_ocaml too.
+
+OMEMO support is not a goal currently, but will be in the future.
diff --git a/dune-project b/dune-project
new file mode 100644
index 0000000..a100b3e
--- /dev/null
+++ b/dune-project
@@ -0,0 +1,30 @@
+(lang dune 3.11)
+
+(name flesh)
+
+(generate_opam_files true)
+
+(source
+ (uri "git+https://forge.fsky.io/clombrong/flesh.git"))
+
+(authors "Clombrong")
+
+(maintainers "Clombrong")
+
+(license LGPL-3.0-or-later)
+
+(homepage "https://forge.fsky.io/clombrong/flesh")
+(bug_reports "https://forge.fsky.io/clombrong/flesh/issues")
+
+(package
+ (name flesh)
+ (synopsis "High-level XMPP flesh interface")
+ (description "An high-level XMPP library based on Lwt, compilable to native code and JS.")
+ (depends
+ ocaml
+ dune
+ (merlin :with-test))
+ (tags
+ (xmpp lwt)))
+
+; See the complete stanza docs at https://dune.readthedocs.io/en/stable/dune-files.html#dune-project
diff --git a/flesh.opam b/flesh.opam
new file mode 100644
index 0000000..48f2406
--- /dev/null
+++ b/flesh.opam
@@ -0,0 +1,32 @@
+# This file is generated by dune, edit dune-project instead
+opam-version: "2.0"
+synopsis: "High-level XMPP flesh interface"
+description:
+ "An high-level XMPP library based on Lwt, compilable to native code and JS."
+maintainer: ["Clombrong"]
+authors: ["Clombrong"]
+license: "LGPL-3.0-or-later"
+tags: ["xmpp" "lwt"]
+homepage: "https://forge.fsky.io/clombrong/flesh"
+bug-reports: "https://forge.fsky.io/clombrong/flesh/issues"
+depends: [
+ "ocaml"
+ "dune" {>= "3.11"}
+ "merlin" {with-test}
+ "odoc" {with-doc}
+]
+build: [
+ ["dune" "subst"] {dev}
+ [
+ "dune"
+ "build"
+ "-p"
+ name
+ "-j"
+ jobs
+ "@install"
+ "@runtest" {with-test}
+ "@doc" {with-doc}
+ ]
+]
+dev-repo: "git+https://forge.fsky.io/clombrong/flesh.git"
diff --git a/lib/dune b/lib/dune
new file mode 100644
index 0000000..2c76709
--- /dev/null
+++ b/lib/dune
@@ -0,0 +1,3 @@
+(library
+ (public_name flesh)
+ (name flesh))
diff --git a/manifest.scm b/manifest.scm
new file mode 100644
index 0000000..95b77fd
--- /dev/null
+++ b/manifest.scm
@@ -0,0 +1,15 @@
+;; What follows is a "manifest" equivalent to the command line you gave.
+;; You can store it in a file that you may then pass to any 'guix' command
+;; that accepts a '--manifest' (or '-m') option.
+
+(use-modules (guix transformations))
+
+(define ocaml-latest
+ (options->transformation
+ '((with-version . "ocaml=5.3.0"))))
+
+(packages->manifest
+ (list (specification->package "gcc-toolchain")
+ (ocaml-latest (specification->package "ocaml"))
+ (specification->package "opam")
+ (specification->package "node")))
diff --git a/test/dune b/test/dune
new file mode 100644
index 0000000..e273eab
--- /dev/null
+++ b/test/dune
@@ -0,0 +1,2 @@
+(test
+ (name flesh))
diff --git a/test/flesh.ml b/test/flesh.ml
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/test/flesh.ml