A statically typed lisp, without a GC, for real-time applications.
Go to file
Scott Olsen d3f8d83c77
feat: add macros for emitting C compiler directives (#1182)
* feat: Add support for emitting literal C

This commit adds a new Obj type, C, as well as a command for emitting C
literals (which are represented by this object).

This is necessary for circumstances in which Carp's handling of
templates and emission orders prevents interop with C. For example, the
c11 macro static_assert must only take a string literal in its second
position. However, Carp's memory management will typically assign a
string literal (in Carp) to an anonymous variable, which makes them
impossible to use with static_assert. The new emit-c command will
support this use case:

```
(static-assert 0 (Unsafe.emit-c "\"message!\""))
```

The literal string "message!" will be emitted in the compiler's C output
in the position corresponding to the macro call.

We also add a special type for c literals, CTy, to prevent conflating
them with Strings. This helps maintainers define clear boundaries and
express what interop code requires the use of literal C.

Likewise, we need to emit `c_code` to represent this type in C. This
wouldn't be necessary except that Carp sometimes auto-generates
functions that refer to Carp types in their C equivalents, so we need
this for completeness. It is typed as the void pointer.

N.B. That the command is not yet exposed in Carp in this commit.

Thanks to @TimDeve for recommending the name emit-c!

* feat: Add preproc command and add emit-c to Unsafe module

This commit adds the preproc command, which enables users to emit
arbitrary C in the compilers emitted C output.

The C emitted by calls to preproc will be appended to the output after
include directives but prior to any other emissions. One can use it to
call preprocessor directives in C, define helper functions etc.

preproc takes a C type value as an argument and must be used in
conjunction with emit-c. Both functions are added to the Unsafe module
to signal their dangerousness.

One can use `register` in combination with preproc to define code
entirely in Carp and obviate the need of additional header files. For
example:

```
(Unsafe.preproc (Unsafe.emit-c "#define FOO 0"))
(Unsafe.preproc (Unsafe.emit-c "void foo() { printf(\"%d\\n\", 1); }"))

(register FOO Int)
(register foo (Fn [] ()))

(defn main []
  (do (foo)
      (IO.println &(fmt "%d" FOO))))
```

The prior example emits C that defines a FOO macro and foo function,
which are both referenced in the main function emitted by Carps normal
processing. Here's what the output looks like:

```
// .. several other includes emitted by the compiler...

void foo() { printf("%d\n", 1); }

//Types:

// Depth 3
typedef struct {
    union {
    struct {
        Long member0;
    } Just;
    // Nothing
    char __dummy;
    } u;
    char _tag;
} Maybe__Long;
```

The C passed to preproc calls is emitted prior to Carps other emissions,
ensuring the user has access to these definitions before any Carp code
is called.

* docs: Add documentation on emit-c and preproc

* feat: add macros for emitting C compiler directives

This suite of macros uses the `Unsafe.emit-c` and `Unsafe.preproc`
functions to provide macros for emitting common C compiler directives,
such as #ifdef, #define, #pragma and others.
2021-03-09 10:43:44 +01:00
.github chore: Try scoop install zip --global 2020-12-20 21:13:32 +01:00
app feat: Add support for emitting literal C (#1178) 2021-03-04 07:29:52 +01:00
bench Add automatic map resizing (#1071) 2020-12-19 22:20:52 +01:00
core feat: add macros for emitting C compiler directives (#1182) 2021-03-09 10:43:44 +01:00
docs feat: Add support for emitting literal C (#1178) 2021-03-04 07:29:52 +01:00
examples fix: re-add benchmarks (#1166) 2021-02-04 08:35:48 +01:00
headerparse fix: Bumped Ormolu version to 0.1.4.1 (#1050) 2020-12-03 12:02:58 +01:00
resources refactor: Move logos into resorces directory 2020-11-20 07:52:59 +01:00
scripts fix: re-add benchmarks (#1166) 2021-02-04 08:35:48 +01:00
src fix: don't qualify paths of registered types (#1172) 2021-03-04 07:31:26 +01:00
test feat: Adds defn- and def- macros (#1174) 2021-03-03 08:57:36 +01:00
.build.yml Fix nixpkgs build. 2020-11-14 15:28:17 +01:00
.clang-format core: do not have short functions on single lines 2019-10-30 11:07:32 +01:00
.dir-locals.el Ormolu in default.nix and emacs before-save hook. (#1059) 2020-12-08 22:09:57 +01:00
.gitignore chore: Move test-for-errors to test directory 2020-11-28 13:11:43 +01:00
.travis.yml Fix nixpkgs build. 2020-11-14 15:28:17 +01:00
CarpHask.cabal build: Release v0.5.0 2021-02-01 19:22:42 +01:00
default.nix chore: Simplify default.nix (#1085) 2020-12-21 13:46:10 +01:00
LICENSE new license 2016-08-23 15:43:10 +02:00
LUA_LICENSE lau license: fix referenced file 2019-01-14 12:08:36 +01:00
README.md Update README.md 2021-03-04 09:35:05 +01:00
Setup.hs refactor: Apply Ormolu auto-formatting (#1045) 2020-12-02 16:33:37 +01:00
stack.yaml Try to fix Windows build failure switching resolver. 2020-05-23 00:29:44 +02:00

Carp

Logo

Linux CI MacOS CI Windows CI

WARNING! This is a research project and a lot of information here might become outdated and misleading without any explanation. Don't use it for anything important just yet!

Version 0.5 of the language is out!

About

Carp is a programming language designed to work well for interactive and performance sensitive use cases like games, sound synthesis and visualizations.

The key features of Carp are the following:

  • Automatic and deterministic memory management (no garbage collector or VM)
  • Inferred static types for great speed and reliability
  • Ownership tracking enables a functional programming style while still using mutation of cache-friendly data structures under the hood
  • No hidden performance penalties allocation and copying are explicit
  • Straightforward integration with existing C code
  • Lisp macros, compile time scripting and a helpful REPL

Learn more

Join the chat at https://gitter.im/eriksvedang/Carp

A Very Small Example

(load-and-use SDL)

(defn tick [state]
  (+ state 10))

(defn draw [app rend state]
  (bg rend &(rgb (/ @state 2) (/ @state 3) (/ @state 4))))

(defn main []
  (let [app (SDLApp.create "The Minimalistic Color Generator" 400 300)
        state 0]
    (SDLApp.run-with-callbacks &app SDLApp.quit-on-esc tick draw state)))

For instructions on how to run Carp code, see this document.

For more examples, check out the examples directory.

Maintainers

Contributing

Thanks to all the awesome people who have contributed to Carp over the years!

We are always looking for more help check out the contributing guide to get started.

License

Copyright 2016 - 2020 Erik Svedäng

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

The regular expression implementation as found in src/carp_regex.h are Copyright (C) 1994-2017 Lua.org, PUC-Rio under the terms of the MIT license. Details can be found in the License file LUA_LICENSE.