Moving repo to github

- Remove the need for -maes, silence warning about ignored option on ARM macs
- Set -mmacos-version-min when building wasm3 to match that of the platform layer and runtime

.clang-format

@@ -24,7 +24,6 @@ BraceWrapping:
   AfterEnum: true
   AfterFunction: true
   AfterNamespace: true
-  AfterObjCDeclaration: true
   AfterStruct: true
   AfterObjCDeclaration: true
   AfterUnion: true

.gitignore

@@ -14,6 +14,7 @@ build
 *.wasm
 *.app
 *.dylib
+*.a
 
 Debug/*
 
@@ -35,6 +36,8 @@ src/graphics/orca_gl31.h
 __pycache__
 scripts/files
 
-ext/angle
+# explicitly abandon old ext dir
+/ext
+src/ext/angle
 
-sketches/*/bin
+sketches/*/bin

FUNDING.yml

@@ -0,0 +1,2 @@
+github: orca-app
+custom: "https://orca-app.dev/sponsor.html"

LICENSE.txt

@@ -1,678 +1,207 @@
-Orca
+                                    Orca
 
-Copyright (C) 2023 Martin Fouilleul and the Orca project contributors
+Copyright (C) 2023 Martin Fouilleul
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as
-published by the Free Software Foundation version 3, with additional
-terms under section 7 of the GNU Affero General Public License version
-3, as published at the end of this document.
-
-This program 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 Affero General Public License for more details.
+Orca is distributed under the MIT license or the Apache License version 2.0,
+at your option.
 
 -------------------------------------------------------------------------------
-                               AGPLv3 LICENSE
+
+                                MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
 -------------------------------------------------------------------------------
 
-                    GNU AFFERO GENERAL PUBLIC LICENSE
-                       Version 3, 19 November 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.
-
-                            Preamble
-
-  The GNU Affero General Public License is a free, copyleft license for
-software and other kinds of works, specifically designed to ensure
-cooperation with the community in the case of network server software.
-
-  The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works.  By contrast,
-our General Public Licenses are intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  Developers that use our General Public Licenses protect your rights
-with two steps: (1) assert copyright on the software, and (2) offer
-you this License which gives you legal permission to copy, distribute
-and/or modify the software.
-
-  A secondary benefit of defending all users' freedom is that
-improvements made in alternate versions of the program, if they
-receive widespread use, become available for other developers to
-incorporate.  Many developers of free software are heartened and
-encouraged by the resulting cooperation.  However, in the case of
-software used on network servers, this result may fail to come about.
-The GNU General Public License permits making a modified version and
-letting the public access it on a server without ever releasing its
-source code to the public.
-
-  The GNU Affero General Public License is designed specifically to
-ensure that, in such cases, the modified source code becomes available
-to the community.  It requires the operator of a network server to
-provide the source code of the modified version running there to the
-users of that server.  Therefore, public use of a modified version, on
-a publicly accessible server, gives the public access to the source
-code of the modified version.
-
-  An older license, called the Affero General Public License and
-published by Affero, was designed to accomplish similar goals.  This is
-a different license, not a version of the Affero GPL, but Affero has
-released a new version of the Affero GPL which permits relicensing under
-this license.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU Affero General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Remote Network Interaction; Use with the GNU General Public License.
-
-  Notwithstanding any other provision of this License, if you modify the
-Program, your modified version must prominently offer all users
-interacting with it remotely through a computer network (if your version
-supports such interaction) an opportunity to receive the Corresponding
-Source of your version by providing access to the Corresponding Source
-from a network server at no charge, through some standard or customary
-means of facilitating copying of software.  This Corresponding Source
-shall include the Corresponding Source for any work covered by version 3
-of the GNU General Public License that is incorporated pursuant to the
-following paragraph.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the work with which it is combined will remain governed by version
-3 of the GNU General Public License.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU Affero 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
-Program specifies that a certain numbered version of the GNU Affero General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU Affero General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU Affero General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
---------------------------------------------------------------------------------
-                          ADDITIONAL TERMS
---------------------------------------------------------------------------------
-
-1. Pursuant to section 7(b) of the AGPLv3, we require the preservation of the legal
-notices, copyright notices and author attributions in the program and in its
-documentation and in the Appropriate Legal Notices displayed by works containing
-it.
-
-2. Pursuant to Section 7(c) of the AGPLv3, we require that modified versions of the
-material should be marked in a reasonable way as different from the official
-version.
-
-Any modified material being redistributed must include a prominent and conveniently
-accessible feature for the display of a Modified Material Notice including the statement
-"This program is using a modified version of the Orca Runtime version VERSION_NUMBER
-released on RELEASE_DATE.
-
-The string VERSION_NUMBER should be replaced with the exact version number of
-the Program on which the modified material is based.
-The string RELEASE_DATE should be replaced with the full date of the release of
-the version VERSION_NUMBER of the Program on which the
-modified material is based.
-
-The Modified Material Notice must be clearly visible with size of the fonts
-and icons proportionate to the user interface being used.
-
-The Modified Material Notice must be in the same language of the user interface.
-
-3. Additional permission for WebAssembly modules used by the Program.
-The Program works by loading and running WebAssembly modules written by third parties.
-To make this work, portions of the Program must be compiled into these WebAssembly modules,
-making them covered work under the terms of this license.
-
-As an additional permission, WebAssembly modules including unmodified portions of
-the Program to the sole purpose of being bundled with and run by an unmodified version
-of the Program can be distributed under the terms of their author's choice, without being
-bound by the requirements of this license. This permission does not extend to modifications
-of the Program itself or its development libraries.
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

Readme.md

@@ -1,128 +1,2 @@
-------
-**DISCLAIMER: This project is very much a Work In Progress. We are making it accessible in this very early state so that participants in the [2023 Wheel Reinvention Jam](https://handmade.network/jam/2023) can try it out and possibly use it as their jamming platform. Expect bugs, missing and/or incomplete features, unstable APIs, and sparse documentation. Some current issues might be a show stopper for you, so make sure you can build and run the sample apps before jumping in.**
+**This repository is not used anymore. Development of Orca was moved here: [https://github.com/orca-app/orca](https://github.com/orca-app/orca)**
 
-**If you do choose to try out Orca anyway, thank you! We'll do our best to answer your questions, and we'd really appreciate your feedback!**
-
-------
-
-# Orca
-
-Orca is a development platform and runtime environment for cross-platform, sandboxed graphical WebAssembly applications. In this early MVP you can:
-
-- Receive mouse and keyboard input.
-- Draw paths, images and text using a 2D vector graphics API.
-- Draw 2D/3D graphics using OpenGL ES 3.1 (minus a few features)
-- Build user interfaces using our UI API and default widgets.
-- Read and write files using a capability-based API.
-
-## Installing
-
-The Orca command-line tools must be installed to your system in order to use them in your own projects.
-
-**At this early stage, you must build Orca yourself - in the future, this installation process will be streamlined.**
-
-### Requirements
-
-- Windows or Mac (Linux is not yet supported)
-- [Python 3](https://www.python.org/) (for command line tools)
-- Clang
-	- **Windows users:** `clang` can be installed via the Visual Studio installer. Search for "C++ Clang Compiler".
-	- **Mac users:** Apple's built-in `clang` does not support WebAssembly. We recommend installing `clang` via [Homebrew](https://brew.sh/) with `brew install clang`.
-- MSVC (Visual Studio 2022 17.5 or newer) (Windows only)
-	- This can be installed through the [Visual Studio Community](https://visualstudio.microsoft.com/) installer.
-	- Please note the version requirement! Orca requires C11 atomics, which were only added to MSVC in late 2022.
-
-### Installation instructions
-
-Clone the repo, then `cd` into the `orca` directory:
-
-```
-git clone git@git.handmade.network:hmn/orca.git
-cd orca
-```
-
-Build the Orca runtime:
-
-```
-./orca dev build-runtime
-```
-
-Install the Orca dev tools. If on Windows, the tool can automatically add `orca` to your PATH. Otherwise, you must manually add the Orca install directory to your PATH, e.g. by updating `.zshrc` or `.bashrc`.
-
-```
-./orca dev install
-```
-
-Finally, verify that Orca is successfully installed by running the `orca version` command. Note the lack of `./`!
-
-```
-orca version
-```
-
-If you encounter any errors, see the FAQ below.
-
-Once the `orca` tools are installed, you can use them from anywhere to
-
-### Building the sample Orca apps
-
-The `samples` directory contains several sample apps that demonstrate various Orca features. To build one, `cd` to a sample project's directory and run its build script. For example, for the `breakout` sample:
-
-```
-cd samples/breakout
-# Windows
-build.bat
-# Mac
-./build.sh
-```
-
-On Windows this creates a `Breakout` directory in `samples/breakout`. You can launch the app by running `Breakout/bin/Breakout.exe`. On macOS this creates a `Breakout.app` bundle in `samples/breakout` that you can double-click to run.
-
-## Writing an Orca app
-
-Orca apps are WebAssembly modules that use the Orca APIs. The process for creating an Orca application is:
-
-1. Compile a WebAssembly module using your language and toolchain of choice.
-2. Bundle the WebAssembly module into a native executable using the Orca command-line tools.
-
-For a more thorough overview, please read the [Quick Start Guide](./doc/QuickStart.md), which will walk you through building a simple application.
-
-The following additional resources may also help you familiarize yourself with Orca and its APIs:
-
-- The [samples folder](./samples) contains sample applications that show various aspects of the Orca API and support library:
-	- [`breakout`](./samples/breakout) is a small breakout game making use of the vector graphics API.
-	- [`clock`](./samples/clock) is a simple clock showcasing vector graphics and the time API.
-	- [`triangle`](./samples/triangle) shows how to draw a spinning triangle using the GLES API.
-	- [`fluid`](./samples/fluid) is a fluid simulation using a more complex GLES setup.
-	- [`ui`](./samples/ui) showcases the UI API and Orca's default UI widgets.  
-- The [API Cheatsheets](./doc/cheatsheets) provide a list of Orca API functions, grouped by topic.
-
-## FAQ
-
-**What platforms does Orca supports?**
-
-We currently support Windows 10 and up, and macOS 10.15 and up.
-
-**What languages can I use with Orca?**
-
-In principle, you can use any language and toolchain that can produce a WebAssembly module and bind to the Orca APIs. However, several important parts of Orca, such as the UI, are provided as part of the support library, which must be compiled to WebAssembly with you app, and is written in C. Therefore, at this early stage, it may be difficult to use any language other than C.
-
-C-style C++ is possible but requires compiling the support library in C as a separate object file, and then adding that object to your compile command when building your app.
-
-We're currently working with contributors to add support for Odin and Zig, and we look forward to expanding the number of officially-supported languages in the future. 
-
-**I am getting errors about atomics when building the runtime on Windows.**
-
-Please ensure that you have the latest version of Visual Studio and MSVC installed. The Orca runtime requires the use of C11 atomics, which were not added to MSVC until late 2022.
-
-**I am getting errors saying that `orca` is not found.**
-
-Please ensure that you have installed Orca to your system per the installation instructions above. Please also ensure that the Orca install directory is on your PATH. The installation path is printed when running `./orca dev install`.
-
-## License
-
-Orca is distributed under the terms of the GNU Affero General Public License version 3, with additional terms in accordance with section 7 of AGPLv3. These additional terms ensure that:
-
-- Modified versions of Orca must reasonably inform users that they are modified.
-- You can distribute your application's WebAssembly modules under the terms of your choice, and are not required to license them under the terms of the AGPLv3.
-
-Copyright and License details can be found in [LICENSE.txt](./LICENSE.txt)

doc/QuickStart.md

@@ -6,51 +6,86 @@
 --------
 
 # Orca Quick Start Guide
----
 
-This is a short introduction to developping an application that can be run by the Orca runtime. We'll present the basic structure of an Orca application, and walk through a simple example in C.
+This is a short introduction to developing an application that can be run by the Orca runtime. We'll present the basic structure of an Orca application, and walk through a simple example in C.
+
+## What is an Orca app?
+
+An Orca app is a WebAssembly module designed for the Orca runtime. Your app interacts with the Orca runtime via WebAssembly imports and exports. For example, you can import functions from the Orca runtime to get user input, and export functions to the Orca runtime to draw to the screen.
+
+Orca also ships with a core library, written in C, which facilitates interaction with the Orca runtime and provides features like UI. This library should be compiled along with your app as part of producing your WebAssembly module.
+
+You can, in principle, write an Orca app in any programming language that supports WebAssembly. However, at this early stage, C is the only officially supported language.
+
+![Basic structure of a C app](images/app_c.png)
+
+Once you have compiled your WebAssembly module, you can bundle this module into an executable using the `orca bundle` command. The application bundle can include images, fonts, or any other private data that the app needs in order to function. These files can be read or written from the app without asking the user for permission. The resulting Orca executables are therefore self-contained.
+
+![Example Orca application bundle](images/app_bundle.png)
 
 ## Basic structure
 
 Orca exposes a number of types and functions to applications. In order to use them the first thing to do is to include `orca.h`.
 
-```
+```c
 #include<orca.h>
 ```
 
 The Orca runtime manages the application's window and event loop. In order to receive a specific kind of event, you can define an associated _event handler_ and export it to the runtime. For instance, to be notified when your application's window is resized, you should define the `oc_on_resize()` handler:
 
-```
+```c
 ORCA_EXPORT void oc_on_resize(u32 width, u32 height)
 {
 	// handle the window resize event
 }
 ```
 
-The `ORCA_EXPORT` macro makes the handler visible to the orca runtime, which automatically binds it to the window resize event.
+The `ORCA_EXPORT` macro makes the handler visible to the Orca runtime, which automatically binds it to the window resize event.
 
-Handlers are optional. If you don't care about an event, you can just omit the associated handler. You probably want to define at least two important handlers:
+Handlers are optional. If you don't care about an event, you can just omit the associated handler. However, you will almost certainly want to define at least two important handlers:
 
-- `oc_on_init()` is called once when your application starts and can be use to initialize your application's resources
+- `oc_on_init()` is called once when your application starts and can be use to initialize your application's resources.
 - `oc_on_frame_refresh()` is called when your application needs to render a new frame, typically tied to the refresh rate of the monitor.
 
 For a list of available handlers and their signatures, see the [app cheatsheet](../doc/cheatsheets/cheatsheet_app.h).
 
 
-## Clock Example
+## Clock example
 
 Let's look at the [clock example](../samples/clock). This is a simple app that shows an analog clock and showcases a couple of interesting Orca APIs.
 
-Open [`main.c`](../samples/clock/src/main.c) and look at the definition of `oc_on_init()`. This handler is called when the applications starts, right after the application window has been created.
+Open [`main.c`](../samples/clock/src/main.c) and look at the definition of `oc_on_init()`. This handler is called when the application starts, right after the application window has been created.
 
 The first thing we do here is set the title and dimensions of the window. We then create the graphics resources that we'll use to draw the clock onto the window.
 
+```c
+ORCA_EXPORT void oc_on_init(void)
+{
+    oc_window_set_title(OC_STR8("clock"));
+    oc_window_set_size((oc_vec2){ .x = 400, .y = 400 });
+    // ...
+}
+```
+
 ### Graphics surfaces
 
-The next line of `oc_init()` creates a _graphics surface_. A surface represents a destination you can draw into using a specific API. In this sample, we're going to use a canvas surface, which allows drawing with a 2D vector graphics API. Other samples use a GLES surface to draw with the OpenGL ES API.
+The next line of `oc_on_init()` creates a _graphics surface_. A surface represents a destination you can draw into using a specific API. In this sample, we're going to use a canvas surface, which allows drawing with a 2D vector graphics API. Other samples use a GLES surface to draw with the OpenGL ES API.
 
 Before drawing into it, the surface must be selected as the current surface by calling `oc_surface_select()`. Once all drawing is done you can display the result by calling `oc_surface_present()`.
 
+```c
+oc_surface surface = { 0 };
+oc_canvas canvas = { 0 };
+
+ORCA_EXPORT void oc_on_init(void)
+{
+    // ...
+    surface = oc_surface_canvas();
+    canvas = oc_canvas_create();
+    // ...
+}
+```
+
 ### Canvas
 
 After creating the surface, we create a _canvas_. A canvas holds some context for drawing commands, like the current color or stroke width, as well as a command buffer that records all drawing commands. All canvas drawing functions use an implicit _current canvas_. You can select a canvas to be the current canvas by calling `oc_canvas_select()`, as seen at the begining of `oc_on_frame_refresh()`.
@@ -59,14 +94,17 @@ Canvas drawing functions like `oc_fill()` or `oc_stroke` merely add to the curre
 
 To summarize, the general structure of canvas drawing code is like the following:
 
-```
-oc_canvas_select(canvas); // make the canvas current
+```c
+ORCA_EXPORT void oc_on_frame_refresh(void)
+{
+    oc_canvas_select(canvas); // make the canvas current
 
-//... add commands to the canvas command buffer using drawing functions
+    //... add commands to the canvas command buffer using drawing functions
 
-oc_surface_select(surface);  // select the canvas surface
-oc_render(canvas);           // render the canvas commands into it
-oc_surface_present(surface); // display the result
+    oc_surface_select(surface);  // select the canvas surface
+    oc_render(canvas);           // render the canvas commands into it
+    oc_surface_present(surface); // display the result
+}
 ```
 
 ### Drawing
@@ -74,17 +112,16 @@ oc_surface_present(surface); // display the result
 Canvas drawing functions can be roughly divided into three groups:
 
 - Path functions like `oc_line_to()` or `oc_cubic_to()` are used to specify paths using lines and curves.
-- Attributes setup functions like `oc_set_color()` or `oc_set_width()` are used to set attributes used by subsequent commands.
+- Attribute setup functions like `oc_set_color()` or `oc_set_width()` are used to set attributes used by subsequent commands.
 - Command functions like `oc_stroke()` and `oc_fill()` encode commands into the canvas command buffer using the current path and attributes.
 
 Some helpers combine a path specification and a command, like `oc_circle_fill()`.
 
 As an example, the back of the clock is drawn using these two calls:
 
-```
-	// clock backing
-    oc_set_color_rgba(1, 1, 1, 1);
-    oc_circle_fill(centerX, centerY, clockRadius);
+```c
+oc_set_color_rgba(1, 1, 1, 1);
+oc_circle_fill(centerX, centerY, clockRadius);
 ```
 
 For a list of canvas drawing functions, see the [graphics API cheatsheet](../doc/cheatsheets/cheatsheet_graphics.h).
@@ -100,30 +137,30 @@ The matrix on the top of the stack at the time a command is encoded is used to t
 
 You can see an example of using transform matrices when drawing the clock's hands:
 
-```
-    // hours hand
-    oc_matrix_multiply_push(mat_transform(centerX, centerY, hoursRotation));
-    {
-        oc_set_color_rgba(.2, 0.2, 0.2, 1);
-        oc_rounded_rectangle_fill(0, -7.5 * uiScale, clockRadius * 0.5f, 15 * uiScale, 5 * uiScale);
-    }
-    oc_matrix_pop();
+```c
+// hour hand
+oc_matrix_multiply_push(mat_transform(centerX, centerY, hoursRotation));
+{
+    oc_set_color_rgba(.2, 0.2, 0.2, 1);
+    oc_rounded_rectangle_fill(0, -7.5 * uiScale, clockRadius * 0.5f, 15 * uiScale, 5 * uiScale);
+}
+oc_matrix_pop();
 ```
 
 ### Fonts and text
 
 Going back to `oc_init()`, after creating a surface and a canvas, we create a font that we will use to draw the numbers on the clock's face:
 
-```
-    oc_unicode_range ranges[5] = {
-        OC_UNICODE_BASIC_LATIN,
-        OC_UNICODE_C1_CONTROLS_AND_LATIN_1_SUPPLEMENT,
-        OC_UNICODE_LATIN_EXTENDED_A,
-        OC_UNICODE_LATIN_EXTENDED_B,
-        OC_UNICODE_SPECIALS
-    };
+```c
+oc_unicode_range ranges[5] = {
+    OC_UNICODE_BASIC_LATIN,
+    OC_UNICODE_C1_CONTROLS_AND_LATIN_1_SUPPLEMENT,
+    OC_UNICODE_LATIN_EXTENDED_A,
+    OC_UNICODE_LATIN_EXTENDED_B,
+    OC_UNICODE_SPECIALS
+};
 
-    font = oc_font_create_from_path(OC_STR8("/segoeui.ttf"), 5, ranges);
+font = oc_font_create_from_path(OC_STR8("/segoeui.ttf"), 5, ranges);
 ```
 
 The font is loaded from a font file located in a data folder inside the app bundle. By default, Orca apps use this data folder as their "root" for file operations.
@@ -132,35 +169,37 @@ Along with the path of the font file, we pass to the creation function the unico
 
 We then use the font to draw the clock's face:
 
-```
-    // clock face
-    for(int i = 0; i < oc_array_size(clockNumberStrings); ++i)
-    {
-        oc_rect textRect = oc_text_bounding_box(font, fontSize, clockNumberStrings[i]);
-        textRect.h -= 10 * uiScale; // oc_text_bounding_box height doesn't seem to be a tight fit around the glyph
+```c
+// clock face
+for(int i = 0; i < oc_array_size(clockNumberStrings); ++i)
+{
+    oc_rect textRect = oc_font_text_metrics(font, fontSize, clockNumberStrings[i]).ink;
 
-        const f32 angle = i * ((M_PI * 2) / 12.0f) - (M_PI / 2);
-        oc_mat2x3 transform = mat_transform(centerX - (textRect.w / 2), centerY + (textRect.h / 2), angle);
-        oc_vec2 pos = oc_mat2x3_mul(transform, (oc_vec2){ clockRadius * 0.8f, 0 });
+    const f32 angle = i * ((M_PI * 2) / 12.0f) - (M_PI / 2);
+    oc_mat2x3 transform = mat_transform(centerX - (textRect.w / 2) - textRect.x,
+                                        centerY - (textRect.h / 2) - textRect.y,
+                                        angle);
 
-        oc_set_color_rgba(0.2, 0.2, 0.2, 1);
-        oc_text_fill(pos.x, pos.y, clockNumberStrings[i]);
-    }
+    oc_vec2 pos = oc_mat2x3_mul(transform, (oc_vec2){ clockRadius * 0.8f, 0 });
+
+    oc_set_color_rgba(0.2, 0.2, 0.2, 1);
+    oc_text_fill(pos.x, pos.y, clockNumberStrings[i]);
+}
 ```
 
 ### Logging and asserts
 
-The runtime has a console overlay whose visiblity can be toggled on and off with `Shift + Cmd + D` on macOS, or `Shift + Ctrl + D` on Windows. Your application can log messages, warnings or errors to that console using the following functions:
+The runtime has a console overlay whose visiblity can be toggled on and off with `⌘ + Shift + D` on macOS, or `Ctrl + Shift + D` on Windows. Your application can log messages, warnings, or errors to that console using the following functions:
 
-```
+```c
 void oc_log_info(const char* fmt, ...);    // informational messages
 void oc_log_warning(const char* fmt, ...); // warnings, displayed in orange.
-void oc_log_error(const char* fmt, ...);  // errors, displayed in red.
+void oc_log_error(const char* fmt, ...);   // errors, displayed in red.
 ```
 
 If you started the application from a terminal, the log entries are also duplicated there.
 
-You can assert on a condition using `OC_ASSERT(test, fmt, ...)`. If the test fails, the runtime displays a message box including your message, and terminates the application.
+You can assert on a condition using `OC_ASSERT(test, fmt, ...)`. If the test fails, the runtime displays a message box and terminates the application.
 
 You can unconditionally abort the application with a message box using `OC_ABORT(fmt, ...)`.
 
@@ -168,10 +207,10 @@ You can unconditionally abort the application with a message box using `OC_ABORT
 
 For more examples of how to use Orca APIs, you can look at the other [sample apps](../samples):
 
-- [breakout](./samples/breakout) is a mini breakout game making use of the vector graphics API. It demonstrates using input and drawing images.
-- 	[triangle](./samples/triangle) shows how to draw a spining triangle using the GLES API.
--  [fluid](./samples/fluid) is a fluid simulation using a more complex GLES setup.
--  [ui](./samples/ui) showcases the UI API and Orca's default UI widgets.
+- [breakout](../samples/breakout) is a mini breakout game making use of the vector graphics API. It demonstrates using input and drawing images.
+- [triangle](../samples/triangle) shows how to draw a spining triangle using the GLES API.
+- [fluid](../samples/fluid) is a fluid simulation using a more complex GLES setup.
+- [ui](../samples/ui) showcases the UI API and Orca's default UI widgets.
 
 For a list of Orca APIs, you can look at the [API cheatsheets](../doc/cheatsheets).
 

doc/cheatsheets/cheatsheet_app.h

@@ -16,8 +16,8 @@ void oc_on_mouse_enter(void);
 void oc_on_mouse_leave(void);
 void oc_on_mouse_move(f32 x, f32 y, f32 deltaX, f32 deltaY);
 void oc_on_mouse_wheel(f32 deltaX, f32 deltaY);
-void oc_on_key_down(oc_key_code key);
-void oc_on_key_up(oc_key_code key);
+void oc_on_key_down(oc_scan_code scan, oc_key_code key);
+void oc_on_key_up(oc_scan_code scan, oc_key_code key);
 void oc_on_frame_refresh(void);
 void oc_on_resize(f32 width, f32 height);
 void oc_on_raw_event(oc_event* event);

doc/cheatsheets/cheatsheet_graphics.h

@@ -117,21 +117,21 @@ oc_font oc_font_nil(void);
 bool oc_font_is_nil(oc_font font);
 
 oc_font oc_font_create_from_memory(oc_str8 mem, u32 rangeCount, oc_unicode_range* ranges);
+oc_font oc_font_create_from_file(oc_file file, u32 rangeCount, oc_unicode_range* ranges);
+oc_font oc_font_create_from_path(oc_str8 path, u32 rangeCount, oc_unicode_range* ranges);
+
 void oc_font_destroy(oc_font font);
 
-oc_font_extents oc_font_get_extents(oc_font font);
-oc_font_extents oc_font_get_scaled_extents(oc_font font, f32 emSize);
+oc_str32 oc_font_get_glyph_indices(oc_font font, oc_str32 codePoints, oc_str32 backing);
+oc_str32 oc_font_push_glyph_indices(oc_arena* arena, oc_font font, oc_str32 codePoints);
+u32 oc_font_get_glyph_index(oc_font font, oc_utf32 codePoint);
+
+oc_font_metrics oc_font_get_metrics(oc_font font, f32 emSize);
+oc_font_metrics oc_font_get_metrics_unscaled(oc_font font);
 f32 oc_font_get_scale_for_em_pixels(oc_font font, f32 emSize);
 
-u32 oc_font_get_glyph_index(oc_font font, oc_utf32 codePoint);
-oc_str32 oc_font_get_glyph_indices(oc_font font, oc_str32 codePoints, oc_str32 backing);
-oc_str32 oc_font_push_glyph_indices(oc_font font, oc_arena* arena, oc_str32 codePoints);
-
-int oc_font_get_codepoint_extents(oc_font font, oc_utf32 codePoint, oc_text_extents* outExtents);
-int oc_font_get_glyph_extents(oc_font font, oc_str32 glyphIndices, oc_text_extents* outExtents);
-
-oc_rect oc_text_bounding_box_utf32(oc_font font, f32 fontSize, oc_str32 text);
-oc_rect oc_text_bounding_box(oc_font font, f32 fontSize, oc_str8 text);
+oc_text_metrics oc_font_text_metrics_utf32(oc_font font, f32 fontSize, oc_str32 codepoints);
+oc_text_metrics oc_font_text_metrics(oc_font font, f32 fontSize, oc_str8 text);
 
 //------------------------------------------------------------------------------------------
 // images
@@ -142,7 +142,8 @@ bool oc_image_is_nil(oc_image a);
 oc_image oc_image_create(oc_surface surface, u32 width, u32 height);
 oc_image oc_image_create_from_rgba8(oc_surface surface, u32 width, u32 height, u8* pixels);
 oc_image oc_image_create_from_memory(oc_surface surface, oc_str8 mem, bool flip);
-oc_image oc_image_create_from_file(oc_surface surface, oc_str8 path, bool flip);
+oc_image oc_image_create_from_file(oc_surface surface, oc_file file, bool flip);
+oc_image oc_image_create_from_path(oc_surface surface, oc_str8 path, bool flip);
 
 void oc_image_destroy(oc_image image);
 
@@ -158,6 +159,8 @@ oc_rect oc_rect_atlas_alloc(oc_rect_atlas* atlas, i32 width, i32 height);
 void oc_rect_atlas_recycle(oc_rect_atlas* atlas, oc_rect rect);
 
 oc_image_region oc_image_atlas_alloc_from_rgba8(oc_rect_atlas* atlas, oc_image backingImage, u32 width, u32 height, u8* pixels);
-oc_image_region oc_image_atlas_alloc_from_data(oc_rect_atlas* atlas, oc_image backingImage, oc_str8 data, bool flip);
-oc_image_region oc_image_atlas_alloc_from_file(oc_rect_atlas* atlas, oc_image backingImage, oc_str8 path, bool flip);
+oc_image_region oc_image_atlas_alloc_from_memory(oc_rect_atlas* atlas, oc_image backingImage, oc_str8 mem, bool flip);
+oc_image_region oc_image_atlas_alloc_from_file(oc_rect_atlas* atlas, oc_image backingImage, oc_file file, bool flip);
+oc_image_region oc_image_atlas_alloc_from_path(oc_rect_atlas* atlas, oc_image backingImage, oc_str8 path, bool flip);
+
 void oc_image_atlas_recycle(oc_rect_atlas* atlas, oc_image_region imageRgn);

ext/wasm3/extra/wapm-package/build/.gitignore

@@ -1,4 +0,0 @@
-# Ignore everything in this directory
-*
-# Except this file
-!.gitignore

ext/wasm3/platforms/openwrt/build/Makefile

@@ -1,15 +0,0 @@
-
-M3_SRC_DIR := ../../../source
-
-SOURCES    := ../../app/main.c \
-              $(shell find $(M3_SRC_DIR) -type f -name '*.c')
-
-override CFLAGS += -std=c99 -O3 -flto -Dd_m3HasWASI -Wno-error=format-security -Wfatal-errors -I$(M3_SRC_DIR)
-
-all: wasm3
-
-wasm3: $(SOURCES)
-	$(CC) $(CFLAGS) $(SOURCES) -o wasm3 -lm
-
-clean:
-	$(RM) wasm3

orca

@@ -7,10 +7,17 @@ import os
 import sys
 
 
+MAJOR, MINOR = 3, 8
+
 if __name__ != "__main__":
     print("why are you importing the orca command-line tool as a Python module, you absolute goofball")
     exit(1)
 
+if sys.version_info.major < MAJOR or sys.version_info.minor < MINOR:
+    print("Your Python version is too old.")
+    print("Orca requires version {}.{}, but you have version {}.{}.".format(MAJOR, MINOR, sys.version_info.major, sys.version_info.minor))
+    exit(1)
+
 
 # If you modify this, be sure to modify the version in scripts/dev.py as well.
 def check_if_source():
@@ -41,9 +48,9 @@ if use_source:
     # Use the source checkout's scripts instead of the system-installed scripts.
 
     if not is_source:
-        print("The Orca tool is running from a local source checkout and will")
-        print("use that instead of the system Orca installation.")
-        print()
+        print("The Orca tool is running from a local source checkout and will", file=sys.stderr)
+        print("use that instead of the system Orca installation.", file=sys.stderr)
+        print(file=sys.stderr)
 
     sys.path.append(source_dir)
     import scripts.orca

orca.bat

@@ -3,5 +3,5 @@
 rem Get the directory of this batch script
 set "script_dir=%~dp0"
 
-python3 "%script_dir%orca" %*
+python "%script_dir%orca" %*
 exit /b %errorlevel%

samples/breakout/build.bat

@@ -1,19 +1,39 @@
 @echo off
+setlocal enabledelayedexpansion
 
-:: compile wasm module
+:: The following code checks if you have the necessary programs to compile the samples.
+:: This code exists to improve the experience of first-time Orca users and can
+:: be safely deleted in your own projects if you wish.
+if exist "..\..\scripts\sample_build_check.py" (
+       python ..\..\scripts\sample_build_check.py
+       if !ERRORLEVEL! neq 0 exit /b 1
+) else (
+       echo Could not check if you have the necessary tools to build the Orca samples.
+       echo If you have copied this script to your own project, you can delete this code.
+)
+
+set ORCA_DIR=..\..
+set STDLIB_DIR=%ORCA_DIR%\src\libc-shim
+
+:: common flags to build wasm modules
 set wasmFlags=--target=wasm32^
        --no-standard-libraries ^
-       -fno-builtin ^
+       -mbulk-memory ^
+       -g -O2 ^
+       -D__ORCA__ ^
        -Wl,--no-entry ^
        -Wl,--export-dynamic ^
-       -g ^
-       -O2 ^
-       -mbulk-memory ^
-       -D__ORCA__ ^
-       -isystem ..\..\src\libc-shim\include ^
-       -I..\..\ext -I ..\..\src
+       -isystem %STDLIB_DIR%\include ^
+       -I%ORCA_DIR%\src ^
+       -I%ORCA_DIR%\src\ext
 
-clang %wasmFlags% -o .\module.wasm ..\..\src\orca.c ..\..\src\libc-shim\src\*.c src\main.c
+:: build orca core as wasm module
+clang %wasmFlags% -Wl,--relocatable -o .\liborca.a %ORCA_DIR%\src\orca.c %ORCA_DIR%\src\libc-shim\src\*.c
 IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
 
-orca bundle --orca-dir ..\.. --name Breakout --icon icon.png --resource-dir data module.wasm
+:: build sample as wasm module and link it with the orca module
+clang %wasmFlags% -L . -lorca -o module.wasm src/main.c
+IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
+
+:: create app directory and copy files into it
+orca bundle --orca-dir %ORCA_DIR% --name Breakout --icon icon.png --resource-dir data module.wasm

samples/breakout/build.sh

@@ -2,31 +2,36 @@
 
 set -euo pipefail
 
-if [[ -x /usr/local/opt/llvm/bin/clang ]]; then
-  CLANG=/usr/local/opt/llvm/bin/clang
-elif [[ -x /opt/homebrew/opt/llvm/bin/clang ]]; then
-  CLANG=/opt/homebrew/opt/llvm/bin/clang
+# The following code checks if you have the necessary programs to compile the samples.
+# This code exists to improve the experience of first-time Orca users and can
+# be safely deleted in your own projects if you wish.
+if [ -f ../../scripts/sample_build_check.py ]; then
+  python3 ../../scripts/sample_build_check.py
 else
-  echo "Could not find Homebrew clang; this script will probably not work."
-  CLANG=clang
+  echo "Could not check if you have the necessary tools to build the Orca samples."
+  echo "If you have copied this script to your own project, you can delete this code."
 fi
 
 ORCA_DIR=../..
-STDLIB_DIR=../../src/libc-shim
+STDLIB_DIR=$ORCA_DIR/src/libc-shim
 
+# common flags to build wasm modules
 wasmFlags="--target=wasm32 \
   --no-standard-libraries \
-  -fno-builtin \
+  -mbulk-memory \
+  -g -O2 \
+  -D__ORCA__ \
   -Wl,--no-entry \
   -Wl,--export-dynamic \
-  -g \
-  -O2 \
-  -mbulk-memory \
-  -D__ORCA__ \
-  -I $STDLIB_DIR/include \
-  -I $ORCA_DIR/ext \
-  -I $ORCA_DIR/src"
+  -isystem $STDLIB_DIR/include \
+  -I $ORCA_DIR/src \
+  -I $ORCA_DIR/src/ext"
 
-$CLANG $wasmFlags -o ./module.wasm ../../src/orca.c $STDLIB_DIR/src/*.c src/main.c
+# build orca core as wasm module
+clang $wasmFlags -Wl,--relocatable -o ./liborca.a $ORCA_DIR/src/orca.c $STDLIB_DIR/src/*.c
 
-orca bundle --orca-dir ../.. --name Breakout --icon icon.png --resource-dir data module.wasm
+# build sample as wasm module and link it with the orca module
+clang $wasmFlags -L . -lorca -o module.wasm src/main.c
+
+# create app directory and copy files into it
+orca bundle --orca-dir $ORCA_DIR --name Breakout --icon icon.png --resource-dir data module.wasm

samples/clock/build.bat

@@ -1,19 +1,39 @@
 @echo off
+setlocal enabledelayedexpansion
 
-:: compile wasm module
+:: The following code checks if you have the necessary programs to compile the samples.
+:: This code exists to improve the experience of first-time Orca users and can
+:: be safely deleted in your own projects if you wish.
+if exist "..\..\scripts\sample_build_check.py" (
+       python ..\..\scripts\sample_build_check.py
+       if !ERRORLEVEL! neq 0 exit /b 1
+) else (
+       echo Could not check if you have the necessary tools to build the Orca samples.
+       echo If you have copied this script to your own project, you can delete this code.
+)
+
+set ORCA_DIR=..\..
+set STDLIB_DIR=%ORCA_DIR%\src\libc-shim
+
+:: common flags to build wasm modules
 set wasmFlags=--target=wasm32^
        --no-standard-libraries ^
-       -fno-builtin ^
+       -mbulk-memory ^
+       -g -O2 ^
+       -D__ORCA__ ^
        -Wl,--no-entry ^
        -Wl,--export-dynamic ^
-       -g ^
-       -O2 ^
-       -mbulk-memory ^
-       -D__ORCA__ ^
-       -isystem ..\..\src\libc-shim\include ^
-       -I..\..\ext -I ..\..\src
+       -isystem %STDLIB_DIR%\include ^
+       -I%ORCA_DIR%\src ^
+       -I%ORCA_DIR%\src\ext
 
-clang %wasmFlags% -o .\module.wasm ..\..\src\orca.c ..\..\src\libc-shim\src\*.c src\main.c
+:: build orca core as wasm module
+clang %wasmFlags% -Wl,--relocatable -o .\liborca.a %ORCA_DIR%\src\orca.c %ORCA_DIR%\src\libc-shim\src\*.c
 IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
 
-orca bundle --orca-dir ..\.. --name Clock --icon icon.png --resource-dir data module.wasm
+:: build sample as wasm module and link it with the orca module
+clang %wasmFlags% -L . -lorca -o module.wasm src/main.c
+IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
+
+:: create app directory and copy files into it
+orca bundle --orca-dir %ORCA_DIR% --name Clock --icon icon.png --resource-dir data module.wasm

samples/clock/build.sh

@@ -2,31 +2,36 @@
 
 set -euo pipefail
 
-if [[ -x /usr/local/opt/llvm/bin/clang ]]; then
-  CLANG=/usr/local/opt/llvm/bin/clang
-elif [[ -x /opt/homebrew/opt/llvm/bin/clang ]]; then
-  CLANG=/opt/homebrew/opt/llvm/bin/clang
+# The following code checks if you have the necessary programs to compile the samples.
+# This code exists to improve the experience of first-time Orca users and can
+# be safely deleted in your own projects if you wish.
+if [ -f ../../scripts/sample_build_check.py ]; then
+  python3 ../../scripts/sample_build_check.py
 else
-  echo "Could not find Homebrew clang; this script will probably not work."
-  CLANG=clang
+  echo "Could not check if you have the necessary tools to build the Orca samples."
+  echo "If you have copied this script to your own project, you can delete this code."
 fi
 
 ORCA_DIR=../..
-STDLIB_DIR=../../src/libc-shim
+STDLIB_DIR=$ORCA_DIR/src/libc-shim
 
+# common flags to build wasm modules
 wasmFlags="--target=wasm32 \
   --no-standard-libraries \
-  -fno-builtin \
+  -mbulk-memory \
+  -g -O2 \
+  -D__ORCA__ \
   -Wl,--no-entry \
   -Wl,--export-dynamic \
-  -g \
-  -O2 \
-  -mbulk-memory \
-  -D__ORCA__ \
-  -I $STDLIB_DIR/include \
-  -I $ORCA_DIR/ext \
-  -I $ORCA_DIR/src"
+  -isystem $STDLIB_DIR/include \
+  -I $ORCA_DIR/src \
+  -I $ORCA_DIR/src/ext"
 
-$CLANG $wasmFlags -o ./module.wasm ../../src/orca.c $STDLIB_DIR/src/*.c src/main.c
+# build orca core as wasm module
+clang $wasmFlags -Wl,--relocatable -o ./liborca.a $ORCA_DIR/src/orca.c $STDLIB_DIR/src/*.c
 
-orca bundle --orca-dir ../.. --name Clock --icon icon.png --resource-dir data module.wasm
+# build sample as wasm module and link it with the orca module
+clang $wasmFlags -L . -lorca -o module.wasm src/main.c
+
+# create app directory and copy files into it
+orca bundle --orca-dir $ORCA_DIR --name Clock --icon icon.png --resource-dir data module.wasm

samples/fluid/build.bat

@@ -1,17 +1,35 @@
 @echo off
+setlocal enabledelayedexpansion
 
-:: compile wasm module
+:: The following code checks if you have the necessary programs to compile the samples.
+:: This code exists to improve the experience of first-time Orca users and can
+:: be safely deleted in your own projects if you wish.
+if exist "..\..\scripts\sample_build_check.py" (
+       python ..\..\scripts\sample_build_check.py
+       if !ERRORLEVEL! neq 0 exit /b 1
+) else (
+       echo Could not check if you have the necessary tools to build the Orca samples.
+       echo If you have copied this script to your own project, you can delete this code.
+)
+
+set ORCA_DIR=..\..
+set STDLIB_DIR=%ORCA_DIR%\src\libc-shim
+
+:: common flags to build wasm modules
 set wasmFlags=--target=wasm32^
        --no-standard-libraries ^
-       -fno-builtin ^
+       -mbulk-memory ^
+       -g -O2 ^
+       -D__ORCA__ ^
        -Wl,--no-entry ^
        -Wl,--export-dynamic ^
-       -g ^
-       -O2 ^
-       -mbulk-memory ^
-       -D__ORCA__ ^
-       -isystem ..\..\src\libc-shim\include ^
-       -I..\..\ext -I ..\..\src
+       -isystem %STDLIB_DIR%\include ^
+       -I%ORCA_DIR%\src ^
+       -I%ORCA_DIR%\src\ext
+
+:: build orca core as wasm module
+clang %wasmFlags% -Wl,--relocatable -o .\liborca.a %ORCA_DIR%\src\orca.c %ORCA_DIR%\src\libc-shim\src\*.c
+IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
 
 set shaders=src/shaders/advect.glsl^
 	src/shaders/blit_div_fragment.glsl^
@@ -28,10 +46,12 @@ set shaders=src/shaders/advect.glsl^
 	src/shaders/subtract_pressure.glsl
 
 
-call python3 ../../scripts/embed_text_files.py --prefix=glsl_ --output src/glsl_shaders.h %shaders%
+call python ../../scripts/embed_text_files.py --prefix=glsl_ --output src/glsl_shaders.h %shaders%
+if !ERRORLEVEL! neq 0 exit /b !ERRORLEVEL!
+
+:: build sample as wasm module and link it with the orca module
+clang %wasmFlags% -L . -lorca -o .\module.wasm src\main.c
 IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
 
-clang %wasmFlags% -o .\module.wasm ..\..\src\orca.c ..\..\src\libc-shim\src\*.c src\main.c
-IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
-
-orca bundle --orca-dir ..\.. --icon icon.png --name Fluid module.wasm
+:: create app directory and copy files into it
+orca bundle --orca-dir %ORCA_DIR% --name Fluid --icon icon.png module.wasm

samples/fluid/build.sh

@@ -2,33 +2,38 @@
 
 set -euo pipefail
 
-if [[ -x /usr/local/opt/llvm/bin/clang ]]; then
-  CLANG=/usr/local/opt/llvm/bin/clang
-elif [[ -x /opt/homebrew/opt/llvm/bin/clang ]]; then
-  CLANG=/opt/homebrew/opt/llvm/bin/clang
+# The following code checks if you have the necessary programs to compile the samples.
+# This code exists to improve the experience of first-time Orca users and can
+# be safely deleted in your own projects if you wish.
+if [ -f ../../scripts/sample_build_check.py ]; then
+  python3 ../../scripts/sample_build_check.py
 else
-  echo "Could not find Homebrew clang; this script will probably not work."
-  CLANG=clang
+  echo "Could not check if you have the necessary tools to build the Orca samples."
+  echo "If you have copied this script to your own project, you can delete this code."
 fi
 
 ORCA_DIR=../..
-STDLIB_DIR=../../src/libc-shim
+STDLIB_DIR=$ORCA_DIR/src/libc-shim
 
 python3 ../../scripts/embed_text_files.py --prefix=glsl_ --output src/glsl_shaders.h src/shaders/*.glsl
 
+# common flags to build wasm modules
 wasmFlags="--target=wasm32 \
   --no-standard-libraries \
-  -fno-builtin \
+  -mbulk-memory \
+  -g -O2 \
+  -D__ORCA__ \
   -Wl,--no-entry \
   -Wl,--export-dynamic \
-  -g \
-  -O2 \
-  -mbulk-memory \
-  -D__ORCA__ \
-  -I $STDLIB_DIR/include \
-  -I $ORCA_DIR/ext \
-  -I $ORCA_DIR/src"
+  -isystem $STDLIB_DIR/include \
+  -I $ORCA_DIR/src \
+  -I $ORCA_DIR/src/ext"
 
-$CLANG $wasmFlags -o ./module.wasm ../../src/orca.c $STDLIB_DIR/src/*.c src/main.c
+# build orca core as wasm module
+clang $wasmFlags -Wl,--relocatable -o ./liborca.a $ORCA_DIR/src/orca.c $STDLIB_DIR/src/*.c
 
-orca bundle --orca-dir ../..  --icon icon.png --name Fluid module.wasm
+# build sample as wasm module and link it with the orca module
+clang $wasmFlags -L . -lorca -o module.wasm src/main.c
+
+# create app directory and copy files into it
+orca bundle --orca-dir $ORCA_DIR --name Fluid --icon icon.png module.wasm

samples/fluid/src/main.c

@@ -140,6 +140,7 @@ frame_buffer divBuffer[4];
 GLuint vertexBuffer;
 
 oc_surface surface;
+f64 startTime;
 
 //----------------------------------------------------------------
 //NOTE(martin): initialization
@@ -403,6 +404,7 @@ typedef struct mouse_input
 } mouse_input;
 
 mouse_input mouseInput = { 0 };
+bool mouseWasDown = false;
 
 int frameWidth = 800;
 int frameHeight = 600;
@@ -410,6 +412,7 @@ int frameHeight = 600;
 ORCA_EXPORT void oc_on_mouse_down(int button)
 {
     mouseInput.down = true;
+    mouseWasDown = true;
 }
 
 ORCA_EXPORT void oc_on_mouse_up(int button)
@@ -577,23 +580,56 @@ void multigrid_clear(frame_buffer* error)
 
 void input_splat(float t)
 {
-    //NOTE: apply force and dye
-    if(mouseInput.down && (mouseInput.deltaX || mouseInput.deltaY))
+    bool applySplat = false;
+    float x, y, deltaX, deltaY;
+    static f64 lastFrameTime = 0;
+    if (lastFrameTime == 0)
+    {
+        lastFrameTime = startTime;
+    }
+    f64 now = oc_clock_time(OC_CLOCK_MONOTONIC);
+    float frameDuration = now - lastFrameTime;
+    lastFrameTime = now;
+
+    if (mouseInput.down && (mouseInput.deltaX || mouseInput.deltaY))
     {
         oc_vec2 scaling = oc_surface_contents_scaling(surface);
+        applySplat = true;
+        x = mouseInput.x * scaling.x / frameWidth;
+        y = mouseInput.y * scaling.y / frameHeight;
+        deltaX = 1. / 60 / frameDuration * mouseInput.deltaX * scaling.x / frameWidth;
+        deltaY = 1. / 60 / frameDuration * mouseInput.deltaY * scaling.y / frameHeight;
+        mouseInput.deltaX = 0;
+        mouseInput.deltaY = 0;
+    }
+
+    f64 timeSinceStart = now - startTime;
+    if (!mouseWasDown && timeSinceStart < 1)
+    {
+        applySplat = true;
+        float totalDeltaX = 0.5;
+        x = 0.1 + totalDeltaX * timeSinceStart;
+        y = 0.5;
+        deltaX = totalDeltaX / 180;
+        deltaY = 0;
+    }
+
+    //NOTE: apply force and dye
+    if(applySplat)
+    {
         // account for margin
         float margin = 32;
 
         float offset = margin / texWidth;
         float ratio = 1 - 2 * margin / texWidth;
 
-        float splatPosX = (mouseInput.x * scaling.x / frameWidth) * ratio + offset;
-        float splatPosY = (1 - mouseInput.y * scaling.y / frameHeight) * ratio + offset;
+        float splatPosX = x * ratio + offset;
+        float splatPosY = (1 - y) * ratio + offset;
 
-        float splatVelX = (10000. * DELTA * mouseInput.deltaX * scaling.x / frameWidth) * ratio;
-        float splatVelY = (-10000. * DELTA * mouseInput.deltaY * scaling.y / frameWidth) * ratio;
+        float splatVelX = (10000. * DELTA * deltaX) * ratio;
+        float splatVelY = (-10000. * DELTA * deltaY) * ratio;
 
-        float intensity = 100 * sqrtf(square(ratio * mouseInput.deltaX * scaling.x / frameWidth) + square(ratio * mouseInput.deltaY * scaling.y / frameHeight));
+        float intensity = 100 * sqrtf(square(ratio * deltaX) + square(ratio * deltaY));
 
         float r = intensity * (sinf(2 * M_PI * 0.1 * t) + 1);
         float g = 0.5 * intensity * (cosf(2 * M_PI * 0.1 / M_E * t + 654) + 1);
@@ -602,9 +638,6 @@ void input_splat(float t)
         float radius = 0.005;
 
         apply_splat(splatPosX, splatPosY, radius, splatVelX, splatVelY, r, g, b, false);
-
-        mouseInput.deltaX = 0;
-        mouseInput.deltaY = 0;
     }
 }
 
@@ -677,6 +710,8 @@ ORCA_EXPORT void oc_on_init()
             testDiv[i][j][0] = 0.5 + 0.5 * cosf(j / 100. * 3.14159 + i / 100. * 1.2139);
         }
     }
+
+    startTime = oc_clock_time(OC_CLOCK_MONOTONIC);
 }
 
 ORCA_EXPORT void oc_on_resize(u32 width, u32 height)

samples/triangle/build.bat

@@ -1,19 +1,39 @@
 @echo off
+setlocal enabledelayedexpansion
 
-:: compile wasm module
+:: The following code checks if you have the necessary programs to compile the samples.
+:: This code exists to improve the experience of first-time Orca users and can
+:: be safely deleted in your own projects if you wish.
+if exist "..\..\scripts\sample_build_check.py" (
+       python ..\..\scripts\sample_build_check.py
+       if !ERRORLEVEL! neq 0 exit /b 1
+) else (
+       echo Could not check if you have the necessary tools to build the Orca samples.
+       echo If you have copied this script to your own project, you can delete this code.
+)
+
+set ORCA_DIR=..\..
+set STDLIB_DIR=%ORCA_DIR%\src\libc-shim
+
+:: common flags to build wasm modules
 set wasmFlags=--target=wasm32^
        --no-standard-libraries ^
-       -fno-builtin ^
+       -mbulk-memory ^
+       -g -O2 ^
+       -D__ORCA__ ^
        -Wl,--no-entry ^
        -Wl,--export-dynamic ^
-       -g ^
-       -O2 ^
-       -mbulk-memory ^
-       -D__ORCA__ ^
-       -isystem ..\..\src\libc-shim\include ^
-       -I..\..\ext -I ..\..\src
+       -isystem %STDLIB_DIR%\include ^
+       -I%ORCA_DIR%\src ^
+       -I%ORCA_DIR%\src\ext
 
-clang %wasmFlags% -o .\module.wasm ..\..\src\orca.c ..\..\src\libc-shim\src\*.c src\main.c
+:: build orca core as wasm module
+clang %wasmFlags% -Wl,--relocatable -o .\liborca.a %ORCA_DIR%\src\orca.c %ORCA_DIR%\src\libc-shim\src\*.c
 IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
 
-orca bundle --orca-dir ..\.. --name Triangle module.wasm
+:: build sample as wasm module and link it with the orca module
+clang %wasmFlags% -L . -lorca -o module.wasm src/main.c
+IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
+
+:: create app directory and copy files into it
+orca bundle --orca-dir %ORCA_DIR% --name Triangle --icon icon.png module.wasm

samples/triangle/build.sh

@@ -2,31 +2,36 @@
 
 set -euo pipefail
 
-if [[ -x /usr/local/opt/llvm/bin/clang ]]; then
-  CLANG=/usr/local/opt/llvm/bin/clang
-elif [[ -x /opt/homebrew/opt/llvm/bin/clang ]]; then
-  CLANG=/opt/homebrew/opt/llvm/bin/clang
+# The following code checks if you have the necessary programs to compile the samples.
+# This code exists to improve the experience of first-time Orca users and can
+# be safely deleted in your own projects if you wish.
+if [ -f ../../scripts/sample_build_check.py ]; then
+  python3 ../../scripts/sample_build_check.py
 else
-  echo "Could not find Homebrew clang; this script will probably not work."
-  CLANG=clang
+  echo "Could not check if you have the necessary tools to build the Orca samples."
+  echo "If you have copied this script to your own project, you can delete this code."
 fi
 
 ORCA_DIR=../..
-STDLIB_DIR=../../src/libc-shim
+STDLIB_DIR=$ORCA_DIR/src/libc-shim
 
+# common flags to build wasm modules
 wasmFlags="--target=wasm32 \
   --no-standard-libraries \
-  -fno-builtin \
+  -mbulk-memory \
+  -g -O2 \
+  -D__ORCA__ \
   -Wl,--no-entry \
   -Wl,--export-dynamic \
-  -g \
-  -O2 \
-  -mbulk-memory \
-  -D__ORCA__ \
-  -I $STDLIB_DIR/include \
-  -I $ORCA_DIR/ext \
-  -I $ORCA_DIR/src"
+  -isystem $STDLIB_DIR/include \
+  -I $ORCA_DIR/src \
+  -I $ORCA_DIR/src/ext"
 
-$CLANG $wasmFlags -o ./module.wasm ../../src/orca.c ../../src/libc-shim/src/*.c src/main.c
+# build orca core as wasm module
+clang $wasmFlags -Wl,--relocatable -o ./liborca.a $ORCA_DIR/src/orca.c $STDLIB_DIR/src/*.c
 
-orca bundle --orca-dir ../.. --name Triangle module.wasm
+# build sample as wasm module and link it with the orca module
+clang $wasmFlags -L . -lorca -o module.wasm src/main.c
+
+# create app directory and copy files into it
+orca bundle --orca-dir $ORCA_DIR --name Triangle module.wasm

samples/ui/build.bat

@@ -1,19 +1,39 @@
 @echo off
+setlocal enabledelayedexpansion
 
-:: compile wasm module
+:: The following code checks if you have the necessary programs to compile the samples.
+:: This code exists to improve the experience of first-time Orca users and can
+:: be safely deleted in your own projects if you wish.
+if exist "..\..\scripts\sample_build_check.py" (
+       python ..\..\scripts\sample_build_check.py
+       if !ERRORLEVEL! neq 0 exit /b 1
+) else (
+       echo Could not check if you have the necessary tools to build the Orca samples.
+       echo If you have copied this script to your own project, you can delete this code.
+)
+
+set ORCA_DIR=..\..
+set STDLIB_DIR=%ORCA_DIR%\src\libc-shim
+
+:: common flags to build wasm modules
 set wasmFlags=--target=wasm32^
        --no-standard-libraries ^
-       -fno-builtin ^
+       -mbulk-memory ^
+       -g -O2 ^
+       -D__ORCA__ ^
        -Wl,--no-entry ^
        -Wl,--export-dynamic ^
-       -g ^
-       -O2 ^
-       -mbulk-memory ^
-       -D__ORCA__ ^
-       -isystem ..\..\src\libc-shim\include ^
-       -I..\..\ext -I ..\..\src
+       -isystem %STDLIB_DIR%\include ^
+       -I%ORCA_DIR%\src ^
+       -I%ORCA_DIR%\src\ext
 
-clang %wasmFlags% -o .\module.wasm ..\..\src\orca.c ..\..\src\libc-shim\src\*.c src\main.c
+:: build orca core as wasm module
+clang %wasmFlags% -Wl,--relocatable -o .\liborca.a %ORCA_DIR%\src\orca.c %ORCA_DIR%\src\libc-shim\src\*.c
 IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
 
-orca bundle --orca-dir ..\.. --name UI --resource-dir data module.wasm
+:: build sample as wasm module and link it with the orca module
+clang %wasmFlags% -L . -lorca -o .\module.wasm src\main.c
+IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
+
+:: create app directory and copy files into it
+orca bundle --orca-dir %ORCA_DIR% --name UI --resource-dir data module.wasm

samples/ui/build.sh

@@ -2,31 +2,36 @@
 
 set -euo pipefail
 
-if [[ -x /usr/local/opt/llvm/bin/clang ]]; then
-  CLANG=/usr/local/opt/llvm/bin/clang
-elif [[ -x /opt/homebrew/opt/llvm/bin/clang ]]; then
-  CLANG=/opt/homebrew/opt/llvm/bin/clang
+# The following code checks if you have the necessary programs to compile the samples.
+# This code exists to improve the experience of first-time Orca users and can
+# be safely deleted in your own projects if you wish.
+if [ -f ../../scripts/sample_build_check.py ]; then
+  python3 ../../scripts/sample_build_check.py
 else
-  echo "Could not find Homebrew clang; this script will probably not work."
-  CLANG=clang
+  echo "Could not check if you have the necessary tools to build the Orca samples."
+  echo "If you have copied this script to your own project, you can delete this code."
 fi
 
 ORCA_DIR=../..
-STDLIB_DIR=../../src/libc-shim
+STDLIB_DIR=$ORCA_DIR/src/libc-shim
 
+# common flags to build wasm modules
 wasmFlags="--target=wasm32 \
   --no-standard-libraries \
+  -mbulk-memory \
+  -g -O2 \
+  -D__ORCA__ \
   -Wl,--no-entry \
   -Wl,--export-dynamic \
-  -g \
-  -O2 \
-  -mbulk-memory \
-  -D__ORCA__ \
-  -I $ORCA_DIR/ext \
-  -I $STDLIB_DIR/include \
-  -I $ORCA_DIR/ext \
-  -I $ORCA_DIR/src"
+  -isystem $STDLIB_DIR/include \
+  -I $ORCA_DIR/src \
+  -I $ORCA_DIR/src/ext"
 
-$CLANG $wasmFlags -o ./module.wasm ../../src/orca.c $STDLIB_DIR/src/*.c src/main.c
+# build orca core as wasm module
+clang $wasmFlags -Wl,--relocatable -o ./liborca.a $ORCA_DIR/src/orca.c $STDLIB_DIR/src/*.c
 
-orca bundle --orca-dir ../.. --name UI --resource-dir data module.wasm
+# build sample as wasm module and link it with the orca module
+clang $wasmFlags -L . -lorca -o module.wasm src/main.c
+
+# create app directory and copy files into it
+orca bundle --orca-dir $ORCA_DIR --name UI --resource-dir data module.wasm

scripts/bindgen.py

@@ -5,292 +5,298 @@ import json
 
 
 def needs_arg_ptr_stub(decl):
-	res = (decl['ret']['tag'] == 'S')
-	for arg in decl['args']:
-		if arg['type']['tag'] == 'S':
-			res = True
-	return(res)
+    res = (decl['ret']['tag'] == 'S')
+    for arg in decl['args']:
+        if arg['type']['tag'] == 'S':
+            res = True
+    return(res)
 
 def printError(str):
-	# This prints a string with a red foreground color.
-	# See this link for an explanation of console escape codes: https://stackabuse.com/how-to-print-colored-text-in-python/
-	print("\x1b[38;5;196m" + "error: " + str + "\033[0;0m")
+    # This prints a string with a red foreground color.
+    # See this link for an explanation of console escape codes: https://stackabuse.com/how-to-print-colored-text-in-python/
+    print("\x1b[38;5;196m" + "error: " + str + "\033[0;0m")
 
 
 def bindgen(apiName, spec, **kwargs):
-	guest_stubs_path = kwargs.get("guest_stubs")
-	guest_include = kwargs.get("guest_include")
-	wasm3_bindings_path = kwargs.get("wasm3_bindings")
+    guest_stubs_path = kwargs.get("guest_stubs")
+    guest_include = kwargs.get("guest_include")
+    wasm3_bindings_path = kwargs.get("wasm3_bindings")
 
-	if guest_stubs_path == None:
-		guest_stubs_path = 'bindgen_' + apiName + '_guest_stubs.c'
-	if wasm3_bindings_path == None:
-		wasm3_bindings_path = 'bindgen_' + apiName + '_wasm3_bindings.c'
+    if guest_stubs_path == None:
+        guest_stubs_path = 'bindgen_' + apiName + '_guest_stubs.c'
+    if wasm3_bindings_path == None:
+        wasm3_bindings_path = 'bindgen_' + apiName + '_wasm3_bindings.c'
 
-	host_bindings = open(wasm3_bindings_path, 'w')
-	guest_bindings = None
+    host_bindings = open(wasm3_bindings_path, 'w')
+    guest_bindings = None
 
-	specFile = open(spec, 'r')
-	data = json.load(specFile)
+    specFile = open(spec, 'r')
+    data = json.load(specFile)
 
-	for decl in data:
-		if needs_arg_ptr_stub(decl):
-			guest_bindings = open(guest_stubs_path, 'w')
-			if guest_include != None:
-				s = '#include"' + guest_include + '"\n\n'
-				print(s, file=guest_bindings)
-			break
+    for decl in data:
+        if needs_arg_ptr_stub(decl):
+            guest_bindings = open(guest_stubs_path, 'w')
+            if guest_include != None:
+                s = '#include"' + guest_include + '"\n\n'
+                print(s, file=guest_bindings)
+            break
 
-	for decl in data:
+    for decl in data:
 
-		name = decl['name']
-		cname = decl.get('cname', name)
+        name = decl['name']
+        cname = decl.get('cname', name)
 
-		if needs_arg_ptr_stub(decl):
-			argPtrStubName = name + '_argptr_stub'
-			# pointer arg stub declaration
-			s = ''
-			if decl['ret']['tag'] == 'S':
-				s += 'void'
-			else:
-				s += decl['ret']['name']
+        if needs_arg_ptr_stub(decl):
+            argPtrStubName = name + '_argptr_stub'
+            # pointer arg stub declaration
+            s = ''
+            if decl['ret']['tag'] == 'S':
+                s += 'void'
+            else:
+                s += decl['ret']['name']
 
-			s += ' ORCA_IMPORT(' + argPtrStubName + ') ('
+            s += ' ORCA_IMPORT(' + argPtrStubName + ') ('
 
-			if decl['ret']['tag'] == 'S':
-				s += decl['ret']['name'] + '* __retArg'
-				if len(decl['args']) > 0:
-					s += ', '
+            if decl['ret']['tag'] == 'S':
+                s += decl['ret']['name'] + '* __retArg'
+                if len(decl['args']) > 0:
+                    s += ', '
+            elif len(decl['args']) == 0:
+                s += 'void'
 
-			for i, arg in enumerate(decl['args']):
-				s += arg['type']['name']
-				if arg['type']['tag'] == 'S':
-					s += '*'
-				s += ' ' + arg['name']
-				if i+1 < len(decl['args']):
-					s += ', '
-			s += ');\n\n'
+            for i, arg in enumerate(decl['args']):
+                s += arg['type']['name']
+                if arg['type']['tag'] == 'S':
+                    s += '*'
+                s += ' ' + arg['name']
+                if i+1 < len(decl['args']):
+                    s += ', '
+            s += ');\n\n'
 
-			# forward function to pointer arg stub declaration
-			s += decl['ret']['name'] + ' ' + name + '('
-			for i, arg in enumerate(decl['args']):
-				s += arg['type']['name'] + ' ' + arg['name']
-				if i+1 < len(decl['args']):
-					s += ', '
-			s += ')\n'
-			s += '{\n'
-			s += '\t'
-			if decl['ret']['tag'] == 'S':
-				s += decl['ret']['name'] + ' __ret;\n\t'
-			elif decl['ret']['tag'] != 'v':
-				s += decl['ret']['name']
-				s += ' __ret = '
-			s += argPtrStubName + '('
+            # forward function to pointer arg stub declaration
+            s += decl['ret']['name'] + ' ' + name + '('
 
-			if decl['ret']['tag'] == 'S':
-				s += '&__ret'
-				if len(decl['args']) > 0:
-					s += ', '
+            if len(decl['args']) == 0:
+                s += 'void'
 
-			for i, arg in enumerate(decl['args']):
-				if arg['type']['tag'] == 'S':
-					s += '&'
+            for i, arg in enumerate(decl['args']):
+                s += arg['type']['name'] + ' ' + arg['name']
+                if i+1 < len(decl['args']):
+                    s += ', '
+            s += ')\n'
+            s += '{\n'
+            s += '\t'
+            if decl['ret']['tag'] == 'S':
+                s += decl['ret']['name'] + ' __ret;\n\t'
+            elif decl['ret']['tag'] != 'v':
+                s += decl['ret']['name']
+                s += ' __ret = '
+            s += argPtrStubName + '('
 
-				s += arg['name']
-				if i+1 < len(decl['args']):
-					s += ', '
-			s += ');\n'
-			if decl['ret']['tag'] != 'v':
-				s += '\treturn(__ret);\n'
-			s += '}\n\n'
+            if decl['ret']['tag'] == 'S':
+                s += '&__ret'
+                if len(decl['args']) > 0:
+                    s += ', '
 
-			print(s, file=guest_bindings)
+            for i, arg in enumerate(decl['args']):
+                if arg['type']['tag'] == 'S':
+                    s += '&'
 
-		# host-side stub
-		s = 'const void* ' + cname + '_stub(IM3Runtime runtime, IM3ImportContext _ctx, uint64_t* _sp, void* _mem)'
+                s += arg['name']
+                if i+1 < len(decl['args']):
+                    s += ', '
+            s += ');\n'
+            if decl['ret']['tag'] != 'v':
+                s += '\treturn(__ret);\n'
+            s += '}\n\n'
 
-		gen_stub = decl.get('gen_stub', True)
-		if gen_stub == False:
-			s += ';\n\n'
-		else:
-			s += '\n{\n'
+            print(s, file=guest_bindings)
+
+        # host-side stub
+        s = 'const void* ' + cname + '_stub(IM3Runtime runtime, IM3ImportContext _ctx, uint64_t* _sp, void* _mem)'
+
+        gen_stub = decl.get('gen_stub', True)
+        if gen_stub == False:
+            s += ';\n\n'
+        else:
+            s += '\n{\n'
 
 
-			# NOTE: check and cast arguments
-			retTag = decl['ret']['tag']
+            # NOTE: check and cast arguments
+            retTag = decl['ret']['tag']
 
-			firstArgIndex = 0
-			if retTag != 'v':
-				firstArgIndex = 1
+            firstArgIndex = 0
+            if retTag != 'v':
+                firstArgIndex = 1
 
-				if retTag == 'S':
-					retTypeName = decl['ret']['name']
-					retTypeCName = decl['ret'].get('cname', retTypeName)
-					s += retTypeCName + '* __retPtr = (' + retTypeCName + '*)((char*)_mem + *(i32*)&_sp[0]);\n'
+                if retTag == 'S':
+                    retTypeName = decl['ret']['name']
+                    retTypeCName = decl['ret'].get('cname', retTypeName)
+                    s += retTypeCName + '* __retPtr = (' + retTypeCName + '*)((char*)_mem + *(i32*)&_sp[0]);\n'
 
-					s += '\t{\n'
-					s += '\t\tOC_ASSERT(((char*)__retPtr >= (char*)_mem) && (((char*)__retPtr - (char*)_mem) < m3_GetMemorySize(runtime)), "return pointer is out of bounds");\n'
-					s += '\t\tOC_ASSERT((char*)__retPtr + sizeof(' + retTypeCName + ') <= ((char*)_mem + m3_GetMemorySize(runtime)), "return pointer is out of bounds");\n'
-					s += '\t}\n'
+                    s += '\t{\n'
+                    s += '\t\tOC_ASSERT(((char*)__retPtr >= (char*)_mem) && (((char*)__retPtr - (char*)_mem) < m3_GetMemorySize(runtime)), "return pointer is out of bounds");\n'
+                    s += '\t\tOC_ASSERT((char*)__retPtr + sizeof(' + retTypeCName + ') <= ((char*)_mem + m3_GetMemorySize(runtime)), "return pointer is out of bounds");\n'
+                    s += '\t}\n'
 
-			for argIndex, arg in enumerate(decl['args']):
+            for argIndex, arg in enumerate(decl['args']):
 
-				argName = arg['name']
-				typeName = arg['type']['name']
-				typeCName = arg['type'].get('cname', typeName)
-				argTag = arg['type']['tag']
+                argName = arg['name']
+                typeName = arg['type']['name']
+                typeCName = arg['type'].get('cname', typeName)
+                argTag = arg['type']['tag']
 
-				s += '\t'
+                s += '\t'
 
-				if argTag == 'i':
-					s += typeCName + ' ' + argName + ' = ('+typeCName+')*(i32*)&_sp[' + str(firstArgIndex + argIndex) + '];\n'
-				elif argTag == 'I':
-					s += typeCName + ' ' + argName + ' = ('+typeCName+')*(i64*)&_sp[' + str(firstArgIndex + argIndex) + '];\n'
-				elif argTag == 'f':
-					s += typeCName + ' ' + argName + ' = ('+typeCName+')*(f32*)&_sp[' + str(firstArgIndex + argIndex) + '];\n'
-				elif argTag == 'F':
-					s += typeCName + ' ' + argName + ' = ('+typeCName+')*(f64*)&_sp[' + str(firstArgIndex + argIndex) + '];\n'
-				elif argTag == 'p':
-					s += typeCName + ' ' + argName + ' = ('+ typeCName +')((char*)_mem + *(u32*)&_sp[' + str(firstArgIndex + argIndex) + ']);\n'
-				elif argTag == 'S':
-					s += typeCName + ' ' + argName + ' = *('+ typeCName +'*)((char*)_mem + *(u32*)&_sp[' + str(firstArgIndex + argIndex) + ']);\n'
-				else:
-					print('unrecognized type ' + c + ' in procedure signature\n')
-					break
+                if argTag == 'i':
+                    s += typeCName + ' ' + argName + ' = ('+typeCName+')*(i32*)&_sp[' + str(firstArgIndex + argIndex) + '];\n'
+                elif argTag == 'I':
+                    s += typeCName + ' ' + argName + ' = ('+typeCName+')*(i64*)&_sp[' + str(firstArgIndex + argIndex) + '];\n'
+                elif argTag == 'f':
+                    s += typeCName + ' ' + argName + ' = ('+typeCName+')*(f32*)&_sp[' + str(firstArgIndex + argIndex) + '];\n'
+                elif argTag == 'F':
+                    s += typeCName + ' ' + argName + ' = ('+typeCName+')*(f64*)&_sp[' + str(firstArgIndex + argIndex) + '];\n'
+                elif argTag == 'p':
+                    s += typeCName + ' ' + argName + ' = ('+ typeCName +')((char*)_mem + *(u32*)&_sp[' + str(firstArgIndex + argIndex) + ']);\n'
+                elif argTag == 'S':
+                    s += typeCName + ' ' + argName + ' = *('+ typeCName +'*)((char*)_mem + *(u32*)&_sp[' + str(firstArgIndex + argIndex) + ']);\n'
+                else:
+                    print('unrecognized type ' + c + ' in procedure signature\n')
+                    break
 
-			# check pointer arg length
-			for arg in decl['args']:
+            # check pointer arg length
+            for arg in decl['args']:
 
-				argName = arg['name']
-				typeName = arg['type']['name']
-				typeCName = arg['type'].get('cname', typeName)
-				argTag = arg['type']['tag']
-				argLen = arg.get('len')
+                argName = arg['name']
+                typeName = arg['type']['name']
+                typeCName = arg['type'].get('cname', typeName)
+                argTag = arg['type']['tag']
+                argLen = arg.get('len')
 
-				if argTag == 'p':
-					if argLen == None:
-						printError("binding '" + name + "' missing pointer length decoration for param '" + argName + "'")
-					else:
-						s += '\t{\n'
-						s += '\t\tOC_ASSERT(((char*)'+ argName + ' >= (char*)_mem) && (((char*)'+ argName +' - (char*)_mem) < m3_GetMemorySize(runtime)), "parameter \''+argName+'\' is out of bounds");\n'
-						s += '\t\tOC_ASSERT((char*)' + argName + ' + '
+                if argTag == 'p':
+                    if argLen == None:
+                        printError("binding '" + name + "' missing pointer length decoration for param '" + argName + "'")
+                    else:
+                        s += '\t{\n'
+                        s += '\t\tOC_ASSERT(((char*)'+ argName + ' >= (char*)_mem) && (((char*)'+ argName +' - (char*)_mem) < m3_GetMemorySize(runtime)), "parameter \''+argName+'\' is out of bounds");\n'
+                        s += '\t\tOC_ASSERT((char*)' + argName + ' + '
 
-						proc = argLen.get('proc')
-						if proc != None:
-							s += proc + '(runtime, '
-							lenProcArgs = argLen['args']
-							for i, lenProcArg in enumerate(lenProcArgs):
-								s += lenProcArg
-								if i < len(lenProcArgs)-1:
-									s += ', '
-							s += ')'
-						else:
-							components =  argLen.get('components')
-							countArg = argLen.get('count')
+                        proc = argLen.get('proc')
+                        if proc != None:
+                            s += proc + '(runtime, '
+                            lenProcArgs = argLen['args']
+                            for i, lenProcArg in enumerate(lenProcArgs):
+                                s += lenProcArg
+                                if i < len(lenProcArgs)-1:
+                                    s += ', '
+                            s += ')'
+                        else:
+                            components =  argLen.get('components')
+                            countArg = argLen.get('count')
 
-							if components != None:
-								s += str(components)
-								if countArg != None:
-									s += '*'
-							if countArg != None:
-								s += countArg
+                            if components != None:
+                                s += str(components)
+                                if countArg != None:
+                                    s += '*'
+                            if countArg != None:
+                                s += countArg
 
-						if typeCName.endswith('**') or (typeCName.startswith('void') == False and typeCName.startswith('const void') == False):
-							s += '*sizeof('+typeCName[:-1]+')'
+                        if typeCName.endswith('**') or (typeCName.startswith('void') == False and typeCName.startswith('const void') == False):
+                            s += '*sizeof('+typeCName[:-1]+')'
 
-						s += ' <= ((char*)_mem + m3_GetMemorySize(runtime)), "parameter \''+argName+'\' is out of bounds");\n'
-						s += '\t}\n'
+                        s += ' <= ((char*)_mem + m3_GetMemorySize(runtime)), "parameter \''+argName+'\' is out of bounds");\n'
+                        s += '\t}\n'
 
-			s += '\t'
+            s += '\t'
 
-			if retTag == 'i':
-				s += '*((i32*)&_sp[0]) = (i32)'
-			elif retTag == 'I':
-				s += '*((i64*)&_sp[0]) = (i64)'
-			elif retTag == 'f':
-				s += '*((f32*)&_sp[0]) = (f32)'
-			elif retTag == 'F':
-				s += '*((f64*)&_sp[0]) = (f64)'
-			elif retTag == 'S':
-				s += '*__retPtr = '
-			elif retTag == 'p':
-				print("Warning: " + name + ": pointer return type not supported yet")
+            if retTag == 'i':
+                s += '*((i32*)&_sp[0]) = (i32)'
+            elif retTag == 'I':
+                s += '*((i64*)&_sp[0]) = (i64)'
+            elif retTag == 'f':
+                s += '*((f32*)&_sp[0]) = (f32)'
+            elif retTag == 'F':
+                s += '*((f64*)&_sp[0]) = (f64)'
+            elif retTag == 'S':
+                s += '*__retPtr = '
+            elif retTag == 'p':
+                print("Warning: " + name + ": pointer return type not supported yet")
 
-			s += cname + '('
+            s += cname + '('
 
-			for i, arg in enumerate(decl['args']):
-				s += arg['name']
+            for i, arg in enumerate(decl['args']):
+                s += arg['name']
 
-				if i+1 < len(decl['args']):
-					s += ', '
+                if i+1 < len(decl['args']):
+                    s += ', '
 
-			s += ');\n\treturn(0);\n}\n\n'
+            s += ');\n\treturn(0);\n}\n\n'
 
-		print(s, file=host_bindings)
+        print(s, file=host_bindings)
 
-	# link function
-	s = 'int bindgen_link_' + apiName + '_api(IM3Module module)\n{\n'
-	s += '	M3Result res;\n'
-	s += '	int ret = 0;\n'
+    # link function
+    s = 'int bindgen_link_' + apiName + '_api(IM3Module module)\n{\n'
+    s += '  M3Result res;\n'
+    s += '  int ret = 0;\n'
 
-	for decl in data:
-		name = decl['name']
-		cname = decl.get('cname', name)
+    for decl in data:
+        name = decl['name']
+        cname = decl.get('cname', name)
 
-		if needs_arg_ptr_stub(decl):
-			name = name + '_argptr_stub'
+        if needs_arg_ptr_stub(decl):
+            name = name + '_argptr_stub'
 
-		m3Sig = ''
-		if decl['ret']['tag'] == 'S':
-			m3Sig += 'v'
-		else:
-			m3Sig += decl['ret']['tag']
+        m3Sig = ''
+        if decl['ret']['tag'] == 'S':
+            m3Sig += 'v'
+        else:
+            m3Sig += decl['ret']['tag']
 
-		m3Sig += '('
-		if decl['ret']['tag'] == 'S':
-			m3Sig += 'i'
-		for arg in decl['args']:
-			tag = arg['type']['tag']
-			if tag == 'p' or tag == 'S':
-				tag = 'i'
-			m3Sig += tag
-		m3Sig += ')'
+        m3Sig += '('
+        if decl['ret']['tag'] == 'S':
+            m3Sig += 'i'
+        for arg in decl['args']:
+            tag = arg['type']['tag']
+            if tag == 'p' or tag == 'S':
+                tag = 'i'
+            m3Sig += tag
+        m3Sig += ')'
 
 
-		s += '	res = m3_LinkRawFunction(module, "*", "' + name + '", "' + m3Sig + '", ' + cname + '_stub);\n'
-		s += '	if(res != m3Err_none && res != m3Err_functionLookupFailed)\n'
-		s += '	{\n'
-		s += '		oc_log_error("Couldn\'t link function ' + name + ' (%s)\\n", res);\n'
-		s += '		ret = -1;\n'
-		s += '	}\n\n'
+        s += '  res = m3_LinkRawFunction(module, "*", "' + name + '", "' + m3Sig + '", ' + cname + '_stub);\n'
+        s += '  if(res != m3Err_none && res != m3Err_functionLookupFailed)\n'
+        s += '  {\n'
+        s += '      oc_log_error("Couldn\'t link function ' + name + ' (%s)\\n", res);\n'
+        s += '      ret = -1;\n'
+        s += '  }\n\n'
 
-	s += '\treturn(ret);\n}\n'
+    s += '\treturn(ret);\n}\n'
 
-	print(s, file=host_bindings)
+    print(s, file=host_bindings)
 
 
 if __name__ == "__main__":
-	parser = ArgumentParser(prog='bindgen.py')
-	parser.add_argument('api')
-	parser.add_argument('spec')
-	parser.add_argument('-g', '--guest-stubs')
-	parser.add_argument('--guest-include')
-	parser.add_argument('--wasm3-bindings')
+    parser = ArgumentParser(prog='bindgen.py')
+    parser.add_argument('api')
+    parser.add_argument('spec')
+    parser.add_argument('-g', '--guest-stubs')
+    parser.add_argument('--guest-include')
+    parser.add_argument('--wasm3-bindings')
 
-	args = parser.parse_args()
+    args = parser.parse_args()
 
-	apiName = args.api
-	spec = args.spec
-	guest_stubs_path = args.guest_stubs
-	if guest_stubs_path == None:
-		guest_stubs_path = 'bindgen_' + apiName + '_guest_stubs.c'
+    apiName = args.api
+    spec = args.spec
+    guest_stubs_path = args.guest_stubs
+    if guest_stubs_path == None:
+        guest_stubs_path = 'bindgen_' + apiName + '_guest_stubs.c'
 
-	wasm3_bindings_path = args.wasm3_bindings
-	if wasm3_bindings_path == None:
-		wasm3_bindings_path = 'bindgen_' + apiName + '_wasm3_bindings.c'
+    wasm3_bindings_path = args.wasm3_bindings
+    if wasm3_bindings_path == None:
+        wasm3_bindings_path = 'bindgen_' + apiName + '_wasm3_bindings.c'
 
-	bindgen(apiName, spec,
-		guest_stubs=guest_stubs_path,
-		guest_include=args.guest_include,
-		wasm3_bindings=wasm3_bindings_path,
-	)
+    bindgen(apiName, spec,
+        guest_stubs=guest_stubs_path,
+        guest_include=args.guest_include,
+        wasm3_bindings=wasm3_bindings_path,
+    )

scripts/bundle.py

@@ -70,8 +70,8 @@ def macos_make_app(args):
 	#-----------------------------------------------------------
 	orca_exe = os.path.join(args.orca_dir, 'build/bin/orca_runtime')
 	orca_lib = os.path.join(args.orca_dir, 'build/bin/liborca.dylib')
-	gles_lib = os.path.join(args.orca_dir, 'ext/angle/bin/libGLESv2.dylib')
-	egl_lib = os.path.join(args.orca_dir, 'ext/angle/bin/libEGL.dylib')
+	gles_lib = os.path.join(args.orca_dir, 'src/ext/angle/bin/libGLESv2.dylib')
+	egl_lib = os.path.join(args.orca_dir, 'src/ext/angle/bin/libEGL.dylib')
 	renderer_lib = os.path.join(args.orca_dir, 'build/bin/mtl_renderer.metallib')
 
 	shutil.copy(orca_exe, exe_dir)
@@ -211,8 +211,8 @@ def windows_make_app(args):
 	#-----------------------------------------------------------
 	orca_exe = os.path.join(args.orca_dir, 'build/bin/orca_runtime.exe')
 	orca_lib = os.path.join(args.orca_dir, 'build/bin/orca.dll')
-	gles_lib = os.path.join(args.orca_dir, 'ext/angle/bin/libGLESv2.dll')
-	egl_lib = os.path.join(args.orca_dir, 'ext/angle/bin/libEGL.dll')
+	gles_lib = os.path.join(args.orca_dir, 'src/ext/angle/bin/libGLESv2.dll')
+	egl_lib = os.path.join(args.orca_dir, 'src/ext/angle/bin/libEGL.dll')
 
 	shutil.copy(orca_exe, os.path.join(exe_dir, app_name + '.exe'))
 	shutil.copy(orca_lib, exe_dir)

scripts/checksum.py

@@ -1,5 +1,6 @@
 import hashlib
 import json
+import os
 
 from .log import *
 
@@ -28,3 +29,80 @@ def checkfile(filepath):
 def filesum(filepath):
     with open(filepath, "rb") as file:
         return hashlib.sha256(file.read()).hexdigest()
+
+
+# -----------------------------------------------------------------------------
+# Directory-hashing implementation pulled from the checksumdir package on pypi.
+# Licensed under the MIT license.
+# -----------------------------------------------------------------------------
+
+def dirsum(
+    dirname,
+    hash_func=hashlib.sha1,
+    excluded_files=None,
+    ignore_hidden=False,
+    followlinks=False,
+    excluded_extensions=None,
+    include_paths=False
+):
+    if not excluded_files:
+        excluded_files = []
+
+    if not excluded_extensions:
+        excluded_extensions = []
+
+    if not os.path.isdir(dirname):
+        raise TypeError("{} is not a directory.".format(dirname))
+
+    hashvalues = []
+    for root, dirs, files in os.walk(dirname, topdown=True, followlinks=followlinks):
+        if ignore_hidden and re.search(r"/\.", root):
+            continue
+
+        dirs.sort()
+        files.sort()
+
+        for fname in files:
+            if ignore_hidden and fname.startswith("."):
+                continue
+
+            if fname.split(".")[-1:][0] in excluded_extensions:
+                continue
+
+            if fname in excluded_files:
+                continue
+
+            hashvalues.append(_filehash(os.path.join(root, fname), hash_func))
+
+            if include_paths:
+                hasher = hash_func()
+                # get the resulting relative path into array of elements
+                path_list = os.path.relpath(os.path.join(root, fname)).split(os.sep)
+                # compute the hash on joined list, removes all os specific separators
+                hasher.update(''.join(path_list).encode('utf-8'))
+                hashvalues.append(hasher.hexdigest())
+
+    return _reduce_hash(hashvalues, hash_func)
+
+
+def _filehash(filepath, hashfunc):
+    hasher = hashfunc()
+    blocksize = 64 * 1024
+
+    if not os.path.exists(filepath):
+        return hasher.hexdigest()
+
+    with open(filepath, "rb") as fp:
+        while True:
+            data = fp.read(blocksize)
+            if not data:
+                break
+            hasher.update(data)
+    return hasher.hexdigest()
+
+
+def _reduce_hash(hashlist, hashfunc):
+    hasher = hashfunc()
+    for hashvalue in sorted(hashlist):
+        hasher.update(hashvalue.encode("utf-8"))
+    return hasher.hexdigest()

scripts/checksums.json

@@ -1,10 +1,10 @@
 {
     "scripts/files/angle-windows-2019-2023-07-05.zip": "a333b5ccc8462151ee8df65c43cfacd70d9db2413f2e495da65670737b5b2d96",
     "scripts/files/angle-macos-jank-2023-07-05.zip": "c234b8db179a24757ab9f46610a032123718dd9bed967d2bf8e27d0d17eb0aff",
-    "ext/angle/bin/libEGL.dll": "b7bf51f83e88129ddc20c0c2cb904ec04c89059a30a2cd29b9b1ea11c80388fb",
-    "ext/angle/lib/libEGL.dll.lib": "4cec54c534136da413dea86bd271ccb9c5ae88e40aa91d1de7a01e701be8e1d7",
-    "ext/angle/bin/libGLESv2.dll": "193b53b0a16b702eaa28a73e84527acf7aecfd665e3e3f54a8d9db9ae73111e1",
-    "ext/angle/lib/libGLESv2.dll.lib": "ee87aac129efe8fe871825d181b85da1b1ea6626cb48be52c2e689f2804b953f",
-    "ext/angle/bin/libEGL.dylib": "96baea4b1c8578d30738764784d07b509d1153df694c094faba2ee8ccbfde2a9",
-    "ext/angle/bin/libGLESv2.dylib": "98ce9f6248a6447ba9199e96b8f6d87df9548d43ce583a2615717aab168ecb71"
-}
+    "src/ext/angle/bin/libEGL.dll": "b7bf51f83e88129ddc20c0c2cb904ec04c89059a30a2cd29b9b1ea11c80388fb",
+    "src/ext/angle/lib/libEGL.dll.lib": "4cec54c534136da413dea86bd271ccb9c5ae88e40aa91d1de7a01e701be8e1d7",
+    "src/ext/angle/bin/libGLESv2.dll": "193b53b0a16b702eaa28a73e84527acf7aecfd665e3e3f54a8d9db9ae73111e1",
+    "src/ext/angle/lib/libGLESv2.dll.lib": "ee87aac129efe8fe871825d181b85da1b1ea6626cb48be52c2e689f2804b953f",
+    "src/ext/angle/bin/libEGL.dylib": "96baea4b1c8578d30738764784d07b509d1153df694c094faba2ee8ccbfde2a9",
+    "src/ext/angle/bin/libGLESv2.dylib": "98ce9f6248a6447ba9199e96b8f6d87df9548d43ce583a2615717aab168ecb71"
+}

scripts/dev.py

@@ -1,7 +1,7 @@
-from datetime import datetime
 import glob
 import os
 import platform
+import re
 import urllib.request
 import shutil
 import subprocess
@@ -9,16 +9,18 @@ from zipfile import ZipFile
 
 from . import checksum
 from .bindgen import bindgen
+from .checksum import dirsum
 from .gles_gen import gles_gen
 from .log import *
-from .utils import pushd, removeall
+from .utils import pushd, removeall, yeetdir, yeetfile
 from .embed_text_files import *
+from .version import check_if_source, is_orca_source, orca_version
 
 ANGLE_VERSION = "2023-07-05"
-
+MAC_SDK_DIR = "/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk"
 
 def attach_dev_commands(subparsers):
-    dev_cmd = subparsers.add_parser("dev", help="Commands for building Orca itself. Must be run from the root of an Orca source checkout.")
+    dev_cmd = subparsers.add_parser("dev", help="Commands for building Orca itself. Must be run from within an Orca source checkout.")
     dev_cmd.set_defaults(func=orca_source_only)
 
     dev_sub = dev_cmd.add_subparsers(required=is_orca_source(), title='commands')
@@ -34,37 +36,8 @@ def attach_dev_commands(subparsers):
     install_cmd.add_argument("--no-confirm", action="store_true", help="don't ask the user for confirmation before installing")
     install_cmd.set_defaults(func=dev_shellish(install))
 
-
-# Checks if the Orca tool should use a source checkout of Orca instead of a system install.
-# This is copy-pasted to the command-line tool so it can work before loading anything.
-#
-# Returns: (use source, source directory, is actually the source's tool)
-def check_if_source():
-    def path_is_in_orca_source(path):
-        dir = path
-        while True:
-            try:
-                os.stat(os.path.join(dir, ".orcaroot"))
-                return (True, dir)
-            except FileNotFoundError:
-                pass
-
-            newdir = os.path.dirname(dir)
-            if newdir == dir: # TODO: Verify on Windows (it will probably not work)
-                return (False, None)
-            dir = newdir
-
-    in_source, current_source_dir = path_is_in_orca_source(os.getcwd())
-    script_is_source, script_source_dir = path_is_in_orca_source(os.path.dirname(os.path.abspath(__file__)))
-
-    use_source = in_source or script_is_source
-    source_dir = current_source_dir or script_source_dir
-    return (use_source, source_dir, script_is_source)
-
-
-def is_orca_source():
-    use_source, _, _ = check_if_source()
-    return use_source
+    uninstall_cmd = dev_sub.add_parser("uninstall", help="Uninstall the system installation of Orca.")
+    uninstall_cmd.set_defaults(func=dev_shellish(uninstall))
 
 
 def orca_source_only(args):
@@ -94,12 +67,27 @@ def build_runtime(args):
     build_wasm3(args.release)
     build_orca(args.release)
 
+    with open("build/orcaruntime.sum", "w") as f:
+        f.write(runtime_checksum())
+
+
+def runtime_checksum_last():
+    try:
+        with open("build/orcaruntime.sum", "r") as f:
+            return f.read()
+    except FileNotFoundError:
+        return None
+
+
+def runtime_checksum():
+    return dirsum("src")
+
 
 def clean(args):
-    yeet("build")
-    yeet("ext/angle")
-    yeet("scripts/files")
-    yeet("scripts/__pycache__")
+    yeetdir("build")
+    yeetdir("src/ext/angle")
+    yeetdir("scripts/files")
+    yeetdir("scripts/__pycache__")
 
 
 def build_platform_layer(target, release):
@@ -142,8 +130,8 @@ def build_platform_layer_lib_win(release):
 
     includes = [
         "/I", "src",
-        "/I", "ext",
-        "/I", "ext/angle/include",
+        "/I", "src/ext",
+        "/I", "src/ext/angle/include",
     ]
     libs = [
         "user32.lib",
@@ -158,7 +146,7 @@ def build_platform_layer_lib_win(release):
         "shlwapi.lib",
         "dxgi.lib",
         "dxguid.lib",
-        "/LIBPATH:ext/angle/lib",
+        "/LIBPATH:src/ext/angle/lib",
         "libEGL.dll.lib",
         "libGLESv2.dll.lib",
         "/DELAYLOAD:libEGL.dll",
@@ -180,13 +168,11 @@ def build_platform_layer_lib_win(release):
     ], check=True)
 
 def build_platform_layer_lib_mac(release):
-    sdk_dir = "/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk"
-
-    flags = ["-mmacos-version-min=10.15.4", "-maes"]
+    flags = ["-mmacos-version-min=10.15.4"]
     cflags = ["-std=c11"]
     debug_flags = ["-O3"] if release else ["-g", "-DOC_DEBUG", "-DOC_LOG_COMPILE_DEBUG"]
-    ldflags = [f"-L{sdk_dir}/usr/lib", f"-F{sdk_dir}/System/Library/Frameworks/"]
-    includes = ["-Isrc", "-Isrc/util", "-Isrc/platform", "-Iext", "-Iext/angle/include"]
+    ldflags = [f"-L{MAC_SDK_DIR}/usr/lib", f"-F{MAC_SDK_DIR}/System/Library/Frameworks/"]
+    includes = ["-Isrc", "-Isrc/util", "-Isrc/platform", "-Isrc/ext", "-Isrc/ext/angle/include"]
 
     # compile metal shader
     subprocess.run([
@@ -225,7 +211,7 @@ def build_platform_layer_lib_mac(release):
         *ldflags, "-dylib",
         "-o", "build/bin/liborca.dylib",
         "build/orca_c.o", "build/orca_objc.o",
-        "-Lext/angle/bin", "-lc",
+        "-Lsrc/ext/angle/bin", "-lc",
         "-framework", "Carbon", "-framework", "Cocoa", "-framework", "Metal", "-framework", "QuartzCore",
         "-weak-lEGL", "-weak-lGLESv2",
     ], check=True)
@@ -268,14 +254,14 @@ def build_wasm3(release):
 
 
 def build_wasm3_lib_win(release):
-    for f in glob.iglob("./ext/wasm3/source/*.c"):
+    for f in glob.iglob("./src/ext/wasm3/source/*.c"):
         name = os.path.splitext(os.path.basename(f))[0]
         subprocess.run([
             "cl", "/nologo",
             "/Zi", "/Zc:preprocessor", "/c",
             "/O2",
             f"/Fo:build/obj/{name}.obj",
-            "/I", "./ext/wasm3/source",
+            "/I", "./src/ext/wasm3/source",
             f,
         ], check=True)
     subprocess.run([
@@ -285,23 +271,24 @@ def build_wasm3_lib_win(release):
 
 
 def build_wasm3_lib_mac(release):
-    includes = ["-Iext/wasm3/source"]
+    includes = ["-Isrc/ext/wasm3/source"]
     debug_flags = ["-g", "-O2"]
     flags = [
         *debug_flags,
         "-foptimize-sibling-calls",
         "-Wno-extern-initializer",
         "-Dd_m3VerboseErrorMessages",
+        "-mmacos-version-min=10.15.4"
     ]
 
-    for f in glob.iglob("ext/wasm3/source/*.c"):
+    for f in glob.iglob("src/ext/wasm3/source/*.c"):
         name = os.path.splitext(os.path.basename(f))[0] + ".o"
         subprocess.run([
             "clang", "-c", *flags, *includes,
             "-o", f"build/obj/{name}",
             f,
         ], check=True)
-    subprocess.run(["ar", "-rcs", "build/lib/libwasm3.a", *glob.glob("build/obj/*.o")], check=True)
+    subprocess.run(["libtool", "-static", "-o", "build/lib/libwasm3.a", "-no_warning_for_no_symbols", *glob.glob("build/obj/*.o")], check=True)
     subprocess.run(["rm", "-rf", "build/obj"], check=True)
 
 
@@ -327,9 +314,9 @@ def build_orca_win(release):
     # compile orca
     includes = [
         "/I", "src",
-        "/I", "ext",
-        "/I", "ext/angle/include",
-        "/I", "ext/wasm3/source",
+        "/I", "src/ext",
+        "/I", "src/ext/angle/include",
+        "/I", "src/ext/wasm3/source",
     ]
     libs = [
         "/LIBPATH:build/bin",
@@ -352,17 +339,15 @@ def build_orca_mac(release):
 
     includes = [
         "-Isrc",
-        "-Iext",
-        "-Iext/angle/include",
-        "-Iext/wasm3/source"
+        "-Isrc/ext",
+        "-Isrc/ext/angle/include",
+        "-Isrc/ext/wasm3/source"
     ]
     libs = ["-Lbuild/bin", "-Lbuild/lib", "-lorca", "-lwasm3"]
     debug_flags = ["-O2"] if release else ["-g", "-DOC_DEBUG -DOC_LOG_COMPILE_DEBUG"]
     flags = [
         *debug_flags,
-        "-mmacos-version-min=10.15.4",
-        "-maes",
-    ]
+        "-mmacos-version-min=10.15.4"]
 
     gen_all_bindings()
 
@@ -387,7 +372,7 @@ def build_orca_mac(release):
 
 
 def gen_all_bindings():
-    gles_gen("ext/gl.xml",
+    gles_gen("src/ext/gl.xml",
         "src/wasmbind/gles_api.json",
         "src/graphics/orca_gl31.h"
     )
@@ -419,28 +404,61 @@ def gen_all_bindings():
 
 def ensure_programs():
     if platform.system() == "Windows":
+        MSVC_MAJOR, MSVC_MINOR = 19, 35
         try:
-            subprocess.run(["cl"], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+            cl_only = subprocess.run(["cl"], capture_output=True, text=True)
+            desc = cl_only.stderr.splitlines()[0]
+
+            detect = subprocess.run(["cl", "/EP", "scripts\\msvc_version.txt"], capture_output=True, text=True)
+            parts = [x for x in detect.stdout.splitlines() if x]
+            version, arch = int(parts[0]), parts[1]
+            major, minor = int(version / 100), version % 100
+
+            if arch != "x64":
+                msg = log_error("MSVC is not running in 64-bit mode. Make sure you are running in")
+                msg.more("an x64 Visual Studio command prompt, such as the \"x64 Native Tools")
+                msg.more("Command Prompt\" from your Start Menu.")
+                msg.more()
+                msg.more("MSVC reported itself as:")
+                msg.more(desc)
+                exit(1)
+
+            if major < MSVC_MAJOR or minor < MSVC_MINOR:
+                msg = log_error(f"Your version of MSVC is too old. You have version {major}.{minor},")
+                msg.more(f"but version {MSVC_MAJOR}.{MSVC_MINOR} or greater is required.")
+                msg.more()
+                msg.more("MSVC reported itself as:")
+                msg.more(desc)
+                msg.more()
+                msg.more("Please update Visual Studio to the latest version and try again.")
+                exit(1)
         except FileNotFoundError:
             msg = log_error("MSVC was not found on your system.")
-            msg.more("If you have already installed Visual Studio, make sure you are running in a")
-            msg.more("Visual Studio command prompt or you have run vcvarsall.bat. Otherwise, download")
-            msg.more("and install Visual Studio: https://visualstudio.microsoft.com/")
+            msg.more("If you have already installed Visual Studio, make sure you are running in an")
+            msg.more("x64 Visual Studio command prompt, such as the \"x64 Native Tools Command")
+            msg.more("Prompt\" from your Start Menu. Otherwise, download and install Visual Studio,")
+            msg.more("and ensure that your installation includes \"Desktop development with C++\"")
+            msg.more("and \"C++ Clang Compiler\": https://visualstudio.microsoft.com/")
             exit(1)
 
-    try:
-        subprocess.run(["clang", "-v"], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
-    except FileNotFoundError:
-        msg = log_error("clang was not found on your system.")
-        if platform.system() == "Windows":
-            msg.more("We recommend installing clang via the Visual Studio installer.")
-        elif platform.system() == "Darwin":
+    if platform.system() == "Darwin":
+        try:
+            subprocess.run(["clang", "-v"], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+        except FileNotFoundError:
+            msg = log_error("clang was not found on your system.")
             msg.more("Run the following to install it:")
             msg.more()
             msg.more("  brew install llvm")
             msg.more()
-        exit(1)
-    # TODO(ben): Check for xcode command line tools
+            exit(1)
+
+        if not os.path.exists(MAC_SDK_DIR):
+            msg = log_error("The Xcode command-line tools are not installed.")
+            msg.more("Run the following to install them:")
+            msg.more()
+            msg.more("  xcode-select --install")
+            msg.more()
+            exit(1)
 
 
 def ensure_angle():
@@ -456,15 +474,15 @@ def verify_angle():
     checkfiles = None
     if platform.system() == "Windows":
         checkfiles = [
-            "ext/angle/bin/libEGL.dll",
-            "ext/angle/lib/libEGL.dll.lib",
-            "ext/angle/bin/libGLESv2.dll",
-            "ext/angle/lib/libGLESv2.dll.lib",
+            "src/ext/angle/bin/libEGL.dll",
+            "src/ext/angle/lib/libEGL.dll.lib",
+            "src/ext/angle/bin/libGLESv2.dll",
+            "src/ext/angle/lib/libGLESv2.dll.lib",
         ]
     elif platform.system() == "Darwin":
         checkfiles = [
-            "ext/angle/bin/libEGL.dylib",
-            "ext/angle/bin/libGLESv2.dylib",
+            "src/ext/angle/bin/libEGL.dylib",
+            "src/ext/angle/bin/libGLESv2.dylib",
         ]
 
     if checkfiles is None:
@@ -509,11 +527,7 @@ def download_angle():
     with ZipFile(filepath, "r") as anglezip:
         anglezip.extractall(path="scripts/files")
 
-    shutil.copytree(f"scripts/files/angle/", "ext/angle", dirs_exist_ok=True)
-
-def yeet(path):
-    os.makedirs(path, exist_ok=True)
-    shutil.rmtree(path)
+    shutil.copytree(f"scripts/files/angle/", "src/ext/angle", dirs_exist_ok=True)
 
 
 def prompt(msg):
@@ -526,22 +540,54 @@ def prompt(msg):
         else:
             print("Please enter \"yes\" or \"no\" and press return.")
 
+def install_dir():
+    if platform.system() == "Windows":
+        return os.path.join(os.getenv("LOCALAPPDATA"), "orca")
+    else:
+        return os.path.expanduser(os.path.join("~", ".orca"))
+
 
 def install(args):
-    if platform.system() == "Windows":
-        dest = os.path.join(os.getenv("LOCALAPPDATA"), "orca")
-    else:
-        dest = os.path.expanduser(os.path.join("~", ".orca"))
+    if runtime_checksum_last() is None:
+        print("You must build the Orca runtime before you can install it to your")
+        print("system. Please run the following command first:")
+        print()
+        print("orca dev build-runtime")
+        exit(1)
+
+    if runtime_checksum() != runtime_checksum_last():
+        print("Your build of the Orca runtime is out of date. We recommend that you")
+        print("rebuild the runtime first with `orca dev build-runtime`.")
+        if not prompt("Do you wish to install the runtime anyway?"):
+            return
+        print()
+
+    dest = install_dir()
+    bin_dir = os.path.join(dest, "bin")
+    src_dir = os.path.join(dest, "src")
+    version_file = os.path.join(dest, ".orcaversion")
+
+    version = orca_version()
+    existing_version = None
+    try:
+        with open(version_file, "r") as f:
+            existing_version = f.read().strip()
+    except FileNotFoundError:
+        pass
 
     if not args.no_confirm:
-        print("The Orca command-line tools will be installed to:")
+        print(f"The Orca command-line tools (version {version}) will be installed to:")
         print(dest)
         print()
+        if existing_version is not None:
+            print(f"This will overwrite version {existing_version}.")
+            print()
         if not prompt("Proceed with the installation?"):
             return
 
-    bin_dir = os.path.join(dest, "bin")
-    yeet(bin_dir)
+    yeetdir(bin_dir)
+    yeetdir(src_dir)
+    yeetfile(version_file)
 
     # The MS Store version of Python does some really stupid stuff with AppData:
     # https://git.handmade.network/hmn/orca/issues/32
@@ -552,14 +598,19 @@ def install(args):
     # paths we need, the following scripts work regardless of Python install.
     #
     # Also apparently you can't just do mkdir in a subprocess call here, hence the
-    # trivial batch script.
+    # trivial batch scripts.
     if platform.system() == "Windows":
         subprocess.run(["scripts\\mkdir.bat", bin_dir], check=True)
+        subprocess.run(["scripts\\mkdir.bat", src_dir], check=True)
+        subprocess.run(["scripts\\touch.bat", version_file], check=True)
 
     shutil.copytree("scripts", os.path.join(bin_dir, "sys_scripts"))
     shutil.copy("orca", bin_dir)
+    shutil.copytree("src", src_dir, dirs_exist_ok=True)
     if platform.system() == "Windows":
         shutil.copy("orca.bat", bin_dir)
+    with open(version_file, "w") as f:
+        f.write(version)
 
     print()
     if platform.system() == "Windows":
@@ -568,14 +619,59 @@ def install(args):
         print()
         print("The tools will need to be on your PATH in order to actually use them.")
         if prompt("Would you like to automatically add Orca to your PATH?"):
-            subprocess.run(["powershell", "scripts\\updatepath.ps1", bin_dir], check=True)
-            print("Orca has been added to your PATH. Restart any open terminals to use it.")
+            try:
+                subprocess.run(["powershell", "-ExecutionPolicy", "Bypass", "scripts\\updatepath.ps1", f'"{bin_dir}"'], check=True)
+                print("Orca has been added to your PATH. Restart any open terminals to use it.")
+            except subprocess.CalledProcessError:
+                msg = log_warning(f"Failed to automatically add Orca to your PATH.")
+                msg.more("Please manually add the following directory to your PATH:")
+                msg.more(bin_dir)
         else:
             print("No worries. You can manually add Orca to your PATH in the Windows settings")
-            print("this in the Windows settings by searching for \"environment variables\".")
+            print("by searching for \"environment variables\".")
     else:
         print("The Orca tools have been installed. Make sure the Orca tools are on your PATH by")
         print("adding the following to your shell config:")
         print()
         print(f"export PATH=\"{bin_dir}:$PATH\"")
     print()
+
+def install_path():
+    if platform.system() == "Windows":
+        orca_dir = os.path.join(os.getenv("LOCALAPPDATA"), "orca")
+    else:
+        orca_dir = os.path.expanduser(os.path.join("~", ".orca"))
+
+    bin_dir = os.path.join(orca_dir, "bin")
+
+    return (orca_dir, bin_dir)
+
+def yeet(path):
+    os.makedirs(path, exist_ok=True)
+    shutil.rmtree(path)
+
+
+def uninstall(args):
+    orca_dir, bin_dir = install_path()
+
+    if not os.path.exists(orca_dir):
+        print("Orca is not installed on your system.")
+        exit()
+
+    print(f"Orca is currently installed at {orca_dir}.")
+    if prompt("Are you sure you want to uninstall?"):
+        yeet(orca_dir)
+
+        if platform.system() == "Windows":
+            print("Orca has been uninstalled from your system.")
+            print()
+            if prompt("Would you like to automatically remove Orca from your PATH?"):
+                try:
+                    subprocess.run(["powershell", "-ExecutionPolicy", "Bypass", "scripts\\updatepath.ps1", f'"{bin_dir}"', "-remove"], check=True)
+                    print("Orca has been removed from your PATH.")
+                except subprocess.CalledProcessError:
+                    msg = log_warning(f"Failed to automatically remove Orca from your PATH.")
+                    msg.more("Please manually remove the following directory from your PATH:")
+                    msg.more(bin_dir)
+        else:
+            print("Orca has been uninstalled from your system. You may wish to remove it from your PATH.")

scripts/msvc_version.txt

@@ -0,0 +1,9 @@
+_MSC_VER
+
+#if defined(__x86_64__) || defined(_M_X64)
+x64
+#elif defined(i386) || defined(__i386__) || defined(__i386) || defined(_M_IX86)
+x86
+#else
+unknown
+#endif

scripts/orca.py

@@ -1,15 +1,31 @@
 #!/usr/bin/env python3
 
 import argparse
+import sys
 
 from .bundle import attach_bundle_commands
+from .source import attach_source_commands
 from .dev import attach_dev_commands
+from .version import attach_version_command
 
 parser = argparse.ArgumentParser()
+parser.add_argument("-?", action="help", help=argparse.SUPPRESS)
 
-subparsers = parser.add_subparsers(required=True, title='commands')
+subparsers = parser.add_subparsers(required=True, title="commands")
 attach_bundle_commands(subparsers)
+attach_source_commands(subparsers)
 attach_dev_commands(subparsers)
+attach_version_command(subparsers)
 
-args = parser.parse_args()
+# Hack to run the actual version command if we pass -v or --version.
+# Using argparse action="version" requires us to pass a single string
+# and doesn't allow us to run our own custom version-printing function.
+argv = sys.argv[1:]
+
+if len(argv) == 0:
+    argv = ["-h"]
+elif argv[0] in ["-v", "--version"]:
+    argv = ["version"]
+
+args = parser.parse_args(argv)
 args.func(args)

scripts/sample_build_check.py

@@ -0,0 +1,61 @@
+import platform
+import re
+import shutil
+import subprocess
+import textwrap
+
+CLANG_MAJOR, CLANG_MINOR = 11, 0
+
+def printw(str=""):
+    print(textwrap.fill(str))
+
+def print_clang_install_info(upgrade):
+    if platform.system() == "Windows":
+        printw(f"Please install Clang {CLANG_MAJOR}.{CLANG_MINOR} or newer. We recommend installing Clang via the Visual Studio installer. In the installer, search for \"C++ Clang Compiler\".")
+    elif platform.system() == "Darwin":
+        printw(f"Please install Clang {CLANG_MAJOR}.{CLANG_MINOR} or newer. We recommend installing Clang via Homebrew (https://brew.sh/):")
+        printw()
+        if upgrade:
+            printw("  brew upgrade llvm")
+        else:
+            printw("  brew install llvm")
+        printw()
+    else:
+        printw(f"Please install Clang {CLANG_MAJOR}.{CLANG_MINOR} or newer.")
+
+try:
+    out = subprocess.run(["clang", "--version"], capture_output=True, text=True, check=True)
+    m = re.search(r"clang version (\d+)\.(\d+)\.(\d+)", out.stdout)
+    major, minor, patch = int(m.group(1)), int(m.group(2)), int(m.group(3))
+    if major < CLANG_MAJOR or minor < CLANG_MINOR:
+        printw(f"ERROR: Your version of Clang is too old. You have version {major}.{minor}.{patch}, but version {CLANG_MAJOR}.{CLANG_MINOR} or greater is required.")
+        printw()
+        printw("This script is currently running the clang located at:")
+        printw(shutil.which("clang"))
+        printw()
+        print_clang_install_info(True)
+        exit(1)
+except FileNotFoundError:
+    printw("ERROR: clang is not installed. The Orca samples require Clang in order to compile C programs to WebAssembly.")
+    printw()
+    print_clang_install_info(False)
+    exit(1)
+except subprocess.CalledProcessError:
+    printw("WARNING: Could not check Clang version. You may encounter build errors.")
+
+try:
+    subprocess.run(["wasm-ld", "--version"], capture_output=True, check=True)
+except FileNotFoundError:
+    printw("ERROR: wasm-ld was not found on your system. This is a component of Clang that is required in order to produce WebAssembly modules. This likely means that an old or otherwise incompatible version of Clang is being used, such as Apple's version of Clang.")
+    printw()
+    print_clang_install_info(False)
+    exit(1)
+
+try:
+    subprocess.run(["orca", "version"], capture_output=True, shell=True, check=True)
+except subprocess.CalledProcessError:
+    printw("ERROR: The Orca tooling has not been installed to your system or is not on your PATH. From the root of the Orca source code, please run the following commands:")
+    printw()
+    printw("  python orca dev build-runtime")
+    printw("  python orca dev install")
+    exit(1)

scripts/source.py

@@ -0,0 +1,113 @@
+import hashlib
+import json
+import os
+import re
+import shutil
+
+from .checksum import dirsum
+from .log import *
+from .utils import yeetdir
+from .version import src_dir, orca_version
+
+
+def attach_source_commands(subparsers):
+    source_cmd = subparsers.add_parser("source", help="Commands for helping compile the Orca source code into your project.")
+    source_sub = source_cmd.add_subparsers(required=True, title="commands")
+
+    cflags_cmd = source_sub.add_parser("cflags", help="Get help setting up a C or C++ compiler to compile the Orca source.")
+    cflags_cmd.add_argument("srcdir", nargs="?", default=src_dir(), help="the directory containing the Orca source code (defaults to system installation)")
+    cflags_cmd.set_defaults(func=shellish(cflags))
+
+    vendor_cmd = source_sub.add_parser("vendor", help="Copy the Orca source code into your project.")
+    vendor_cmd.add_argument("dir", type=str, help="the directory into which the Orca source code will be copied")
+    vendor_cmd.set_defaults(func=shellish(vendor))
+
+
+def vendor(args):
+    # Verify that we are ok to vendor into the requested dir.
+    if os.path.exists(args.dir):
+        try:
+            with open(vendor_file_path(args.dir), "r") as f:
+                vendor_info = json.load(f)
+                version = vendor_info["version"]
+            print(f"Orca version {version} is currently installed in that directory.")
+
+            if vendor_checksum(args.dir) != vendor_info["checksum"]:
+                log_error(f"The contents of your vendor directory have been modified. This command will exit to avoid overwriting any local changes. To proceed, manually delete {args.dir} and try again.")
+                exit(1)
+        except FileNotFoundError:
+            if len(os.listdir(args.dir)) > 0:
+                log_error(f"The requested directory already exists and does not appear to contain Orca source code. To avoid deleting anything important, please either provide the correct path or manually empty {args.dir} first.")
+                exit(1)
+
+    yeetdir(args.dir)
+    shutil.copytree(src_dir(), args.dir)
+    with open(vendor_file_path(args.dir), "w") as f:
+        json.dump({
+            "version": orca_version(),
+            "checksum": vendor_checksum(args.dir),
+        }, f, indent=2)
+    print(f"Version {orca_version()} of the Orca source code has been copied to {args.dir}.")
+
+
+def vendor_file_path(vendor_dir):
+    return os.path.join(vendor_dir, ".orcavendor")
+
+
+def vendor_checksum(dir):
+    return dirsum(dir, excluded_extensions=["orcavendor"])
+
+
+def cflags(args):
+    if not os.path.exists(os.path.join(args.srcdir, "orca.h")):
+        log_error(f"The provided path does not seem to contain the Orca source code: {args.srcdir}")
+        exit(1)
+    
+    def path_contains(a, b):
+        a_abs = os.path.abspath(a)
+        b_abs = os.path.abspath(b)
+        return os.path.commonpath([a_abs, b_abs]) == a_abs
+
+    def nicepath(path):
+        path_abs = os.path.abspath(path)
+        if path_contains(os.getcwd(), path_abs):
+            return os.path.relpath(path_abs)
+        else:
+            return path_abs
+    
+    include = nicepath(args.srcdir)
+    orcac = nicepath(os.path.join(args.srcdir, "orca.c"))
+    extinclude = nicepath(os.path.join(args.srcdir, "ext"))
+    sysinclude = nicepath(os.path.join(args.srcdir, "libc-shim/include"))
+    libcsource = nicepath(os.path.join(args.srcdir, "libc-shim/src/*.c"))
+
+    print("To compile Orca as part of your C or C++ project, you must:")
+    print(f"> Put the following directory on your SYSTEM include search path:")
+    print(f"  {sysinclude}")
+    print(f"> Put the following directories on your include search path:")
+    print(f"  {include}")
+    print(f"  {extinclude}")
+    print(f"> Compile the following file as a single translation unit:")
+    print(f"  {orcac}")
+    print(f"> Compile the following files as separate translation units:")
+    print(f"  {libcsource}")
+    print()
+    print("The following clang flags are also required:")
+    print("> --target=wasm32         (to compile to wasm)")
+    print("> --no-standard-libraries (to use only our libc shim)")
+    print("> -mbulk-memory           (to enable memset/memcpy intrinsics, which are required)")
+    print("> -D__ORCA__              (to signal that the Orca source code is being compiled to run on Orca itself)")
+    print("> -Wl,--no-entry         (to prevent wasm-ld from looking for a _start symbol)")
+    print("> -Wl,--export-dynamic   (to expose your module's functions to Orca)")
+    print()
+    print("And the following clang flags are recommended:")
+    print("> -g -O2                  (to compile with optimizations and debug info)")
+    print()
+    print("Complete clang example:")
+    print()
+    print(f"clang --target=wasm32 --no-standard-libraries -mbulk-memory -g -O2 -D__ORCA__ -Wl,--no-entry -Wl,--export-dynamic -isystem \"{sysinclude}\" -I \"{include}\" -I \"{extinclude}\" \"{orcac}\" \"{libcsource}\" your-main.c")
+    print()
+    if not path_contains(os.getcwd(), args.srcdir):
+        print("If these paths look crazy to you, consider vendoring the source code into your")
+        print("project using `orca source vendor`.")
+        print()

scripts/touch.bat

@@ -0,0 +1,3 @@
+@echo off
+type nul > %1
+exit /b %errorlevel%

scripts/updatepath.ps1

@@ -1,11 +1,16 @@
 param (
     [parameter(Mandatory=$true)]
-    [string]$orcaPath
+    [string]$orcaPath,
+
+    [switch]$remove
 )
 
 $arrPath = [System.Environment]::GetEnvironmentVariable('PATH', 'User') -split ';'
 $arrPath = $arrPath | Where-Object { $_ -ne $orcaPath } | Where-Object { $_ -ne '' }
-$newPath = ($arrPath + $orcaPath) -join ';'
+if (-not $remove) {
+    $arrPath += $orcaPath
+}
+
+$newPath = $arrPath -join ';'
 
 [System.Environment]::SetEnvironmentVariable('PATH', $newPath, 'User')
-# echo $newPath

scripts/utils.py

@@ -1,7 +1,6 @@
 import glob
 import os
-import subprocess
-import traceback
+import shutil
 
 from contextlib import contextmanager
 
@@ -18,3 +17,13 @@ def pushd(new_dir):
 def removeall(dir):
     [os.remove(f) for f in glob.iglob("{}/*".format(dir), recursive=True)]
     os.removedirs(dir)
+
+
+def yeetdir(path):
+    os.makedirs(path, exist_ok=True)
+    shutil.rmtree(path)
+
+
+def yeetfile(path):
+    if os.path.exists(path):
+        os.remove(path)

scripts/version.py

@@ -0,0 +1,95 @@
+import os
+import subprocess
+import sys
+
+from .log import *
+from .utils import pushd
+
+
+# Checks if the Orca tool should use a source checkout of Orca instead of a system install.
+# This is copy-pasted to the command-line tool so it can work before loading anything.
+#
+# Returns: (use source, source directory, is actually the source's tool)
+def check_if_source():
+    def path_is_in_orca_source(path):
+        dir = path
+        while True:
+            try:
+                os.stat(os.path.join(dir, ".orcaroot"))
+                return (True, dir)
+            except FileNotFoundError:
+                pass
+
+            newdir = os.path.dirname(dir)
+            if newdir == dir:
+                return (False, None)
+            dir = newdir
+
+    in_source, current_source_dir = path_is_in_orca_source(os.getcwd())
+    script_is_source, script_source_dir = path_is_in_orca_source(os.path.dirname(os.path.abspath(__file__)))
+
+    use_source = in_source or script_is_source
+    source_dir = current_source_dir or script_source_dir
+    return (use_source, source_dir, script_is_source)
+
+
+def is_orca_source():
+    use_source, _, _ = check_if_source()
+    return use_source
+
+
+def actual_install_dir():
+    # The path adjustment in here is technically sort of fragile because it depends
+    # on the current location of this actual file. But oh well.
+    if is_orca_source():
+        raise Exception("actual_install_dir should not be called when using the source version of the Orca tools")
+    return os.path.normpath(os.path.join(os.path.abspath(__file__), "../../.."))
+
+
+def src_dir():
+    # More fragile path adjustments! Yay!
+    if is_orca_source():
+        return os.path.normpath(os.path.join(os.path.abspath(__file__), "../../src"))
+    else:
+        return os.path.normpath(os.path.join(os.path.abspath(__file__), "../../../src"))
+
+
+def orca_version():
+    is_source, source_dir, _ = check_if_source()
+    if is_source:
+        with pushd(source_dir):
+            version = "unknown"
+            if os.path.exists(".git"):
+                try:
+                    res = subprocess.run(["git", "rev-parse", "--short", "HEAD"], check=True, capture_output=True, text=True)
+                    version = res.stdout.strip()
+                except subprocess.CalledProcessError:
+                    log_warning("failed to look up current git hash for version number")
+            return f"dev-{version}"
+    else:
+        try:
+            with open(os.path.join(actual_install_dir(), ".orcaversion"), "r") as f:
+                version = f.read().strip()
+                return version
+        except FileNotFoundError:
+            return "dev-unknown"
+
+
+def attach_version_command(subparsers):
+    version_cmd = subparsers.add_parser("version", help="Print the current Orca version.")
+    version_cmd.set_defaults(func=print_orca_version)
+
+
+def print_orca_version(args):
+    use_source, source_dir, _ = check_if_source()
+
+    # This function prints the bare version number to stdout and everything else
+    # to stderr. This makes it easy to use the version number in shell pipelines
+    # without requiring extra flags or parsing a weird output format.
+    sys.stdout.write(orca_version() + "\n")
+    if use_source:
+        sys.stderr.write(f"Orca is running from a source checkout.\n")
+        sys.stderr.write(f"Source dir: {source_dir}\n")
+    else:
+        sys.stderr.write(f"Orca is running from a system installation.\n")
+        sys.stderr.write(f"Install dir: {actual_install_dir()}\n")

src/app/app.c

@@ -188,7 +188,7 @@ oc_key_code oc_scancode_to_keycode(oc_scan_code scanCode)
     return (oc_appData.keyMap[scanCode]);
 }
 
-#define OC_DEFAULT_KEYMAP_ENTRY(sc, sv, ...) [(int) sc] = (oc_key_code)sc,
+#define OC_DEFAULT_KEYMAP_ENTRY(sc, sv, kc, ...) [(int) sc] = OC_VA_NOPT(sv, ##__VA_ARGS__) __VA_ARGS__,
 
 oc_key_code oc_defaultKeyMap[OC_SCANCODE_COUNT] = {
     OC_KEY_TABLE(OC_DEFAULT_KEYMAP_ENTRY)