Skip to content

Commit

Permalink
Move org generation code to separate repository (#311)
Browse files Browse the repository at this point in the history
* removed the lisp code from this repo to another. Used ros to call the generation

* updated redme to reflect the new instructions
  • Loading branch information
mariari committed Jan 28, 2020
1 parent 4908613 commit 270dc79
Show file tree
Hide file tree
Showing 17 changed files with 30 additions and 1,092 deletions.
9 changes: 9 additions & 0 deletions .org-generation
@@ -0,0 +1,9 @@
;; configuration file for code generation

;; TODO ∷ re-enable lisp

(:enabled haskell)

(haskell
:name "Juvix"
:dir-before-code ("src" "app" "test"))
4 changes: 3 additions & 1 deletion README.md
Expand Up @@ -101,7 +101,9 @@ juvix interactive

[Ormolu](https://github.com/cryptiumlabs/ormolu) required for source formatting.

[Quicklisp](https://www.quicklisp.org/beta/) and [sbcl](http://www.sbcl.org/) required for the automatic generation of documentation in [doc/Code](https://github.com/cryptiumlabs/juvix/tree/develop/doc/Code).
[Roswell](https://github.com/roswell/roswell) is required for automatic generation of documentation in [doc/Code](https://github.com/cryptiumlabs/juvix/tree/develop/doc/Code).

Once Roswell is installed one only needs to add `~/.roswell/bin` to their bash path along with running `ros install cryptiumlabs/org-generation`.

To open a REPL with the library scoped:

Expand Down
28 changes: 17 additions & 11 deletions doc/Code/Juvix.org
Expand Up @@ -31,7 +31,7 @@
**** DSL
Serves as a mini DSL layer above LLVM
- _Relies on_
+ [[Codegen]]
+ [[Backends/LLVM/Codegen]]
+ [[Library]]
***** What is included?
1. _Relink_
Expand All @@ -51,7 +51,7 @@ TODO: Separate out the common logic from the interpreter & this file into a shar
+ [[Interface]]
+ [[Nets/Default]]
+ [[Library]]
**** Codegen
**** Codegen <<Backends/LLVM/Codegen>>
- _Relies on_
+ [[Block]]
+ [[Constants]]
Expand Down Expand Up @@ -95,7 +95,7 @@ Provides a mechanism for defining Sum types
Serves as a front end for the Graph folder
- _Relies on_
+ [[Graph/Debug]]
+ [[Definitons]]
+ [[Definitions]]
+ [[Operations]]
****** Debug <<Graph/Debug>>
Serves as a module for various debugging functions
Expand All @@ -104,7 +104,7 @@ Serves as a module for various debugging functions
+ [[Operations]]
+ [[Codegen/Types]]
+ [[Library]]
****** Definitons
****** Definitions
Operations necessary to update nodes
- =mainPort=, =auxiliary1= \dots =auxiliary4= allocation
| Part | Alloca Or Malloc |
Expand Down Expand Up @@ -187,14 +187,14 @@ Functions that help with more complex Graph operations
**** Net
***** API
- _Relies on_
+ [[Codegen]]
+ [[Backends/LLVM/Codegen]]
+ [[Net/EAC]]
+ [[Net/EAC/Types]]
+ [[Library]]
***** Environment
- Serves as the default environment for executing EAC code
- _Relies on_
+ [[Codegen]]
+ [[Backends/LLVM/Codegen]]
+ [[API]]
+ [[Net/EAC]]
+ [[Defs]]
Expand Down Expand Up @@ -226,7 +226,7 @@ Functions that help with more complex Graph operations
responsibility of the node to de-allocate, but instead uses the
default strategy laid out in [[Codegen/Graph]]
- _Relies on_
+ [[Codegen]]
+ [[Backends/LLVM/Codegen]]
+ [[DSL]]
+ [[EAC/Debug]]
+ [[Defs]]
Expand All @@ -237,15 +237,15 @@ Functions that help with more complex Graph operations
****** Debug <<EAC/Debug>>
Serves as a module for various debugging functions
- _Relies on_
+ [[Codegen]]
+ [[Backends/LLVM/Codegen]]
****** Defs
- Specializes the functions in Graph to fit [[Net/EAC/Types]]
+ Later in the DSL Layer!
- Generates the =find_edge= and =isBothPrimary= function with the =eal= type.
- Also generates the proper types associated with them
- Also has some miscellaneous debug information
- _Relies on_
+ [[Codegen]]
+ [[Backends/LLVM/Codegen]]
+ [[DSL]]
+ [[Net/EAC/Types]]
+ [[Library]]
Expand All @@ -255,12 +255,12 @@ Serves as a module for various debugging functions
+ Sadly we can't extend types easily in Haskell, hence the
boilerplate in this file
- _Relies on_
+ [[Codegen]]
+ [[Backends/LLVM/Codegen]]
+ [[Library]]
+ [[HashMap]]
****** Types <<Net/EAC/Types>>
- _Relies on_
+ [[Codegen]]
+ [[Backends/LLVM/Codegen]]
+ [[Library]]
*** Michelson
- _Relies on_
Expand Down Expand Up @@ -739,6 +739,12 @@ Can be added to via core translation
+ [[NodeInterface]]
+ [[InteractionNet/Shared]]
+ [[Library]]
** LLVM
*** Codegen <<Juvix/LLVM/Codegen>>
- _Relies on_
+ [[Shared]]
+ [[Library]]
+ [[HashMap]]
** Library
- The standard Library for the project
+ Thus all code will depend on this module without stating otherwise
Expand Down
64 changes: 0 additions & 64 deletions doc/Code/org-generation.org

This file was deleted.

13 changes: 0 additions & 13 deletions scripts/org-generation/language-config.lisp

This file was deleted.

24 changes: 0 additions & 24 deletions scripts/org-generation/org-generation.asd

This file was deleted.

0 comments on commit 270dc79

Please sign in to comment.