497 Commits

Author SHA1 Message Date
cd01246997 remove pygments setup 2020-06-05 15:21:33 -07:00
6350ddd242 fix permissions for travis doc script 2020-06-05 15:16:59 -07:00
d69d7e482d Added description of to the Num class docs (#726) 2020-06-05 15:08:52 -07:00
7b56dce4f0 Fix example C code (#745) 2020-06-05 15:08:25 -07:00
d585a080e8 Merge pull request #751 from wren-lang/0.3.0-refactor
0.3.0 refactor
2020-06-05 14:57:20 -07:00
6ab4abe9e3 cli; Fix a memory leak in findModulesDirectory() (#718) 2019-12-27 10:42:32 -08:00
186a8c7c13 Fixed Random.sample(list, count) for small number of samples (#714)
Closes #713
2019-12-11 15:40:07 -08:00
53cf6f511b benchmark; fix parsing of None in certain cases (like with no interpreter when a baseline is made) 2019-10-07 23:48:42 -07:00
b120739631 fix minor warning 2019-10-07 23:43:05 -07:00
51ef6ff5fa docs; fix missing blog link and arrangement in small mode
thanks Brian Slesinsky
2019-10-02 23:41:39 -07:00
faff0d6ca4 blog; formatting 2019-09-30 23:03:45 -07:00
8ce631e80e blog; add 0.2.0/0.3.0 post 2019-09-30 22:48:04 -07:00
5338275dcd 0.2.0 prep work 2019-09-30 21:38:08 -07:00
3eb4ac1419 Add a clearer error message for forward declared lowercase variables (#699)
* Add better error messaging for forward referenced top level variables, see #467
* add test case
2019-09-30 20:30:27 -07:00
fc7bd1c78f Merge pull request #703 from mwilmsm/master
Cleaned up some documentation typos. -mw
2019-09-30 13:23:51 -07:00
265bcc6780 Cleaned up some documentation typos. -mw 2019-09-30 09:02:55 -05:00
ff4f92eb87 .gitignore; and one more 2019-09-28 12:21:45 -07:00
7617498aa3 .gitignore; correct path for object files 2019-09-28 12:21:19 -07:00
688691b17c Don't access null pointers when printing null module names
fixes #631
2019-09-18 22:49:01 -07:00
7eac8e6a37 docs; encapsulation legibility fixes 2019-09-18 01:43:34 -07:00
898e5356c7 Merge pull request #562 from Salmela/locals-array-overflow-fix
Check that there is space in local variable array
2019-09-18 00:20:03 -07:00
f3b0200c39 Merge pull request #541 from kext/amalgamation
Repaired amalgamation script
2019-09-18 00:11:22 -07:00
cdeb0db5c3 disambiguate the call here from the call in wren_compiler.c (fixes amalgamation having overalapped symbols) 2019-09-18 00:08:07 -07:00
123ba80a89 fix warning about conversion from '__int64' to 'double', possible loss of data 2019-09-18 00:05:16 -07:00
fa2a3d9576 Clarify modulus documentation for sign
closes #695
2019-09-17 22:27:47 -07:00
0e67667010 Update Encapsulation documentation to be clearer
fixes #691
2019-09-17 22:18:55 -07:00
e94c813ecc Merge pull request #698 from matusnovak/fix-foreign-allocate-abort-fiber
Fix wrenAbortFiber does not work inside of foreign class allocator
2019-09-17 11:08:37 -07:00
f91586a71a Fix wrenAbortFiber does not work inside of foreign class allocator 2019-09-17 19:43:53 +02:00
740c365597 Merge pull request #693 from wren-lang/faster-bit-hash
Fix horrendously bad bit hashing function.
2019-07-27 21:00:02 -07:00
2a1499b04b Fix horrendously bad bit hashing function.
hashBits() is used to generate a hash code from the same 64 bits used
to represent a Wren number as a double. When building a map containing
a large number of integer keys, it's important for this to do a good
job scattering the bits across the 32-bit key space.

Alas, it does not. Worse, the benchmark to test this happens to stop
just before the performance falls off a cliff, so this was easy to
overlook.

This replaces it with the hash function V8 uses, which has much better
performance across the numeric range.
2019-07-27 13:34:07 -07:00
d1a0d0682a Merge pull request #688 from pyway/patch-1
fix memory leak in path.c
2019-07-01 07:40:14 -07:00
vvn
5725ecad67 Update path.c 2019-06-13 14:51:28 +08:00
a8fd838255 Merge pull request #680 from bjorn/patch-1
docs: Fixed broken link to overview about maps
2019-04-09 15:46:38 -07:00
451098db05 docs: Fixed broken link to overview about maps
Closes #672
2019-04-09 17:44:15 +02:00
13dfebe1a5 Merge pull request #664 from Heaven31415/master
Update note about path to visual studio solution.
2019-03-24 14:09:24 -07:00
fe3aa60601 Update note about path to visual studio solution. 2019-03-24 21:36:21 +01:00
2d018c9109 Merge pull request #663 from Heaven31415/master
Update link to comment about NaN tagging.
2019-03-24 08:03:52 -07:00
51230e18fc Update link to comment about NaN tagging. 2019-03-24 12:46:39 +01:00
93dac91327 Merge pull request #660 from walterschell/feature/string_fromByte
Added String.fromByte with docs and unit test
2019-02-28 19:31:26 -08:00
a437e804ba Added String.fromByte with docs and unit test 2019-02-27 08:10:54 -05:00
487f53ace1 Merge pull request #657 from SuperWangKai/master
Fixed compiling error of cli on Windows
2019-02-20 09:00:22 -08:00
kai
c58e51fa96 Fixed compiling error of cli on Windows 2019-02-19 15:14:53 +08:00
1ec0b649c1 Merge pull request #589 from FICTURE7/master
Renamed include guard in wren_compiler.h
2019-02-15 07:30:46 -08:00
51c857ab0e Merge pull request #610 from jyaif/bar
Remove unused prototype.
2019-02-15 07:30:16 -08:00
abbb410ff2 Fix assert in insertEntry().
The intent of the assert is to ensure that insertEntry() is not called
with an empty entries array because that would cause you to get into a
code path where the entry output parameter is not set. But the assert
didn't correctly check that.

Fix #635.
2019-02-14 07:51:57 -08:00
03d70f336f Merge pull request #620 from PrimordialHelios/fixup_overflow
Fix overflow on line 401 of wren_compiler.c
2019-02-14 07:42:12 -08:00
b2a2494008 Regenerate REPL include. 2019-02-14 07:33:30 -08:00
35df7faa1e Merge branch 'repl_keys' of https://github.com/PrimordialHelios/wren into PrimordialHelios-repl_keys
# Conflicts:
#	AUTHORS
2019-02-14 07:31:22 -08:00
0f8e9a6554 Merge pull request #612 from iwillspeak/osx-buildfixes
Disable 32 bit macOS Build
2019-02-11 23:33:05 -08:00
6514c592d3 Merge pull request #611 from iwillspeak/doc-fixup
Update Call to `WrenInterpret` in Docs
2019-02-11 23:32:40 -08:00
8a0d2297a1 Merge pull request #615 from iwillspeak/repl-escape-fix
Fixup Handling of `\` in REPL to Prevent Crash
2019-02-11 22:58:06 -08:00
ccb9ba3441 Disable 32 bit macOS Build
With the latest XCode it looks like 32 bit builds are deprecated. This
causes build warnings which fail the libuv build. This commit remvoves
the 32 bit arch from the macOS libuv build, and stops building the 32
build on Travis.
2019-02-12 06:56:38 +00:00
9347c5c61a Update Call to WrenInterpret in Docs
Fixes #599 by updating the arguments to WrenInterpret to match the new
API.
2019-02-12 06:54:58 +00:00
52c16b4f80 Merge branch 'wrenHasError' of https://github.com/mhermier/canary into mhermier-wrenHasError 2019-02-11 07:52:38 -08:00
a945bed812 Merge pull request #655 from wren-lang/limited-reentrancy
Add a limited form of re-entrant calls.
2019-02-11 07:38:09 -08:00
a5147aa2d9 Add a limited form of re-entrant calls.
This doesn't let you arbitrarily call back into the VM from within
foreign methods. I'm still not sure if that's even a good idea since
God knows what that would mean if you switch fibers while doing that.

But this does allow the very important use case of being able to call
a foreign method from within a call to wrenCall(). In other words,
foreign methods need to always be leaf calls on the call stack, but the
root of that stack can now come from runInterpreter() or wrenCall().

Fix #510.
2019-02-08 17:09:39 -08:00
6ac829947a blog; fix twitter link to munificentbob (thanks @noelfb) 2019-02-07 20:40:44 -08:00
25a1431fa7 docs; add some links to blog post 2019-02-07 13:07:21 -08:00
27a08151e7 blog; clarify weird grammar (sponge) 2019-02-05 19:39:38 -08:00
57a1d809d8 docs; replace wren repo URL to point to organization 2019-02-05 18:41:31 -08:00
7cc7c715c9 docs; list; add + operator documentation 2019-02-05 18:18:38 -08:00
21024bfa13 docs; formatting and tidying
- quick clean up pass on layout and colors for clarity/legibility
- added logo to the sidebar
- fix various css things like a full height page when content is shorter, so the footer doesn't creep away from the bottom
- start using em instead of px for consistency across devices
2019-02-05 18:18:24 -08:00
2d449cd4c9 docs; add blog section with simple rss
- rss is hand written right now
- see the hello wren blog post for reasoning
2019-02-05 18:15:29 -08:00
29cef0bd53 docs; update generator
- copies files in doc/site/static/ to output
- update output formatting to include potential differences in markdown generator (local generate had >, so cover both to remain consistent)
- copy rss xml (could be in static too, but for now...)
2019-02-05 18:14:34 -08:00
201ae2f38a Merge pull request #619 from PrimordialHelios/fix_doc_generation
Fix doc generation script
2019-02-04 17:57:52 -08:00
cabab755f5 Merge pull request #646 from nenofite/patch-1
Fix broken link for error handling
2018-12-19 18:36:30 -03:30
d01905ef80 Fix broken link for error handling 2018-12-19 12:39:52 -08:00
193e0c812c Change size of label on line 449 to avoid incorrect compiler warning about label's maximum length 2018-12-19 09:38:26 -05:00
4ebb99d27f Merge pull request #636 from datatypevoid/readme-update
chore(README): point broken links to wren.io
2018-11-26 16:35:42 -03:30
afebb24e1b chore(README): point broken links to wren.io 2018-11-26 14:33:35 -05:00
00491480d7 Add myself to AUTHORS file 2018-11-06 20:01:05 -05:00
31e179907d Add support for home, end, delete, and ctrl+w 2018-10-31 18:32:34 -04:00
091d2c4313 Fix call to markdown.markdown 2018-10-30 15:06:50 -04:00
a4b034f30b Fixup Handling of \ in REPL to Prevent Crash
When parsing the string token if a `\` was used it would
unconditionally consume the next character. This would led to a token
with an invalid lenght causing a crash when it was printed. This fixes
that by only consuming the token after the `\` if there is one to
consume.

Fixes #603
2018-10-08 07:35:55 +01:00
8929415847 Remove unused prototype. 2018-09-27 15:03:10 +02:00
744147fd94 Flush prompt in animals example. 2018-08-01 07:28:48 -07:00
fefed21158 Rename include guard 2018-07-27 18:57:17 +04:00
fe57c1eea0 Trivial: wren_core.wren.inc needs to be regenerated. 2018-07-25 11:58:50 +02:00
051e224ce6 De-inline wrenHasError.
Move fiber error detection inside a function instead of using inlined
version everywhere.
2018-07-25 11:55:03 +02:00
0ebf4e1277 Add me to AUTHORS. 2018-07-25 11:55:03 +02:00
e47f17567e Fix a couple more casts needed in C++. 2018-07-24 07:27:18 -07:00
03ec25720d Add cast to satisfy the C++ warning gods. 2018-07-24 07:21:41 -07:00
c237a44b88 Add file to test directory so Git creates directory. 2018-07-24 07:15:04 -07:00
f23c82071a Don't allow calling the root fiber.
The VM used to not detect this case. It meant you could get into a
situation where another fiber's caller had completed. Then, when it
tried to resume that fiber, the VM would crash because there was nothing
to resume to.

This is part of thinking through all the cases around re-entrancy. Added
some notes for that too.
2018-07-21 10:02:29 -07:00
5f29a72d65 Remove the special method type for Fn.call(...).
Instead, using regular primitives for each of the call() methods.
Doesn't help performance (alas), but does seem cleaner to me.
2018-07-18 08:20:11 -07:00
ed64a13778 Add new files to api_test target in XCode project. 2018-07-18 07:30:18 -07:00
fe7e56d508 Merge branch 'rfc-0001-smarter-imports' 2018-07-16 07:03:00 -07:00
b2b2b8a4e7 Add note. 2018-07-16 07:02:53 -07:00
1a37d2228d Merge branch 'smarter-imports' 2018-07-16 07:00:08 -07:00
7a42a20b98 Merge branch 'master' into smarter-imports
# Conflicts:
#	src/module/io.c
#	src/vm/wren_vm.c
2018-07-15 21:01:14 -07:00
c367fc3bfc Get logical imports in "wren_modules" working.
There's a lot of changes here and surely some rough edges to iron out.
Also, I need to update the docs. But I want to get closer to landing
this so I can build on it.
2018-07-15 20:09:41 -07:00
e486c56ae9 Merge pull request #546 from mathewmariani/master
Fixed PreBuildEvents on vs2017
2018-07-15 11:08:21 -07:00
09f4beff4a Add trim methods on String:
- trim()
- trim(chars)
- trimEnd()
- trimEnd(chars)
- trimStart()
- trimStart(chars)
2018-07-15 10:48:56 -07:00
ef5f38b48f Turn on auto-deploying docs.
Looks like it's working now. <crosses fingers>
2018-07-14 21:35:33 -07:00
7b42a9d621 More guessing at package names. 2018-07-14 21:00:59 -07:00
361b57fa8d Try to get right package name for smartypants. 2018-07-14 20:51:48 -07:00
3920818b46 Install smartypants on Travis. 2018-07-14 20:44:22 -07:00
c7c69d1291 Check in shared Xcode file. 2018-07-14 12:12:37 -07:00
09be27d3d5 Install pygments on Travis. 2018-07-14 12:12:07 -07:00
7d8292fe90 Fix a Travis dependency. 2018-07-14 11:57:11 -07:00
52f08aec05 Install the custom pygments lexer using python3. 2018-07-14 11:44:53 -07:00
d13cafed71 Fix command. I am an idiot. 2018-07-14 11:17:36 -07:00
db77a9dce4 Disable container-based build so we can use sudo. 2018-07-14 11:05:41 -07:00
5fff693530 Testing fix to doc deploy script. 2018-07-14 10:35:45 -07:00
08b5492362 Turn off doc deploying for now. 2018-07-13 09:15:26 -07:00
c120769977 Make some tweaks to doc deploy script.
- Rename file to match other naming conventions.
- Simplify condition a little.
2018-07-13 08:02:37 -07:00
91b4f53ee5 Merge branch 'auto-deploy-docs-from-travis' of https://github.com/CodogoFreddie/wren into CodogoFreddie-auto-deploy-docs-from-travis 2018-07-13 07:46:46 -07:00
1f93e16fb2 Provide actual soname when building shared lib on Linux.
Fix #572.
2018-07-13 07:19:06 -07:00
646fedab98 Merge pull request #555 from GHvW/GHvW-patch-1
Update file.markdown
2018-07-13 07:02:49 -07:00
a3c2402ca0 Merge branch 'missing_undef' of https://github.com/dressupgeekout/wren into dressupgeekout-missing_undef
# Conflicts:
#	AUTHORS
2018-07-13 07:01:57 -07:00
1029d5feb6 Merge pull request #581 from michal037/michal037
Small improvements
2018-07-13 06:53:34 -07:00
ad9a0e13ac Small improvements
* Safer definitions in io.c
* Easier to understand information in repl.wren
* Added my e-mail; Contributing > Hacking on the VM
2018-07-12 21:50:23 +02:00
5356ccb760 Add myself to the AUTHORS 2018-06-14 00:33:59 -07:00
e7b1bade1a Check that there is space in local variable array
Otherwise it can overflow due to for loop's hidden
variables.

Fix #561
2018-06-13 00:59:55 +03:00
18f74d89c4 Don't forget to #undef FINALIZER 2018-06-05 13:27:45 -07:00
4c9209c1b2 Update file.markdown
minor fix to close() language
2018-06-03 23:06:40 -05:00
9934d17019 Update PreBuildEvent scripts for more conditions 2018-05-21 11:14:23 -04:00
85b2c9a99d added explicity vs2017 argument
To build with VS2017 you need to explicitly add a vs2017 argument
2018-05-21 01:57:50 -04:00
4957fff584 Fixed PreBuildEvents on vs2017 2018-05-21 01:25:38 -04:00
c40bb93d60 Changed shebang to python3 2018-05-16 23:10:44 +02:00
abd1cf37c4 Repaired amalgamation script
The amalgamation script now searches for files in the different
directories of src.

Also the full paths in the amalgamation were replaced by the basename
to produce the same content on all machines.

The makefile now creates the build directory for the amalgamation
if it does not exist.
2018-05-12 09:24:23 +02:00
40c927f440 Make sure we consume all the input when compiling a single expression.
Fix #528.
2018-04-28 16:54:33 -07:00
c4ae0f5c59 Be a little more conservative with some string operations.
This should hopefully fix #531, though in practice the previous code
should have been safe too.
2018-04-28 16:38:09 -07:00
41a56446c6 Refine a few things:
- Fix some doc comments.

- Inline comparing two ObjStrings, since it's only used in one place.
  Also, this avoids a redundant identity check.

- Move the forward declarations of the object types out of
  wren_common.h. Instead, I just added the one needed forward
  declaration of ObjString in wren_utils.h. It's a little inelegant,
  but it feels weird to me to expose all of the object types in
  wren_common.h when they logically belong to wren_value.h and most of
  the types aren't problematic.

- Fix a bug where field symbol tables weren't being marked. If a GC
  happened while compiling a class, field strings got freed.
2018-04-28 12:13:03 -07:00
05e18fa95f Merge branch 'unify_string' of https://github.com/mhermier/wren into mhermier-unify_string 2018-04-28 10:22:42 -07:00
d03ef9e8b0 Move test and tweak code a bit. 2018-04-28 10:08:42 -07:00
4d056b6ec3 Merge branch 'master' of https://github.com/jclc/wren into jclc-master 2018-04-28 10:00:59 -07:00
8fae8e4f1e Don't overflow signature string if there are too many parameters.
Fix #494.
2018-04-27 09:13:40 -07:00
c5ce6fac46 Fix local variable declarations in the REPL.
A statement like:

  for (i in 1..2)

When run in the REPL declares a local variable ("i"), but not inside
a function or method body. This hit a corner case in the compiler
where it didn't have the correct slot indexes set up.

That corner case is because sometimes when you compile a chunk, local
slot zero is pre-allocated -- either to refer to "this" or to hold the
closure for a function so that it doesn't get GCed while running. But
if you're compiling top-level code, that slot isn't allocated. But top
level code for the REPL *should* be, because that gets invoked like a
function.

To simplify things, *every* compiled chunk now pre-allocates slot zero.
That way, there are fewer cases to keep in mind.

Also fixed an issue where a GC during an import could collected the
imported module body's closure.

Fix #456.
2018-04-27 08:20:49 -07:00
64f8bf7ae3 Merge pull request #524 from bjorn/master
Small documentation fixes
2018-04-25 21:09:48 -07:00
4bc3e6f424 Fix LICENSE to match https://choosealicense.com/licenses/mit/.
That way GitHub and other tools correctly recognize the license. There
is no substantive change to the license itself.
2018-04-23 16:48:47 -07:00
e66115c9fc add regression test for #520 2018-04-10 18:53:56 +03:00
c1ed027973 Merge pull request #523 from jaromirmuller/patch-1
documentation: fixed typo, function declares data, body uses file
2018-04-06 23:49:55 -07:00
4034a6d65a crunched BOM skipping 2018-04-07 06:04:32 +03:00
67ed36e79a don't publish docs from PRs, only from merges into master 2018-04-06 20:04:34 +01:00
f7a61df634 only upload docs from the master branch 2018-04-06 19:53:53 +01:00
372cd3e197 Small documentation fixes 2018-04-06 10:34:12 +02:00
4442b37411 fixed typo, function declares data, body uses file 2018-04-05 23:02:30 +02:00
492763205b introduced docs auto publish step to travisci 2018-04-04 20:37:05 +01:00
fe2ca0e89a remove extra line 2018-04-04 05:14:05 +03:00
8858161484 skip UTF-8 BOM 2018-04-04 05:11:59 +03:00
e4901c51d8 Add wrenStringEqualStrLength and wrenStringsEqual. 2018-03-29 09:12:32 +02:00
3c39f7e0af Make symboltable use ObjString.
* Avoid to have 2 different string representation in the code.
* Reduce memory creation in meta API, by reusing created strings.
2018-03-28 18:12:50 +02:00
3e9bf0277b Move Obj* type definition to wren_common.h.
Uniformize structure naming, and should help file includes.
2018-03-28 17:51:34 +02:00
7487eeab49 Merge pull request #515 from kjk/patch-1
fix bindForeignMethod() example
2018-03-26 07:52:26 -07:00
af9fda5e60 Merge branch 'master' of https://github.com/munificent/wren 2018-03-26 07:50:49 -07:00
8c7174d1c6 Merge branch 'fix-assert' of https://github.com/maxdeviant/wren into maxdeviant-fix-assert 2018-03-26 07:50:16 -07:00
8852e5accc Merge pull request #500 from mhermier/critical_fixes
[critical] Fix getNumArguments and wrenBindMethodCode opcodes data.
2018-03-26 07:49:54 -07:00
8210452970 Relative imports!
This is a breaking change because existing imports in user Wren code
that assume the path is relative to the entrypoint file will now likely
fail.

Also, stack trace output and host API calls that take a module string
now need the resolved module string, not the short name that appears in
the import.
2018-03-24 11:10:36 -07:00
5539c59750 Add a minimal path manipulation C module.
This is just for the VM's own internal use, for resolving relative
imports.

Also added a tiny unit test framework for writing tests of low-level
C functionality that isn't exposed directly by the language or VM.
2018-03-24 10:58:07 -07:00
8a71735e0f Expose an API to let the host resolve relative import strings.
This is a breaking API change: wrenInterpret() now takes an additional
parameter for the module name to interpret the code in.
2018-03-23 07:54:09 -07:00
e1f105fd8e Merge pull request #484 from feiss/patch-1
parameter missing in errorFn
2018-03-22 10:31:01 -07:00
bcc31e63a2 add() method is bound as static but bindForeignMethod responds to non-static 2018-03-20 17:13:28 -07:00
c5befa72cf Don't use module import string when loading imported variables.
This is an interim step towards supporting relative imports. Previously,
the IMPORT_VARIABLE instruction had a constant string operand for the
import string of the module to import the variable from. However, with
relative imports, the import string needs to be resolved by the host
all into a canonical import string. At that point, the original import
string in the source is no longer useful.

This changes that to have IMPORT_VARIABLE access the imported ObjModule
directly. It works in two pieces:

1. When a module is compiled, it ends with an END_MODULE instruction.
   That instruction stores the current ObjModule in vm->lastModule.

2. The IMPORT_VARIABLE instruction uses vm->lastModule as the module to
   load the variable from. Since no interesting code can execute between
   when a module body completes and the subsequent IMPORT_VARIABLE
   statements, we know vm->lastModule will be the one we imported.
2018-03-20 06:54:51 -07:00
7612b6bc8c Merge pull request #513 from snocl/replfix
Fix REPL being broken by latest commit
2018-03-19 14:08:04 -07:00
92cb88366b Fix REPL being broken by latest commit. 2018-03-19 21:50:12 +01:00
2c88e19497 Compile imports to closures, not fibers.
This is simpler and marginally faster. We don't need the overhead of
fibers since you can't have long or recursive import chains anyway.

More importantly, this makes the behavior more well-defined when you do
things like yield from an imported module. (Not that you should do that,
but if you do, it shouldn't do weird things.)
2018-03-17 09:33:33 -07:00
43cf652003 Simplify wrenCompileSource(). 2018-03-17 09:13:51 -07:00
bd3897278c Use newer GYP. 2018-03-14 08:06:06 -07:00
a95077cd9f Don't build the libuv tests on Linux. 2018-03-14 07:27:29 -07:00
011e8fab96 Fix off-by-one error in arg checking. 2018-03-14 07:27:29 -07:00
f866ee7003 Vendor GYP and libuv into the repo.
Instead of dynamically downloading these as needed during a build, this
checks in those two dependencies directly into the Wren repo. That's a
little lame because users of Wren who aren't building the CLI don't
actually need them, but they aren't too big, so it's not a huge deal.

It makes builds (particularly on Travis) more reliable, because they
don't have to pull down additional content over the network.
2018-03-14 07:27:29 -07:00
3ce9ecfc65 Merge pull request #506 from adsr/patch-readme
Fix embedding link in README
2018-02-20 14:23:39 -08:00
0ad0af0e1f Fix embedding link in README 2018-02-16 23:18:01 -05:00
89ae3f92ec Add @maxdeviant to AUTHORS 2018-01-18 00:48:02 -05:00
e493e6679b Fix variable in assert
Fixes #493
2018-01-18 00:46:58 -05:00
a2cf3c34ad Fix getNumArguments and wrenBindMethodCode opcodes data.
Some instructions data in these 2 functions are out of syncs, and can try to
patch the code in bad manner.
2018-01-11 12:20:35 +01:00
d1a772e820 parameter missing in errorFn 2017-11-14 16:56:16 +01:00
c4d08bcb81 Fix missing return error. 2017-10-31 22:07:07 -07:00
7b326d804b Merge pull request #475 from KyleCharters/master
Correct method examples in Range docs
2017-10-31 16:24:58 -07:00
8d37b20783 Compile imports to actual instructions instead of core library calls. 2017-10-31 15:58:59 -07:00
e9ac543853 Merge pull request #480 from aliou/ad-fix-embedding-path
Fix embedding path in getting started
2017-10-31 14:04:37 -07:00
b45cab28d1 Fix embedding path in getting started. 2017-10-31 21:47:51 +01:00
9f79dfcdac Proposal for smarter imports. 2017-10-31 07:49:40 -07:00
1be76bb478 Correct method examples in Range docs 2017-10-23 13:48:43 -04:00
88ff8f90ef Merge pull request #474 from minirop/typo-in-doc
missing language specifier and variable declaration
2017-10-19 22:12:25 -07:00
1661f5368f Allow passing a value when first starting a fiber.
If the function the fiber is created from takes a parameter, the value
passed to the first call() or transfer() gets bound to that parameter.

Also, this now correctly handles fibers with functions that take
parameters. It used to leave the stack in a busted state. Now, it's a
runtime error to create a fiber with a function that takes any more
than one parameter.
2017-10-19 20:45:13 -07:00
e043a95e4e Edit docs. Docs docs docs. 2017-10-19 19:52:05 -07:00
6444a5f5db missing language specifier and variable declaration 2017-10-19 21:17:40 +02:00
f8076c2c1c Revise embedding docs. 2017-10-19 07:02:18 -07:00
e2e16dc4a9 Finish off the rest of the embedding docs.
A first draft of them, at least. They probably need some editing.
Remove the "Application Lifecycle" page for now. I do intend to add
some docs about how fibers interact with the host app, but I can do
that later.
2017-10-17 08:26:06 -07:00
9661a5b999 Fix a couple of bugs in the REPL.
- Not sure what was going on, but fix #456. It makes more sense for the
  REPL to invoke the compiled code as a fiber than a function anyway.

- Flush stdout before reading from stdin since System.print() no longer
  does that automatically.
2017-10-13 07:58:57 -07:00
97b2e1c818 Add web server to doc generator. 2017-10-12 06:38:34 -07:00
91853a7fa9 Fix comment on foreign allocate function.
Fix #453.
2017-10-12 06:37:49 -07:00
2021e086bf Don't automatically flush on every System.write().
It's handy because it ensures writes are flushed to the terminal before
any calls to read from stdin, but it's also gratuitously slow.

Instead, added a Stdout class with an explicit flush() method that can
be called by the user.

Fix #445.
2017-10-09 07:16:05 -07:00
c4b0f83cb3 "ClassCompiler" -> "ClassInfo".
Fix #469.
2017-10-09 06:47:42 -07:00
973b43eb7f Simplify statement compiler code a little. 2017-10-08 10:47:31 -07:00
c7087652ee Add regression tests from wren-fuzz.
These are all non-crashing now, so it looks like the underlying issue
is fixed. (It was probably #429.)

Fix #442.
2017-10-08 10:15:15 -07:00
c38d97b973 Properly detect a missing "}" in a block.
Fix #429.
2017-10-08 10:03:42 -07:00
18449102e8 Parenthesize macro arguments in ALLOCATE_FLEX and ALLOCATE_ARRAY.
Fix #457.
2017-10-08 09:45:06 -07:00
fec54d5021 Avoid undefined pointer difference behavior.
Fix #458.
2017-10-08 09:42:35 -07:00
eba0b97aa2 Merge pull request #472 from KyleCharters/master
Add Num .round
2017-10-06 07:51:55 -07:00
8963a870ff Abort all fibers along a call chain when one aborts. 2017-10-06 07:39:00 -07:00
0f19984017 Merge branch '201703_bubble_exceptions' of https://github.com/JonesAndrew/wren into JonesAndrew-201703_bubble_exceptions 2017-10-06 06:58:27 -07:00
61f5e56e93 Merge pull request #460 from skybrian/fixcomment
Remove obsolete comment
2017-10-05 06:51:48 -07:00
2bb531d860 Tweak Fiber.error docs. 2017-10-05 06:50:45 -07:00
84f2252c68 Add Num .round 2017-09-20 20:27:02 -04:00
16bab57056 fix #468 2017-09-16 21:38:35 -07:00
a7418d64e6 Remove obsolete comment 2017-05-29 12:02:50 -07:00
d390e16a99 Kill duplicate test.
Fix #438.
2017-04-08 12:53:33 -07:00
7aa3fc1ce7 Merge pull request #435 from Nelarius/vs
Modernize the Visual Studio solution
2017-04-08 12:48:47 -07:00
6ccdc0cf19 Merge pull request #443 from nathanhourt/nathanhourt-typo-fixes
One more typo fix
2017-04-08 12:40:31 -07:00
889cae5ff1 Free imported module source strings after compiling them.
Fix #430.
2017-04-08 12:38:36 -07:00
e9896544c8 Typo fix: is only be -> will only be 2017-04-04 15:29:53 -05:00
a6424e94b1 Merge pull request #440 from nathanhourt/patch-1
Fix typos in documentation
2017-04-04 07:07:57 -07:00
7d631276cb Catch errors in the first try() 2017-03-30 21:57:29 -04:00
a01b8d12bd Typo fix: askes -> asks 2017-03-30 20:20:02 -05:00
8f14bfb4b8 Fix typo in Num documentation
The documentation for the bitwise or operator described the behavior of the bitwise and operator.
2017-03-30 17:45:12 -05:00
21b4032fae Remove Visual Studio 2013 solution 2017-03-28 22:06:03 +03:00
a32f54126b Add Visual Studio 2017 solution 2017-03-28 22:05:58 +03:00
417ed7aeed Add wren.hpp. 2017-03-25 10:05:33 -07:00
b32c445f96 Show constructing "blondie" instance in functions doc.
Fix #432.
2017-03-23 21:22:07 -07:00
44a95e65c6 Set the token type after an invalid character error.
Otherwise, it still has the previous token's type. This can cause it
to get stuck in a loop in some places in the compiler.

Fix #428.
2017-03-23 21:19:20 -07:00
02bcefcbe4 Add test for user data.
Also moved the VM parameter in the error callback to be first like it
is in other callbacks.
2017-03-22 07:26:19 -07:00
907db83e1c Merge branch 'user-data' of https://github.com/foobit/wren into foobit-user-data 2017-03-22 07:12:26 -07:00
8d313be3ce Make it an error to skip or take a negative count. 2017-03-15 07:22:44 -07:00
9f93119377 Merge branch 'take_and_skip' of https://github.com/bjorn/wren into bjorn-take_and_skip 2017-03-15 07:15:00 -07:00
c84b8109a4 Tweak comments. 2017-03-15 07:10:23 -07:00
627e9edc23 Merge branch 'fix362' of https://github.com/bytemaster/wren into bytemaster-fix362 2017-03-15 07:09:31 -07:00
9efb18bae2 Typo: "seperator" -> "separator". 2017-03-15 07:06:07 -07:00
9fcdf3dc0a Merge branch '201703_split_replace' of https://github.com/JonesAndrew/wren into JonesAndrew-201703_split_replace 2017-03-15 07:04:56 -07:00
32aa43d1df Split and replace in wren. 2017-03-07 21:15:06 -05:00
860e596b8a Test wrenSetSlotNull(). 2017-03-03 07:57:50 -08:00
f14d13a6bf Mention libm in docs. 2017-03-02 07:17:03 -08:00
22ae382ac5 Proofread configuring the VM. 2017-02-12 14:58:16 -08:00
18f8f48bb6 Docs for configuring the VM. 2017-02-12 11:04:38 -08:00
996a607026 More work on embedding docs.
- Revise the earlier pages and tighten them up some.
- Write the docs for foreign methods.
2017-02-12 10:14:37 -08:00
f5d9443d0a Added Sequence.take and Sequence.skip
These lazy iterator producing methods are useful when working with
arbitrary sequences and you need to skip or take some number of elements
at the start.
2017-02-10 21:43:59 +01:00
4fe3ad3f8b Docs for Num.log and Num.pow(). 2017-01-20 07:24:46 -08:00
3faec25c4c Merge branch 'num-features' of https://github.com/underscorediscovery/wren into underscorediscovery-num-features 2017-01-20 07:20:55 -08:00
cdce553f5a fixed new api issue in cli 2017-01-19 22:58:52 -05:00
dc2f2d9e41 support for user defined state data associated with the WrenVM object 2017-01-19 22:54:25 -05:00
c6eb0be990 Remove the negative number tests for bitwise not.
They were inadvertently relying on undefined behavior in C and we get
different results on some compilers.

Until we decide how we want the operation to behave, for now, just
leave it unspecified.
2017-01-12 22:17:33 -08:00
d301fefac2 Add a comment explaining the ci targets. 2017-01-12 21:55:35 -08:00
5ddd783ff5 Use strtoll() for hex literals to handle 64-bit ones even on 32-bit. 2017-01-12 21:53:21 -08:00
0cc00c41c0 Simplify test runner output a little. 2017-01-12 21:38:06 -08:00
33a73ef1d5 Avoid using fpclassify() to detect infinity and nan.
It's not supported in C++98. Instead, use isnan() and isinf(), which
seem to work? If nothing else, they are used elsewhere in Wren, so if
we're not going to use them here, we should fix the other places too.
2017-01-12 21:34:11 -08:00
e8dfb1bf10 Don't test bitwise operations on operands that don't fit in u32.
The current behavior is undefined in C when converting the double to a
u32, so the tests fail on some compilers. For now, I'm just removing
those parts of the tests because I'm not sure what I want the behavior
to be. Modulo? Truncate? Runtime error?
2017-01-12 21:32:50 -08:00
252265c80b Merge branch 'travis-build-configurations' of https://github.com/iwillspeak/wren into iwillspeak-travis-build-configurations 2017-01-12 20:19:52 -08:00
f03647cbf0 Merge branch 'gc-32-bugfix' of https://github.com/iwillspeak/wren into iwillspeak-gc-32-bugfix 2017-01-12 18:53:14 -08:00
479ca7ec6d Improve explanation of single-expression blocks.
Fix #390.
2017-01-12 11:05:03 -08:00
0a2bc4a8a7 More copy editing. 2017-01-12 07:11:01 -08:00
fc6a7e5d18 Tweak some docs a little. 2017-01-12 07:10:19 -08:00
a9f49b89a4 Fix Bug in GC Reallocation Calculation
Updates the way we calculate thenext GC to make sure that we're not
already past the threshold. This was causing endless garbage collections
on 32 bit builds in `test/language/deeply_nested_gc.wren`.
2016-12-29 17:53:27 +00:00
04a7c9b5c8 Improve Travis Build & Test Coverage
Build Wren for more targets, and run the test suite on both 32 and 64
bit builds.

 * Update the build config to test both with and without NAN_TAGGING
   defined.

 * Updatest `util/test.py` to take the executable suffix as a
   parameter. This allows the makefile to control which binaries will be
   tested.

   Adds a new target to the makefile to be run by travis, this runs the
   test suite against all of the configurations it builds.

 * Gcc on some 32 bit platforms was complaining about numeric overflows
   when -INFINITY was used. Update the logic for converting a double to
   a string to not explicitly check against the literal values.

 * Make CI builds run the tests on both 64 _and_ 32 bit builds.

 * If I limit the number of CPUs on my MBP I can get some of the tests
   to time out, I'm imagining that the specs of the Travis Macs means
   that the same is happening there too. Updated the test script to
   allow an extra few seconds for the test to complete successfully
   before killing it.

 * Due to slight differences in accuracy in some computations tests were
   failing on 32 bit builds. Stop comparing things quite as exactly in
   the cases where it is causing issues.

   For some reason 12.34 was refusing to compare equal to itself. Bad
   show 12.34 :-/. I've also updated the test so it doesn't leak handles
   even if the assertions fail.

 * Double-cast from `double` to `uint32_t` to prevent undefined
   behaviour on overflow of basic integers. This should hopefully
   prevent 32 bit test failures on Linux.

 * Move to a version of LibUV with a fix for the 32 bit build error on
   Travis.
2016-12-29 17:52:38 +00:00
cefb50f944 Fix Bug in GC Reallocation Calculation
Updates the way we calculate thenext GC to make sure that we're not
already past the threshold. This was causing endless garbage collections
on 32 bit builds in `test/language/deeply_nested_gc.wren`.
2016-12-29 17:52:38 +00:00
b9f53f71fb Reset API stack a fiber is aborted from wrenCall(). 2016-11-01 08:40:16 -07:00
51e50e6cc4 Free libuv data before resuming after an error. 2016-11-01 08:39:30 -07:00
a2868913c5 Add .log to Num 2016-10-31 17:22:32 -02:30
955e92761d Add .pow(_) to Num 2016-10-31 17:22:13 -02:30
2650794340 Update AUTHORS 2016-10-31 17:21:55 -02:30
a3aaad83ea Fix bug #362 calling Foreign methods
I assume that invoking callForeign that the apiStack should be restored
to it's original value, rather than reset to NULL.
2016-10-26 13:51:29 -04:00
57f34fab95 Fix assignment test. 2016-10-08 10:51:19 -07:00
e7cabbb5e4 Reset the API stack after a foreign constructor returns. 2016-08-28 08:23:27 -07:00
d331cbf43d Ensure macro parameter is parenthesized. 2016-08-27 21:44:39 -07:00
b59eeaf2d1 Support "--version" in the CLI to print the version. 2016-08-27 17:38:14 -07:00
09ef904d32 Use DBL_MIN instead of DBL_EPSILON for Num.smallest. 2016-08-27 17:25:32 -07:00
b8b0f36521 Merge branch 'num-properties' of https://github.com/Nelarius/wren into Nelarius-num-properties 2016-08-27 17:18:21 -07:00
0a4f1b370c Revise embedding docs a bit. 2016-08-26 07:11:50 -07:00
a8cf1c9d71 Const correct a couple of functions.
Thanks, Michel!
2016-08-16 07:43:54 -07:00
febb1b0437 Use a map to check for constant collisions.
Doing an O(n) lookup was too slow.
2016-08-16 07:43:34 -07:00
08eceb7382 Check for duplicates when adding constants.
This saves a little memory, but, more importantly, allows us to support
functions with large numbers of repeated constants.
2016-08-16 07:24:04 -07:00
6ee1743429 Update Num class doc 2016-08-04 21:17:45 +03:00
50fa77356e Add largest, smallest properties to Num class 2016-08-04 21:15:55 +03:00
500c7b0426 Add List constructors to docs. 2016-08-04 06:28:41 -07:00
3666eae013 Tweak new list constructors.
- Remove List.new(_). I was convinced by the issue discussion that
  using it is probably a bad idea. We don't want to encourage more nulls
  in the world than there are already are. So let's see if we can live
  without it and just have List.filled(). That way users think about
  what they're creating a list *of*.
- Added some more tests.
- Correctly handle being given a negative size.
2016-08-03 22:42:31 -07:00
3de394e8a1 Merge branch 'new-list-constructors' of https://github.com/mooxen/wren into mooxen-new-list-constructors 2016-08-03 22:34:08 -07:00
6845328661 Tweak String.indexOf(_,_) a bit.
- Simplify the arithmetic a little in wrenStringFind().
- Allow the start to be negative.
- Even more tests.
- Docs.
2016-08-03 22:19:34 -07:00
e5dce527ac Merge branch 'string-indexof-startindex' of https://github.com/underscorediscovery/wren into underscorediscovery-string-indexof-startindex 2016-08-03 21:51:46 -07:00
83bb043327 Merge branch 'forgotten-bytecode' of https://github.com/minirop/wren into minirop-forgotten-bytecode 2016-08-03 21:45:09 -07:00
60a0353a27 Tweak list C API:
- Rename "size" -> "count" to be consistent with other usage.
- Remove "Slot" from the function names, since that's implicit.
- Make the getListElement() just move the element to another slot. This
  matches other APIs where we distinguish accessing a value and
  converting it to some specific type.
2016-07-28 08:06:36 -07:00
b8675e2d91 Merge branch 'get_slot_list_values' of https://github.com/dradtke/wren into dradtke-get_slot_list_values 2016-07-28 07:53:19 -07:00
244faa5700 renamed filler constructor in list to match issue 2016-07-17 12:24:19 +10:00
45d9794476 added extra arguments to list constructors for default size/ value 2016-07-17 12:01:50 +10:00
1f84a10f44 Implement String indexOf(needle, startIndex) 2016-07-14 01:23:01 -02:30
193d102952 missed bytecode name refactoring 2016-07-12 22:59:02 +02:00
d192a9a02d Add doc mention of new Num properties 2016-07-10 23:26:23 +03:00
817a5650fe Add highest, lowest, epsilon properties to Num class 2016-07-10 22:54:34 +03:00
5418e4f8f3 Add MapEntry to core to let maps be directly iterated.
Fix #372.
2016-07-06 07:17:07 -07:00
fcfb053dc1 Merge branch 'verbose-make' of https://github.com/bfontaine/wren into bfontaine-verbose-make 2016-07-06 06:51:12 -07:00
d7524898dc Merge pull request #376 from paulsapps/master
Fix build, return false instead of NULL
2016-07-06 06:46:35 -07:00
5468d6d033 Fix build, return false instead of NULL 2016-07-02 12:40:00 +01:00
b41a0f7c07 Allow builds to be verbose
It’s impossible to disable @s in Makefiles to get a verbose build.
Adding them conditionally using a variable lets users choose if they
want a verbose build by using the VERBOSE variable.

Normal build:

    make

Verbose build:

    make VERBOSE=1
2016-07-02 11:21:47 +02:00
0837917307 Use a hash function for numbers that doesn't tend to zero low bits.
Just pulling the raw words out of a double means integers often map to
hashes with zero low bits. Then when we map that to an entry in the map,
all small integers end up in entry zero, leading to tons of collisions.

This mixes the bits around some like Java does to fix that.

Makes the map_numeric benchmark about 18% faster on my machine. On a
contrived benchmark that just uses keys up to 1000, this makes it 52x
(yes, *times) faster.
2016-06-27 08:13:45 -07:00
4e94195f26 Properly handle tombstones when inserting items into a map.
Previously, you could get into a state where a key was present in the
map, but after a tombstone in the probe sequence. If they key was added
again, it stopped at the first tombstone and added it there, resulting
in the key being in the map multiple times.

Fix #373.
2016-06-27 07:14:52 -07:00
bc29f43bbd Allow hosts with no module loader to still load optional modules.
If the host doesn't set a loadModuleFn at all in the config, it should
still be able to load random, meta, etc.
2016-06-27 07:08:08 -07:00
9c3163d533 Only reset the TTY if we created the stdin stream. 2016-06-09 19:16:41 -07:00
6ece314863 Reset the TTY before closing the underlying stdin stream. 2016-06-09 19:16:41 -07:00
33cf8f7b31 Fall back to a simpler REPL if it seems like ANSI escapes won't work. 2016-06-09 19:16:41 -07:00
f47e128978 Tab-completion in REPL based on module variables. 2016-06-09 19:16:41 -07:00
98514188b0 More shortcuts:
- Ctrl-B: Move cursor left.
- Ctrl-F: Move cursor right.
- Ctrl-K: Delete everything after cursor.
- Ctrl-L: Clear screen.
- Ctrl-U: Clear line.
- Ctrl-N: Next in history.
- Ctrl-P: Previous in history.
2016-06-09 19:16:41 -07:00
2ba264bc29 Add history to REPL. 2016-06-09 19:16:41 -07:00
bc7f1de758 Execute input in the REPL.
Guesses whether the input is an expression or statement and handles it
appropriately. Finally, after over a year, the Wren REPL automatically
prints "3" if you type in "1 + 2". \o/
2016-06-09 19:16:41 -07:00
689cd42269 Start writing the REPL in Wren.
It doesn't actually execute code yet, but it:

- Supports left and right arrow keys for moving the cursor.
- Ctrl-C, Ctrl-D, Ctrl-A, and Ctrl-E for navigating.
- Syntax highlights the line (!).

The next step is to do a rough parse so that we can tell if the line
is an expression, statement, or needs more input. That will tell us
whether we need to interpret it at the top level (statement) and not
worry about a result, evaluate it as an expression and print the result,
or read more lines.
2016-06-09 19:16:41 -07:00
59e9eb127e Add wrenAbortFiber().
Thanks, @underscorediscovery!
2016-06-09 19:14:21 -07:00
8657a42c21 Merge pull request #366 from underscorediscovery/patch-2
fix range docs to introduction
2016-05-27 07:23:41 -07:00
78deace9a4 Merge pull request #365 from underscorediscovery/patch-1
docs; iterator protocol link relative to core/ not modules/
2016-05-27 07:23:07 -07:00
2b0878ec6d Platform.isWindows. 2016-05-21 12:53:21 -07:00
6002cc4d65 Add Stdin.isTerminal. 2016-05-21 12:51:11 -07:00
06731f66d4 Add a Platform class.
- Rename the "process" module to "os".
- Add Platform to it.
- Static "name" method.
- Static "isPosix" method.
- Docs and tests!
2016-05-21 12:44:17 -07:00
6bcc64eb61 Wren 0.1.0!
There's nothing new in this "release", but now is as good a time as any
to start versioning. Going forward, I plan to do periodic releases and
update the changelog so users can see what's going on.
2016-05-21 10:53:05 -07:00
0a060a9678 WrenValue -> WrenHandle. 2016-05-20 20:55:28 -07:00
5a8cacfbe4 fix range docs to introduction
Is that the link that was intended?
2016-05-21 00:24:41 -02:30
b57fd6431a iterator protocol relative to core/ not modules/ 2016-05-21 00:21:47 -02:30
5d98d20175 Add Stdin.isRaw. 2016-05-20 15:19:18 -07:00
500dd41ccd Add Stdin.readByte(). 2016-05-20 11:50:14 -07:00
872cfdcd42 Mention the subreddit on the community docs.
Fix #360.
2016-05-20 10:02:57 -07:00
1d252d1970 First draft of docs for calling Wren from C. 2016-05-19 16:01:54 -07:00
cf258b9074 Add support for retrieving list values from a slot
This PR adds support for retrieving list information from a slot. Rather
than take the whole list, two different methods are provided for
retrieving a) the length of the list, and b) a specific value in the
list.
2016-05-19 14:11:48 -05:00
d64af5d6a5 Fix output formatting in Firefox. 2016-05-19 09:30:38 -07:00
befe90501b Start writing comprensive embedding docs.
- Break embedding out into a separate section with multiple pages.
- Document the constraints on the API.
- Document the slot array and WrenValue.

Still lots more to do, but getting there...
2016-05-16 08:09:14 -07:00
856390c3fa Merge pull request #357 from hoop33/master
Fix typo
2016-05-04 13:29:59 -07:00
23b5dc25de Fix typo 2016-05-04 13:17:20 -04:00
2ce5913501 Correctly count subscript parameters in wrenMakeCallHandle().
Fixes #351.
2016-05-04 06:29:44 -07:00
3b7446738c Merge pull request #354 from ElFeesho/master
Fix typos and re-word explanation of gc heapGrowthPercentage
2016-05-03 12:27:16 -07:00
2f066f0b66 Merge pull request #355 from hoop33/master
Fix typo
2016-05-03 12:26:39 -07:00
d4662ebdfc Fix typo 2016-05-03 14:43:59 -04:00
0c1fc15e3c Fix typos and re-word explanation of gc heapGrowthPercentage 2016-05-03 18:48:08 +01:00
33ce3677f3 Merge pull request #353 from radarhere/patch-1
Fixed typo
2016-05-03 10:19:10 -07:00
05cc248b00 Fixed typo 2016-05-04 00:16:02 +10:00
94eb22cd9d Merge pull request #348 from crimsun/patch-1
Clarified grammatical inversion
2016-05-02 21:54:42 -07:00
020b1b7661 Merge branch 'master' of https://github.com/munificent/wren 2016-05-02 16:23:56 -07:00
66e7def128 Style nits. 2016-05-02 16:23:52 -07:00
1f37068b39 Oops, correct year that C++ was standardized. 2016-05-02 16:23:08 -07:00
2132f15f9e Clarified grammatical inversion 2016-05-02 02:39:11 +04:30
18b638b797 Merge pull request #347 from ianmackenzie/patch-1
Fix small typo in method call documentation
2016-04-15 10:13:54 -04:00
95da4f90b9 Fix small typo in method call documentation 2016-04-15 15:16:24 +10:00
694186810b Test that multiple closures of the same code are unequal. 2016-03-26 14:22:38 -07:00
6dc4286ffa Always wrap functions in closures.
This has a couple of pros:

- It simplifies some code that used to have to check whether a called
  thing is a bare function or a closure.
- It's faster because we don't need to do the above checks every time
  something is called.
- It lets us more precisely type some fields that used to be Obj*
  because they could hold an ObjClosure* or ObjFn*.

The cost is that we allocate a closure every time a function is
declared, even if it has no upvalues. Since functions are called way
more often than they are declared, this is still a net win.

On my Mac laptop:

api_call - wren            0.06s 0.0020 104.73%
api_foreign_method - wren  0.32s 0.0040 101.89%
binary_trees - wren        0.23s 0.0057  98.82%
binary_trees_gc - wren     0.79s 0.0170  98.46%
delta_blue - wren          0.13s 0.0031 101.36%
fib - wren                 0.23s 0.0038 103.15%
fibers - wren              0.04s 0.0017  98.97%
for - wren                 0.08s 0.0017 107.81%
method_call - wren         0.12s 0.0024  98.60%
map_numeric - wren         0.31s 0.0052 103.93%
map_string - wren          0.11s 0.0113  97.97%
string_equals - wren       0.20s 0.0023 107.75%
2016-03-26 14:00:17 -07:00
a5f95b90e9 Lazy load optional libraries and let the host override them. 2016-03-17 07:49:43 -07:00
984fa1ddd1 Use errorFn for runtime errors. 2016-03-17 07:17:03 -07:00
66b7acd862 Remove unneeded includes. 2016-03-17 07:04:09 -07:00
c5855a6fe9 Squashed commit of the following:
commit f93ec6430f9629b5a28765a3961379d1e8296e50
Author: Bob Nystrom <robert@stuffwithstuff.com>
Date:   Wed Mar 16 08:03:25 2016 -0700

    Tiny tweaks.

commit 332a08fe33cddffec82dbd377ee0c941a0066f64
Merge: a673981 14b7a08
Author: Bob Nystrom <robert@stuffwithstuff.com>
Date:   Wed Mar 16 08:01:00 2016 -0700

    Merge branch 'errorFn' of https://github.com/ppvk/wren into ppvk-errorFn

commit 14b7a086ce
Author: Paul VanKeuren <paul.vankeuren@gmail.com>
Date:   Tue Mar 15 11:33:37 2016 -0500

    missing semicolon, accessing vm through parser in

commit 924eaa1f9d
Author: Paul VanKeuren <paul.vankeuren@gmail.com>
Date:   Tue Mar 15 11:25:32 2016 -0500

    fixed missing errorFn in wren.h

commit 3761df111f
Author: Paul VanKeuren <paul.vankeuren@gmail.com>
Date:   Tue Mar 15 11:23:51 2016 -0500

    Added an errorFn to the CLI

commit d51137b4ab
Author: Paul VanKeuren <paul.vankeuren@gmail.com>
Date:   Tue Mar 15 11:21:16 2016 -0500

    Added a WrenErrorFn typedef, an errorFn slot in WrenConfiguration.  exits early if  is not defined, otherwise it runs the errorFn .
2016-03-16 08:04:03 -07:00
a6739819b2 Report undefined variable errors on the line where they are used.
This also more importantly ensures the error message for one has a
bounded length even if the variable name is pathologically long.
2016-03-16 08:00:28 -07:00
1478d6b7e2 Add a few comments. 2016-03-16 07:27:03 -07:00
6f0ee7e52b Merge branch 'master' of https://github.com/RallyTronics/wren into RallyTronics-master 2016-03-16 07:23:24 -07:00
678051c5e1 Tweak makefile formatting. 2016-03-16 07:22:18 -07:00
676f4e1037 io.c fixes to build in Visual Studio 2016-03-15 14:52:09 -06:00
8c79501738 Fix windows build 2016-03-16 00:37:23 +09:00
38699e3a81 Rearrange the code a bit for duplicate method detections. 2016-03-15 07:15:55 -07:00
c1cea30131 Merge branch 'no-duplicate-methods' of https://github.com/Qard/wren into Qard-no-duplicate-methods 2016-03-15 06:54:49 -07:00
001db02c81 Remove unused DUP opcode. 2016-03-13 22:11:21 -07:00
6dfbea1ea4 Don't use generic function for finding method duplicates and add tests 2016-03-12 19:14:19 -08:00
4cc3afd38b Fix and optimize duplicate method check 2016-03-12 18:29:44 -08:00
3fd151036c Forbid duplicate methods 2016-03-12 18:29:43 -08:00
22a95265f2 Simplify the formatting used to print compile errors.
Avoids using multiple calls to fprintf() to print a single compile
error. This should make it easier to allow the host to provide a
callback function to print errors.
2016-03-11 21:30:54 -08:00
5be9377d93 Simplify shebang parsing. 2016-03-11 17:23:31 -08:00
485e91ab05 Redo metrics script. 2016-03-07 07:56:44 -08:00
fb0e01bfe9 Fix some nits in the FAQ. 2016-03-07 07:41:00 -08:00
139b447898 Compile functions in place instead of copying when done.
The compiler used to maintain all of the data that defines a function,
which it incrementally built up. Then, when it was done, it copied all
of that to a new ObjFn. In theory, that was to trim down some memory
and avoid unneeded fields in ObjFn.

In practice, the performance benefit is negligible and the memory saving
is nullified by the fact that it copies anyway.

This moves all of that mutable state directly into ObjFn. The compiler
creates a new empty ObjFn at the beginning and then just fills it in
in place.

This shaves off about 40 lines of code, is simpler, and doesn't seem to
impact perf.
2016-03-04 07:49:34 -08:00
f2f779d3b8 Fix bug with the compiler root not being popped. 2016-03-03 17:48:47 -08:00
a3505fa060 Simplify runtime error reporting. 2016-03-03 17:11:52 -08:00
9fda7cb526 Unify Fiber.try() with the other methods to execute fibers. 2016-03-03 17:00:33 -08:00
d717ddf817 Simplify how assignment expressions are compiled. 2016-03-03 16:30:48 -08:00
84bcb5801c Add a test for creating a VM without a config. 2016-03-03 14:31:47 -08:00
41e30f47d8 wrenNewVM NULL check
My first attempt to embed VM in project ended with crash. Fortunately I'm not so easly scared and managed to found out that despite comment in "wren.h" no check for null is performed. I took the liberty of fixing that. 
Btw. nice project, keep up the good work!
2016-03-03 17:58:50 +01:00
223d66a01c I can spell gooder. 2016-02-27 16:23:48 -08:00
0a83697bd4 Minor janitorial work. 2016-02-27 16:05:50 -08:00
1e4b9e5175 File.realPath().
Not tested yet, because we can't create symlinks from Wren and I don't
want to check symlinks into the repo, but it seems to do the right
thing.
2016-02-27 15:53:02 -08:00
e6b48de598 Fix precedence table in docs.
It was out of sync with the actual implemented precedence in a few
places.
2016-02-27 10:14:09 -08:00
fa2598c601 Upgrade to libuv 1.8.0. 2016-02-27 09:19:56 -08:00
b7e189fe11 Desugar import statements to core library calls.
This is simpler than having special opcodes for them. It's also a bit
faster, and gets some non-critical code out of the interpreter loop.

Also, this is good prep work for being able to write some of the module
loading process in Wren to make things more flexible for embedders and
the CLI.
2016-02-26 22:43:54 -08:00
edca85827a Combine block() and statement().
The separation between the two didn't really do anything useful.
2016-02-25 07:04:48 -08:00
d46dfc9500 Allow "*" on lists and strings to repeat them.
This is not implemented on Sequence because, at least for lists and
strings, I think users expect an eager result. Multiplying a string
should give you back a string, not a lazy sequence of repeated
characters.

This also mirrors "+" on strings and lists, which is eager. I like the
idea of having a general guideline that operators are eager.

Repetition is useful for arbitrary sequences, but for that maybe we
should add a "repeat()" method.
2016-02-24 07:48:03 -08:00
919605b7ba Couple of tiny tweaks. 2016-02-24 06:52:12 -08:00
2c4e497c54 Fix a couple of doc bugs. 2016-02-22 07:48:53 -08:00
60162575ee More file system checking functions:
- Stat#isFile
- Stat#isDirectory
- Directory.exists()
- File.exists()
2016-02-21 12:23:33 -08:00
c6148f8941 Make Stat a foreign class.
Instead of copying the uv_fs_stat struct to a list of Wren numbers, we
store it directly in the Stat object. This is important because we'll
need to implement later methods like isDirectory() in C so we can use
S_ISDIR(). For that, we need to have access to the original stat data.
2016-02-21 11:34:10 -08:00
b331915259 Add stat instance method to File. 2016-02-21 10:18:45 -08:00
3101d9c499 Fix file flags to be OS-independent. 2016-02-20 17:25:41 -08:00
ff96a179ac Include stdio.h when debugging is enabled. 2016-02-20 13:36:22 -08:00
8e90e3577b More file IO!
Can now create, delete, and write to files.
2016-02-20 09:23:42 -08:00
bec5181bdb Add separate targets for building just the shared or static library.
make static
make shared

Running "make vm" will build both, as usual.

Fixes #322.
2016-02-19 07:22:10 -08:00
ef3aa07d84 Add API to get the type of object in a slot. 2016-02-19 07:18:00 -08:00
fa0a507b48 Error on jump distance overflow. 2016-02-19 06:57:38 -08:00
5b7cd12e76 Don't run the skynet example from the tests.
It's too slow on the Travis bots and times out.
2016-02-14 22:28:14 -08:00
b8e85c83a8 Fix test and add skynet example. 2016-02-14 22:21:50 -08:00
d823896136 Merge branch 'master' of https://github.com/munificent/wren 2016-02-14 22:18:53 -08:00
1a6d3703d2 Merge pull request #320 from 4d47/small-doc-update
Fix two small code samples in doc
2016-02-12 10:35:40 -08:00
edbffc9a95 Simplify method() and defineMethod().
Passing along a Variable lets us get rid of some duplicate code around
loading the class.
2016-02-12 07:43:44 -08:00
68f801a525 Unnecessary strncmp -> memcmp. 2016-02-12 07:27:42 -08:00
5b5c258f55 Make a little Variable struct.
Gets rid of the slightly ugly loadInstruction output parameter that
gets passed around. Now a reference to a variable is a first-class
concept in the compiler.
2016-02-12 07:16:41 -08:00
ff69b12c2c Fix sample in doc/site/error-handling
Add missing constructor.
2016-02-11 18:06:51 -05:00
a2e03279e2 Fix abs code sample in doc/site/modules/core/num
-123.abs returns -123 because the dot has higher precedence so it's
 really -(123.abs).
2016-02-11 17:58:09 -05:00
68ab4e88c0 Merge branch 'master' of https://github.com/munificent/wren 2016-02-09 07:24:55 -08:00
8b36e2f00b Add sample(_) and sample(_,_) to Random. 2016-02-09 07:24:45 -08:00
895136b78c Merge pull request #319 from 4d47/small-doc-update
Update wrenInterpret doc/site/embedding-api
2016-02-08 17:43:05 -08:00
82307232cc Update wrenInterpret doc/site/embedding-api 2016-02-08 08:34:56 -05:00
d4a4b26203 Add Random.shuffle(). 2016-02-07 10:38:39 -08:00
79558d95e5 Move File.stat() -> Stat.path().
Thanks, Michel!
2016-02-07 09:56:16 -08:00
ffb5ada9fb Move the community docs to the wiki. 2016-01-24 15:39:35 -08:00
fde6cfc142 Generate wrenAllocateForeign() to match the other setSlot methods.
Thanks, Michel!
2016-01-24 09:25:04 -08:00
71e2458a6c Add API for accessing command-line arguments.
- Add process module with Process class.
- Add "arguments" and "allArguments" methods.
- Docs for same.
- Support passing additional arguments to command line.
- Add "--help" support to command line.
2016-01-22 07:57:26 -08:00
860220869a Oops. Completely disable lto. 2016-01-22 07:01:56 -08:00
f19888d328 Merge branch 'master' of https://github.com/munificent/wren 2016-01-22 06:42:16 -08:00
7e8bc2a89a Disable link-time-optimization for now.
It's failing when building with clang on Travis. The underlying problem
seems to be something broken with how LLVM is looking for the gold
linker, and working around that is outside of my skillset.

To learn more, Google: "LLVMgold.so: error loading plugin" lto
2016-01-22 06:42:01 -08:00
056ae61493 Tweak some docs. 2016-01-21 21:38:27 -08:00
46a03e3a2d Merge pull request #318 from pra85/patch-1
Update license year range to 2016
2016-01-21 15:20:58 -08:00
39b29ee07a Enable link time optimization in the CLI.
One little compiler flag makes a surprisingly large difference:

api_call - wren            0.05s 0.0017 130.52% relative to baseline
api_foreign_method - wren  0.24s 0.0017 144.54% relative to baseline
binary_trees - wren        0.21s 0.0032 112.27% relative to baseline
binary_trees_gc - wren     0.75s 0.0288 115.02% relative to baseline
delta_blue - wren          0.13s 0.0031 103.24% relative to baseline
fib - wren                 0.20s 0.0036 120.56% relative to baseline
fibers - wren              0.04s 0.0007 108.52% relative to baseline
for - wren                 0.07s 0.0009 124.45% relative to baseline
method_call - wren         0.12s 0.0010  95.58% relative to baseline
map_numeric - wren         0.30s 0.0031 110.11% relative to baseline
map_string - wren          0.11s 0.0098 111.38% relative to baseline
string_equals - wren       0.19s 0.0064 115.49% relative to baseline
2016-01-20 07:47:00 -08:00
205661713a Update license year range to 2016 2016-01-17 23:28:25 +05:30
f9d1e9954a Make File.stat() directory test less file system sensitive. 2016-01-05 07:32:51 -08:00
94208647ab Test File.stat() on a directory. 2016-01-01 10:05:31 -08:00
5cd8a06fa0 File.stat(). 2016-01-01 09:58:44 -08:00
b054526df8 Add an optional offset to File.readBytes(). 2015-12-30 08:13:19 -08:00
6e2ec92e0d Fix parameter format in docs. 2015-12-29 22:35:14 -08:00
452cc88082 Fix a few typos in the docs. 2015-12-29 22:29:13 -08:00
8854dfb07e Docs for the io module! 2015-12-29 21:56:44 -08:00
678251a00c Fix type for fileFinalizer(). 2015-12-29 21:07:26 -08:00
2c31985e54 Make Directory.list() create and return a list from C. 2015-12-29 08:37:47 -08:00
e0ac88c22a Revamp wrenCall to work with slots.
Now, you call wrenEnsureSlots() and then wrenSetSlot___() to set up the
receiver and arguments before the call. Then wrenCall() is passed a
handle to the stub function that makes the call. After that, you can
get the result using wrenGetSlot___().

This is a little more verbose to use, but it's more flexible, simpler,
and much faster in the VM. The call benchmark is 185% of the previous
speed.
2015-12-29 07:58:47 -08:00
ed6fad6153 Get rid of fiber for finalizers.
Instead, finalizers just get access to the foreign object's raw bytes.
This is deliberately limiting, since it discourages the user from
interacting with the VM in the middle of a GC.
2015-12-28 08:06:29 -08:00
a447b66380 Make slots available to the API outside of foreign methods.
At any point in time, the user can call wrenEnsureSlots() which will
implicitly create a fiber and point to its stack if needed.
2015-12-28 07:49:47 -08:00
a09892de32 Use a fiber for a finalizer's foreign stack. 2015-12-27 21:43:08 -08:00
9512ce74c3 Merge branch 'master' into api
# Conflicts:
#	src/module/io.c
2015-12-26 20:42:53 -08:00
fbc76cdc05 Fix C++ compile error in Directory.list(). 2015-12-26 20:26:05 -08:00
5b90896fa8 Print object type for unknown object error.
Thanks, Michel!
2015-12-26 20:15:00 -08:00
a5dc5e8390 Sort cases alphabetically.
Thanks, Michel!
2015-12-26 20:13:39 -08:00
4ad4953196 Fix typo.
Thanks, Michel!
2015-12-26 20:12:35 -08:00
8ab329ff91 Make wren.mk log wren_to_c_string.
Thanks, Michel!
2015-12-26 20:11:48 -08:00
8203baf7bd Initialize match in the test script.
Thanks, Michel!
2015-12-26 20:08:20 -08:00
1d16e85a85 Add an API to load a top-level variable into a slot. 2015-12-26 10:53:14 -08:00
0ac793d4f8 Add Directory.list() to io. 2015-12-24 10:12:12 -08:00
15043b897f Add a benchmark for wrenCall(). 2015-12-23 17:29:53 -08:00
b7e62926ab Merge branch 'master' into api 2015-12-23 09:22:49 -08:00
1ebc711c30 Allow call and unary expressions as map keys. 2015-12-22 16:00:50 -08:00
6f3077d582 Fix off by one error in initial stack capacity. 2015-12-16 20:55:18 -08:00
910049cd19 Update the docs around slots. 2015-12-16 16:39:27 -08:00
6f37d379f4 Add C API functions for working with lists:
- wrenEnsureSlots()
  Lets you go the foreign slot stack to make room for a temporary work
  area.

- wrenSetSlotNewList()
  Creates a new empty list and stores it in a slot.

- wrenInsertInList()
  Takes a value from one slot and inserts it into the list in another.

Still need more functions like getting elements from a list, removing,
etc. but this at least lets you create, populate, and return lists from
foreign methods.
2015-12-16 16:28:26 -08:00
7fcdcf2f1a wrenReturn___() -> wrenSlotSet___().
This turns those functions into general-purpose functions for writing
raw C values into slots on the foreign call stack.

Writing a return just means writing a value to slot 0.
2015-12-16 13:00:13 -08:00
4b3c818ec5 Start moving embedding API towards "slot" register-API.
- wrenGetArgumentCount() -> wrenGetSlotCount()
- wrenGetArgument___() -> wrenGetSlot___()

Also, the get functions assert that the value is the right type instead
of checking at runtime. This puts the onus on the caller to be safe,
but maximizes performance.
2015-12-16 10:22:42 -08:00
55beda3ea9 Simplify the foreign call preamble a bit.
We don't need to store the number of arguments since we can calculate
it from the start and top of the stack.
2015-12-15 17:10:02 -08:00
01e8f9053e Add a benchmark to test the Wren C API.
I've got some ideas on how to tweak the embedding API, but I want to
see what performance impact they have first, so this adds a little
benchmark that just calls a foreign method a ton of times.
2015-12-15 16:02:13 -08:00
873926915f Don't allow fibers as map keys.
I hacked in support for it for a misguided reason (trying to fake
"thread-local storage") and ended up not using it for that anyway.
2015-12-15 10:42:21 -08:00
8d9feb4bc9 Fix typo in benchmark. 2015-12-15 10:37:53 -08:00
bcc40ab66a Clean up a few little things:
- Fix the instruction output when debug dumping code.
- Don't pass around the classCompiler since Compiler stores it.
2015-12-14 17:10:10 -08:00
e7d10218db Grow the stack as needed.
This is untuned for performance, but seems to be doing the right thing.
2015-12-14 08:00:22 -08:00
c7cd1fb1ac Track the maximum number of slots each function may use.
This is the first step towards dynamically grown stacks. We don't want
to check for stack overflow on every single push, so we store the max
number of slots a function might need and (in later patches) ensure
at function call time that that many slots are available.
2015-12-13 22:57:40 -08:00
2df5362ab2 Handle compile errors in imported modules. 2015-12-08 07:49:37 -08:00
bfa86b259a Ignore newlines in imports. 2015-12-07 19:41:10 -08:00
6ff5fb9ff2 Allow empty ranges at the end of a sequence. 2015-12-06 10:37:58 -08:00
10ece995f7 Add some Dart benchmarks running on fletch. 2015-12-05 11:09:30 -08:00
0f9e2a49ce Fix "%" in error message. 2015-12-05 10:15:18 -08:00
37b70db1b0 Make delta_blue more idiomatic Wren. 2015-11-30 20:58:08 -08:00
a38753d1d6 Add an animals guessing game example. 2015-11-29 09:43:47 -08:00
c46507d937 Fix .gitignore (and add incorrectly ignored file!) 2015-11-27 11:22:09 -08:00
cb0edd34b3 Remove VS intermediate locations from gitignore 2015-11-25 19:56:58 -05:00
2125471132 Addressing feedback
* Always include fcntl.h in io.c
* FileReqData -> FileRequestData
* Don't combine allocations
* Make output paths more consistent with the docs
2015-11-25 19:47:13 -05:00
2708b0c7ae Fix handleRequestError casting uv_fs_t::data to the wrong type 2015-11-25 12:43:50 -05:00
8d63667ce2 Store buffer info in uv_fs_t::data so we don't depend on a private libuv field for it 2015-11-25 12:43:50 -05:00
2d3a7ece40 Remove reference to timer.h, add reference to wren.h 2015-11-25 12:43:49 -05:00
f09e75c6e8 Update Visual Studio projects so we can build again 2015-11-25 12:43:19 -05:00
5454152dff Merge pull request #313 from acook/patch-1
Fixing a couple of typos in the classes docs.
2015-11-25 08:59:16 -08:00
69a5c1d017 Avoid empty array initializer which seems to be problematic on VC++. 2015-11-25 08:36:42 -08:00
5bde04db4c Eagerly evaluate interpolated expressions.
If we ever support custom string templates, we'll need to go back to
compiling them to functions. But, for now, they can be evaluated
eagerly, leading to simpler code.
2015-11-23 07:08:14 -08:00
fb72e0fff7 Document method scope. 2015-11-21 14:00:21 -08:00
03163a760f Document interpolation. 2015-11-21 09:20:50 -08:00
da3eac9a48 Fixing a couple of typos in the classes docs. 2015-11-20 12:56:27 -06:00
78655c68b0 Simple string interpolation.
This allows "%(...)" inside a string literal to interpolate the
stringified result of an expression.

It doesn't support custom interpolators or format strings, but we can
consider extending that later.
2015-11-11 07:55:48 -08:00
71575d9179 Switch to O3 for release builds.
It now seems to be fairly consistently faster on my machine:

binary_trees - wren     0.22s 0.0023 100.10% relative to baseline
binary_trees_gc - wren  0.85s 0.0160 112.63% relative to baseline
delta_blue - wren       0.12s 0.0044 102.91% relative to baseline
fib - wren              0.21s 0.0021 103.34% relative to baseline
fibers - wren           0.26s 0.0083 102.46% relative to baseline
for - wren              0.08s 0.0024 111.82% relative to baseline
method_call - wren      0.11s 0.0087  94.56% relative to baseline
map_numeric - wren      0.32s 0.0042 109.83% relative to baseline
map_string - wren       0.11s 0.0096 105.69% relative to baseline
string_equals - wren    0.19s 0.0028 110.00% relative to baseline
2015-11-10 07:33:15 -08:00
aaab14959f Get rid of extraneous "," in module macros.
Thanks, Michel!
2015-11-10 07:13:19 -08:00
de7b062a03 Tweak module docs a bit. 2015-11-09 07:42:48 -08:00
902289d7dd Document the "random" module. 2015-11-09 07:37:06 -08:00
82706b74fc Reorganize site to make room for documenting the other built-in modules. 2015-11-08 13:31:22 -08:00
8c0dae1320 Move precedence table to syntax page. 2015-11-08 10:59:23 -08:00
0bf5dc42ef Remove outdated docs. 2015-11-07 13:00:49 -08:00
7ae9888c4f It turns out "is" is just a normal overridable operator. Who knew? 2015-11-07 13:00:24 -08:00
931d9ca4d3 Reorganize the language guide.
- Rename "Expressions" -> "Method Calls".
- Organize "Types" and "Language" into a single linear narrative.
- Mobile-specific navigation to handle the longer guide.
- Rename "Fibers" -> "Concurrency".
- Get rid of duplicate stuff about signatures in "Classes".
- Add next/prev links to each page in the guide.
- Move "Contributing" and "Community" up to the top level.
- Move the precendence table to a separate "Grammar" page.
- Lots of other little stuff.
2015-11-07 11:09:04 -08:00
bbd6b827b5 Fix C++ compile errors. 2015-11-04 07:07:33 -08:00
2ff8acbe1a Tweak a few things in the new GC.
- Make sure it handles an empty gray set.
- Make sure growing the gray stack doesn't itself trigger a GC.
- Make sure it works when stress testing is enabled.
- Ensure the tests kick off a GC.
2015-10-29 07:38:09 -07:00
25bd182c58 Fix some typos and rename some functions.
Makes the tri-color abstraction more explicit throughout the code.
2015-10-28 07:55:04 -07:00
e3c9324dd9 Merge branch 'master' into iwillspeak-iterative-gc 2015-10-28 07:46:06 -07:00
e985e6fe07 Make sure binary_trees_gc actually stresses GC. 2015-10-28 07:45:52 -07:00
cea71c2fe4 Remove Recursive Mark from GC
The previous GC implementation used a recursive mark method. This can
result in stack overflows when attempting to mark deeply nested objects.

This commit replaces the recursive approach with an iteritive one,
moving the state stack from the C call stack to the `WrenVM` structure.

As objects are 'grayed' they are pushed onto the VM's gray stack. When
we have grayed all of the root objects we iterate until the stack is
empty graying any obejcts which haven't been marked as dark before. At
the end of the process we clean up all unmarked objects as before.

This commit also adds a few new tests which check garbage collection by
allocating some new deeply nested objects and triggering the GC a few
times in the process.
2015-10-25 09:02:57 +00:00
b365c07d7a Add a benchmark that explicitly invokes the GC. 2015-10-24 11:00:17 -07:00
0f7d4dd4d0 Add a timeout to the test runner.
This ensures that when you run the tests while stress testing the GC,
that a pathological test won't hang forever.
2015-10-24 10:58:21 -07:00
720c03cf49 Add System.gc(). 2015-10-24 10:56:27 -07:00
f145662158 "Auxiliary" -> "optional".
Fixes #309.
2015-10-24 09:23:25 -07:00
545a4cbf7e Style example output and errors in the docs. 2015-10-18 15:56:52 -07:00
2174ff31e7 Merge pull request #308 from iwillspeak/master
Add Will Speak to Authors File
2015-10-18 10:35:14 -07:00
bc1de6d9b1 Add Will Speak to Authors File
Add my name to the authors file.
2015-10-18 10:56:11 +01:00
30e7d9e508 Move core.wren to be next to wren_core.wren.inc. 2015-10-17 22:17:10 -07:00
e5176607d9 Move meta and random to "aux" modules.
Wren now has three classes of modules:

- The one magic "core" module that's built in and always needed.
- Auxiliary libraries like "meta" and "random". These do not have any
  dependencies, so can be used even when you embed Wren inside an
  application. But they're also optional and can be disabled if you
  don't need them.
- CLI modules. These ones need libuv and are tied to the CLI wrapper
  around the VM.
2015-10-17 22:09:48 -07:00
3ca480cbf4 Merge branch 'master' of https://github.com/iwillspeak/wren into iwillspeak-master 2015-10-17 20:07:52 -07:00
a3f3e3ce03 Don't try to run the guess_number example from the test script. 2015-10-17 13:29:50 -07:00
2c5926b32b Add guess a number example. 2015-10-17 11:19:25 -07:00
5d6ed0958c Use explicit constant for 2**53. 2015-10-17 11:07:13 -07:00
8436ce1934 Add a random module. 2015-10-17 11:03:15 -07:00
d45c0d7f82 Add Support for \U Style Unicode Escapes
This allows fuky things such as 🚀 and 😀 to be Direclty encoded in
Wren strings.
2015-10-17 10:35:46 +01:00
49601e67c5 Don't require nonstandard __builtin_unreachable() in UNREACHABLE().
Fix #304 (I hope).
2015-10-16 21:51:30 -07:00
29eebe4928 Tweak libuv.py a bit. 2015-10-16 21:33:22 -07:00
82d6453a7e Merge branch 'master' of https://github.com/ppearson/wren into ppearson-master 2015-10-16 21:24:22 -07:00
d431c2eaa8 Start sketching in support for reading from stdin. 2015-10-16 21:05:24 -07:00
c714c53c83 "Library" -> "module". 2015-10-15 19:38:25 -07:00
3b09b35b59 Get rid of source path in module.
It wasn't useful anyway since it always had the module name for all but
the main script.
2015-10-15 18:17:42 -07:00
d5b9f0096c Move Meta to a separate module.
Also cleaned up some of the code around loading the core module.
2015-10-15 18:08:56 -07:00
06a4e00f31 Store the module debug path in the ObjModule.
Thanks, Michel!
2015-10-14 07:37:13 -07:00
52b1b7698f Modified libuv.py file to be able to work with Python 2.6 2015-09-24 21:05:08 +12:00
517 changed files with 91783 additions and 8311 deletions

37
.gitignore vendored
View File

@ -1,25 +1,26 @@
# Build outputs.
bin/
lib/
wren
# Build outputs
/bin
/lib
# Intermediate files
*.obj
Debug/
Release/
/build
/.sass-cache
*.pyc
# Intermediate files.
build/
deps/
.sass-cache/
# I leave a temporary Wren script at the top
# level so that I can quickly test stuff.
/scratch.wren
# I leave a temporary Wren script at the top level so that I can quickly test
# stuff.
scratch.wren
# The baseline file is machine-specific
/test/benchmark/baseline.txt
# The baseline file is machine-specific, so doesn't get checked in.
test/benchmark/baseline.txt
# XCode user-specific stuff.
# XCode user-specific stuff
xcuserdata/
*.xccheckout
# Visual Studio cache files.
# Visual Studio cache files
.vs/
ipch/
*.aps
*.ncb
@ -27,7 +28,7 @@ ipch/
*.sdf
*.cachefile
# Visual Studio User-specific files.
# Visual Studio User-specific files
*.suo
*.user
*.userosscache

30
.travis.sh Executable file
View File

@ -0,0 +1,30 @@
#!/bin/bash
set -e
# This build script only builds mac or linux right now, for CI.
WREN_WD="projects/make"
if [ -n "$WREN_TARGET_MAC" ]
then
WREN_WD="projects/make.mac"
fi
WREN_PY="python3"
if [ -n "$WREN_PY_BINARY" ]
then
WREN_PY="$WREN_PY_BINARY"
fi
echo "using working directory '$WREN_WD' ..."
echo "using python binary '$WREN_PY' ..."
cd "$WREN_WD" && make config=debug_64bit-no-nan-tagging
cd ../../ && $WREN_PY ./util/test.py --suffix=_d
cd "$WREN_WD" && make config=debug_64bit
cd ../../ && $WREN_PY ./util/test.py --suffix=_d
cd "$WREN_WD" && make config=release_64bit-no-nan-tagging
cd ../../ && $WREN_PY ./util/test.py
cd "$WREN_WD" && make config=release_64bit
cd ../../ && $WREN_PY ./util/test.py

View File

@ -1,13 +1,42 @@
language: c
compiler:
- gcc
- clang
# Travis VMs are 64-bit but we compile both for 32 and 64 bit. To enable the
# 32-bit builds to work, we need gcc-multilib.
addons:
apt:
packages:
- gcc-multilib
- g++-multilib
sudo: false # Enable container-based builds.
script: make all && make test
language: c
# https://docs.travis-ci.com/user/languages/c/#gcc-on-macos
# On mac, gcc is aliased to clang, so we only have one row
# in build the matrix, not two like on linux
compiler:
- clang
- gcc
# Automatically build and deploy docs.
jobs:
include:
- os: linux
- os: osx
env: WREN_TARGET_MAC=1
- stage: deploy
script: ./util/deploy_docs_from_travis.sh
# Only deploy commits that land on master.
if: branch = master and type = push
# Travis VMs are 64-bit but we compile both for 32 and 64 bit. To enable the
# 32-bit builds to work, we need gcc-multilib.
addons:
apt:
packages:
- gcc-multilib
- g++-multilib
# These are needed for building and deploying the docs.
- python3-markdown
- python3-pygments
- python3-setuptools
- ruby-sass
# Can't do container-based builds for now because installing the custom
# Pygments lexer to generate the docs requires sudo. :( If that changes,
# uncomment the next line and delete the "sudo" and "dist" lines.
# sudo: false # Enable container-based builds.
sudo: required
dist: trusty
script: ./.travis.sh

13
AUTHORS
View File

@ -14,4 +14,15 @@ Thorbjørn Lindeijer <bjorn@lindeijer.nl>
Patricio Mac Adden <patriciomacadden@gmail.com>
Evan Hahn <me@evanhahn.com>
Starbeamrainbowlabs <contact@starbeamrainbowlabs.com>
Alexander Roper <minirop@gmail.com>
Alexander Roper <minirop@gmail.com>
Will Speak <will@willspeak.me>
Damien Radtke <damienradtke@gmail.com>
Max Ferguson <maxxferguson@gmail.com>
Sven Bergström <sven@underscorediscovery.com>
Kyle Charters <kylewcharters@gmail.com>
Marshall Bowers <elliott.codes@gmail.com>
Michal Kozakiewicz <michalkozakiewicz3@gmail.com>
Charlotte Koch <cfkoch@edgebsd.org>
Michel Hermier <michel.hermier@gmail.com>
Taylor Hoff <primdevs@gmail.com>
ruby0x1 <ruby0x1@pm.me>

77
CHANGELOG.md Normal file
View File

@ -0,0 +1,77 @@
## 0.3.0
0.3.0 is a fairly specific release, aimed at fixing build issues across platforms,
streamlining the process for new users and making embedding easier.
This is a stepping stone for working on language features and improving the VM,
hacking on the docs and the VM is simpler than ever!
Builds now work out of the box on all primary platforms.
Previously there was issues on Windows and other platforms due to unix-ey workflows being the default.
All the python scripts have also been fixed and updated (to python 3), and work consistently
across all platforms out of the box too (including the tests, benchmarks, metrics etc).
Like before, there was some things that didn't hold up on Windows or Mac. Fixed!
A lot of work has been done to also clarify the distinction between the CLI project and the VM,
as well as [move the CLI to it's own repo](https://github.com/wren-lang/wren-cli/)!
This removes a lot of code that wasn't being used, and also been clarified the project structure.
Docs have also had a clean up, and a new page to try Wren directly on the doc page was added.
### Language/VM
- CLI moved to own repo
- Use premake for project generation, see projects/
- Fix builds across platforms. "Just works" on all primary platforms.
- Fix amalgamated script generator and amalgamated build
- Fix unicode parsing and other issues in all python scripts
- All python scripts are python3 now, and run on all platforms correctly
- Test runner isolated and unified for VM tests
- Remove SASS and Pygments requirements from docs, just python now
- Updated docs to clarify VM/CLI split
- Added Try page for running wren code in the docs
## 0.2.0
0.2.0 spans a pretty wide time period with [around 290 commits](https://github.com/wren-lang/wren/compare/0.1.0...master).
This includes many bug fixes, improvements, clarity in the
code and documentation and so on. There's too many to explicitly list.
Below is the obvious user facing stuff that was easy to spot in the history.
Most noteworthy is that 'relative imports' are a slightly breaking change,
but help pave the way forward toward a consistency for modules.
### Language/VM
- `import` was made smarter, differentiating relative from logical
- `Fiber` can now accept a value from the first `call`/`transfer`
- Added `String.trim`, `String.trimEnd`, `String.trimStart` variants
- Added `String.split`, `String.replace`, `String.fromByte`
- Added `String.indexOf(needle, startIndex)`
- Added `Sequence.take` and `Sequence.skip`
- Added `List.filled(count, value)`
- Added `Num.pow`, `Num.log`, `Num.round`
- Added `Num.largest`, `Num.smallest`
- Added `Map` iteration (`MapEntry`)
#### C API
- Added `wren.hpp` for use in c++
- Added void* user data to `WrenVM`
- Allow hosts with no module loader to still load optional modules.
- Added `wrenAbortFiber`
### CLI
Please note that beyond 0.2.0 the CLI will have it's own changelog.
This list is not exhaustive. For a fuller history see the commit log above.
- Add path module
- Add `--version`
- Add REPL written in Wren
- Add Stdin.isTerminal
- Added Platform class
- Rename `process` module to `os`
## 0.1.0
First declared version. Everything is new!

24
LICENSE
View File

@ -1,23 +1,21 @@
Wren uses the MIT License:
MIT License
Copyright (c) 2013-2015 Robert Nystrom
Copyright (c) 2013-2020 Robert Nystrom and Wren Contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. (As clarification, there is no
requirement that the copyright notice and permission be included in binary
distributions of the Software.)
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@ -1,65 +0,0 @@
# Top-level Makefile. This has targets for various utility things. To actually
# compile Wren itself, it invokes util/wren.mk for the various configurations
# that Wren can be built with.
# Executables are built to bin/. Libraries are built to lib/.
# A normal, optimized release build for the current CPU architecture.
release:
@ $(MAKE) -f util/wren.mk
@ cp bin/wren wren # For convenience, copy the interpreter to the top level.
# A debug build for the current architecture.
debug:
@ $(MAKE) -f util/wren.mk MODE=debug
# A release build of just the VM.
vm:
@ $(MAKE) -f util/wren.mk vm
# Build all configurations.
all: debug release
@ $(MAKE) -f util/wren.mk LANG=cpp
@ $(MAKE) -f util/wren.mk MODE=debug LANG=cpp
@ $(MAKE) -f util/wren.mk ARCH=32
@ $(MAKE) -f util/wren.mk LANG=cpp ARCH=32
@ $(MAKE) -f util/wren.mk MODE=debug ARCH=32
@ $(MAKE) -f util/wren.mk MODE=debug LANG=cpp ARCH=32
@ $(MAKE) -f util/wren.mk ARCH=64
@ $(MAKE) -f util/wren.mk LANG=cpp ARCH=64
@ $(MAKE) -f util/wren.mk MODE=debug ARCH=64
@ $(MAKE) -f util/wren.mk MODE=debug LANG=cpp ARCH=64
# Remove all build outputs and intermediate files. Does not remove downloaded
# dependencies. Use cleanall for that.
clean:
@ rm -rf bin
@ rm -rf build
@ rm -rf lib
# Remove all build outputs, intermediate files, and downloaded dependencies.
cleanall: clean
@ rm -rf deps
# Run the tests against the debug build of Wren.
test: debug
@ $(MAKE) -f util/wren.mk MODE=debug test
@ ./util/test.py $(suite)
# Generate the Wren site.
docs:
@ ./util/generate_docs.py
# Continuously generate the Wren site.
watchdocs:
@ ./util/generate_docs.py --watch
# Build the docs and copy them to a local "gh-pages" directory.
gh-pages: docs
@ cp -r build/docs/. build/gh-pages
# Build amalgamation of all Wren library files.
amalgamation: src/include/wren.h src/vm/*.h src/vm/*.c
./util/generate_amalgamation.py > build/wren.c
.PHONY: all amalgamation builtin clean debug docs gh-pages release test vm watchdocs

View File

@ -8,7 +8,7 @@ System.print("Hello, world!")
class Wren {
flyTo(city) {
System.print("Flying to ", city)
System.print("Flying to %(city)")
}
}
@ -44,15 +44,15 @@ If you like the sound of this, [let's get started][started]. You can even try
it [in your browser][browser]! Excited? Well, come on and [get
involved][contribute]!
[![Build Status](https://travis-ci.org/munificent/wren.svg)](https://travis-ci.org/munificent/wren)
[![Build Status](https://travis-ci.org/wren-lang/wren.svg)](https://travis-ci.org/wren-lang/wren)
[syntax]: http://munificent.github.io/wren/syntax.html
[src]: https://github.com/munificent/wren/tree/master/src
[nan]: https://github.com/munificent/wren/blob/46c1ba92492e9257aba6418403161072d640cb29/src/wren_value.h#L378-L433
[perf]: http://munificent.github.io/wren/performance.html
[classes]: http://munificent.github.io/wren/classes.html
[fibers]: http://munificent.github.io/wren/fibers.html
[embedding]: http://munificent.github.io/wren/embedding-api.html
[started]: http://munificent.github.io/wren/getting-started.html
[syntax]: http://wren.io/syntax.html
[src]: https://github.com/wren-lang/wren/tree/master/src
[nan]: https://github.com/wren-lang/wren/blob/93dac9132773c5bc0bbe92df5ccbff14da9d25a6/src/vm/wren_value.h#L486-L541
[perf]: http://wren.io/performance.html
[classes]: http://wren.io/classes.html
[fibers]: http://wren.io/concurrency.html
[embedding]: http://wren.io/embedding/
[started]: http://wren.io/getting-started.html
[browser]: http://ppvk.github.io/wren-nest/
[contribute]: http://munificent.github.io/wren/contributing.html
[contribute]: http://wren.io/contributing.html

View File

@ -1,9 +0,0 @@
The Wren scripts in this directory get converted to C string literals into files
with a `.wren.inc` extension. Those are then `#include`d into their respective
`.c` files so that the interpreter can load them directly without having to do
any file IO.
The script that does this translation is `util/wren_to_c_string.py`.
When any of the ".wren" files in here are changed, the Makefile automatically
updates the generated C headers.

View File

@ -1 +0,0 @@
class Meta {}

261
doc/notes/import syntax.md Normal file
View File

@ -0,0 +1,261 @@
So we need some syntax to distinguish between a relative import and a logical
import. I'm not sure which way to go, and I'd like some feedback (or possibly
other alternate ideas I haven't considered).
My two favorites are:
```
// Use
use "relative/path"
import "logical/path"
// Node-style
import "./relative/path"
import "logical/path"
```
If you folks are OK with "use", that's my preference. But otherwise, the Node
style will definitely work too. I'm open to other ideas as well, including a few
below, but I'd like to not bikeshed this forever.
## Background
There are four general approaches we can take:
### Use a modifier ("modifier")
Both kinds of imports start with `import`, but then we use a second keyword
afterwards to identify either a relative or logical import. We could use *two*
keywords -- one for each kind -- but that's unnecessarily verbose. Instead, we
use the presence or absence of the keyword to distinguish. In other words:
```
import foo "string"
import "string"
```
The specific questions we have to answer are:
1. Which kind of import gets the keyword? Ideally, the most common kind of
import would be the one that doesn't need an extra keyword.
2. What keyword? This is surprisingly hard. Probably some kind of preposition.
### Use different keywords ("keyword")
Instead of using `import` for both logical and relative imports, we could have
two keywords, one for each kind. The specific questions to answer then are:
1. Which kind of import gets `import`?
2. What's the other keyword?
### Use different syntax for the path ("syntax")
Instead of always using a string literal to identify what's being imported, we
could use a different kind of token or tokens for the different kinds of import.
For example, a string literal for one kind, and an identifier token for the
other:
import identifier
import "string literal"
The specific questions are:
1. Which kind of import uses a string literal?
2. What's the syntax for the other kind?
### Use a signifier in the import string itself to distinguish ("string")
An import is always `import` followed by a string literal. Then we use some
specific markers inside the string literal itself to distinguish the two kinds.
For example, Node says that an import string starting with "./" or "../" is
relative and other import strings are logical.
The specific question to answer is what kind of signifier we'd use. I think
Node's convention is the only real contender here, though.
One feature this style has that none of the others do is that it means the
language syntax itself has no notion of logical and relative imports. This
means there is no overhead or complexity for host applications where that
distinction isn't meaningful.
## Contenders
These are options I'm open to, in roughly descending order of preference:
### Node-style (string)
If the string starts with "./" or "../", it's relative.
```
import "./relative/path"
import "logical/path"
```
This is how Node works, so there's prior art. It keeps the language completely
simple. It does feel sort of arbitrary and magical to me, but it's the simplest,
most expedient solution.
### Use (keyword)
The `use` keyword is for relative imports, `import` is for logical.
```
use "relative/path"
import "logical/path"
```
The `use` keyword comes from Pascal, but that's not very widely known. I kind
of like this. It's short, and `use` feels "nearer" to me than "import" so it
has the right connotation. (You can't "use" something unless you have it near
to hand.)
It adds a little complexity to the language and VM. We have to support both
keywords and pass that "use versus import" bit through the name resolution
process. But that's pretty minor.
### Slashes (syntax)
If the path is a string literal, it's relative. Otherwise, it is a
slash-separated series of unquoted identifiers.
```
import "relative/path"
import logical/path
```
This means you can't (easily) use reserved words as names of logical imports.
This was my initial pitch. I still like how it looks, but I seem to be in the
minority.
### Relative (modifier)
The `relative` modifier is for relative imports.
```
import relative "relative/path"
import "logical/path"
```
It's explicit, which is good. It is unfortunately verbose. I think `relative`
is too useful of a word to make into a reserved word, which means it would have
to be a contextual keyword (i.e. treated like a reserved word after `import`
but behaving like a regular identifier elsewhere). I'm not generally a fan of
contextual keywords—they tend to make things like syntax highlighters more
difficult to create—so I try to avoid them.
## Rejected
I considered these ideas, but don't think they are good enough approaches for
various reasons:
### Package identifier (syntax)
If an unquoted identifier appears before the import string, then it's a logical
import within that package. Otherwise, it's relative.
```
import "relative/path"
import logical "path"
```
This was one of my initial ideas. It has the same problem as other unquoted
imports in that it makes it harder to have odd package names. It means the VM
has to understand this syntax and figure out how to display package names in
stack traces and stuff, so there is some extra complexity involved.
The form where you have both a package name and a relative path within that
package is pretty unusual and likely unintuitive to users.
### Dotted (syntax)
If the path is a string literal, it's relative. Otherwise, it is a
dot-separated series of unquoted identifiers.
```
import "relative/path"
import logical.path
```
Similar to slashes, but using dots. This helps make logical imports look more
visually distinct from relative ones. But it also makes them look more similar
to getter calls, which they aren't related to at all.
### Include (keyword)
The `include` keyword is for relative imports, `import` is for logical.
```
include "relative/path"
import "logical/path"
```
Ruby uses `include` for applying mixins. "Include" reads to me more like some
kind of transclusion thing, so it feels a little weird.
### Require (keyword)
The `require` keyword is for relative imports, `import` is for logical.
```
require "relative/path"
import "logical/path"
```
Node uses "require" and ES6 uses "import" so this is kind of confusing. Ruby
uses `require` and `require_relative`, so using `require` for a relative import
is kind of confusing. Lua also uses `require`, but for both relative and
logical. Overall, this feels murky and unhelpful to me.
### Angle-brackets (syntax)
As in C/C++, an import string can be in angle brackets or quotes. Angle brackets
are for logical imports, quotes for relative.
```
import "relative/path"
import <logical/path>
```
Hard pass. It requires context-sensitive tokenization (!) in C and we definitely
don't want to go there.
### URI scheme (string)
An import string starting with "package:" and maybe "wren:" is treated as
logical, like they are URIs with an explicit scheme. Others are relative.
```
import "relative/path"
import "package:logical/path"
import "wren:random"
```
This is (roughly) how Dart works. I'm not a fan. I think it's too verbose for
logical imports.
### Package (modifier)
A `package` modifier indicates a logical import. Others are relative.
```
import "relative/path"
import package "logical/path"
```
Pretty long, and I'm not too crazy about baking "package" into the language and
VM.
### From (modifier)
A `from` modifier indicates, uh, one kind of import.
```
import "some/path"
import from "other/path"
```
It looks nice, but it's totally unclear to me whether logical imports should
get `from` or relative ones. Also kind of confusing in that Python and ES6 use
`from` in their notation for importing explicit variables from a module (where
Wren uses `for`).

144
doc/notes/re-entrancy.md Normal file
View File

@ -0,0 +1,144 @@
## wrenInterpret()
You can already call out to a foreign method or constructor from within an
execution that was started using `wrenInterpret()`, so I think that's fine.
`wrenInterpret()` doesn't use the API stack at all.
## wrenCall()
Normally, when using `wrenCall()` to start executing some code, the API slots
are at the very bottom of the fiber's stack and the fiber has no other
callframes until execution begins.
When a foreign method or constructor is called, there *are* callframes on the
fiber's stack. There must be, because that's where the arguments to the foreign
method are.
So, if you `wrenCall()`, which eventually calls a foreign method, the same fiber
will be used for the API twice. This is currently broken. The reason it's broken
is that `callForeign()` and `createForeign()` store the old apiStack pointer
(the one used for the initial `wrenCall()`) in a local variable and then restore
it when the foreign call completes. If a GC or stack grow occurs in the middle
of that, we end up restoring a bad pointer.
But I don't think we need to preserve apiStack for the `wrenCall()` anyway. As
soon as the user calls `wrenCall()` and it starts running, we no longer need to
track the number of slots allocated for the API. All that matters is that the
one return value is available at the end.
I think this means it *should* be fairly easy to support:
wrenCall() -> wren code -> foreign method
## Foreign calls
The interesting one is whether you can call `wrenInterpret()` or `wrenCall()`
from within a foreign method. If we're going to allow re-entrancy at all, it
would be nice to completely support it. I do think there are practical uses
for this.
Calling `wrenInterpret()` should already work, though I don't think it's tested.
Calling `wrenCall()` is probably broken. It will try to re-use the slots that
are already set up for the foreign call and then who knows what happens if you
start to execute.
I think a key part of the problem is that we implicitly create or reuse the API
stack as soon as you start messing with slots. So if there already happens to
be an API stack -- because you're in the middle of a foreign method -- it will
incorrectly reuse it when you start preparing for the `wrenCall()`.
An obvious fix is to add a new function like `wrenPrepareCall()` that explicitly
creates a new API stack -- really a new fiber -- for you to use. We still have
to figure out how to keep track of the current API stack and fiber for the
foreign call so that we can return to it.
**TODO: more thinking here...**
If I can figure this out, it means we can do:
foreign method -> C code -> wrenCall()
## Nested foreign calls
If we compose the above it leads to the question of whether you can have
multiple nested foreign calls in-progress at the same time. Can you have a C
stack like:
wrenCall()
runInterpreter()
foreignCall()
wrenCall()
runInterpreter()
foreignCall()
...
This does *not* mean there is a single Wren stack that contains multiple
foreign calls. Since each `wrenCall()` begins a new fiber, any given Wren stack
can only ever have a single foreign API call at the top of the stack. I think
that's a good invariant.
I believe we should support the above. This means that the core
`runInterpreter()` C function is itself re-entrant. So far, I've always assumed
it would not be, so it probably breaks some assumptions. I'll have to think
through. The main thing that could be problematic is the local variables inside
`runInterpreter()`, but I believe `STORE_FRAME()` and `LOAD_FRAME()` take care
of those. We just need to make sure they get called before any re-entrancy can
happen. That probably means calling them before we invoke a foreign method.
I'll have to write some tests and see what blows up for this.
## Calling re-entrant fibers
Where it gets really confusing is how re-entrant calls interact with fibers.
For example, say you:
wrenCall() -> creates Fiber #1
runInterpreter() -> runs Fiber #1
some Wren code stores current fiber in a variable
foreignCall()
wrenCall() -> creates Fiber #2
runInterpreter() -> runs Fiber #2
some Wren code calls or transfers to Fiber #1
What happens in this scenario? We definitely want to prevent it. We already
detect and prevent the case where you call a fiber that's already called in the
current *Wren* stack, so we should be able to do something in the above case
too.
Now that I think about it, you can probably already get yourself in a weird
state if you grab the root fiber and call it. Yeah, I justed tested. This:
var root = Fiber.current
Fiber.new {
root.call()
System.print(1)
}.call()
System.print(2)
Segfaults the VM. :( It actually dies when the called child fiber *returns*. The
root call successfully continues executing the root fiber (which is super
weird). Then that completes and control returns to the spawned fiber. Then
*that* completes and tries to return control to the root fiber, but the root is
already done, and it blows up. So the above prints "2" then "1" then dies.
(If either of the `call()` calls are change to `transfer()`, the script runs
without any problems because then it never tries to unwind back through the
root fiber which already completed.)
To fix this, when `runInterpreter()` begins executing a root fiber (either from
`wrenCall()` or `wrenInterpret()`), we need to mark it in some way so that it
can't be called or transferred to.
## Suspending during re-entrancy
Maybe the weird conceptual case is when you suspend a fiber while there are
multiple re-entrant calls to `runInterpreter()` on the C stack. Ideall, they
would all magically return, but that's obviously not feasible.
I guess what will/should happen is that just the innermost one suspends. It's
up to the host to handle that fact. I need to think about this more, add some
tests, and work through it.
I think we'll probably want to add another WrenInterpretResult case for
suspension so that the host can tell that's what happened.

View File

@ -0,0 +1,478 @@
# Smarter Imports
**Note: This is now mostly implemented, though the implementation differs
somewhat from this original proposal.**
Here's a proposal for improving how imported modules are identified and found
to hopefully help us start growing an ecosystem of reusable Wren code. Please
do [let me know][list] what you think!
[list]: https://groups.google.com/forum/#!forum/wren-lang
## Motivation
As [others][210] [have][325] [noted][346], the way imports work in Wren,
particularly how the CLI resolves them, makes it much too hard to reuse code.
This proposal aims to improve that. It doesn't intend to fix *everything* about
imports and the module system, but should leave the door open for later
improvements.
[210]: https://github.com/wren-lang/wren/issues/210
[325]: https://github.com/wren-lang/wren/issues/325
[346]: https://github.com/wren-lang/wren/issues/346
### Relative imports
Today, it's hard to reuse your own code unless you literally dump everything in
a single directory. Say you have:
```text
script_a.wren
useful_stuff/
script_b.wren
thing_1.wren
thing_2.wren
```
`script_a.wren` and `script_b.wren` are both scripts you can run directly from
the CLI. They would both like to use `thing_1.wren`, which in turn imports
`thing_2.wren`. What does `thing_1.wren` look like? If you do:
```scala
// thing_1.wren
import "thing_2"
```
Then it works fine if you run `script_b.wren` from the `useful_stuff/`
directory. But if you try to run `script_a.wren` from the top level directory,
then it looks for `thing_2.wren` *there* and fails to find it. If you change the
import to:
```scala
// thing_1.wren
import "useful_stuff/thing_2"
```
Then `script_a.wren` works, but now `script_b.wren` is broken. The problem is
that all imports are treated as relative to the directory containing the
*initial script* you run. That means you can't reuse modules from scripts that
live in different directories.
In this example, if feels like imports should be treated as relative to the
file that contains the import statement. Often you want to specify, "Here is
*where* this other module is, relative to where *I* am."
### Logical imports
If we make imports relative, is that enough? Should *all* imports be relative? I
don't think so. First of all, some modules are not even on the file system.
There is no relative path that will take you to "random" — it's built into the
VM itself. Likewise, "io" is baked into the CLI.
Today, when you write:
```scala
import "io"
```
You aren't saying *where* that module should be found, you're saying *what*
module you want. Assuming we get a package manager at some point, these kinds of
"logical" imports will be common. So I want these too.
If you look at other langauges' package managers, you'll find many times a
single package offers a number of separate libraries you can use. So I also
want to support logical imports that contain a path too — the import would say
both *what* package to look in and *where* in that package to look.
### Only logical imports?
Given some kind of package-y import syntax, could we get rid of relative imports
and use those for everything? You'd treat your own program like it was itself
some kind of package and anything you wanted to import in it you'd import
relative to your app's root directory.
The problem is that the "root directory" for your program's "package" isn't
well-defined. We could say it's always the same directory as the script you're
running, but that's probably too limiting. You may want to run scripts that live
in subdirectories.
We could walk up the parent directories looking for some kind of "manifest" file
that declares "the root of the package is here", but that seems like a lot of
hassle if you just want to create a couple of text files and start getting some
code running. So, for your own programs, I think it's nice to still support
"pure" relative imports.
### Ambiguity?
OK, so we want both relative imports and logical imports. Can we use the same
syntax for both? We could allow, say:
```scala
import "a/b"
```
And the semantics would be:
1. Look for a module "a/b.wren" relative to the file containing the import. If
found, use it.
2. Otherwise, look inside some "package" directory for a package named "a" and
a module named "b.wren" inside it. If found use that.
3. Otherwise, look for a built in module named "a".
This is pretty much how things work now, but I don't think it's a good idea.
Relative imports will tend to be short — often single words like "utils".
Assuming we get a healthy package ecosystem at some point, the chances of one of
those colliding with a logical import name are high.
Also, when reading code, I think it's important to be able to easily tell "this
import is from my own program" without having to know the names of all of the
files and directories in the program.
## Proposal
OK, so here's my goals:
1. A way to import a module relative to the one containing the import.
2. A way to import a module from some named logical package, possibly at a
specific path within that package.
3. Distinct syntaxes for each of these.
I tried a few different ideas, and my favorite is:
### Relative imports
Relative imports use the existing syntax:
```scala
// Relative path.
import "ast/expr"
```
This looks for the file `ast/expr.wren` relative to the directory containing the
module that has this import statement in it.
You can also walk out of directories if you need to import a module in a parent
folder:
```scala
import "../../other/stuff"
```
### Logical imports
If you want to import a module from some named logical entity, you use an
*unquoted* identifier:
```scala
import random
```
Being unquoted means the names must be valid Wren identifiers and can't be
reserved words. I think that's OK. It would confuse the hell out of people if
you had a library named "if". I think the above *looks* nice, and the fact that
it's not quoted sends a signal (to me at least) that the name is a "what" more
than a "where".
If you want to import a specific module within a logical entity, you can have a
series of slash-separate identifiers after the name:
```scala
import wrenalyzer/ast/expr
```
This imports module "ast/expr" from "wrenalyzer".
## Implementation
That's the proposed syntax and basic semantics. The way we actually implement it
is tricky because Wren is both a standalone interpreter you can run on the
command line and an embedded scripting language. We have to figure out what goes
into the VM and what lives in the CLI, and the interface between the two.
### VM
As usual, I want to keep the VM minimal and free of policy. We do need to add
support for the new unquoted syntax. The more significant change is to the API
the VM uses to talk to the host app when a module is imported. The VM doesn't
know how to actually load modules. When it executes an import statement, it
calls:
```c
char* loadModuleFn(WrenVM* vm, const char* name);
```
The VM tells the host app the import string and the host app returns the code.
In order to distinguish relative imports (quoted) from an identical unquoted
name and path, we need to pass in an extra to bit to tell the host whether there
were quotes or not.
The more challenging change (and the reason I didn't support them when I first
added imports to Wren) is relative imports. There are two tricky parts:
First, the host app doesn't have enough context to resolve a relative import.
Right now, the VM only passes in the import string. It doesn't tell which module
*contains* that import string, so the host has no way of knowing what that
import should be relative *to*.
That's easy to fix. We have the VM pass in the name of the module that contains
the import.
The harder problem is **canonicalization**. When you import the same module
twice, the VM ensures it is only executed once and both places use the same
module data. This is important to ensure you don't get confusing things like
duplicate static state or other weird side effects.
To do that, the VM needs to be able to tell when two imports refer to the "same"
module. Right now, it uses the import string itself. If two imports use the same
string, they are the same module.
With relative imports, that is no longer valid. Consider:
```text
script_a.wren
useful_stuff/
thing_1.wren
thing_2.wren
```
Now imagine those files contain:
```scala
// script_a.wren
import "useful_stuff/thing_1"
import "useful_stuff/thing_2"
// useful_stuff/thing_1.wren
import "thing_2"
// useful_stuff/thing_2.wren
// Stuff...
```
Both `script_a.wren` and `thing_1` import `thing_2`, but the import *strings*
are different. The VM needs to be able to figure out that those two imports
refer to the same module. I don't want path manipulation logic in the VM, so it
will delegate to the host app for that as well.
Given the import string and the name of the module containing it, the host app
produces a "fully-qualified" or "canonical" name for the imported module. It is
*that* resulting string that the VM uses to tell if two imports resolve to the
same module. (It's also the string it uses in things like stack traces.)
This means importing becomes a three stage process:
1. First the VM asks the host to resolve an import. It gives it the (previously
resolved) name of the module containing the import, the imports string, and
whether or not it was quoted. The host app returns a canonical string for
that import.
2. The VM checks to see if a module with that canonical name has already been
imported. If so, it reuses that and its done.
3. Otherwise, it circles back and asks the host for the source of the module
with that given canonical name. It compiles and executes that and goes from
there.
So we add a new callback to the embedding API. Something like:
```c
char* resolveModuleFn(WrenVM* vm,
// Canonical name of the module containing the import.
const char* importer,
// The import string.
const char* path,
// Whether the path name was quoted.
bool isQuoted);
```
The VM invokes this for step one above. The other two steps are the existing
loading logic but now using the canonicalized string.
### CLI
All of the policy lives over in the CLI (or in your app if you are embedding the
VM). You are free to use whatever canonicalization policy makes sense for you.
For the CLI, and for the policy described up in motivation, it's something like
this:
* Imports are slash-separated paths. Resolving a relative path is normal path
joining relative to the directory containing the import. So if you're
importing "a/b" from "c/d" (which is a file named "d.wren" in a directory
"c"), then the canonical name is "c/a/b" and the file is "c/a/b.wren".
".." and "." are allowed and are normalized. So these imports all resolve
to the same module:
```scala
import "a/b/c"
import "a/./b/./c"
import "a/d/../b/c"
```
* If an import is quoted, the path is considered relative to the importing
module's path, and is in the same package as the importing module.
So, if the current file is "a/b/c.wren" in package "foo" then these are
equivalent:
```scala
import "d/e"
import foo/a/b/d/e
```
* If an import is unquoted, the first identifier is the logical "package"
containing the module, and the remaining components are the path within that
package. The canonicalized string is the logical name, a colon, then the
resolved full path to the import (without the ".wren" file extension).
So if you import:
```scala
import wrenalyzer/ast/expr
```
The canonical name is "wrenalyzer:ast/expr".
* If an import is a single unquoted name, the CLI implicitly uses the name as
the module to look for within that package. These are equivalent:
```scala
import foo
import foo/foo
```
We could use some default name like "module" instead of the package name,
similar to Python, but I think this is actually a little more usable in
practice. If you're hacking on a bunch of packages at the same time, it's
annoying if every tab in your text editor just says "module.wren".
* The canonicalized string for the main script or a module imported using a
relative path from the main script is just the normalized file path,
probably relative to the working directory.
* Since colon is used to separate the name from path, path components with
colons are not allowed.
### Finding logical imports
The last remaining piece is how the CLI physically locates logical imports. If
you write:
```scala
import foo
```
Where does it look for "foo"? Of course, if "foo" is built into the VM like
"random", then that's easy. Likewise, if it's built into the CLI like "io",
that's easy too.
Otherwise, it will try to find it on the file system. We don't have a package
manager yet, so we need some kind of simple policy so you can "hand-author" the
layout a package manager would produce. Borrowing from Node, the basic idea is
pretty simple.
To find a logical import, the CLI starts in the directory that contains the main
script (not the directory containing the module doing the import), and looks for
a directory named "wren_modules". If not found there, it starts walking up
parent directories until it finds one. If it does, it looks for the logical
import inside there. So, if you import "foo", it will try to find
"wren_modules/foo/foo.wren".
Once it finds a "wren_modules" directory, it uses that one directory for all
logical imports. You can't scatter stuff across multiple "wren_modules" folders
at different levels of the hierarchy. If it can't find a "wren_modules"
directory, or it can't find the requested module inside the directory, the
import fails.
This means that to reuse someone else's Wren "package" (or your own for that
matter), you can just stick a "wren_modules" directory next to the main script
for your app or in some parent directory. Inside that "wren_modules" directory,
copy in the package you want to reuse. If that package in turn uses other
packages, copy those into the *same* "wren_modules" directory. In other words,
the transitive dependencies get flattened. This is important to handle shared
dependencies between packages without duplication.
You only need to worry about all of this if you actually have logical imports.
If you just have a couple of files that import each other, you can use straight
relative imports and everything just works.
## Migration
OK, that's the plan. How do we get there? I've start hacking on the
implementation a little and, so far, it seems straightforward. Honestly, it will
probably take less time than I spent writing this up.
The tricky part is that this is a breaking change. All of your existing quoted
import strings will mean something different. We definitely *can* and will make
breaking changes in Wren, so that's OK, but I'd like to minimize the pain. Right
now, Wren is currently at version 0.1.0. I'll probably consider the commit right
before I start landing this to be the "official" 0.1.0 release and then the
import changes will land in "0.2.0". I'll work in a branch off master until
everything looks solid and then merge it in.
If you have existing Wren code that you run on the CLI and that contains
imports, you'll probably need to tweak them.
If you are hosting Wren in your own app, the imports are fine since your app
has control over how they resolve. But you will have to fix your app a little
since the import embedding API is going to change to deal with canonicalization.
I think I can make it so that if you don't provide a canonicalization callback,
then the original import string is treated as the canonical string and you
fall back to the current behavior.
## Alternatives
Having both quoted and unquoted import strings is a little funny, but it's the
best I could come up with. For what it's worth, I [borrowed it from
Racket][racket].
[racket]: https://docs.racket-lang.org/guide/module-basics.html
I considered a couple of other ideas which are potentially on the table if
most of you don't dig the main proposal:
### Node-style
In Node, [all imports are quoted][node]. To distinguish between relative and
logical imports, relative imports always start with "./". In Wren, it would be:
[node]: https://nodejs.org/api/modules.html
```scala
import "./something/relative"
import "logical/thing"
```
This is simpler than the main proposal since there are no syntax changes and we
don't need to push the "was quoted?" bit through the embedding API. But I find
the "./" pretty unintuitive especially if you're not steeped in the UNIX
tradition. Even if you are, it's weird that you *need* to use "./" when it means
nothing to the filesystem.
### Unquoted identifiers
The other idea I had was to allow both an unquoted identifier and a quoted
path, like:
```scala
import wrenalyzer "ast/expr"
```
The unquoted name is the logical part — the package name. The quoted part is
the path within that logical package. If you omit the unquoted name, it's a
straight relative import. If you have a name but no path, it's desugars to use
the name as the path.
This is a little more complex because we have to pass around the name and path
separately between the VM and the host app during canonicalization. If we want
the canonicalized form to keep those separate as well, then the way we keep
track of previously-loaded modules needs to get more complex too. Likewise the
way we show stack traces, etc.
The main proposal gloms everything into a single string using ":" to separate
the logical name part from the path. That's a little arbitrary, but it keeps
the VM a good bit simpler and means the idea of there being a "package name" is
pure host app policy.

View File

@ -1,62 +0,0 @@
-- new
- introduction
- getting started
- tutorial
- community
- contributing
- guide
- basic syntax
scripts, comments, newlines, names
- values
null, bools, numbers, strings, and ranges
- collections
lists and maps
- expressions
calls, this, super, operators, is
- control flow
if, while, for, sequence protocol, && ||, ?:
- variables
var, assignment, scope, blocks
- functions
block arguments, closures
- classes
- concurrency
- error handling
- modules
- embedding
- core module
...
- cli modules
- io
- scheduler
- timer
...
- reference
- performance
- faq
-- current
- getting started
- language
- syntax
- expressions
- variables
- control flow
- error handling
- modules
- types
- values
- classes
- fibers
- functions
- lists
- maps
- reference
- core
- embedding api
- performance
- community
- contributing
- qa

View File

@ -0,0 +1,69 @@
^title Hello Wren
4 Feb 2019
---
Welcome to the new Wren development blog!
Around November 2018 on the Wren mailing list, munificent announced that a new maintainer is taking over the development and maintainence of the Wren language. [The original post is here, with all the details.](https://groups.google.com/forum/#!topic/wren-lang/cMUwij-NIn0)
In short, [I'm (ruby0x1)](https://github.com/ruby0x1) taking over from [Bob (munificent)](https://github.com/munificent) as maintainer, but Bob is sticking around as a contributor!
### The Wren blog
One of the first things I felt Wren needed going forward is a consistent and centralized place to talk about the language. The existing design choices and goals, and especially the future and evolution of Wren are something a lot of people want to read about, in detail. Now we have a place to do exactly that!
The blog will be keeping in the spirit of Wren by remaining simple. Posts are just regular markdown files in the repository alongside the rest of the site, and are considered part of the documentation.
Since Wren as a project aims to help others learn, having the in depth thought processes, development details and technical intricacy be documented in the same place, over a timeline, is valuable.
### What's next for Wren?
First and foremost, I wanted to state explicitly that **Wren is going to be changing** but it is **not going to become something else**.
Wren attracted me as a language because of what it _is_, not because it isn't {_other language_}. If I wanted to use {_other language_} I would have, but I chose Wren because I wanted what it was.
So, Wren is going to be changing in ways that align with it's existing design intentions. Staying small, simple, learnable and hackable is all vital to what makes Wren valuable, and will remain.
We're just as excited as you are to get to longer term changes and fun tweaks (we have lots of work done already in local projects like [the debugger](https://i.imgur.com/dazexnY.gifv)). There's plenty of ideas we've tried since we've been [using Wren full time](https://luxeengine.com) the last 2.5+ years, and can't wait to get started with bring those into master (and optional modules). There's a lot to do!
In the next blog I want to try talk a bit more about the short to medium term goals and roadmap (rather than mixing it here with the meta/hello world post). Be sure to keep an eye out for that one, as it has more juicy details on what we're gonna get up to.
There are immediate term goals, though.
### First steps
I think it's important to reset the baseline before we shake things up too much. Think of it as a ramp up to gain momentum, rather than running into a china store with arms flailing.
- We're gonna clear out a bit of backlog, tidying up issues and PRs
- Tidy up the website a bit, visually and structurally
- Make sure all documentation is up to date with the current development
- Tag 0.2.0 with a list of relevant changes since 0.1.0
Once we tag 0.2.0, we'll be in a good place to move forward. And, everything up until now will have a well defined checkpoint preserved, if people want to refer to it.
### Steps so far
Since the announcement and transition, I've been making my way through all the mailing list posts, issues and PRs in the backlog and reading all the way back to the early days.
I've also been talking to community members one on one and getting personal experiences and thoughts on Wren. Forming a full picture will help us since we'll have an overview of what's most relevant (and what isn't) as time has passed, and gives us actionable things to do for the next milestone. I think it's an important step.
We've also been investigating some of the PRs with the community to get those sorted out, since they're in the way.
Lastly, I've already done a bit of clean up on the website and documentation theme, added a new logo, and of course added the blog.
### Thanks!
Lastly, I wanted to say thanks to munificent, the community and all the contributors that have made Wren possible to this point. It's a wonderful thing and I look forward to seeing where we take it, together.
I hope you'll join us on the journey!
### More
- [The Wren Blog RSS](http://wren.io/blog/rss.xml)
- Join the [discord community](https://discord.gg/Kx6PxSX)
- Visit the [wren-lang organization](https://github.com/wren-lang) on GitHub.
- Follow [@munificentbob](https://twitter.com/munificentbob) or [@ruby0x1](https://twitter.com/ruby0x1) on twitter

View File

@ -0,0 +1,91 @@
^title 0.2.0 and beyond
30 Sep 2019
---
### 0.2.0 is here
It's time to tag a release!
Let's check our goals from [the last blog post](0-hello-wren.html):
- <s>We're gonna clear out a bit of backlog, tidying up issues and PRs</s>
- <s>Tidy up the website a bit, visually and structurally</s>
- <s>Make sure all documentation is up to date with the current development</s>
- <s>Tag 0.2.0 with a list of relevant changes since 0.1.0</s>
So far so good.
### Backlog
Clearing out the issues on a repo after some time has passed is always a bit tricky.
Many issues are outdated (or unrelated), and some need a proper response. Some are related to future ideals, things that will take a while to get to. Some are related to the Wren CLI. It can be difficult to reason about the state of the tasks when they're all over the place, so we've been consolidating.
The good news is the issue list has been drastically reduced, 70+ issues being closed (or resolved). Around 21 of those are marked for future consideration, and 23 moved to the Wren CLI repository. More consolidation will still continue.
**The goal is that the active issues are as relevant as possible in the immediate term.**
A tricky but important aspect to mention here is the perception of closing an issue...
A closed issue doesn't necessarily mean anything final, it's just a categorization tool!
The other categorization tool which operates _within_ open/closed categories, is the _label_. Labels allow us to distinguish clearly the different types of issues, which makes open/closed less binary and more nuanced and rich. We rely on both to make sense of the list.
For example, discussions of future tasks, ideas or goals [are tagged `future`](https://github.com/wren-lang/wren/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3Afuture+). Now we can refer to them later, and re-open them when they become active and relevant again.
**We're in this together.**
Please don't be discouraged if an issue is closed! Discussion is absolutely encouraged and ideas, proposals and input is very necessary. Feel free to keep a discussion going, even if the issue it's attached to has been marked as closed.
### 0.2.0
We've been hammering away on Wren since 0.1.0 for quite a while. The [change list on GitHub](https://github.com/wren-lang/wren/compare/0.1.0...5338275dcdd97fd8d9fc614f420a645500836a59) is too long to display!
Most importantly, before we start iterating on the language further, I wanted to make sure we had a checkpoint to look back to. That's largely what 0.2.0 is about.
There's quite a lot of good changes, with **290 commits from 41 contributors!**
Thanks to everyone getting involved, every little bit has helped Wren, no matter how small the contribution.
### 0.3.0
With 0.2.0 wrapped up, our next release won't be as far away this time.
**The primary goal for 0.3.0 is separating the VM from the CLI.**
This includes updated documentation, splitting the source repos, migrating all the tests, issues and more.
All the code and documentation will still be easy to access in one place, but clarity around Wren as a project will improve a lot.
The migration has already started, you can [find the wren-cli repository here](https://github.com/wren-lang/wren-cli).
I'm working on some of the refactoring on the [wren-cli-refactor branch.](https://github.com/wren-lang/wren/tree/wren-cli-refactor)
With that, we'll also have a cleaner build process for the CLI.
On some platforms (Windows especially), there have been several pain points, these will be addressed.
There's also gonna be an additional build target, namely emscripten, so we can easily run Wren examples on the Wren website and documentation.
And finally, we'll have some proper prebuilt releases with 0.3.0.
I know many people have just wanted to grab an executable and give the language a go, but that hasn't been an option.
We'll fix that with 0.3.0.
The 0.3.0 goals in simple form:
- VM / CLI split
- Build consistency/reliablity
- Web build for embedding in docs
- Prebuilt releases
### Beyond
I don't have any concrete plans for 0.4.0 right now, but once the dust settles from 0.3.0 we'll have a clearer view.
There's definitely things in the pipeline though, I've been playing with [adding compound assignments like `+=`](https://github.com/wren-lang/wren/pull/701).
More details about in development features and fixes can be found on the repo in the meantime.
Thanks for reading!
### More
- [The Wren Blog RSS](http://wren.io/blog/rss.xml)
- Join the [discord community](https://discord.gg/Kx6PxSX)
- Visit the [wren-lang organization](https://github.com/wren-lang) on GitHub to get involved.
- Follow the developers [@munificentbob](https://twitter.com/munificentbob) or [@ruby0x1](https://twitter.com/ruby0x1) on twitter

View File

@ -0,0 +1,135 @@
^title 0.3.0 released!
5 June 2020
---
In this post we'll cover 0.3.0 and the goals for 0.4.0 [#](#goals-for-0.4.0).
## About the 0.3.0 release
Let's revisit our goals from [the last blog post](1-0.2.0-and-beyond.html),
and mark what we managed to get done:
- <s>VM / CLI split</s> [#](#vm--cli-split)
- <s>Build consistency/reliablity</s> [#](#build-consistencyreliability)
- <s>Web build for embedding in docs</s> [#](#web-build-for-embedding-in-docs)
- <s>Prebuilt releases</s> [#](#prebuilt-releases)
## The details
### VM / CLI split
With 0.3.0 we've separated the CLI from the Wren repo,
and updated the docs to make the distinction clearer.
The [CLI now has it's own corner of the docs](../cli), so that the modules
and API docs aren't overlapped like before. This opens up space for the
CLI to get better, fuller documentation, and removes confusion about
built in modules vs ones that are in the CLI only.
The code structure is clearer, too, and all the tests and utils are now specific.
### Build consistency/reliability
Previously, builds on Windows could be a little fickle, and there was sometimes
issues with the dependencies on the CLI side.
To solve this, premake is now used to generate platform specific project files that
'just work', making it a one step process to build the VM or CLI. Both projects
now have a `projects/` folder which includes ready to go project files for primary platforms.
<small>The original `Makefile` and `util/wren.mk` no longer exist, so there might be some work needed
to reintegrate if you relied on those. You can find the updated makefile in `projects/make/`, or `projects/make.mac/`.</small>
The **amalgamated build** was fixed too, so that embedding in your own project is as simple as
including a single c file (and the `wren.h` header).
On the **CLI** side, the pre-build steps were removed and dependencies vendored in repo,
so that the project just builds with less potential points of error, especially across platforms.
And finally the **docs**! Previously [SASS](https://sass-lang.com/) was used, and code highlighting
was done at generation time using pygments, a python code highlighter. Both of these dependencies
have been removed, code highlighting is now done on the client side instead (see another reason why below).
The benefit here that it is now _easy_ to edit the docs, just a simple python command, no setup!
### Web build for embedding in docs
The goal was two part here, one is to have a page to just try out Wren.
Type in some code, run it. That's the first big step and we've now got that on the docs page.
<h4><a href="../try" target="_blank" class="dark-link">Try Wren directly in your browser!</a></h4>
This should work on desktop or mobile, and will continue to be improved over time.
The second part of that goal is having the VM available to make examples on each page interactive.
This is implemented, _but not activated on any pages yet_.
In the near future inline doc examples will have a small button that you can
press to see the code result right there, live. Since there's a lot of examples,
and sometimes they're fragments of code that don't run in isolation,
it will take time to propagate it through the pages.
Mainly, I didn't want this to hold up 0.3.0, but expect to start seeing it soon.
### Prebuilt releases
In addition to the browser based build that removes a barrier to trying out Wren,
Wren CLI has prebuilt binaries for Mac, Windows and Linux now! This gives
an easy path to just tinkering with Wren before embedding it.
---
## Goals for 0.4.0
With 0.4.0 the goal is to address a couple of bigger todos, but also to push the language
itself, and the embedding experience forward.
You can see some of the [work in progress tasks](https://github.com/wren-lang/wren/pulls?q=is%3Apr+is%3Aopen+label%3A0.4.0) here,
but there's a few things I'd like to resolve in 0.4.0.
**Compound operators**
I've really missed having `+=` and friends,
so I've been working on a (broken, wip) [PR here](https://github.com/wren-lang/wren/pull/701).
I've since had a better idea to implement it and will hope to address that in 0.4.0.
**Chained methods ('fluent interfaces')**
Currently in Wren it's required that the period (`.`) be on the same line as the method.
<pre class="snippet">
example.
some().
functions().
here()
</pre>
This isn't as elegant as we'd want for this form of API,
so **in 0.4.0 the goal is** allowing a newline, as you'd expect:
<pre class="snippet">
example
.some()
.functions()
.here()
</pre>
This doesn't seem like a big deal but when your calls are wider,
longer and possibly accept block functions. It's hard to read,
and can be less fun to track down a missing `.` in a big chunk of code.
<pre class="snippet">
example.
some {|args, and, stuff|
...
}.
here()
</pre>
**C Side APIs**
Some APIs for dealing with `Map` have been proposed several times,
it's time to bring that into the API. There's some additions for `List` as well,
like a helper to set an element in a list.
**Other goals**
There's a few more things but I'm still exploring their viability.
Keep an eye on the [PRs/issues](https://github.com/wren-lang/wren) or the [0.4.0 label](https://github.com/wren-lang/wren/pulls?q=is%3Apr+is%3Aopen+label%3A0.4.0) to see when they're discussed.
## Till next time
---
- [The Wren Blog RSS](http://wren.io/blog/rss.xml)
- Join the [discord community](https://discord.gg/Kx6PxSX)
- Visit the [wren-lang organization](https://github.com/wren-lang) on GitHub to get involved.
- Follow the developers [@munificentbob](https://twitter.com/munificentbob) or [@ruby0x1](https://twitter.com/ruby0x1) on twitter

View File

@ -0,0 +1,12 @@
^title Development blogs
[<h3>0.3.0 released!</h3>](2-0.3.0-released.html)
> <date>5 June 2020</date> • 0.3.0 release info! Plus some notes and goals for the next release, 0.4.0.
[<h3>0.2.0 and beyond</h3>](1-0.2.0-and-beyond.html)
> <date>30 Sep 2019</date> • Checkpoints, and the plans for 0.3.0.
[<h3>System.print("hello wren")</h3>](0-hello-wren.html)
> <date>4 Feb 2019</date> • A short post introducing the blog, the new maintainer, and the immediate term plans for Wren.

28
doc/site/blog/rss.xml Normal file
View File

@ -0,0 +1,28 @@
<rss version="2.0">
<channel><title>Wren - development blog</title>
<link>https://wren.io/</link>
<description>The development blog of the Wren programming language.</description>
<language>en-us</language>
<item>
<title>0.3.0 released</title>
<link>https://wren.io/blog/2-0.3.0-released.html</link>
<description>0.3.0 release info! Plus some notes and goals for the next release, 0.4.0.</description>
<guid>https://wren.io/blog/2-0.3.0-released.html</guid>
<pubDate>Mon, 30 Sep 2019 00:00:00 GMT</pubDate>
</item>
<item>
<title>0.2.0 and beyond</title>
<link>https://wren.io/blog/1-0.2.0-and-beyond.html</link>
<description>Checkpoints, and the plans for 0.3.0.</description>
<guid>https://wren.io/blog/1-0.2.0-and-beyond.html</guid>
<pubDate>Mon, 30 Sep 2019 00:00:00 GMT</pubDate>
</item>
<item>
<title>System.print("hello wren")</title>
<link>https://wren.io/blog/0-hello-wren.html</link>
<description>A short post introducing the blog, the new maintainer, and the immediate term plans for Wren.</description>
<guid>https://wren.io/blog/0-hello-wren.html</guid>
<pubDate>Mon, 04 Feb 2019 00:00:00 GMT</pubDate>
</item>
</channel>
</rss>

View File

@ -0,0 +1,60 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
<title>{title} &ndash; Wren</title>
<script type="application/javascript" src="../prism.js" data-manual></script>
<script type="application/javascript" src="../wren.js"></script>
<link rel="stylesheet" type="text/css" href="../prism.css" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:400,700,400italic,700italic|Source+Code+Pro:400|Lato:400|Sanchez:400italic,400' rel='stylesheet' type='text/css'>
<!-- Tell mobile browsers we're optimized for them and they don't need to crop
the viewport. -->
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"/>
</head>
<body id="top">
<header>
<div class="page">
<div class="main-column">
<h1><a href="../">wren</a></h1>
<h2>a classy little scripting language</h2>
</div>
</div>
</header>
<div class="page">
<nav class="big">
<a href="../"><img src="../wren.svg" class="logo"></a>
<ul>
<li><a href="../getting-started.html">Getting Started</a></li>
<li><a href="../contributing.html">Contributing</a></li>
<li><a href="../blog">Blog</a></li>
<li><a href="../try">Try it!</a></li>
</ul>
</nav>
<nav class="small">
<table>
<tr>
<td><a href="getting-started.html">Getting Started</a></td>
<td><a href="contributing.html">Contributing</a></td>
</tr>
</table>
</nav>
<main>
<h2>{title}</h2>
{html}
</main>
</div>
<footer>
<div class="page">
<div class="main-column">
<p>Wren lives
<a href="https://github.com/wren-lang/wren">on GitHub</a>
&mdash; Made with &#x2764; by
<a href="http://journal.stuffwithstuff.com/">Bob Nystrom</a> and
<a href="https://github.com/wren-lang/wren/blob/master/AUTHORS">friends</a>.
</p>
<div class="main-column">
</div>
</footer>
</body>
</html>

View File

@ -1,20 +1,25 @@
^title Classes
^category types
Every value in Wren is an object, and every object is an instance of a class.
Even `true` and `false` are full-featured objects&mdash;instances of the
[`Bool`](core/bool.html) class.
[Bool][] class.
Classes contain both *behavior* and *state*. Behavior is defined in *methods*
which are stored in the class. State is defined in *fields*, whose values are
[bool]: modules/core/bool.html
Classes define an objects *behavior* and *state*. Behavior is defined by
[*methods*][method calls] which live in the class. Every object of the same
class supports the same methods. State is defined in *fields*, whose values are
stored in each instance.
[method calls]: method-calls.html
## Defining a class
Classes are created using the `class` keyword, unsurprisingly:
:::wren
class Unicorn {}
<pre class="snippet">
class Unicorn {}
</pre>
This creates a class named `Unicorn` with no methods or fields.
@ -22,199 +27,314 @@ This creates a class named `Unicorn` with no methods or fields.
To let our unicorn do stuff, we need to give it methods.
:::wren
class Unicorn {
prance() {
System.print("The unicorn prances in a fancy manner!")
}
}
<pre class="snippet">
class Unicorn {
prance() {
System.print("The unicorn prances in a fancy manner!")
}
}
</pre>
This defines a `prance()` method that takes no arguments. To support
parameters, put their names inside the parentheses:
This defines a `prance()` method that takes no arguments. To add parameters, put
their names inside the parentheses:
:::wren
class Unicorn {
prance(where, when) {
System.print("The unicorn prances in " + where + " at " + when)
}
}
<pre class="snippet">
class Unicorn {
prance(where, when) {
System.print("The unicorn prances in %(where) at %(when).")
}
}
</pre>
### Signature
Since the number of parameters is part of a method's [signature][] a class can
define multiple methods with the same name:
Unlike most other dynamically-typed languages, in Wren you can have multiple
methods in a class with the same name, as long as they have a different
*signature*. In technical terms, you can *overload by arity*. So this class is
fine:
[signature]: method-calls.html#signature
:::wren
class Unicorn {
prance() {
System.print("The unicorn prances in a fancy manner!")
}
<pre class="snippet">
class Unicorn {
prance() {
System.print("The unicorn prances in a fancy manner!")
}
prance(where) {
System.print("The unicorn prances in " + where)
}
prance(where) {
System.print("The unicorn prances in %(where).")
}
prance(where, when) {
System.print("The unicorn prances in " + where + " at " + when)
}
}
And you can call each of the methods like so:
:::wren
var unicorn = Unicorn.new()
unicorn.prance()
unicorn.prance("Antwerp")
unicorn.prance("Brussels", "high noon")
The number of arguments provided at the callsite determines which method is
chosen.
prance(where, when) {
System.print("The unicorn prances in %(where) at %(when).")
}
}
</pre>
It's often natural to have the same conceptual operation work with different
sets of arguments. In other languages, you'd define a single method for the
operation and have to check for "undefined" or missing arguments. Wren just
treats them as different methods that you can implement separately.
operation and have to check for missing optional arguments. In Wren, they are
different methods that you implement separately.
In addition to named methods with parameter lists, Wren has a bunch of other
different syntaxes for methods. Your classes can define all of them.
### Getters
Many methods on a class exist to expose or compute some property of the object.
For example:
A getter leaves off the parameter list and the parentheses:
:::wren
System.print("string".count) // "6".
These *getters* are just another kind of method&mdash;one without a parameter
list. You can define them like so:
:::wren
class Unicorn {
isFancy { true } // Unicorns are always fancy.
}
Whether or not a method name has parentheses is also part of its signature.
This lets you distinguish between a method that takes an *empty* argument list
(`()`) and no argument list at all:
:::wren
class Confusing {
method { "no argument list" }
method() { "empty argument list" }
}
var confusing = Confusing.new()
confusing.method // "no argument list".
confusing.method() // "empty argument list".
Like the example says, having two methods that differ just by an empty set of
parentheses is pretty confusing. That's not what this is for. Instead, it
ensures that the way you *declare* the method is the way you *call* it.
Unlike other languages with "optional parentheses", Wren wants to make sure you
call a getter like a getter and a `()` method like a `()` method. These don't
work:
:::wren
"string".count()
list.clear
Methods that don't need arguments and don't modify the underlying object are
usually getters:
:::wren
"string".count
(1..10).min
1.23.sin
[1, 2, 3].isEmpty
When a method doesn't need any parameters, but does modify the object, it's
helpful to draw attention to that by requiring an empty set of parentheses:
:::wren
list.clear()
Also, when a method supports multiple arities, it's typical to include the `()`
in the zero-argument case to be consistent with the other versions:
Fn.new { "a function" }.call()
Fiber.yield()
### Operators
Operators are just special syntax for a method call on the left hand operand
(or only operand in the case of unary operators like `!` and `~`). In other
words, you can think of `a + b` as meaning `a.+(b)`.
You can define operators in your class like so:
:::wren
class Unicorn {
// Infix:
+(other) {
System.print("Adding to a unicorn?")
}
// Prefix:
! {
System.print("Negating a unicorn?!")
}
}
This can be used to define any of these operators:
:::wren
// Infix:
+ - * / % < > <= >= == != & |
// Prefix:
! ~ -
Note that `-` can be both a prefix and infix operator. If there's a parameter
list, it's the infix one, otherwise, it's prefix. Since Wren supports
overloading by arity, it's no problem for a class to define both.
### Subscript operators
**TODO**
<pre class="snippet">
class Unicorn {
// Unicorns are always fancy.
isFancy { true }
}
</pre>
### Setters
**TODO**
A setter has `=` after the name, followed by a single parenthesized parameter:
<pre class="snippet">
class Unicorn {
rider=(value) {
System.print("I am being ridden by %(value).")
}
}
</pre>
By convention, the parameter is usually named `value` but you can call it
whatever makes your heart flutter.
### Operators
Prefix operators, like getters, have no parameter list:
<pre class="snippet">
class Unicorn {
- {
System.print("Negating a unicorn is weird.")
}
}
</pre>
Infix operators, like setters, have a single parenthesized parameter for the
right-hand operand:
<pre class="snippet">
class Unicorn {
-(other) {
System.print("Subtracting %(other) from a unicorn is weird.")
}
}
</pre>
A subscript operator puts the parameters inside square brackets and can have
more than one:
<pre class="snippet">
class Unicorn {
[index] {
System.print("Unicorns are not lists!")
}
[x, y] {
System.print("Unicorns are not matrices either!")
}
}
</pre>
Unlike with named methods, you can't define a subscript operator with an empty
parameter list.
As the name implies, a subscript setter looks like a combination of a subscript
operator and a setter:
<pre class="snippet">
class Unicorn {
[index]=(value) {
System.print("You can't stuff %(value) into me at %(index)!")
}
}
</pre>
## Method Scope
Up to this point, "[scope][]" has been used to talk exclusively about
[variables][]. In a procedural language like C, or a functional one like Scheme,
that's the only kind of scope there is. But object-oriented languages like Wren
introduce another kind of scope: *object scope*. It contains the methods that
are available on an object. When you write:
[scope]: variables.html#scope
[variables]: variables.html
<pre class="snippet">
unicorn.isFancy
</pre>
You're saying "look up the method `isFancy` in the scope of the object
`unicorn`&rdquo;. In this case, the fact that you want to look up a *method*
`isFancy` and not a *variable* `isFancy` is explicit. That's what `.` does and
the object to the left of the period is the object you want to look up the
method on.
### `this`
Things get more interesting when you're inside the body of a method. When the
method is called on some object and the body is being executed, you often need
to access that object itself. You can do that using `this`.
<pre class="snippet">
class Unicorn {
name { "Francis" }
printName() {
System.print(this.name) //> Francis
}
}
</pre>
The `this` keyword works sort of like a variable, but has special behavior. It
always refers to the instance whose method is currently being executed. This
lets you invoke methods on "yourself".
It's an error to refer to `this` outside of a method. However, it's perfectly
fine to use it inside a [function][] declared *inside* a method. When you do,
`this` still refers to the instance whose *method* is being called:
<pre class="snippet">
class Unicorn {
name { "Francis" }
printNameThrice() {
(1..3).each {
// Use "this" inside the function passed to each().
System.print(this.name) //> Francis
} //> Francis
} //> Francis
}
</pre>
[function]: functions.html
This is unlike Lua and JavaScript which can "forget" `this` when you create a
callback inside a method. Wren does what you want here and retains the
reference to the original object.
(In technical terms, a function's closure includes `this`. Wren can do this
because it makes a distinction between methods and functions.)
### Implicit `this`
Using `this.` every time you want to call a method on yourself works, but it's
tedious and verbose, which is why some languages don't require it. You can do a
"self send" by calling a method (or getter or setter) without any explicit
receiver:
<pre class="snippet">
class Unicorn {
name { "Francis" }
printName() {
System.print(name) //> Francis
}
}
</pre>
Code like this gets tricky when there is also a variable outside of the class
with the same name. Consider:
<pre class="snippet">
var name = "variable"
class Unicorn {
name { "Francis" }
printName() {
System.print(name) // ???
}
}
</pre>
Should `printName()` print "variable" or "Francis"? A method body has a foot in
each of two worlds. It is surrounded by the lexical scope where it's defined in
the program, but it also has the object scope of the methods on `this`.
Which scope wins? Every language has to decide how to handle this and there
is a surprising plethora of approaches. Wren's approach to resolving a name
inside a method works like this:
1. If there is a local variable inside the method with that name, that wins.
2. Else, if the name starts with a lowercase letter, treat it like a method on
`this`.
3. Otherwise, look for a variable with that name in the surrounding scope.
So, in the above example, we hit case #2 and it prints "Francis". Distinguishing
self sends from outer variables based on the *case* of the first letter in the
name probably seems crazy but it works surprisingly well. Method names are
lowercase in Wren. Class names are capitalized.
Most of the time, when you're in a method and want to access a name from outside
of the class, it's usually the name of some other class. This rule makes that
work.
Here's an example that shows all three cases:
<pre class="snippet">
var shadowed = "surrounding"
var lowercase = "surrounding"
var Capitalized = "surrounding"
class Scope {
shadowed { "object" }
lowercase { "object" }
Capitalized { "object" }
test() {
var shadowed = "local"
System.print(shadowed) //> local
System.print(lowercase) //> object
System.print(Capitalized) //> surrounding
}
}
</pre>
It's a bit of a strange rule, but Ruby works more or less the same way.
## Constructors
Unicorns can prance around now, but we don't actually *have* any unicorns to do
it. To create instances of a class, we need a *constructor*. You can define one
We've seen how to define kinds of objects and how to declare methods on them.
Our unicorns can prance around, but we don't actually *have* any unicorns to do
it. To create *instances* of a class, we need a *constructor*. You define one
like so:
:::wren
class Unicorn {
construct new(name, color) {
System.print("My name is " + name + " and I am " + color + ".")
}
}
<pre class="snippet">
class Unicorn {
construct new(name, color) {
System.print("My name is " + name + " and I am " + color + ".")
}
}
</pre>
The `construct` keyword says we're defining a constructor, and `new` is its
name. In Wren, all constructors have names, just like [methods][#methods]. The
word "new" isn't special to Wren, it's just a common constructor name.
name. In Wren, all constructors have names. The word "new" isn't special to
Wren, it's just a common constructor name.
To make a unicorn now, we just call the constructor method on the class itself:
To make a unicorn now, we call the constructor method on the class itself:
:::wren
var fred = Unicorn.new("Fred", "palomino")
<pre class="snippet">
var fred = Unicorn.new("Fred", "palomino")
</pre>
Giving constructors names is handy because it means you can have more than one,
and each can clarify how it creates the instance:
:::wren
class Unicorn {
construct brown(name) {
System.print("My name is " + name + " and I am brown.")
}
}
<pre class="snippet">
class Unicorn {
construct brown(name) {
System.print("My name is " + name + " and I am brown.")
}
}
var dave = Unicorn.brown("Dave")
var dave = Unicorn.brown("Dave")
</pre>
Note that we have to declare a constructor because, unlike some other
languages, Wren doesn't give you a default one. This is useful because some
@ -229,8 +349,9 @@ constructors.
A constructor is actually a pair of methods. You get a method on the class:
:::wren
Unicorn.brown("Dave")
<pre class="snippet">
Unicorn.brown("Dave")
</pre>
That creates the new instance, then it invokes the *initializer* on that
instance. This is where the constructor body you defined gets run.
@ -241,15 +362,16 @@ constructors, etc.
## Fields
All state stored in instances is stored in *fields*. Each field has a named
All state stored in instances is stored in *fields*. Each field has a name
that starts with an underscore.
:::wren
class Rectangle {
area { _width * _height }
<pre class="snippet">
class Rectangle {
area { _width * _height }
// Other stuff...
}
// Other stuff...
}
</pre>
Here, `_width` and `_height` in the `area` [getter](classes.html#methods) refer
to fields on the rectangle instance. You can think of them like `this.width`
@ -268,27 +390,63 @@ value is `null`.
### Encapsulation
All fields are *private* in Wren&mdash;an object's fields can only be directly
accessed from within methods defined on the object's class. You cannot even
access fields on another instance of your own class, unlike C++ and Java.
accessed from within methods defined on the object's class.
If you want to make a property of an object visible, you need to define a
getter to expose it:
In short, if you want to make a property of an object visible,
**you need to define a getter to expose it**:
:::wren
class Rectangle {
width { _width }
height { _height }
<pre class="snippet">
class Rectangle {
width { _width }
height { _height }
// ...
}
// ...
}
</pre>
To allow outside code to modify the field, you'll also need to provide setters:
To allow outside code to modify the field,
**you need to provide setters to provide access**:
:::wren
class Rectangle {
width=(value) { _width = value }
height=(value) { _height = value }
}
<pre class="snippet">
class Rectangle {
width=(value) { _width = value }
height=(value) { _height = value }
}
</pre>
This might be different from what you're used to, so here are two important facts:
- You can't access fields from a base class.
- You can't access fields on another instance of your own class.
Here is an example in code:
<pre class="snippet">
class Shape {
construct new() {
_shape = "none"
}
}
class Rectangle is Shape {
construct new() {
//This will print null!
//_shape from the parent class is private,
//we are reading `_shape` from `this`,
//which has not been set, so returns null.
System.print("I am a %(_shape)")
//a local variable, all variables are private
_width = 10
var other = Rectangle.new()
//other._width is not accessible from here,
//even though we are also a rectangle. The field
//is private, and other._width is invalid syntax!
}
}
...
</pre>
One thing we've learned in the past forty years of software engineering is that
encapsulating state tends to make code easier to maintain, so Wren defaults to
@ -305,44 +463,46 @@ A name that starts with *two* underscores is a *static* field. They work
similar to [fields](#fields) except the data is stored on the class itself, and
not the instance. They can be used in *both* instance and static methods.
:::wren
class Foo {
// Set the static field.
static set(a) {
__a = a
}
<pre class="snippet">
class Foo {
construct new() {}
setFromInstance(a) {
__a = a
}
static setFromStatic(a) { __a = a }
setFromInstance(a) { __a = a }
// Can use __a in both static methods...
static bar { __a }
static printFromStatic() {
System.print(__a)
}
// ...and instance ones.
baz { __a }
}
printFromInstance() {
System.print(__a)
}
}
</pre>
Just like instance fields, static fields are initially `null`:
:::wren
System.print(Foo.bar) // null.
<pre class="snippet">
Foo.printFromStatic() //> null
</pre>
They can be used from static methods:
:::wren
Foo.set("foo")
System.print(Foo.bar) // foo.
<pre class="snippet">
Foo.setFromStatic("first")
Foo.printFromStatic() //> first
</pre>
And also instance methods. When you do so, there is still only one static field
shared among all instances of the class:
:::wren
var foo1 = Foo.new()
var foo2 = Foo.new()
<pre class="snippet">
var foo1 = Foo.new()
var foo2 = Foo.new()
foo1.setFromInstance("updated")
System.print(foo2.baz) // updated.
foo1.setFromInstance("second")
foo2.printFromInstance() //> second
</pre>
## Inheritance
@ -350,44 +510,50 @@ A class can inherit from a "parent" or *superclass*. When you invoke a method
on an object of some class, if it can't be found, it walks up the chain of
superclasses looking for it there.
By default, any new class inherits from `Object`, which is the superclass from
By default, any new class inherits from Object, which is the superclass from
which all other classes ultimately descend. You can specify a different parent
class using `is` when you declare the class:
:::wren
class Pegasus is Unicorn {}
<pre class="snippet">
class Pegasus is Unicorn {}
</pre>
This declares a new class `Pegasus` that inherits from `Unicorn`.
This declares a new class Pegasus that inherits from Unicorn.
Note that you should not create classes that inherit from the built-in types (Bool, Num, String, Range, List). The built-in types expect their internal bit representation to be very specific and get horribly confused when you invoke one of the inherited built-in methods on the derived type.
Note that you should not create classes that inherit from the built-in types
(Bool, Num, String, Range, List). The built-in types expect their internal bit
representation to be very specific and get horribly confused when you invoke one
of the inherited built-in methods on the derived type.
The metaclass hierarchy does *not* parallel the regular class hierarchy. So, if
`Pegasus` inherits from `Unicorn`, `Pegasus`'s metaclass will not inherit from
`Unicorn`'s metaclass. In more prosaic terms, this means that static methods
are not inherited.
Pegasus inherits from Unicorn, Pegasus's metaclass does not inherit from
Unicorn's metaclass. In more prosaic terms, this means that static methods are
not inherited.
:::wren
class Unicorn {
// Unicorns cannot fly. :(
static canFly { false }
}
<pre class="snippet">
class Unicorn {
// Unicorns cannot fly. :(
static canFly { false }
}
class Pegasus is Unicorn {}
class Pegasus is Unicorn {}
Pegasus.canFly // ERROR: Static methods are not inherited.
Pegasus.canFly //! Static methods are not inherited.
</pre>
This also means constructors are not inherited:
:::wren
class Unicorn {
this new(name) {
System.print("My name is " + name + ".")
}
}
<pre class="snippet">
class Unicorn {
construct new(name) {
System.print("My name is " + name + ".")
}
}
class Pegasus is Unicorn {}
class Pegasus is Unicorn {}
Pegasus.new("Fred") // Error!
Pegasus.new("Fred") //! Pegasus does not define new().
</pre>
Each class gets to control how it may be constructed independently of its base
classes. However, constructor *initializers* are inherited since those are
@ -395,17 +561,66 @@ instance methods on the new object.
This means you can do `super` calls inside a constructor:
:::wren
class Unicorn {
this new(name) {
System.print("My name is " + name + ".")
}
}
<pre class="snippet">
class Unicorn {
construct new(name) {
System.print("My name is " + name + ".")
}
}
class Pegasus is Unicorn {
this new(name) {
super(name)
}
}
class Pegasus is Unicorn {
construct new(name) {
super(name)
}
}
Pegasus.new("Fred") // Prints "My name is Fred.".
Pegasus.new("Fred") //> My name is Fred
</pre>
## Super
**TODO: Integrate better into page. Should explain this before mentioning
super above.**
Sometimes you want to invoke a method on yourself, but using methods defined in
one of your [superclasses](classes.html#inheritance). You typically do this in
an overridden method when you want to access the original method being
overridden.
To do that, you can use the special `super` keyword as the receiver in a method
call:
<pre class="snippet">
class Base {
method() {
System.print("base method")
}
}
class Derived is Base {
method() {
super.method() //> base method
}
}
</pre>
You can also use `super` without a method name inside a constructor to invoke a
base class constructor:
<pre class="snippet">
class Base {
construct new(arg) {
System.print("base got " + arg)
}
}
class Derived is Base {
construct new() {
super("value") //> base got value
}
}
</pre>
<br><hr>
<a class="right" href="concurrency.html">Concurrency &rarr;</a>
<a href="functions.html">&larr; Functions</a>

View File

@ -0,0 +1,30 @@
^title Wren CLI
---
## What is it?
**The Wren Command-Line Interface** is a tool you can run which gives you a way to run Wren code, and
also includes modules for talking to the operating system&mdash;file IO,
networking, stuff like that. It depends on [libuv][] for that
functionality.
Wren as a language is intentionally designed to be minimal.
That includes the built in language features, the standard library and the VM itself.
In order to access files, networks and other IO, you'd need to make a tool _using_ the language VM.
That's what the CLI project is! It is not bundled as part of the wren project,
instead it is it's own project as a standalone tool you can run.
It exposes it's own standard library and modules that may be of interest
if looking for a general purpose single binary scriptable tool.
Wren CLI is a work in progress, and contributions are welcome to make it more useful over time.
## Why does it exist?
- It's fun to make things.
- It's always a good idea to test the language you're making!
- Interest was expressed in a scriptable tool using the Wren language.
- It's helpful for others to learn from, since it is a real world usage example showing several concepts.
[libuv]: http://libuv.org/

View File

@ -0,0 +1,16 @@
^title CLI Modules
The Wren CLI executable extends the built in language modules with it's own,
which offer access to IO and other facilities for scripting.
The CLI modules are deeply tied to [libuv][], each other, and other internals
of the command-line app, so can't easily be separated out and pulled into host
applications that want to embed Wren. Scripts written for the CLI then,
are specific to the CLI unless another host implements the same API.
[libuv]: http://libuv.org
* [io](io)
* [os](os)
* [scheduler](scheduler)
* [timer](timer)

View File

@ -0,0 +1,15 @@
^title Directory Class
A directory on the file system.
## Static Methods
### Directory.**exists**(path)
Whether a directory exists at `path`. This returns `false` for files or other
special file system entities.
### Directory.**list**(path)
Lists the contents of the directory at `path`. Returns a sorted list of path
strings for all of the contents of the directory.

View File

@ -0,0 +1,48 @@
^title FileFlags Class
Contains constants for the various file flags used to open or create a file.
These correspond directly to the flags that can be passed to the POSIX
[`open()`][open] syscall.
[open]: http://linux.die.net/man/2/open
They are integers and can be bitwise or'ed together to produce a composite
flag.
## Static Methods
### FileFlags.**readOnly**
The file can be read from but not written. Equivalent to `O_RDONLY`.
### FileFlags.**writeOnly**
The file can be written but not read from. Equivalent to `O_WRONLY`.
### FileFlags.**readWrite**
The file can be both read from and written to. Equivalent to `O_RDWR`.
### FileFlags.**sync**
Writes will block until the data has been physically written to the underling
hardware. This does *not* affect whether or the file API is synchronous. File
operations are always asynchronous in Wren and may allow other scheduled fibers
to run.
This is a lower-level flag that ensures that when a write completes, it has
been flushed all the way to disc.
### FileFlags.**create**
Creates a new file if a file at the given path does not already exist.
### FileFlags.**truncate**
If the file already exists and can be written to, its previous contents are
discarded.
### FileFlags.**exclusive**
Ensures that a new file must be created. If a file already exists at the given
path, this flag will cause the operation to fail.

View File

@ -0,0 +1,138 @@
^title File Class
Lets you work with files on the file system. An instance of this class
represents an open file with a file descriptor.
When you are done with a file object, it's a good idea to explicitly close it.
If you don't, the GC will close it when the file is no longer used and gets
finalized, but that may take a while. In the meantime, leaving it open wastes
a file descriptor.
## Static Methods
### File.**create**(path, fn)
Opens the file at `path` for writing and passes it to `fn`. If there is already
a file at that path, it is truncated. After the function returns, the file is
automatically closed.
<pre class="snippet">
File.create("numbers.txt") {|file|
file.writeBytes("one two three")
}
</pre>
### File.**delete**(path)
Deletes the file at `path`.
### File.**exists**(path)
Whether a regular file exists at `path`. This returns `false` for directories
or other special file system entities.
### File.**open**(path, fn)
Opens the file at `path` for reading and passes it to `fn`. After the function
returns, the file is automatically closed.
<pre class="snippet">
File.open("words.txt") {|file|
file.readBytes(5)
}
</pre>
### File.**read**(path)
Reads the entire contents of the file at `path` and returns it as a string.
<pre class="snippet">
File.read("words.txt")
</pre>
No encoding or decoding is done. If the file is UTF-8, then the resulting
string will be a UTF-8 string. Otherwise, it will be a string of bytes in
whatever encoding the file uses.
### File.**realPath**(path)
Resolves `path`, traversing symlinks and removining any unneeded `./` and `../`
components. Returns the canonical absolute path to the file.
<pre class="snippet">
var path = "/some/./symlink/a/../b/file.txt"
System.print(File.realPath(path)) //> /real/path/a/file.txt
</pre>
### File.**size**(path)
Returns the size in bytes of the contents of the file at `path`.
## Constructors
### File.**create**(path)
Opens the file at `path` for writing. If there is already a file at that path,
it is truncated.
<pre class="snippet">
var file = File.create("colors.txt")
file.writeBytes("chartreuse lime teal")
file.close()
</pre>
### File.**open**(path)
Opens the file at `path` for reading. You are responsible for closing it when
done with it.
## Methods
### **descriptor**
The numeric file descriptor used to access the file.
### **isOpen**
Whether the file is still open or has been closed.
### **size**
The size of the contents of the file in bytes.
### **close**()
Closes the file. After calling this, you can't read or write from it.
### **readBytes**(count)
Reads up to `count` bytes starting from the beginning of the file.
<pre class="snippet">
// Assume this file contains "I am a file!".
File.open("example.txt") {|file|
System.print(file.readBytes(6)) //> I am a
}
</pre>
### **readBytes**(count, offset)
Reads up to `count` bytes starting at `offset` bytes from the beginning of
the file.
<pre class="snippet">
// Assume this file contains "I am a file!".
File.open("example.txt") {|file|
System.print(file.readBytes(6, 2)) //> am a f
}
</pre>
### **writeBytes**(bytes)
Writes the raw bytes of the string `bytes` to the end of the file.
### **writeBytes**(bytes, offset)
Writes the raw bytes of the string `bytes` to the to the file, starting at
`offset`. Any overlapping bytes already in the file at the offset are
overwritten.

View File

@ -0,0 +1,9 @@
^title Module "io"
Provides access to operating system streams and the file system.
* [Directory](directory.html)
* [File](file.html)
* [Stat](stat.html)
* [Stdin](stdin.html)
* [Stdout](stdout.html)

View File

@ -0,0 +1,63 @@
^title Stat Class
A data structure describing the low-level details of a file system entry.
## Static Methods
### Stat.**path**(path)
"Stats" the file or directory at `path`.
## Methods
### **blockCount**
The number of system blocks allocated on disk for the file.
### **blockSize**
The preferred block size in bytes for interacting with the file. It may vary
from file to file.
### **device**
The ID of the device containing the entry.
### **group**
Numeric group ID of the file's owner.
### **inode**
The [inode][] number of the entry.
[inode]: https://en.wikipedia.org/wiki/Inode
### **isDirectory**
Whether the file system entity is a directory.
### **isFile**
Whether the file system entity is a regular file, as opposed to a directory or
other special entity.
### **linkCount**
The number of hard links to the entry.
### **mode**
A bit field describing the entry's type and protection flags.
### **size**
The size of the entry in bytes.
### **specialDevice**
The device ID for the entry, if it's a special file.
### **user**
Numeric user ID of the file's owner.

View File

@ -0,0 +1,45 @@
^title Stdin Class
The standard input stream.
## Static Methods
### **isRaw**
Returns `true` if stdin is in raw mode. When in raw mode, input is not echoed
or buffered, and all characters, even non-printing and control characters go
into stdin.
Defaults to `false`.
### **isRaw**=(value)
Sets raw mode on or off.
### **isTerminal**
Returns `true` if Stdin is connected to a "TTY". This is true when the user is
running Wren in an interactive terminal, and false if it its input is coming
from a pipe.
### **readByte**()
Reads one byte of input from stdin. Blocks the current fiber until a byte has
been received.
Returns the byte value as a number or `null` if stdin is closed.
Note that output is not automatically flushed when calling this. If you want to
display a prompt before reading input, you'll want to call `Stdout.flush()`
after printing the prompt.
### **readLine**()
Reads one line of input from stdin. Blocks the current fiber until a full line
of input has been received.
Returns the string of input or `null` if stdin is closed.
Note that output is not automatically flushed when calling this. If you want to
display a prompt before reading input, you'll want to call `Stdout.flush()`
after printing the prompt.

View File

@ -0,0 +1,11 @@
^title Stdout Class
The standard output stream.
## Static Methods
### **flush()**
Flushes all buffered data to the stream. Ensures any data written to stdout
that is in the buffer gets written to the file or terminal that stdout is
connected to.

View File

@ -0,0 +1,89 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
<title>{title} &ndash; Wren</title>
<script type="application/javascript" src="../../../prism.js" data-manual></script>
<script type="application/javascript" src="../../../wren.js"></script>
<link rel="stylesheet" type="text/css" href="../../../prism.css" />
<link rel="stylesheet" type="text/css" href="../../../style.css" />
<link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:400,700,400italic,700italic|Source+Code+Pro:400|Lato:400|Sanchez:400italic,400' rel='stylesheet' type='text/css'>
<!-- Tell mobile browsers we're optimized for them and they don't need to crop
the viewport. -->
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"/>
</head>
<body id="top" class="module">
<header>
<div class="page">
<div class="main-column">
<h1><a href="../../../">wren</a></h1>
<h2>a classy little scripting language</h2>
</div>
</div>
</header>
<div class="page">
<nav class="big">
<a href="../../../"><img src="../../../wren.svg" class="logo"></a>
<ul>
<li><a href="../../">Back to Wren CLI</a></li>
<li><a href="../">Back to CLI Modules</a></li>
<li><a href="./">io module</a></li>
</ul>
<section>
<h2>io classes</h2>
<ul>
<li><a href="directory.html">Directory</a></li>
<li><a href="file.html">File</a></li>
<li><a href="file-flags.html">FileFlags</a></li>
<li><a href="stat.html">Stat</a></li>
<li><a href="stdin.html">Stdin</a></li>
<li><a href="stdout.html">Stdout</a></li>
</ul>
</section>
</nav>
<nav class="small">
<table>
<tr>
<td><a href="../">Back to CLI Modules</a></td>
<td><a href="./">io module</a></td>
</tr>
<tr>
<td colspan="2"><h2>io classes</h2></td>
</tr>
<tr>
<td>
<ul>
<li><a href="directory.html">Directory</a></li>
<li><a href="file.html">File</a></li>
<li><a href="file-flags.html">FileFlags</a></li>
</ul>
</td>
<td>
<ul>
<li><a href="stat.html">Stat</a></li>
<li><a href="stdin.html">Stdin</a></li>
<li><a href="stdout.html">Stdout</a></li>
</ul>
</td>
</tr>
</table>
</nav>
<main>
<h1>{title}</h1>
{html}
</main>
</div>
<footer>
<div class="page">
<div class="main-column">
<p>Wren lives
<a href="https://github.com/wren-lang/wren">on GitHub</a>
&mdash; Made with &#x2764; by
<a href="http://journal.stuffwithstuff.com/">Bob Nystrom</a> and
<a href="https://github.com/wren-lang/wren/blob/master/AUTHORS">friends</a>.
</p>
<div class="main-column">
</div>
</footer>
</body>
</html>

View File

@ -0,0 +1,7 @@
^title Module "os"
The os module exposes classes for accessing capabilities provided by the
underlying operating system.
* [Platform](platform.html)
* [Process](process.html)

View File

@ -0,0 +1,30 @@
^title Platform Class
The Platform class exposes basic information about the operating system Wren is
running on top of.
## Static Methods
### **name**
The name of the platform. This roughly describes the operating system, and is
usually one of:
* "iOS"
* "Linux"
* "OS X"
* "POSIX"
* "Unix"
* "Windows"
If Wren was compiled for an unknown operating system, returns "Unknown".
### **isPosix**
Returns `true` if the host operating system is known to support the POSIX
standard. This is true for Linux and other Unices, as well as the various Apple
operating systems.
### **isWindows**
Returns `true` if the host operating system is some flavor of Windows.

View File

@ -0,0 +1,38 @@
^title Process Class
The Process class lets you work with operating system processes, including the
currently running one.
## Static Methods
### **allArguments**
The list of command-line arguments that were passed when the Wren process was
spawned. This includes the Wren executable itself, the path to the file being
run (if any), and any other options passed to Wren itself.
If you run:
$ wren file.wren arg
This returns:
<pre class="snippet">
System.print(Process.allArguments) //> ["wren", "file.wren", "arg"]
</pre>
### **arguments**
The list of command-line arguments that were passed to your program when the
Wren process was spawned. This does not include arguments handled by Wren
itself.
If you run:
$ wren file.wren arg
This returns:
<pre class="snippet">
System.print(Process.arguments) //> ["arg"]
</pre>

View File

@ -0,0 +1,81 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
<title>{title} &ndash; Wren</title>
<script type="application/javascript" src="../../../prism.js" data-manual></script>
<script type="application/javascript" src="../../../wren.js"></script>
<link rel="stylesheet" type="text/css" href="../../../prism.css" />
<link rel="stylesheet" type="text/css" href="../../../style.css" />
<link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:400,700,400italic,700italic|Source+Code+Pro:400|Lato:400|Sanchez:400italic,400' rel='stylesheet' type='text/css'>
<!-- Tell mobile browsers we're optimized for them and they don't need to crop
the viewport. -->
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"/>
</head>
<body id="top" class="module">
<header>
<div class="page">
<div class="main-column">
<h1><a href="../../../">wren</a></h1>
<h2>a classy little scripting language</h2>
</div>
</div>
</header>
<div class="page">
<nav class="big">
<a href="../../../"><img src="../../../wren.svg" class="logo"></a>
<ul>
<li><a href="../../">Back to Wren CLI</a></li>
<li><a href="../">Back to CLI Modules</a></li>
<li><a href="./">os module</a></li>
</ul>
<section>
<h2>os classes</h2>
<ul>
<li><a href="platform.html">Platform</a></li>
<li><a href="process.html">Process</a></li>
</ul>
</section>
</nav>
<nav class="small">
<table>
<tr>
<td><a href="../">Back to CLI Modules</a></td>
<td><a href="./">os module</a></td>
</tr>
<tr>
<td colspan="2"><h2>os classes</h2></td>
</tr>
<tr>
<td>
<ul>
<li><a href="platform.html">Platform</a></li>
<li><a href="process.html">Process</a></li>
</ul>
</td>
<td>
<ul>
</ul>
</td>
</tr>
</table>
</nav>
<main>
<h1>{title}</h1>
{html}
</main>
</div>
<footer>
<div class="page">
<div class="main-column">
<p>Wren lives
<a href="https://github.com/wren-lang/wren">on GitHub</a>
&mdash; Made with &#x2764; by
<a href="http://journal.stuffwithstuff.com/">Bob Nystrom</a> and
<a href="https://github.com/wren-lang/wren/blob/master/AUTHORS">friends</a>.
</p>
<div class="main-column">
</div>
</footer>
</body>
</html>

View File

@ -0,0 +1,5 @@
^title Module "scheduler"
**TODO**
* [Scheduler](scheduler.html)

View File

@ -0,0 +1,7 @@
^title Scheduler Class
**TODO**
## Methods
**TODO**

View File

@ -0,0 +1,79 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
<title>{title} &ndash; Wren</title>
<script type="application/javascript" src="../../../prism.js" data-manual></script>
<script type="application/javascript" src="../../../wren.js"></script>
<link rel="stylesheet" type="text/css" href="../../../prism.css" />
<link rel="stylesheet" type="text/css" href="../../../style.css" />
<link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:400,700,400italic,700italic|Source+Code+Pro:400|Lato:400|Sanchez:400italic,400' rel='stylesheet' type='text/css'>
<!-- Tell mobile browsers we're optimized for them and they don't need to crop
the viewport. -->
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"/>
</head>
<body id="top" class="module">
<header>
<div class="page">
<div class="main-column">
<h1><a href="../../../">wren</a></h1>
<h2>a classy little scripting language</h2>
</div>
</div>
</header>
<div class="page">
<nav class="big">
<a href="../../../"><img src="../../../wren.svg" class="logo"></a>
<ul>
<li><a href="../../">Back to Wren CLI</a></li>
<li><a href="../">Back to CLI Modules</a></li>
<li><a href="./">scheduler module</a></li>
</ul>
<section>
<h2>scheduler classes</h2>
<ul>
<li><a href="scheduler.html">Scheduler</a></li>
</ul>
</section>
</nav>
<nav class="small">
<table>
<tr>
<td><a href="../">Back to CLI Modules</a></td>
<td><a href="./">scheduler module</a></td>
</tr>
<tr>
<td colspan="2"><h2>scheduler classes</h2></td>
</tr>
<tr>
<td>
<ul>
<li><a href="scheduler.html">Scheduler</a></li>
</ul>
</td>
<td>
<ul>
</ul>
</td>
</tr>
</table>
</nav>
<main>
<h1>{title}</h1>
{html}
</main>
</div>
<footer>
<div class="page">
<div class="main-column">
<p>Wren lives
<a href="https://github.com/wren-lang/wren">on GitHub</a>
&mdash; Made with &#x2764; by
<a href="http://journal.stuffwithstuff.com/">Bob Nystrom</a> and
<a href="https://github.com/wren-lang/wren/blob/master/AUTHORS">friends</a>.
</p>
<div class="main-column">
</div>
</footer>
</body>
</html>

View File

@ -0,0 +1,94 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
<title>{title} &ndash; Wren</title>
<script type="application/javascript" src="../../prism.js" data-manual></script>
<script type="application/javascript" src="../../wren.js"></script>
<link rel="stylesheet" type="text/css" href="../../prism.css" />
<link rel="stylesheet" type="text/css" href="../../style.css" />
<link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:400,700,400italic,700italic|Source+Code+Pro:400|Lato:400|Sanchez:400italic,400' rel='stylesheet' type='text/css'>
<!-- Tell mobile browsers we're optimized for them and they don't need to crop
the viewport. -->
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"/>
</head>
<body id="top" class="module">
<header>
<div class="page">
<div class="main-column">
<h1><a href="../../">wren</a></h1>
<h2>a classy little scripting language</h2>
</div>
</div>
</header>
<div class="page">
<nav class="big">
<a href="../../"><img src="../../wren.svg" class="logo"></a>
<ul>
<li><a href="../">Back to Wren CLI</a></li>
</ul>
<section>
<h2>Built In</h2>
<ul>
<li><a href="../../modules">Wren modules</a></li>
</ul>
</section>
<section>
<h2>CLI modules</h2>
<ul>
<li><a href="io">io</a></li>
<li><a href="os">os</a></li>
<li><a href="scheduler">scheduler</a></li>
<li><a href="timer">timer</a></li>
</ul>
</section>
</nav>
<nav class="small">
<table>
<tr>
<td><h2>core</h2></td>
<td><h2>optional</h2></td>
<td><h2>cli</h2></td>
</tr>
<tr>
<td>
<ul>
<li><a href="core">core</a></li>
</ul>
</td>
<td>
<ul>
<li><a href="meta">meta</a></li>
<li><a href="random">random</a></li>
</ul>
</td>
<td>
<ul>
<li><a href="io">io</a></li>
<li><a href="os">os</a></li>
<li><a href="scheduler">scheduler</a></li>
<li><a href="timer">timer</a></li>
</ul>
</td>
</tr>
</table>
</nav>
<main>
<h1>{title}</h1>
{html}
</main>
</div>
<footer>
<div class="page">
<div class="main-column">
<p>Wren lives
<a href="https://github.com/wren-lang/wren">on GitHub</a>
&mdash; Made with &#x2764; by
<a href="http://journal.stuffwithstuff.com/">Bob Nystrom</a> and
<a href="https://github.com/wren-lang/wren/blob/master/AUTHORS">friends</a>.
</p>
<div class="main-column">
</div>
</footer>
</body>
</html>

View File

@ -0,0 +1,5 @@
^title Module "timer"
**TODO**
* [Timer](timer.html)

View File

@ -0,0 +1,79 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
<title>{title} &ndash; Wren</title>
<script type="application/javascript" src="../../../prism.js" data-manual></script>
<script type="application/javascript" src="../../../wren.js"></script>
<link rel="stylesheet" type="text/css" href="../../../prism.css" />
<link rel="stylesheet" type="text/css" href="../../../style.css" />
<link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:400,700,400italic,700italic|Source+Code+Pro:400|Lato:400|Sanchez:400italic,400' rel='stylesheet' type='text/css'>
<!-- Tell mobile browsers we're optimized for them and they don't need to crop
the viewport. -->
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"/>
</head>
<body id="top" class="module">
<header>
<div class="page">
<div class="main-column">
<h1><a href="../../../">wren</a></h1>
<h2>a classy little scripting language</h2>
</div>
</div>
</header>
<div class="page">
<nav class="big">
<a href="../../../"><img src="../../../wren.svg" class="logo"></a>
<ul>
<li><a href="../../">Back to Wren CLI</a></li>
<li><a href="../">Back to CLI Modules</a></li>
<li><a href="./">timer module</a></li>
</ul>
<section>
<h2>timer classes</h2>
<ul>
<li><a href="timer.html">Timer</a></li>
</ul>
</section>
</nav>
<nav class="small">
<table>
<tr>
<td><a href="../">Back to CLI Modules</a></td>
<td><a href="./">timer module</a></td>
</tr>
<tr>
<td colspan="2"><h2>timer classes</h2></td>
</tr>
<tr>
<td>
<ul>
<li><a href="timer.html">Timer</a></li>
</ul>
</td>
<td>
<ul>
</ul>
</td>
</tr>
</table>
</nav>
<main>
<h1>{title}</h1>
{html}
</main>
</div>
<footer>
<div class="page">
<div class="main-column">
<p>Wren lives
<a href="https://github.com/wren-lang/wren">on GitHub</a>
&mdash; Made with &#x2764; by
<a href="http://journal.stuffwithstuff.com/">Bob Nystrom</a> and
<a href="https://github.com/wren-lang/wren/blob/master/AUTHORS">friends</a>.
</p>
<div class="main-column">
</div>
</footer>
</body>
</html>

View File

@ -0,0 +1,7 @@
^title Timer Class
**TODO**
## Methods
**TODO**

View File

@ -0,0 +1,88 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
<title>{title} &ndash; Wren</title>
<script type="application/javascript" src="../prism.js" data-manual></script>
<script type="application/javascript" src="../wren.js"></script>
<link rel="stylesheet" type="text/css" href="../prism.css" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:400,700,400italic,700italic|Source+Code+Pro:400|Lato:400|Sanchez:400italic,400' rel='stylesheet' type='text/css'>
<!-- Tell mobile browsers we're optimized for them and they don't need to crop
the viewport. -->
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"/>
</head>
<body id="top">
<header>
<div class="page">
<div class="main-column">
<h1><a href="../">wren</a></h1>
<h2>a classy little scripting language</h2>
</div>
</div>
</header>
<div class="page">
<nav class="big">
<a href="../"><img src="../wren.svg" class="logo"></a>
<ul>
<li><a href="../">Back to Wren</a></li>
</ul>
<section>
<h2>Wren CLI</h2>
<ul>
<li><a href="./">About</a></li>
<li><a target="_blank" href="https://github.com/wren-lang/wren-cli/releases">Downloads</a></li>
<li><a href="usage.html">Usage</a></li>
</ul>
</section>
<section>
<h2>API docs</h2>
<ul>
<li><a href="modules">CLI Modules</a></li>
</ul>
</section>
</nav>
<nav class="small">
<table>
<tr>
<div><a href="../">Back to Wren</a></div>
</tr>
<tr>
<td><h2>CLI</h2></td>
<td><h2>API</h2></td>
</tr>
<tr>
<td>
<ul>
<li><a href="./">About</a></li>
<li><a target="_blank" href="https://github.com/wren-lang/wren-cli/releases">Downloads</a></li>
<li><a href="usage.html">Usage</a></li>
</ul>
</td>
<td>
<ul>
<li><a href="modules">CLI Modules</a></li>
</ul>
</td>
</tr>
</table>
</nav>
<main>
<h2>{title}</h2>
{html}
</main>
</div>
<footer>
<div class="page">
<div class="main-column">
<p>Wren lives
<a href="https://github.com/wren-lang/wren">on GitHub</a>
&mdash; Made with &#x2764; by
<a href="http://journal.stuffwithstuff.com/">Bob Nystrom</a> and
<a href="https://github.com/wren-lang/wren/blob/master/AUTHORS">friends</a>.
</p>
<div class="main-column">
</div>
</footer>
</body>
</html>

View File

@ -0,0 +1,55 @@
^title Wren CLI Usage
---
You can [download a build for your OS from the releases page](https://github.com/wren-lang/wren-cli/releases).
### Interactive mode
If you just run `wren` without any arguments, it starts the interpreter in
interactive mode, where you can type in a line of code, and it immediately executes
it. You can exit the interpreter using good old Ctrl-C or Ctrl-D.
Here's something to try:
<pre class="snippet">
System.print("Hello, world!")
</pre>
Or a little more exciting:
<pre class="snippet">
for (i in 1..10) System.print("Counting up %(i)")
</pre>
### Running scripts
The standalone interpreter can also load scripts from files and run them. Just
pass the name of the script to `wren`. Create a file named "my_script.wren" in
your favorite text editor and paste this into it:
<pre class="snippet">
for (yPixel in 0...24) {
var y = yPixel / 12 - 1
for (xPixel in 0...80) {
var x = xPixel / 30 - 2
var x0 = x
var y0 = y
var iter = 0
while (iter < 11 && x0 * x0 + y0 * y0 <= 4) {
var x1 = (x0 * x0) - (y0 * y0) + x
var y1 = 2 * x0 * y0 + y
x0 = x1
y0 = y1
iter = iter + 1
}
System.write(" .-:;+=xX$& "[iter])
}
System.print("")
}
</pre>
Now run:
$ ./wren my_script.wren

View File

@ -1,49 +0,0 @@
^title Community
^category reference
Like the [bird](https://en.wikipedia.org/wiki/Wren), Wren's community is small,
but it exists!
## User group
There's one Wren user group, and it's the [official Wren mailing
list](https://groups.google.com/forum/#!forum/wren-lang). Please join it and
say hello! There are no strangers to Wren, just friends we haven't met yet.
## Libraries
There are some third-party libraries that are written in Wren. Here's the list:
- [Please](https://github.com/EvanHahn/wren-please): An assertion library.
- [wren-colors](https://github.com/gsmaverick/wren-colors): Print colored
messages to the terminal.
- [wren-test](https://github.com/gsmaverick/wren-test): A testing framework.
- [wren-vector3d](https://github.com/EvanHahn/wren-vector3d): 3D vectors.
## Language bindings
Want to host a Wren VM within another language. Try these:
- [JavaScript: ppvk/wrenjs](https://github.com/ppvk/wrenjs)
- [Rust: tilpner/wren-sys](https://github.com/tilpner/wren-sys)
- [Rust: pwoolcoc/wren-sys](https://github.com/pwoolcoc/wren-sys)
- [Rust: pwoolcoc/wren-rs](https://github.com/pwoolcoc/wren-rs)
## Editor integrations
If you want Wren syntax highlighting in your editor, look no further:
- [Emacs](https://github.com/v2e4lisp/wren-mode.el)
- [Sublime Text](https://github.com/munificent/wren-sublime)
- [Vim](https://github.com/lluchs/vim-wren)
## Tools and Utilities
Things that make life easier:
- [The Wren Nest](http://ppvk.github.io/wren-nest/): Run and share Wren in your
browser.
Do you have anything to add here? Send a [pull request][]!
[pull request]: https://github.com/munificent/wren/pulls

View File

@ -0,0 +1,194 @@
^title Concurrency
Lightweight concurrency is a key feature of Wren and it is expressed using
*fibers*. They control how all code is executed, and take the place of
exceptions in [error handling](error-handling.html).
Fibers are a bit like threads except they are *cooperatively* scheduled. That
means Wren doesn't pause one fiber and switch to another until you tell it to.
You don't have to worry about context switches at random times and all of the
headaches those cause.
Wren takes care of all of the fibers in the VM, so they don't use OS thread
resources, or require heavyweight context switches. Each just needs a bit of
memory for its stack. A fiber will get garbage collected like any other object
when not referenced any more, so you can create them freely.
They are lightweight enough that you can, for example, have a separate fiber for
each entity in a game. Wren can handle thousands of them without breaking a
sweat. For example, when you run Wren in interactive mode, it creates a new
fiber for every line of code you type in.
## Creating fibers
All Wren code runs within the context of a fiber. When you first start a Wren
script, a main fiber is created for you automatically. You can spawn new fibers
using the Fiber class's constructor:
<pre class="snippet">
var fiber = Fiber.new {
System.print("This runs in a separate fiber.")
}
</pre>
It takes a [function][] containing the code the fiber should execute. The
function can take zero or one parameter, but no more than that. Creating the
fiber does not immediately run it. It just wraps the function and sits there,
waiting to be activated.
[function]: functions.html
## Invoking fibers
Once you've created a fiber, you run it by calling its `call()` method:
<pre class="snippet">
fiber.call()
</pre>
This suspends the current fiber and executes the called one until it reaches the
end of its body or until it passes control to yet another fiber. If it reaches
the end of its body, it is considered *done*:
<pre class="snippet">
var fiber = Fiber.new {
System.print("It's alive!")
}
System.print(fiber.isDone) //> false
fiber.call() //> It's alive!
System.print(fiber.isDone) //> true
</pre>
When a called fiber finishes, it automatically passes control *back* to the
fiber that called it. It's a runtime error to try to call a fiber that is
already done.
## Yielding
The main difference between fibers and functions is that a fiber can be
suspended in the middle of its operation and then resumed later. Calling
another fiber is one way to suspend a fiber, but that's more or less the same
as one function calling another.
Things get interesting when a fiber *yields*. A yielded fiber passes control
*back* to the fiber that ran it, but *remembers where it is*. The next time the
fiber is called, it picks up right where it left off and keeps going.
You make a fiber yield by calling the static `yield()` method on Fiber:
<pre class="snippet">
var fiber = Fiber.new {
System.print("Before yield")
Fiber.yield()
System.print("Resumed")
}
System.print("Before call") //> Before call
fiber.call() //> Before yield
System.print("Calling again") //> Calling again
fiber.call() //> Resumed
System.print("All done") //> All done
</pre>
Note that even though this program uses *concurrency*, it is still
*deterministic*. You can reason precisely about what it's doing and aren't at
the mercy of a thread scheduler playing Russian roulette with your code.
## Passing values
Calling and yielding fibers is used for passing control, but it can also pass
*data*. When you call a fiber, you can optionally pass a value to it.
If you create a fiber using a function that takes a parameter, you can pass a
value to it through `call()`:
<pre class="snippet">
var fiber = Fiber.new {|param|
System.print(param)
}
fiber.call("Here you go") //> Here you go
</pre>
If the fiber has yielded and is waiting to resume, the value you pass to call
becomes the return value of the `yield()` call when it resumes:
<pre class="snippet">
var fiber = Fiber.new {|param|
System.print(param)
var result = Fiber.yield()
System.print(result)
}
fiber.call("First") //> First
fiber.call("Second") //> Second
</pre>
Fibers can also pass values *back* when they yield. If you pass an argument to
`yield()`, that will become the return value of the `call()` that was used to
invoke the fiber:
<pre class="snippet">
var fiber = Fiber.new {
Fiber.yield("Reply")
}
System.print(fiber.call()) //> Reply
</pre>
This is sort of like how a function call may return a value, except that a fiber
may return a whole sequence of values, one every time it yields.
## Full coroutines
What we've seen so far is very similar to what you can do with languages like
Python and C# that have *generators*. Those let you define a function call that
you can suspend and resume. When using the function, it appears like a sequence
you can iterate over.
Wren's fibers can do that, but they can do much more. Like Lua, they are full
*coroutines*&mdash;they can suspend from anywhere in the callstack. The function
you use to create a fiber can call a method that calls another method that calls
some third method which finally calls yield. When that happens, *all* of those
method calls &mdash; the entire callstack &mdash; gets suspended. For example:
<pre class="snippet">
var fiber = Fiber.new {
(1..10).each {|i|
Fiber.yield(i)
}
}
</pre>
Here, we're calling `yield()` from within a [function](functions.html) being
passed to the `each()` method. This works fine in Wren because that inner
`yield()` call will suspend the call to `each()` and the function passed to it
as a callback.
## Transferring control
Fibers have one more trick up their sleeves. When you execute a fiber using
`call()`, the fiber tracks which fiber it will return to when it yields. This
lets you build up a chain of fiber calls that will eventually unwind back to
the main fiber when all of the called ones yield or finish.
This is usually what you want. But if you're doing something low level, like
writing your own scheduler to manage a pool of fibers, you may not want to treat
them explicitly like a stack.
For rare cases like that, fibers also have a `transfer()` method. This switches
execution to the transferred fiber and "forgets" the fiber that was transferred
*from*. The previous one is suspended, leaving it in whatever state it was in.
You can resume the previous fiber by explicitly transferring back to it, or even
calling it. If you don't, execution stops when the last transferred fiber
returns.
Where `call()` and `yield()` are analogous to calling and returning from
functions, `transfer()` works more like an unstructured goto. It lets you freely
switch control between a number of fibers, all of which act as peers to one
another.
<br><hr>
<a class="right" href="error-handling.html">Error Handling &rarr;</a>
<a href="classes.html">&larr; Classes</a>

View File

@ -1,90 +1,89 @@
^title Contributing
^category reference
It should be obvious by now that Wren is under active development and there's
lots left to do. We'd be delighted to have you participate.
Like the bird, Wren's ecosystem is small but full of life. Almost everything is
under active development and there's lots to do. We'd be delighted to have you
help.
## Getting acquainted
The first thing to do is to join [the discord community][discord] (or [the mailing list][list]) and say,
"Hi". There are no strangers to Wren, just friends we haven't met yet.
[Pull requests][pull request] and [bug reports][issue] are always welcome. But,
if you'd like to dip your toes in the water before diving in, please join
[the mailing list][list] and say, "Hi". There's no strangers to Wren, just
friends we haven't met yet.
## Growing the ecosystem
## The source
The simplest and often most helpful way to join the Wren party is to be a Wren
*user*. Create an application that embeds Wren. Write a library or a handy
utility in Wren. Add syntax highlighting support for Wren to your favorite text
editor. Share that stuff and it will help the next Wren user to come along.
Wren uses the OSI-approved [MIT license][mit]. I'm not sure exactly what that
means, but I went with the most permissive license I could find.
If you do any of the above, let us know by adding it to [the wiki][wiki].
We like to keep track of:
The source is developed [on GitHub][github]. My hope is that the codebase,
tests, and [documentation][docs] are easy to understand and contribute to. If
they aren't, that's a bug.
[wiki]: https://github.com/wren-lang/wren/wiki
## Finding something to hack on
* [Applications][] that host Wren as a scripting language.
* [Modules][] written in Wren that others can use.
* [Language bindings][] that let you interact with Wren from other
languages.
* [Tools and utilities][] that make it easier to be a Wren programmer.
Eventually, the [issue tracker][issue] will be populated with a more complete
set of changes and features I have in mind. Until then, one easy way to find
things that need doing is to look for `TODO` comments in the code.
[applications]: https://github.com/wren-lang/wren/wiki/Applications
[modules]: https://github.com/wren-lang/wren/wiki/Modules
[language bindings]: https://github.com/wren-lang/wren/wiki/Language-Bindings
[tools and utilities]: https://github.com/wren-lang/wren/wiki/Tools
Also, writing code in Wren and seeing what problems you run into is incredibly
helpful. Embedding Wren in an application will also exercise lots of corners of
the system and highlight problems and missing features.
## Contributing to Wren
Of course, new ideas are also welcome as well! If you have an idea for a
significant change or addition, please file a [proposal][] to discuss it
before writing lots of code. Wren tries very *very* hard to be minimal which
You're also more than welcome to contribute to Wren itself, both the core VM and
the command-line interpreter. The source is developed [on GitHub][github]. Our
hope is that the codebase, tests, and [documentation][docs] are easy to
understand and contribute to. If they aren't, that's a bug.
You can learn how to build wren on the [getting started page](getting-started.html#building-wren).
### Finding something to hack on
Between the [issue tracker][issue] and searching for `TODO` comments in the
code, it's pretty easy to find something that needs doing, though we don't
always do a good job of writing everything down.
If nothing there suits your fancy, new ideas are welcome as well! If you have an
idea for a significant change or addition, please file a [proposal][] to discuss
it before writing lots of code. Wren tries very *very* hard to be minimal which
means often having to say "no" to language additions, even really cool ones.
## Hacking on docs
### Hacking on docs
The [documentation][] is one of the easiest&mdash;and most
important!&mdash;parts of Wren to contribute to. The source for the site is
written in [Markdown][] (and a little [SASS][]) and lives under `doc/site`. A
simple Python script, `util/generate_docs.py`, converts that to HTML and CSS.
written in [Markdown][] and lives under `doc/site`. A
simple Python 3 script, `util/generate_docs.py`, converts that to HTML and CSS.
[documentation]: /
[markdown]: http://daringfireball.net/projects/markdown/
[sass]: http://sass-lang.com/
The site uses [Pygments][] for syntax highlighting, with a custom lexer plug-in
for Wren. To install that, run:
[pygments]: http://pygments.org
:::sh
$ cd util/pygments-lexer
$ sudo python setup.py develop
$ cd ../.. # Back to the root Wren directory.
Now you can build the docs:
:::sh
$ make docs
$ python util/generate_docs.py
This generates the site in `build/docs/`. You can run any simple static web
server from there. Python includes one:
:::sh
$ cd build/docs
$ python -m SimpleHTTPServer
$ python -m http.server
Running `make docs` is a drag every time you change a line of Markdown or SASS,
Running that script every time you change a line of Markdown can be slow,
so there is also a file watching version that will automatically regenerate the
docs when you edit a file:
:::sh
$ make watchdocs
$ python util/generate_docs.py --watch
## Hacking on the VM
### Hacking on the VM
The basic process is simple:
1. **Make sure you can build and run the tests locally.** It's good to ensure
you're starting from a happy place before you poke at the code. Running the
tests is as simple as:
tests is as simple as [building the vm project](getting-started.html#building-wren),
which generates `bin/wren_test` and then running the following python 3 script:
:::sh
$ make test
$ python util/test.py
If there are no failures, you're good to go.
@ -95,7 +94,7 @@ The basic process is simple:
3. **Change the code.** Please follow the style of the surrounding code. That
basically means `camelCase` names, `{` on the next line, keep within 80
columns, and two spaces of indentation. If you see places where the existing
code is inconsistent, let me know.
code is inconsistent, let us know.
4. **Write some tests for your new functionality.** They live under `test/`.
Take a look at some existing tests to get an idea of how to define
@ -109,17 +108,22 @@ The basic process is simple:
fun open source project! I'll take it from here and hopefully we'll get it
landed smoothly.
## Getting help
If at any point you have questions, feel free to [file an issue][issue] or ask
on the [mailing list][list]. You can also email me directly (`robert` at
`stuffwithstuff.com`) if you want something less public. *Thank you!*
on the [discord community][discord] (or the [mailing list][list]). If you're a Redditor, try the
[/r/wren_lang][subreddit] subreddit. You can also email me directly (`robert` at
`stuffwithstuff.com`) if you want something less public.
[mit]: http://opensource.org/licenses/MIT
[github]: https://github.com/munificent/wren
[github]: https://github.com/wren-lang/
[fork]: https://help.github.com/articles/fork-a-repo/
[docs]: https://github.com/munificent/wren/tree/master/doc/site
[issue]: https://github.com/munificent/wren/issues
[proposal]: https://github.com/munificent/wren/labels/proposal
[docs]: https://github.com/wren-lang/wren/tree/master/doc/site
[issue]: https://github.com/wren-lang/wren/issues
[proposal]: https://github.com/wren-lang/wren/labels/proposal
[feature branches]: https://www.atlassian.com/git/tutorials/comparing-workflows/centralized-workflow
[authors]: https://github.com/munificent/wren/tree/master/AUTHORS
[pull request]: https://github.com/munificent/wren/pulls
[authors]: https://github.com/wren-lang/wren/tree/master/AUTHORS
[pull request]: https://github.com/wren-lang/wren/pulls
[list]: https://groups.google.com/forum/#!forum/wren-lang
[subreddit]: https://www.reddit.com/r/wren_lang/
[discord]: https://discord.gg/Kx6PxSX

View File

@ -1,17 +1,16 @@
^title Control Flow
^category language
Control flow is used to determine which chunks of code are executed and how
many times. *Branching* statements decide whether or not to execute some code
and *looping* ones execute something more than once.
Control flow is used to determine which chunks of code are executed and how many
times. *Branching* statements and expressions decide whether or not to execute
some code and *looping* ones execute something more than once.
## Truth
All control flow is based on *deciding* whether or not to do something. This
decision is conditional on the value of some expression. We take the entire
universe of possible values and divide them into two buckets: some we consider
"true" and the rest are "false". If the expression results in a value in the
true bucket, we do one thing. Otherwise, we do something else.
decision depends on some expression's value. We take the entire universe of
possible objects and divide them into two buckets: some we consider "true" and
the rest are "false". If the expression results in a value in the true bucket,
we do one thing. Otherwise, we do something else.
Obviously, the boolean `true` is in the "true" bucket and `false` is in
"false", but what about values of other types? The choice is ultimately
@ -30,33 +29,79 @@ values.
The simplest branching statement, `if` lets you conditionally skip a chunk of
code. It looks like this:
:::wren
if (ready) System.print("go!")
<pre class="snippet">
if (ready) System.print("go!")
</pre>
That evaluates the parenthesized expression after `if`. If it's true, then the
statement after the condition is evaluated. Otherwise it is skipped. Instead of
a statement, you can have a [block](syntax.html#blocks):
:::wren
if (ready) {
System.print("getSet")
System.print("go!")
}
<pre class="snippet">
if (ready) {
System.print("getSet")
System.print("go!")
}
</pre>
You may also provide an `else` branch. It will be executed if the condition is
false:
:::wren
if (ready) System.print("go!") else System.print("not ready!")
<pre class="snippet">
if (ready) System.print("go!") else System.print("not ready!")
</pre>
And, of course, it can take a block too:
:::wren
if (ready) {
System.print("go!")
} else {
System.print("not ready!")
}
<pre class="snippet">
if (ready) {
System.print("go!")
} else {
System.print("not ready!")
}
</pre>
## Logical operators
Unlike most other [operators][] in Wren which are just a special syntax for
[method calls][], the `&&` and `||` operators are special. This is because they
only conditionally evaluate right operand&mdash;they short-circuit.
[operators]: method-calls.html#operators
[method calls]: method-calls.html
A `&&` ("logical and") expression evaluates the left-hand argument. If it's
false, it returns that value. Otherwise it evaluates and returns the right-hand
argument.
<pre class="snippet">
System.print(false && 1) //> false
System.print(1 && 2) //> 2
</pre>
A `||` ("logical or") expression is reversed. If the left-hand argument is
*true*, it's returned, otherwise the right-hand argument is evaluated and
returned:
<pre class="snippet">
System.print(false || 1) //> 1
System.print(1 || 2) //> 1
</pre>
## The conditional operator `?:`
Also known as the "ternary" operator since it takes three arguments, Wren has
the little "if statement in the form of an expression" you know and love from C
and its brethren.
<pre class="snippet">
System.print(1 != 2 ? "math is sane" : "math is not sane!")
</pre>
It takes a condition expression, followed by `?`, followed by a then
expression, a `:`, then an else expression. Just like `if`, it evaluates the
condition. If true, it evaluates and returns the then expression. Otherwise
it does the else expression.
## While statements
@ -67,16 +112,17 @@ they should be familiar if you've used other imperative languages.
The simplest, a `while` statement executes a chunk of code as long as a
condition continues to hold. For example:
:::wren
// Hailstone sequence.
var n = 27
while (n != 1) {
if (n % 2 == 0) {
n = n / 2
} else {
n = 3 * n + 1
}
}
<pre class="snippet">
// Hailstone sequence.
var n = 27
while (n != 1) {
if (n % 2 == 0) {
n = n / 2
} else {
n = 3 * n + 1
}
}
</pre>
This evaluates the expression `n != 1`. If it is true, then it executes the
following body. After that, it loops back to the top, and evaluates the
@ -87,9 +133,10 @@ The condition for a while loop can be any expression, and must be surrounded by
parentheses. The body of the loop is usually a curly block but can also be a
single statement:
:::wren
var n = 27
while (n != 1) if (n % 2 == 0) n = n / 2 else n = 3 * n + 1
<pre class="snippet">
var n = 27
while (n != 1) if (n % 2 == 0) n = n / 2 else n = 3 * n + 1
</pre>
## For statements
@ -98,10 +145,11 @@ some complex condition. But in most cases, you're looping through
a [list](lists.html), a series of numbers, or some other "sequence" object.
That's what `for` is, uh, for. It looks like this:
:::wren
for (beatle in ["george", "john", "paul", "ringo"]) {
System.print(beatle)
}
<pre class="snippet">
for (beatle in ["george", "john", "paul", "ringo"]) {
System.print(beatle)
}
</pre>
A `for` loop has three components:
@ -119,16 +167,15 @@ A `for` loop has three components:
Sometimes, right in the middle of a loop body, you decide you want to bail out
and stop. To do that, you can use a `break` statement. It's just the `break`
keyword all by itself. That will immediately exit out of the nearest enclosing
keyword all by itself. That immediately exits out of the nearest enclosing
`while` or `for` loop.
:::wren
for (i in [1, 2, 3, 4]) {
System.print(i)
if (i == 3) break
}
So this program will print the numbers from 1 to 3, but will not print 4.
<pre class="snippet">
for (i in [1, 2, 3, 4]) {
System.print(i) //> 1
if (i == 3) break //> 2
} //> 3
</pre>
## Numeric ranges
@ -136,25 +183,28 @@ Lists are one common use for `for` loops, but sometimes you want to walk over a
sequence of numbers, or loop a number of times. For that, you can create a
[range](values.html#ranges), like so:
:::wren
for (i in 1..100) {
System.print(i)
}
<pre class="snippet">
for (i in 1..100) {
System.print(i)
}
</pre>
This loops over the numbers from 1 to 100, including 100 itself. If you want to
leave off the last value, use three dots instead of two:
:::wren
for (i in 1...100) {
System.print(i)
}
<pre class="snippet">
for (i in 1...100) {
System.print(i)
}
</pre>
This looks like some special "range" syntax in the `for` loop, but it's
actually just a pair of operators. The `..` and `...` syntax are infix "range"
operators. Like [other operators](expressions.html#operators), they are just
special syntax for a regular method call. The number type implements them and
returns a [range object](values.html#ranges) that knows how to iterate over a
series of numbers.
This looks like some special "range" syntax in the `for` loop, but it's actually
just a pair of operators. The `..` and `...` syntax are infix "range" operators.
Like [other operators][operators], they are special syntax for a regular method
call. The number type implements them and returns a [range object][] that knows
how to iterate over a series of numbers.
[range object]: values.html#ranges
## The iterator protocol
@ -166,20 +216,22 @@ methods on the object that resulted from evaluating the sequence expression.
When you write a loop like this:
:::wren
for (i in 1..100) {
System.print(i)
}
<pre class="snippet">
for (i in 1..100) {
System.print(i)
}
</pre>
Wren sees it something like this:
:::wren
var iter_ = null
var seq_ = 1..100
while (iter_ = seq_.iterate(iter_)) {
var i = seq_.iteratorValue(iter_)
System.print(i)
}
<pre class="snippet">
var iter_ = null
var seq_ = 1..100
while (iter_ = seq_.iterate(iter_)) {
var i = seq_.iteratorValue(iter_)
System.print(i)
}
</pre>
First, Wren evaluates the sequence expression and stores it in a hidden
variable (written `seq_` in the example but in reality it doesn't have a name
@ -202,3 +254,7 @@ that to look up and return the appropriate element.
The built-in [List](lists.html) and [Range](values.html#ranges) types implement
`iterate()` and `iteratorValue()` to walk over their respective sequences. You
can implement the same methods in your classes to make your own types iterable.
<br><hr>
<a class="right" href="variables.html">Variables &rarr;</a>
<a href="method-calls.html">&larr; Method Calls</a>

View File

@ -1,28 +0,0 @@
^title Class Class
^category core
## Methods
### **name**
The name of the class.
### **supertype**
The superclass of this class.
:::wren
class Crustacean {}
class Crab is Crustacean {}
System.print(Crab.supertype) // "Crustacean".
A class with no explicit superclass implicitly inherits Object:
:::wren
System.print(Crustacean.supertype) // "Object".
Object forms the root of the class hierarchy and has no supertype:
:::wren
System.print(Object.supertype) // "null".

View File

@ -1,140 +0,0 @@
^title Fiber Class
^category core
A lightweight coroutine. [Here](../fibers.html) is a gentle introduction.
### Fiber.**new**(function)
Creates a new fiber that executes `function` in a separate coroutine when the
fiber is run. Does not immediately start running the fiber.
:::wren
var fiber = Fiber.new {
System.print("I won't get printed")
}
## Static Methods
### Fiber.**current**
The currently executing fiber.
### Fiber.**suspend**()
Pauses the current fiber, and stops the interpreter. Control returns to the
host application.
To resume execution, the host application will need to invoke the interpreter
again. If there is still a reference to the suspended fiber, it can be resumed.
### Fiber.**yield**()
Pauses the current fiber and transfers control to the parent fiber. "Parent"
here means the last fiber that was started using `call` and not `run`.
:::wren
var fiber = Fiber.new {
System.print("Before yield")
Fiber.yield()
System.print("After yield")
}
fiber.call() // "Before yield"
System.print("After call") // "After call"
fiber.call() // "After yield"
When resumed, the parent fiber's `call()` method returns `null`.
If a yielded fiber is resumed by calling `call()` or `run()` with an argument,
`yield()` returns that value.
:::wren
var fiber = Fiber.new {
System.print(Fiber.yield()) // "value"
}
fiber.call() // Run until the first yield.
fiber.call("value") // Resume the fiber.
If it was resumed by calling `call()` or `run()` with no argument, it returns
`null`.
If there is no parent fiber to return to, this exits the interpreter. This can
be useful to pause execution until the host application wants to resume it
later.
:::wren
Fiber.yield()
System.print("this does not get reached")
### Fiber.**yield**(value)
Similar to `Fiber.yield` but provides a value to return to the parent fiber's
`call`.
:::wren
var fiber = Fiber.new {
Fiber.yield("value")
}
System.print(fiber.call()) // "value"
## Methods
### **call**()
Starts or resumes the fiber if it is in a paused state.
:::wren
var fiber = Fiber.new {
System.print("Fiber called")
Fiber.yield()
System.print("Fiber called again")
}
fiber.call() // Start it.
fiber.call() // Resume after the yield() call.
When the called fiber yields, control is transferred back to the fiber that
called it.
If the called fiber is resuming from a yield, the `yield()` method returns
`null` in the called fiber.
:::wren
var fiber = Fiber.new {
System.print(Fiber.yield())
}
fiber.call()
fiber.call() // Prints "null".
### **call**(value)
Invokes the fiber or resumes the fiber if it is in a paused state and sets
`value` as the returned value of the fiber's call to `yield`.
:::wren
var fiber = Fiber.new {
System.print(Fiber.yield())
}
fiber.call()
fiber.call("value") // Prints "value".
### **isDone**
Whether the fiber's main function has completed and the fiber can no longer be
run. This returns `false` if the fiber is currently running or has yielded.
### **transfer**()
**TODO**
### **transfer**(value)
**TODO**
### **transferError**(error)
**TODO**

View File

@ -1,25 +0,0 @@
^title Core Library
^category core
Because Wren is designed for [embedding in applications][embedding], its core
library is minimal and is focused on working with objects within Wren. For
stuff like file IO, graphics, etc., it is up to the host application to provide
interfaces for this.
All Wren source files automatically have access to the following classes:
* [Bool](bool.html)
* [Class](class.html)
* [Fiber](fiber.html)
* [Fn](fn.html)
* [List](list.html)
* [Map](map.html)
* [Null](null.html)
* [Num](num.html)
* [Object](object.html)
* [Range](range.html)
* [Sequence](sequence.html)
* [String](string.html)
* [System](system.html)
[embedding]: ../embedding-api.html

View File

@ -1,139 +0,0 @@
^title Embedding API
^category reference
Wren is designed to be a scripting language, so the embedding API is as
important as any of its language features. There are two (well, three) ways to
get Wren into your application:
1. **Link to static or dynamic library.** When you [build Wren][build], it
generates both shared and static libraries in `lib` that you can link to.
2. **Include the source directly in your application.** If you want to include
the source directly in your program, you don't need to run any build steps.
Just add the source files in `src/vm` to your project. They should compile
cleanly as C99 or C++89 or anything later.
[build]: getting-started.html
In either case, you also want to add `src/include` to your include path so you
can get to the [public header for Wren][wren.h]:
[wren.h]: https://github.com/munificent/wren/blob/master/src/include/wren.h
:::c
#include "wren.h"
## Creating a Wren VM
Once you've integrated the code into your executable, you need to create a
virtual machine. To do that, you first fill in a `WrenConfiguration`:
:::c
WrenConfiguration config;
wrenInitConfiguration(&config);
This gives you a basic configuration that has reasonable defaults for
everything. If you don't need to tweak stuff, you can leave it at that. If you
do want to turn some knobs and dials, it exposes some fields you can set:
:::c
config.reallocateFn = ...;
The `reallocateFn` is a callback you can provide to control how Wren allocates
and frees memory. If you leave that to the default, it uses `malloc()` and
`free()`.
:::c
config.loadModuleFn = ...;
config.bindForeignMethodFn = ...;
config.bindForeignClassFn = ...;
These three callbacks are how Wren talks back to your program. We'll cover
them in detail later.
:::c
config.initialHeapSize = ...;
config.minHeapSize = ...;
config.heapGrowthPercent = ...;
These let you tune how the garbage collector runs. You can tweak these if you
want, but the defaults are usually fine.
With this ready, you can create the VM:
:::c
WrenVM* vm = wrenNewVM(&config);
This allocates memory for a new VM using the same `reallocateFn` you provided.
The Wren C implementation has no global state, so every single bit of data Wren
uses is bundled up inside a `WrenVM`. You can have multiple Wren VMs running
independently from each other without any problems.
`wrenNewVM()` stores its own copy of the configuration, so after calling it, you
can discard the `WrenConfiguration` struct you filled in. Now you have a live
VM, waiting to run some code!
## Executing Wren code
You can tell the VM to execute a string of Wren source code like so:
:::c
WrenInterpretResult result = wrenInterpret(vm,
"<where>",
"System.print(\"Hi!\")");
The first string parameter is a "source path". It's just an arbitrary string
that describes where the source code is from. It's what shows up in stack traces
if a runtime error occurs in the code. It can be whatever you want as long as
it's not `NULL`.
The other string is the chunk of code to execute&mdash;a series of one or more
statements separated by newlines. Wren runs this code in a special "main"
module. Each time you call this, the code is run in the same module. This way,
top-level names defined in one call can be accessed in later ones.
When you call `wrenInterpret()`, Wren first compiles your source to bytecode. If
an error occurs here, it returns immediately with `WREN_RESULT_COMPILE_ERROR`.
Otherwise, Wren spins up a new [fiber][] and executes the code in that. Your
code can in turn spawn whatever other fibers it wants. It keeps running fibers
until they all complete.
[fiber]: fibers.html
If a [runtime error][] occurs (and another fiber doesn't catch it), it will
abort fibers all the way back to the main one and then return
`WREN_RESULT_RUNTIME_ERROR`. Otherwise, when the last fiber successfully
returns, it returns `WREN_RESULT_SUCCESS`.
[runtime error]: error-handling.html
## Calling a C function from Wren
**TODO**
## Calling a Wren method from C
**TODO**
## Storing a reference to a Wren object in C
**TODO**
## Storing C data in a Wren object
**TODO**
## Shutting down a VM
Once the party is over and you're ready to end your relationship with a VM, you
need to free any memory it allocated. You do that like so:
:::c
wrenFreeVM(vm);
After calling that, you obviously cannot use the `WrenVM*` you passed to it
again. It's dead.
Note that Wren will yell at you if you still have any live `WrenValue` objects
when you call this. This makes sure you haven't lost track of any of them (which
leaks memory) and you don't try to use any of them after the VM has been freed.

View File

@ -0,0 +1,142 @@
^title Calling C from Wren
When we are ensconced within the world of Wren, the external C world is
"foreign" to us. There are two reasons we might want to bring some foreign
flavor into our VM:
* We want to execute code written in C.
* We want to store raw C data.
Since Wren is object-oriented, behavior lives in methods, so for the former we
have **foreign methods**. Likewise, data lives in objects, so for the latter, we
define **foreign classes**. This page is about the first, foreign methods. The
[next page][] covers foreign classes.
[next page]: /embedding/storing-c-data.html
A foreign method looks to Wren like a regular method. It is defined on a Wren
class, it has a name and signature, and calls to it are dynamically dispatched.
The only difference is that the *body* of the method is written in C.
A foreign method is declared in Wren like so:
<pre class="snippet">
class Math {
foreign static add(a, b)
}
</pre>
The `foreign` keyword tells Wren that the method `add()` is declared on `Math`,
but implemented in C. Both static and instance methods can be foreign.
## Binding Foreign Methods
When you call a foreign method, Wren needs to figure out which C function to
execute. This process is called *binding*. Binding is performed on-demand by the
VM. When a class that declares a foreign method is executed -- when the `class`
statement itself is evaluated -- the VM asks the host application for the C
function that should be used for the foreign method.
It does this through the `bindForeignMethodFn` callback you give it when you
first [configure the VM][config]. This callback isn't the foreign method itself.
It's the binding function your app uses to *look up* foreign methods.
[config]: configuring-the-vm.html
Its signature is:
<pre class="snippet" data-lang="c">
WrenForeignMethodFn bindForeignMethodFn(
WrenVM* vm,
const char* module,
const char* className,
bool isStatic,
const char* signature);
</pre>
Every time a foreign method is first declared, the VM invokes this callback. It
passes in the module containing the class declaration, the name of the class
containing the method, the method's signature, and whether or not it's a static
method. In the above example, it would pass something like:
<pre class="snippet" data-lang="c">
bindForeignMethodFn(vm, "main", "Math", true, "add(_,_)");
</pre>
When you configure the VM, you give it a C callback that looks up the
appropriate function for the given foreign method and returns a pointer to it.
Something like:
<pre class="snippet" data-lang="c">
WrenForeignMethodFn bindForeignMethod(
WrenVM* vm,
const char* module,
const char* className,
bool isStatic,
const char* signature)
{
if (strcmp(module, "main") == 0)
{
if (strcmp(className, "Math") == 0)
{
if (isStatic && strcmp(signature, "add(_,_)") == 0)
{
return mathAdd; // C function for Math.add(_,_).
}
// Other foreign methods on Math...
}
// Other classes in main...
}
// Other modules...
}
</pre>
This implementation is pretty tedious, but you get the idea. Feel free to do
something more clever here in your host application.
The important part is that it returns a pointer to a C function to use for that
foreign method. Wren does this binding step *once* when the class definition is
first executed. It then keeps the function pointer you return and associates it
with that method. This way, *calls* to the foreign method are fast.
## Implementing a Foreign Method
All C functions for foreign methods have the same signature:
<pre class="snippet" data-lang="c">
void foreignMethod(WrenVM* vm);
</pre>
Arguments passed from Wren are not passed as C arguments, and the method's
return value is not a C return value. Instead -- you guessed it -- we go through
the [slot array][].
[slot array]: /embedding/slots-and-handles.html
When a foreign method is called from Wren, the VM sets up the slot array with
the receiver and arguments to the call. As in calling Wren from C, the receiver
object is in slot zero, and arguments are in consecutive slots after that.
You use the slot API to read those arguments, and then perform whatever work you
want to in C. If you want the foreign method to return a value, place it in slot
zero. Like so:
<pre class="snippet" data-lang="c">
void mathAdd(WrenVM* vm)
{
double a = wrenGetSlotDouble(vm, 1);
double b = wrenGetSlotDouble(vm, 2);
wrenSetSlotDouble(vm, 0, a + b);
}
</pre>
While your foreign method is executing, the VM is completely suspended. No other
fibers run until your foreign method returns. You should *not* try to resume the
VM from within a foreign method by calling `wrenCall()` or `wrenInterpret()`.
The VM is not re-entrant.
This covers foreign behavior, but what about foreign *state*? For that, we need
a foreign *class*...
<a class="right" href="storing-c-data.html">Storing C Data &rarr;</a>
<a href="calling-wren-from-c.html">&larr; Calling Wren from C</a>

View File

@ -0,0 +1,191 @@
^title Calling Wren from C
From C, we can tell Wren to do stuff by calling `wrenInterpret()`, but that's
not always the ideal way to drive the VM. First of all, it's slow. It has to
parse and compile the string of source code you give it. Wren has a pretty fast
compiler, but that's still a good bit of work.
It's also not an effective way to communicate. You can't pass arguments to
Wren&mdash;at least, not without doing something nasty like converting them to
literals in a string of source code&mdash;and you can't get a result value back.
`wrenInterpret()` is great for loading code into the VM, but it's not the best
way to execute code that's already been loaded. What we want to do is invoke
some already compiled chunk of code. Since Wren is an object-oriented language,
"chunk of code" means a [method][], not a [function][].
[method]: ../method-calls.html
[function]: ../functions.html
The C API for doing this is `wrenCall()`. In order to invoke a Wren method from
C, we need a few things:
* **The method to call.** Wren is dynamically typed, so this means we'll look it
up by name. Further, since Wren supports overloading by arity, we actually
need its entire [signature][].
[signature]: ../method-calls.html#signature
* **The receiver object to invoke the method on.** The receiver's class
determines which method is actually called.
* **The arguments to pass to the method.**
We'll tackle these one at a time.
### Getting a Method Handle
When you run a chunk of Wren code like this:
<pre class="snippet">
object.someMethod(1, 2, 3)
</pre>
At runtime, the VM has to look up the class of `object` and find a method there
whose signature is `someMethod(_,_,_)`. This sounds like it's doing some string
manipulation&mdash;at the very least hashing the signature&mdash;every time a
method is called. That's how many dynamic languages work.
But, as you can imagine, that's pretty slow. So, instead, Wren does as much of
that work at compile time as it can. When it's compiling the above code to
bytecode, it takes that method signature a converts it to a *method symbol*, a
number that uniquely identifes that method. That's the only part of the process
that requires treating a signature as a string.
At runtime, the VM just looks for the method *symbol* in the receiver's class's
method table. In fact, the way it's implemented today, the symbol is simply the
array index into the table. That's [why method calls are so fast][perf] in Wren.
[perf]: ../performance.html
It would be a shame if calling a method from C didn't have that same speed
benefit. To achieve that, we split the process of calling a method into two
steps. First, we create a handle that represents a "compiled" method signature:
<pre class="snippet" data-lang="c">
WrenHandle* wrenMakeCallHandle(WrenVM* vm, const char* signature);
</pre>
That takes a method signature as a string and gives you back an opaque handle
that represents the compiled method symbol. Now you have a *reusable* handle
that can be used to very quickly call a certain method given a receiver and some
arguments.
This is just a regular WrenHandle, which means you can hold onto it as long as
you like. Typically, you'd call this once outside of your application's
performance critical loops and reuse it as long as you need. It is us up to you
to release it when you no longer need it by calling `wrenReleaseHandle()`.
## Setting Up a Receiver
OK, we have a method, but who are we calling it on? We need a receiver, and as
you can probably guess after reading the [last section][], we give that to Wren
by storing it in a slot. In particular, **the receiver for a method call goes in
slot zero.**
Any object you store in that slot can be used as a receiver. You could even call
`+` on a number by storing a number in there if you felt like it.
[last section]: slots-and-handles.html
Needing a receiver to call some Wren code from C might feel strange. C is
procedural, so it's natural to want to just invoke a bare *function* from Wren,
but Wren isn't procedural. Instead, if you want to define some executable
operation that isn't logically tied to a specific object, the natural way is to
define a static method on an appropriate class.
For example, say we're making a game engine. From C, we want to tell the game
engine to update all of the entities each frame. We'll keep track of the list of
entities within Wren, so from C, there's no obvious object to call `update(_)`
on. Instead, we'll just make it a static method:
<pre class="snippet">
class GameEngine {
static update(elapsedTime) {
// ...
}
}
</pre>
Often, when you call a Wren method from C, you'll be calling a static method.
But, even then, you need a receiver. Now, though, the receiver is the *class
itself*. Classes are first class objects in Wren, and when you define a named
class, you're really declaring a variable with the class's name and storing a
reference to the class object in it.
Assuming you declared that class at the top level, the C API [gives you a way to
look it up][variable]. We can get a handle to the above class like so:
[variable]: slots-and-handles.html#looking-up-variables
<pre class="snippet" data-lang="c">
// Load the class into slot 0.
wrenEnsureSlots(vm, 1);
wrenGetVariable(vm, "main", "GameEngine", 0);
</pre>
We could do this every time we call `update()`, but, again, that's kind of slow
because we're looking up "GameEngine" by name each time. A faster solution is to
create a handle to the class once and use it each time:
<pre class="snippet" data-lang="c">
// Load the class into slot 0.
wrenEnsureSlots(vm, 1);
wrenGetVariable(vm, "main", "GameEngine", 0);
WrenHandle* gameEngineClass = wrenGetSlotHandle(vm, 0);
</pre>
Now, each time we want to call a method on GameEngine, we store that value back
in slot zero:
<pre class="snippet" data-lang="c">
wrenSetSlotHandle(vm, 0, gameEngineClass);
</pre>
Just like we hoisted `wrenMakeCallHandle()` out of our performance critical
loop, we can hoist the call to `wrenGetVariable()` out. Of course, if your code
isn't performance critical, you don't have to do this.
## Passing Arguments
We've got a receiver in slot zero now, next we need to pass in any other
arguments. In our GameEngine example, that's just the elapsed time. Method
arguments go in consecutive slots after the receiver. So the elapsed time goes
into slot one. You can use any of the slot functions to set this up. For the
example, it's just:
<pre class="snippet" data-lang="c">
wrenSetSlotDouble(vm, 1, elapsedTime);
</pre>
## Calling the Method
We have all of the data in place, so all that's left is to pull the trigger and
tell the VM to start running some code:
<pre class="snippet" data-lang="c">
WrenInterpretResult wrenCall(WrenVM* vm, WrenHandle* method);
</pre>
It takes the method handle we created using `wrenMakeCallHandle()`. Now Wren
starts running code. It looks up the method on the receiver, executes it and
keeps running until either the method returns or a fiber [suspends][].
[suspends]: ../modules/core/fiber.html#fiber.suspend()
`wrenCall()` returns the same WrenInterpretResult enum as `wrenInterpret()` to
tell you if the method completed successfully or a runtime error occurred.
(`wrenCall()` never returns `WREN_ERROR_COMPILE` since it doesn't compile
anything.)
## Getting the Return Value
When `wrenCall()` returns, it leaves the slot array in place. In slot zero, you
can find the method's return value, which you can access using any of the slot
reading functions. If you don't need the return value, you can ignore it.
This is how you drive Wren from C, but how do you put control in Wren's hands?
For that, you'll need the next section...
<a class="right" href="calling-c-from-wren.html">Calling C From Wren &rarr;</a>
<a href="slots-and-handles.html">&larr; Slots and Handles</a>

View File

@ -0,0 +1,207 @@
^title Configuring the VM
When you create a Wren VM, you tweak it by passing in a pointer to a
WrenConfiguration structure. Since Wren has no global state, you can configure
each VM differently if your application happens to run multiple.
The struct looks like:
<pre class="snippet" data-lang="c">
typedef struct
{
WrenReallocateFn reallocateFn;
WrenLoadModuleFn loadModuleFn;
WrenBindForeignMethodFn bindForeignMethodFn;
WrenBindForeignClassFn bindForeignClassFn;
WrenWriteFn writeFn;
WrenErrorFn errorFn;
size_t initialHeapSize;
size_t minHeapSize;
int heapGrowthPercent;
} WrenConfiguration;
</pre>
Most fields have useful defaults, which you can (and should) initialize by
calling:
<pre class="snippet" data-lang="c">
wrenInitConfiguration(&configuration);
</pre>
Calling this ensures that your VM doesn't get uninitialized configuration when
new fields are added to WrenConfiguration. Here is what each field does, roughly
categorized:
## Binding
The VM is isolated from the outside world. These callbacks let the VM request
access to imported code and foreign functionality.
### **`loadModuleFn`**
This is the callback Wren uses to load an imported module. The VM itself does
not know how to talk to the file system, so when an `import` statement is
executed, it relies on the host application to locate and read the source code
for a module.
The signature of this function is:
<pre class="snippet" data-lang="c">
char* loadModule(WrenVM* vm, const char* name)
</pre>
When a module is imported, Wren calls this and passes in the module's name. The
host should return the source code for that module. Memory for the source should
be allocated using the same allocator that the VM uses for other allocation (see
below). Wren will take ownership of the returned string and free it later.
The module loader is only be called once for any given module name. Wren caches
the result internally so subsequent imports of the same module use the
previously loaded code.
If your host application isn't able to load a module with some name, it should
return `NULL` and Wren will report that as a runtime error.
If you don't use any `import` statements, you can leave this `NULL`.
### **`bindForeignMethodFn`**
The callback Wren uses to find a foreign method and bind it to a class. See
[this page][foreign method] for details. If your application defines no foreign
methods, you can leave this `NULL`.
[foreign method]: /embedding/calling-c-from-wren.html
### **`bindForeignClassFn`**
The callback Wren uses to find a foreign class and get its foreign methods. See
[this page][foreign class] for details. If your application defines no foreign
classes, you can leave this `NULL`.
[foreign class]: /embedding/storing-c-data.html
## Diagnostics
These let you wire up some minimal output so you can tell if your code is doing
what you expect.
### **`writeFn`**
This is the callback Wren uses to output text when `System.print()` or the other
related functions are called. This is the minimal connection the VM has with the
outside world and lets you do rudimentary "printf debugging". Its signature is:
<pre class="snippet" data-lang="c">
void write(WrenVM* vm, const char* text)
</pre>
Wren does *not* have a default implementation for this. It's up to you to wire
it up to `printf()` or some other way to show the text. If you leave it `NULL`,
calls to `System.print()` and others silently do nothing.
### **`errorFn`**
Wren uses this callback to report compile time and runtime errors. Its signature
is:
<pre class="snippet" data-lang="c">
void error(
WrenVM* vm,
WrenErrorType type,
const char* module,
int line,
const char* message)
</pre>
The `type` parameter is one of:
<pre class="snippet" data-lang="c">
typedef enum
{
// A syntax or resolution error detected at compile time.
WREN_ERROR_COMPILE,
// The error message for a runtime error.
WREN_ERROR_RUNTIME,
// One entry of a runtime error's stack trace.
WREN_ERROR_STACK_TRACE
} WrenErrorType;
</pre>
When a compile error occurs, `errorFn` is called once with type
`WREN_ERROR_COMPILE`, the name of the module and line where the error occurs,
and the error message.
Runtime errors include stack traces. To handle this, Wren first calls `errorFn`
with `WREN_ERROR_RUNTIME`, no module or line, and the runtime error's message.
After that, it calls `errorFn` again using type `WREN_ERROR_STACK_TRACE`, once
for each line in the stack trace. Each of those calls has the module and line
where the method or function is defined and `message` is the name of the method
or function.
If you leave this `NULL`, Wren does not report any errors.
## Memory Management
These fields control how the VM allocates and manages memory.
### **`reallocateFn`**
This lets you provide a custom memory allocation function. Its signature is:
<pre class="snippet" data-lang="c">
void* reallocate(void* memory, size_t newSize)
</pre>
Wren uses this one function to allocate, grow, shrink, and deallocate memory.
When called, `memory` is the existing pointer to the block of memory if an
allocation is being changed or freed. If Wren is requesting new memory, then
`memory` is `NULL`.
`newSize` is the number of bytes of memory being requested. If memory is being
freed, this is zero. Your callback should allocate the proper amount of memory
and return it.
If you don't provide a custom allocator, the VM uses a default one that relies
on `realloc` and `free`.
### **`initialHeapSize`**
This defines the total number of bytes of memory the VM will allocate before
triggering the first garbage collection. Setting this to a smaller number
reduces the amount of memory Wren will have allocated at one time, but causes it
to collect garbage more frequently.
If you set this to zero, Wren uses a default size of 10MB.
### **`minHeapSize`**
After a garbage collection occurs, the threshold for the *next* collection is
determined based on the number of bytes remaining in use. This allows Wren to
grow or shrink its memory usage automatically based on how much memory is
actually needed.
This can be used to ensure that the heap does not get *too* small, which can
in turn lead to a large number of collections afterwards as the heap grows
back to a usable size.
If zero, this defaults to 1MB.
### **`heapGrowthPercent`**
Wren tunes the rate of garbage collection based on how much memory is still in
use after a collection. This number controls that. It determines the amount of
additional memory Wren will use after a collection, as a percentage of the
current heap size.
For example, say that this is 50. After a garbage collection, there are 400
bytes of memory still in use. That means the next collection will be triggered
after a total of 600 bytes are allocated (including the 400 already in use.)
Setting this to a smaller number wastes less memory, but triggers more
frequent garbage collections.
If set to zero, the VM uses a default of 50.
<a href="storing-c-data.html">&larr; Storing C Data</a>

View File

@ -0,0 +1,185 @@
^title Embedding
Wren is designed to be a scripting language that lives inside a host
application, so the embedding API is as important as any of its language
features. Designing this API well requires satisfying several constraints:
1. **Wren is dynamically typed, but C is not.** A variable can hold a value of
any type in Wren, but that's definitely not the case in C unless you define
some sort of variant type, which ultimately just kicks the problem down the
road. Eventually, we have to move data across the boundary between statically and dynamically typed code.
2. **Wren uses garbage collection, but C manages memory manually.** GC adds a
few constraints on the API. The VM must be able to find every Wren object
that is still usable, even if that object is being referenced from native C
code. Otherwise, Wren could free an object that's still in use.
Also, we ideally don't want to let native C code see a bare pointer to a
chunk of memory managed by Wren. Many garbage collection strategies involve
[moving objects][] in memory. If we allow C code to point directly to an
object, that pointer will be left dangling when the object moves. Wren's GC
doesn't move objects today, but we would like to keep that option for the
future.
3. **The embedding API needs to be fast.** Users may add layers of abstraction
on top of the API to make it more pleasant to work with, but the base API
defines the *maximum* performance you can get out of the system. It's the
bottom of the stack, so there's no way for a user to optimize around it if
it's too slow. There is no lower level alternative.
4. **We want the API to be pleasant to use.** This is the last constraint
because it's the softest. Of course, we want a beautiful, usable API. But we
really *need* to handle the above, so we're willing to make things a bit more
of a chore to reach the first three goals.
[moving objects]: https://en.wikipedia.org/wiki/Tracing_garbage_collection#Copying_vs._mark-and-sweep_vs._mark-and-don.27t-sweep
Fortunately, we aren't the first people to tackle this. If you're familiar with
[Lua's C API][lua], you'll find Wren's similar.
[lua]: https://www.lua.org/pil/24.html
### Performance and safety
When code is safely snuggled within the confines of the VM, it's pretty safe.
Method calls are dynamically checked and generate runtime errors which can be
caught and handled. The stack grows if it gets close to overflowing. In general,
when you're within Wren code, it tries very hard to avoid crashing and burning.
This is why you use a high level language after all&mdash;it's safer and more
productive than C. C, meanwhile, really assumes you know what you're doing. You
can cast pointers in invalid ways, misinterpret bits, use memory after freeing
it, etc. What you get in return is blazing performance. Many of the reasons C is
fast are because it takes all the governors and guardrails off.
Wren's embedding API defines the border between those worlds, and takes on some
of the characteristics of C. When you call any of the embedding API functions,
it assumes you are calling them correctly. If you invoke a Wren method from C
that expects three arguments, it trusts that you gave it three arguments.
In debug builds, Wren has assertions to check as many things as it can, but in
release builds, Wren expects you to do the right thing. This means you need to
take care when using the embedding API, just like you do in all C code you
write. In return, you get an API that is quite fast.
## Including Wren
There are two (well, three) ways to get the Wren VM into your program:
1. **Link to the static or dynamic library.** When you [build Wren][build], it
generates both shared and static libraries in `lib` that you can link to.
2. **Include the source directly in your application.** If you want to include
the source directly in your program, you don't need to run any build steps.
Just add the source files in `src/vm` to your project. They should compile
cleanly as C99 or C++98 or anything later.
[build]: ../getting-started.html
In either case, you also want to add `src/include` to your include path so you
can find the [public header for Wren][wren.h]:
[wren.h]: https://github.com/wren-lang/wren/blob/master/src/include/wren.h
<pre class="snippet" data-lang="c">
#include "wren.h"
</pre>
Wren depends only on the C standard library, so you don't usually need to link
to anything else. On some platforms (at least BSD and Linux) some of the math
functions in `math.h` are implemented in a separate library, [libm][], that you
have to explicitly link to.
[libm]: https://en.wikipedia.org/wiki/C_mathematical_functions#libm
If your program is in C++ but you are linking to the Wren library compiled as C,
this header handles the differences in calling conventions between C and C++:
<pre class="snippet" data-lang="c">
#include "wren.hpp"
</pre>
## Creating a Wren VM
Once you've integrated the code into your executable, you need to create a
virtual machine. To do that, you create a
WrenConfiguration config;
wrenInitConfiguration(&config);
This gives you a basic configuration that has reasonable defaults for
everything. If you don't need to tweak stuff, you can leave it at that. We'll
[learn more][configuration] about what you can configure later.
[configuration]: configuring-the-vm.html
With this ready, you can create the VM:
<pre class="snippet" data-lang="c">
WrenVM* vm = wrenNewVM(&config);
</pre>
This allocates memory for a new VM and initializes it. The Wren C implementation
has no global state, so every single bit of data Wren uses is bundled up inside
a WrenVM. You can have multiple Wren VMs running independently of each other
without any problems, even concurrently on different threads.
`wrenNewVM()` stores its own copy of the configuration, so after calling it, you
can discard the WrenConfiguration struct you filled in. Now you have a live
VM, waiting to run some code!
## Executing Wren code
You execute a string of Wren source code like so:
<pre class="snippet" data-lang="c">
WrenInterpretResult result = wrenInterpret(
vm,
"my_module",
"System.print(\"I am running in a VM!\")");
</pre>
The string is a series of one or more statements separated by newlines. Wren
copies the string, so you can free it after calling this. When you call
`wrenInterpret()`, Wren first compiles your source to bytecode. If an error
occurs, it returns immediately with `WREN_RESULT_COMPILE_ERROR`.
Otherwise, Wren spins up a new [fiber][] and executes the code in that. Your
code can in turn spawn whatever other fibers it wants. It keeps running fibers
until they all complete or one [suspends].
[fiber]: ../concurrency.html
[suspends]: ../modules/core/fiber.html#fiber.suspend()
If a [runtime error][] occurs (and another fiber doesn't handle it), Wren aborts
fibers all the way back to the main one and returns `WREN_RESULT_RUNTIME_ERROR`.
Otherwise, when the last fiber successfully returns, it returns
`WREN_RESULT_SUCCESS`.
[runtime error]: ../error-handling.html
All code passed to `wrenInterpret()` runs in a special "main" module. That way,
top-level names defined in one call can be accessed in later ones. It's similar
to a REPL session.
## Shutting down a VM
Once the party is over and you're ready to end your relationship with a VM, you
need to free any memory it allocated. You do that like so:
<pre class="snippet" data-lang="c">
wrenFreeVM(vm);
</pre>
After calling that, you obviously cannot use the `WrenVM*` you passed to it
again. It's dead.
Note that Wren will yell at you if you still have any live [WrenHandle][handle]
objects when you call this. This makes sure you haven't lost track of any of
them (which leaks memory) and you don't try to use any of them after the VM has
been freed.
[handle]: slots-and-handles.html#handles
Next, we'll learn to make that VM do useful stuff...
<a class="right" href="slots-and-handles.html">Slots and Handles &rarr;</a>

View File

@ -0,0 +1,272 @@
^title Slots and Handles
With `wrenInterpret()`, we can execute code, but that code can't do anything
particularly interesting. By default, the VM is isolated from the rest of the
world, so pretty much all it can do is turn your laptop into a lap warmer.
To make our Wren code *useful*, the VM needs to communicate with the outside
world. Wren uses a single unified set of functions for passing data into and out
of the VM. These functions are based on two fundamental concepts: **slots** and
**handles**.
## The Slot Array
When you want to send data to Wren, read data from it, or generally monkey
around with Wren objects from C, you do so by going through an array of slots.
Think of it as a shared message board that both the VM and your C code leave
notes on for the other side to process.
The array is zero-based, and each slot can hold a value of any type. It is
dynamically sized, but it's your responsibility to ensure there are enough slots
*before* you use them. You do this by calling:
<pre class="snippet" data-lang="c">
wrenEnsureSlots(WrenVM* vm, int slotCount);
</pre>
This grows the slot array if needed to ensure that many slots are available. If
it's already big enough, this does nothing. You'll typically call this once
before populating the slots with data that you want to send to Wren.
<pre class="snippet" data-lang="c">
wrenEnsureSlots(vm, 4);
// Can now use slots 0 through 3, inclusive.
</pre>
After you ensure an array of slots, you can only rely on them being there until
you pass control back to Wren. That includes calling `wrenCall()` or
`wrenInterpret()`, or returning from a [foreign method][].
[foreign method]: calling-c-from-wren.html
If you read or write from a slot that you haven't ensured is valid, Wren makes
no guarantees about what will happen. I've heard rumors of smoke and feathers
flying out of a user's computer.
If you want to see how big the slot array is, use:
<pre class="snippet" data-lang="c">
int wrenGetSlotCount(WrenVM* vm);
</pre>
It returns the number of slots in the array. Note that this may be higher than
the size you've ensured. Wren reuses the memory for this array when possible,
so you may get one bigger than you need if it happened to be laying around.
When Wren [calls your C code][] and passes data to you, it ensures there are
enough slots for the objects it is sending you.
[calls your c code]: calling-c-from-wren.html
### Writing slots
Once you have some slots, you store data in them using a number of functions all
named `wrenSetSlot<type>()` where `<type>` is the kind of data. We'll start with
the simple ones:
<pre class="snippet" data-lang="c">
void wrenSetSlotBool(WrenVM* vm, int slot, bool value);
void wrenSetSlotDouble(WrenVM* vm, int slot, double value);
void wrenSetSlotNull(WrenVM* vm, int slot);
</pre>
Each of these takes a primitive C value and converts it to the corresponding
[Wren value][]. (Since Wren's [native number type][] *is* a double, there's not
really much *conversion* going on, but you get the idea.)
[wren value]: ../values.html
[native number type]: ../values.html#numbers
You can also pass string data to Wren:
<pre class="snippet" data-lang="c">
void wrenSetSlotBytes(WrenVM* vm, int slot,
const char* bytes, size_t length);
void wrenSetSlotString(WrenVM* vm, int slot,
const char* text);
</pre>
Both of these copy the bytes into a new [String][] object managed by Wren's
garbage collector, so you can free your copy of it after you call this. The
difference between the two is that `wrenSetSlotBytes()` takes an explicit
length. Since Wren strings may contain arbitrary byte values, including the null
byte, this lets you pass those in. It's also a little faster to use this for
regular strings if you happen to know the length. The latter calculates the
length of the string using `strlen()`.
[string]: ../values.html#strings
### Reading slots
You can, of course, also pull data out of slots. Here are the simple ones:
<pre class="snippet" data-lang="c">
bool wrenGetSlotBool(WrenVM* vm, int slot);
double wrenGetSlotDouble(WrenVM* vm, int slot);
</pre>
These take a Wren value of the corresponding type and convert it to its raw C
representation. For strings, we have:
<pre class="snippet" data-lang="c">
const char* wrenGetSlotString(WrenVM* vm, int slot);
const char* wrenGetSlotBytes(WrenVM* vm, int slot,
int* length);
</pre>
These return a pointer to the first byte of the string. If you want to know the
length, the latter stores it in the variable pointed to by `length`. Both of
these return a direct pointer to the bytes managed by Wren. You should not hold
on to this pointer for long. Wren does not promise that it won't move or free
the data.
With these functions, you are going from dynamically typed Wren data to
statically typed C. It's up to *you* to ensure that you read a value as the
correct type. If you read a number from a slot that currently holds a string,
you're gonna have a bad time.
Fortunately, you usually know what type of data you have in a slot. If not, you
can ask:
<pre class="snippet" data-lang="c">
WrenType wrenGetSlotType(WrenVM* vm, int slot);
</pre>
This returns an enum defining what type of value is in the slot. It only covers
the primitive values that are supported by the C API. Things like ranges and
instances of classes come back as `WREN_TYPE_UNKNOWN`. If you want to move that
kind of data between Wren and C, you'll have to pull the object apart into
simple primitive values first or use a [foreign class][].
[foreign class]: storing-c-data.html
### Looking up variables
There are a few other utility functions that move data into and out of slots.
Here's the first:
<pre class="snippet" data-lang="c">
void wrenGetVariable(WrenVM* vm, const char* module,
const char* name, int slot);
</pre>
This looks up a top level variable with the given name in the module with the
given name and stores its value in the given slot. Note that classes are just
objects stored in variables too, so you can use this to look up a class by its
name. Handy for calling static methods on it.
Like any method that works with strings, this one is a bit slow. It has to hash
the name and look it up in the module's string table. You might want to avoid
calling this in the middle of a hot loop where performance is critical. Instead,
it's faster to look up the variable once outside the loop and store a reference
to the object using a [handle](#handles).
### Working with lists
The slot array is fine for moving a fixed number of objects between Wren and
C, but sometimes you need to shuttle a larger or dynamically-sized ball of
stuff. [List objects][lists] work well for that, so the C API lets you work
with them directly.
[lists]: ../lists.html
You can create a new empty list from C using:
<pre class="snippet" data-lang="c">
void wrenSetSlotNewList(WrenVM* vm, int slot);
</pre>
It stores the resulting list in the given slot. If you have a list in a
slot&mdash;either one you created from C or from Wren&mdash;you can add elements
to it using:
<pre class="snippet" data-lang="c">
void wrenInsertInList(WrenVM* vm, int listSlot, int index,
int elementSlot);
</pre>
That's a lot of int parameters:
* `listSlot` is the slot where the list object is stored. That's the list you'll
be modifying. If you created the list from C, it will be the slot you passed
to `wrenSetSlotNewList()`.
* `index` is the index within the list where you want to insert the element.
Just like from within Wren, you can use a negative number to count back from
the end, so `-1` appends to the list.
* `elementSlot` identifies the slot where the value you want to insert in the
list can be found.
This API means getting a value from C into a list is a two step operation. First
you move the value into a slot, then you take it from the slot and insert it in
the list. This is kind of tedious, but it lets us use the same set of functions
for moving values into slots of each primitive type. Otherwise, we'd need
`wrenInsertInListDouble()`, `wrenInsertInListBool()`, etc.
## Handles
Slots are pretty good for shuttling primitive data between C and Wren, but they
have two limitations:
1. **They are short-lived.** As soon as you execute some more Wren code, the
slot array is invalidated. You can't use a slot to persistently keep track
of some object.
2. **They only support primitive types.** A slot can hold a value of any type,
but the C API we've seen so far doesn't let you *do* anything with values
that aren't simple primitive ones. If you want to grab a reference to,
say, an instance of some class, how do you do it?
To address those, we have handles. A handle wraps a reference to an object of
any kind&mdash;strings, numbers, instances of classes, collections, whatever.
You create a handle using this:
<pre class="snippet" data-lang="c">
WrenHandle* wrenGetSlotHandle(WrenVM* vm, int slot);
</pre>
This takes the object stored in the given slot, creates a new WrenHandle to wrap
it, and returns a pointer to it back to you. You can send that wrapped object
back to Wren by calling:
<pre class="snippet" data-lang="c">
void wrenSetSlotHandle(WrenVM* vm, int slot, WrenHandle* handle);
</pre>
Note that this doesn't invalidate your WrenHandle. You can still keep using it.
### Retaining and releasing handles
A handle is an opaque wrapper around an object of any type, but just as
important, it's a *persistent* one. When Wren gives you a pointer to a
WrenHandle, it guarantees that that pointer remains valid. You can keep it
around as long as you want. Even if a garbage collection occurs, Wren will
ensure the handle and the object it wraps are kept safely in memory.
Internally, Wren keeps a list of all of the WrenHandles that have been created.
That way, during garbage collection, it can find them all and make sure their
objects aren't freed. But what if you don't want it to be kept around any more?
Since C relies on manual memory management, WrenHandle does too. When you are
done with one, you must explicitly release it by calling:
<pre class="snippet" data-lang="c">
void wrenReleaseHandle(WrenVM* vm, WrenHandle* handle);
</pre>
This does not immediately delete the wrapped object&mdash;after all, there may
be other references to the same object in the program. It just invalidates the
WrenHandle wrapper itself. After you call this, you cannot use that pointer
again.
You must release every WrenHandle you've created before shutting down the VM.
Wren warns you if you don't, since it implies you've probably leaked a resource
somewhere.
Now we know how to pass values between Wren and C, but we don't know how to
actually *do* anything with them. Next, we'll learn how to use slots to pass
parameters to a Wren method from C...
<a class="right" href="calling-wren-from-c.html">Calling Wren from C &rarr;</a>
<a href="index.html">&larr; Introduction</a>

View File

@ -0,0 +1,389 @@
^title Storing C Data
An embedded language often needs to work with native data. You may want a
pointer to some memory managed in the C heap, or maybe you want to store a chunk
of data more efficiently than Wren's dynamism allows. You may want a Wren object
that represents a native resource like a file handle or database connection.
For those cases, you can define a **foreign class**, a chimera whose state is
half Wren and half C. It is a real Wren class with a name, constructor, and
methods. You can define methods on it written in Wren, or [foreign methods][]
written in C. It produces real Wren objects that you can pass around, do `is`
checks on, etc. But it also wraps a blob of raw memory that is opaque to Wren
but accessible from C.
[foreign methods]: http://localhost:8000/embedding/calling-c-from-wren.html
## Defining a Foreign Class
You define one like so:
<pre class="snippet">
foreign class Point {
// ...
}
</pre>
The `foreign` keyword tells Wren to loop in the host application when it
constructs instances of the class. The host tells Wren how many bytes of extra
memory the foreign instance should contain and in return, Wren gives the host
the opportunity to initialize that data.
To talk to the host app, Wren needs a C function it can call when it constructs
an instance of the foreign class. This function is found through a binding
process similar to [how foreign methods are bound][bind]. When you [configure
the VM][], you set the `bindForeignClassFn` field in WrenConfiguration to point
to a C callback you define. Its signature must be:
[bind]: calling-c-from-wren.html#binding-foreign-methods
[configure the vm]: configuring-the-vm.html
<pre class="snippet" data-lang="c">
WrenForeignClassMethods bindForeignClass(
WrenVM* vm, const char* module, const char* className);
</pre>
Wren invokes this callback once when a foreign class declaration is executed.
Wren passes in the name of the module containing the foreign class, and the name
of the class being declared. The host's responsibility is to return one of these
structs:
<pre class="snippet" data-lang="c">
typedef struct
{
WrenForeignMethodFn allocate;
WrenFinalizerFn finalize;
} WrenForeignClassMethods;
</pre>
It's a pair of function pointers. The first, `allocate`, is called by Wren
whenever an instance of the foreign class is created. (We'll get to the optional
`finalize` callback later.) The allocation callback has the same signature as a
foreign method:
<pre class="snippet" data-lang="c">
void allocate(WrenVM* vm);
</pre>
## Initializing an Instance
When you create an instance of a foreign class by calling one its
[constructors][], Wren invokes the `allocate` callback you gave it when binding
the foreign class. Your primary responsibility in that callback is to tell Wren
how many bytes of raw memory you need. You do that by calling:
[constructors]: ../classes.html#constructors
<pre class="snippet" data-lang="c">
void* wrenSetSlotNewForeign(WrenVM* vm,
int slot, int classSlot, size_t size);
</pre>
Like other [slot manipulation functions][slot], it both reads from and writes to
the slot array. It has a few parameters to make it more general purpose since it
can also be used in other foreign methods:
[slot]: slots-and-handles.html
* The `slot` parameter is the destination slot where the new foreign object
should be placed. When you're calling this in a foreign class's allocate
callback, this should be 0.
* The `classSlot` parameter is the slot where the foreign class being
constructed can be found. When the VM calls an allocate callback for a
foreign class, the class itself is already in slot 0, so you'll pass 0 for
this too.
* Finally, the `size` parameter is the interesting one. Here, you pass in the
number of extra raw bytes of data you want the foreign instance to store.
This is the memory you get to play with from C.
So, for example, if you wanted to create a foreign instance that contains eight
bytes of C data, you'd call:
<pre class="snippet" data-lang="c">
void* data = wrenSetSlotNewForeign(vm, 0, 0, 8);
</pre>
The value returned by `wrenSetSlotNewForeign()` is the raw pointer to the
requested bytes. You can cast that to whatever C type makes sense (as long as it
fits within the requested number of bytes) and initialize it as you see fit.
Any parameters passed to the constructor are also available in subsequent slots
in the slot array. That way you can initialize the foreign data based on values
passed to the constructor from Wren.
After the allocate callback returns, the class's constructor in Wren is run and
execution proceeds like normal. From here on out, within Wren, it appears you
have a normal instance of a class. It just happens to have some extra bytes
hiding inside it that can be accessed from foreign methods.
## Accessing Foreign Data
Typically, the way you make use of the data stored in an instance of a foreign
class is through other foreign methods. Those are usually defined on the same
foreign class, but can be defined on other classes as well. Wren doesn't care.
Once you have a foreign instance in a slot, you can access the raw bytes it
stores by calling:
<pre class="snippet" data-lang="c">
void* wrenGetSlotForeign(WrenVM* vm, int slot);
</pre>
You pass in the slot index containing the foreign object and it gives you back a
pointer to the raw memory the object wraps. As usual, the C API doesn't do any
type or bounds checking, so it's on you to make sure the object in that slot
actually *is* an instance of a foreign class and contains as much memory as you
access.
Given that void pointer, you can now freely read and modify the data it points
to. They're your bits, Wren just holds them for you.
## Freeing Resources
If your foreign instances are just holding memory and you're OK with Wren's
garbage collector managing the lifetime of that memory, then you're done. Wren
will keep the bytes around as long as there is still a reference to them. When
the instance is no longer reachable, eventually the garbage collector will do
its thing and free the memory.
But, often, your foreign data refers to some resource whose lifetime needs to
be explicitly managed. For example, if you have a foreign object that wraps an
open file handle, you need to ensure that handle doesn't get left open when the
GC frees the foreign instance.
Of course, you can (and usually should) add a method on your foreign class, like
`close()` so the user can explicitly release the resource managed by the object.
But if they forget to do that and the object is no longer reachable, you want to
make sure the resource isn't leaked.
To that end, you can also provide a *finalizer* function when binding the
foreign class. That's the other callback in the WrenForeignClassMethods struct.
If you provide that callback, then Wren will invoke it when an instance of your
foreign class is about to be freed by the garbage collector. This gives you one
last chance to clean up the object's resources.
Because this is called during the middle of a garbage collection, you do not
have unfettered access to the VM. It's not like a normal foreign method where
you can monkey around with slots and other stuff. Doing that while the GC is
running could leave Wren in a weird state.
Instead, the finalize callback's signature is only:
<pre class="snippet" data-lang="c">
void finalize(void* data);
</pre>
Wren gives you the pointer to your foreign function's memory, and that's it. The
*only* thing you should do inside a finalizer is release any external resources
referenced by that memory.
## A Full Example
That's a lot to take in, so let's walk through a full example of a foreign class
with a finalizer and a couple of methods. We'll do a File class that wraps the
C standard file API.
In Wren, the class we want looks like this:
<pre class="snippet">
foreign class File {
construct create(path) {}
foreign write(text)
foreign close()
}
</pre>
So you can create a new file given a path. Once you have one, you can write to
it and then explicitly close it if you want. We also need to make sure the file
gets closed if the user forgets to and the GC cleans up the object.
### Setting up the VM
Over in the host, first we'll set up the VM:
<pre class="snippet" data-lang="c">
#include "wren.h"
int main(int argc, const char* argv[])
{
WrenConfiguration config;
wrenInitConfiguration(&config);
config.bindForeignClassFn = bindForeignClass;
config.bindForeignMethodFn = bindForeignMethod;
WrenVM* vm = wrenNewVM(&config);
wrenInterpret(vm, "my_module", "some code...");
return 0;
}
</pre>
### Binding the foreign class
We give the VM two callbacks. The first is for wiring up the foreign class
itself:
<pre class="snippet" data-lang="c">
WrenForeignClassMethods bindForeignClass(
WrenVM* vm, const char* module, const char* className)
{
WrenForeignClassMethods methods;
if (strcmp(className, "File") == 0)
{
methods.allocate = fileAllocate;
methods.finalize = fileFinalize;
}
else
{
// Unknown class.
methods.allocate = NULL;
methods.finalize = NULL;
}
return methods;
}
</pre>
When our binding callback is invoked for the File class, we return the allocate
and finalize functions the VM should call. Allocation looks like:
<pre class="snippet" data-lang="c">
#include &lt;stdio.h>
#include "wren.h"
void fileAllocate(WrenVM* vm)
{
FILE** file = (FILE**)wrenSetSlotNewForeign(vm,
0, 0, sizeof(FILE*));
const char* path = wrenGetSlotString(vm, 1);
*file = fopen(path, "w");
}
</pre>
First we create the instance by calling `wrenSetSlotNewForeign()`. We tell it to
add enough extra bytes to store a `FILE*` in it, which is C's representation of
a file handle. We're given back a pointer to the bytes. Since the file handle is
itself a pointer, we end up with a double indirection, hence the `FILE**`. In
most cases, you'll just have a single `*`.
We also pull the file path from the slot array. Then we tell C to create a new
file at that path. That gives us back a new file handle -- a `FILE*` -- and we
store that back into the foreign instance using `*file`. Now we have a foreign
object that wraps an open file handle.
The finalizer simply casts the foreign instance's data back to the proper type
and closes the file:
<pre class="snippet" data-lang="c">
void fileFinalize(void* data)
{
closeFile((FILE**) data);
}
</pre>
It uses this little utility function:
<pre class="snippet" data-lang="c">
static void closeFile(FILE** file)
{
// Already closed.
if (*file == NULL) return;
fclose(*file);
*file = NULL;
}
</pre>
This closes the file (if it's not already closed) and also nulls out the file
handle so that we don't try to use the file after it's been closed.
### Binding the foreign methods
That's the foreign *class* part. Now we have a couple of foreign *methods* to
handle. The host tells the VM how to find them by giving Wren a pointer to this
function:
<pre class="snippet" data-lang="c">
WrenForeignMethodFn bindForeignMethod(WrenVM* vm, const char* module,
const char* className, bool isStatic, const char* signature)
{
if (strcmp(className, "File") == 0)
{
if (!isStatic && strcmp(signature, "write(_)") == 0)
{
return fileWrite;
}
if (!isStatic && strcmp(signature, "close()") == 0)
{
return fileClose;
}
}
// Unknown method.
return NULL;
}
</pre>
When Wren calls this, we look at the class and method name to figure out which
method it's binding, and then return a pointer to the appropriate function. The
foreign method for writing to the file is:
<pre class="snippet" data-lang="c">
void fileWrite(WrenVM* vm)
{
FILE** file = (FILE**)wrenGetSlotForeign(vm, 0);
// Make sure the file is still open.
if (*file == NULL)
{
wrenSetSlotString(vm, 0, "Cannot write to a closed file.");
wrenAbortFiber(vm, 0);
return;
}
const char* text = wrenGetSlotString(vm, 1);
fwrite(text, sizeof(char), strlen(text), *file);
}
</pre>
We use `wrenGetSlotForeign()` to pull the foreign data out of the slot array.
Since this method is called on the file itself, the foreign object is in slot
zero. We take the resulting pointer and cast it to a pointer of the proper type.
Again, because our foreign data is *itself* a pointer, we get a pointer to a
pointer.
We do a little sanity checking to make sure the user isn't writing to a file
they already closed. If not, we call `fwrite()` to write to the file.
The other method is `close()` to let them explicitly close the file:
<pre class="snippet" data-lang="c">
void fileClose(WrenVM* vm)
{
FILE** file = (FILE**)wrenGetSlotForeign(vm, 0);
closeFile(file);
}
</pre>
It uses the same helper we defined above. And that's it, a complete foreign
class with a finalizer and a couple of foreign methods. In Wren, you can use it
like so:
<pre class="snippet">
var file = File.create("some/path.txt")
file.write("some text")
file.close()
</pre>
Pretty neat, right? The resulting class looks and feels like a normal Wren
class, but it has the functionality and much of the performance of native C
code.
<a class="right" href="configuring-the-vm.html">Configuring the VM &rarr;</a>
<a href="calling-c-from-wren.html">&larr; Calling C from Wren</a>

View File

@ -0,0 +1,89 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
<title>{title} &ndash; Wren</title>
<script type="application/javascript" src="../prism.js" data-manual></script>
<script type="application/javascript" src="../wren.js"></script>
<link rel="stylesheet" type="text/css" href="../prism.css" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:400,700,400italic,700italic|Source+Code+Pro:400|Lato:400|Sanchez:400italic,400' rel='stylesheet' type='text/css'>
<!-- Tell mobile browsers we're optimized for them and they don't need to crop
the viewport. -->
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"/>
</head>
<body id="top" class="embedding">
<header>
<div class="page">
<div class="main-column">
<h1><a href="../">wren</a></h1>
<h2>a classy little scripting language</h2>
</div>
</div>
</header>
<div class="page">
<nav class="big">
<a href="../"><img src="../wren.svg" class="logo"></a>
<ul>
<li><a href="../">Back to Wren</a></li>
</ul>
<section>
<h2>embedding</h2>
<ul>
<li><a href="./">Introduction</a></li>
<li><a href="slots-and-handles.html">Slots and Handles</a></li>
<li><a href="calling-wren-from-c.html">Calling Wren from C</a></li>
<li><a href="calling-c-from-wren.html">Calling C from Wren</a></li>
<li><a href="storing-c-data.html">Storing C Data</a></li>
<li><a href="configuring-the-vm.html">Configuring the VM</a></li>
</ul>
</section>
</nav>
<nav class="small">
<table>
<tr>
<td><h2>embedding</h2></td>
<td><h2>?</h2></td>
<td><h2>?</h2></td>
</tr>
<tr>
<td>
<ul>
<li><a href="./">Introduction</a></li>
<li><a href="slots-and-handles.html">Slots and Handles</a></li>
<li><a href="calling-wren-from-c.html">Calling Wren from C</a></li>
<li><a href="calling-c-from-wren.html">Calling C from Wren</a></li>
<li><a href="storing-c-data.html">Storing C Data</a></li>
<li><a href="configuring-the-vm.html">Configuring the VM</a></li>
</ul>
</td>
<td>
<ul>
</ul>
</td>
<td>
<ul>
</ul>
</td>
</tr>
</table>
</nav>
<main>
<h1>{title}</h1>
{html}
</main>
</div>
<footer>
<div class="page">
<div class="main-column">
<p>Wren lives
<a href="https://github.com/wren-lang/wren">on GitHub</a>
&mdash; Made with &#x2764; by
<a href="http://journal.stuffwithstuff.com/">Bob Nystrom</a> and
<a href="https://github.com/wren-lang/wren/blob/master/AUTHORS">friends</a>.
</p>
<div class="main-column">
</div>
</footer>
</body>
</html>

View File

@ -1,5 +1,4 @@
^title Error Handling
^category language
Errors come in a few fun flavors.
@ -8,27 +7,27 @@ Errors come in a few fun flavors.
The first errors you're likely to run into are syntax errors. These include
simple bugs where your code doesn't follow the language's grammar, like:
:::wren
1 + * 2
<pre class="snippet">
1 + * 2
</pre>
Wren will detect these errors as soon as it tries to read your code. When it
hits one, you'll get a friendly error message, like:
Wren detects these errors as soon as it tries to read your code. When it hits
one, you get a friendly error message, like:
:::text
[script.wren line 1] Error on '*': Unexpected token for expression.
[main line 1] Error on '*': Unexpected token for expression.
Some slightly more "semantic" errors fall into this bucket too. Things like
using a variable that hasn't been defined, or declaring two variables with the
same name in the same scope. So if you do:
:::wren
var a = "once"
var a = "twice"
<pre class="snippet">
var a = "once"
var a = "twice"
</pre>
Wren tells you:
:::text
[script.wren line 2] Error on 'a': Top-level variable is already defined.
[main line 2] Error on 'a': Top-level variable is already defined.
Note that it does this before it executes *any* code. Unlike some other
scripting languages, Wren tries to help you find your errors as soon as
@ -49,15 +48,17 @@ perform an operation that the VM can't do. The most common error is a "method
not found" one. If you call a method on an object and its class (and all of its
superclasses) don't define that method, there's nothing Wren can do:
:::wren
class Foo {}
<pre class="snippet">
class Foo {
construct new() {}
}
var foo = Foo.new()
foo.someRandomMethod
var foo = Foo.new()
foo.someRandomMethod
</pre>
If you run this, Wren will print:
:::text
Foo does not implement method 'someRandomMethod'.
Then it stops executing code. Unlike some other languages, Wren doesn't keep
@ -70,17 +71,17 @@ Another common runtime error is passing an argument of the wrong type to a
method. For example, lists are indexed using a number. If you try to pass some
other type, it's an error:
:::wren
var list = ["a", "b", "c"]
list["1"]
<pre class="snippet">
var list = ["a", "b", "c"]
list["1"]
</pre>
This exits with:
:::text
Subscript must be a number or a range.
[script.wren line 2] in (script)
[main line 2] in (script)
These are the most two common kinds of runtime errors, but there are others.
These are the two most common kinds of runtime errors, but there are others.
Stuff like out of bounds errors on lists, calling a function with the wrong
number of arguments, etc.
@ -90,11 +91,12 @@ Most of the time, runtime errors indicate a bug in your code and the best
solution is to fix the bug. However, sometimes it's useful to be able to handle
them at, uh, runtime.
To keep the language simpler, Wren does not have exception handling. Instead,
it takes advantage of [fibers](fibers.html) for handling errors. When a runtime
error occurs, the current fiber is aborted. Normally, Wren will also abort any
fibers that invoked that one, all the way to the main fiber, and then exit the
VM.
To keep the language simpler, Wren does not have exception handling. Instead, it
takes advantage of [fibers][] for handling errors. When a runtime error occurs,
the current fiber is aborted. Normally, Wren will also abort any fibers that
invoked that one, all the way to the main fiber, and then exit the VM.
[fibers]: concurrency.html
However, you can run a fiber using the `try` method. If a runtime error occurs
in the called fiber, the error is captured and the `try` method returns the
@ -102,29 +104,29 @@ error message as a string.
For example, if you run this program:
:::wren
var fiber = Fiber.new {
123.badMethod
}
<pre class="snippet">
var fiber = Fiber.new {
123.badMethod
}
var error = fiber.try()
System.print("Caught error: " + error)
var error = fiber.try()
System.print("Caught error: " + error)
</pre>
It prints:
:::text
Caught error: Num does not implement method 'badMethod'.
The called fiber can no longer be used, but any other fibers can proceed as
usual. When a fiber has been aborted because of a runtime error, you can also
get the error from the fiber object. Continuing the above example:
:::wren
System.print(fiber.error)
<pre class="snippet">
System.print(fiber.error)
</pre>
This also prints:
:::text
Num does not implement method 'badMethod'.
If you have a chain of fiber calls and a runtime error occurs, it will walk the
@ -137,11 +139,14 @@ Most runtime errors come from within the Wren VM, but you may want to be able
to cause your own runtime errors to occur. This can be done by calling the
`abort()` static method on `Fiber`:
:::wren
Fiber.abort("Something bad happened")
<pre class="snippet">
Fiber.abort("Something bad happened")
</pre>
You must pass in an error message, and it must be a string.
If the provided message is `null`, no runtime error is raised.
## Failures
The last flavor of errors is the highest-level one. All of the above errors
@ -163,3 +168,7 @@ indication.
For example, a method for parsing a number could return a number on success and
`null` to indicate parsing failed. Since Wren is dynamically typed, it's easy
and natural for a method to return different types of values.
<br><hr>
<a class="right" href="modularity.html">Modularity &rarr;</a>
<a href="concurrency.html">&larr; Concurrency</a>

View File

@ -1,379 +0,0 @@
^title Expressions
^category language
Wren's syntax is based on C so if you're familiar with that (or any of the
plethora of other languages based on it) you should be right at home. Since
Wren is heavily object-oriented, you'll notice that most of the different
expression forms are just different ways of invoking methods.
## Literals
Literals produce objects of built-in types. The primitive [value](values.html)
types&mdash;numbers, strings and friends&mdash;have literal forms as do the
built in collections: [lists](lists.html) and [maps](maps.html).
[Functions](functions.html) do not have standalone a literal form. Instead,
they are created by passing a [block
argument](functions.html#block-arguments) to a method.
## Identifiers
Names in expressions come in a few flavors. A name that starts with an
underscore denotes a [field](classes.html#fields), a piece of data stored in an
instance of a [class](classes.html). All other names refer to
[variables](variables.html).
## Method calls
Wren is object-oriented, so most code consists of method calls. Most of them
look like so:
:::wren
System.print("hello")
items.add("another")
items.insert(1, "value")
You have a *receiver* expression followed by a `.`, then a name and an argument
list in parentheses. Arguments are separated by commas. Methods that do not
take any arguments can omit the `()`:
:::wren
text.length
These are special "getters" or "accessors" in other languages. In Wren, they're
just method calls. You can also define methods that take an empty argument list:
:::wren
list.clear()
An empty argument list is *not* the same as omitting the parentheses
completely. Wren lets you overload methods by their call signature. This mainly
means [*arity*](classes.html#signature)&mdash;number of parameters&mdash;but
also distinguishes between "empty parentheses" and "no parentheses at all".
You can have a class that defines both `foo` and `foo()` as separate methods.
Think of it like the parentheses and commas between arguments are part of the
method's *name*.
If the last (or only) argument to a method call is a
[function](functions.html), it may be passed as a [block
argument](functions.html#block-arguments):
:::wren
blondie.callMeAt(867, 5309) {
System.print("This is the body!")
}
Semantically, all method calls work like so:
1. Evaluate the receiver and arguments.
2. Look up the method on the receiver's class.
3. Invoke it, passing in the arguments.
## This
The special `this` keyword works sort of like a variable, but has special
behavior. It always refers to the instance whose method is currently being
executed. This lets you invoke methods on "yourself".
It's an error to refer to `this` outside of a method. However, it's perfectly
fine to use it inside a function contained in a method. When you do, `this`
still refers to the instance whose method is being called.
This is unlike Lua and JavaScript which can "forget" `this` when you create a
callback inside a method. Wren does what you want here and retains the
reference to the original object. (In technical terms, a function's closure
includes `this`.)
## Super
Sometimes you want to invoke a method on yourself, but only methods defined in
one of your [superclasses](classes.html#inheritance). You typically do this in
an overridden method when you want to access the original method being
overridden.
To do that, you can use the special `super` keyword as the receiver in a method
call:
:::wren
class Base {
method {
System.print("base method")
}
}
class Derived is Base {
method {
super.method // Prints "base method".
}
}
You can also use `super` without a method name inside a constructor to invoke a
base class constructor:
:::wren
class Base {
this new(arg) {
System.print("base constructor got " + arg)
}
}
class Derived is Base {
this new() {
super("value") // Prints "base constructor got value".
}
}
**TODO: constructors**
## Operators
Wren has most of the same operators you know and love with the same precedence
and associativity. Wren has three prefix operators:
:::wren
! ~ -
They are just method calls on their operand without any other arguments. An
expression like `!possible` means "call the `!` method on `possible`".
We have a few other operators to play with. The remaining ones are
infix&mdash;they have operators on either side. They are:
:::wren
== != < > <= >= .. ... | & + - * / %
Like prefix operators, they are all funny ways of writing method calls. The
left operand is the receiver, and the right operand gets passed to it. So
`a + b` is semantically interpreted as "invoke the `+` method on `a`, passing
it `b`".
Most of these are probably familiar already. The `..` and `...` operators are
"range" operators. The number type implements those to create a
[range](values.html#ranges) object, but they are just regular operators.
Since operators are just method calls, this means Wren supports "operator
overloading" (though "operator over-*riding*" is more accurate). This can be
really useful when the operator is natural for what a class represents, but can
lead to mind-crushingly unreadable code when used recklessly. There's a reason
punctuation represents profanity in comic strips.
## Assignment
The `=` operator is used to *assign* or store a value somewhere. The right-hand
side can be any expression. If the left-hand side is an
[identifier](#identifiers), then the value of the right operand is stored in
the referenced [variable](variables.html) or [field](classes.html#fields).
The left-hand side may also be a method call, like:
:::wren
point.x = 123
In this case, the entire expression is a single "setter" method call. The above
example invokes the `x=` setter on the `point` object, and passing in `123`.
Sort of like `point.x=(123)`.
Since these are just regular method calls, you can define whatever setters you
like in your classes. However, you cannot change the behavior of *simple*
assignment. If the left-hand side is a variable name or field, an assignment
expression will always just store the value there.
## Subscript operators
Most languages use square brackets (`[]`) for working with collection-like
objects. For example:
:::wren
list[0] // Gets the first item in a list.
map["key"] // Gets the value associated with "key".
You know the refrain by now. In Wren, these are just method calls that a class
may define. Subscript operators may take multiple arguments, which is useful
for things like multi-dimensional arrays:
:::wren
matrix[3, 5]
Subscripts may also be used on the left-hand side of an assignment:
:::wren
list[0] = "item"
map["key"] = "value"
Again, these are just method calls. The last example is equivalent to invoking
the `[]=` method on `map`, passing in `"key"` and `"value"`.
## Logical operators
The `&&` and `||` operators are not like the other infix operators. They work
more like [control flow](control-flow.html) structures than operators because
they conditionally execute some code&mdash;they short-circuit. Depending on the
value of the left-hand side, the right-hand operand expression may or may not
be evaluated. Because of this, they cannot be overloaded and their behavior is
fixed.
A `&&` ("logical and") expression evaluates the left-hand argument. If it's
[false](control-flow.html#truth), it returns that value. Otherwise it evaluates
and returns the right-hand argument.
:::wren
System.print(false && 1) // false
System.print(1 && 2) // 2
An `||` ("logical or") expression is reversed. If the left-hand argument is
[true](control-flow.html#truth), it's returned, otherwise the right-hand
argument is evaluated and returned:
:::wren
System.print(false || 1) // 1
System.print(1 || 2) // 1
## The conditional operator `?:`
Also known as the "ternary" operator since it takes three arguments, Wren has
the little "if statement in the form of an expression" you know and love from C
and its brethren.
:::wren
System.print(1 != 2 ? "math is sane" : "math is not sane!")
It takes a condition expression, followed by `?`, followed by a then
expression, a `:`, then an else expression. Just like `if`, it evaluates the
condition. If true, it evaluates (and returns) the then expression. Otherwise
it does the else expression.
## The `is` operator
Wren has one last expression form. You can use the `is` keyword like an infix
operator. It performs a type test. The left operand is an object and the right
operand is a class. It evaluates to `true` if the object is an instance of the
class (or one of its subclasses).
:::wren
123 is Num // true
"s" is Num // false
null is String // false
[] is List // true
[] is Sequence // true
## Precedence
When you mix these all together, you need to worry about
*precedence*&mdash;which operators bind more tightly than others&mdash;and
*associativity*&mdash;how a series of the same operator is ordered. Wren mostly
follows C, except that it fixes the bitwise operator mistake. The full
precedence table, from highest to lowest, is:
<table class="precedence">
<tbody>
<tr>
<th>Prec</th>
<th>Operator</th>
<th>Description</th>
<th>Assoc</th>
</tr>
<tr>
<td>1</td>
<td><code>()</code> <code>[]</code> <code>.</code></td>
<td>Grouping, Subscript, Method call</td>
<td>Left</td>
</tr>
<tr>
<td>2</td>
<td><code>-</code> <code>!</code> <code>~</code></td>
<td>Negate, Not, Complement</td>
<td>Right</td>
</tr>
<tr>
<td>3</td>
<td><code>*</code> <code>/</code> <code>%</code></td>
<td>Multiply, Divide, Modulo</td>
<td>Left</td>
</tr>
<tr>
<td>4</td>
<td><code>+</code> <code>-</code></td>
<td>Add, Subtract</td>
<td>Left</td>
</tr>
<tr>
<td>5</td>
<td><code>..</code> <code>...</code></td>
<td>Inclusive range, Exclusive range</td>
<td>Left</td>
</tr>
<tr>
<td>6</td>
<td><code>&lt;&lt;</code> <code>&gt;&gt;</code></td>
<td>Left shift, Right shift</td>
<td>Left</td>
</tr>
<tr>
<td>7</td>
<td><code>&lt;</code> <code>&lt;=</code> <code>&gt;</code> <code>&gt;=</code></td>
<td>Comparison</td>
<td>Left</td>
</tr>
<tr>
<td>8</td>
<td><code>==</code></td>
<td>Equals</td>
<td>Left</td>
</tr>
<tr>
<td>8</td>
<td><code>!=</code></td>
<td>Not equal</td>
<td>Left</td>
</tr>
<tr>
<td>9</td>
<td><code>&amp;</code></td>
<td>Bitwise and</td>
<td>Left</td>
</tr>
<tr>
<td>10</td>
<td><code>^</code></td>
<td>Bitwise xor</td>
<td>Left</td>
</tr>
<tr>
<td>11</td>
<td><code>|</code></td>
<td>Bitwise or</td>
<td>Left</td>
</tr>
<tr>
<td>12</td>
<td><code>is</code></td>
<td>Type test</td>
<td>Left</td>
</tr>
<tr>
<td>13</td>
<td><code>&amp;&amp;</code></td>
<td>Logical and</td>
<td>Left</td>
</tr>
<tr>
<td>14</td>
<td><code>||</code></td>
<td>Logical or</td>
<td>Left</td>
</tr>
<tr>
<td>15</td>
<td><code>?:</code></td>
<td>Conditional</td>
<td>Right</td>
</tr>
<tr>
<td>16</td>
<td><code>=</code></td>
<td>Assign</td>
<td>Right</td>
</tr>
</tbody>
</table>

View File

@ -1,169 +0,0 @@
^title Fibers
^category types
Fibers are a key part of Wren. They form its execution model, its concurrency
story, and take the place of exceptions in [error
handling](error-handling.html).
They are a bit like threads except they are *cooperatively* scheduled. That
means Wren doesn't pause one fiber and switch to another until you tell it to.
You don't have to worry about context switches at random times and all of the
headaches those cause.
Fibers are managed entirely by Wren, so they don't use OS thread resources, or
require heavyweight context switches. They just need a bit of memory for their
stacks. A fiber will get garbage collected like any other object when not
referenced any more, so you can create them freely.
They are lightweight enough that you can, for example, have a separate fiber
for each entity in a game. Wren can handle thousands of them without any
trouble. For example, when you run Wren in interactive mode, it creates a new
fiber for every line of code you type in.
## Creating fibers
All Wren code runs within the context of a fiber. When you first start a Wren
script, a main fiber is created for you automatically. You can spawn new fibers
using the `Fiber` class's constructor:
:::wren
var fiber = Fiber.new {
System.print("This runs in a separate fiber.")
}
Creating a fiber does not immediately run it. It's just a first class bundle of
code sitting there waiting to be activated, a bit like a
[function](functions.html).
## Invoking fibers
Once you've created a fiber, you can invoke it (which suspends the current
fiber) by calling its `call()` method:
:::wren
fiber.call()
The called fiber will execute its code until it reaches the end of its body or
until it passes control to another fiber. If it reaches the end of its body,
it's considered *done*:
:::wren
var fiber = Fiber.new { System.print("Hi") }
fiber.isDone // false
fiber.call()
fiber.isDone // true
When it finishes, it automatically resumes the fiber that called it. It's a
runtime error to try to call a fiber that is already done.
## Yielding
The main difference between fibers and functions is that a fiber can be
suspended in the middle of its operation and then resumed later. Calling
another fiber is one way to suspend a fiber, but that's more or less the same
as one function calling another.
Things get interesting when a fiber *yields*. A yielded fiber passes control
*back* to the fiber that ran it, but *remembers where it is*. The next time the
fiber is called, it picks up right where it left off and keeps going.
You can make a fiber yield by calling the static `yield()` method on `Fiber`:
:::wren
var fiber = Fiber.new {
System.print("fiber 1")
Fiber.yield()
System.print("fiber 2")
}
System.print("main 1")
fiber.call()
System.print("main 2")
fiber.call()
System.print("main 3")
This program prints:
:::text
main 1
fiber 1
main 2
fiber 2
main 3
Note that even though this program has *concurrency*, it's still
*deterministic*. You can reason precisely about what it's doing and aren't at
the mercy of a thread scheduler playing Russian roulette with your code.
## Passing values
Calling and yielding fibers is used for passing control, but it can also pass
*data*. When you call a fiber, you can optionally pass a value to it. If the
fiber has yielded and is waiting to resume, the value becomes the return value
of the `yield()` call:
:::wren
var fiber = Fiber.new {
var result = Fiber.yield()
System.print(result)
}
fiber.call("discarded")
fiber.call("sent")
This prints "sent". Note that the first value sent to the fiber through call is
ignored. That's because the fiber isn't waiting on a `yield()` call, so there's
nowhere for the sent value to go.
Fibers can also pass values *back* when they yield. If you pass an argument to
`yield()`, that will become the return value of the `call` that was used to
invoke the fiber:
:::wren
var fiber = Fiber.new {
Fiber.yield("sent")
}
System.print(fiber.call())
This also prints "sent".
## Full coroutines
What we've seen so far is very similar to what you can do with languages like
Python and C# that have *generators*. Those let you define a function call that
you can suspend and resume. When using the function, it appears like a sequence
you can iterate over.
Wren's fibers can do that, but they can do much more. Like Lua, they are full
*coroutines*&mdash;they can suspend from anywhere in the callstack. For
example:
:::wren
var fiber = Fiber.new {
(1..10).map {|i|
Fiber.yield(i)
}
}
Here, we're calling `yield()` from within a [function](functions.html) being
passed to the `map()` method. This works fine in Wren because that inner
`yield()` call will suspend the call to `map()` and the function passed to it
as a callback.
## Transferring control
Fibers have one more trick up their sleeves. When you execute a fiber using
`call()`, the fiber tracks which fiber it will return to when it yields. This
lets you build up a chain of fiber calls that will eventually unwind back to
the main fiber when all of the called ones yield or finish.
This is almost always what you want. But if you're doing something really low
level, like writing your own scheduler to manage a pool of fibers, you may not
want to treat them explicitly like a stack.
For rare cases like that, fibers also have a `transfer()` method. This switches
execution immediately to the transferred fiber. The previous one is suspended,
leaving it in whatever state it was in. You can resume the previous fiber by
transferring back to it, or even calling it. If you don't, execution stops when
the last transferred fiber returns.

View File

@ -1,5 +1,4 @@
^title Functions
^category types
No self-respecting language today can get by without functions&mdash;first
class little bundles of code. Since Wren is object-oriented, most of your code
@ -20,50 +19,58 @@ Since that's the most common usage pattern, Wren's syntax optimizes for that.
Taking a page from Ruby, a function is created by passing a *block argument* to
a method. At its simplest, it looks like this:
:::wren
blondie.callMe {
System.print("This is the body!")
}
<pre class="snippet">
blondie.callMe {
System.print("This is the body!")
}
</pre>
Here we're invoking the `callMe` method on `blondie`. We're passing one
argument, a function whose body is the following
[block](syntax.html#blocks)&mdash;everything between that pair of curly braces.
argument, a function whose body is the
following [block](syntax.html#blocks)&mdash;everything between that pair of
curly braces.
Methods that take a block argument receive it as a normal parameter. `callMe`
could be defined like so:
:::wren
class Blondie {
callMe(fn) {
// Call it...
}
}
<pre class="snippet">
class Blondie {
callMe(fn) {
// Call it...
}
}
var blondie = Blondie.new()
</pre>
A method can take other arguments in addition to the block. They appear before
the block just like a regular argument list. For example:
:::wren
blondie.callMeAt(867, 5309) {
System.print("This is the body!")
}
<pre class="snippet">
blondie.callMeAt(867, 5309) {
System.print("This is the body!")
}
</pre>
Of course, you don't *have* to use a block argument to pass a function to a
method. If you already have a function object, you can pass it like a regular
argument:
:::wren
var someFn = // Get a function...
blondie.callMe(someFn)
<pre class="snippet">
var someFn = // Get a function...
blondie.callMe(someFn)
</pre>
Block arguments are purely sugar for creating a function and passing it in one
little blob of syntax. There are some times when you want to create a function
but *don't* need to pass it to a method. For that, you can call the `Fn`
class's constructor:
:::wren
var someFn = Fn.new {
System.print("Hi!")
}
<pre class="snippet">
var someFn = Fn.new {
System.print("Hi!")
}
</pre>
As you can see it takes a block argument too! All the constructor does it
return that, so this exists purely as a convenience method for you.
@ -73,25 +80,27 @@ return that, so this exists purely as a convenience method for you.
Once you have a function, how do you invoke it? Like everything in Wren, you do
so by calling a method on it:
:::wren
class Blondie {
callMe(fn) {
fn.call()
}
}
<pre class="snippet">
class Blondie {
callMe(fn) {
fn.call()
}
}
</pre>
Functions expose a `call()` method that executes the body of the function. This
method is dynamically-dispatched like any other, so you can define your own
"function-like" classes and pass them to methods that expect "real" functions.
:::wren
class FakeFn {
call() {
System.print("I'm feeling functional!")
}
}
<pre class="snippet">
class FakeFn {
call() {
System.print("I'm feeling functional!")
}
}
blondie.callMe(FakeFn.new())
blondie.callMe(FakeFn.new())
</pre>
## Function parameters
@ -100,20 +109,22 @@ functions that we've seen so far take no arguments. To change that, you can
provide a parameter list surrounded by `|` immediately after the opening brace
of the body, like so:
:::wren
blondie.callMe {|first, last|
System.print("Hi, " + first + " " + last + "!")
}
<pre class="snippet">
blondie.callMe {|first, last|
System.print("Hi, " + first + " " + last + "!")
}
</pre>
Here we're passing a function to `greet` that takes two parameters, `first` and
Here we're passing a function to `callMe` that takes two parameters, `first` and
`last`. They are passed to the function when it's called:
:::wren
class Blondie {
callMe(fn) {
fn.call("Debbie", "Harry")
}
}
<pre class="snippet">
class Blondie {
callMe(fn) {
fn.call("Debbie", "Harry")
}
}
</pre>
It's an error to call a function with fewer arguments than its parameter list
expects. If you pass too *many* arguments, the extras are ignored.
@ -129,12 +140,13 @@ Otherwise, the body returns `null` by default. You can explicitly return a
value using a `return` statement. In other words, these two functions do the
same thing:
:::wren
Fn.new { "return value" }
<pre class="snippet">
Fn.new { "return value" }
Fn.new {
return "return value"
}
Fn.new {
return "return value"
}
</pre>
## Closures
@ -142,21 +154,27 @@ As you expect, functions are closures&mdash;they can access variables defined
outside of their scope. They will hold onto closed-over variables even after
leaving the scope where the function is defined:
:::wren
class Counter {
static create {
var i = 0
return Fn.new { i = i + 1 }
}
}
<pre class="snippet">
class Counter {
static create() {
var i = 0
return Fn.new { i = i + 1 }
}
}
</pre>
Here, the `create` method returns the function created on its second line. That
function references a variable `i` declared outside of the function. Even after
the function is returned from `create`, it is still able to read and assign
to`i`:
:::wren
var counter = Counter.create
System.print(counter.call()) // Prints "1".
System.print(counter.call()) // Prints "2".
System.print(counter.call()) // Prints "3".
<pre class="snippet">
var counter = Counter.create()
System.print(counter.call()) //> 1
System.print(counter.call()) //> 2
System.print(counter.call()) //> 3
</pre>
<br><hr>
<a class="right" href="classes.html">Classes &rarr;</a>
<a href="variables.html">&larr; Variables</a>

View File

@ -1,109 +1,87 @@
^title Getting Started
Getting Wren running on your machine is straightforward. Tiny C programs with
few dependencies are nice that way. "Wren" encompasses two separate artifacts:
## Trying out the language
* **The virtual machine.** This is the core chunk of C that executes Wren
If you'd like to try Wren, you have a few options.
* **In your browser.** You can try Wren **[right here](./try/)**!
* **On your computer.** The [Wren CLI](cli) project is a downloadable executable
to run scripts with access to file io and more. See the [Wren CLI docs](cli).
* **Embedded in your code.** See how to [build and embed Wren](#embed-the-vm) below.
And then read the [embedding guide](embedding)!
Once you have somewhere to explore, it's time to [learn the
language](syntax.html).
---
## Embed the VM
**The Wren Virtual Machine** is the core of the language that executes Wren
source code. It is just a library, not a standalone application. It's
designed to be [embedded][] in a larger host application. It has no
dependencies beyond the C standard library. You can is use as a static
library, shared library, or simply compile the source into your app.
designed to be [embedded][] in a larger host application.
* **The command line executable.** Wren also ships with a CLI wrapper around
the VM. This gives you a way to run Wren code from the command-line, and
also includes modules for talking to the operating system&mdash;file IO,
networking, stuff like that. It depends on [libuv][] for that
functionality.
It has no dependencies beyond the C standard library.
You can use it as a static library, shared library, or simply compile the source into your app.
[embedded]: embedding-api.html
[libuv]: http://libuv.org/
### Building Wren
If you're on a Unix or Mac and you can rock a command line, it's just:
To build the Wren library, we look inside the `projects/` folder.
In here you'll find ready to go projects for `Visual Studio`, `XCode` and tools like `make`.
:::sh
$ git clone https://github.com/munificent/wren.git
$ cd wren
$ make
$ ./wren
* **Windows** Open `wren.sln` inside `projects/vs2019/` (or `vs2017`), hit build.
* **Mac** Open `wren.xcworkspace` inside `projects/xcode/`, hit build.
* **Linux** Run `make` inside of `projects/make/`.
This builds both the VM and the CLI. It downloads libuv automatically for you.
The release build of the CLI goes right into the repo's top level directory.
Binaries for other configurations are built to `bin/`. Static and shared
libraries for embedding Wren get built in `lib/`.
In each case, **there will be library files generated into the root `lib/` folder**.
These are what you'll link into your project, based on your needs.
For Mac users, there is also an XCode project under `util/xcode`. For
Windows brethren, `util/msvc2013` contains a Visual Studio solution. Note
that these may not have the exact same build settings as the makefile. The
makefile is the "official" way to compile Wren.
* **Static Linking** `wren.lib` on Windows, `libwren.a` elsewhere.
* **Dynamic Linking** `wren.dll` on Windows, `libwren.so` on Linux, and `libwren.dylib` on Mac.
If you only want to build the VM, you can do:
<small>
Note that the default build will also generate `wren_test` inside of `bin/`,
a binary that is used to run the language tests. It can execute simple scripts.
</small>
:::sh
$ make vm
**Other platforms**
If your platform isn't explicitly supported,
it is recommended that you include the Wren source
in your project for a portable experience.
This compiles the VM to static and shared libraries. It does not even download
libuv since it isn't needed.
### Including the code in your project
## Interactive mode
**all source files**
The alternative to building via the provided projects is to include the wren source code in your project.
Since it has no dependencies this is simple, all the code in `src/` comes along. There's a readme in `src/` for details.
If you just run `wren` without any arguments, it starts the interpreter in
interactive mode. You can type in a line of code, and it immediately executes
it. Here's something to try:
**'amalgamated' build**
If you want an even simpler way, there's an 'amalgamated' build (often called `blob`, or `unity` builds.).
This is _all of the wren source code in one file_.
:::wren
System.print("Hello, world!")
This file can be generated by running `python3 util/generate_amalgamation.py`, and the generated output will be in `build/wren.c`.
Include `build/wren.c` and `src/include/wren.h` in your project code and you're good to go.
<small>Ideally later we can automate generating this and include it in the repo.</small>
Or a little more exciting:
---
:::wren
for (i in 1..10) System.print("Counting up " + i.toString)
[embedded]: embedding
You can exit the interpreter using good old Ctrl-C or Ctrl-D, or just throw
your computer to the ground and storm off.
If you run into bugs, or have ideas or questions, any of
the following work:
## Running scripts
The standalone interpreter can also load scripts from files and run them. Just
pass the name of the script to `wren`. Create a file named "my_script.wren" in
your favorite text editor and paste this into it:
:::wren
for (yPixel in 0...24) {
var y = yPixel / 12 - 1
for (xPixel in 0...80) {
var x = xPixel / 30 - 2
var x0 = x
var y0 = y
var iter = 0
while (iter < 11 && x0 * x0 + y0 * y0 <= 4) {
var x1 = (x0 * x0) - (y0 * y0) + x
var y1 = 2 * x0 * y0 + y
x0 = x1
y0 = y1
iter = iter + 1
}
System.write(" .-:;+=xX$& "[iter])
}
System.print("")
}
Now run:
:::sh
$ ./wren my_script.wren
Neat, right? You're a Wren programmer now! The next step is to [read more
docs](syntax.html) and learn your way around the language. If you run into
bugs, or have ideas or questions, any of the following work:
* **Ask on the [Wren mailing list][list].**
* Tell me on twitter at [@munificentbob][twitter].
* Join the [discord community][discord].
* Ask on the [Wren mailing list][list] (which is pretty quiet).
* Tell us on twitter at [@munificentbob][twitter] or [@ruby0x1][twitter0x1].
* [File a ticket][issue] at [the GitHub repo][repo].
* Send a pull request.
* Email me at [`robert@stuffwithstuff.com`](mailto:robert@stuffwithstuff.com).
* The CLI also has [tickets][issue_cli] and a [GitHub repo][repo_cli] too.
* Pull requests are welcome.
[discord]: https://discord.gg/Kx6PxSX
[list]: https://groups.google.com/forum/#!forum/wren-lang
[twitter]: https://twitter.com/intent/user?screen_name=munificentbob
[issue]: https://github.com/munificent/wren/issues
[repo]: https://github.com/munificent/wren
[twitter0x1]: https://twitter.com/intent/user?screen_name=ruby0x1
[issue]: https://github.com/wren-lang/wren/issues
[repo]: https://github.com/wren-lang/wren
[issue_cli]: https://github.com/wren-lang/wren-cli/issues
[repo_cli]: https://github.com/wren-lang/wren-cli

View File

@ -1,24 +1,27 @@
^title Welcome
^title
## Wren is a small, fast, class-based concurrent scripting language
---
Think Smalltalk in a Lua-sized package with a dash of Erlang and wrapped up in
a familiar, modern [syntax][].
:::wren
System.print("Hello, world!")
<pre class="snippet">
System.print("Hello, world!")
class Wren {
flyTo(city) {
System.print("Flying to " + city)
}
}
class Wren {
flyTo(city) {
System.print("Flying to %(city)")
}
}
var adjectives = Fiber.new {
["small", "clean", "fast"].each {|word| Fiber.yield(word) }
}
var adjectives = Fiber.new {
["small", "clean", "fast"].each {|word| Fiber.yield(word) }
}
while (!adjectives.isDone) System.print(adjectives.call())
while (!adjectives.isDone) System.print(adjectives.call())
</pre>
* **Wren is small.** The VM implementation is under [4,000 semicolons][src].
You can skim the whole thing in an afternoon. It's *small*, but not
@ -33,7 +36,7 @@ a familiar, modern [syntax][].
[classes][] front and center.
* **Wren is concurrent.** Lightweight [fibers][] are core to the execution
model and let you organize your program into an army of communicating
model and let you organize your program into a flock of communicating
coroutines.
* **Wren is a scripting language.** Wren is intended for embedding in
@ -41,17 +44,19 @@ a familiar, modern [syntax][].
and [an easy-to-use C API][embedding]. It compiles cleanly as C99, C++98
or anything later.
If you like the sound of this, [let's get started][started]. You can even try
it [in your browser][browser]! Excited? Well, come on and [get
involved][contribute]!
---
You can try it [in your browser][browser]!
If you like the sound of this, [let's get started][started].
Excited? You're also welcome to [get involved][contribute]!
[syntax]: syntax.html
[src]: https://github.com/munificent/wren/tree/master/src
[nan]: https://github.com/munificent/wren/blob/46c1ba92492e9257aba6418403161072d640cb29/src/wren_value.h#L378-L433
[src]: https://github.com/wren-lang/wren/tree/master/src
[nan]: https://github.com/wren-lang/wren/blob/46c1ba92492e9257aba6418403161072d640cb29/src/wren_value.h#L378-L433
[perf]: performance.html
[classes]: classes.html
[fibers]: fibers.html
[embedding]: embedding-api.html
[fibers]: concurrency.html
[embedding]: embedding
[started]: getting-started.html
[browser]: http://ppvk.github.io/wren-nest/
[browser]: try
[contribute]: contributing.html

View File

@ -1,12 +1,12 @@
^title Lists
^category types
A list is a compound object that holds a collection of elements identified by
integer index. You can create a list by placing a sequence of comma-separated
expressions inside square brackets:
:::wren
[1, "banana", true]
<pre class="snippet">
[1, "banana", true]
</pre>
Here, we've created a list of three elements. Notice that the elements don't
have to be the same type.
@ -14,33 +14,39 @@ have to be the same type.
## Accessing elements
You can access an element from a list by calling the [subscript
operator](expressions.html#subscript-operators) on it with the index of the
operator][] on it with the index of the
element you want. Like most languages, indexes start at zero:
:::wren
var hirsute = ["sideburns", "porkchops", "'stache", "goatee"]
hirsute[0] // "sideburns".
hirsute[1] // "porkchops".
[subscript operator]: method-calls.html#subscripts
<pre class="snippet">
var hirsute = ["sideburns", "porkchops", "'stache", "goatee"]
System.print(hirsute[0]) //> sideburns
System.print(hirsute[1]) //> porkchops
</pre>
Negative indices counts backwards from the end:
:::wren
hirsute[-1] // "goatee".
hirsute[-2] // "'stache".
<pre class="snippet">
System.print(hirsute[-1]) //> goatee
System.print(hirsute[-2]) //> 'stache
</pre>
It's a runtime error to pass an index outside of the bounds of the list. If you
don't know what those bounds are, you can find out using count:
:::wren
hirsute.count // 4.
<pre class="snippet">
System.print(hirsute.count) //> 4
</pre>
## Slices and ranges
Sometimes you want to copy a chunk of elements from a list. You can do that by
passing a [range](values.html#ranges) to the subscript operator, like so:
:::wren
hirsute[1..2] // ["porkchops", "'stache"].
<pre class="snippet">
System.print(hirsute[1..2]) //> [porkchops, 'stache]
</pre>
This returns a new list containing the elements of the original list whose
indices are within the given range. Both inclusive and exclusive ranges work
@ -49,29 +55,33 @@ and do what you expect.
Negative bounds also work like they do when passing a single number, so to copy
a list, you can just do:
:::wren
hirsute[0..-1]
<pre class="snippet">
hirsute[0..-1]
</pre>
## Adding elements
Lists are *mutable*, meaning their contents can be changed. You can swap out an
existing element in the list using the subscript setter:
:::wren
hirsute[1] = "muttonchops"
System.print(hirsute[1]) // muttonchops.
<pre class="snippet">
hirsute[1] = "muttonchops"
System.print(hirsute[1]) //> muttonchops
</pre>
It's an error to set an element that's out of bounds. To grow a list, you can
use `add` to append a single item to the end:
:::wren
hirsute.add("goatee")
System.print(hirsute.count) // 4.
<pre class="snippet">
hirsute.add("goatee")
System.print(hirsute.count) //> 5
</pre>
You can insert a new element at a specific position using `insert`:
:::wren
hirsute.insert(2, "soul patch")
<pre class="snippet">
hirsute.insert(2, "soul patch")
</pre>
The first argument is the index to insert at, and the second is the value to
insert. All elements following the inserted one will be pushed down to
@ -81,12 +91,24 @@ It's valid to "insert" after the last element in the list, but only *right*
after it. Like other methods, you can use a negative index to count from the
back. Doing so counts back from the size of the list *after* it's grown by one:
:::wren
var letters = ["a", "b", "c"]
letters.insert(3, "d") // OK: inserts at end.
System.print(letters) // ["a", "b", "c", "d"]
letters.insert(-2, "e") // Counts back from size after insert.
System.print(letters) // ["a", "b", "c", "e", "d"]
<pre class="snippet">
var letters = ["a", "b", "c"]
letters.insert(3, "d") // OK: inserts at end.
System.print(letters) //> [a, b, c, d]
letters.insert(-2, "e") // Counts back from size after insert.
System.print(letters) //> [a, b, c, e, d]
</pre>
## Adding lists together
Lists have the ability to be added together via the `+` operator. This is often known as concatenation.
<pre class="snippet">
var letters = ["a", "b", "c"]
var other = ["d", "e", "f"]
var combined = letters + other
System.print(combined) //> [a, b, c, d, e, f]
</pre>
## Removing elements
@ -94,18 +116,25 @@ The opposite of `insert` is `removeAt`. It removes a single element from a
given position in the list. All following items are shifted up to fill in the
gap:
:::wren
var letters = ["a", "b", "c", "d"]
letters.removeAt(1)
System.print(letters) // ["a", "c", "d"]
<pre class="snippet">
var letters = ["a", "b", "c", "d"]
letters.removeAt(1)
System.print(letters) //> [a, c, d]
</pre>
The `removeAt` method returns the removed item:
:::wren
System.print(letters.removeAt(1)) // "c"
<pre class="snippet">
System.print(letters.removeAt(1)) //> c
</pre>
If you want to remove everything from the list, you can clear it:
:::wren
hirsute.clear()
System.print(hirsute) // []
<pre class="snippet">
hirsute.clear()
System.print(hirsute) //> []
</pre>
<br><hr>
<a class="right" href="maps.html">Maps &rarr;</a>
<a href="values.html">&larr; Values</a>

View File

@ -1,5 +1,4 @@
^title Maps
^category types
A map is an *associative* collection. It holds a set of entries, each of which
maps a *key* to a *value*. The same data structure has a variety of names in
@ -8,28 +7,27 @@ other languages: hash table, dictionary, association, table, etc.
You can create a map by placing a series of comma-separated entries inside
curly braces. Each entry is a key and a value separated by a colon:
:::wren
{
"George": "Harrison",
"John": "Lennon",
"Paul": "McCartney",
"Ringo": "Starr"
}
<pre class="snippet">
{
"George": "Harrison",
"John": "Lennon",
"Paul": "McCartney",
"Ringo": "Starr"
}
</pre>
This creates a map that maps the first names of the Beatles to their last
names. Syntactically, in a map literal, keys can be any literal, a variable
This creates a map that associates the first name of each Beatle with his last
name. Syntactically, in a map literal, keys can be any literal, a variable
name, or a parenthesized expression. Values can be any expression. Here, we're
using string literals for both keys and values.
*Semantically*, values can be any object, and multiple keys may map to the
same value. Keys have a few limitations. They must be one of the immutable
built-in [value types](values.html) in Wren. That means a number, string,
range, bool, or `null`. You can also use a [class object](classes.html) as a
key.
*Semantically*, values can be any object, and multiple keys may map to the same
value. Keys have a few limitations. They must be one of the immutable built-in
[value types][] in Wren. That means a number, string, range, bool, or `null`.
You can also use a [class object][] as a key.
In addition, even though they aren't strictly immutable, [fibers](fibers.html)
can be used as map keys. This is handy for storing data that's roughly
"thread-local" by using the current fiber as a map key.
[value types]: values.html
[class object]: classes.html
The reason for this limitation&mdash;and the reason maps are called "*hash*
tables" in other languages&mdash;is that each key is used to generate a numeric
@ -39,26 +37,28 @@ built-in types, only those can be used as keys.
## Adding entries
You add new key-value pairs to the map by using the [subscript operator][]:
You add new key-value pairs to the map using the [subscript operator][]:
:::wren
var capitals = {}
[subscript operator]: method-calls.html#subscripts
<pre class="snippet">
var capitals = {}
capitals["Georgia"] = "Atlanta"
capitals["Idaho"] = "Boise"
capitals["Maine"] = "Augusta"
</pre>
If the key isn't already present, this adds it and associates it with the given
value. If the key is already there, this just replaces its value.
[subscript operator]: expressions.html#subscript-operators
## Looking up values
To find the value associated with some key, again you use your friend the
subscript operator:
:::wren
System.print(capitals["Idaho"]) // "Boise".
<pre class="snippet">
System.print(capitals["Idaho"]) //> Boise
</pre>
If the key is present, this returns its value. Otherwise, it returns `null`. Of
course, `null` itself can also be used as a value, so seeing `null` here
@ -66,44 +66,49 @@ doesn't necessarily mean the key wasn't found.
To tell definitively if a key exists, you can call `containsKey()`:
:::wren
var belief = {"nihilism": null}
<pre class="snippet">
var belief = {"nihilism": null}
System.print(belief["nihilism"]) // "null" though key exists.
System.print(belief["solipsism"]) // Also "null".
System.print(belief.containsKey("nihilism")) // "true".
System.print(belief.containsKey("solipsism")) // "false".
System.print(belief["nihilism"]) //> null (though key exists)
System.print(belief["solipsism"]) //> null
System.print(belief.containsKey("nihilism")) //> true
System.print(belief.containsKey("solipsism")) //> false
</pre>
You can see how many entries a map contains using `count`:
:::wren
System.print(capitals.count) // "3".
<pre class="snippet">
System.print(capitals.count) //> 3
</pre>
## Removing entries
To remove an entry from a map, call `remove()` and pass in the key for the
entry you want to delete:
:::wren
capitals.remove("Maine")
System.print(capitals.containsKey("Maine")) // "false".
<pre class="snippet">
capitals.remove("Maine")
System.print(capitals.containsKey("Maine")) //> false
</pre>
If the key was found, this returns the value that was associated with it:
:::wren
System.print(capitals.remove("Georgia")) // "Atlanta".
<pre class="snippet">
System.print(capitals.remove("Georgia")) //> Atlanta
</pre>
If the key wasn't in the map to begin with, `remove()` just returns `null`.
If you want to remove *everything* from the map, just like with [lists][], you
can just call `clear()`:
:::wren
capitals.clear()
System.print(capitals.count) // "0".
If you want to remove *everything* from the map, like with [lists][], you call
`clear()`:
[lists]: lists.html
<pre class="snippet">
capitals.clear()
System.print(capitals.count) //> 0
</pre>
## Iterating over the contents
The subscript operator works well for finding values when you know the key
@ -113,24 +118,29 @@ For that, map exposes two methods: `keys` and `values`.
The first returns a [Sequence][] that [iterates][] over all of the keys in the
map, and the second returns one that iterates over the values.
[sequence]: core/sequence.html
[sequence]: modules/core/sequence.html
[iterates]: control-flow.html#the-iterator-protocol
If you want to see all of the key-value pairs in a map, the easiest way is to
iterate over the keys and use each to look up its value:
:::wren
var birds = {
"Arizona": "Cactus wren",
"Hawaii": "Nēnē",
"Ohio": "Northern Cardinal"
}
<pre class="snippet">
var birds = {
"Arizona": "Cactus wren",
"Hawaii": "Nēnē",
"Ohio": "Northern Cardinal"
}
for (state in birds.keys) {
System.print("The state bird of " + state + " is " + birds[state])
}
for (state in birds.keys) {
System.print("The state bird of " + state + " is " + birds[state])
}
</pre>
This program will print the three states and their birds. However, the *order*
This program prints the three states and their birds. However, the *order*
that they are printed isn't defined. Wren makes no promises about what order
keys and values will be iterated in when you use these methods. All it promises
is that every entry will appear exactly once.
keys and values are iterated in when you use these methods. All it promises is
that every entry will appear exactly once.
<br><hr>
<a class="right" href="method-calls.html">Method Calls &rarr;</a>
<a href="lists.html">&larr; Lists</a>

View File

@ -0,0 +1,196 @@
^title Method Calls
Wren is deeply object oriented, so most code consists of invoking methods on
objects, usually something like this:
<pre class="snippet">
System.print("Heyoo!") //> Heyoo!
</pre>
You have a *receiver* expression (here `System`) followed by a `.`, then a name
(`print`) and an argument list in parentheses (`("Heyoo!")`). Multiple arguments
are separated by commas:
<pre class="snippet">
list.insert(3, "item")
</pre>
The argument list can also be empty:
<pre class="snippet">
list.clear()
</pre>
The VM executes a method call like so:
1. Evaluate the receiver and arguments from left to right.
2. Look up the method on the receiver's [class][].
3. Invoke it, passing in the argument values.
[class]: classes.html
## Signature
Unlike most other dynamically-typed languages, in Wren a class can have multiple
methods with the same *name*, as long as they have different *signatures*. The
signature includes the method's name along with the number of arguments it
takes. In technical terms, this means you can *overload by arity*.
For example, the [Random][] class has two methods for getting a random integer.
One takes a minimum and maximum value and returns a value in that range. The
other only takes a maximum value and uses 0 as the minimum:
[random]: modules/random/random.html
<pre class="snippet">
var random = Random.new()
random.int(3, 10)
random.int(4)
</pre>
In a language like Python or JavaScript, these would both call a single `int()`
method, which has some kind of "optional" parameter. The body of the method
figures out how many arguments were passed and uses control flow to handle the
two different behaviors. That means first parameter represents "max unless
another parameter was passed, in which case it's min". Kind of gross.
In Wren, these are calls to two entirely separate methods, `int(_,_)` and
`int(_)`. This makes it easier to define "overloads" like this since you don't
need optional parameters or any kind of control flow to handle the different
cases.
It's also faster to execute. Since we know how many arguments are passed at
compile time, we can compile this to directly call the right method and avoid
any "if I got two arguments do this..." runtime work.
## Getters
Some methods exist to expose a stored or computed property of an object. These
are *getters* and have no parentheses:
<pre class="snippet">
"string".count //> 6
(1..10).min //> 1
1.23.sin //> 0.9424888019317
[1, 2, 3].isEmpty //> false
</pre>
A getter is *not* the same as a method with an empty argument list. The `()` is
part of the signature, so `count` and `count()` have different signatures.
Unlike Ruby's optional parentheses, Wren wants to make sure you call a getter
like a getter and a `()` method like a `()` method. These don't work:
<pre class="snippet">
"string".count()
[1, 2, 3].clear
</pre>
If you're defining some member that doesn't need any parameters, you need to
decide if it should be a getter or a method with an empty `()` parameter list.
The general guidelines are:
* If it modifies the object or has some other side effect, make it a method:
<pre class="snippet">
list.clear()
</pre>
* If the method supports multiple arities, make the zero-parameter case a `()`
method to be consistent with the other versions:
<pre class="snippet">
Fiber.yield()
Fiber.yield("value")
</pre>
* Otherwise, it can probably be a getter.
## Setters
A getter lets an object expose a public "property" that you can *read*.
Likewise, a *setter* lets you write to a property:
<pre class="snippet">
person.height = 74 // Grew up!
</pre>
Despite the `=`, this is just another syntax for a method call. From the
language's perspective, the above line is just a call to the `height=(_)`
method on `person`, passing in `74`.
Since the `=(_)` is in the setter's signature, an object can have both a getter
and setter with the same name without a collision. Defining both lets you
provide a read/write property.
## Operators
Wren has most of the same operators you know and love with the same precedence
and associativity. We have three prefix operators:
<pre class="snippet">
! ~ -
</pre>
They are just method calls on their operand without any other arguments. An
expression like `!possible` means "call the `!` method on `possible`".
We also have a slew of infix operators&mdash;they have operands on both sides.
They are:
<pre class="snippet">
* / % + - .. ... << >> < <= > >= == != & ^ | is
</pre>
Like prefix operators, they are all funny ways of writing method calls. The left
operand is the receiver, and the right operand gets passed to it. So `a + b` is
semantically interpreted as "invoke the `+(_)` method on `a`, passing it `b`".
Note that `-` is both a prefix and an infix operator. Since they have different
signatures (`-` and `-(_)`), there's no ambiguity between them.
Most of these are probably familiar already. The `..` and `...` operators are
"range" operators. The number type implements those to create [range][]
objects, but they are method calls like other operators.
[range]: values.html#ranges
The `is` keyword is a "type test" operator. The base [Object][] class implements
it to tell if an object is an instance of a given class. You'll rarely need to,
but you can override `is` in your own classes. That can be useful for things
like mocks or proxies where you want an object to masquerade as a certain class.
[object]: modules/core/object.html
## Subscripts
Another familiar syntax from math class is *subscripting* using square brackets
(`[]`). It's handy for working with collection-like objects. For example:
<pre class="snippet">
list[0] // Get the first item in a list.
map["key"] // Get the value associated with "key".
</pre>
You know the refrain by now. In Wren, these are method calls. In the above
examples, the signature is `[_]`. Subscript operators may also take multiple
arguments, which is useful for things like multi-dimensional arrays:
<pre class="snippet">
matrix[3, 5]
</pre>
These examples are subscript "getters", and there are also
corresponding *subscript setters*:
<pre class="snippet">
list[0] = "item"
map["key"] = "value"
</pre>
These are equivalent to method calls whose signature is `[_]=(_)` and whose
arguments are both the subscript (or subscripts) and the value on the right-hand
side.
<br><hr>
<a class="right" href="control-flow.html">Control Flow &rarr;</a>
<a href="maps.html">&larr; Maps</a>

View File

@ -1,5 +1,4 @@
^title Modules
^category language
^title Modularity
Once you start writing programs that are more than little toys, you quickly run
into two problems:
@ -26,8 +25,9 @@ When you run Wren and give it a file name to execute, the contents of that file
define the "main" module that execution starts at. To load and execute other
modules, you use an import statement:
:::wren
import "beverages" for Coffee, Tea
<pre class="snippet">
import "beverages" for Coffee, Tea
</pre>
This finds a module named "beverages" and executes its source code. Then, it
looks up two top-level variables, `Coffee` and `Tea` in *that* module and
@ -36,23 +36,26 @@ creates new variables in *this* module with their values.
This statement can appear anywhere a variable declaration is allowed, even
inside blocks:
:::wren
if (thirsty) {
import "beverages" for Coffee, Tea
}
<pre class="snippet">
if (thirsty) {
import "beverages" for Coffee, Tea
}
</pre>
If you want to load a module, but not bind any variables from it, you can omit
the `for` clause:
:::wren
import "some_imperative_code"
<pre class="snippet">
import "some_imperative_code"
</pre>
That's the basic idea. Now let's break it down into each of the steps it
performs:
1. Locate the source code for the module.
2. Execute the imported module's code.
3. Bind new variables in the importing module to values defined in the imported module.
3. Bind new variables in the importing module to values defined in the imported
module.
We'll go through each step:
@ -66,18 +69,20 @@ string is used to locate a blob of source code.
When the host application creates a new Wren VM, it provides a module loader
function:
:::c
WrenConfiguration config;
config.loadModuleFn = loadModule;
<pre class="snippet" data-lang="c">
WrenConfiguration config;
config.loadModuleFn = loadModule;
// Other configuration...
// Other configuration...
WrenVM* vm = wrenNewVM(&config);
WrenVM* vm = wrenNewVM(&config);
</pre>
That function has this signature:
:::c
char* WrenLoadModuleFn(WrenVM* vm, const char* name);
<pre class="snippet" data-lang="c">
char* WrenLoadModuleFn(WrenVM* vm, const char* name);
</pre>
Whenever a module is imported, the VM calls this and passes it the name of the
module. The embedder is expected to return the source code contents of the
@ -90,17 +95,17 @@ found. When you do this, Wren will report it as a runtime error.
### The command-line loader
The default little command-line VM that comes with Wren has a very simple
The [Wren CLI command-line tool](getting-started.html#using-the-wren-cli) has a very simple
lookup process. It appends the module name and ".wren" to the directory where
the main module was loaded and looks for that file. So, let's say you run:
:::bash
$ wren /code/my_program.wren
$ wren code/my_program.wren
And that main module has:
:::wren
import "some/module"
<pre class="snippet">
import "some/module"
</pre>
Then the command-line VM will try to find `/code/some/module.wren`. By
convention, forward slashes should be used as path separators, even on Windows,
@ -110,9 +115,11 @@ valid separator on Windows, but backslashes are not valid on other OSes.)
## Executing the module
Once we have the source code for a module, we need to run it. First, the VM
takes the fiber that is executing the `import` statement in the importing
takes the [fiber][] that is executing the `import` statement in the importing
module and pauses it.
[fiber]: concurrency.html
Then it creates a new module object&mdash;a new fresh top-level scope,
basically&mdash;and a new fiber. It executes the new module's code in that
fiber and scope. The module can run whatever imperative code it wants and
@ -137,8 +144,9 @@ These are simply variables declared outside of any
These are visible to anything inside the module, but they can also be
*exported* and used by other modules. When Wren executes an import like:
:::wren
import "beverages" for Coffee, Tea
<pre class="snippet">
import "beverages" for Coffee, Tea
</pre>
First it runs the "beverages" module. Then it goes through each of the variable
names in the `for` clause. For each one, it looks for a top-level variable with
@ -157,23 +165,24 @@ rarely makes a difference.
## Shared imports
Earlier, I described a programs set of modules as a tree. Of course, it's only
Earlier, I described a program's set of modules as a tree. Of course, it's only
a *tree* of modules if there are no *shared imports*. But consider a program
like:
:::wren
// main.wren
import "a"
import "b"
<pre class="snippet">
// main.wren
import "a"
import "b"
// a.wren
import "shared"
// a.wren
import "shared"
// b.wren
import "shared"
// b.wren
import "shared"
// shared.wren
System.print("Shared!")
// shared.wren
System.print("Shared!")
</pre>
Here, "a" and "b" both want to use "shared". If "shared" defines some top-level
state, we only want a single copy of that in memory. To handle this, a module's
@ -206,23 +215,23 @@ it will be found in the registry and the cycle is short-circuited.
For example:
:::wren
// main.wren
import "a"
<pre class="snippet">
// main.wren
import "a"
// a.wren
System.print("start a")
import "b"
System.print("end a")
// a.wren
System.print("start a")
import "b"
System.print("end a")
// b.wren
System.print("start b")
import "a"
System.print("end b")
// b.wren
System.print("start b")
import "a"
System.print("end b")
</pre>
This program runs successfully and prints:
:::text
start a
start b
end b
@ -230,17 +239,18 @@ This program runs successfully and prints:
Where you have to be careful is binding variables. Consider:
:::wren
// main.wren
import "a"
<pre class="snippet">
// main.wren
import "a"
// a.wren
import "b" for B
var A = "a variable"
// a.wren
import "b" for B
var A = "a variable"
// b.wren
import "a" for A
var B = "b variable"
// b.wren
import "a" for A
var B = "b variable"
</pre>
The import of "a" in b.wren will fail here. If you trace the execution, you
get:
@ -255,17 +265,18 @@ defined yet since "a.wren" is still sitting on the `import "b" for B` line
before the declaration. To get this to work, you would need to move the
variable declaration above the import:
:::wren
// main.wren
import "a"
<pre class="snippet">
// main.wren
import "a"
// a.wren
var A = "a variable"
import "b" for B
// a.wren
var A = "a variable"
import "b" for B
// b.wren
import "a" for A
var B = "b variable"
// b.wren
import "a" for A
var B = "b variable"
</pre>
Now when we run it, we get:
@ -283,3 +294,6 @@ Now when we run it, we get:
This sounds super hairy, but that's because cyclic dependencies are hairy in
general. The key point here is that Wren *can* handle them in the rare cases
where you need them.
<br><hr>
<a href="error-handling.html">&larr; Error Handling</a>

View File

@ -1,7 +1,8 @@
^title Bool Class
^category core
Boolean values. There are two instances, `true` and `false`.
Boolean [values][]. There are two instances, `true` and `false`.
[values]: ../../values.html
## Methods
@ -9,9 +10,10 @@ Boolean values. There are two instances, `true` and `false`.
Returns the logical complement of the value.
:::wren
System.print(!true) // "false".
System.print(!false) // "true".
<pre class="snippet">
System.print(!true) //> false
System.print(!false) //> true
</pre>
### toString

View File

@ -0,0 +1,32 @@
^title Class Class
**TODO**
## Methods
### **name**
The name of the class.
### **supertype**
The superclass of this class.
<pre class="snippet">
class Crustacean {}
class Crab is Crustacean {}
System.print(Crab.supertype) //> Crustacean
</pre>
A class with no explicit superclass implicitly inherits Object:
<pre class="snippet">
System.print(Crustacean.supertype) //> Object
</pre>
Object forms the root of the class hierarchy and has no supertype:
<pre class="snippet">
System.print(Object.supertype) //> null
</pre>

View File

@ -0,0 +1,187 @@
^title Fiber Class
A lightweight coroutine. [Here][fibers] is a gentle introduction.
[fibers]: ../../concurrency.html
## Static Methods
### Fiber.**abort**(message)
Raises a runtime error with the provided message:
<pre class="snippet">
Fiber.abort("Something bad happened.")
</pre>
If the message is `null`, does nothing.
### Fiber.**current**
The currently executing fiber.
### Fiber.**new**(function)
Creates a new fiber that executes `function` in a separate coroutine when the
fiber is run. Does not immediately start running the fiber.
<pre class="snippet">
var fiber = Fiber.new {
System.print("I won't get printed")
}
</pre>
`function` must be a function (an actual [Fn][] instance, not just an object
with a `call()` method) and it may only take zero or one parameters.
[fn]: fn.html
### Fiber.**suspend**()
Pauses the current fiber, and stops the interpreter. Control returns to the
host application.
Typically, you store a reference to the fiber using `Fiber.current` before
calling this. The fiber can be resumed later by calling or transferring to that
reference. If there are no references to it, it is eventually garbage collected.
Much like `yield()`, returns the value passed to `call()` or `transfer()` when
the fiber is resumed.
### Fiber.**yield**()
Pauses the current fiber and transfers control to the parent fiber. "Parent"
here means the last fiber that was started using `call` and not `transfer`.
<pre class="snippet">
var fiber = Fiber.new {
System.print("Before yield")
Fiber.yield()
System.print("After yield")
}
fiber.call() //> Before yield
System.print("After call") //> After call
fiber.call() //> After yield
</pre>
When resumed, the parent fiber's `call()` method returns `null`.
If a yielded fiber is resumed by calling `call()` or `transfer()` with an
argument, `yield()` returns that value.
<pre class="snippet">
var fiber = Fiber.new {
System.print(Fiber.yield()) //> value
}
fiber.call() // Run until the first yield.
fiber.call("value") // Resume the fiber.
</pre>
If it was resumed by calling `call()` or `transfer()` with no argument, it
returns `null`.
If there is no parent fiber to return to, this exits the interpreter. This can
be useful to pause execution until the host application wants to resume it
later.
<pre class="snippet">
Fiber.yield()
System.print("this does not get reached")
</pre>
### Fiber.**yield**(value)
Similar to `Fiber.yield` but provides a value to return to the parent fiber's
`call`.
<pre class="snippet">
var fiber = Fiber.new {
Fiber.yield("value")
}
System.print(fiber.call()) //> value
</pre>
## Methods
### **call**()
Starts or resumes the fiber if it is in a paused state. Equivalent to:
<pre class="snippet">
fiber.call(null)
</pre>
### **call**(value)
Start or resumes the fiber if it is in a paused state. If the fiber is being
started for the first time, and its function takes a parameter, `value` is
passed to it.
<pre class="snippet">
var fiber = Fiber.new {|param|
System.print(param) //> begin
}
fiber.call("begin")
</pre>
If the fiber is being resumed, `value` becomes the returned value of the fiber's
call to `yield`.
<pre class="snippet">
var fiber = Fiber.new {
System.print(Fiber.yield()) //> resume
}
fiber.call()
fiber.call("resume")
</pre>
### **error**
The error message that was passed when aborting the fiber, or `null` if the
fiber has not been aborted.
<pre class="snippet">
var fiber = Fiber.new {
123.badMethod
}
fiber.try()
System.print(fiber.error) //> Num does not implement method 'badMethod'.
</pre>
### **isDone**
Whether the fiber's main function has completed and the fiber can no longer be
run. This returns `false` if the fiber is currently running or has yielded.
### **try**()
Tries to run the fiber. If a runtime error occurs
in the called fiber, the error is captured and is returned as a string.
<pre class="snippet">
var fiber = Fiber.new {
123.badMethod
}
var error = fiber.try()
System.print("Caught error: " + error)
</pre>
If the called fiber raises an error, it can no longer be used.
### **transfer**()
**TODO**
### **transfer**(value)
**TODO**
### **transferError**(error)
**TODO**

View File

@ -1,8 +1,11 @@
^title Fn Class
^category core
A first class function&mdash;an object that wraps an executable chunk of code.
[Here](../functions.html) is a friendly introduction.
[Here][functions] is a friendly introduction.
[functions]: ../../functions.html
## Static Methods
### Fn.**new**(function)
@ -11,10 +14,11 @@ function, so this really just returns the argument. It exists mainly to let you
create a "bare" function when you don't want to immediately pass it as a [block
argument](../functions.html#block-arguments) to some other method.
:::wren
var fn = Fn.new {
System.print("The body")
}
<pre class="snippet">
var fn = Fn.new {
System.print("The body")
}
</pre>
It is a runtime error if `function` is not a function.
@ -24,20 +28,22 @@ It is a runtime error if `function` is not a function.
The number of arguments the function requires.
:::wren
System.print(Fn.new {}.arity) // 0.
System.print(Fn.new {|a, b, c| a }.arity) // 3.
<pre class="snippet">
System.print(Fn.new {}.arity) //> 0
System.print(Fn.new {|a, b, c| a }.arity) //> 3
</pre>
### **call**(args...)
Invokes the function with the given arguments.
:::wren
var fn = Fn.new { |arg|
System.print(arg)
}
<pre class="snippet">
var fn = Fn.new { |arg|
System.print(arg) //> Hello world
}
fn.call("Hello world") // Prints "Hello world".
fn.call("Hello world")
</pre>
It is a runtime error if the number of arguments given is less than the arity
of the function. If more arguments are given than the function's arity they are

View File

@ -0,0 +1,4 @@
<script type="text/javascript">
window.location = '../'
</script>

View File

@ -1,9 +1,22 @@
^title List Class
^category core
Extends [Sequence](sequence.html).
An indexable contiguous collection of elements. More details [here](../lists.html).
An indexable contiguous collection of elements. More details [here][lists].
[lists]: ../../lists.html
## Static Methods
### List.**filled**(size, element)
Creates a new list with `size` elements, all set to `element`.
It is a runtime error if `size` is not a nonnegative integer.
### List.**new**()
Creates a new empty list. Equivalent to `[]`.
## Methods
@ -23,37 +36,43 @@ The number of elements in the list.
Inserts the `item` at `index` in the list.
:::wren
var list = ["a", "b", "c", "d"]
list.insert(1, "e")
System.print(list) // "[a, e, b, c, d]".
<pre class="snippet">
var list = ["a", "b", "c", "d"]
list.insert(1, "e")
System.print(list) //> [a, e, b, c, d]
</pre>
The `index` may be one past the last index in the list to append an element.
:::wren
var list = ["a", "b", "c"]
list.insert(3, "d")
System.print(list) // "[a, b, c, d]".
<pre class="snippet">
var list = ["a", "b", "c"]
list.insert(3, "d")
System.print(list) //> [a, b, c, d]
</pre>
If `index` is negative, it counts backwards from the end of the list. It bases this on the length of the list *after* inserted the element, so that `-1` will append the element, not insert it before the last element.
:::wren
var list = ["a", "b"]
list.insert(-1, "d")
list.insert(-2, "c")
System.print(list) // "[a, b, c, d]".
<pre class="snippet">
var list = ["a", "b"]
list.insert(-1, "d")
list.insert(-2, "c")
System.print(list) //> [a, b, c, d]
</pre>
Returns the inserted item.
:::wren
System.print(["a", "c"].insert(1, "b")) // "b".
<pre class="snippet">
System.print(["a", "c"].insert(1, "b")) //> b
</pre>
It is a runtime error if the index is not an integer or is out of bounds.
### **iterate**(iterator), **iteratorValue**(iterator)
Implements the [iterator protocol](../control-flow.html#the-iterator-protocol)
for iterating over the elements in the list.
Implements the [iterator protocol][] for iterating over the elements in the
list.
[iterator protocol]: ../../control-flow.html#the-iterator-protocol
### **removeAt**(index)
@ -61,14 +80,17 @@ Removes the element at `index`. If `index` is negative, it counts backwards
from the end of the list where `-1` is the last element. All trailing elements
are shifted up to fill in where the removed element was.
:::wren
var list = ["a", "b", "c", "d"]
list.removeAt(1)
System.print(list) // "[a, c, d]".
<pre class="snippet">
var list = ["a", "b", "c", "d"]
list.removeAt(1)
System.print(list) //> [a, c, d]
</pre>
Returns the removed item.
System.print(["a", "b", "c"].removeAt(1)) // "b".
<pre class="snippet">
System.print(["a", "b", "c"].removeAt(1)) //> b
</pre>
It is a runtime error if the index is not an integer or is out of bounds.
@ -77,9 +99,10 @@ It is a runtime error if the index is not an integer or is out of bounds.
Gets the element at `index`. If `index` is negative, it counts backwards from
the end of the list where `-1` is the last element.
:::wren
var list = ["a", "b", "c"]
System.print(list[1]) // "b".
<pre class="snippet">
var list = ["a", "b", "c"]
System.print(list[1]) //> b
</pre>
It is a runtime error if the index is not an integer or is out of bounds.
@ -88,9 +111,21 @@ It is a runtime error if the index is not an integer or is out of bounds.
Replaces the element at `index` with `item`. If `index` is negative, it counts
backwards from the end of the list where `-1` is the last element.
:::wren
var list = ["a", "b", "c"]
list[1] = "new"
System.print(list) // "[a, new, c]".
<pre class="snippet">
var list = ["a", "b", "c"]
list[1] = "new"
System.print(list) //> [a, new, c]
</pre>
It is a runtime error if the index is not an integer or is out of bounds.
## **+**(other) operator
Appends a list to the end of the list (concatenation). `other` must be a `List`.
<pre class="snippet">
var letters = ["a", "b", "c"]
var other = ["d", "e", "f"]
var combined = letters + other
System.print(combined) //> [a, b, c, d, e, f]
</pre>

View File

@ -1,7 +1,6 @@
^title Map Class
^category core
An associative collection that maps keys to values. More details [here](../maps.html).
An associative collection that maps keys to values. More details [here](../../maps.html).
## Methods
@ -23,14 +22,9 @@ A [Sequence](sequence.html) that can be used to iterate over the keys in the
map. Note that iteration order is undefined. All keys will be iterated over,
but may be in any order, and may even change between invocations of Wren.
### **iterate**(iterator), **iteratorValue**(iterator)
Implements the [iterator protocol](../control-flow.html#the-iterator-protocol)
for iterating over the elements in the list.
### **remove**(key)
Removes [key] and the value associated with it from the map. Returns the value.
Removes `key` and the value associated with it from the map. Returns the value.
If the key was not present, returns `null`.
@ -48,10 +42,11 @@ multiple times in the sequence.
Gets the value associated with `key` in the map. If `key` is not present in the
map, returns `null`.
:::wren
var map = {"george": "harrison", "ringo": "starr"}
System.print(map["ringo"]) // "starr".
System.print(map["pete"]) // "null".
<pre class="snippet">
var map = {"george": "harrison", "ringo": "starr"}
System.print(map["ringo"]) //> starr
System.print(map["pete"]) //> null
</pre>
### **[**key**]=**(value) operator

View File

@ -1,5 +1,4 @@
^title Null Class
^category core
## Methods
@ -7,5 +6,6 @@
Returns `true`, since `null` is considered [false](../control-flow.html#truth).
:::wren
System.print(!null) // "true".
<pre class="snippet">
System.print(!null) //> true
</pre>

View File

@ -1,5 +1,4 @@
^title Num Class
^category core
## Static Methods
@ -12,7 +11,15 @@ It is a runtime error if `value` is not a string.
### Num.**pi**
The value of π.
The value of &pi;.
### Num.**largest**
The largest representable numeric value.
### Num.**smallest**
The smallest positive representable numeric value.
## Methods
@ -20,8 +27,9 @@ The value of π.
The absolute value of the number.
:::wren
-123.abs // 123
<pre class="snippet">
System.print( (-123).abs ) //> 123
</pre>
### **acos**
@ -44,9 +52,10 @@ numbers to determine the quadrant of the result.
Rounds the number up to the nearest integer.
:::wren
1.5.ceil // 2
(-3.2).ceil // -3
<pre class="snippet">
System.print(1.5.ceil) //> 2
System.print((-3.2).ceil) //> -3
</pre>
### **cos**
@ -56,25 +65,28 @@ The cosine of the number.
Rounds the number down to the nearest integer.
:::wren
1.5.floor // 1
(-3.2).floor // -4
<pre class="snippet">
System.print(1.5.floor) //> 1
System.print((-3.2).floor) //> -4
</pre>
### **isInfinity**
Whether the number is positive or negative infinity or not.
:::wren
99999.isInfinity // false
(1/0).isInfinity // true
<pre class="snippet">
System.print(99999.isInfinity) //> false
System.print((1/0).isInfinity) //> true
</pre>
### **isInteger**
Whether the number is an integer or has some fractional component.
:::wren
2.isInteger // true
2.3.isInteger // false
<pre class="snippet">
System.print(2.isInteger) //> true
System.print(2.3.isInteger) //> false
</pre>
### **isNan**
@ -82,6 +94,28 @@ Whether the number is [not a number](http://en.wikipedia.org/wiki/NaN). This is
`false` for normal number values and infinities, and `true` for the result of
`0/0`, the square root of a negative number, etc.
### **log**
The natural logarithm of the number.
### **pow**(power)
Raises this number (the base) to `power`. Returns `nan` if the base is negative.
### **round**
Rounds the number to the nearest integer.
<pre class="snippet">
System.print(1.5.round) //> 2
System.print((-3.2).round) //> -3
System.print((-3.7).round) //> -4
</pre>
### **sign**
The sign of the number, expressed as a -1, 1 or 0, for negative and positive numbers, and zero.
### **sin**
The sine of the number.
@ -98,9 +132,10 @@ The tangent of the number.
Negates the number.
:::wren
var a = 123
-a // -123
<pre class="snippet">
var a = 123
System.print(-a) //> -123
</pre>
### **-**(other), **+**(other), **/**(other), **\***(other) operators
@ -110,7 +145,10 @@ not a number. Wren doesn't roll with implicit conversions.
### **%**(denominator) operator
The floating-point remainder of this number divided by `denominator`.
Also known as mod or modulus.
The floating-point remainder of this number divided by `denominator`.
The returned value has the same sign as `this` (internally calls `fmod` from C).
It is a runtime error if `denominator` is not a number.
@ -137,7 +175,7 @@ It is a runtime error if `other` is not a number.
Performs bitwise or on the number. Both numbers are first converted to 32-bit
unsigned values. The result is then a 32-bit unsigned number where each bit is
`true` only where the corresponding bits of both inputs were `true`.
`true` only where the corresponding bits of one or both inputs were `true`.
It is a runtime error if `other` is not a number.
@ -146,19 +184,21 @@ It is a runtime error if `other` is not a number.
Creates a [Range](range.html) representing a consecutive range of numbers
from the beginning number to the ending number.
:::wren
var range = 1.2..3.4
System.print(range.min) // 1.2
System.print(range.max) // 3.4
System.print(range.isInclusive) // true
<pre class="snippet">
var range = 1.2..3.4
System.print(range.min) //> 1.2
System.print(range.max) //> 3.4
System.print(range.isInclusive) //> true
</pre>
### **...**(other) operator
Creates a [Range](range.html) representing a consecutive range of numbers
from the beginning number to the ending number not including the ending number.
:::wren
var range = 1.2...3.4
System.print(range.min) // 1.2
System.print(range.max) // 3.4
System.print(range.isInclusive) // false
<pre class="snippet">
var range = 1.2...3.4
System.print(range.min) //> 1.2
System.print(range.max) //> 3.4
System.print(range.isInclusive) //> false
</pre>

View File

@ -1,9 +1,8 @@
^title Object Class
^category core
## Static Methods
## **same**(obj1, obj2)
### **same**(obj1, obj2)
Returns `true` if *obj1* and *obj2* are the same. For [value
types](../values.html), this returns `true` if the objects have equivalent
@ -20,7 +19,9 @@ even on user-defined classes.
### **!** operator
Returns `false`, since most objects are considered [true](control-flow.html#truth).
Returns `false`, since most objects are considered [true][].
[true]: control-flow.html#truth
### **==**(other) and **!=**(other) operators
@ -28,10 +29,26 @@ Compares two objects using built-in equality. This compares [value
types](../values.html) by value, and all other objects are compared by
identity&mdash;two objects are equal only if they are the exact same object.
### **is**(class) operator
Returns `true` if this object's class or one of its superclasses is `class`.
<pre class="snippet">
System.print(123 is Num) //> true
System.print("s" is Num) //> false
System.print(null is String) //> false
System.print([] is List) //> true
System.print([] is Sequence) //> true
</pre>
It is a runtime error if `class` is not a [Class][].
### **toString**
A default string representation of the object.
### **type**
The [Class](#class-class) of the object.
The [Class][] of the object.
[class]: class.html

View File

@ -1,8 +1,7 @@
^title Range Class
^category core
A range defines a bounded range of values from a starting point to a possibly
exclusive endpoint. [Here](../range.html) is a friendly introduction.
exclusive endpoint. [Here](../../values.html#ranges) is a friendly introduction.
Extends [Sequence](sequence.html).
@ -13,44 +12,49 @@ Extends [Sequence](sequence.html).
The starting point of the range. A range may be backwards, so this can be
greater than [to].
:::wren
(3..5).min // 3.
(4..2).min // 4.
<pre class="snippet">
System.print((3..5).from) //> 3
System.print((4..2).from) //> 4
</pre>
### **to**
The endpoint of the range. If the range is inclusive, this value is included,
otherwise it is not.
:::wren
(3..5).min // 5.
(4..2).min // 2.
<pre class="snippet">
System.print((3..5).to) //> 5
System.print((4..2).to) //> 2
</pre>
### **min**
The minimum bound of the range. Returns either `from`, or `to`, whichever is
lower.
:::wren
(3..5).min // 3.
(4..2).min // 2.
<pre class="snippet">
System.print((3..5).min) //> 3
System.print((4..2).min) //> 2
</pre>
### **max**
The maximum bound of the range. Returns either `from`, or `to`, whichever is
greater.
:::wren
(3..5).min // 5.
(4..2).min // 4.
<pre class="snippet">
System.print((3..5).max) //> 5
System.print((4..2).max) //> 4
</pre>
### **isInclusive**
Whether or not the range includes `to`. (`from` is always included.)
:::wren
(3..5).isInclusive // true.
(3...5).isInclusive // false.
<pre class="snippet">
System.print((3..5).isInclusive) //> true
System.print((3...5).isInclusive) //> false
</pre>
### **iterate**(iterator), **iteratorValue**(iterator)

View File

@ -1,10 +1,9 @@
^title Sequence Class
^category core
An abstract base class for any iterable object. Any class that implements the
core [iterator protocol][] can extend this to get a number of helpful methods.
[iterator protocol]: ../control-flow.html#the-iterator-protocol
[iterator protocol]: ../../control-flow.html#the-iterator-protocol
## Methods
@ -16,21 +15,25 @@ Iterates over the sequence, passing each element to the function `predicate`.
If it returns something [false](../control-flow.html#truth), stops iterating
and returns the value. Otherwise, returns `true`.
:::wren
[1, 2, 3].all {|n| n > 2} // False.
[1, 2, 3].all {|n| n < 4} // True.
<pre class="snippet">
System.print([1, 2, 3].all {|n| n > 2}) //> false
System.print([1, 2, 3].all {|n| n < 4}) //> true
</pre>
### **any**(predicate)
Tests whether any element in the sequence passes the `predicate`.
Iterates over the sequence, passing each element to the function `predicate`.
If it returns something [true](../control-flow.html#truth), stops iterating and
If it returns something [true][], stops iterating and
returns that value. Otherwise, returns `false`.
:::wren
[1, 2, 3].any {|n| n < 1} // False.
[1, 2, 3].any {|n| n > 2} // True.
[true]: ../../control-flow.html#truth
<pre class="snippet">
System.print([1, 2, 3].any {|n| n < 1}) //> false
System.print([1, 2, 3].any {|n| n > 2}) //> true
</pre>
### **contains**(element)
@ -50,16 +53,18 @@ Returns the number of elements in the sequence that pass the `predicate`.
Iterates over the sequence, passing each element to the function `predicate`
and counting the number of times the returned value evaluates to `true`.
:::wren
[1, 2, 3].count {|n| n > 2} // 1.
[1, 2, 3].count {|n| n < 4} // 3.
<pre class="snippet">
System.print([1, 2, 3].count {|n| n > 2}) //> 1
System.print([1, 2, 3].count {|n| n < 4}) //> 3
</pre>
### **each**(function)
Iterates over the sequence, passing each element to the given `function`.
:::wren
["one", "two", "three"].each {|word| System.print(word) }
<pre class="snippet">
["one", "two", "three"].each {|word| System.print(word) }
</pre>
### **isEmpty**
@ -85,11 +90,14 @@ together into a single string.
Creates a new sequence that applies the `transformation` to each element in the
original sequence while it is iterated.
:::wren
var doubles = [1, 2, 3].map {|n| n * 2 }
for (n in doubles) {
System.print(n) // "2", "4", "6".
}
<pre class="snippet">
var doubles = [1, 2, 3].map {|n| n * 2 }
for (n in doubles) {
System.print(n) //> 2
//> 4
//> 6
}
</pre>
The returned sequence is *lazy*. It only applies the mapping when you iterate
over the sequence, and it does so by holding a reference to the original
@ -101,11 +109,12 @@ changes to the original sequence will be reflected in the mapped sequence.
To force eager evaluation, just call `.toList` on the result.
:::wren
var numbers = [1, 2, 3]
var doubles = numbers.map {|n| n * 2 }.toList
numbers.add(4)
System.print(doubles) // [2, 4, 6].
<pre class="snippet">
var numbers = [1, 2, 3]
var doubles = numbers.map {|n| n * 2 }.toList
numbers.add(4)
System.print(doubles) //> [2, 4, 6]
</pre>
### **reduce**(function)
@ -122,12 +131,32 @@ It is a runtime error to call this on an empty sequence.
Similar to above, but uses `seed` for the initial value of the accumulator. If
the sequence is empty, returns `seed`.
### **skip**(count)
Creates a new sequence that skips the first `count` elements of the original
sequence.
The returned sequence is *lazy*. The first `count` elements are only skipped
once you start to iterate the returned sequence. Changes to the original
sequence will be reflected in the filtered sequence.
### **take**(count)
Creates a new sequence that iterates only the first `count` elements of the
original sequence.
The returned sequence is *lazy*. Changes to the original sequence will be
reflected in the filtered sequence.
### **toList**
Creates a [list](list.html) containing all the elements in the sequence.
Creates a [list][] containing all the elements in the sequence.
:::wren
(1..3).toList // [1, 2, 3].
[list]: list.html
<pre class="snippet">
System.print((1..3).toList) //> [1, 2, 3]
</pre>
If the sequence is already a list, this creates a copy of it.
@ -139,11 +168,14 @@ that pass the `predicate`.
During iteration, each element in the original sequence is passed to the
function `predicate`. If it returns `false`, the element is skipped.
:::wren
var odds = (1..10).where {|n| n % 2 == 1 }
for (n in odds) {
System.print(n) // "1", "3", "5", "7", "9".
}
<pre class="snippet">
var odds = (1..6).where {|n| n % 2 == 1 }
for (n in odds) {
System.print(n) //> 1
//> 3
//> 5
}
</pre>
The returned sequence is *lazy*. It only applies the filtering when you iterate
over the sequence, and it does so by holding a reference to the original
@ -156,8 +188,9 @@ sequence.
To force eager evaluation, just call `.toList` on the result.
:::wren
var numbers = [1, 2, 3, 4, 5, 6]
var odds = numbers.where {|n| n % 2 == 1 }.toList
numbers.add(7)
System.print(odds) // [1, 3, 5].
<pre class="snippet">
var numbers = [1, 2, 3, 4, 5, 6]
var odds = numbers.where {|n| n % 2 == 1 }.toList
numbers.add(7)
System.print(odds) //> [1, 3, 5]
</pre>

View File

@ -1,5 +1,4 @@
^title String Class
^category core
A string is an immutable array of bytes. Strings usually store text, in which
case the bytes are the UTF-8 encoding of the text's code points. But you can put
@ -27,17 +26,19 @@ counting them as you go.
Because counting code points is relatively slow, the indexes passed to string
methods are *byte* offsets, not *code point* offsets. When you do:
:::wren
someString[3]
<pre class="snippet">
someString[3]
</pre>
That means "get the code point starting at *byte* three", not "get the third
code point in the string". This sounds scary, but keep in mind that the methods
on strings *return* byte indexes too. So, for example, this does what you want:
:::wren
var metalBand = "Fäcëhämmër"
var hPosition = metalBand.indexOf("h")
System.print(metalBand[hPosition]) // "h"
<pre class="snippet">
var metalBand = "Fäcëhämmër"
var hPosition = metalBand.indexOf("h")
System.print(metalBand[hPosition]) //> h
</pre>
If you want to work with a string as a sequence numeric code points, call the
`codePoints` getter. It returns a [Sequence](sequence.html) that decodes UTF-8
@ -52,12 +53,23 @@ ignores any UTF-8 encoding and works directly at the byte level.
Creates a new string containing the UTF-8 encoding of `codePoint`.
:::wren
String.fromCodePoint(8225) // "‡"
<pre class="snippet">
String.fromCodePoint(8225) //> ‡
</pre>
It is a runtime error if `codePoint` is not an integer between `0` and
`0x10ffff`, inclusive.
### String.**fromByte**(byte)
Creates a new string containing the single byte `byte`.
<pre class="snippet">
String.fromByte(255) //> <20>
</pre>
It is a runtime error if `byte` is not an integer between `0` and `0xff`, inclusive.
## Methods
### **bytes**
@ -67,8 +79,9 @@ the string and ignore any UTF-8 encoding. In addition to the normal sequence
methods, the returned object also has a subscript operator that can be used to
directly index bytes.
:::wren
System.print("hello".bytes[1]) // 101, for "e".
<pre class="snippet">
System.print("hello".bytes[1]) //> 101 (for "e")
</pre>
The `count` method on the returned sequence returns the number of bytes in the
string. Unlike `count` on the string itself, it does not have to iterate over
@ -81,17 +94,19 @@ code points of the string *as numbers*. Iteration and subscripting work similar
to the string itself. The difference is that instead of returning
single-character strings, this returns the numeric code point values.
:::wren
var string = "(ᵔᴥᵔ)"
System.print(string.codePoints[0]) // 40, for "(".
System.print(string.codePoints[4]) // 7461, for "ᴥ".
<pre class="snippet">
var string = "(ᵔᴥᵔ)"
System.print(string.codePoints[0]) //> 40 (for "(")
System.print(string.codePoints[4]) //> 7461 (for "ᴥ")
</pre>
If the byte at `index` does not begin a valid UTF-8 sequence, or the end of the
string is reached before the sequence is complete, returns `-1`.
:::wren
var string = "(ᵔᴥᵔ)"
System.print(string.codePoints[2]) // -1, in the middle of "ᵔ".
<pre class="snippet">
var string = "(ᵔᴥᵔ)"
System.print(string.codePoints[2]) //> -1 (in the middle of "ᵔ")
</pre>
### **contains**(other)
@ -121,28 +136,110 @@ Returns the index of the first byte matching `search` in the string or `-1` if
It is a runtime error if `search` is not a string.
### **indexOf**(search, start)
Returns the index of the first byte matching `search` in the string or `-1` if
`search` was not found, starting a byte offset `start`. The start can be
negative to count backwards from the end of the string.
It is a runtime error if `search` is not a string or `start` is not an integer
index within the string's byte length.
### **iterate**(iterator), **iteratorValue**(iterator)
Implements the [iterator protocol](../control-flow.html#the-iterator-protocol)
for iterating over the *code points* in the string:
Implements the [iterator protocol][] for iterating over the *code points* in the
string:
:::wren
var codePoints = []
for (c in "(ᵔᴥᵔ)") {
codePoints.add(c)
}
[iterator protocol]: ../../control-flow.html#the-iterator-protocol
System.print(codePoints) // ["(", "ᵔ", "ᴥ", "ᵔ", ")"].
<pre class="snippet">
var codePoints = []
for (c in "(ᵔᴥᵔ)") {
codePoints.add(c)
}
System.print(codePoints) //> [(, ᵔ, ᴥ, ᵔ, )]
</pre>
If the string contains any bytes that are not valid UTF-8, this iterates over
those too, one byte at a time.
### **replace**(old, swap)
Returns a new string with all occurrences of `old` replaced with `swap`.
<pre class="snippet">
var string = "abc abc abc"
System.print(string.replace(" ", "")) //> abcabcabc
</pre>
### **split**(separator)
Returns a list of one or more strings separated by `separator`.
<pre class="snippet">
var string = "abc abc abc"
System.print(string.split(" ")) //> [abc, abc, abc]
</pre>
It is a runtime error if `separator` is not a string or is an empty string.
### **startsWith**(prefix)
Checks if the string starts with `prefix`.
It is a runtime error if `prefix` is not a string.
### **trim**()
Returns a new string with whitespace removed from the beginning and end of this
string. "Whitespace" is space, tab, carriage return, and line feed characters.
<pre class="snippet">
System.print(" \nstuff\r\t".trim()) //> stuff
</pre>
### **trim**(chars)
Returns a new string with all code points in `chars` removed from the beginning
and end of this string.
<pre class="snippet">
System.print("ᵔᴥᵔᴥᵔbearᵔᴥᴥᵔᵔ".trim("ᵔᴥ")) //> bear
</pre>
### **trimEnd**()
Like `trim()` but only removes from the end of the string.
<pre class="snippet">
System.print(" \nstuff\r\t".trimEnd()) //> " \nstuff"
</pre>
### **trimEnd**(chars)
Like `trim()` but only removes from the end of the string.
<pre class="snippet">
System.print("ᵔᴥᵔᴥᵔbearᵔᴥᴥᵔᵔ".trimEnd("ᵔᴥ")) //> ᵔᴥᵔᴥᵔbear
</pre>
### **trimStart**()
Like `trim()` but only removes from the beginning of the string.
<pre class="snippet">
System.print(" \nstuff\r\t".trimStart()) //> "stuff\r\t"
</pre>
### **trimStart**(chars)
Like `trim()` but only removes from the beginning of the string.
<pre class="snippet">
System.print("ᵔᴥᵔᴥᵔbearᵔᴥᴥᵔᵔ".trimStart("ᵔᴥ")) //> bearᵔᴥᴥᵔᵔ
</pre>
### **+**(other) operator
Returns a new string that concatenates this string and `other`.
@ -161,8 +258,9 @@ Check if the string is not equal to `other`.
Returns a string containing the code point starting at byte `index`.
:::wren
System.print("ʕ•ᴥ•ʔ"[5]) // "ᴥ".
<pre class="snippet">
System.print("ʕ•ᴥ•ʔ"[5]) //> ᴥ
</pre>
Since `ʕ` is two bytes in UTF-8 and `•` is three, the fifth byte points to the
bear's nose.
@ -170,8 +268,9 @@ bear's nose.
If `index` points into the middle of a UTF-8 sequence or at otherwise invalid
UTF-8, this returns a one-byte string containing the byte at that index:
:::wren
System.print("I ♥ NY"[3]) // One-byte string whose value is 153.
<pre class="snippet">
System.print("I ♥ NY"[3]) //> (one-byte string [153])
</pre>
It is a runtime error if `index` is greater than the number of bytes in the
string.

View File

@ -1,43 +1,50 @@
^title System Class
^category core
The System class is a grab-bag of functionality exposed by the VM, mostly for
use during development or debugging.
## Static Methods
### System.**clock**
Returns the number of seconds (including fractional seconds) since the program
was started. This is usually used for benchmarking.
### System.**gc**()
Requests that the VM perform an immediate garbage collection to free unused
memory.
### System.**print**()
Prints a single newline to the console.
### System.**print**(object)
Prints [object] to the console followed by a newline. If not already a string,
Prints `object` to the console followed by a newline. If not already a string,
the object is converted to a string by calling `toString` on it.
:::wren
System.print("I like bananas") // Prints "I like bananas".
<pre class="snippet">
System.print("I like bananas") //> I like bananas
</pre>
### System.**printAll**(sequence)
Iterates over [sequence] and prints each element, then prints a single newline
Iterates over `sequence` and prints each element, then prints a single newline
at the end. Each element is converted to a string by calling `toString` on it.
:::wren
System.printAll([1, [2, 3], 4]) // Prints "1[2, 3]4".
<pre class="snippet">
System.printAll([1, [2, 3], 4]) //> 1[2, 3]4
</pre>
### System.**write**(object)
Prints a single value to the console, but does not print a newline character
afterwards. Converts the value to a string by calling `toString` on it.
:::wren
System.write(4 + 5) // Prints "9".
<pre class="snippet">
System.write(4 + 5) //> 9
</pre>
In the above example, the result of `4 + 5` is printed, and then the prompt is
printed on the same line because no newline character was printed afterwards.
### System.**clock**
Returns the number of seconds (including fractional seconds) since the program
was started. This is usually used for benchmarking.

View File

@ -0,0 +1,101 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
<title>{title} &ndash; Wren</title>
<script type="application/javascript" src="../../prism.js" data-manual></script>
<script type="application/javascript" src="../../wren.js"></script>
<link rel="stylesheet" type="text/css" href="../../prism.css" />
<link rel="stylesheet" type="text/css" href="../../style.css" />
<link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:400,700,400italic,700italic|Source+Code+Pro:400|Lato:400|Sanchez:400italic,400' rel='stylesheet' type='text/css'>
<!-- Tell mobile browsers we're optimized for them and they don't need to crop
the viewport. -->
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"/>
</head>
<body id="top" class="module">
<header>
<div class="page">
<div class="main-column">
<h1><a href="../../">wren</a></h1>
<h2>a classy little scripting language</h2>
</div>
</div>
</header>
<div class="page">
<nav class="big">
<a href="../../"><img src="../../wren.svg" class="logo"></a>
<ul>
<li><a href="../">Back to Modules</a></li>
</ul>
<section>
<h2>core classes</h2>
<ul>
<li><a href="bool.html">Bool</a></li>
<li><a href="class.html">Class</a></li>
<li><a href="fiber.html">Fiber</a></li>
<li><a href="fn.html">Fn</a></li>
<li><a href="list.html">List</a></li>
<li><a href="map.html">Map</a></li>
<li><a href="null.html">Null</a></li>
<li><a href="num.html">Num</a></li>
<li><a href="object.html">Object</a></li>
<li><a href="range.html">Range</a></li>
<li><a href="sequence.html">Sequence</a></li>
<li><a href="string.html">String</a></li>
<li><a href="system.html">System</a></li>
</ul>
</section>
</nav>
<nav class="small">
<table>
<tr>
<td><a href="../">Modules</a></td>
<td><a href="./">core</a></td>
</tr>
<tr>
<td colspan="2"><h2>core classes</h2></td>
</tr>
<tr>
<td>
<ul>
<li><a href="bool.html">Bool</a></li>
<li><a href="class.html">Class</a></li>
<li><a href="fiber.html">Fiber</a></li>
<li><a href="fn.html">Fn</a></li>
<li><a href="list.html">List</a></li>
<li><a href="map.html">Map</a></li>
<li><a href="null.html">Null</a></li>
</ul>
</td>
<td>
<ul>
<li><a href="num.html">Num</a></li>
<li><a href="object.html">Object</a></li>
<li><a href="range.html">Range</a></li>
<li><a href="sequence.html">Sequence</a></li>
<li><a href="string.html">String</a></li>
<li><a href="system.html">System</a></li>
</ul>
</td>
</tr>
</table>
</nav>
<main>
<h1>{title}</h1>
{html}
</main>
</div>
<footer>
<div class="page">
<div class="main-column">
<p>Wren lives
<a href="https://github.com/wren-lang/wren">on GitHub</a>
&mdash; Made with &#x2764; by
<a href="http://journal.stuffwithstuff.com/">Bob Nystrom</a> and
<a href="https://github.com/wren-lang/wren/blob/master/AUTHORS">friends</a>.
</p>
<div class="main-column">
</div>
</footer>
</body>
</html>

View File

@ -0,0 +1,33 @@
^title Modules
Wren comes with two kinds of modules, the core module (built-in),
and a few optional modules that the host embedding Wren can enable.
## Core module
The core module is built directly into the VM and is implicitly
imported by every other module. You don't need to `import` anything to use it.
It contains objects and types for the language itself like [numbers][] and [strings][].
Because Wren is designed for [embedding in applications][embedding], its core
module is minimal and is focused on working with objects within Wren. For
stuff like file IO, graphics, etc., it is up to the host application to provide
interfaces for this.
[numbers]: core/num.html
[strings]: core/string.html
## Optional modules
Optional modules are available in the Wren project, but whether they are included is up to the host.
They are written in Wren and C, with no external dependencies, so including them in
your application is as easy as a simple compile flag.
Since they aren't *needed* by the VM itself to function, you can
disable some or all of them, so check if your host has them available.
So far there are a few optional modules:
* [meta docs](meta)
* [random docs](random)

View File

@ -0,0 +1,5 @@
^title Module "meta"
**TODO**
* [Meta](meta.html)

View File

@ -0,0 +1,7 @@
^title Meta Class
**TODO**
## Methods
**TODO**

View File

@ -0,0 +1,78 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
<title>{title} &ndash; Wren</title>
<script type="application/javascript" src="../../prism.js" data-manual></script>
<script type="application/javascript" src="../../wren.js"></script>
<link rel="stylesheet" type="text/css" href="../../prism.css" />
<link rel="stylesheet" type="text/css" href="../../style.css" />
<link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:400,700,400italic,700italic|Source+Code+Pro:400|Lato:400|Sanchez:400italic,400' rel='stylesheet' type='text/css'>
<!-- Tell mobile browsers we're optimized for them and they don't need to crop
the viewport. -->
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"/>
</head>
<body id="top" class="module">
<header>
<div class="page">
<div class="main-column">
<h1><a href="../../">wren</a></h1>
<h2>a classy little scripting language</h2>
</div>
</div>
</header>
<div class="page">
<nav class="big">
<a href="../../"><img src="../../wren.svg" class="logo"></a>
<ul>
<li><a href="../">Back to Modules</a></li>
<li><a href="./">meta module</a></li>
</ul>
<section>
<h2>meta classes</h2>
<ul>
<li><a href="meta.html">Meta</a></li>
</ul>
</section>
</nav>
<nav class="small">
<table>
<tr>
<td><a href="../">Modules</a></td>
<td><a href="./">meta</a></td>
</tr>
<tr>
<td colspan="2"><h2>meta classes</h2></td>
</tr>
<tr>
<td>
<ul>
<li><a href="meta.html">Meta</a></li>
</ul>
</td>
<td>
<ul>
</ul>
</td>
</tr>
</table>
</nav>
<main>
<h1>{title}</h1>
{html}
</main>
</div>
<footer>
<div class="page">
<div class="main-column">
<p>Wren lives
<a href="https://github.com/wren-lang/wren">on GitHub</a>
&mdash; Made with &#x2764; by
<a href="http://journal.stuffwithstuff.com/">Bob Nystrom</a> and
<a href="https://github.com/wren-lang/wren/blob/master/AUTHORS">friends</a>.
</p>
<div class="main-column">
</div>
</footer>
</body>
</html>

View File

@ -0,0 +1,10 @@
^title Module "random"
This module provides a simple, fast pseudo-random number generator.
It is an optional module. You can omit it from your application by setting the
preprocessor constant `WREN_OPT_RANDOM` to `0`.
It contains a single class:
* [Random](random.html)

View File

@ -0,0 +1,138 @@
^title Random Class
A simple, fast pseudo-random number generator. Internally, it uses the [well
equidistributed long-period linear PRNG][well] (WELL512a).
[well]: https://en.wikipedia.org/wiki/Well_equidistributed_long-period_linear
Each instance of the class generates a sequence of randomly distributed numbers
based on the internal state of the object. The state is initialized from a
*seed*. Two instances with the same seed generate the exact same sequence of
numbers.
It must be imported from the [random][] module:
<pre class="snippet">
import "random" for Random
[random]: ../
## Constructors
### Random.**new**()
Creates a new generator whose state is seeded based on the current time.
<pre class="snippet">
var random = Random.new()
</pre>
### Random.**new**(seed)
Creates a new generator initialized with [seed]. The seed can either be a
number, or a non-empty sequence of numbers. If the sequnce has more than 16
elements, only the first 16 are used. If it has fewer, the elements are cycled
to generate 16 seed values.
<pre class="snippet">
Random.new(12345)
Random.new("appleseed".codePoints)
</pre>
## Methods
### **float**()
Returns a floating point value between 0.0 and 1.0, including 0.0, but excluding
1.0.
<pre class="snippet">
var random = Random.new(12345)
System.print(random.float()) //> 0.53178795980617
System.print(random.float()) //> 0.20180515043262
System.print(random.float()) //> 0.43371948658705
</pre>
### **float**(end)
Returns a floating point value between 0.0 and `end`, including 0.0 but
excluding `end`.
<pre class="snippet">
var random = Random.new(12345)
System.print(random.float(0)) //> 0
System.print(random.float(100)) //> 20.180515043262
System.print(random.float(-100)) //> -43.371948658705
</pre>
### **float**(start, end)
Returns a floating point value between `start` and `end`, including `start` but
excluding `end`.
<pre class="snippet">
var random = Random.new(12345)
System.print(random.float(3, 4)) //> 3.5317879598062
System.print(random.float(-10, 10)) //> -5.9638969913476
System.print(random.float(-4, 2)) //> -1.3976830804777
</pre>
### **int**(end)
Returns an integer between 0 and `end`, including 0 but excluding `end`.
<pre class="snippet">
var random = Random.new(12345)
System.print(random.int(1)) //> 0
System.print(random.int(10)) //> 2
System.print(random.int(-50)) //> -22
</pre>
### **int**(start, end)
Returns an integer between `start` and `end`, including `start` but excluding
`end`.
<pre class="snippet">
var random = Random.new(12345)
System.print(random.int(3, 4)) //> 3
System.print(random.int(-10, 10)) //> -6
System.print(random.int(-4, 2)) //> -2
</pre>
### **sample**(list)
Selects a random element from `list`.
### **sample**(list, count)
Samples `count` randomly chosen unique elements from `list`.
This uses "random without replacement" sampling&mdash;no index in the list will
be selected more than once.
Returns a new list of the selected elements.
It is an error if `count` is greater than the number of elements in the list.
### **shuffle**(list)
Randomly shuffles the elements in `list`. The items are randomly re-ordered in
place.
<pre class="snippet">
var random = Random.new(12345)
var list = (1..5).toList
random.shuffle(list)
System.print(list) //> [3, 2, 4, 1, 5]
</pre>
Uses the Fisher-Yates algorithm to ensure that all permutations are chosen
with equal probability.
Keep in mind that a list with even a modestly large number of elements has an
astronomically large number of permutations. For example, there are about 10^74
ways a deck of 56 cards can be shuffled. The random number generator's internal
state is not that large, which means there are many permutations it will never
generate.

View File

@ -0,0 +1,78 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
<title>{title} &ndash; Wren</title>
<script type="application/javascript" src="../../prism.js" data-manual></script>
<script type="application/javascript" src="../../wren.js"></script>
<link rel="stylesheet" type="text/css" href="../../prism.css" />
<link rel="stylesheet" type="text/css" href="../../style.css" />
<link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:400,700,400italic,700italic|Source+Code+Pro:400|Lato:400|Sanchez:400italic,400' rel='stylesheet' type='text/css'>
<!-- Tell mobile browsers we're optimized for them and they don't need to crop
the viewport. -->
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"/>
</head>
<body id="top" class="module">
<header>
<div class="page">
<div class="main-column">
<h1><a href="../../">wren</a></h1>
<h2>a classy little scripting language</h2>
</div>
</div>
</header>
<div class="page">
<nav class="big">
<a href="../../"><img src="../../wren.svg" class="logo"></a>
<ul>
<li><a href="../">Back to Modules</a></li>
<li><a href="./">random module</a></li>
</ul>
<section>
<h2>random classes</h2>
<ul>
<li><a href="random.html">Random</a></li>
</ul>
</section>
</nav>
<nav class="small">
<table>
<tr>
<td><a href="../">Modules</a></td>
<td><a href="./">random</a></td>
</tr>
<tr>
<td colspan="2"><h2>random classes</h2></td>
</tr>
<tr>
<td>
<ul>
<li><a href="random.html">Random</a></li>
</ul>
</td>
<td>
<ul>
</ul>
</td>
</tr>
</table>
</nav>
<main>
<h1>{title}</h1>
{html}
</main>
</div>
<footer>
<div class="page">
<div class="main-column">
<p>Wren lives
<a href="https://github.com/wren-lang/wren">on GitHub</a>
&mdash; Made with &#x2764; by
<a href="http://journal.stuffwithstuff.com/">Bob Nystrom</a> and
<a href="https://github.com/wren-lang/wren/blob/master/AUTHORS">friends</a>.
</p>
<div class="main-column">
</div>
</footer>
</body>
</html>

View File

@ -0,0 +1,107 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
<title>{title} &ndash; Wren</title>
<script type="application/javascript" src="../prism.js" data-manual></script>
<script type="application/javascript" src="../wren.js"></script>
<link rel="stylesheet" type="text/css" href="../prism.css" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:400,700,400italic,700italic|Source+Code+Pro:400|Lato:400|Sanchez:400italic,400' rel='stylesheet' type='text/css'>
<!-- Tell mobile browsers we're optimized for them and they don't need to crop
the viewport. -->
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"/>
</head>
<body id="top" class="module">
<header>
<div class="page">
<div class="main-column">
<h1><a href="../">wren</a></h1>
<h2>a classy little scripting language</h2>
</div>
</div>
</header>
<div class="page">
<nav class="big">
<a href="../"><img src="../wren.svg" class="logo"></a>
<ul>
<li><a href="../">Back to Wren</a></li>
</ul>
<section>
<h2>core classes</h2>
<ul>
<li><a href="core/bool.html">Bool</a></li>
<li><a href="core/class.html">Class</a></li>
<li><a href="core/fiber.html">Fiber</a></li>
<li><a href="core/fn.html">Fn</a></li>
<li><a href="core/list.html">List</a></li>
<li><a href="core/map.html">Map</a></li>
<li><a href="core/null.html">Null</a></li>
<li><a href="core/num.html">Num</a></li>
<li><a href="core/object.html">Object</a></li>
<li><a href="core/range.html">Range</a></li>
<li><a href="core/sequence.html">Sequence</a></li>
<li><a href="core/string.html">String</a></li>
<li><a href="core/system.html">System</a></li>
</ul>
</section>
<section>
<h2>optional</h2>
<ul>
<li><a href="meta">meta</a></li>
<li><a href="random">random</a></li>
</ul>
</section>
</nav>
<nav class="small">
<table>
<tr>
<td><h2>core classes</h2></td>
<td><h2>optional</h2></td>
</tr>
<tr>
<td>
<ul>
<li><a href="core/bool.html">Bool</a></li>
<li><a href="core/class.html">Class</a></li>
<li><a href="core/fiber.html">Fiber</a></li>
<li><a href="core/fn.html">Fn</a></li>
<li><a href="core/list.html">List</a></li>
<li><a href="core/map.html">Map</a></li>
<li><a href="core/null.html">Null</a></li>
<li><a href="core/num.html">Num</a></li>
<li><a href="core/object.html">Object</a></li>
<li><a href="core/range.html">Range</a></li>
<li><a href="core/sequence.html">Sequence</a></li>
<li><a href="core/string.html">String</a></li>
<li><a href="core/system.html">System</a></li>
</ul>
</td>
<td>
<ul>
<li><a href="meta">meta</a></li>
<li><a href="random">random</a></li>
</ul>
</td>
</tr>
</table>
</nav>
<main>
<h1>{title}</h1>
{html}
</main>
</div>
<footer>
<div class="page">
<div class="main-column">
<p>Wren lives
<a href="https://github.com/wren-lang/wren">on GitHub</a>
&mdash; Made with &#x2764; by
<a href="http://journal.stuffwithstuff.com/">Bob Nystrom</a> and
<a href="https://github.com/wren-lang/wren/blob/master/AUTHORS">friends</a>.
</p>
<div class="main-column">
</div>
</footer>
</body>
</html>

View File

@ -1,5 +1,4 @@
^title Performance
^category reference
Even though most benchmarks aren't worth the pixels they're printed on, people
seem to like them, so here's a few:
@ -7,76 +6,76 @@ seem to like them, so here's a few:
<h3>Method Call</h3>
<table class="chart">
<tr>
<th>wren</th><td><div class="chart-bar wren" style="width: 11%;">0.15s&nbsp;</div></td>
<th>wren</th><td><div class="chart-bar wren" style="width: 14%;">0.12s&nbsp;</div></td>
</tr>
<tr>
<th>luajit (-joff)</th><td><div class="chart-bar" style="width: 17%;">0.23s&nbsp;</div></td>
<th>luajit (-joff)</th><td><div class="chart-bar" style="width: 18%;">0.16s&nbsp;</div></td>
</tr>
<tr>
<th>ruby</th><td><div class="chart-bar" style="width: 26%;">0.36s&nbsp;</div></td>
<th>ruby</th><td><div class="chart-bar" style="width: 23%;">0.20s&nbsp;</div></td>
</tr>
<tr>
<th>lua</th><td><div class="chart-bar" style="width: 43%;">0.58s&nbsp;</div></td>
<th>lua</th><td><div class="chart-bar" style="width: 41%;">0.35s&nbsp;</div></td>
</tr>
<tr>
<th>python3</th><td><div class="chart-bar" style="width: 88%;">1.18s&nbsp;</div></td>
<th>python3</th><td><div class="chart-bar" style="width: 91%;">0.78s&nbsp;</div></td>
</tr>
<tr>
<th>python</th><td><div class="chart-bar" style="width: 100%;">1.33s&nbsp;</div></td>
<th>python</th><td><div class="chart-bar" style="width: 100%;">0.85s&nbsp;</div></td>
</tr>
</table>
<h3>DeltaBlue</h3>
<table class="chart">
<tr>
<th>wren</th><td><div class="chart-bar wren" style="width: 27%;">0.13s&nbsp;</div></td>
<th>wren</th><td><div class="chart-bar wren" style="width: 22%;">0.13s&nbsp;</div></td>
</tr>
<tr>
<th>python3</th><td><div class="chart-bar" style="width: 94%;">0.44s&nbsp;</div></td>
<th>python3</th><td><div class="chart-bar" style="width: 83%;">0.48s&nbsp;</div></td>
</tr>
<tr>
<th>python</th><td><div class="chart-bar" style="width: 100%;">0.47s&nbsp;</div></td>
<th>python</th><td><div class="chart-bar" style="width: 100%;">0.57s&nbsp;</div></td>
</tr>
</table>
<h3>Binary Trees</h3>
<table class="chart">
<tr>
<th>luajit (-joff)</th><td><div class="chart-bar" style="width: 20%;">0.16s&nbsp;</div></td>
<th>luajit (-joff)</th><td><div class="chart-bar" style="width: 20%;">0.11s&nbsp;</div></td>
</tr>
<tr>
<th>wren</th><td><div class="chart-bar wren" style="width: 39%;">0.29s&nbsp;</div></td>
<th>wren</th><td><div class="chart-bar wren" style="width: 41%;">0.22s&nbsp;</div></td>
</tr>
<tr>
<th>ruby</th><td><div class="chart-bar" style="width: 49%;">0.37s&nbsp;</div></td>
<th>ruby</th><td><div class="chart-bar" style="width: 46%;">0.24s&nbsp;</div></td>
</tr>
<tr>
<th>python3</th><td><div class="chart-bar" style="width: 68%;">0.52s&nbsp;</div></td>
<th>python</th><td><div class="chart-bar" style="width: 71%;">0.37s&nbsp;</div></td>
</tr>
<tr>
<th>lua</th><td><div class="chart-bar" style="width: 97%;">0.73s&nbsp;</div></td>
<th>python3</th><td><div class="chart-bar" style="width: 73%;">0.38s&nbsp;</div></td>
</tr>
<tr>
<th>python</th><td><div class="chart-bar" style="width: 100%;">0.75s&nbsp;</div></td>
<th>lua</th><td><div class="chart-bar" style="width: 100%;">0.52s&nbsp;</div></td>
</tr>
</table>
<h3>Recursive Fibonacci</h3>
<table class="chart">
<tr>
<th>luajit (-joff)</th><td><div class="chart-bar" style="width: 17%;">0.15s&nbsp;</div></td>
<th>luajit (-joff)</th><td><div class="chart-bar" style="width: 17%;">0.10s&nbsp;</div></td>
</tr>
<tr>
<th>wren</th><td><div class="chart-bar wren" style="width: 38%;">0.31s&nbsp;</div></td>
<th>wren</th><td><div class="chart-bar wren" style="width: 35%;">0.20s&nbsp;</div></td>
</tr>
<tr>
<th>ruby</th><td><div class="chart-bar" style="width: 40%;">0.33s&nbsp;</div></td>
<th>ruby</th><td><div class="chart-bar" style="width: 39%;">0.22s&nbsp;</div></td>
</tr>
<tr>
<th>lua</th><td><div class="chart-bar" style="width: 43%;">0.35s&nbsp;</div></td>
<th>lua</th><td><div class="chart-bar" style="width: 49%;">0.28s&nbsp;</div></td>
</tr>
<tr>
<th>python3</th><td><div class="chart-bar" style="width: 96%;">0.78s&nbsp;</div></td>
<th>python</th><td><div class="chart-bar" style="width: 90%;">0.51s&nbsp;</div></td>
</tr>
<tr>
<th>python</th><td><div class="chart-bar" style="width: 100%;">0.81s&nbsp;</div></td>
<th>python3</th><td><div class="chart-bar" style="width: 100%;">0.57s&nbsp;</div></td>
</tr>
</table>
@ -93,7 +92,7 @@ languages benchmarked, including Wren, because Mike Pall is a robot from the
future.
The benchmark harness and programs are
[here](https://github.com/munificent/wren/tree/master/test/benchmark).
[here](https://github.com/wren-lang/wren/tree/master/test/benchmark).
## Why is Wren fast?
@ -185,6 +184,19 @@ means that we can copy down all inherited methods in the subclass when it's
created since we know those will never change. Method dispatch then just
requires locating the method in the class of the receiver.
### Method signatures
Wren supports overloading by arity using its concept of [signatures]. This makes
the language more expressive, but also faster. When a method is called, we look
it up on the receiver's class. If we succeed in finding it, we also know it has
the right number of parameters.
This lets Wren avoid the extra checking most languages need to do at runtime to
handle too few or too many arguments being passed to a method. In Wren, it's not
*syntactically* possible to call a method with the wrong number of arguments.
[signatures]: method-calls.html#signature
### Computed gotos
On compilers that support it, Wren's core bytecode interpreter loop uses

View File

@ -1,5 +1,4 @@
^title Q & A
^category reference
## Why did you create Wren?
@ -33,36 +32,42 @@ prototypes) that classes are more usable.
Here's an example of that kind of object-oriented programming in Lua:
:::lua
Account = {}
Account.__index = Account
<pre class="snippet">
-- account.lua
function Account.create(balance)
local acnt = {} -- our new object
setmetatable(acnt,Account) -- make Account handle lookup
acnt.balance = balance -- initialize our object
return acnt
end
Account = {}
Account.__index = Account
function Account:withdraw(amount)
self.balance = self.balance - amount
end
function Account.create(balance)
local acnt = {} -- our new object
setmetatable(acnt,Account) -- make Account handle lookup
acnt.balance = balance -- initialize our object
return acnt
end
-- create and use an Account
acc = Account.create(1000)
acc:withdraw(100)
function Account:withdraw(amount)
self.balance = self.balance - amount
end
-- create and use an Account
account = Account.create(1000)
account:withdraw(100)
</pre>
Here's the same example in Wren:
:::wren
class Account {
this new(balance) { _balance = balance }
withdraw(amount) { _balance = _balance - amount }
}
<pre class="snippet">
//account.wren
// create and use an Account
var acc = Account.new(1000)
acc.withdraw(100)
class Account {
construct new(balance) { _balance = balance }
withdraw(amount) { _balance = _balance - amount }
}
// create and use an Account
var account = Account.new(1000)
account.withdraw(100)
</pre>
Classes have a reputation for complexity because most of the widely used
languages with them are quite complex: C++, Java, C#, Ruby, and Python. I hope
@ -83,12 +88,14 @@ is that bytecode is a nice trade-off between performance and simplicity. Also:
* Many devices like iPhones and game consoles don't allow executing code
generated at runtime, which rules out just-in-time compilation.
* I think [fibers](fibers.html) are a really powerful tool, and implementing
them is straightforward in a bytecode VM that doesn't use the native stack.
* I think [fibers][] are a really powerful tool, and implementing them is
straightforward in a bytecode VM that doesn't use the native stack.
[fibers]: concurrency.html
## Why is the VM stack-based instead of register-based?
Bytecode VMs come in two flavors. Stack-based VMs have short (usually one-byte)
Bytecode VMs come in two flavors. Stack-based VMs have short (usually one byte)
instructions whose operands are implicitly understood to be at the top of the
stack. That means you often have a couple of instructions to push some stuff on
the stack and then an instruction to do something.
@ -97,8 +104,9 @@ Register-based VMs have big instructions (usually 32 bits) that contain both an
opcode and a couple of numbers indicating where in the stack the operands can
be found. This is cool because it means, that, for example, this Lua statement:
:::lua
a = b + c
<pre class="snippet">
a = b + c
</pre>
Can be a single bytecode instruction. In a stack-based language, it would be
four&mdash;push `b`, push `c`, add, store `a`. (Though note that in both cases

View File

@ -0,0 +1,51 @@
function withLineNumbers(highlight, options = {}) {
const opts = Object.assign({ class: "codejar-linenumbers", wrapClass: "codejar-wrap", width: "35px" }, options);
let lineNumbers;
return function (editor) {
highlight(editor);
if (!lineNumbers) {
lineNumbers = init(editor, opts);
}
const code = editor.textContent || "";
const linesCount = code.replace(/\n+$/, "\n").split("\n").length + 1;
let text = "";
for (let i = 1; i < linesCount; i++) {
text += `${i}\n`;
}
lineNumbers.innerText = text;
};
}
function init(editor, opts) {
const css = getComputedStyle(editor);
const wrap = document.createElement("div");
wrap.className = opts.wrapClass;
wrap.style.position = "relative";
const lineNumbers = document.createElement("div");
lineNumbers.className = opts.class;
wrap.appendChild(lineNumbers);
// Add own styles
lineNumbers.style.position = "absolute";
lineNumbers.style.top = "0px";
lineNumbers.style.left = "0px";
lineNumbers.style.bottom = "0px";
lineNumbers.style.width = opts.width;
lineNumbers.style.overflow = "hidden";
lineNumbers.style.backgroundColor = "rgba(255, 255, 255, 0.05)";
lineNumbers.style.color = "#fff";
lineNumbers.style.setProperty("mix-blend-mode", "difference");
// Copy editor styles
lineNumbers.style.fontFamily = css.fontFamily;
lineNumbers.style.fontSize = css.fontSize;
lineNumbers.style.lineHeight = css.lineHeight;
lineNumbers.style.paddingTop = css.paddingTop;
lineNumbers.style.paddingLeft = css.paddingLeft;
lineNumbers.style.borderTopLeftRadius = css.borderTopLeftRadius;
lineNumbers.style.borderBottomLeftRadius = css.borderBottomLeftRadius;
// Tweak editor styles
editor.style.paddingLeft = `calc(${opts.width} + ${lineNumbers.style.paddingLeft})`;
editor.style.whiteSpace = "pre";
// Swap editor with a wrap
editor.parentNode.insertBefore(wrap, editor);
wrap.appendChild(editor);
return lineNumbers;
}

401
doc/site/static/codejar.js Normal file
View File

@ -0,0 +1,401 @@
function CodeJar(editor, highlight, opt = {}) {
const options = Object.assign({ tab: "\t" }, opt);
let listeners = [];
let history = [];
let at = -1;
let focus = false;
let callback;
let prev; // code content prior keydown event
let isFirefox = navigator.userAgent.toLowerCase().indexOf("firefox") > -1;
editor.setAttribute("contentEditable", isFirefox ? "true" : "plaintext-only");
editor.setAttribute("spellcheck", "false");
editor.style.outline = "none";
editor.style.overflowWrap = "break-word";
editor.style.overflowY = "auto";
editor.style.resize = "vertical";
editor.style.whiteSpace = "pre-wrap";
highlight(editor);
const debounceHighlight = debounce(() => {
const pos = save();
highlight(editor);
restore(pos);
}, 30);
let recording = false;
const shouldRecord = (event) => {
return !isUndo(event) && !isRedo(event)
&& event.key !== "Meta"
&& event.key !== "Control"
&& event.key !== "Alt"
&& !event.key.startsWith("Arrow");
};
const debounceRecordHistory = debounce((event) => {
if (shouldRecord(event)) {
recordHistory();
recording = false;
}
}, 300);
const on = (type, fn) => {
listeners.push([type, fn]);
editor.addEventListener(type, fn);
};
on("keydown", event => {
if (event.defaultPrevented)
return;
prev = toString();
handleNewLine(event);
handleTabCharacters(event);
handleJumpToBeginningOfLine(event);
handleSelfClosingCharacters(event);
handleUndoRedo(event);
if (shouldRecord(event) && !recording) {
recordHistory();
recording = true;
}
});
on("keyup", event => {
if (event.defaultPrevented)
return;
if (event.isComposing)
return;
if (prev !== toString())
debounceHighlight();
debounceRecordHistory(event);
if (callback)
callback(toString());
});
on("focus", _event => {
focus = true;
});
on("blur", _event => {
focus = false;
});
on("paste", event => {
recordHistory();
handlePaste(event);
recordHistory();
if (callback)
callback(toString());
});
function save() {
const s = window.getSelection();
const pos = { start: 0, end: 0, dir: undefined };
visit(editor, el => {
if (el === s.anchorNode && el === s.focusNode) {
pos.start += s.anchorOffset;
pos.end += s.focusOffset;
pos.dir = s.anchorOffset <= s.focusOffset ? "->" : "<-";
return "stop";
}
if (el === s.anchorNode) {
pos.start += s.anchorOffset;
if (!pos.dir) {
pos.dir = "->";
}
else {
return "stop";
}
}
else if (el === s.focusNode) {
pos.end += s.focusOffset;
if (!pos.dir) {
pos.dir = "<-";
}
else {
return "stop";
}
}
if (el.nodeType === Node.TEXT_NODE) {
if (pos.dir != "->")
pos.start += el.nodeValue.length;
if (pos.dir != "<-")
pos.end += el.nodeValue.length;
}
});
return pos;
}
function restore(pos) {
const s = window.getSelection();
let startNode, startOffset = 0;
let endNode, endOffset = 0;
if (!pos.dir)
pos.dir = "->";
if (pos.start < 0)
pos.start = 0;
if (pos.end < 0)
pos.end = 0;
// Flip start and end if the direction reversed
if (pos.dir == "<-") {
const { start, end } = pos;
pos.start = end;
pos.end = start;
}
let current = 0;
visit(editor, el => {
if (el.nodeType !== Node.TEXT_NODE)
return;
const len = (el.nodeValue || "").length;
if (current + len >= pos.start) {
if (!startNode) {
startNode = el;
startOffset = pos.start - current;
}
if (current + len >= pos.end) {
endNode = el;
endOffset = pos.end - current;
return "stop";
}
}
current += len;
});
// If everything deleted place cursor at editor
if (!startNode)
startNode = editor;
if (!endNode)
endNode = editor;
// Flip back the selection
if (pos.dir == "<-") {
[startNode, startOffset, endNode, endOffset] = [endNode, endOffset, startNode, startOffset];
}
s.setBaseAndExtent(startNode, startOffset, endNode, endOffset);
}
function beforeCursor() {
const s = window.getSelection();
const r0 = s.getRangeAt(0);
const r = document.createRange();
r.selectNodeContents(editor);
r.setEnd(r0.startContainer, r0.startOffset);
return r.toString();
}
function afterCursor() {
const s = window.getSelection();
const r0 = s.getRangeAt(0);
const r = document.createRange();
r.selectNodeContents(editor);
r.setStart(r0.endContainer, r0.endOffset);
return r.toString();
}
function handleNewLine(event) {
if (event.key === "Enter") {
const before = beforeCursor();
const after = afterCursor();
let [padding] = findPadding(before);
let newLinePadding = padding;
// If last symbol is "{" ident new line
if (before[before.length - 1] === "{") {
newLinePadding += options.tab;
}
if (isFirefox) {
preventDefault(event);
insert("\n" + newLinePadding);
}
else {
// Normal browsers
if (newLinePadding.length > 0) {
preventDefault(event);
insert("\n" + newLinePadding);
}
}
// Place adjacent "}" on next line
if (newLinePadding !== padding && after[0] === "}") {
const pos = save();
insert("\n" + padding);
restore(pos);
}
}
}
function handleSelfClosingCharacters(event) {
const open = `([{'"`;
const close = `)]}'"`;
const codeAfter = afterCursor();
if (close.includes(event.key) && codeAfter.substr(0, 1) === event.key) {
const pos = save();
preventDefault(event);
pos.start = ++pos.end;
restore(pos);
}
else if (open.includes(event.key)) {
const pos = save();
preventDefault(event);
const text = event.key + close[open.indexOf(event.key)];
insert(text);
pos.start = ++pos.end;
restore(pos);
}
}
function handleTabCharacters(event) {
if (event.key === "Tab") {
preventDefault(event);
if (event.shiftKey) {
const before = beforeCursor();
let [padding, start,] = findPadding(before);
if (padding.length > 0) {
const pos = save();
// Remove full length tab or just remaining padding
const len = Math.min(options.tab.length, padding.length);
restore({ start, end: start + len });
document.execCommand("delete");
pos.start -= len;
pos.end -= len;
restore(pos);
}
}
else {
insert(options.tab);
}
}
}
function handleJumpToBeginningOfLine(event) {
if (event.key === "ArrowLeft" && event.metaKey) {
preventDefault(event);
const before = beforeCursor();
let [padding, start, end] = findPadding(before);
if (before.endsWith(padding)) {
if (event.shiftKey) {
const pos = save();
restore({ start, end: pos.end }); // Select from line start.
}
else {
restore({ start, end: start }); // Jump to line start.
}
}
else {
if (event.shiftKey) {
const pos = save();
restore({ start: end, end: pos.end }); // Select from beginning of text.
}
else {
restore({ start: end, end }); // Jump to beginning of text.
}
}
}
}
function handleUndoRedo(event) {
if (isUndo(event)) {
preventDefault(event);
at--;
const record = history[at];
if (record) {
editor.innerHTML = record.html;
restore(record.pos);
}
if (at < 0)
at = 0;
}
if (isRedo(event)) {
preventDefault(event);
at++;
const record = history[at];
if (record) {
editor.innerHTML = record.html;
restore(record.pos);
}
if (at >= history.length)
at--;
}
}
function recordHistory() {
if (!focus)
return;
const html = editor.innerHTML;
const pos = save();
const lastRecord = history[at];
if (lastRecord) {
if (lastRecord.html === html
&& lastRecord.pos.start === pos.start
&& lastRecord.pos.end === pos.end)
return;
}
at++;
history[at] = { html, pos };
history.splice(at + 1);
const maxHistory = 300;
if (at > maxHistory) {
at = maxHistory;
history.splice(0, 1);
}
}
function handlePaste(event) {
preventDefault(event);
const text = (event.originalEvent || event).clipboardData.getData("text/plain");
const pos = save();
insert(text);
highlight(editor);
restore({ start: pos.end + text.length, end: pos.end + text.length });
}
function visit(editor, visitor) {
const queue = [];
if (editor.firstChild)
queue.push(editor.firstChild);
let el = queue.pop();
while (el) {
if (visitor(el) === "stop")
break;
if (el.nextSibling)
queue.push(el.nextSibling);
if (el.firstChild)
queue.push(el.firstChild);
el = queue.pop();
}
}
function isCtrl(event) {
return event.metaKey || event.ctrlKey;
}
function isUndo(event) {
return isCtrl(event) && !event.shiftKey && event.code === "KeyZ";
}
function isRedo(event) {
return isCtrl(event) && event.shiftKey && event.code === "KeyZ";
}
function insert(text) {
text = text
.replace(/&/g, "&amp;")
.replace(/</g, "&lt;")
.replace(/>/g, "&gt;")
.replace(/"/g, "&quot;")
.replace(/'/g, "&#039;");
document.execCommand("insertHTML", false, text);
}
function debounce(cb, wait) {
let timeout = 0;
return (...args) => {
clearTimeout(timeout);
timeout = window.setTimeout(() => cb(...args), wait);
};
}
function findPadding(text) {
// Find beginning of previous line.
let i = text.length - 1;
while (i >= 0 && text[i] !== "\n")
i--;
i++;
// Find padding of the line.
let j = i;
while (j < text.length && /[ \t]/.test(text[j]))
j++;
return [text.substring(i, j) || "", i, j];
}
function toString() {
return editor.textContent || "";
}
function preventDefault(event) {
event.preventDefault();
}
return {
updateOptions(options) {
options = Object.assign(Object.assign({}, options), options);
},
updateCode(code) {
editor.textContent = code;
highlight(editor);
},
onUpdate(cb) {
callback = cb;
},
toString,
destroy() {
for (let [type, fn] of listeners) {
editor.removeEventListener(type, fn);
}
},
};
}

142
doc/site/static/prism.css Normal file
View File

@ -0,0 +1,142 @@
/* PrismJS 1.20.0
https://prismjs.com/download.html#themes=prism&languages=clike+c+lua */
/**
* prism.js default theme for JavaScript, CSS and HTML
* Based on dabblet (http://dabblet.com)
* @author Lea Verou
*/
code[class*="language-"],
pre[class*="language-"] {
color: black;
background: none;
text-shadow: 0 1px white;
font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
font-size: 1em;
text-align: left;
white-space: pre;
word-spacing: normal;
word-break: normal;
word-wrap: normal;
line-height: 1.5;
-moz-tab-size: 4;
-o-tab-size: 4;
tab-size: 4;
-webkit-hyphens: none;
-moz-hyphens: none;
-ms-hyphens: none;
hyphens: none;
}
pre[class*="language-"]::-moz-selection, pre[class*="language-"] ::-moz-selection,
code[class*="language-"]::-moz-selection, code[class*="language-"] ::-moz-selection {
text-shadow: none;
background: #b3d4fc;
}
pre[class*="language-"]::selection, pre[class*="language-"] ::selection,
code[class*="language-"]::selection, code[class*="language-"] ::selection {
text-shadow: none;
background: #b3d4fc;
}
@media print {
code[class*="language-"],
pre[class*="language-"] {
text-shadow: none;
}
}
/* Code blocks */
pre[class*="language-"] {
padding: 1em;
margin: .5em 0;
overflow: auto;
}
:not(pre) > code[class*="language-"],
pre[class*="language-"] {
background: #f5f2f0;
}
/* Inline code */
:not(pre) > code[class*="language-"] {
padding: .1em;
border-radius: .3em;
white-space: normal;
}
.token.comment,
.token.prolog,
.token.doctype,
.token.cdata {
color: slategray;
}
.token.punctuation {
color: #999;
}
.token.namespace {
opacity: .7;
}
.token.property,
.token.tag,
.token.boolean,
.token.number,
.token.constant,
.token.symbol,
.token.deleted {
color: #905;
}
.token.selector,
.token.attr-name,
.token.string,
.token.char,
.token.builtin,
.token.inserted {
color: #690;
}
.token.operator,
.token.entity,
.token.url,
.language-css .token.string,
.style .token.string {
color: #9a6e3a;
background: hsla(0, 0%, 100%, .5);
}
.token.atrule,
.token.attr-value,
.token.keyword {
color: #07a;
}
.token.function,
.token.class-name {
color: #DD4A68;
}
.token.regex,
.token.important,
.token.variable {
color: #e90;
}
.token.important,
.token.bold {
font-weight: bold;
}
.token.italic {
font-style: italic;
}
.token.entity {
cursor: help;
}

6
doc/site/static/prism.js Normal file

File diff suppressed because one or more lines are too long

574
doc/site/static/style.css Normal file
View File

@ -0,0 +1,574 @@
:root {
--header-h: 8em;
--header: "Sanchez", helvetica, arial, sans-serif;
--subheader: "Lato", helvetica, arial, sans-serif;
--code: "Source Code Pro", Menlo, Monaco, Consolas, monospace;
--body: "Source Sans Pro", georgia, serif;
--code-bg: hsl(210, 0%, 99%);
--dark: hsl(210, 10%, 25%);
--darker: hsl(210, 20%, 10%);
--light: hsl(0, 0%, 100%);
--code-color: hsl(210, 20%, 30%);
--text: #333333;
--gray-5: whitesmoke;
--gray-10: #ebebec;
--gray-20: #d7d8da;
--gray-30: #c3c5c7;
--gray-50: #9c9fa2;
--gray-60: #888c90;
--gray-80: #60666a;
--link: hsl(200, 60%, 50%);
--link-dark: hsl(210, 60%, 20%);
--link-hover: hsl(210, 100%, 80%);
--link: hsl(200, 60%, 50%);
--module-link-dark: hsl(160, 60%, 25%);
--module-link-hover: hsl(130, 70%, 70%);
--module-link: hsl(150, 70%, 40%);
}
* {
-moz-box-sizing: border-box;
box-sizing: border-box;
}
body, code, h1, h2, h3, p, pre, html {
margin: 0;
padding: 0;
}
html {
height: 100%;
min-height: 100%;
}
body {
background-color: var(--light);
color: var(--text);
font: 16px/25px var(--body);
height: 100%;
min-height: 100%;
}
hr {
display: block;
height: 1px;
border: 0;
border-top: 1px solid var(--gray-5);
margin: 1em 0;
padding: 0;
}
blockquote {
color: var(--gray-50);
margin: 0;
max-width: 24em;
margin-left: 0.5em;
}
date {
color: var(--gray-80);
}
.page {
margin: 0 auto;
width: 800px;
min-height: calc(100% - 16.75em);
}
/* Clear contents.*/
.page::after {
content: "";
display: table;
clear: both;
}
.main-column, main {
position: relative;
width: 560px;
}
.logo {
height: 7em;
position: relative;
margin: auto;
display: block;
left: -1em;
margin-bottom: 2em;
}
header {
background: var(--light);
border-bottom: solid 1px var(--gray-10);
}
header h1 {
position: absolute;
left: -8px;
top: calc((var(--header-h) / 3) - 1.15em);
padding: 0;
font-weight: 400;
font-size: 48px;
font-family: "Sanchez", helvetica, arial, sans-serif;
letter-spacing: 2px;
}
header h2 {
position: absolute;
left: 0;
top: calc(var(--header-h) + 0.5em);
padding: 0;
font: 500 13px var(--subheader);
text-transform: uppercase;
letter-spacing: 2px;
color: var(--gray-50);
}
header a {
color: var(--gray-80);
}
header a:hover {
color: var(--link-hover);
}
header .page {
height: var(--header-h);
}
nav {
float: right;
width: 160px;
margin-top: 2em;
}
nav h2 {
color: var(--gray-80);
font: 500 13px var(--subheader);
text-transform: uppercase;
letter-spacing: 2px;
margin: 0;
}
nav ul {
padding: 0;
margin: 6px 0 20px 0;
}
nav li {
font: 17px var(--body);
color: var(--gray-30);
list-style-type: none;
margin: 0 0 4px 0;
}
nav.small {
/*Only show the mobile navigation on small screens.*/
display: none;
float: none;
width: 100%;
padding: 16px 0 0 0;
margin: 0;
background: var(--gray-10);
}
nav.small div:not(table) { padding-left: 1em; }
nav.small table {
width: 100%;
border-collapse: separate;
border-spacing: 16px 0;
}
nav.small h2 {
margin: 16px 0 0 0;
padding: 0 0 1px 0;
border-bottom: solid 1px var(--gray-20);
}
h1 {
padding-top: 30px;
font: 500 36px/60px var(--header);
color: var(--link);
}
h2 {
font-weight: 500;
font-size: 24px;
font-family: var(--header);
margin: 24px 0 0 0;
color: var(--link);
}
h2 code {
border: none;
background: inherit;
color: inherit;
font-size: 24px;
}
h3 {
font: 20px var(--body);
margin: 24px 0 0 0;
color: var(--link);
}
h3 code {
border: none;
background: inherit;
color: inherit;
font-size: 20px;
}
a {
color: var(--link);
text-decoration: none;
transition: color 0.2s, text-shadow 0.2s;
outline: none;
cursor: pointer;
}
main {
margin-top: 2em;
float: left;
}
main .intro {
border-bottom: solid 1px var(--gray-10);
margin-bottom: -0.5em;
}
main h2 {
display: block;
position: relative;
max-width: 16em;
}
a:hover {
color: var(--link-dark);
}
.header-anchor {
color: var(--light);
}
h2:hover > .header-anchor,
h3:hover > .header-anchor {
color: var(--gray-10);
}
h2:hover > .header-anchor:hover,
h3:hover > .header-anchor:hover {
color: var(--link-dark);
}
p {
margin: 10px 0;
}
p + p {
margin-top: 20px;
}
code, pre {
background-color: var(--code-bg) !important;
color: var(--code-color) !important;
font-family: var(--code) !important;
font-size: 13px !important;
}
code {
white-space: pre;
}
pre {
border-radius: 2px;
border: solid 1px hsl(200, 20%, 88%);
overflow: auto;
white-space: pre-wrap;
padding: 1em;
}
footer {
margin-top: 4em;
padding: 20px 0 40px 0;
font: 14px var(--body);
background: var(--dark);
color: var(--gray-20);
border-top: solid 1px var(--darker);
text-align: center;
text-shadow: 0 1px 1px var(--darker);
}
footer a {
color: var(--link-hover);
}
footer a:hover {
color: var(--link);
}
.right {
float: right;
}
/* Have a different primary color for the module docs.*/
body.module header a {
color: var(--gray-80);
}
body.module header a:hover {
color: var(--module-link-hover);
}
body.module a {
color: var(--module-link);
}
body.module a:hover {
color: var(--module-link-dark);
}
body.module .header-anchor {
color: var(--light);
}
body.module footer a {
color: var(--module-link-hover);
}
body.module footer a:hover {
color: var(--module-link);
}
body.module main h1 { color: var(--module-link); }
body.module main h2 { color: var(--module-link); }
body.module main h3 { color: var(--module-link); }
body.module main h2:hover > .header-anchor:hover,
body.module main h3:hover > .header-anchor:hover {
color: var(--module-link-dark);
}
/* Try related stuff */
.buttons {
z-index: 2;
right: 0;
display: block;
position: absolute;
font-size: 1.3em;
letter-spacing: 0.05em;
margin-top: -1.25em;
}
.button {
margin-right: 0.25em;
display: inline-block;
text-align: right;
}
#examples {
margin-bottom: 1em;
}
#try-area {
margin-bottom: 1em;
}
#try-area p {
margin-left: 0.2em;
color: var(--gray-50);
font-size: 0.9em;
margin-bottom: -0.1em;
}
#try-output {
scrollbar-width: thin;
white-space: pre;
overflow-x: auto;
font-family: var(--code);
font-size: 1em;
line-height: 1.25em;
}
#try-result {
display: block;
margin-top: 1.4em;
position: absolute;
right: 0;
}
#try-result.error {
color: #c00;
font-weight: bold;
}
span.token.error {
color: #c00;
}
.codejar-linenumbers {
background-color: #f9f9f9 !important;
border-left: solid 1px hsl(200, 20%, 88%);
border-top: solid 1px hsl(200, 20%, 88%);
border-bottom: solid 1px hsl(200, 20%, 88%);
color: #d9d9d9 !important;
mix-blend-mode: normal !important;
width: 2.5em !important;
text-align: right !important;
padding-left: 0 !important;
padding-right: 0.5em !important;
}
#try-code {
scrollbar-width: thin;
border-radius: 0.01em;
border: solid 1px hsl(200, 20%, 88%);
font-family: 'Source Code Pro', monospace;
font-size: 14px;
font-weight: 400;
height: auto;
letter-spacing: normal;
line-height: 1.5em;
padding: 1em;
tab-size: 2;
}
table {
width: 100%;
border-collapse: collapse;
}
tr {
margin: 0;
padding: 0;
vertical-align: top;
}
th, td {
font-size: 14px;
line-height: 20px;
text-align: left;
}
/* Bar charts on the performance page.*/
table.chart {
margin: 4px 0 0 0;
padding: 5px 0 5px 25px;
}
table.chart td, th {
line-height: 14px;
margin: 0;
padding: 1px 0;
}
table.chart th {
font-size: 14px;
width: 100px;
}
table.chart .chart-bar {
display: inline-block;
font: 13px var(--body);
color: var(--light);
background: var(--link);
border-bottom: solid 1px var(--link-dark);
text-align: right;
border-radius: 2px;
}
table.chart .chart-bar.wren {
background: #1d5176;
border-bottom: solid 1px var(--link-dark);
}
/* Precedence table on expressions page.*/
table.precedence th {
font: 500 11px var(--subheader);
text-transform: uppercase;
letter-spacing: 1px;
color: var(--gray-60);
padding: 6px 0;
border-bottom: solid 1px var(--gray-10);
}
table.precedence td {
padding: 3px 0;
border-bottom: solid 1px var(--gray-10);
}
@media only screen and (max-width: 839px) {
/* 36 pixel columns.*/
.page { width: 720px; }
nav { width: 144px; }
.main-column, main { width: 504px; }
}
@media only screen and (max-width: 759px) {
/* 32 pixel columns.*/
.page { width: 640px; }
nav { width: 128px; }
.main-column, main { width: 448px; }
}
@media only screen and (max-width: 679px) {
/* 28 pixel columns.*/
.page { width: 560px; }
nav { width: 112px; }
.main-column, main { width: 392px; }
header h2 {
font-size: 12px;
letter-spacing: 1px;
}
}
@media only screen and (max-width: 639px) {
.page { width: 100%; }
.buttons { margin-right: 1em; }
#try-result { margin-right: 1.5em; }
/* Switch to the mobile navigation.*/
nav.big { display: none; }
nav.small { display: block; }
nav.small div:not(table) { padding-left: 1em; }
.main-column, main {
padding: 0 20px;
width: 100%;
}
header h1 {
position: relative;
top: 10px;
left: 0;
text-align: center;
}
header h2 {
position: relative;
top: 0;
right: 0;
text-align: center;
font-size: 13px;
letter-spacing: 2px;
}
main {
float: none;
width: 100%;
}
pre {
font-size: 13px;
}
footer {
padding: 20px 20px 40px 20px;
}
}

79
doc/site/static/wren.js Normal file
View File

@ -0,0 +1,79 @@
window.onload = function() {
var blocks = document.querySelectorAll('pre.snippet')
blocks.forEach((element) => {
var lang = 'lua'
var input_lang = element.getAttribute('data-lang')
if(input_lang) lang = input_lang
var code = document.createElement('code');
code.setAttribute('class', ' language-'+lang);
code.innerHTML = element.innerHTML;
element.innerHTML = '';
element.append(code)
});
Prism.highlightAll();
var try_code = document.querySelector("#try-code")
if(try_code) {
var jar_options = { tab: ' '.repeat(2) }
var jar = CodeJar(try_code, withLineNumbers(Prism.highlightElement), jar_options)
var output = document.querySelector("#try-output")
var result = document.querySelector("#try-result")
Module.print = function(text) { output.innerText += text + "\n"; }
Module.printErr = function(text) { output.innerText += text + "\n"; }
var run = document.querySelector("#try-run")
var hello = document.querySelector("#try-hello")
var fractal = document.querySelector("#try-fractal")
var loop = document.querySelector("#try-loop")
var compile = Module.cwrap('wren_compile', 'number', ['string'])
var set_input = (content) => {
output.innerText = '...';
result.removeAttribute('class');
result.innerText = 'no errors';
jar.updateCode(content);
}
run.onclick = (e) => {
console.log("run")
output.setAttribute('ready', '');
output.innerText = '';
var res = compile(jar.toString())
var message = "no errors!"
result.removeAttribute('class');
if(res == 1) { //WREN_RESULT_COMPILE_ERROR
message = "Compile error!"
result.setAttribute('class', 'error');
} else if(res == 2) { //WREN_RESULT_RUNTIME_ERROR
message = "Runtime error!"
result.setAttribute('class', 'error');
}
result.innerText = message;
console.log(result);
}
hello.onclick = (e) => { set_input('System.print("hello wren")') }
loop.onclick = (e) => { set_input(`for (i in 1..10) System.print("Counting up %(i)")`); }
fractal.onclick = (e) => {
set_input(`for (yPixel in 0...24) {
var y = yPixel / 12 - 1
for (xPixel in 0...80) {
var x = xPixel / 30 - 2
var x0 = x
var y0 = y
var iter = 0
while (iter < 11 && x0 * x0 + y0 * y0 <= 4) {
var x1 = (x0 * x0) - (y0 * y0) + x
var y1 = 2 * x0 * y0 + y
x0 = x1
y0 = y1
iter = iter + 1
}
System.write(" .-:;+=xX$& "[iter])
}
System.print("")
}`);
} //fractal
} //if try_code
}

Some files were not shown because too many files have changed in this diff Show More