Hash :
38da0a8b
Author :
Thomas de Grivel
Date :
2025-09-20T19:53:03
readme
KC3 is a programming language with meta-programmation and a graph database embedded into the language. It aims to be the language for semantic programming, and programming the semantic web.
You can easily convert each KC3 function to a C function. KC3 is both a language and a runtime.
This is a development branch, for the latest release see KC3 v0.1.15.
KC3 is currently a programming language project, inspired by C, Elixir and Common Lisp. It could be described as C with Elixir modules, pattern matching, and a semantic object system. The idea is to plug modules, closures, pattern matching, a graph database and metaprogramming into C99 with an extremely small set of dependencies.
Components :
libkc3 library is a full KC3 parser and interpreter. ikc3 is the interactive interpreter (verbose). kc3s is the script interpreter (same as ikc3 but terse). lib/kc3/0.1
using the make lib_links command. kc3_httpd. All binaries can be compiled for four targets :
assert is disabled. assert is enabled Supported operating systems (additional dependencies) :
Supported architectures :
To install and test KC3 for yourself, you can follow the KC3 Installation Guide.
There are now four full applications written in KC3 that we know of :
make demo make demo_gl make test_httpd with all the KC3 releases and
documentation. libkc3
(Facts*) → p_facts securelevel(0) > 0 env_eval_callable cfn_eval cfn_link cfn_prep_cif buf_parse_pcallable buf_parse_cfn securelevel(0) > 0 kc3_system kc3_system_pipe_exec securelevel(0) > 0 securelevel(0) > 0 securelevel(0) > 1 securelevel(0) > 1 securelevel(0) > 1 securelevel(0) > 1 securelevel(0) > 1 securelevel(0) > 1 securelevel(0) > 1 securelevel(0) > 2 ikc3
RPC.request("input") %RPC.Response{out: "plop\n",
err: "warning: message\n",
result: (Sw) 5}
build system
runj as a git submodule to parallelize configure
and update_sources sort as a git submodule to have a portable sort
algorithm that gives consistent results across Linux and BSD. test infrastructure
runj to call test_runner in parallel sleep 2 that slowed each ikc3 test Join us on kmx.io Discord server !
Follow the KC3 guides to discover how to use KC3 for your own projects.
(Macro) fn (x) { x } \n) (TAG_VOID: 1, TAG_TUPLE: (1+ (max (height tuple->tags))))
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
# KC3 v0.1.16-git
KC3 is a programming language with meta-programmation and a graph
database embedded into the language. It aims to be the language
for semantic programming, and programming the semantic web.
You can easily convert each KC3 function to a C function. KC3 is both
a language and a runtime.
This is a development branch, for the latest release see
[KC3 v0.1.15](https://git.kmx.io/kc3-lang/kc3/_tree/v0.1.15).
KC3 is currently a programming language project, inspired by C, Elixir
and Common Lisp. It could be described as C with Elixir modules,
pattern matching, and a semantic object system. The idea is to plug
modules, closures, pattern matching, a graph database and
metaprogramming into C99 with an extremely small set of dependencies.
Components :
- The pure C11 `libkc3` library is a full KC3 parser and interpreter.
- `ikc3` is the interactive interpreter (verbose).
- `kc3s` is the script interpreter (same as ikc3 but terse).
- There are several C libraries which are installed in `lib/kc3/0.1`
using the `make lib_links` command.
- There is a web server in httpd : `kc3_httpd`.
All binaries can be compiled for four targets :
- __main__ : speed optimizations from GCC/Clang -O2 and
debug code like `assert` is disabled.
- __debug__ : no optimization and debug code like `assert` is enabled
- __cov__ : code coverage instrumentation
- __asan__ : memory safety instrumentation with ASan, an absolutely
awesome tool to detect all memory leaks, double free, segmentation
faults, invalid read, invalid write, general memory corruption
errors, etc., just run the __asan__ target for a full report at
process exit, the report being empty if all is ok.
Supported operating systems (additional dependencies) :
- BSD
- Linux (libbsd, libmd)
- MacOS X (libmd)
- Windows (MSys2) (no network)
Supported architectures :
- aarch64 (arm64, Apple M1, Apple M2)
- amd64
- i386
- sparc64
To install and test KC3 for yourself, you can follow the
[KC3 Installation Guide](https://kc3-lang.org/doc/3_Guides/3.1_Install).
## Users
There are now four full applications written in KC3 that we know of :
- The KC3 Cairo demo which you can run with `make demo`
- The KC3 SDL2 OpenGL demo which you can run with `make demo_gl`
- The [KC3 website](https://kc3-lang.org/) which you can launch
locally with `make test_httpd` with all the KC3 releases and
documentation.
- The [www.kmx.io website](https://www.kmx.io/) which is closed
source and is hosted on kmx.io servers in France using OpenBSD
everywhere. We donate to OpenBSD every month because a healthy
software ecosystem is a funded ecosystem.
## New in this release
- libkc3
- dlopen inside lib/ only
- Typed pointer example : `(Facts*)` → `p_facts`
- securelevel between 0 and 3
- API that can only increase securelevel between 0 and 2
- 0 = (cfn + system + dlopen + dlsym) + (eval + def*)
- 1 = def* + eval
- block all Cfn definition if `securelevel(0) > 0`
- `env_eval_callable`
- `cfn_eval`
- `cfn_link`
- `cfn_prep_cif`
- `buf_parse_pcallable`
- `buf_parse_cfn`
- block system() calls if `securelevel(0) > 0`
- `kc3_system`
- `kc3_system_pipe_exec`
- block dlopen() calls if `securelevel(0) > 0`
- kc3_dlopen
- env_dlopen
- block dlsym() calls if `securelevel(0) > 0`
- only ever called by cfn_apply which is already blocked at
securelevel > 0
- 2 = eval
- block buf_parse_fn if `securelevel(0) > 1`
- block buf_parse_pcallable if `securelevel(0) > 1`
- block env_eval_callable if `securelevel(0) > 1`
- block all env_def* if `securelevel(0) > 1`
- block all kc3_def* if `securelevel(0) > 1`
- block all facts_add* on global env facts
if `securelevel(0) > 1`
- block all facts_remove* on global env facts
if `securelevel(0) > 1`
- 3 = ø (no KC3 eval, C-mode only)
- [ ] block all env_eval_* if `securelevel(0) > 2`
- ikc3
- Remote procedure call
- client : ikc3 --client HOST PORT
- opens a prompt on stdin and forwards parsed tags to server
using `RPC.request("input")`
- reads structured response from server :
```elixir
%RPC.Response{out: "plop\n",
err: "warning: message\n",
result: (Sw) 5}
```
- server : ikc3 --server HOST PORT
- accepts only one connection and exits
- works with netcat (no prompt)
- build system
- use shipped `runj` as a git submodule to parallelize configure
and update_sources
- use shipped `sort` as a git submodule to have a portable sort
algorithm that gives consistent results across Linux and BSD.
- test infrastructure
- modular test infrastructure with test/test.subr and
test/test_runner
- use shipped `runj` to call test_runner in parallel
- removed ugly `sleep 2` that slowed each ikc3 test
- all tests suites run in under 30 seconds now compared to
more than 5 minutes before
## Discord invite
[Join us on kmx.io Discord server !](https://discord.gg/A4MWkpUDsG)
## [Guides](https://kc3-lang.org/doc/3_Guides)
Follow the [KC3 guides](https://kc3-lang.org/doc/3_Guides)
to discover how to use KC3 for your own projects.
## TODO
- libkc3
- env_init: find lib dir for /usr/local/lib/kc3/0.1/
- HTTPd
- OAuth2 / jwt
- dynamic router
- def_route(:get, "/user/:id/articles/*slug/edit", UserArticlesController.edit)
- tls
- fx
- chaining of audio and video previews (folder as a playlist)
- tags
- create
- POST "/tag/:tag/*path"
- delete
- DELETE "/tag/:tag/*path"
- recursive
- properties
- recursive
- libkc3
- hash-table as a KC3 value (map ?)
- special operators hash table
- pass by reference and reference counting in all data structures
- array
- cow
- frame
- list
- map
- base-specific big floats
- macro cast : `(Macro) fn (x) { x }`
- pretty printer
- 80 columns (`\n`)
- tags
- generic walker
- height function `(TAG_VOID: 1, TAG_TUPLE: (1+ (max (height tuple->tags))))`
- has_ident
- collect_idents
- facts
- negative facts : 4 + 2n = not 3 + 2n
- with ignore variables
- math
- arbitrary precision floating point numbers (decimals)
- enums
- unions
- errors (setjmp, longjmp)
- ffi ?
- libdwarf
- control structures
- when
- unless
- switch/case/cond
- livebook
- gaussian
- buf_sha256
- buf_popen
- tests