Overview
| Comment: | initial commit |
|---|---|
| Downloads: | Tarball | ZIP archive | SQL archive |
| Timelines: | family | ancestors | descendants | both | trunk |
| Files: | files | file ages | folders |
| SHA3-256: |
1cc0d769544ba67e549865fa75c32250 |
| User & Date: | lexi on 2025-02-09 20:46:08 |
| Other Links: | manifest | tags |
Context
|
2025-02-10
| ||
| 01:11 | add automatic instance bindings with accessors check-in: 351bb17bed user: lexi tags: trunk | |
|
2025-02-09
| ||
| 20:46 | initial commit check-in: 1cc0d76954 user: lexi tags: trunk | |
| 19:09 | initial empty check-in check-in: 193e0f36da user: lexi tags: trunk | |
Changes
Added gdjn.ct version [3da39adca5].
1 +%toc 2 +#top gdjn 3 +allow use of Godot 4 with a [^civ civilized] scripting language, viz. [>janet Janet]. 4 + 5 + janet: https://janet-lang.org 6 + godot: https://godotengine.org 7 + 8 +@civ { 9 + to meet the bare minimum standards necessary to qualify as [!civilized] to my mind, a language must: 10 + * support compilation, whether to bytecode or machine code (excludes gdscript) 11 + * parse into an AST (excludes bash, php (or used to)) 12 + * support AST-rewriting macros (excludes everything outside the lisp family except maybe rust) 13 + * use real syntax, not whitespace-based kludges (excludes python, gdscript inter alia) 14 + * provide a proper module system (excludes C) 15 + * provide for hygienic namespacing (excludes C, gdscript) 16 + * provide simple, cheap aggregate types (excludes gdscript, java, maybe python depending on how you view tuples) 17 + so, janet and fennel are about the only game in town. 18 +} 19 + 20 + 21 +## building 22 + 23 +###dep dependencies 24 +* [*build-time] 25 +** GNU make 26 +** git 27 +** [>top.janet janet] (automatically downloaded and built in [`ext/janet] by default) 28 +*** CLI binary [`janet] (used to run codegen scripts) 29 +*** linked with static library [`libjanet.a] using header [`janet.h] 30 +** [>top.godot godot] ≥ 4.3, or the following files generated by godot: 31 +*** [`gen/extension_api.json] 32 +*** [`gen/gdextension_interface.h] 33 +* [*runtime] 34 +** godot ≥ 4.3 35 + 36 +## license 37 +the content of this repository is made available under the terms of the [>agpl GNU AGPLv3] except where otherwise noted. the full legally-binding english-language text of this license may be found in the root of this repository in the file [`license.en]. 38 + agpl: https://www.gnu.org/licenses/agpl-3.0.txt 39 + 40 +## about 41 +gdscript is a [>anti-gdscriptische-aktion gibbering aberration] from beyond the stars; this is known. however, as a poor fool determined to write a video game, using godot no less, i resolved to ameliorate my suffering by binding a better language to the engine. such is the depth of my madness. 42 + 43 +"it'll be simple," i told myself. "i've poked at gdextension before; i know it's a nightmare from the sewers of R'lyeh but i've already paid the toll in blood and pain to wrest loose its secrets. i have pretty good sense of what i'm doing this time. janet is well suited to this. [!wgah'nagl fhtagn]. ｉｔ ｗｉｌｌ ｂｅ ｅａｓｙ" 44 + 45 +yes, i was on drugs when i made this decision. i still am 46 + 47 +a week or so later, i found myself implementing a new domain-specific IDL from scratch because that was less work than directly using the GDExtension api. the C side of GDExtension, it must be understood, was not designed for humans to use. it was intended as a scaffolding for godot-cpp, and only exists because C++ does not have a [^abi standardized ABI] -- C++ binaries can only talk to other C++ binaries by using C as a gobetween. no, this is not as crazy as it sounds. it's [!crazier.] 48 + 49 + abi: okay yes in reality it absolutely fucking does, everyone uses the same gods-damned amd one, in actual materially existing reality there is no interop problem at least on x86, but because we haven't ritually enshrined this model at ISO and pacified its marauding [!aramitama] with burnt offerings of motor oil and obsolete DRAM chips, we cover our eyes and pretend we cannot see what is sitting right in front of us. i love too compute dont u 50 + 51 +so GDExtension is designed (if i may use the word liberally) with certain notions fixed firmly in mind. chief among them is that the actual C-level calls will be thoroughly ensconced in a suffocating buffer of template hackery, which will employ dark arts and crafts to generate gobs and gobs of impenetrable C at compile time. in fact, GDExtension is so designed that it is basically impossible to use it directly without a code generation layer. unwilling as i was to use C++ (it's against my religion), i wrote my layer from scratch, in janet. 52 + 53 +this was not as bad as it could have been. janet has something [^deficient magnificent] in its stdlib that every language should have: a PEG module. the resulting program, ["tool/class-compile.janet] is under 1k lines! just barely. this tool is fired off by the makefile for the ["src/*.gcd] files, generating a header file ["gen/*.h] and an object file ["out/*.o] that implements the class described in the file. the care and feeding of this file format is described in the [>gcd GCD section]. 54 + 55 + deficient: it is deficient in one particular way: it only operates over bytestrings. so you can use a PEG to parse raw text, or you can use it to implement a lexer, but you can't have both a PEG lexer and parser, which is really fucking dumb and makes things like dealing with whitespace far more painful than it needs to be.) 56 + 57 +##gcd GCD language 58 +GCD is a simple IDL which is translated into [^complex much more complicated C]. it's designed to make writing GDExtension classes as close to the native GDScript experience as possible, without the syntactic hanging offenses. you define the structure of the class using GCD, and write inline C to implement your functions. linemarkers are emitted properly so when you inevitably fuck it up, the compiler will be able to apportion the blame properly. 59 + 60 + complex: the generated implementation code is roughly 24x longer than the input file 61 + 62 +the C "lexing" is pretty robust, and as long as you aren't doing horrible shit with the preprocessor (on the order of ["#define fi }]) it shouldn't choke on anything you write. if you [!are] doing horrible shit with the preprocessor however, [!you deserve everything you get]. 63 + 64 +["tool/class-compile.janet] accepts the following (nested) forms: 65 + 66 + block: \{ ··· [$[#1]] ··· } 67 + c-block: {block inline C} 68 + scope: {block inner scope} 69 + 70 +* [`(* ... *)] masks out a comment. these nest properly. normal C comments in a C block will be output with the rest of the text; gcd comments will be elided everywhere. 71 +* [`(- ... -)] marks out inline documentation. this is not a comment! it is a syntactical element, allowed only in certain places (before a line item definition, after a return type, at the end of an argument specifier before the terminating comma/semicolon, or after an enum item). javadoc-style doc comments will be generated for the generated C, and it is my hope to also integrate this with godot's online API documentation system, which i will grudgingly acknowledge is pretty fricken neat. 72 +* [`class [$name] (is|extends) [$base] {scope};] define a class [$name] inheriting from [$base]. use [`is] when inheriting from a godot native class; use [`extends] when inheriting from a gdextension class [!defined in your program] (inheriting from foreign gdextension classes will not work as expected either way). the necessity of this distinction is unfortunate; godot's virtual method implementation is hilariously broken so we have to manually hack around that particular cesspit of incompetence 73 +* [`(fn | impl) [$name]([$arg-type] [$arg], ...) -> [$return-type] {c-block};] defines a function. use fn for normal static-dispatch functions; use impl for virtual overrides. these are implemented in bizarrely diverging ways but you don't have to care about that, because i did it for you. [!you owe me.] 74 +** all arguments should be available by name as the proper godot type; e.g. [`string-name] becomes a [`gd_stringName]. 75 +** a pointer to the C-side storage struct for this class can be named by the token [`me]. if you need the godot object, write [`me -> self]. 76 +** for void functions, omit the [`-> [$return-type]] clause. 77 +* [`var [$c-type] as [$gd-type]: [$v1], [$v2], ...;] defines a public class field (or global, at unit scope). [$c-type] is the actual storage type of the object; omit it to have a sensible choice picked for you based on [$gd-type]. [$gd-type] is the godot type that this field will be presented as. 78 +* [`var [$c-type]: [$v1], [$v2], ...;] defines a private class field, accessible only to C. 79 +** note that [*you cannot use intializers here] (yet, anyway); defining a reasonable syntax for a type that has to translate between C and the Godot type system is a decidedly nontrivial endeavor, and would probably have been more complicated than the rest of the syntax combined. for now, initialize your variables in [`new {c-block}]. 80 +* [`(import | use) <[$header]>;] transcludes a C system include into the unit. [`import] is the equivalent of using [`#include] in a header file; [`use] is the equivalent of using it in an implementation file. 81 +* [`(import | use) \"[$header]\";] transcludes a local C file into the unit. 82 +* [`(import | use) {c-block};] dumps a block of C code into the header or implementation. use this to e.g. define utility functions. 83 +* [`new {c-block};] defines the class constructor 84 +* [`del {c-block};] defines the class destructor. remember that in godot-land refcounting is used, so sane RAII is kind of out of the question unless you're imposing manual memory management on your poor end users 85 +* [*godot types]: these are named using lisp-style tokens instead of the normal godot camelcase, both because i prefer it immensely and because it simplifies the more aggravating aspects of generating appropriate C from this trainwreck. 86 +** primitive types: [`string], [`string-name], [`int], [`float], [`packed-float64-array] etc. 87 +** container types: [`array], [`array\[[$prim-type]\]], [`dictionary], [`dictionary\[[$prim-key], [$prim-val]\]] 88 +** reference types: these are prefixed with the [`ref] keyword, e.g [`ref node-3D], [`ref rich-text-label] etc. you can also write these as normal camelcase ([`ref RichTextLabel]) if you like, since i don't have to care about the internal structure of the identifier at this point. 89 + 90 +note that [*semicolons are mandatory] after every statement. whitespace is irrelevant except as a token-separator. 91 + 92 +the interface for each unit is written to ["gen/*.h]. be sure to call the unit load function at the proper place and time. 93 + 94 +#anti-gdscriptische-aktion manifesto against GDScript 95 +> [!gdscript is a gibbering aberration from beyond the stars] 96 + 97 +okay, this is, if anything, an understatement. it is possibly the single worst programming language i have yet (however begrudgingly) coded in. the tale of gdscript is one of fantastical hubris, of strife and horror and punishment handed down by the gods from on high like unto the sagas of old. 98 + 99 +the creators of gdscript, you see (whom i shall henceforth address by the name of Abdul al-Hazred, for reasons i hope are readily apparent) originally wanted to use lua as godot's scripting language, and made an attempt to do so (this was sensible) but they concluded (incorrectly) that lua's facilities for threading were insufficient (i.e. they did not understand how to use the library correctly), so, having zero domain expertise or relevant experience, they resolved to devise their very own language from scratch. (this [>blunder was not]. i am put in mind of how Brendan Eich (piss be upon him) actually wanted to use a Scheme as Netscape's scripting language -- as i would have in his place! -- but the bleating idiot suits wanted something they could (however dishonestly) slap the Java branding on, so instead the entire modern web is infested by unending reams of [>wat ECMAScript]. more ECMAScript than there are stars. [!more ECMAScript than there is light]) 100 + 101 +so, knowing nothing of elementary PL theory, they hacked together a lurching screeching nightmare that is the antithesis to everything lua has ever been. shall i number the ways? 102 + 103 +: lua has clean, consistent, unambiguous syntax that completely elides any need for syntactic handholding like brackets or (outside one niggling edge case) semicolons or line continuation sigils; gdscript reads the entrails of your indenting discipline and tries to infer structure therefrom (except for enums, for some unfathomable reason, which use C-style bracket blocks), which you inevitably have to hack your way around with the aforementioned semicolons and backslashes, and no matter what you do your code looks hideous. even this is inconsistent: the (woefully inadequate) match statement ([!"statement"], i will note, [!not] "expression"; the ML weenies in the audience just flinched, and rightly so) absolutely requires whitespace and newlines to delimit its cases. 104 +: lua has a simple but extensible prototype-ish object model. godot has a full-blown class system with all the elegance of GObject, all the efficiency of Java, all the consistency of an American politician, and all the expressive power of MUMPS. single inheritance, no interfaces, no templates, no generics, no macros, no mixins. in a [!game engine]. [!lunacy, i tell you.] 105 +: lua is cleverly designed to use tables to implement namespacing. in point of fact, namespacing is emergent; it's barely even part of the language. every lua chunk has its own clean namespace (or a shared global environment, an the host program will it so), and can choose what to bring in by binding modules to variables. gdscript barely supports namespacing at all, and in such a broken fucking way the native classes don't even try to use it. inner classes are defective, with reduced autocomplete metadata from other units, and cannot be used as resources. i honestly cannot fathom how they fucked this up so badly. every godot class you create pretty much pollutes a global namespace, and the situation is so bad that addon writers follow a convention of [!not naming their classes at all], using path-based imports instead. 106 +: lua is a reasonable functional language. you can use any FP paradigm you want, with a bit of effort. closures are lightweight, simple, and fun to use. there is no difference between an ordinary function and a lambda. gdscript, on the other hand, is a procedural language with lambdas hacked awkwardly in, with syntax that will make you long for the purity of ruby. a closure is a completely different thing from functions, an object of class Callable, and can only be invoked by using [`Callable.call(args)]. and of course closures are completely untyped. 107 +: lua has a straightforward dynamic type system. not great, but it's bearable. gdscript has a bizarre and spiritually unclean gradual typing system (i have always been suspicious of this concept and i am now firmly of the opinion that gradual typing is categorically a bug, not a feature.) it is not even internally consistent. "typed arrays" are not a type at all, but bizarre syntactic sugar for an array-specific runtime type tagging system. typed dictionaries [!were not even available] until 4.4, which at the time of writing is still in pre-release. there are no generics, no templates. just [`Variant], and special-casing as far as the eye can see. this is almost the worst part, because to use godot at all, even from another language, you have to interact with this abortion somehow. i am going to have to wrap some kind of elaborate blast shield around it to make it usable from janet and i do not eagerly anticipate the process. 108 +: lua compiles down to bytecode. the reference implementation is not terribly impressive speed-wise, but luajit (an ideological variant based on pre-5.3 lua, not an implementation as it is often called) has performance characteristics bordering on C itself. gdscript does not compile at all; at best, it is pre-tokenized. yes, the entire damn thing is interpreted, at runtime. [*this alone should be enough to rule it out summarily as a game scripting language.] i mean, [!for shame]. fucking [!ruby] is probably more efficient at this point (not that i suggest anyone pull an RPGMaker XP here). 109 + 110 +this is not exhaustive. this isn't even getting into the rat fuck screaming lunacy that is the underlying implementation. this is just the particular set of aggravations that came most immediately to mind when i set my cyberquill to electric paper. this is just a fucking taste, a faint flickering preview of how bad it gets. [!and people use this language for serious work.] they claim to [!like] it. the godot team blithely encourages people to learn gdscript, enthusing on its many virtues, as if they should not be too ashamed to show their faces where unsullied souls might see. the absolute mindless [!gall] is beyond all reckoning. i would say that this is the fucking PHP fractal-of-bad-design fiasco all over again, except, like, I've used PHP. [!i prefer PHP to this monstrosity.] yes, even ye-olde-worlde PHP, with [`register_globals] and all. i think it is fair to say that gdscript is to lua as modern American English is to [>toki Toki Pona] or Japanese. 111 +in broad conclusion, gdscript is not a programming language. it is barely a scripting language. it is a genus of tyranid. it is the diseased, misshapen, gurgling spawn of the unclean things that gnaw the roots of Yggdrasil in the depths beyond depths where gods and titans fear to tread, and sing searing nightmares into the sleeping souls of mortals. it is a thing demonstrative of the Kali Yuga, and foretells in near time the merciful descent of Shiva's cleansing blade. it is the most intricate work of raw seething blasphemy yet wrought by mortal hands, if indeed mere mortals had anything to do with it. 112 +you maybe have some idea of exactly [!how angry this thing makes me], simply from the fact that i was willing to endure the process of binding a whole new language to godot out of sheer fulminating [!spite]. 113 +- - - - 114 +i would like to make one final point, and if you take anything away from the above rant, [!wote it be this]: programming language design is an art unto itself, and being a programmer -- even a very good one -- gives you fuck all credibility as a language designer. i don't care how many languages you know, i don't care how 10x your full stack is, i don't care if you have 700 years of experience at Current Thing, and i don't care how sharp your suit is. none of that has any bearing on your competence as a language designer. as an [!implementer], maybe. but leave the high concept stuff to your betters. do not under any circumstances design Yet Another Language, and work actively to shame those who do. 115 + 116 +yes, i am being unironically elitist here: like making art and making war, language design is an [!intrinsically aristocratic pastime], and no amount of raw labor power or professional experience can suffice in the absence of a suitably disciplined, cultured, and talented mind. comrade stalin (peace be upon him) learned this the hard way about war, and if anything we moderns seem to be learning the same lesson even more slowly about the technical arts. 117 + 118 +i myself am capable of reasonably competent language design, and that was a skill i developed over more than a decade of research and experiment and, mostly, plain old omphaloskepsis, things i would not have had time or energy for if i weren't broadly sheltered from the material conditions of the 21st century by my status as a(n intermittently starving) artist, paid by human patrons rather than bugman employers. i do not even hold a candle to [>fennel the] [>lua true] [>bakpakin masters] in this arena. 119 + 120 + toki: https://en.wikipedia.org/wiki/Toki_Pona 121 + blunder: https://www.youtube.com/watch?v=WjvsYi2DkOs 122 + fennel: https://github.com/bakpakin/Fennel 123 + lua: https://lua.org 124 + bakpakin: https://github.com/bakpakin 125 + wat: https://www.destroyallsoftware.com/talks/wat
Added gdjn.gdextension version [2f8453068d].
1 +[configuration] 2 +entry_symbol = "gdjn_library_init" 3 +compatibility_minimum = "4.3" 4 + 5 +[libraries] 6 +linux.x86_64 = "gdjn.so"
Added lib/json.janet version [3400f70ba4].
1 +# [ʞ] lib/json.janet 2 +# ~ lexi hale <lexi@hale.su> 3 +# 🄯 AGPLv3 4 +# ? a quick-and-dirty json parser good enough to 5 +# make sense of extension_api.json and no better 6 +# > (import :/lib/json) 7 + 8 +(defn- mk-json-obj [& body] 9 + (tabseq [[key val] :in body] 10 + key val)) 11 + 12 +(defn- json-kw [kw & pat] 13 + ~(* (constant ,kw) ,;pat)) 14 + 15 +(def parse-fail { 16 + :->string (fn [me] 17 + (string/format "parse error %s at %d:%d" 18 + (me :kind) (me :line) (me :col))) 19 +}) 20 + 21 + 22 +(defn- fail [kind] 23 + (defn mk [line col] 24 + (struct/with-proto parse-fail 25 + :kind kind 26 + :line line 27 + :col col)) 28 + ~(error (cmt (* (line) (column)) ,mk))) 29 + 30 +(def pattern (peg/compile ~{ 31 + :bool (+ ,(json-kw true "true") 32 + ,(json-kw false "false")) 33 + :null ,(json-kw :null "null") 34 + :val (* :ws (+ :obj :str :num 35 + :ary :bool :null 36 + ,(fail :bad-val)) :ws) 37 + :ary (group 38 + (+ "[]" 39 + (* "[" (+ 40 + (* :val 41 + (any (* "," :val)) 42 + (? (* "," :ws))) 43 + :wso 44 + ,(fail :bad-array)) 45 + "]" ))) 46 + :obj (cmt (* "{" :ws 47 + (? (* 48 + :pair 49 + (any (* :ws "," :ws :pair)) 50 + :ws (? ",") :ws)) 51 + :ws "}") ,mk-json-obj) 52 + :pair (group (* :str :ws ":" :ws :val)) 53 + :str (* `"` (<- (any (+ `\"` (if-not `"` 1)))) `"`) 54 + 55 + # numerals # 56 + :dec-digit (range "09") 57 + :dec-int-lit (some :dec-digit) 58 + :dec-lit-base (+ (* :dec-int-lit "." (? :dec-int-lit)) 59 + (* "." :dec-int-lit) 60 + :dec-int-lit) 61 + :dec-lit (+ (* :dec-lit-base "e" :dec-lit-base) 62 + :dec-lit-base) 63 + :hex-digit (+ :dec-digit 64 + (range "af") 65 + (range "AF")) 66 + :hex-lit (* "0x" (some :hex-digit)) 67 + :num (number (* (+ "-" "+" "") 68 + (+ :hex-lit :dec-lit))) 69 + 70 + # misc # 71 + :ws-char (+ " " "\t" "\n") 72 + :wso (some :ws-char) 73 + :ws (any :ws-char) 74 + :main :val 75 +})) 76 + 77 +(defn parse [body] 78 + (try (let [parsed (peg/match pattern body)] 79 + (when (= nil parsed) 80 + (error :unknown)) 81 + (first parsed)) 82 + ([e] (error (match e 83 + :unknown "mystery error" 84 + _ (:->string e)))))) 85 + 86 + 87 +(defn main [& argv] 88 + (pp (parse `` 89 + {"test": 123, 90 + "array": [{}, true, {"no":"yes", }]} 91 + ``)))
Added license.en version [06898b1c98].
1 + GNU AFFERO GENERAL PUBLIC LICENSE 2 + Version 3, 19 November 2007 3 + 4 + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> 5 + Everyone is permitted to copy and distribute verbatim copies 6 + of this license document, but changing it is not allowed. 7 + 8 + Preamble 9 + 10 + The GNU Affero General Public License is a free, copyleft license for 11 +software and other kinds of works, specifically designed to ensure 12 +cooperation with the community in the case of network server software. 13 + 14 + The licenses for most software and other practical works are designed 15 +to take away your freedom to share and change the works. By contrast, 16 +our General Public Licenses are intended to guarantee your freedom to 17 +share and change all versions of a program--to make sure it remains free 18 +software for all its users. 19 + 20 + When we speak of free software, we are referring to freedom, not 21 +price. Our General Public Licenses are designed to make sure that you 22 +have the freedom to distribute copies of free software (and charge for 23 +them if you wish), that you receive source code or can get it if you 24 +want it, that you can change the software or use pieces of it in new 25 +free programs, and that you know you can do these things. 26 + 27 + Developers that use our General Public Licenses protect your rights 28 +with two steps: (1) assert copyright on the software, and (2) offer 29 +you this License which gives you legal permission to copy, distribute 30 +and/or modify the software. 31 + 32 + A secondary benefit of defending all users' freedom is that 33 +improvements made in alternate versions of the program, if they 34 +receive widespread use, become available for other developers to 35 +incorporate. Many developers of free software are heartened and 36 +encouraged by the resulting cooperation. However, in the case of 37 +software used on network servers, this result may fail to come about. 38 +The GNU General Public License permits making a modified version and 39 +letting the public access it on a server without ever releasing its 40 +source code to the public. 41 + 42 + The GNU Affero General Public License is designed specifically to 43 +ensure that, in such cases, the modified source code becomes available 44 +to the community. It requires the operator of a network server to 45 +provide the source code of the modified version running there to the 46 +users of that server. Therefore, public use of a modified version, on 47 +a publicly accessible server, gives the public access to the source 48 +code of the modified version. 49 + 50 + An older license, called the Affero General Public License and 51 +published by Affero, was designed to accomplish similar goals. This is 52 +a different license, not a version of the Affero GPL, but Affero has 53 +released a new version of the Affero GPL which permits relicensing under 54 +this license. 55 + 56 + The precise terms and conditions for copying, distribution and 57 +modification follow. 58 + 59 + TERMS AND CONDITIONS 60 + 61 + 0. Definitions. 62 + 63 + "This License" refers to version 3 of the GNU Affero General Public License. 64 + 65 + "Copyright" also means copyright-like laws that apply to other kinds of 66 +works, such as semiconductor masks. 67 + 68 + "The Program" refers to any copyrightable work licensed under this 69 +License. Each licensee is addressed as "you". "Licensees" and 70 +"recipients" may be individuals or organizations. 71 + 72 + To "modify" a work means to copy from or adapt all or part of the work 73 +in a fashion requiring copyright permission, other than the making of an 74 +exact copy. The resulting work is called a "modified version" of the 75 +earlier work or a work "based on" the earlier work. 76 + 77 + A "covered work" means either the unmodified Program or a work based 78 +on the Program. 79 + 80 + To "propagate" a work means to do anything with it that, without 81 +permission, would make you directly or secondarily liable for 82 +infringement under applicable copyright law, except executing it on a 83 +computer or modifying a private copy. Propagation includes copying, 84 +distribution (with or without modification), making available to the 85 +public, and in some countries other activities as well. 86 + 87 + To "convey" a work means any kind of propagation that enables other 88 +parties to make or receive copies. Mere interaction with a user through 89 +a computer network, with no transfer of a copy, is not conveying. 90 + 91 + An interactive user interface displays "Appropriate Legal Notices" 92 +to the extent that it includes a convenient and prominently visible 93 +feature that (1) displays an appropriate copyright notice, and (2) 94 +tells the user that there is no warranty for the work (except to the 95 +extent that warranties are provided), that licensees may convey the 96 +work under this License, and how to view a copy of this License. If 97 +the interface presents a list of user commands or options, such as a 98 +menu, a prominent item in the list meets this criterion. 99 + 100 + 1. Source Code. 101 + 102 + The "source code" for a work means the preferred form of the work 103 +for making modifications to it. "Object code" means any non-source 104 +form of a work. 105 + 106 + A "Standard Interface" means an interface that either is an official 107 +standard defined by a recognized standards body, or, in the case of 108 +interfaces specified for a particular programming language, one that 109 +is widely used among developers working in that language. 110 + 111 + The "System Libraries" of an executable work include anything, other 112 +than the work as a whole, that (a) is included in the normal form of 113 +packaging a Major Component, but which is not part of that Major 114 +Component, and (b) serves only to enable use of the work with that 115 +Major Component, or to implement a Standard Interface for which an 116 +implementation is available to the public in source code form. A 117 +"Major Component", in this context, means a major essential component 118 +(kernel, window system, and so on) of the specific operating system 119 +(if any) on which the executable work runs, or a compiler used to 120 +produce the work, or an object code interpreter used to run it. 121 + 122 + The "Corresponding Source" for a work in object code form means all 123 +the source code needed to generate, install, and (for an executable 124 +work) run the object code and to modify the work, including scripts to 125 +control those activities. However, it does not include the work's 126 +System Libraries, or general-purpose tools or generally available free 127 +programs which are used unmodified in performing those activities but 128 +which are not part of the work. For example, Corresponding Source 129 +includes interface definition files associated with source files for 130 +the work, and the source code for shared libraries and dynamically 131 +linked subprograms that the work is specifically designed to require, 132 +such as by intimate data communication or control flow between those 133 +subprograms and other parts of the work. 134 + 135 + The Corresponding Source need not include anything that users 136 +can regenerate automatically from other parts of the Corresponding 137 +Source. 138 + 139 + The Corresponding Source for a work in source code form is that 140 +same work. 141 + 142 + 2. Basic Permissions. 143 + 144 + All rights granted under this License are granted for the term of 145 +copyright on the Program, and are irrevocable provided the stated 146 +conditions are met. This License explicitly affirms your unlimited 147 +permission to run the unmodified Program. The output from running a 148 +covered work is covered by this License only if the output, given its 149 +content, constitutes a covered work. This License acknowledges your 150 +rights of fair use or other equivalent, as provided by copyright law. 151 + 152 + You may make, run and propagate covered works that you do not 153 +convey, without conditions so long as your license otherwise remains 154 +in force. You may convey covered works to others for the sole purpose 155 +of having them make modifications exclusively for you, or provide you 156 +with facilities for running those works, provided that you comply with 157 +the terms of this License in conveying all material for which you do 158 +not control copyright. Those thus making or running the covered works 159 +for you must do so exclusively on your behalf, under your direction 160 +and control, on terms that prohibit them from making any copies of 161 +your copyrighted material outside their relationship with you. 162 + 163 + Conveying under any other circumstances is permitted solely under 164 +the conditions stated below. Sublicensing is not allowed; section 10 165 +makes it unnecessary. 166 + 167 + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 + 169 + No covered work shall be deemed part of an effective technological 170 +measure under any applicable law fulfilling obligations under article 171 +11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 +similar laws prohibiting or restricting circumvention of such 173 +measures. 174 + 175 + When you convey a covered work, you waive any legal power to forbid 176 +circumvention of technological measures to the extent such circumvention 177 +is effected by exercising rights under this License with respect to 178 +the covered work, and you disclaim any intention to limit operation or 179 +modification of the work as a means of enforcing, against the work's 180 +users, your or third parties' legal rights to forbid circumvention of 181 +technological measures. 182 + 183 + 4. Conveying Verbatim Copies. 184 + 185 + You may convey verbatim copies of the Program's source code as you 186 +receive it, in any medium, provided that you conspicuously and 187 +appropriately publish on each copy an appropriate copyright notice; 188 +keep intact all notices stating that this License and any 189 +non-permissive terms added in accord with section 7 apply to the code; 190 +keep intact all notices of the absence of any warranty; and give all 191 +recipients a copy of this License along with the Program. 192 + 193 + You may charge any price or no price for each copy that you convey, 194 +and you may offer support or warranty protection for a fee. 195 + 196 + 5. Conveying Modified Source Versions. 197 + 198 + You may convey a work based on the Program, or the modifications to 199 +produce it from the Program, in the form of source code under the 200 +terms of section 4, provided that you also meet all of these conditions: 201 + 202 + a) The work must carry prominent notices stating that you modified 203 + it, and giving a relevant date. 204 + 205 + b) The work must carry prominent notices stating that it is 206 + released under this License and any conditions added under section 207 + 7. This requirement modifies the requirement in section 4 to 208 + "keep intact all notices". 209 + 210 + c) You must license the entire work, as a whole, under this 211 + License to anyone who comes into possession of a copy. This 212 + License will therefore apply, along with any applicable section 7 213 + additional terms, to the whole of the work, and all its parts, 214 + regardless of how they are packaged. This License gives no 215 + permission to license the work in any other way, but it does not 216 + invalidate such permission if you have separately received it. 217 + 218 + d) If the work has interactive user interfaces, each must display 219 + Appropriate Legal Notices; however, if the Program has interactive 220 + interfaces that do not display Appropriate Legal Notices, your 221 + work need not make them do so. 222 + 223 + A compilation of a covered work with other separate and independent 224 +works, which are not by their nature extensions of the covered work, 225 +and which are not combined with it such as to form a larger program, 226 +in or on a volume of a storage or distribution medium, is called an 227 +"aggregate" if the compilation and its resulting copyright are not 228 +used to limit the access or legal rights of the compilation's users 229 +beyond what the individual works permit. Inclusion of a covered work 230 +in an aggregate does not cause this License to apply to the other 231 +parts of the aggregate. 232 + 233 + 6. Conveying Non-Source Forms. 234 + 235 + You may convey a covered work in object code form under the terms 236 +of sections 4 and 5, provided that you also convey the 237 +machine-readable Corresponding Source under the terms of this License, 238 +in one of these ways: 239 + 240 + a) Convey the object code in, or embodied in, a physical product 241 + (including a physical distribution medium), accompanied by the 242 + Corresponding Source fixed on a durable physical medium 243 + customarily used for software interchange. 244 + 245 + b) Convey the object code in, or embodied in, a physical product 246 + (including a physical distribution medium), accompanied by a 247 + written offer, valid for at least three years and valid for as 248 + long as you offer spare parts or customer support for that product 249 + model, to give anyone who possesses the object code either (1) a 250 + copy of the Corresponding Source for all the software in the 251 + product that is covered by this License, on a durable physical 252 + medium customarily used for software interchange, for a price no 253 + more than your reasonable cost of physically performing this 254 + conveying of source, or (2) access to copy the 255 + Corresponding Source from a network server at no charge. 256 + 257 + c) Convey individual copies of the object code with a copy of the 258 + written offer to provide the Corresponding Source. This 259 + alternative is allowed only occasionally and noncommercially, and 260 + only if you received the object code with such an offer, in accord 261 + with subsection 6b. 262 + 263 + d) Convey the object code by offering access from a designated 264 + place (gratis or for a charge), and offer equivalent access to the 265 + Corresponding Source in the same way through the same place at no 266 + further charge. You need not require recipients to copy the 267 + Corresponding Source along with the object code. If the place to 268 + copy the object code is a network server, the Corresponding Source 269 + may be on a different server (operated by you or a third party) 270 + that supports equivalent copying facilities, provided you maintain 271 + clear directions next to the object code saying where to find the 272 + Corresponding Source. Regardless of what server hosts the 273 + Corresponding Source, you remain obligated to ensure that it is 274 + available for as long as needed to satisfy these requirements. 275 + 276 + e) Convey the object code using peer-to-peer transmission, provided 277 + you inform other peers where the object code and Corresponding 278 + Source of the work are being offered to the general public at no 279 + charge under subsection 6d. 280 + 281 + A separable portion of the object code, whose source code is excluded 282 +from the Corresponding Source as a System Library, need not be 283 +included in conveying the object code work. 284 + 285 + A "User Product" is either (1) a "consumer product", which means any 286 +tangible personal property which is normally used for personal, family, 287 +or household purposes, or (2) anything designed or sold for incorporation 288 +into a dwelling. In determining whether a product is a consumer product, 289 +doubtful cases shall be resolved in favor of coverage. For a particular 290 +product received by a particular user, "normally used" refers to a 291 +typical or common use of that class of product, regardless of the status 292 +of the particular user or of the way in which the particular user 293 +actually uses, or expects or is expected to use, the product. A product 294 +is a consumer product regardless of whether the product has substantial 295 +commercial, industrial or non-consumer uses, unless such uses represent 296 +the only significant mode of use of the product. 297 + 298 + "Installation Information" for a User Product means any methods, 299 +procedures, authorization keys, or other information required to install 300 +and execute modified versions of a covered work in that User Product from 301 +a modified version of its Corresponding Source. The information must 302 +suffice to ensure that the continued functioning of the modified object 303 +code is in no case prevented or interfered with solely because 304 +modification has been made. 305 + 306 + If you convey an object code work under this section in, or with, or 307 +specifically for use in, a User Product, and the conveying occurs as 308 +part of a transaction in which the right of possession and use of the 309 +User Product is transferred to the recipient in perpetuity or for a 310 +fixed term (regardless of how the transaction is characterized), the 311 +Corresponding Source conveyed under this section must be accompanied 312 +by the Installation Information. But this requirement does not apply 313 +if neither you nor any third party retains the ability to install 314 +modified object code on the User Product (for example, the work has 315 +been installed in ROM). 316 + 317 + The requirement to provide Installation Information does not include a 318 +requirement to continue to provide support service, warranty, or updates 319 +for a work that has been modified or installed by the recipient, or for 320 +the User Product in which it has been modified or installed. Access to a 321 +network may be denied when the modification itself materially and 322 +adversely affects the operation of the network or violates the rules and 323 +protocols for communication across the network. 324 + 325 + Corresponding Source conveyed, and Installation Information provided, 326 +in accord with this section must be in a format that is publicly 327 +documented (and with an implementation available to the public in 328 +source code form), and must require no special password or key for 329 +unpacking, reading or copying. 330 + 331 + 7. Additional Terms. 332 + 333 + "Additional permissions" are terms that supplement the terms of this 334 +License by making exceptions from one or more of its conditions. 335 +Additional permissions that are applicable to the entire Program shall 336 +be treated as though they were included in this License, to the extent 337 +that they are valid under applicable law. If additional permissions 338 +apply only to part of the Program, that part may be used separately 339 +under those permissions, but the entire Program remains governed by 340 +this License without regard to the additional permissions. 341 + 342 + When you convey a copy of a covered work, you may at your option 343 +remove any additional permissions from that copy, or from any part of 344 +it. (Additional permissions may be written to require their own 345 +removal in certain cases when you modify the work.) You may place 346 +additional permissions on material, added by you to a covered work, 347 +for which you have or can give appropriate copyright permission. 348 + 349 + Notwithstanding any other provision of this License, for material you 350 +add to a covered work, you may (if authorized by the copyright holders of 351 +that material) supplement the terms of this License with terms: 352 + 353 + a) Disclaiming warranty or limiting liability differently from the 354 + terms of sections 15 and 16 of this License; or 355 + 356 + b) Requiring preservation of specified reasonable legal notices or 357 + author attributions in that material or in the Appropriate Legal 358 + Notices displayed by works containing it; or 359 + 360 + c) Prohibiting misrepresentation of the origin of that material, or 361 + requiring that modified versions of such material be marked in 362 + reasonable ways as different from the original version; or 363 + 364 + d) Limiting the use for publicity purposes of names of licensors or 365 + authors of the material; or 366 + 367 + e) Declining to grant rights under trademark law for use of some 368 + trade names, trademarks, or service marks; or 369 + 370 + f) Requiring indemnification of licensors and authors of that 371 + material by anyone who conveys the material (or modified versions of 372 + it) with contractual assumptions of liability to the recipient, for 373 + any liability that these contractual assumptions directly impose on 374 + those licensors and authors. 375 + 376 + All other non-permissive additional terms are considered "further 377 +restrictions" within the meaning of section 10. If the Program as you 378 +received it, or any part of it, contains a notice stating that it is 379 +governed by this License along with a term that is a further 380 +restriction, you may remove that term. If a license document contains 381 +a further restriction but permits relicensing or conveying under this 382 +License, you may add to a covered work material governed by the terms 383 +of that license document, provided that the further restriction does 384 +not survive such relicensing or conveying. 385 + 386 + If you add terms to a covered work in accord with this section, you 387 +must place, in the relevant source files, a statement of the 388 +additional terms that apply to those files, or a notice indicating 389 +where to find the applicable terms. 390 + 391 + Additional terms, permissive or non-permissive, may be stated in the 392 +form of a separately written license, or stated as exceptions; 393 +the above requirements apply either way. 394 + 395 + 8. Termination. 396 + 397 + You may not propagate or modify a covered work except as expressly 398 +provided under this License. Any attempt otherwise to propagate or 399 +modify it is void, and will automatically terminate your rights under 400 +this License (including any patent licenses granted under the third 401 +paragraph of section 11). 402 + 403 + However, if you cease all violation of this License, then your 404 +license from a particular copyright holder is reinstated (a) 405 +provisionally, unless and until the copyright holder explicitly and 406 +finally terminates your license, and (b) permanently, if the copyright 407 +holder fails to notify you of the violation by some reasonable means 408 +prior to 60 days after the cessation. 409 + 410 + Moreover, your license from a particular copyright holder is 411 +reinstated permanently if the copyright holder notifies you of the 412 +violation by some reasonable means, this is the first time you have 413 +received notice of violation of this License (for any work) from that 414 +copyright holder, and you cure the violation prior to 30 days after 415 +your receipt of the notice. 416 + 417 + Termination of your rights under this section does not terminate the 418 +licenses of parties who have received copies or rights from you under 419 +this License. If your rights have been terminated and not permanently 420 +reinstated, you do not qualify to receive new licenses for the same 421 +material under section 10. 422 + 423 + 9. Acceptance Not Required for Having Copies. 424 + 425 + You are not required to accept this License in order to receive or 426 +run a copy of the Program. Ancillary propagation of a covered work 427 +occurring solely as a consequence of using peer-to-peer transmission 428 +to receive a copy likewise does not require acceptance. However, 429 +nothing other than this License grants you permission to propagate or 430 +modify any covered work. These actions infringe copyright if you do 431 +not accept this License. Therefore, by modifying or propagating a 432 +covered work, you indicate your acceptance of this License to do so. 433 + 434 + 10. Automatic Licensing of Downstream Recipients. 435 + 436 + Each time you convey a covered work, the recipient automatically 437 +receives a license from the original licensors, to run, modify and 438 +propagate that work, subject to this License. You are not responsible 439 +for enforcing compliance by third parties with this License. 440 + 441 + An "entity transaction" is a transaction transferring control of an 442 +organization, or substantially all assets of one, or subdividing an 443 +organization, or merging organizations. If propagation of a covered 444 +work results from an entity transaction, each party to that 445 +transaction who receives a copy of the work also receives whatever 446 +licenses to the work the party's predecessor in interest had or could 447 +give under the previous paragraph, plus a right to possession of the 448 +Corresponding Source of the work from the predecessor in interest, if 449 +the predecessor has it or can get it with reasonable efforts. 450 + 451 + You may not impose any further restrictions on the exercise of the 452 +rights granted or affirmed under this License. For example, you may 453 +not impose a license fee, royalty, or other charge for exercise of 454 +rights granted under this License, and you may not initiate litigation 455 +(including a cross-claim or counterclaim in a lawsuit) alleging that 456 +any patent claim is infringed by making, using, selling, offering for 457 +sale, or importing the Program or any portion of it. 458 + 459 + 11. Patents. 460 + 461 + A "contributor" is a copyright holder who authorizes use under this 462 +License of the Program or a work on which the Program is based. The 463 +work thus licensed is called the contributor's "contributor version". 464 + 465 + A contributor's "essential patent claims" are all patent claims 466 +owned or controlled by the contributor, whether already acquired or 467 +hereafter acquired, that would be infringed by some manner, permitted 468 +by this License, of making, using, or selling its contributor version, 469 +but do not include claims that would be infringed only as a 470 +consequence of further modification of the contributor version. For 471 +purposes of this definition, "control" includes the right to grant 472 +patent sublicenses in a manner consistent with the requirements of 473 +this License. 474 + 475 + Each contributor grants you a non-exclusive, worldwide, royalty-free 476 +patent license under the contributor's essential patent claims, to 477 +make, use, sell, offer for sale, import and otherwise run, modify and 478 +propagate the contents of its contributor version. 479 + 480 + In the following three paragraphs, a "patent license" is any express 481 +agreement or commitment, however denominated, not to enforce a patent 482 +(such as an express permission to practice a patent or covenant not to 483 +sue for patent infringement). To "grant" such a patent license to a 484 +party means to make such an agreement or commitment not to enforce a 485 +patent against the party. 486 + 487 + If you convey a covered work, knowingly relying on a patent license, 488 +and the Corresponding Source of the work is not available for anyone 489 +to copy, free of charge and under the terms of this License, through a 490 +publicly available network server or other readily accessible means, 491 +then you must either (1) cause the Corresponding Source to be so 492 +available, or (2) arrange to deprive yourself of the benefit of the 493 +patent license for this particular work, or (3) arrange, in a manner 494 +consistent with the requirements of this License, to extend the patent 495 +license to downstream recipients. "Knowingly relying" means you have 496 +actual knowledge that, but for the patent license, your conveying the 497 +covered work in a country, or your recipient's use of the covered work 498 +in a country, would infringe one or more identifiable patents in that 499 +country that you have reason to believe are valid. 500 + 501 + If, pursuant to or in connection with a single transaction or 502 +arrangement, you convey, or propagate by procuring conveyance of, a 503 +covered work, and grant a patent license to some of the parties 504 +receiving the covered work authorizing them to use, propagate, modify 505 +or convey a specific copy of the covered work, then the patent license 506 +you grant is automatically extended to all recipients of the covered 507 +work and works based on it. 508 + 509 + A patent license is "discriminatory" if it does not include within 510 +the scope of its coverage, prohibits the exercise of, or is 511 +conditioned on the non-exercise of one or more of the rights that are 512 +specifically granted under this License. You may not convey a covered 513 +work if you are a party to an arrangement with a third party that is 514 +in the business of distributing software, under which you make payment 515 +to the third party based on the extent of your activity of conveying 516 +the work, and under which the third party grants, to any of the 517 +parties who would receive the covered work from you, a discriminatory 518 +patent license (a) in connection with copies of the covered work 519 +conveyed by you (or copies made from those copies), or (b) primarily 520 +for and in connection with specific products or compilations that 521 +contain the covered work, unless you entered into that arrangement, 522 +or that patent license was granted, prior to 28 March 2007. 523 + 524 + Nothing in this License shall be construed as excluding or limiting 525 +any implied license or other defenses to infringement that may 526 +otherwise be available to you under applicable patent law. 527 + 528 + 12. No Surrender of Others' Freedom. 529 + 530 + If conditions are imposed on you (whether by court order, agreement or 531 +otherwise) that contradict the conditions of this License, they do not 532 +excuse you from the conditions of this License. If you cannot convey a 533 +covered work so as to satisfy simultaneously your obligations under this 534 +License and any other pertinent obligations, then as a consequence you may 535 +not convey it at all. For example, if you agree to terms that obligate you 536 +to collect a royalty for further conveying from those to whom you convey 537 +the Program, the only way you could satisfy both those terms and this 538 +License would be to refrain entirely from conveying the Program. 539 + 540 + 13. Remote Network Interaction; Use with the GNU General Public License. 541 + 542 + Notwithstanding any other provision of this License, if you modify the 543 +Program, your modified version must prominently offer all users 544 +interacting with it remotely through a computer network (if your version 545 +supports such interaction) an opportunity to receive the Corresponding 546 +Source of your version by providing access to the Corresponding Source 547 +from a network server at no charge, through some standard or customary 548 +means of facilitating copying of software. This Corresponding Source 549 +shall include the Corresponding Source for any work covered by version 3 550 +of the GNU General Public License that is incorporated pursuant to the 551 +following paragraph. 552 + 553 + Notwithstanding any other provision of this License, you have 554 +permission to link or combine any covered work with a work licensed 555 +under version 3 of the GNU General Public License into a single 556 +combined work, and to convey the resulting work. The terms of this 557 +License will continue to apply to the part which is the covered work, 558 +but the work with which it is combined will remain governed by version 559 +3 of the GNU General Public License. 560 + 561 + 14. Revised Versions of this License. 562 + 563 + The Free Software Foundation may publish revised and/or new versions of 564 +the GNU Affero General Public License from time to time. Such new versions 565 +will be similar in spirit to the present version, but may differ in detail to 566 +address new problems or concerns. 567 + 568 + Each version is given a distinguishing version number. If the 569 +Program specifies that a certain numbered version of the GNU Affero General 570 +Public License "or any later version" applies to it, you have the 571 +option of following the terms and conditions either of that numbered 572 +version or of any later version published by the Free Software 573 +Foundation. If the Program does not specify a version number of the 574 +GNU Affero General Public License, you may choose any version ever published 575 +by the Free Software Foundation. 576 + 577 + If the Program specifies that a proxy can decide which future 578 +versions of the GNU Affero General Public License can be used, that proxy's 579 +public statement of acceptance of a version permanently authorizes you 580 +to choose that version for the Program. 581 + 582 + Later license versions may give you additional or different 583 +permissions. However, no additional obligations are imposed on any 584 +author or copyright holder as a result of your choosing to follow a 585 +later version. 586 + 587 + 15. Disclaimer of Warranty. 588 + 589 + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 + 598 + 16. Limitation of Liability. 599 + 600 + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 +SUCH DAMAGES. 609 + 610 + 17. Interpretation of Sections 15 and 16. 611 + 612 + If the disclaimer of warranty and limitation of liability provided 613 +above cannot be given local legal effect according to their terms, 614 +reviewing courts shall apply local law that most closely approximates 615 +an absolute waiver of all civil liability in connection with the 616 +Program, unless a warranty or assumption of liability accompanies a 617 +copy of the Program in return for a fee. 618 + 619 + END OF TERMS AND CONDITIONS 620 + 621 + How to Apply These Terms to Your New Programs 622 + 623 + If you develop a new program, and you want it to be of the greatest 624 +possible use to the public, the best way to achieve this is to make it 625 +free software which everyone can redistribute and change under these terms. 626 + 627 + To do so, attach the following notices to the program. It is safest 628 +to attach them to the start of each source file to most effectively 629 +state the exclusion of warranty; and each file should have at least 630 +the "copyright" line and a pointer to where the full notice is found. 631 + 632 + <one line to give the program's name and a brief idea of what it does.> 633 + Copyright (C) <year> <name of author> 634 + 635 + This program is free software: you can redistribute it and/or modify 636 + it under the terms of the GNU Affero General Public License as published by 637 + the Free Software Foundation, either version 3 of the License, or 638 + (at your option) any later version. 639 + 640 + This program is distributed in the hope that it will be useful, 641 + but WITHOUT ANY WARRANTY; without even the implied warranty of 642 + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 + GNU Affero General Public License for more details. 644 + 645 + You should have received a copy of the GNU Affero General Public License 646 + along with this program. If not, see <https://www.gnu.org/licenses/>. 647 + 648 +Also add information on how to contact you by electronic and paper mail. 649 + 650 + If your software can interact with users remotely through a computer 651 +network, you should also make sure that it provides a way for users to 652 +get its source. For example, if your program is a web application, its 653 +interface could display a "Source" link that leads users to an archive 654 +of the code. There are many ways you could offer source, and different 655 +solutions will be better for different programs; see section 13 for the 656 +specific requirements. 657 + 658 + You should also get your employer (if you work as a programmer) or school, 659 +if any, to sign a "copyright disclaimer" for the program, if necessary. 660 +For more information on this, and how to apply and follow the GNU AGPL, see 661 +<https://www.gnu.org/licenses/>.
Added makefile version [ab479c70d3].
1 +# [ʞ] gdjn 2 +# ~ lexi hale <lexi@hale.su> 3 +# ? write godot games in a civilized language 4 +# 🄯 AGPLv3 5 +# > make all 6 + 7 +o = out# final binary output 8 +g = gen# where to store intermediate build artifacts 9 +s = src# source of the main gdjn library 10 +t = tool# source of utilities built for use during build 11 +x = ext# where to fetch external binary libraries 12 +l = lib# libraries written in janet 13 + 14 +# in case these are confusing: 15 +# * ["src] only contains valuable files written by human hand 16 +# 17 +# * ["gen] does not contain any files that cannot be deleted 18 +# without any repercussions beyond having to run `make` 19 +# again. 20 +# 21 +# * ["tool] contains valuable hand-written source files which 22 +# are interpreted during the build process and help generate 23 +# artifacts that contribute to the final binary. [!however], 24 +# none of the tool code itself ends up in the binary in any 25 +# form. 26 +# 27 +# * ["ext] is a Keter-class high-security containment unit for 28 +# Other People's Code. 29 +# 30 +# * ["lib] contains (mostly janet) code that will be included 31 +# as blobs in the binary. janet code will be able to import 32 +# them. these will be compiled down to .jimage files and 33 +# then bundled into rsrc.o. libraries used in ["tool/*] 34 +# should only be placed in this directory if they are also 35 +# used at runtime in the godot environment (e.g. the OOP 36 +# macros). library code used only by tools belongs in the 37 +# tool directory. 38 +# 39 +# * ["out] contains all live binaries and object files. 40 + 41 +godot = godot4 42 +godot.flags = --headless 43 +godot.cmd = "$(godot)" $(godot.flags) 44 +janet = $o/janet 45 +git = git 46 +git.flags.clone = --depth=1 47 + 48 +janet.src.path = $x/janet 49 +janet.src.git = https://github.com/janet-lang/janet.git 50 +janet.root = $x/janet/src 51 +janet.cfg = 52 + 53 +cc.link = -flto 54 +cc.comp = -fPIC 55 + 56 +ifeq ($(debug),1) 57 + cc.link += -g 58 + cc.comp += -g -O0 59 +endif 60 + 61 +cc.gdjn.comp = $(cc.comp) \ 62 + -std=gnu23 \ 63 + -I"$g" \ 64 + -I"$s" \ 65 + -I"$(janet.root)/include" \ 66 + -I"$(janet.root)/conf" 67 + 68 +cc.gdjn.link = $(cc.link) -shared 69 +cc.janet.link = $(cc.link) 70 + 71 +cc ?= $(CC) 72 + 73 +path-ensure = mkdir -p "$(@D)" 74 + 75 +# tell our scripts where to look for various files 76 +export JANET_PATH = $(realpath $l) 77 +export CC := $(cc) 78 +export gd_build_out = $o 79 +export gd_build_gen = $g 80 +export gd_api_spec = $g/extension_api.json 81 +export gd_api_iface = $g/gdextension_interface.h 82 + 83 +.PHONY: all clean purge 84 +all: $o/gdjn.so 85 +clean: 86 + rm "$o/"*.o "$g/"*.{jimage,h} "$o/gdjn.so" 87 +purge: 88 + rm "$o/"* "$g/"* 89 + 90 +%/:; $(path-ensure) 91 +%: | $(@D)/ 92 + 93 +tags: . 94 + find "$s" "$g" -name "*.h" -o -name "*.c" | xargs ctags 95 + 96 +$o/gdjn.so: $o/gdjn.o $o/rsrc.o $o/interface.o \ 97 + $o/janet-lang.o $o/janet-rsrc.o \ 98 + $o/libjanet.a 99 + "$(cc)" $(cc.gdjn.link) $^ -o"$@" 100 + 101 +$o/interface.o: $t/c-bind-gen.janet \ 102 + $g/interface.h \ 103 + $(gd_api_spec) \ 104 + $(gd_api_iface) 105 + "$(janet)" "$<" loader | "$(cc)" $(cc.gdjn.comp) -c -xc - -o "$@" 106 + 107 +$g/interface.h: $t/c-bind-gen.janet \ 108 + $(gd_api_spec) 109 + "$(janet)" "$<" header >"$@" 110 + 111 +$g/%.h: $s/%.gcd $t/class-compile.janet $(realpath $(janet)) 112 + "$(janet)" "$t/class-compile.janet" "$<" header >"$@" 113 +$o/%.o: $s/%.gcd $g/%.h $t/class-compile.janet $(realpath $(janet)) 114 + "$(janet)" "$t/class-compile.janet" "$<" loader \ 115 + | "$(cc)" $(cc.gdjn.comp) -c -xc - -o "$@" 116 + 117 +$o/%.o: $s/%.c $s/%.h $(realpath $(janet.root)/include/janet.h) 118 + "$(cc)" -c $(cc.gdjn.comp) "$<" -o"$@" 119 + 120 +$o/rsrc.o: $t/rsrc.janet $(realpath $(janet)) \ 121 + $g/api.jimage 122 + "$(janet)" "$<" -- "$g/api.jimage" 123 + 124 +%.jimage: $(realpath $(janet)) 125 + 126 +$g/api.jimage: $t/api-compile.janet $(gd_api_spec) 127 + "$(janet)" "$<" "$(gd_api_spec)" "$@" 128 + 129 +$g/%.jimage: $l/%.janet 130 + "$(janet)" -c "$<" "$@" 131 + 132 +$x/janet $x/janet/src/include/janet.h: 133 + "$(git)" $(git.flags) clone $(git.flags.clone) "$(janet.src.git)" "$x/janet" 134 + 135 +canon = $(realpath $(dir $1))/$(notdir $1) 136 +define janet.build = 137 + "$(MAKE)" -C "$(janet.src.path)" "$(call canon,$@)" \ 138 + JANET_$1="$(call canon,$@)" \ 139 + $(janet.cfg) 140 +endef 141 + 142 +$o/libjanet.a: $(janet.src.path) 143 + $(call janet.build,STATIC_LIBRARY) 144 +$o/janet: $(janet.src.path) 145 + $(call janet.build,TARGET) 146 + 147 +$g/extension_api.json $g/gdextension_interface.h: 148 + cd "$g" && $(godot.cmd) --dump-extension-api-with-docs \ 149 + --dump-gdextension-interface 150 + 151 + 152 +# individual dependencies 153 + 154 +janet-header = $(janet.root)/include/janet.h 155 + 156 +$o/gdjn.o: $s/util.h $g/interface.h $g/janet-lang.h $g/janet-rsrc.h $(gd_api_iface) 157 +$o/janet-lang.o: $s/util.h $(janet-header) 158 +$o/janet-rsrc.o: $s/util.h $g/janet-lang.h $(janet-header)
Added src/gdjn.c version [f8bd0edc4d].
1 +/* [ʞ] src/gdjn.c 2 + * ~ lexi hale <lexi@hale.su> 3 + * 🄯 AGPLv3 4 + * ? gdjn entry point 5 + */ 6 + 7 +#include "gdjn.h" 8 +#include "janet-lang.h" 9 +#include "janet-rsrc.h" 10 + 11 +gdjn* gdjn_ctx = nullptr; 12 + 13 +static void 14 +gdjn_init 15 +( void* data, 16 + GDExtensionInitializationLevel lvl 17 +) { 18 + if (lvl != GDEXTENSION_INITIALIZATION_SCENE) return; 19 + gdjn_types_fetch(&gdjn_ctx -> gd.t, gdjn_ctx -> gd.getProc); 20 + 21 + const gdjn_typeDB* c = &gdjn_ctx -> gd.t; 22 + 23 + gdjn_unit_janetLang_load(); 24 + gdjn_unit_janetRsrc_load(); 25 + 26 + gdjn_ctx -> gd.janetLang_inst = gdjn_class_JanetLang_new() -> self; 27 + 28 + auto e = gd_engine_registerScriptLanguage( 29 + c -> objects.engine, 30 + gdjn_ctx -> gd.janetLang_inst 31 + ); 32 + if (e != gd_Error_ok) { 33 + _err("could not register JanetLang"); 34 + return; 35 + } 36 + 37 + gdjn_ctx -> gd.janetSaver_inst = gdjn_class_JanetScriptSaver_new()->self; 38 + gdjn_ctx -> gd.janetLoader_inst = gdjn_class_JanetScriptLoader_new()->self; 39 + 40 + gd_refCounted_reference(gdjn_ctx -> gd.janetLoader_inst); 41 + gd_refCounted_reference(gdjn_ctx -> gd.janetSaver_inst); 42 + 43 + gd_resourceLoader_addResourceFormatLoader( 44 + gdjn_ctx -> gd.t.objects.resourceLoader, 45 + gdjn_ctx -> gd.janetLoader_inst, 46 + false 47 + ); 48 + gd_resourceSaver_addResourceFormatSaver( 49 + gdjn_ctx -> gd.t.objects.resourceSaver, 50 + gdjn_ctx -> gd.janetSaver_inst, 51 + false 52 + ); 53 + /* 54 + gd_variant ret; 55 + c -> gd_object.methodBindPtrcall( 56 + c -> gd_m_engine.registerScriptLanguage_ptr, 57 + c -> objects.engine, 58 + (GDExtensionConstTypePtr[]) { 59 + &gdjn_ctx -> gd.janetLang_inst, 60 + }, &ret 61 + ); 62 + */ 63 + 64 + _t(array).empty(&gdjn_ctx -> gd.dox, nullptr); 65 + gd_stringName empty = {}; 66 + _t(stringName).empty(&empty, nullptr); 67 + _t(array).setTyped(&gdjn_ctx -> gd.dox, 68 + GDEXTENSION_VARIANT_TYPE_DICTIONARY, &empty, &empty); 69 + 70 + _t(stringName).dtor(&empty); 71 +} 72 + 73 +static void 74 +gdjn_teardown 75 +( void* data, 76 + GDExtensionInitializationLevel lvl 77 +) { 78 + if (lvl != GDEXTENSION_INITIALIZATION_SCENE) return; 79 + /* we get double frees otherwise */ 80 + 81 + const gdjn_typeDB* c = &gdjn_ctx -> gd.t; 82 + 83 + gd_engine_unregisterScriptLanguage( 84 + c -> objects.engine, 85 + gdjn_ctx -> gd.janetLang_inst 86 + ); 87 + /* 88 + GDExtensionTypePtr ret; 89 + c -> gd_object.methodBindPtrcall( 90 + c -> gd_m_engine.unregisterScriptLanguage_ptr, 91 + (GDExtensionConstTypePtr[]) { 92 + }, &ret 93 + );*/ 94 + 95 + gd_resourceLoader_removeResourceFormatLoader( 96 + gdjn_ctx -> gd.t.objects.resourceLoader, 97 + gdjn_ctx -> gd.janetLoader_inst 98 + ); 99 + gd_resourceSaver_removeResourceFormatSaver( 100 + gdjn_ctx -> gd.t.objects.resourceSaver, 101 + gdjn_ctx -> gd.janetSaver_inst 102 + ); 103 + /* gd_refCounted_unreference(gdjn_ctx -> gd.janetLoader_inst); */ 104 + /* gd_refCounted_unreference(gdjn_ctx -> gd.janetSaver_inst); */ 105 + gdjn_class_JanetLang_del(nullptr, gdjn_ctx -> gd.janetLang_inst); 106 + 107 + gdjn_ctx -> gd.free(gdjn_ctx); 108 + gdjn_ctx = nullptr; 109 +} 110 + 111 + 112 +gdBool 113 +gdjn_library_init 114 +( GDExtensionInterfaceGetProcAddress getProc, 115 + GDExtensionClassLibraryPtr classLib, 116 + GDExtensionInitialization* init 117 +) { 118 + 119 + auto alloc = (GDExtensionInterfaceMemAlloc)getProc("mem_alloc"); 120 + 121 + gdjn_ctx = alloc(sizeof(gdjn)); 122 + gdjn_ctx -> gd = (gdjn_gd) { 123 + .lib = classLib, 124 + .getProc = getProc, 125 + .alloc = alloc, 126 + .realloc = (GDExtensionInterfaceMemRealloc) 127 + getProc("mem_realloc"), 128 + .free = (GDExtensionInterfaceMemFree) 129 + getProc("mem_free"), 130 + 131 + .err = (GDExtensionInterfacePrintError) 132 + getProc("print_error"), 133 + .errMsg = (GDExtensionInterfacePrintErrorWithMessage) 134 + getProc("print_error_with_message"), 135 + .warn = (GDExtensionInterfacePrintWarning) 136 + getProc("print_warning"), 137 + .warnMsg = (GDExtensionInterfacePrintWarningWithMessage) 138 + getProc("print_warning_with_message"), 139 + 140 + .wrap = (GDExtensionInterfaceGetVariantFromTypeConstructor) 141 + getProc("get_variant_from_type_constructor"), 142 + .cast = (GDExtensionInterfaceGetVariantToTypeConstructor) 143 + getProc("get_variant_to_type_constructor"), 144 + }; 145 + 146 + *init = (GDExtensionInitialization) { 147 + .initialize = gdjn_init, 148 + .deinitialize = gdjn_teardown, 149 + .userdata = gdjn_ctx, 150 + .minimum_initialization_level = GDEXTENSION_INITIALIZATION_SCENE, 151 + }; 152 + 153 + return true; 154 +} 155 + 156 +void 157 +gdjn_dox 158 +( gd_dictionary* page 159 +) { 160 + 161 +}
Added src/gdjn.h version [b22d9ec405].
1 +/* [ʞ] src/gdjn.h 2 + * ~ lexi hale <lexi@hale.su> 3 + * 🄯 AGPLv3 4 + * ? core types and declarations used by gdjn 5 + */ 6 + 7 +#pragma once 8 +#include <assert.h> 9 +#include <stdint.h> 10 +#include "janet.h" 11 +#include "interface.h" 12 + 13 +typedef void (*GDExtensionInterfacePrintError)(const char *p_description, const char *p_function, const char *p_file, int32_t p_line, GDExtensionBool p_editor_notify); 14 + 15 +#define _emit(fn, msg) \ 16 + (gdjn_ctx -> gd.fn((msg), __func__, __FILE__, __LINE__, true)) 17 +#define _warn(msg) _emit(warn, msg) 18 +#define _err(msg) _emit(err, msg) 19 + 20 +typedef GDExtensionBool gdBool; 21 + 22 +#define _alloc(ty, n) \ 23 + ((typeof(ty)*)gdjn_alloc(sizeof(ty) * (n))) 24 +#define _free(v) \ 25 + (gdjn_ctx -> gd.free(v)) 26 +#define _sz(r) ((sizeof(r) / sizeof(*r))) 27 + 28 +#define _t(T) \ 29 + (gdjn_ctx -> gd.t.gd_##T) 30 +#define _method(name) \ 31 + static void name \ 32 + ( GDExtensionClassInstancePtr self, \ 33 + const GDExtensionConstTypePtr* argv, \ 34 + GDExtensionTypePtr ret \ 35 + ) 36 + 37 + 38 +typedef struct gdjn { 39 + struct gdjn_gd { 40 + GDExtensionClassLibraryPtr lib; 41 + 42 + GDExtensionInterfaceGetProcAddress getProc; 43 + 44 + GDExtensionInterfaceMemAlloc alloc; 45 + GDExtensionInterfaceMemRealloc realloc; 46 + GDExtensionInterfaceMemFree free; 47 + 48 + GDExtensionInterfacePrintError err; 49 + GDExtensionInterfacePrintErrorWithMessage errMsg; 50 + GDExtensionInterfacePrintWarning warn; 51 + GDExtensionInterfacePrintWarningWithMessage warnMsg; 52 + 53 + GDExtensionInterfaceGetVariantFromTypeConstructor 54 + wrap; 55 + GDExtensionInterfaceGetVariantToTypeConstructor 56 + cast; 57 + 58 + gdjn_typeDB t; 59 + gd_array dox; 60 + 61 + GDExtensionObjectPtr 62 + janetLang_inst, 63 + janetLoader_inst, 64 + janetSaver_inst; 65 + } gd; 66 + struct gdjn_jn { 67 + Janet env; 68 + } jn; 69 +} gdjn; 70 + 71 +extern gdjn* gdjn_ctx; 72 + 73 +[[gnu::alloc_size(1)]] static inline 74 +void* gdjn_alloc(size_t sz) { 75 + return gdjn_ctx -> gd.alloc(sz); 76 +} 77 + 78 + 79 +typedef struct gdjn_gd gdjn_gd; // derp 80 +typedef struct gdjn_jn gdjn_jn; 81 + 82 +typedef struct gdjn_class_def gdjn_class_def; 83 + 84 +void 85 +gdjn_dox 86 +( gd_dictionary* page 87 +);
Added src/janet-lang.gcd version [c0eeb85e80].
1 +(* [ʞ] src/janet-lang.gcd vi:ft=d 2 + * ~ lexi hale <lexi@hale.su> 3 + * 🄯 AGPLv3 4 + * ? implement the godot-janet interface 5 + *) 6 + 7 +use <janet.h>; 8 + 9 +class JanetLang is ScriptLanguageExtension { 10 + use <stdio.h>; 11 + use "util.h"; 12 + 13 + new {}; 14 + 15 + impl _get_name() -> string { 16 + gd_string j; 17 + _t(string).newWithUtf8Chars(&j, "Janet"); 18 + return j; 19 + }; 20 + 21 + impl _get_extension() -> string { 22 + gd_string j; 23 + _t(string).newWithUtf8Chars(&j, "janet"); 24 + return j; 25 + }; 26 + 27 + impl _supports_documentation() -> bool { return true; }; 28 + impl _supports_builtin_mode() -> bool { return true; }; 29 + impl _is_using_templates() -> bool { return false; }; 30 + impl _can_inherit_from_file() -> bool { return true; }; 31 + 32 + impl _handles_global_class_type(string t) -> bool { return false; }; 33 + impl _get_type() -> string { 34 + gd_string s = {}; 35 + _t(string).newWithUtf8Chars(&s, "JanetScriptText"); 36 + return s; 37 + }; 38 + impl _get_recognized_extensions() -> packed-string-array { 39 + gd_packedStringArray r = {}; 40 + _t(packedStringArray).empty(&r, nullptr); 41 + _gdu_array_string_pushLit(&r, "janet"); 42 + _gdu_array_string_pushLit(&r, "jimage"); 43 + return r; 44 + }; 45 + impl _get_comment_delimiters() -> packed-string-array { 46 + gd_packedStringArray r = {}; 47 + _t(packedStringArray).empty(&r, nullptr); 48 + _gdu_array_string_pushLit(&r, "#"); 49 + return r; 50 + }; 51 + impl _get_string_delimiters() -> packed-string-array { 52 + gd_packedStringArray r = {}; 53 + _t(packedStringArray).empty(&r, nullptr); 54 + _gdu_array_string_pushLit(&r, "\" \""); 55 + _gdu_array_string_pushLit(&r, "```` ````"); 56 + _gdu_array_string_pushLit(&r, "``` ```"); 57 + _gdu_array_string_pushLit(&r, "`` ``"); 58 + _gdu_array_string_pushLit(&r, "` `"); 59 + (* et cetera ad infinitum *) 60 + return r; 61 + }; 62 + impl _is_control_flow_keyword(string k) -> bool { 63 + #define l(s) ((pstr){(s),sizeof(s)}) 64 + const pstr words[] = { 65 + l("if"), l("cond"), l("when"), l("unless"), 66 + l("loop"), l("each"), 67 + l("for"), l("forv"), l("forever"), 68 + l("seq"), l("catseq"), 69 + (* et cetera ad nauseam *) 70 + }; 71 + #undef l 72 + for (size_t i = 0; i < _sz(words); ++i) { 73 + if (gdu_strEq_sz(&k, words[i].v, words[i].sz)) 74 + return true; 75 + } 76 + return false; 77 + }; 78 + impl _get_reserved_words() -> packed-string-array { 79 + typedef struct {const char* w; size_t sz;} pstr; 80 + #define l(s) ((pstr){(s),sizeof(s)}) 81 + const pstr words[] = { 82 + l("if"), l("cond"), 83 + l("def"), l("defn"), l("defmacro"), 84 + l("fn"), 85 + l("var"), l("let"), 86 + l("loop"), l("each"), 87 + l("for"), l("forv"), l("forever"), 88 + l("seq"), l("catseq"), 89 + l("map"), l("mapcat"), 90 + l("find"), 91 + l("array"), l("tuple"), 92 + l("string"), l("buffer"), 93 + l("table"), l("struct"), 94 + (* et cetera ad nauseam *) 95 + }; 96 + gd_packedStringArray r = {}; 97 + _t(packedStringArray).empty(&r, nullptr); 98 + for (size_t i = 0; i < _sz(words); ++i) { 99 + gdu_array_string_pushPtr(&r, words[i].w, words[i].sz); 100 + } 101 + return r; 102 + #undef l 103 + }; 104 + 105 + impl _validate_path(string path) -> string { 106 + gd_string s = {}; 107 + _t(string).empty(&s, nullptr); 108 + return s; 109 + }; 110 + 111 + 112 + impl _make_template 113 + ( string tpl; 114 + string class; 115 + string base; 116 + ) -> ref Script { 117 + auto janscr = gdjn_class_JanetScriptText_new(); 118 + return janscr -> self; 119 + }; 120 + impl _create_script() -> ref Object { 121 + auto janscr = gdjn_class_JanetScriptText_new(); 122 + return janscr -> self; 123 + }; 124 + 125 + impl _get_documentation() -> array[dictionary] { 126 + gd_array a = {}; 127 + _t(array).ref(&a, &gdjn_ctx -> gd.dox); 128 + return gdjn_ctx -> gd.dox; 129 + }; 130 + 131 + impl _init() { /* (* "deprecated" but i still have to impl it?? *) */ }; 132 + impl _frame() {}; 133 + impl _thread_enter() { janet_init(); }; 134 + impl _thread_exit() { janet_deinit(); }; 135 + impl _finish() {}; 136 + 137 + impl _overrides_external_editor() -> bool { return false; }; 138 + impl _get_global_class_name(string path) -> dictionary { 139 + gd_dictionary dict; 140 + _t(dictionary).empty(&dict,nullptr); 141 + return dict; 142 + (* FIXME *) 143 + }; 144 + impl _validate( 145 + string script; 146 + string path; 147 + bool vFuncs; 148 + bool vErrs; 149 + bool vWarns; 150 + bool vSafe; 151 + ) -> dictionary { 152 + gd_dictionary dict; 153 + _t(dictionary).empty(&dict,nullptr); 154 + return dict; 155 + }; 156 +}; 157 + 158 +class JanetScript is ScriptExtension { 159 + var as string: path; 160 + new { 161 + _t(string).empty(&me -> path, nullptr); 162 + }; 163 + del { 164 + _t(string).dtor(&me -> path); 165 + }; 166 + 167 + impl _create_instance(array[variant] argv, int argc, ref Object owner, bool refCounted, int error) -> ref Object { 168 + 169 + }; 170 + impl _get_language() -> ref ScriptLanguage { 171 + return gdjn_ctx -> gd.janetLang_inst; 172 + }; 173 + impl _set_path(string path, bool takeOver) { 174 + if (takeOver) { 175 + _t(string).dtor(&me -> path); 176 + me -> path = path; 177 + } else { 178 + _t(string).dtor(&me -> path); 179 + _t(string).copy(&me -> path, (void const*[]) {&path}); 180 + } 181 + }; 182 + impl _get_base_script() -> ref Script { 183 + return nullptr; 184 + }; 185 + impl _has_static_method(string-name method) -> bool { 186 + return false; 187 + }; 188 + impl _is_tool() -> bool { return false; }; (* FIXME *) 189 +}; 190 + 191 +class JanetScriptText extends JanetScript { 192 + var as string: src; 193 + new { 194 + _t(string).empty(&me -> src, nullptr); 195 + }; 196 + del { 197 + _t(string).dtor(&me -> src); 198 + }; 199 + 200 + impl _get_instance_base_type() -> string-name { 201 + return _gdu_intern("ScriptExtension"); 202 + }; 203 + impl _has_source_code() -> bool { return true; }; 204 + impl _get_source_code() -> string { 205 + auto d = gdu_string_dup(&me -> src); 206 + return d; 207 + }; 208 + impl _set_source_code(string s) { 209 + _t(string).dtor(&me -> src); 210 + _t(string).copy(&me -> src, (void const*[]) {&s}); 211 + }; 212 +}; 213 + 214 +class JanetScriptImage extends JanetScript { 215 + impl _has_source_code() -> bool { return false; }; 216 + var struct gdjn_class_JanetScript_image { 217 + size_t sz; 218 + uint8_t* buf; 219 + }: image; 220 + impl _get_instance_base_type() -> string-name { 221 + return _gdu_intern("ScriptExtension"); 222 + }; 223 +};
Added src/janet-rsrc.gcd version [0f238faa9a].
1 +(* [ʞ] src/janet-rsrc.gcd vi:ft=d 2 + * ~ lexi hale <lexi@hale.su> 3 + * 🄯 AGPLv3 4 + * ? implement the saving and loading of janet scripts 5 + *) 6 +use "util.h"; 7 +use <assert.h>; 8 +use "janet-lang.h"; 9 + 10 +use { 11 + static gd_packedStringArray 12 + janetExts(void) { 13 + gd_packedStringArray r = {}; 14 + _t(packedStringArray).empty(&r, nullptr); 15 + _gdu_array_string_pushLit(&r, "janet"); 16 + _gdu_array_string_pushLit(&r, "jimage"); 17 + return r; 18 + }; 19 + typedef enum janetFileKind { 20 + janetFileNone, 21 + janetFileImage, 22 + janetFileText, 23 + } janetFileKind; 24 + static inline janetFileKind 25 + janetKind(gd_string const* const path) { 26 + if (gdu_string_suffix(path, _litSz(".jimage"))) { 27 + return janetFileImage; 28 + } else if (gdu_string_suffix(path, _litSz(".janet"))) { 29 + return janetFileText; 30 + } else return janetFileNone; 31 + } 32 +}; 33 + 34 +class JanetScriptLoader is ResourceFormatLoader { 35 + impl _get_recognized_extensions() -> packed-string-array { 36 + return janetExts(); 37 + }; 38 + impl _handles_type(string-name type) -> bool { 39 + return gdu_symEq(&type, "JanetScriptText") 40 + || gdu_symEq(&type, "JanetScriptImage"); 41 + }; 42 + impl _get_resource_type(string path) -> string { 43 + const char* str = ""; 44 + switch (janetKind(&path)) { 45 + case janetFileImage: str="JanetScriptImage"; break; 46 + case janetFileText: str="JanetScriptText"; break; 47 + } 48 + return gdu_str(str); 49 + }; 50 + use { 51 + static inline gd_variant 52 + vFromErr(int64_t err) { 53 + gd_variant v; 54 + auto wrap = gdjn_ctx -> gd.wrap(GDEXTENSION_VARIANT_TYPE_INT); 55 + wrap(&v, &err); 56 + return v; 57 + } 58 + static inline gd_variant 59 + vFromObj(GDExtensionObjectPtr o) { 60 + gd_variant v; 61 + auto wrap = gdjn_ctx -> gd.wrap(GDEXTENSION_VARIANT_TYPE_OBJECT); 62 + wrap(&v, &o); 63 + return v; 64 + } 65 + }; 66 + impl _load 67 + ( string path; 68 + string origPath; 69 + bool subThreads; 70 + int cacheMode; 71 + ) -> variant { 72 + switch (janetKind(&path)) { 73 + case janetFileImage: { 74 + auto s = gdjn_class_JanetScriptImage_new(); 75 + return vFromObj(gdu_cast(s->self, "Resource")); 76 + }; 77 + case janetFileText: { 78 + auto s = gdjn_class_JanetScriptText_new(); 79 + return vFromObj(gdu_cast(s->self, "Resource")); 80 + }; 81 + default: { 82 + return vFromErr(gd_Error_errFileUnrecognized); 83 + }; 84 + } 85 + }; 86 +}; 87 + 88 + 89 +class JanetScriptSaver is ResourceFormatSaver { 90 + use { 91 + static inline bool 92 + gdjn_isJanet(GDExtensionObjectPtr* res) { 93 + return _gdu_objIs(res, JanetScriptImage) 94 + || _gdu_objIs(res, JanetScriptText); 95 + } 96 + }; 97 + impl _get_recognized_extensions() -> packed-string-array { 98 + return janetExts(); 99 + }; 100 + impl _recognize(ref Resource res) -> bool { 101 + return gdjn_isJanet(res); 102 + }; 103 + impl _save(ref Resource res, string path, int flags) -> int { 104 + gd_refCounted_reference(res); 105 + assert(gdjn_isJanet(res)); 106 + gd_string path_mine; 107 + _t(string).copy(&path_mine, (void const*[]) {&path}); 108 + auto fd = gd_fileAccess_open(path, 109 + gd_FileAccess_ModeFlags_write); 110 + gd_refCounted_reference(fd); 111 + 112 + if (_gdu_objIs(res, JanetScriptText)) { 113 + auto asText = gdu_cast(res, "JanetScriptText"); 114 + gd_string src = gd_script_getSourceCode(asText); 115 + gd_fileAccess_storeString(fd, src); 116 + _t(string).dtor(&src); 117 + } else if (_gdu_objIs(res, JanetScriptImage)) { 118 + auto asImg = gdu_cast(res, "JanetScriptImage"); 119 + }; 120 + 121 + gd_fileAccess_close(fd); 122 + _t(string).dtor(&path_mine); 123 + gd_refCounted_unreference(fd); 124 + gd_refCounted_unreference(res); 125 + }; 126 +};
Added src/util.h version [9bc49409e2].
1 +/* [ʞ] util.h 2 + * ~ lexi hale <lexi@hale.su> 3 + * 🄯 AGPLv3 4 + * ? encapsulate annoying operations (read: pitiful, fragile blast 5 + * shield over the most indefensibly psychotic pieces of the godot 6 + * "type" "system") 7 + * 8 + * if you want to use this outside gdjn, redefine the macro _t 9 + * from gdjn.h appropriately. 10 + * 11 + * (honestly tho you should use c-bind-gen.janet too) 12 + */ 13 + 14 +#pragma once 15 +#include "gdjn.h" 16 +#include <string.h> 17 + 18 +static inline gd_string 19 +gdu_string_of_stringName(const gd_stringName* const s) { 20 + gd_string r; 21 + _t(string).fromStringName(&r, (void*)&s); 22 + return r; 23 +} 24 + 25 +static inline gd_stringName 26 +gdu_stringName_of_string(const gd_stringName* const s) { 27 + gd_stringName r; 28 + _t(stringName).fromString(&r, (void*)&s); 29 + return r; 30 +} 31 + 32 +static inline gd_stringName 33 +gdu_intern_sz (const char* str, const size_t sz) { 34 + gd_stringName r = {}; 35 + if (sz == 0) _t(stringName).newWithUtf8Chars(&r, str); 36 + else _t(stringName).newWithUtf8CharsAndLen(&r, str, sz); 37 + return r; 38 +} 39 + 40 +static inline gd_stringName 41 +gdu_intern (const char* str) { 42 + return gdu_intern_sz(str, 0); 43 +} 44 + 45 +static inline gd_string 46 +gdu_str_sz (const char* str, const size_t sz) { 47 + gd_string r = {}; 48 + if (sz == 0) _t(string).newWithUtf8Chars(&r, str); 49 + else _t(string).newWithUtf8CharsAndLen(&r, str, sz); 50 + return r; 51 +} 52 + 53 +static inline gd_string 54 +gdu_str (const char* str) { 55 + return gdu_str_sz(str, 0); 56 +} 57 + 58 +#define _gdu_intern(x) (gdu_intern_sz((x), sizeof(x)-1)) 59 +#define _litSz(x) (x), (sizeof (x)-1) 60 +#define _ref(x) typeof(typeof(x) const* const) 61 +#define _refMut(x) typeof(typeof(x) * const) 62 +#define _with(T, k, v, ...) ({\ 63 + typeof(gd_##T) k = v; \ 64 + do { __VA_ARGS__; } while (0); \ 65 + _t(T).dtor(&k); \ 66 +}) 67 + 68 +#define _withSym(k, v, ...) \ 69 + _with(stringName, k, gdu_intern(v), __VA_ARGS__) 70 +#define _withSym0(k, ...) \ 71 + _with(stringName, k, {}, __VA_ARGS__) 72 +#define _withStr(k, v, ...) \ 73 + _with(string, k, gdu_str(v), __VA_ARGS__) 74 +#define _withStr0(k, v, ...) \ 75 + _with(string, k, {}, __VA_ARGS__) 76 + 77 +#define _typeEq(a, b) \ 78 + __builtin_classify_type(typeof(a)) == _builtin_classify_type(typeof(b)) 79 + 80 +#define _refVal 0 81 +#define _refPtr 1 82 +#define _refArray 2 83 + 84 +#define _indirect(a) \ 85 + __builtin_types_compatible_p(typeof(a), void*) 86 + 87 +#define _refKind(a) \ 88 + __builtin_choose( _typeEq(typeof_unqual(a), \ 89 + typeof_unqual(a[0]) []), _refArray \ 90 + /* false */ __builtin_choose(_typeEq(a, (typeof_unqual(a[0]) *)), _refPtr )) 91 + 92 +#define _szElse(a, zero) \ 93 + __builtin_choose(_refKind(a) == _refArray, \ 94 + /* true */ _sz(a), \ 95 + /* false */ __builtin_choose(_refKind(a) == _refPtr, \ 96 + /* true */ (__builtin_counted_by(ptr) != nullptr ? \ 97 + *__builtin_counted_by(ptr) : (zero)) \ 98 + /* false */ (void)0 /* bad type */ )) 99 +#define _sz0(a) _szElse(a,0) 100 +#define _szStr(a) \ 101 + __builtin_choose(_typeEq((a), pstr), (a).sz, _szElse(a, strlen(a))) 102 + 103 +#define _array(t) struct {t* v; size_t sz;} 104 +typedef _array(char) pstr; 105 + 106 +#define _strWithSz(a) (a), _strLen(a) 107 + 108 +static inline bool 109 +gdu_symIs 110 +( gd_stringName const* const a, 111 + gd_stringName const* const b 112 +) { 113 + bool res; 114 + _t(stringName).equal(a, b, &res); 115 + return res; 116 +} 117 + 118 +static inline bool 119 +gdu_symEq_sz 120 +( _ref(gd_stringName) a, 121 + _ref(char) b, 122 + size_t const sz 123 +) { 124 + auto bSym = gdu_intern_sz(b,sz); 125 + bool res = gdu_symIs(a, &bSym); 126 + _t(stringName).dtor(&bSym); 127 + return res; 128 +} 129 + 130 +static inline bool 131 +gdu_symEq 132 +( _ref(gd_stringName) a, 133 + _ref(char) b 134 +) { return gdu_symEq_sz(a, b, 0); } 135 + 136 +#define _gdu_symEq(a,b) (gdu_symEq_sz(a, _litSz(b))) 137 + 138 +static inline bool 139 +gdu_objIs 140 +( GDExtensionObjectPtr obj, 141 + _ref(char) id, 142 + size_t const sz 143 +) { 144 + bool res = false; 145 + _withSym0(name, ({ 146 + if (!_t(object).getClassName(obj, gdjn_ctx -> gd.lib, &name)) 147 + break; 148 + res = gdu_symEq_sz(&name, id, sz); 149 + })); 150 + return res; 151 +} 152 + 153 +static inline bool 154 +gdu_strIs 155 +( gd_string const* const a, 156 + gd_string const* const b 157 +) { 158 + bool res; 159 + _t(string).equal(a, b, &res); 160 + return res; 161 +} 162 + 163 +static inline bool 164 +gdu_strEq_sz 165 +( _ref(gd_string) a, 166 + _ref(char) b, 167 + size_t const sz 168 +) { 169 + auto bSym = gdu_str_sz(b,sz); 170 + bool res = gdu_strIs(a, &bSym); 171 + _t(string).dtor(&bSym); 172 + return res; 173 +} 174 + 175 +static inline bool 176 +gdu_strEq 177 +( _ref(gd_string) a, 178 + _ref(char) b 179 +) { return gdu_strEq_sz(a, b, 0); } 180 + 181 +#define _gdu_symEq(a,b) (gdu_symEq_sz(a, _litSz(b))) 182 +#define _gdu_strEq(a,b) (gdu_strEq_sz(a, _litSz(b))) 183 +#define _gdu_objIs(obj, id) \ 184 + (gdu_objIs(obj, _litSz(#id))) 185 + 186 +#define _gdu_string_emit(s, tgt) \ 187 + (gdu_string_emit(&(s), (tgt), sizeof (tgt)-1)) 188 + 189 +static inline size_t 190 +gdu_string_emit 191 +( size_t sz; 192 + 193 + const gd_string* const s, 194 + char target[static sz], 195 + size_t sz 196 +) { 197 + /* docs lie btw, this returns a count of bytes, 198 + * not "characters" (??) 199 + * (thank the gods for small mercies) */ 200 + size_t len = _t(string).toUtf8Chars(s, target, sz); 201 + target[len] = 0; 202 + return len; 203 +} 204 + 205 +#define _gdu_stringName_emit(s, tgt) \ 206 + (gdu_stringName_emit(&(s), (tgt), sizeof (tgt) - 1)) 207 + 208 +static inline pstr 209 +gdu_string_pdup (_ref(gd_string) s) { 210 + size_t len = gd_string_length(s) + 1; 211 + char* buf = _alloc(char, len); 212 + gdu_string_emit(s, buf, len - 1); 213 + return (pstr){buf,len}; 214 +} 215 + 216 +static inline gd_string 217 +gdu_string_dup (_ref(gd_string) s) { 218 + gd_string cp; 219 + _t(string).copy(&cp, (void const*[]) {s}); 220 + return cp; 221 +} 222 + 223 +#define _cat(x,y) x##y 224 +#define __cat(x,y) _cat(x,y) 225 +#define _gensym __cat(_sym_,__COUNTER__) 226 + 227 +#define __gdu_string_auto(szid, name, str) \ 228 + size_t szid = gd_string_length(str) + 1; \ 229 + char[szid] name; \ 230 + gdu_string_emit(str, name, szid-1); 231 + 232 +#define _gdu_string_auto(...) __gdu_string_auto(_gensym, __VA_ARGS__) 233 + 234 +#if __has_builtin(__builtin_alloca_with_align) 235 +# define _stalloc(ty, n) \ 236 + (__builtin_alloca_with_align(sizeof(ty)*(n), alignof(ty)*8)) 237 +#else 238 +# define _stalloc(ty, n) \ 239 + (__builtin_alloca(sizeof(ty)*(n))) 240 +#endif 241 + 242 +#define _gdu_gstr_stack(ty, str) ({ \ 243 + size_t sz = gd_##ty##_length(str) + 1; \ 244 + char* buf = _stalloc(char, sz); \ 245 + gdu_##ty##_emit(str, buf, sz - 1); \ 246 + buf; \ 247 +}) 248 +#define _gdu_gstr_stackp(ty, str) ({ \ 249 + size_t sz = gd_##ty##_length(str) + 1; \ 250 + char* buf = _stalloc(char, sz); \ 251 + gdu_##ty##_emit(str, buf, sz - 1); \ 252 + (pstr) {.v = buf, .sz = sz}; \ 253 +}) 254 + 255 +#define _gdu_string_stack(str) _gdu_gstr_stack(string, str) 256 +#define _gdu_stringName_stack(str) _gdu_gstr_stack(stringName, str) 257 +#define _gdu_string_stackp(str) _gdu_gstr_stackp(string, str) 258 +#define _gdu_stringName_stackp(str) _gdu_gstr_stackp(stringName, str) 259 + 260 + 261 +static inline size_t 262 +gdu_stringName_emit 263 +( size_t sz; 264 + 265 + _ref(gd_stringName) s, 266 + char target[static sz], 267 + size_t sz 268 +) { 269 + gd_string r; 270 + _t(string).fromStringName(&r, (void*)&s); 271 + const auto len = gdu_string_emit(&r, target, sz); 272 + _t(string).dtor(&r); 273 + return len; 274 +} 275 + 276 +#define _gdu_packedArray_push_def(name, T, input, fn) \ 277 + static inline bool \ 278 + gdu_array_##name \ 279 + ( gd_packed##T##Array* self,\ 280 + const typeof(input)* const arg \ 281 + ) {\ 282 + bool ret;\ 283 + auto c = &gdjn_ctx -> gd.t; \ 284 + (c -> gd_packed##T##Array.fn) ( \ 285 + self,\ 286 + (GDExtensionConstTypePtr[]) { \ 287 + arg,\ 288 + }, &ret, 1\ 289 + );\ 290 + return ret;\ 291 + } 292 + 293 +#define _gdu_packedArrayTypes \ 294 + _(Byte, byte, uint8_t ) \ 295 + _(Int32, int32, int32_t ) \ 296 + _(Int64, int64, int64_t ) \ 297 + _(Float32, float32, int32_t ) \ 298 + _(Float64, float64, int64_t ) \ 299 + _(String, string, gd_string ) \ 300 + _(Vector2, vector2, gd_vector2) \ 301 + _(Vector3, vector3, gd_vector3) \ 302 + _(Vector4, vector4, gd_vector4) \ 303 + 304 +#define _gdu_packedArray_defs(maj, min, input) \ 305 + _gdu_packedArray_push_def(min##_##push, maj, input, append) \ 306 + _gdu_packedArray_push_def(min##_##concat, maj, gd_packed##maj##Array, append_array) 307 +/* bool gdu_array_(type)_push(self, type) 308 + * bool gdu_array_(type)_concat(self, packedArray[type]) 309 + */ 310 + 311 +#define _(...) _gdu_packedArray_defs(__VA_ARGS__) 312 + _gdu_packedArrayTypes 313 +#undef _ 314 + 315 +/* obnoxious special case */ 316 +static inline bool 317 +gdu_array_string_pushPtr 318 +( gd_packedStringArray* self, 319 + const char* const str, 320 + size_t sz 321 +) { 322 + gd_string tmp; 323 + if (sz == 0) _t(string).newWithUtf8Chars (&tmp, str); 324 + else _t(string).newWithUtf8CharsAndLen(&tmp, str, sz); 325 + bool ret = gdu_array_string_push(self, &tmp); 326 + _t(string).dtor(&tmp); 327 + return ret; 328 +} 329 +#define _gdu_array_string_pushLit(self, str) \ 330 + (gdu_array_string_pushPtr((self), (str), sizeof (str) - 1)) 331 + 332 +static inline bool 333 +gdu_string_suffix 334 +( _ref(gd_string) self, 335 + _ref(char) affix, 336 + size_t affsz 337 +) { 338 + auto ch = _gdu_string_stackp(self); 339 + if (affsz == 0) affsz = strlen(affix); 340 + if (ch.sz < affsz) return false; 341 + for (size_t i = 0; i < affsz; ++i) { 342 + auto a = ch.v[ch.sz - 2 - i]; 343 + auto b = affix[affsz - 1 - i]; 344 + if (a != b) return false; 345 + } 346 + return true; 347 +} 348 + 349 +static inline void* 350 +gdu_classTag(_ref(char) name) { 351 + void* tag = nullptr; 352 + _withSym(sName, name, 353 + tag = _t(classdb).getClassTag(&sName); 354 + ); 355 + return tag; 356 +} 357 +static inline GDExtensionObjectPtr 358 +gdu_cast 359 +( GDExtensionConstObjectPtr what, 360 + _ref(char) to 361 +) { 362 + return _t(object).castTo(what, gdu_classTag(to)); 363 +}
Added tool/api-compile.janet version [bd52030fd5].
1 +(defn api-parse [src] 2 + {} #TODO parse json 3 + ) 4 + 5 +(defn api-gen [api] 6 + @{} #TODO gen bindings 7 + ) 8 + 9 +(defn main [_ api-src api-dest & _] 10 + (def api 11 + (with [fd (file/open api-src :r)] 12 + (api-gen (api-parse (:read fd :all))))) 13 + (def api-bin (make-image api)) 14 + (with [fd (file/open api-dest :w)] 15 + (:write fd api-bin)) 16 + 0) 17 +
Added tool/c-bind-gen.janet version [777733985b].
1 +# [ʞ] c-bind-gen.janet 2 +# ~ lexi hale <lexi@hale.su>, may the gods have mercy on 3 +# the tattered remnants of my soul 4 +# 🄯 CC0 (please, megacorps, im begging you, steal this 5 +# piece of shit. YOUVE EARNED IT) 6 +# > janet tool/c-bind-gen.janet (header|loader) 7 +# 8 +# ! look, im not gonna bullshit you. this code is terrible 9 +# i started writing it when i was still getting the hang 10 +# of janet, in particular working with its lispified OOP 11 +# system, and i made some terrible mistakes. in 12 +# particular because i've never actually used a proper 13 +# prototype-based object system before (lua doesn't 14 +# really count here). at some point i realized the code 15 +# was unfixably bad and i just stopped caring. at some 16 +# point, if this project goes anywhere, this whole 17 +# gibbering aberration deserves to be ripped out and 18 +# redone from scratch, ideally using some of the cleaner 19 +# mechanisms i ended up putting together for 20 +# tool/class-compile.janet 21 + 22 +(import :/lib/json) 23 + 24 +(def <gd-sym> (let 25 + [transform (fn[{:seg segments} tx delim] 26 + (string/join (map tx segments) delim)) 27 + capitalize (fn[x] (string 28 + (string/ascii-upper (slice x 0 1)) 29 + (slice x 1)))] 30 + 31 + {:@inherit (fn gd-sym:inherit[class & defs] 32 + (struct/with-proto class ;defs)) 33 + :@new (fn gd-sym:new[class & args] 34 + (struct/with-proto class ;((class :%init) ;args))) 35 + :%init (fn gd-sym:init[dfn] 36 + [:id (dfn :id) 37 + :seg (get dfn :seg [;(string/split "-" (string (dfn :id)))])]) 38 + 39 + 40 + :from |(:@new $0 {:id $1}) 41 + :from-snek |(as-> $1 x 42 + (string/ascii-lower x) 43 + (string/split "_" x) 44 + {:id (string/join x "-") 45 + :seg x} 46 + (:@new $0 x)) 47 + 48 + :vstr |(if (> ($ :ver) 1) (string ($ :ver)) "") 49 + :tall |(transform $ capitalize "") 50 + :sulk |(transform $ identity "_") 51 + :scream |(transform $ string/ascii-upper "_") 52 + :name |(apply string [ (first ($ :seg)) 53 + ;(map capitalize (slice ($ :seg) 1))])})) 54 + 55 +(def <gd-method> 56 + (:@inherit <gd-sym> 57 + :%init (fn [spec] 58 + [ ;((<gd-sym> :%init) spec) 59 + :ver (spec :ver) ]))) 60 + 61 +(def <gd-type> 62 + (:@inherit <gd-sym> 63 + :%init (fn[spec] 64 + 65 + (defn bind-def[bind-spec] 66 + (:@new <gd-method> 67 + (match bind-spec 68 + (obj (struct? obj)) obj 69 + [sym ver] {:id sym :ver ver} 70 + sym {:id sym :ver 1 }))) 71 + 72 + [ ;((<gd-sym> :%init) spec) 73 + :binds (map bind-def 74 + (or (spec :binds) [])) 75 + :methods (map bind-def 76 + (or (spec :methods) [])) 77 + :ops (map bind-def 78 + (or (spec :ops) [])) 79 + :ctors (or (spec :ctors) {}) 80 + :mode (spec :mode)]) 81 + :binds [] 82 + :methods [] 83 + :ctors {} 84 + :ops [] 85 + :mode : 86 + :enum (fn [me] 87 + (string "GDEXTENSION_VARIANT_TYPE_" (:scream me))) 88 + )) 89 + 90 +(defn env: [v dflt] 91 + (or ((os/environ) v) dflt)) 92 + 93 +(def api-spec 94 + (let [api-spec-path 95 + (env: "gd_api_spec" 96 + (string (env: "gd_build_gen" "gen") 97 + "/extension_api.json" ))] 98 + (json/parse 99 + (with [fd (file/open api-spec-path :r)] 100 + (:read fd :all))))) 101 + 102 +(def vector-types-float (map |(symbol 'vector $) (range 2 5))) 103 +(def vector-types 104 + (tuple/join vector-types-float 105 + (map |(symbol $ 'i) vector-types-float))) 106 + 107 +(def packed-types 108 + (map |(symbol 'packed- $ '-array) 109 + (tuple/join vector-types-float 110 + ['color 'byte 'string 111 + 'int32 'int64 112 + 'float32 'float64]))) 113 + 114 +(defn names-variant? [x] 115 + (-> (map |(:tall (:from <gd-sym> $)) packed-types) 116 + (array/join ["String" "StringName" 117 + "Array" "Dictionary"]) 118 + (has-value? x))) 119 +(defn names-prim? [x] 120 + (-> ["int" "float" "bool"] 121 + (has-value? x))) 122 +(def variants (map |(:@new <gd-type> $) ~[ 123 + {:id variant :binds [get-ptr-constructor 124 + get-ptr-destructor 125 + get-ptr-operator-evaluator 126 + get-ptr-internal-getter 127 + get-ptr-builtin-method 128 + get-type 129 + booleanize]} 130 + {:id bool } 131 + {:id color } 132 + 133 + ,;(map |{:id $} vector-types) 134 + ,;(map |{:id $ 135 + :methods '[get set size resize fill clear 136 + append append_array insert remove-at 137 + has is-empty find rfind count 138 + reverse slice duplicate] 139 + :ctors {:empty []} 140 + } 141 + packed-types) 142 + {:id array 143 + :binds [ref set-typed] 144 + :ctors {:empty []}} 145 + {:id dictionary 146 + :binds [set-typed operator-index operator-index-const] 147 + :ctors {:empty []}} 148 + 149 + {:id string-name :mode :dc 150 + :ops [equal] 151 + :binds [new-with-utf8-chars 152 + new-with-utf8-chars-and-len] 153 + :methods [length 154 + ends-with begins-with 155 + trim-suffix trim-prefix] 156 + :ctors {:empty [] 157 + :copy [[:from string-name]] 158 + :from-string [[:from string]]}} 159 + 160 + {:id string :mode :dc 161 + :ops [equal] 162 + :binds [[new-with-utf8-chars 1] 163 + [new-with-utf8-chars-and-len 2] 164 + to-utf8-chars] 165 + :methods [length 166 + ends-with begins-with 167 + trim-suffix trim-prefix] 168 + :ctors {:empty [] 169 + :copy [[:from string]] 170 + :from-string-name [[:from string-name]]}} 171 +])) 172 + 173 +(def classes (map |(:@new <gd-type> $) '[ 174 + {:id classdb :binds [[register-extension-class 4] 175 + unregister-extension-class 176 + register-extension-class-method 177 + register-extension-class-virtual-method 178 + get-method-bind 179 + get-class-tag 180 + [construct-object 2]]} 181 + {:id object :binds [set-instance 182 + set-instance-binding 183 + get-class-name 184 + cast-to 185 + has-script-method 186 + call-script-method 187 + method-bind-ptrcall 188 + destroy 189 + ]} 190 + {:id global :binds [get-singleton]} #hax 191 +])) 192 + 193 +(def internals (map |(:@new <gd-type> $) ~[ 194 + {:id engine :binds [register-script-language 195 + unregister-script-language]} 196 + {:id ref-counted :binds [reference unreference 197 + get-reference-count]} 198 + {:id script :binds [get-source-code set-source-code]} 199 + {:id file-access :binds [open close store-string get-as-text]} 200 + {:id resource-loader :binds [add-resource-format-loader 201 + remove-resource-format-loader]} 202 + {:id resource-saver :binds [add-resource-format-saver 203 + remove-resource-format-saver]} 204 +])) 205 + 206 +(def global-enums (map |(:from <gd-sym> $) '[ 207 + error 208 +])) 209 + 210 +(def singletons (map |(:from <gd-sym> $) '[ 211 + engine 212 + resource-loader 213 + resource-saver 214 +])) 215 + 216 +(def c-fetch-decl (string 217 + "void gdjn_types_fetch\n" 218 + "( struct gdjn_typeDB* t,\n" 219 + " GDExtensionInterfaceGetProcAddress getProc\n" 220 + ")")) 221 + 222 +(defn main [_ mode & args] 223 + (def api { 224 + :decls @[] 225 + :aliases @[] 226 + :calls @[] 227 + :defer-calls @[] # dependency Hel bypass 228 + :types @[] 229 + :method-defs @[] 230 + }) 231 + (def config (env: "gd_config" "double_64")) 232 + (def sizes (do 233 + (var sz-list nil) 234 + (loop [cfg :in (api-spec "builtin_class_sizes") 235 + :until (not= nil sz-list)] 236 + (when (= config (cfg "build_configuration")) 237 + (set sz-list (cfg "sizes")))) 238 + 239 + (def vt @{}) 240 + (loop [sz :in sz-list] 241 + (put vt (sz "name") (sz "size"))) 242 + vt)) 243 + (defn prim:gd->c [x] 244 + (defn bp [x small big] 245 + (case (sizes x) 246 + 4 small 247 + 8 big 248 + (error (string "bad type size " (sizes x) " for " x)))) 249 + (case x 250 + "int" (bp "int" "int32_t" "int64_t") 251 + "float" (bp "float" "float" "double") 252 + "bool" "bool")) 253 + (defn variant:gd->c [x] 254 + (def v (find |(= x (:tall (:@new <gd-sym> {:id ($ :id)}))) variants)) 255 + (string "gd_" (:name v))) 256 + (defn translate-type [st &opt flags] 257 + (defn fl [x] (string/check-set (or flags :) x)) 258 + (match (string/split "::" st) 259 + # enums can be directly mapped to a C 260 + # instantiation of the enum 261 + ["enum" ty] 262 + (match (string/split "." ty) 263 + [a b] (string/format "gd_%s_%s" a b) 264 + [x] (string "gd_" x)) 265 + 266 + # primitives will be returned directly 267 + ([ty] (names-prim? ty)) 268 + (prim:gd->c ty) 269 + 270 + # opaques ("variant" members) will be 271 + # returned as the appropriate opaque object 272 + ([ty] (names-variant? ty)) 273 + (let [t (variant:gd->c ty)] 274 + (if (not (fl :r)) t 275 + (string/format "typeof(%s)%s*" t 276 + (if (fl :c) " const" "")))) 277 + 278 + # everything else has to be an object; return 279 + # a pointer 280 + [ty] (string "GDExtension" 281 + (if (fl :c) "Const" "") 282 + "ObjectPtr /*"ty"*/") 283 + 284 + fbk (error (string/format "bad type %q" fbk)))) 285 + (defn method:return-type [method] 286 + (let [rv (method :return_value)] (cond 287 + (nil? rv) "void" 288 + (empty? rv) "void" 289 + (translate-type (rv "type"))))) 290 + (defn method:args [method t-self &opt self-flags] 291 + (as-> (if (has-key? method :arguments) 292 + (method :arguments) 293 + []) lst 294 + (if (method :is_static) lst 295 + (tuple/join [{"name" "self" 296 + "type" t-self 297 + :flags (keyword :r (or self-flags :))}] lst)) 298 + (map |(string (translate-type ($ "type") ($ :flags)) 299 + " const " 300 + ($ "name")) lst))) 301 + (def gdclasses (merge 302 + ;(seq [src :in ["classes" "builtin_classes"]] 303 + (tabseq [class :in (api-spec src)] 304 + (class "name") 305 + {:methods (if (= nil (class "methods")) {} 306 + (tabseq [meth :in (class "methods")] 307 + (meth "name") 308 + (tabseq [[k v] :pairs meth] 309 + (keyword k) v))) 310 + :enums (get class "enums" [])})))) 311 + (defn add [to fmt & vals] 312 + (array/push to (string/format fmt ;vals))) 313 + (defn add-get-proc [class method] 314 + (def version-str (:vstr method)) 315 + # this is so hateful and evil im not even going to pretty it up 316 + (def ptr-t (if (= (method :id) 'get-ptr-internal-getter) 317 + "GDExtensionInterfaceGetVariantGetInternalPtrFunc" 318 + (string/format "GDExtensionInterface%s%s" 319 + (string (:tall class) (:tall method)) version-str 320 + ))) 321 + 322 + (add (api :calls) "t -> gd_%s.%s = (%s)getProc(\"%s%s\");" 323 + (:name class) (:name method) ptr-t 324 + (string (:sulk class) "_" (:sulk method)) version-str)) 325 + 326 + (def gd-iface-pfx "GDExtensionInterface") 327 + 328 + (defn add-methods [class binds] 329 + (loop [bind :in binds 330 + :let [c-type (string gd-iface-pfx 331 + (:tall class) (:tall bind))]] 332 + (def ptr-t (if (= (bind :id) 'get-ptr-internal-getter) 333 + "GDExtensionInterfaceGetVariantGetInternalPtrFunc" 334 + c-type)) 335 + (add (api :decls) "\t%s%s %s;" ptr-t (:vstr bind) (:name bind)) 336 + (add-get-proc class bind))) 337 + (defn add-enums [class] 338 + (def api-ent (get-in gdclasses [(:tall class) :enums] [])) 339 + (defn ln [& x] (add (api :types) ;x)) 340 + (each e api-ent 341 + (def id (string "gd_" (:tall class) "_" (e "name"))) 342 + # the underlying type is IMPORTANT! godot enums 343 + # appear to use the godot int type, which (at present) 344 + # is always 8 bytes long. this means trying to write 345 + # a godot "enum" to a plain old C enum will, if you 346 + # are very lucky, cause your program to barf all over 347 + # the stack and immediately segfault 348 + (ln "typedef enum %s : int64_t {" id) 349 + # thank the gods for C23. this would have been really 350 + # unpleasant otherwise 351 + (each n (e "values") 352 + (def ident (:from-snek <gd-sym> (n "name"))) 353 + (def sym (:@new <gd-sym> ident)) 354 + (ln "\t%s_%s = %d," id (:name sym) (n "value")) 355 + (ln "\t/* %s */" 356 + (n "description"))) 357 + (ln "} %s;\n" id))) 358 + (defn add-ctors [class ctors] 359 + (loop [[id form] :pairs ctors] 360 + (def id-sym (:from <gd-sym> id)) 361 + (def key (freeze (seq [[name t] :in form 362 + :let [tsym (:from <gd-sym> t)]] 363 + {"name" (string name) 364 + "type" (string (:tall tsym))}))) 365 + (def ent (as-> (api-spec "builtin_classes") x 366 + (find |(= (freeze ($ "name")) (:tall class)) x) 367 + (x "constructors") 368 + (find |(if (empty? key) (not (has-key? $ "arguments")) 369 + (let [args (freeze ($ "arguments"))] 370 + (= key args))) x))) 371 + (assert ent (string/format "no matching constructor: %q" form)) 372 + (let [ctor-idx (ent "index")] 373 + (add (api :decls) "\tGDExtensionPtrConstructor %s;" (:name id-sym)) 374 + (add (api :calls) "t -> gd_%s.%s = t -> gd_variant.getPtrConstructor(%s, %d);" 375 + (:name class) (:name id-sym) (:enum class) ctor-idx) 376 + ))) 377 + 378 + (add (api :aliases) "#define _opaque(n) struct{unsigned char _opaque_ [n];}") 379 + 380 + (defn with-names [ln names func] 381 + (ln "{") 382 + (each [id val] names 383 + (ln "gd_stringName %s;" id) 384 + (ln "t -> gd_stringName.newWithUtf8Chars(&%s, %q);" id val)) 385 + (func) 386 + (each [id _] names 387 + (ln "t -> gd_stringName.dtor(&%s);" id)) 388 + (ln "}")) 389 + 390 + (loop [e :in global-enums] 391 + (defn ln [& x] (add (api :types) ;x)) 392 + (def spec (find |(= ($ "name") (:tall e)) 393 + (api-spec "global_enums"))) 394 + (assert spec (string/format "no enum with name %s found" 395 + (:tall e))) 396 + (ln "typedef enum gd_%s : int64_t {" (:tall e)) 397 + (each v (spec "values") 398 + (def name (:from-snek <gd-sym> (v "name"))) 399 + (ln "\tgd_%s_%s = %d," (:tall e) (:name name) (v "value")) 400 + (when (v "description") 401 + (ln "\t/* %s */" (v "description")))) 402 + (ln "} gd_%s;\n" (:tall e)) 403 + ) 404 + 405 + (loop [v :in variants 406 + :let [vsz (or (sizes (:tall v)) 407 + (sizes (string (v :id) )))]] 408 + (add (api :aliases) # these are all opaque objects 409 + "typedef _opaque(%d) gd_%s;" 410 + vsz (:name v)) 411 + (add (api :decls ) "struct {") 412 + (def my-enum (:enum v)) 413 + (add-methods v (v :binds)) 414 + (add-enums v) 415 + 416 + # bind builtins 417 + # WHY IS THIS *YET ANOTHER* COMPLETELY DIFFERENT API 418 + # for the SAME LITERAL THING fuck youuuuu 419 + (when (has-key? gdclasses (:tall v)) (loop [m :in (v :methods) 420 + :let [method (get-in gdclasses [(:tall v) :methods 421 + (:sulk m)])]] 422 + (add (api :decls) "\tGDExtensionPtrBuiltInMethod %s;" (:name m)) 423 + 424 + (def return-type 425 + (if (not (has-key? method :return_type)) "void" 426 + (translate-type (method :return_type)))) 427 + (def args (method:args method (:tall v) 428 + (if (method :is_const) :c :))) 429 + 430 + (def impl @[]) 431 + (unless (= return-type "void") 432 + (array/push impl 433 + (string/format "typeof(%s) ret;" return-type))) 434 + (array/push impl 435 + (string/format "_g_typeDB -> gd_%s.%s(" 436 + (:name v) (:name m))) 437 + 438 + 439 + (array/push impl 440 + (string "\t" (if (method :is_static) 441 + "nullptr" "(void*)self") ",") 442 + "\t(void const*[]) {") 443 + (when (has-key? method :arguments) 444 + (each a (method :arguments) 445 + (array/push impl 446 + (string/format "\t\t&%s," (a "name"))) 447 + )) 448 + (array/push impl (string/format "\t}, %s, %d" 449 + (if (= return-type "void") "nullptr" "&ret") 450 + (if (not (has-key? method :arguments)) 0 451 + (length (method :arguments)))) 452 + ");") 453 + (unless (= return-type "void") 454 + (array/push impl "return ret;")) 455 + 456 + 457 + (array/push (api :method-defs) 458 + {:dfn (string/format "%s gd_%s_%s\n(\t%s\n)" 459 + return-type (:name v) (:name m) 460 + (string/join args ",\n\t")) 461 + :impl impl}) 462 + 463 + (with-names (fn [& a] (add (api :defer-calls) ;a)) 464 + [[:methodID (:sulk m)]] 465 + (fn [] (add (api :defer-calls) 466 + "t -> gd_%s.%s = t -> gd_variant.getPtrBuiltinMethod(%s, &methodID, %d);" 467 + (:name v) (:name m) 468 + my-enum (method :hash) 469 + ) 470 + )))) 471 + 472 + (when (v :ctors) 473 + (add-ctors v (v :ctors))) 474 + 475 + (when (not= "variant" (:name v)) 476 + (add (api :decls) "\ttypeof(gd_%s* (*)(GDExtensionVariantType*)) raw;" (:name v)) 477 + (add (api :calls) "t -> gd_%s.raw = (typeof(t->gd_%s.raw))t -> gd_variant.getPtrInternalGetter(%s);" 478 + (:name v) (:name v) my-enum)) 479 + 480 + (loop [o :in (v :ops)] 481 + 482 + (add (api :decls) "\tGDExtensionPtrOperatorEvaluator %s;" (:name o)) 483 + (add (api :calls) "t -> gd_%s.%s = t -> gd_variant.getPtrOperatorEvaluator(GDEXTENSION_VARIANT_OP_%s, %s, %s);" 484 + (:name v) (:name o) (string/ascii-upper (:sulk o)) 485 + my-enum my-enum) 486 + ) 487 + 488 + (when (string/check-set (v :mode) :d) 489 + (add (api :calls) 490 + "t -> gd_%s.dtor = t -> gd_variant.getPtrDestructor(%s);" 491 + (:name v) my-enum ) 492 + (add (api :decls) "\tGDExtensionPtrDestructor dtor;")) 493 + 494 + (add (api :decls) "} gd_%s;" (:name v))) 495 + 496 + (loop [c :in classes 497 + :let [pfx (string "GDExtensionInterface" (:tall c) (:vstr c)) 498 + gd-t (:sulk c)]] 499 + 500 + (add (api :decls) "struct {") 501 + (add-methods c (c :binds)) 502 + (add-enums c) 503 + (add (api :decls) "} gd_%s;" (:name c))) 504 + 505 + 506 + (loop [i :in internals 507 + :let [class (gdclasses (:tall i))]] 508 + (def ctr-id (string/format "gd_m_%s" (:name i))) 509 + 510 + (add (api :decls) "struct {") 511 + (add-enums i) 512 + (loop [m :in (i :binds) 513 + :let [method ((class :methods) (:sulk m))]] 514 + (assert method 515 + (string/format "method %s not found in class %s" 516 + (m :id) (i :id))) 517 + (add (api :decls) "\tGDExtensionMethodBindPtr %s_ptr;" 518 + (:name m)) 519 + 520 + (def return-type (method:return-type method)) 521 + (def args (method:args method (:tall i) 522 + (if (method :is_const) :c :))) 523 + 524 + (def impl @[]) 525 + (defn ln [& x] (array/push impl ;x)) 526 + (when (not= return-type "void") 527 + (ln (string/format "%s ret;" return-type))) 528 + (ln "_g_typeDB -> gd_object.methodBindPtrcall(" 529 + (string/format "\t_g_typeDB -> gd_m_%s.%s_ptr," 530 + (:name i) (:name m)) 531 + (if (method :is_static) "\tnullptr," "\t(void*)self,") 532 + "\t(GDExtensionConstTypePtr[]) {") 533 + (as-> (method :arguments) args 534 + (if (nil? args) [] args) 535 + (map |(string "\t\t&" ($ "name") ",") args) 536 + (ln ;args)) 537 + (ln (string "\t}, " 538 + (if (not= return-type "void") 539 + "&ret" 540 + "nullptr")) ");") 541 + (when (not= return-type "void") (ln "return ret;")) 542 + (array/push (api :method-defs) 543 + {:dfn (string/format "%s gd_%s_%s\n(\t%s\n)" 544 + return-type 545 + (:name i) 546 + (:name m) 547 + (string/join args ",\n\t") 548 + ) 549 + :impl impl}) 550 + 551 + (defn ln [& l] (add (api :calls) ;l)) 552 + 553 + (with-names ln 554 + [["className" (:tall i)] 555 + ["methodName" (:sulk m)]] 556 + (fn [] 557 + (ln (string 558 + "auto ptr = t -> gd_classdb.getMethodBind(&className, &methodName, %d);\n" 559 + "\tt -> %s.%s_ptr = ptr;\n" 560 + "\t"`printf("* bind method %s.%s (%%p)\n",ptr);` "\n" 561 + "\tassert(ptr != nullptr);") 562 + (method :hash) 563 + ctr-id (:name m) 564 + (:name i) (:name m) 565 + )))) 566 + (add-ctors i (i :ctors)) 567 + (add (api :decls) "} %s;" ctr-id)) 568 + 569 + 570 + (add (api :decls) "struct {") 571 + (loop [s :in singletons] 572 + (add (api :decls) "\tGDExtensionObjectPtr %s;" (:name s)) 573 + (defn cln [& v] (add (api :calls) ;v)) 574 + (with-names cln 575 + [["sgtName" (:tall s)]] 576 + (fn [] 577 + (cln "t -> objects.%s = t -> gd_global.getSingleton(&sgtName);" (:name s)) 578 + (cln "if (t -> objects.%s == nullptr) abort();" (:name s)) 579 + ))) 580 + (add (api :decls) "} objects;") 581 + 582 + (case mode 583 + "list" (do 584 + # may the gods have mercy on me 585 + (defn print-binds [v] 586 + (print " • \e[94;4m" (v :id)"\e[m") 587 + (each b (v :binds) 588 + (print " · " (b :id) "\n" 589 + " \e[3;35mgd_" (:name v) "." (:name b) "()\e[m"))) 590 + (print "we are currently binding the following symbols") 591 + (print "- \e[1mvariants\e[m -" ) 592 + (each v variants (print-binds v)) 593 + (print "- \e[1mclasses\e[m -" ) 594 + (each c classes (print-binds c)) 595 + (print "- \e[1mptrcalls\e[m -" ) 596 + (each i internals 597 + (print " • \e[94;4m" (i :id)"\e[m") 598 + (each b (i :binds) 599 + (print " · " (b :id) "\n" 600 + " \e[3;33mgd_m_" (:name i) "." (:name b) "_ptr\e[m\n" 601 + " \e[3;92mgd_" (:name i) "_" (:name b) "()\e[m"))) 602 + 603 + (print "- \e[1msingletons\e[m -" ) 604 + (each s singletons 605 + (print " • \e[94;4m" (s :id)"\e[m\n" 606 + " \e[3;33mobjects." (:name s) "\e[m" )) 607 + 608 + (print "- \e[1mglobal enums\e[m -" ) 609 + (each e global-enums 610 + (print " • \e[94;4m" (e :id)"\e[m\n" 611 + " \e[3;33mgd_" (:tall e) "\e[m" ))) 612 + "header" (do 613 + (print "/* automatically generated by tool/c-bind-gen.janet */\n\n" 614 + "#pragma once\n" 615 + "#include \"gdextension_interface.h\"\n") 616 + (loop [list :in [(api :aliases)] 617 + val :in list] (print val)) 618 + (print "\ntypedef struct gdjn_typeDB {") 619 + (loop [d :in (api :decls)] 620 + (print "\t" d)) 621 + (print "} gdjn_typeDB;") 622 + (each t (api :types) (print t)) 623 + (print c-fetch-decl ";") 624 + (each m (api :method-defs) 625 + (print (m :dfn) ";"))) 626 + 627 + "loader" (do 628 + (print "#include <stdlib.h>\n" 629 + "#include <stdio.h>\n" 630 + "#include <assert.h>\n" 631 + "#include \"interface.h\"\n\n" 632 + "static gdjn_typeDB* _g_typeDB;\n\n" 633 + # HORRID HACK 634 + 635 + c-fetch-decl "{\n" 636 + ;(map |(string "\t" $ "\n") 637 + [ "_g_typeDB = t;" 638 + ;(api :calls) 639 + ;(api :defer-calls) ]) 640 + "}") 641 + (each m (api :method-defs) 642 + (print (m :dfn) "{\n\t" (string/join (m :impl) "\n\t") "\n}\n")))))
Added tool/class-compile.janet version [21ecd655b6].
1 +# [ʞ] tool/class-compile.janet 2 +# ~ lexi hale <lexi@hale.su> 3 +# 🄯 AGPLv3 4 +# ? compiles a godot class definition to C source 5 +# > janet tool/class-compile.janet <class> (loader|header) 6 + 7 +(def *src-file* (gensym)) 8 + 9 +(def parse-doc 10 + (do 11 + (def doc-parser (peg/compile '{ 12 + :hs (+ " " "\t") 13 + :- "-" 14 + :open-line (* (? " ") (? '(some (if-not "\n" 1))) "\n") 15 + :single-line (* (? " ") (? '(some (* (not :hs) 1))) (any :hs) -1) 16 + :mid-line (+ (* (any :hs) :- (? " ") 17 + (? '(some (if-not "\n" 1))) "\n") 18 + (* (? '(some (if-not "\n" 1))) "\n")) 19 + :close-line (+ (* (any :hs) -1) 20 + (* (any :hs) :- (? " ") 21 + (? '(some (if-not (* (any :hs) -1) 1))) 22 + (any :hs) -1)) 23 + :main (+ (* :open-line (any :mid-line) :close-line) 24 + :single-line 25 + '(any 1)) # admit defeat 26 + })) 27 + 28 + (fn parse-doc[str] 29 + (peg/match doc-parser str)))) 30 + 31 +(def syntaxes 32 + (do (def quot-syntax 33 + '(nth 1 (unref (* (<- (+ `"` `'`) :quo) 34 + (<- (any (+ (* `\` (backmatch :quo)) 35 + (if-not (backmatch :quo) 1)))) 36 + (backmatch :quo)) :quo))) 37 + (defn fail [cause] 38 + (defn mk [ln col] 39 + {:kind :parse 40 + :cause cause 41 + :ln ln :col col}) 42 + ~(error (cmt (* (line) (column)) ,mk))) 43 + (defn req [id body] 44 + ~(+ (* ,;body) ,(fail (keyword :malformed- id)))) 45 + (defn kw [id body] 46 + ~(* ,id (> 1 :bound) ,(req id ~(:s+ ,;body)))) 47 + (defn comment-syntax [id open close] 48 + ~(* ,open '(any (+ ,id 49 + :quot 50 + (if -1 ,(fail :fell-off-comment)) 51 + (if-not ,close 1))) ,close)) 52 + 53 + {:class-def (peg/compile ~{ 54 + :b (any :s) 55 + :bound (+ :s ";" "," `"` "{" "}" "<" ">" ":" "->" "(" ")") 56 + :sym (some (if-not :bound 1)) 57 + :sym-kw (cmt ':sym ,keyword) 58 + :term (* :b ";" :b) 59 + :quot ,quot-syntax 60 + :quot-ang (* "<" (<- (any (+ `\>` 61 + (if-not ">" 1)))) 62 + ">") 63 + :doc (cmt (* :b ,(comment-syntax :doc "(-" "-)") :b) 64 + ,(fn [text] [:doc ;(parse-doc text)])) 65 + :def-class (* (+ (* (constant :class) "class") 66 + (* (constant :iface) "interface")) 67 + :s+ (<- :sym) :s+ 68 + (+ (* (constant :native) "is") 69 + (* (constant :gdext) "extends") 70 + ,(fail :bad-inherit)) 71 + :s+ (<- :sym) 72 + :b "{" :b (group (any :stmt)) :b "}") 73 + :def-import (* (constant :import) 74 + (+ (* (constant :impl) "use") 75 + (* (constant :head) "import")) 76 + :b 77 + (+ (* (constant :lit) :c-block) 78 + (* (constant :sys) :quot-ang) 79 + (* (constant :loc) :quot))) 80 + :c-comment (+ (* (+ "//" "#") (any (if-not (+ "\n" -1) 1)) (+ "\n" -1)) 81 + (* "/*" (any (if-not "*/" 1)) "*/")) 82 + :c-block (cmt (* "{" (line) (<- (any (+ (drop :quot) 83 + (drop :c-block) 84 + :c-comment 85 + (if -1 ,(fail :fell-off-c-block)) 86 + (if-not "}" 1)))) "}") 87 + ,(fn [ln text] 88 + (string/format "#line %d %q\n%s" 89 + (+ 4 ln) (dyn *src-file*) text))) 90 + :type-gd-vector (* "vector" (+ "2" "3" "4")) 91 + :type-gd-basic (cmt '(+ 92 + "int" 93 + "float" 94 + "bool" 95 + "string-name" 96 + "string" 97 + "color" 98 + :type-gd-vector 99 + 100 + "transform-2D" 101 + "transform-3D" 102 + "basis" 103 + "projection" 104 + 105 + "variant" 106 + "array" 107 + "dictionary" 108 + (* "packed-" 109 + (+ (* (+ "int" "float") (+ "32" "64")) 110 + :type-gd-vector 111 + "byte" "color" "string") "-array")) 112 + ,keyword) 113 + :type-gd (+ (group (* (constant :ref) "ref" :b ':sym)) 114 + (group (* (constant :array) "array" :b 115 + "[" :b :type-gd-basic :b "]")) 116 + (group (* (constant :dictionary) "dictionary" :b 117 + "[" :b :type-gd-basic "," 118 + :b :type-gd-basic :b "]")) 119 + :type-gd-basic) 120 + 121 + :arg-spec (* (group (* :type-gd :s+ ':sym (? :doc))) (? (* :b (+ "," ";") :b :arg-spec))) 122 + :arg-list (group (* "(" :b (? :arg-spec) :b (?";") :b ")")) 123 + :def-method (* (constant :func) (+ (* (constant :method) "fn") 124 + (* (constant :impl ) "impl")) 125 + :s+ ':sym :b :arg-list :b 126 + (+ (* "->" :b (group (* :type-gd (? :doc)))) 127 + (constant [:void])) 128 + :b :c-block) 129 + :def-event (* (constant :event) 130 + (+ (* (constant :ctor) "new") 131 + (* (constant :dtor) "del") ) :b :c-block) 132 + :def-var (* (constant :var) 133 + # c type 134 + (+ (* "var" (> (* :s+ "as")) (constant :auto)) 135 + (* "var" :s+ 136 + '(any (if-not (+ (* :s+ "as" :s+) 137 + (* :b ":" )) 1)))) 138 + (+ (* :s+ "as" :s+ :type-gd) 139 + (constant :priv)) 140 + (* :b ":" :b) (any (* ':sym :b "," :b)) ':sym) 141 + 142 + :def (* (? :doc) 143 + (+ :def-class 144 + :def-var 145 + :def-import 146 + :def-method 147 + :def-event)) 148 + :stmt (* :b (+ (group :def) "") :term) 149 + # :main (+ (* (any :stmt) -1) 150 + # ,(fail :bad-stmt)) 151 + :main (* (any :stmt) (+ -1 ,(fail :bad-stmt)))}) 152 + :comment-eraser (peg/compile ~{ 153 + :quot ,quot-syntax 154 + :comment ,(comment-syntax :comment "(*" "*)") 155 + :main (% (any (+ (drop :comment) 156 + (<- 1))))}) 157 + })) 158 + 159 +(defn parse-class [str] 160 + (def stripped (first (peg/match (syntaxes :comment-eraser) str))) 161 + (peg/match (syntaxes :class-def) stripped)) 162 + 163 +(def *colorize* (gensym)) 164 +(setdyn *colorize* true) 165 + 166 +(defn style [& body] 167 + (def emit (if (dyn *colorize*) 168 + (fn [sq] (string "\e[;" sq "m")) 169 + (fn [_ ] ""))) 170 + (defn enter [body style-seq] 171 + (defn push [st] 172 + (if (= "" style-seq) st 173 + (string style-seq ";" st))) 174 + (defn enc [st str] 175 + (def cst (push st)) 176 + (string (emit cst) 177 + (enter str cst) 178 + (emit style-seq))) 179 + (match body 180 + (str (string? str)) str 181 + [:hl str] (enc "1" str) 182 + [:em str] (enc "3" str) 183 + [:rv str] (enc "7" str) 184 + [:red str] (enc "31" str) 185 + [:span & strs] (string ;(map |(enter $ style-seq) strs)) 186 + _ (error (string/format "bad style spec %q" body)))) 187 + (enter body "")) 188 + 189 +(defn err->msg [e] 190 + (defn err-span [h & m] [:span [:hl [:red h]] ": " ;m ]) 191 + (match e 192 + {:kind :parse} (err-span "parse error" 193 + (string (e :cause) " at ") 194 + [:hl (string/format "%d:%d" (e :ln) (e :col))]) 195 + _ (error e))) 196 + # _ (err-span "error" 197 + # "something went wrong (" [:em (string e)] ")"))) 198 + 199 + 200 +(defn indent [n lst] 201 + (map |(string (string/repeat "\t" n) $) lst)) 202 + 203 +(defn fmt-docs [dox] 204 + (tuple/join ["/**"] (map |(string " * " $) dox) [" */"])) 205 + 206 +(def <obj> { 207 + :new (fn [this & args] (struct/with-proto this ;args)) 208 + :is? (fn [this obj] (and (struct? obj) 209 + (= this (struct/getproto obj)))) 210 + :impl? (fn [this obj] 211 + (and (struct? obj) 212 + (match (struct/getproto obj) 213 + nil false 214 + (@ this) true 215 + p (:impl? this p)))) 216 +}) 217 + 218 +(def <sym> 219 + (let [tcap (fn tcap[str] 220 + (def init (string/slice str 0 1)) 221 + (def rest (string/slice str 1)) 222 + (string (string/ascii-upper init) 223 + rest))] 224 + (:new <obj> 225 + :segs [] 226 + :read (fn read[this id] 227 + (if (:impl? this id) 228 + (:new this :segs (id :segs)) 229 + (:new this :segs (string/split "-" id)))) 230 + :form (fn form[me tx &opt sep] 231 + (keyword (string/join (map tx (me :segs)) 232 + (or sep "")))) 233 + :tall |(:form $ tcap) 234 + :scream |(:form $ string/ascii-upper "_") 235 + :sulk |(:form $ identity "_") 236 + :stab |(:form $ identity "-") 237 + :say (fn [me] 238 + (def s (me :segs)) 239 + (string (first s) 240 + ;(map tcap (slice s 1))))))) 241 +(def <func-c> (:new <obj> 242 + :id : 243 + :args [] 244 + :ret : 245 + :body [] 246 + :quals [] 247 + :dec* (fn [this quals ret id sig & body] 248 + (:new this 249 + :id id 250 + :ret ret 251 + :body body 252 + :quals quals 253 + :args (map (fn [[t id]] 254 + {:id id :t t}) 255 + sig))) 256 + :dec- (fn [this & dfn] (:dec* this [:static] ;dfn)) 257 + :dec (fn [this & dfn] (:dec* this [] ;dfn)) 258 + :proto (fn [me arg-ids?] 259 + (def arg->str (if arg-ids? 260 + |(string "typeof(" ($ :t) ") " ($ :id)) 261 + |(string "typeof(" ($ :t) ")"))) 262 + (defn arg-lines [args] 263 + (if (empty? args) [] 264 + (let [a @[]] 265 + (loop [arg :in args] 266 + (when (not (empty? a)) 267 + (put a (- (length a) 1) 268 + (string (last a) ","))) 269 + (array/push a (string "\t" (arg->str arg)))) 270 + (tuple (string "(" (first a)) 271 + ;(slice a 1) 272 + ")")))) 273 + [ (string (if (empty? (me :quals)) "" 274 + (string (string/join (me :quals) " ") " ")) 275 + (me :ret)) 276 + (string (me :id) (if (empty? (me :args)) "(void)" "")) 277 + ;(arg-lines (me :args)) ]) 278 + :declare* (fn [me] [ ;(:proto me false) ";" ]) 279 + :define* (fn [me] [ ;(:proto me true) "{" 280 + ;(indent 1 (me :body)) "}" ]) 281 + :declare (fn [me] 282 + (defn flag? [f] (has-value? (me :quals) f)) 283 + (cond 284 + (flag? :inline) (:define* me) 285 + (flag? :static) [] 286 + (:declare* me))) 287 + :define (fn [me] (if (has-value? (me :quals) :inline) [] 288 + (:define* me))))) 289 + 290 +(def <type-c> (:new <obj> 291 + :id (:new <sym>) 292 + :dec* (fn [this mode id & meta] (:new this 293 + :id (:read <sym> id) 294 + :mode mode 295 + ;meta)) 296 + :dec (fn [this & dfn] (:dec* this :pub ;dfn)) 297 + :dec- (fn [this & dfn] (:dec* this :priv ;dfn)) 298 + :dec@ (fn [this & dfn] (:dec* this :opaq ;dfn)) 299 + :content (fn [me] "void") 300 + :declare (fn [me] 301 + [(string "typedef " (:say (me :id)) ";")]) 302 + :define (fn [me] 303 + [(string "typedef " (:content me) " " (:say (me :id)) ";")]))) 304 + 305 +(def <struct-c> (:new <type-c> 306 + :dec* (fn [this mode id fields & meta] 307 + ((<type-c> :dec*) this mode id 308 + :fields fields 309 + ;meta)) 310 + :declare (fn [me] 311 + (let [id (:say (me :id))] 312 + [(string "typedef struct " id " " id ";")])) 313 + :define (fn [me] 314 + [(string "struct " (:say (me :id)) " {") 315 + ;(indent 1 316 + (catseq [f :in (me :fields)] 317 + (def fdesc (string/format "typeof(%s) %s;" 318 + (f :t) (:say (:read <sym> (f :id))))) 319 + (if (f :doc) (tuple/join (fmt-docs (f :doc)) 320 + [fdesc]) 321 + [fdesc]) 322 + )) 323 + "};"]))) 324 + 325 +(def <cursor> (:new <obj> 326 + :path [] 327 + :unit nil 328 + :push (fn [me what & vals] 329 + (array/push ((me :unit) what) ;vals)) 330 + :branch (fn [me id & dfn] (:new me 331 + :super me 332 + :path (tuple/join (me :path) [id]) 333 + :doc false 334 + ;dfn)) 335 + :prefix (fn [me &opt sep mode] 336 + (string/join (map (or mode :say) (me :path)) 337 + (or sep "_"))))) 338 + 339 +(defn cache [gen &opt ident] 340 + (var idx 0) 341 + (def box @{}) 342 + (fn [& argv] 343 + (def sig (if (nil? ident) argv 344 + (ident ;argv))) 345 + (if-let [val (get box sig)] val 346 + (let [new-val (gen idx ;argv)] 347 + (set idx (+ 1 idx)) 348 + (put box sig new-val) 349 + new-val)))) 350 + 351 +(defn cache/of-fn [pfx &opt inst] (cache 352 + (fn [idx & argv] # gen 353 + (def id (string/format "_priv_%s_%x" pfx idx)) 354 + (when inst (inst id ;argv)) 355 + id) 356 + (fn [sig & _] sig))) # ident 357 + 358 +(defn gdtype->vartype [t] (match t 359 + [:array _] :array 360 + [:dictionary _] :dictionary 361 + [:ref _] :object 362 + x (keyword x))) 363 +(defn gdtype->ctype [t] 364 + (match t 365 + :void :void 366 + :float :double 367 + :int :int64_t 368 + :bool :bool 369 + [:array _] :gd_array 370 + [:dictionary _] :gd_dictionary 371 + [:ref _] :GDExtensionObjectPtr 372 + 373 + # use an opaque wrapper struct defined in interface.h 374 + x (string "gd_" (:say (:read <sym> t))))) 375 + 376 +(defmacro over [acc init binds & body] 377 + (def acc (if (= acc :) (gensym) acc)) 378 + ~(do (var ,acc ,init) 379 + (loop ,binds 380 + (set ,acc (do ,;body))) 381 + ,acc)) 382 + 383 + 384 +(defn unit-files [u] 385 + (def h @[ `#pragma once` `#include "gdjn.h"` `#include "util.h"` 386 + ;(u :header-prefix)]) 387 + (def c @[ 388 + (string `#include "` (:stab (u :name)) `.h"`) 389 + `typedef struct gdjn_vcall {` 390 + ` GDExtensionClassMethodPtrCall caller; ` 391 + ` void* tgt;` 392 + `} gdjn_vcall;` 393 + ;(u :impl-prefix) 394 + ]) 395 + 396 + (defn print-docs [dest obj] 397 + (when-let [dox (get (u :doc) obj)] 398 + (array/concat dest (fmt-docs dox)))) 399 + (each t (u :types) 400 + (def [f-dec f-def f-doc] 401 + (case (t :mode) 402 + :pub [h h h] 403 + :priv [c c c] 404 + :opaq [h c c])) 405 + (print-docs f-doc t) 406 + (array/concat f-dec (:declare t)) 407 + (array/concat f-def (:define t))) 408 + 409 + # forward-declare private funcs 410 + (each func (u :funcs) 411 + (when (has-value? (func :quals) :static) 412 + (array/join c (:declare* func)))) 413 + 414 + (each v (u :vars) 415 + (when (not (v :priv)) 416 + (print-docs h v) 417 + (array/push h (string/format "extern typeof(%s) %s;" 418 + (v :t) (v :id)))) 419 + (def init (let [val (v :v)] (cond 420 + ( nil? val) "" 421 + ( keyword? val) (string " = " val) 422 + ( string? val) (string/format ` = %q` val) 423 + (function? val) (string " = " (val)) ))) 424 + 425 + (when (v :priv) (print-docs c v)) 426 + (array/push c (string/format "%stypeof(%s) %s%s;" 427 + (if (v :priv) "static " "") 428 + (v :t) (v :id) init))) 429 + 430 + (defn func-push [func] 431 + (array/join h (:declare func)) 432 + (array/join c (:define func))) 433 + 434 + (each func (u :funcs) 435 + (print-docs (if (func :priv) c h) func) 436 + (func-push func)) 437 + 438 + (let [fname (string "gdjn_unit_" (:say (u :name)) "_load")] 439 + (func-push (:dec <func-c> :void fname [] 440 + ;(indent 0 (u :load))))) 441 + {:header h :impl c}) 442 + 443 +(defn with-names [kv & body] 444 + (def [start end] [@[] @[]]) 445 + (loop [[k v] :pairs (struct ;kv)] 446 + (def v-rep (cond (keyword? v) (string v) 447 + (string/format "%q" v))) 448 + (array/push start 449 + (string "gd_stringName " k ";") 450 + (string/format "_t(stringName).newWithUtf8Chars(&%s, %s);" 451 + k v-rep)) 452 + (array/push end 453 + (string/format "_t(stringName).dtor(&%s);" k))) 454 + (tuple/join ["{"] 455 + (indent 1 start) 456 + body 457 + (indent 1 (reverse end)) 458 + ["}"])) 459 + 460 +(defn variant-type-enum [sym] 461 + (def s (cond (:is? <sym> sym) sym 462 + (or (keyword? sym) 463 + (string? sym)) (:read <sym> sym) 464 + (:read <sym> (gdtype->vartype sym)))) 465 + (when (= :variant (:stab s)) 466 + (error "value is already a variant")) 467 + (string "GDEXTENSION_VARIANT_TYPE_" 468 + (:scream s))) 469 + 470 +(defn func-ptr-t [ret args] 471 + (defn wt [t] 472 + (string "typeof(" t ")")) 473 + (string/format "typeof(%s (*)(%s))" 474 + (wt ret) 475 + (if (empty? args) "void" 476 + (string/join (map wt args) ", ")))) 477 +(defn lines->str [lines] 478 + (string (string/join lines "\n") "\n")) 479 + 480 +(defn basename [p] 481 + (last (string/split "/" p))) 482 +(defn entry [_ inp emit] 483 + (def ast (with [fd (file/open inp :r)] 484 + (with-dyns [*src-file* inp] 485 + (parse-class (:read fd :all))))) 486 + 487 + (def unit 488 + (let [unit-funcs @[] 489 + unit-vars @[] 490 + unit-load @[] ] 491 + (defn unit-variant-inst [kind] 492 + (when (= kind :variant) 493 + (error "cannot rewrap a variant")) 494 + (def modes 495 + {:cast {:call "cast" 496 + :type "GDExtensionTypeFromVariantConstructorFunc"} 497 + :wrap {:call "wrap" 498 + :type "GDExtensionVariantFromTypeConstructorFunc"}}) 499 + (def mode (in modes kind)) 500 + (fn [id ty] 501 + (def ty-sym (:read <sym> (gdtype->vartype ty))) 502 + (def ty-enum (variant-type-enum ty-sym)) 503 + (array/push unit-vars 504 + {:id id :priv true :v :nullptr 505 + :t (mode :type)}) 506 + (array/push unit-load 507 + (string/format `%s = gdjn_ctx -> gd.%s(%s);` 508 + id (mode :call) ty-enum)))) 509 + 510 + (def unit-variant-wrap 511 + (cache/of-fn "variant_wrap" (unit-variant-inst :wrap))) 512 + (def unit-variant-cast 513 + (cache/of-fn "variant_cast" (unit-variant-inst :cast))) 514 + 515 + 516 + (defn unit-invocant-ptr-inst [id [t-ret t-args]] 517 + (def invoke-args '[ 518 + # in 519 + [void* target] 520 + [GDExtensionClassInstancePtr inst] 521 + ["const GDExtensionConstTypePtr*" argv] 522 + # out 523 + [GDExtensionTypePtr ret]]) 524 + (def args* 525 + (seq [i :range [0 (length t-args)] 526 + :let [a (t-args i) ]] 527 + (string/format "*((%s*)argv[%d])" (gdtype->ctype a) i))) 528 + (def fn-t (func-ptr-t (gdtype->ctype t-ret) 529 + [:void* ;(map gdtype->ctype t-args)])) 530 + (def arg-str (string/join ["inst" ;args*] ", ")) 531 + (def invoke [ 532 + (string "typedef " fn-t " ptrCallFn;") 533 + (string "ptrCallFn func = target;") 534 + (string (if (= :void t-ret) "" 535 + "auto rv = ") "func(" arg-str ");") 536 + ;(if (= :void t-ret) [] [ 537 + "* (typeof(rv)*) ret = rv;"])]) 538 + (array/push unit-funcs 539 + (:dec- <func-c> :void id invoke-args 540 + ;invoke))) 541 + (defn unit-invocant-inst [id [t-ret t-args]] 542 + (def invoke-args '[ 543 + # in 544 + [void* target] 545 + [GDExtensionClassInstancePtr inst] 546 + ["const GDExtensionConstVariantPtr*" argv] 547 + [GDExtensionInt argc] 548 + # out 549 + [GDExtensionVariantPtr ret] 550 + [GDExtensionCallError* err]]) 551 + 552 + (defn call-err [kind & params] 553 + (let [kind-sym (:read <sym> kind) 554 + enum (string "GDEXTENSION_CALL_ERROR_" 555 + (:scream kind-sym)) 556 + p (struct ;params)] 557 + [(string `err -> error = ` enum `;`) 558 + ;(map (fn[[k v]] 559 + (string `err -> ` k ` = ` v `;`)) 560 + (pairs p)) 561 + `return;`])) 562 + 563 + (defn arity-enforce [m &opt x] 564 + [(string/format `if (argc < %d) {` m) 565 + ;(indent 1 (call-err :too-few-arguments :expected m)) 566 + (string/format `} else if (argc > %d) {` (or x m)) 567 + ;(indent 1 (call-err :too-many-arguments :expected (or x m))) 568 + `}`]) 569 + (defn unwrap-type [n] 570 + (def var-t (gdtype->vartype (t-args n))) 571 + (def tsym (:read <sym> var-t)) 572 + (def tenum (variant-type-enum tsym)) 573 + (def unwrap (unit-variant-cast var-t)) 574 + [(string/format 575 + `if (_t(variant).getType(argv[%d]) != %s) {` 576 + n tenum) 577 + ;(indent 1 (call-err :invalid-argument 578 + :expected tenum 579 + :argument n)) 580 + `}` 581 + (string (gdtype->ctype (t-args n)) 582 + " arg_" n ";") 583 + 584 + (string/format "%s(&arg_%d, (void*)argv[%d]);" unwrap n n) 585 + ]) 586 + 587 + (def invoke 588 + (let [tx (fn (t) 589 + (string "typeof(" (gdtype->ctype t) ")")) 590 + wrapper (cond (= t-ret :void) nil 591 + (= t-ret :variant) nil 592 + (unit-variant-wrap t-ret))] 593 + [(string/format "typedef %s wrappedFunc;" 594 + (func-ptr-t (gdtype->ctype t-ret) [:void* 595 + ;(map gdtype->ctype t-args)])) 596 + (string/format "%s((wrappedFunc)target)(%s);" 597 + (if (= t-ret :void) "" 598 + (string (tx t-ret) " result = ")) 599 + (string/join ["inst" 600 + ;(seq [i :range [0 (length t-args)]] 601 + (string "arg_" i))] 602 + ", ")) 603 + (cond (= t-ret :variant) "*(gd_variant*)ret = result;" 604 + wrapper (string wrapper "(ret, &result);") 605 + "") 606 + ])) 607 + (array/push unit-funcs 608 + (:dec- <func-c> :void id invoke-args 609 + ;(arity-enforce (length t-args)) 610 + ;(tuple/join ;(map |(unwrap-type $) 611 + (range (length t-args)))) 612 + ;invoke))) 613 + (def unit-invocants (cache/of-fn "invoke" unit-invocant-inst)) 614 + (def unit-invocants-ptr (cache/of-fn "invoke_ptr" 615 + unit-invocant-ptr-inst)) 616 + 617 + {:name (:read <sym> (first (string/split "." (basename inp)))) 618 + :vars unit-vars 619 + :funcs unit-funcs 620 + :load unit-load 621 + :header-prefix @[] 622 + :impl-prefix @[] 623 + :variant-wrap unit-variant-wrap 624 + :variant-cast unit-variant-cast 625 + :invocants unit-invocants 626 + :invocants-ptr unit-invocants-ptr 627 + :classes @[] 628 + :methods @[] 629 + :types @[] 630 + :doc @{}})) 631 + 632 + 633 + (defn process [n csr] 634 + (match n 635 + [[:doc & lines] & node] 636 + (let [doc-csr (:new csr :doc lines)] 637 + (process node doc-csr)) 638 + 639 + ([cl id imode base body] (or (= cl :class) (= cl :iface))) 640 + (let [class-def {:id id 641 + :base base 642 + :cursor csr 643 + :events @{} 644 + :fields @[] 645 + :methods @[] 646 + :vtbl-map @{} 647 + :impls @[] 648 + :base-mode imode 649 + :abstract (= cl :iface)} 650 + id-sym (:read <sym> id) 651 + base-sym (:read <sym> base) 652 + subcsr (:branch csr id-sym 653 + :class class-def)] 654 + (array/push (unit :classes) class-def) 655 + (each n body (process n subcsr))) 656 + ([:var t-c t-gd id] (has-key? csr :class)) 657 + (array/push (get-in csr [:class :fields]) 658 + {:id id :cursor csr 659 + :t-gd t-gd 660 + :t-c (match t-c 661 + :auto (gdtype->ctype t-gd) 662 + t t)}) 663 + [:var t-c t-gd id] (do 664 + (assert (= t-gd :priv) 665 + "static globals cannot currently be exposed to godot") 666 + (array/push (unit :vars) 667 + {:id (string "gdjn_unit_" (:say (unit :name)) 668 + "_" (:prefix csr) id) 669 + :cursor csr 670 + :v (keyword "{}") 671 + :t (match t-c 672 + :auto (gdtype->ctype t-gd) 673 + t t)})) 674 + [:import mode & what] 675 + (array/push (case mode 676 + :head (unit :header-prefix) 677 + :impl (unit :impl-prefix)) 678 + (match what 679 + [:loc header] (string `#include "` header `"`) 680 + [:sys header] (string `#include <` header `>`) 681 + [:lit body] body)) 682 + [:event ev c] 683 + (do (assert (csr :class) 684 + (string "event " ev " defined outside of class")) 685 + (put-in csr [:class :events ev] 686 + {:cursor csr 687 + :text c})) 688 + [:func kind id argv [rty & meta] c] 689 + (let [cls (csr :class) 690 + meth {:id id 691 + :args (map (fn [[t id & r]] 692 + [t 693 + (keyword id) ;r]) argv) 694 + :ret rty 695 + :ret-doc (match (first meta) 696 + [:doc & d] d) 697 + :cursor csr 698 + :text c}] 699 + (array/push (unit :methods) meth) 700 + (when cls (case kind 701 + :method (array/push (cls :methods) meth) 702 + :impl (array/push (cls :impls) meth))) 703 + ))) 704 + 705 + (def root (:new <cursor> :unit unit)) 706 + (each n ast (process n root)) 707 + 708 + (defn class-prefix [c & r] 709 + (def pf (let [p (:prefix c)] 710 + (if (empty? p) [] [p]))) 711 + (string/join ["gdjn_class" ;pf ;r] "_")) 712 + 713 + (defn bind-methods [class] 714 + (defn bind [f kind] 715 + (def t-args (map (fn [[t] &] t) 716 + (f :args))) 717 + (def invocant 718 + ((unit :invocants) [(f :ret) t-args])) 719 + (def invocant-ptr 720 + ((unit :invocants-ptr) [(f :ret) t-args])) 721 + (def fp-t (func-ptr-t (gdtype->ctype (f :ret)) 722 + [(string "typeof(" 723 + (class-prefix (class :cursor) 724 + (class :id))")*") 725 + ;(map gdtype->ctype t-args)])) 726 + 727 + (def strings-lst @[]) 728 + (def strings 729 + (cache (fn [idx text] 730 + (def id (string "_priv_str_" idx)) 731 + (array/push strings-lst id text) 732 + id))) 733 + (defn prop-info [t &opt id] [ 734 + "(GDExtensionPropertyInfo) {" ;(indent 1 [ 735 + (if (= :variant t) "" 736 + (string ".type = " (variant-type-enum t) ",")) 737 + (string ".name = &" (strings (if (nil? id) "" 738 + (string id))) ",") 739 + (string ".class_name = &" (strings (match t 740 + [:ref c] (string (:tall (:read <sym> c))) 741 + _ "")) ",") 742 + (string ".hint_string = &" (strings "") ",") 743 + `.usage = 6,` # DEFAULT 744 + ]) "}" 745 + ]) 746 + (def arg-info (if (empty? t-args) [] [ 747 + (string "." (case kind 748 + :method "arguments_info" 749 + :impl "arguments") 750 + "= (GDExtensionPropertyInfo[]) {") 751 + ;(indent 1 (mapcat (fn [[t id]] [;(prop-info t id) ","]) (f :args))) 752 + "}," 753 + ".arguments_metadata = (GDExtensionClassMethodArgumentMetadata[]) {" 754 + ;(seq [i :range [0 (length (f :args))]] 755 + "\tGDEXTENSION_METHOD_ARGUMENT_METADATA_NONE,") 756 + "}," 757 + ])) 758 + (def ret-info 759 + (indent 1 [`.return_value_metadata = GDEXTENSION_METHOD_ARGUMENT_METADATA_NONE,` 760 + ;(case kind 761 + :method (if (= :void (f :ret)) [] 762 + [`.return_value_info = &` 763 + ;(prop-info (f :ret)) 764 + `,`]) 765 + :impl [`.return_value = ` 766 + ;(prop-info (if (= :void (f :ret)) :nil 767 + (f :ret)))] 768 + )]) 769 + ) 770 + 771 + (def fn-path (class-prefix (f :cursor) "method" (f :id))) 772 + (with-names [:s_methodName (f :id) ;strings-lst] 773 + (if (not= kind :method) "" 774 + (string fp-t " func = " fn-path ";")) 775 + (string/format `auto info = (%s) {` 776 + (case kind 777 + :method "GDExtensionClassMethodInfo" 778 + :impl "GDExtensionClassVirtualMethodInfo")) 779 + ` .name = &s_methodName,` 780 + (string "\t.argument_count = " 781 + (length t-args) ",") 782 + ;(indent 1 arg-info) 783 + ;(if (= kind :method) [ 784 + ` .method_userdata = func,` 785 + ` .method_flags = GDEXTENSION_METHOD_FLAGS_DEFAULT,` 786 + (string "\t.has_return_value = " 787 + (if (= :void (f :ret)) "false" "true") ",") 788 + (string "\t.call_func = " invocant ",") 789 + (string "\t.ptrcall_func = " invocant-ptr ",") 790 + ] []) 791 + ;ret-info 792 + `};` 793 + (string `printf("binding method %s\n",` 794 + (string/format "%q" fn-path) 795 + `);`) 796 + (string `_t(classdb).` 797 + (case kind 798 + :method "registerExtensionClassMethod" 799 + :impl "registerExtensionClassVirtualMethod") 800 + `(gdjn_ctx -> gd.lib, &s_className, &info);`))) 801 + (array/concat @[] "{" ;(with-names [:s_className (class :id)] 802 + ;(map |(bind $ :method) (class :methods)) 803 + ;(map |(bind $ :impl) (class :impls))) "}")) 804 + 805 + (defn push-item [kind cursor item] # abuse hashtables for fun & profit 806 + (array/push (unit kind) item) 807 + (when (and cursor (cursor :doc)) 808 + (put (unit :doc) item (cursor :doc)))) 809 + 810 + (loop [c :in (unit :classes)] 811 + (def id (class-prefix (c :cursor) (c :id))) 812 + (def [id-ctor id-dtor 813 + id-ctor-api 814 + id-init id-create] 815 + (map |(string id "_" $) ["new" "del" 816 + "api_new" "init" "create"])) 817 + 818 + (def id-base (as-> (c :base) b 819 + (string/split "." b) 820 + (string/join b "_") 821 + (string "gdjn_class_" b))) #HAAACK 822 + (when (not (empty? (c :impls))) 823 + (def vtbl @[]) 824 + (loop [i :range [0 (length (c :impls))] 825 + :let [f ((c :impls) i)]] 826 + (def t-args (map (fn [[t] &] t) 827 + (f :args))) 828 + (def call (class-prefix (f :cursor) "method" (f :id))) 829 + (def caller ((unit :invocants-ptr) [(f :ret) t-args])) 830 + (put (c :vtbl-map) (f :id) i) 831 + (array/push vtbl 832 + (string "{.caller=" caller ", .tgt=" call "}")) 833 + ) 834 + (let [vstr (string/join (map |(string "\n\t" $ ",") vtbl)) 835 + vwr (string "{" vstr "\n}") ] 836 + (array/push (unit :vars) 837 + {:id (string id "_vtbl") 838 + :priv true 839 + :t "const gdjn_vcall[]" 840 + :v |vwr}))) 841 + 842 + (defn push-event [ev-kind ev-id ret-t args gen] 843 + (push-item :funcs (get-in c [:events ev-kind :cursor]) 844 + (:dec <func-c> ret-t ev-id 845 + args 846 + ;(gen (if c ["{" (get-in c [:events ev-kind :text] "") "}"] []))))) 847 + (array/push (unit :funcs) 848 + (:dec <func-c> :GDExtensionObjectPtr id-ctor-api 849 + [[:void* :_data] 850 + [:GDExtensionBool :postInit]] 851 + (string/format "return %s() -> self;" id-ctor))) 852 + (def self-ref-t (string "typeof(" id ")*")) 853 + (push-event :ctor id-init :void [[self-ref-t :me] 854 + [:GDExtensionObjectPtr :obj]] 855 + |[(string/format "me -> self = obj;") 856 + ;(if (= :native (c :base-mode)) [] 857 + [(string id-base "_init(&me -> super, obj);")]) 858 + ;$]) 859 + (array/push (unit :funcs) 860 + (:dec <func-c> :GDExtensionObjectPtr id-create [] 861 + "GDExtensionObjectPtr super;" 862 + ;(if (= :native (c :base-mode)) 863 + (with-names ["superName" (c :base)] 864 + "super = _t(classdb).constructObject(&superName);") 865 + [(string/format "super = %s_create();" 866 + id-base)]) 867 + "return super;")) 868 + 869 + (array/push (unit :funcs) 870 + (:dec <func-c> self-ref-t id-ctor [] 871 + (string "typeof("id")* me = _alloc("id", 1);") 872 + ;(with-names ["className" (c :id)] 873 + (string/format "auto gdobj = %s();" 874 + id-create) 875 + `printf("constructed super object %p\n", gdobj);` 876 + "_t(object).setInstance(gdobj, &className, me);" 877 + (string id-init "(me, gdobj);")) 878 + "return me;")) 879 + (push-event :dtor id-dtor :void 880 + [[:void* :_data] 881 + [:GDExtensionClassInstancePtr :_ptr_me]] 882 + |[(string "typeof("id")* me = _ptr_me;") 883 + ;$ 884 + "_free(me);"]) 885 + (def id-virt (class-prefix (c :cursor) (c :id) "virt")) 886 + 887 + (array/push (unit :funcs) (:dec- <func-c> :void* id-virt 888 + [[:void* :data] 889 + [:GDExtensionConstStringNamePtr :method] 890 + [:uint32_t :hash]] 891 + `bool res = false;` 892 + ;(catseq [[name idx] :pairs (c :vtbl-map)] [ 893 + ;(with-names [:name name] 894 + `_t(stringName).equal(&name, method, &res);` 895 + `if (res) {` 896 + (string "\treturn (void*)&" id "_vtbl[" idx "];") 897 + `}`)]) 898 + ;(if (= :native (c :base-mode)) [`return nullptr;`] 899 + # inherits from a gdextension class; call up 900 + [(string/format "return %s_virt(data, method, hash);" 901 + id-base)]) 902 + )) 903 + (def id-virt-call (class-prefix (c :cursor) (c :id) "virt_call")) 904 + (array/push (unit :funcs) (:dec- <func-c> :void id-virt-call 905 + [[:GDExtensionClassInstancePtr :inst] 906 + [:GDExtensionConstStringNamePtr :method] 907 + [:void* :vcall] 908 + ["const GDExtensionConstTypePtr*" :args] 909 + [:GDExtensionTypePtr :ret]] 910 + `auto c = (const gdjn_vcall*)vcall;` 911 + `c -> caller(c -> tgt, inst, args, ret);`)) 912 + (array/push (unit :load) 913 + ;(with-names ["className" (c :id) 914 + "superName" (c :base)] 915 + "auto classDesc = (GDExtensionClassCreationInfo4) {" 916 + ` .is_virtual = false,` 917 + (string "\t.is_abstract = " (if (c :abstract) "true" "false")",") 918 + ` .is_exposed = true,` 919 + ` .is_runtime = true,` 920 + (string "\t.create_instance_func = " id-ctor-api ",") 921 + (string "\t.free_instance_func = " id-dtor ",") 922 + (string "\t.get_virtual_call_data_func = " 923 + id-virt ",") 924 + (string "\t.call_virtual_with_data_func = " 925 + id-virt-call ",") 926 + "};" 927 + `_t(classdb).registerExtensionClass(gdjn_ctx -> gd.lib, &className, &superName, &classDesc);` 928 + )) 929 + (def fields 930 + (tuple/join (if (= :native (c :base-mode)) [] 931 + [{:id "super" 932 + :t id-base}]) 933 + [{:id "self" :t :GDExtensionObjectPtr}] 934 + (seq [f :in (c :fields)] 935 + {:id (f :id) 936 + :t (f :t-c) :v {} 937 + :doc (get-in f [:cursor :doc] nil)}))) 938 + (push-item :types (c :cursor) 939 + (:dec <struct-c> id 940 + fields)) 941 + (def binder (bind-methods c)) 942 + (array/concat (unit :load) binder) 943 + 944 + 945 + 946 + ) 947 + (loop [f :in (unit :methods)] 948 + (def class (class-prefix (f :cursor))) 949 + (def cid (class-prefix (f :cursor) "method" (f :id))) 950 + (def cfn (:dec <func-c> (gdtype->ctype (f :ret)) cid 951 + [ [(string class "*") "me"] 952 + ;(map (fn [[t id dox]] 953 + [(gdtype->ctype t) id]) 954 + (f :args))] 955 + (f :text))) 956 + (def arg-dox 957 + (mapcat (fn [[t id & meta]] 958 + (match (first meta) 959 + ([:doc & dox] (not (empty? dox))) 960 + (do (def pfx (string "@param " id " ")) 961 + (def pad (string/repeat " " (length pfx))) 962 + [(string pfx (first dox)) 963 + ;(map |(string pad $) (slice dox 1))]) 964 + _ [])) 965 + (f :args))) 966 + (let [func-dox (if-let [x (get-in f [:cursor :doc])] 967 + (tuple/join x [""]) 968 + []) 969 + ret-dox (if-let [x (f :ret-doc)] 970 + [(string "@return " (first x)) 971 + ;(if (= (length x) 1) [] 972 + (map |(string " " $) (slice x 1)))] 973 + []) 974 + curs (if (empty? arg-dox) (f :cursor) 975 + (:new (f :cursor) 976 + :doc (tuple/join func-dox 977 + arg-dox 978 + ret-dox)))] 979 + (push-item :funcs curs cfn)) 980 + ) 981 + 982 + (let [uf (unit-files unit)] 983 + (:write stdout (case emit 984 + "header" (lines->str (uf :header)) 985 + "loader" (lines->str (uf :impl)) 986 + (error :bad-cmd))))) 987 + 988 +(defn main [& argv] 989 + # (entry ;argv)) 990 + (try (entry ;argv) 991 + ([e] (:write stderr (style ;(err->msg e))))))
Added tool/rsrc.janet version [5689af4629].
1 +# [ʞ] rsrc.janet 2 +# ~ lexi hale <lexi@hale.su> 3 +# ? the usual bullshit 4 +# > CC=cc gd_build_out=out gd_build_gen=gen 5 +# janet rsrc.janet -- <file> <file>... 6 + 7 +(def *cc* (gensym)) 8 +(def *out-path* (gensym)) 9 +(def *gen-path* (gensym)) 10 + 11 +(defn blob->c-array [data] 12 + (def bytes (string/bytes data)) 13 + (def buf @"") 14 + (defn nl [] (buffer/push buf "\n")) 15 + 16 + (loop [i :range [0 (length bytes)] 17 + :let [col (mod i 20) 18 + val (data i)] 19 + :after (when (= col 0) (nl))] 20 + (buffer/push buf (string/format "%d," val))) 21 + 22 + (string buf)) 23 + 24 +(defn basename [f] (array/peek (string/split "/" f))) 25 + 26 +(defn blob [path] 27 + (print "doing path " path) 28 + (let [fd (file/open path :r) 29 + rec {:id (reduce |(string/replace-all $1 "_" $0) 30 + (basename path) ["-" "." "/"]) 31 + :vals (blob->c-array (:read fd :all))}] 32 + (:close fd) 33 + rec)) 34 + 35 +(defn c-decl [t] 36 + (string "const uint8_t gdjn_rsrc_" (t :id) " []")) 37 +(defn c-def [t] 38 + (string (c-decl t) " = {" (t :vals) "}")) 39 + 40 + 41 +(defn c-compile [c to-path] 42 + (def cc (os/spawn [(dyn *cc*) 43 + "-xc" "-c" "-" 44 + "-o" to-path] 45 + :p {:in :pipe})) 46 + (ev/gather (do (:write (cc :in) 47 + "#include <stdint.h>\n") 48 + (ev/write (cc :in) c) 49 + (ev/close (cc :in))) 50 + (os/proc-wait cc))) 51 + 52 +(defn build [paths] 53 + (let [ lst (map blob (slice paths 2 -1)) 54 + decl (map |(string (c-decl $) ";\n") lst) 55 + impl (map |(string (c-def $) ";\n") lst) 56 + obj-path (string/format "%s/rsrc.o" (dyn *out-path*)) 57 + decl-path (string/format "%s/rsrc.h" (dyn *gen-path*)) 58 + decl-fd (file/open decl-path :w)] 59 + (:write decl-fd 60 + "#pragma once\n" 61 + "#include <stdint.h>\n") 62 + (each d decl (:write decl-fd d)) 63 + (each i impl (c-compile i obj-path)) 64 + (:close decl-fd))) 65 + 66 +(defn env: [k dflt] 67 + (or (get (os/environ) k) dflt)) 68 + 69 +(defn main [& argv] 70 + (with-dyns [ *cc* (env: "CC" "cc" ) 71 + *out-path* (env: "gd_build_out" "out") 72 + *gen-path* (env: "gd_build_gen" "gen")] 73 + (build argv)) 74 + 0)