prism 2.0.0.rc1-arm64-darwin

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at opensource@shopify.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing
+
+Thank you for your interest in contributing to prism! Below are a couple of ways that you can help out.
+
+## Discussions
+
+The discussions page on the GitHub repository are open. If you have a question or want to discuss the project, feel free to open a new discussion or comment on an existing one. This is the best place to ask questions about the project.
+
+## Code
+
+If you want to contribute code, please first open or contribute to a discussion. A lot of the project is in flux, and we want to make sure that you are contributing to the right place. Once you have a discussion going, you can open a pull request with your changes. We will review your code and get it merged in.
+
+## Tests
+
+We could always use more tests! One of the biggest challenges of this project is building up a big test suite. If you want to contribute tests, feel free to open a pull request. These will get merged in as soon as possible.
+
+The `test` Rake task will not compile libraries or the C extension, and this is intentional (to make testing against an installed version easier). If you want to test your changes, please make sure you're also running either the task:
+
+``` sh
+bundle exec rake
+```
+
+or explicitly running the `compile` task:
+
+``` sh
+bundle exec rake compile test
+# or to just compile the C extension ...
+bundle exec rake compile:prism test
+```
+
+To test the rust bindings (with caveats about setting up your Rust environment properly first):
+
+``` sh
+bundle exec rake compile test:rust
+```
+
+
+## Documentation
+
+We could always use more documentation! If you want to contribute documentation, feel free to open a pull request. These will get merged in as soon as possible. Documenting functions or methods is always useful, but we also need more guides and tutorials. If you have an idea for a guide or tutorial, feel free to open an issue and we can discuss it.
+
+## Developing
+
+To get `clangd` support in the editor for development, generate the compilation database. This command will
+create an ignored `compile_commands.json` file at the project root, which is used by clangd to provide functionality.
+
+You will need `bear` which can be installed on macOS with `brew install bear`.
+
+```sh
+bundle exec rake bear
+```
+
+## Debugging
+
+Some useful rake tasks:
+
+- `test:valgrind` runs the test suite under valgrind to look for illegal memory access or memory leaks
+- `test:gdb` and `test:lldb` run the test suite under those debuggers

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2022-present, Shopify Inc.
+
+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.
+
+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.

data/Makefile

@@ -0,0 +1,145 @@
+
+# V=0 quiet, V=1 verbose.  other values don't work.
+V = 0
+V0 = $(V:0=)
+Q1 = $(V:1=)
+Q = $(Q1:0=@)
+ECHO1 = $(V:1=@ :)
+ECHO = $(ECHO1:0=@ echo)
+FUZZ_OUTPUT_DIR = $(CURDIR)/fuzz/output
+
+SOEXT ?= $(shell ruby -e 'puts RbConfig::CONFIG["SOEXT"]')
+
+CPPFLAGS := -Iinclude $(CPPFLAGS)
+CFLAGS := -g -O2 -std=c99 -Wall -Werror -Wextra -Wpedantic -Wundef -Wconversion -Wno-missing-braces -fPIC -fvisibility=hidden -Wimplicit-fallthrough $(CFLAGS)
+JAVA_WASM_CFLAGS := -g0 -O2 -Oz -std=c99 -Wall -Werror -Wextra -Wpedantic -Wundef -Wconversion -Wno-missing-braces -fno-sanitize=all -fno-stack-protector -fPIC -fvisibility=hidden -Wimplicit-fallthrough $(JAVA_WASM_CFLAGS)
+CC ?= cc
+AR ?= ar
+ARFLAGS ?= -r$(V0:1=v)
+WASI_SDK_PATH := /opt/wasi-sdk
+
+# Exporting a symbol makes it a GC root, so the JavaScript module exports only
+# the symbols javascript/src/parsePrism.js calls. That lets --gc-sections drop
+# the rest of the C API along with the wasi-libc code reachable from it.
+WASM_EXPORTS := -Wl,--export=malloc,--export=free,--export=pm_buffer_new,--export=pm_buffer_value,--export=pm_buffer_length,--export=pm_buffer_free,--export=pm_serialize_parse
+
+# Bind the library's own references to its own definitions at link time, so
+# that the functions exported for FFI cannot be interposed by another copy of
+# libprism loaded in the same process (for example the copy built into the
+# interpreter next to the one built by a prism gem, when either copy was loaded
+# with RTLD_GLOBAL). Mach-O and PE do this by default; only ELF needs the flag.
+ifeq ($(SOEXT),so)
+SHARED_LDFLAGS := -Wl,-Bsymbolic
+endif
+
+MAKEDIRS ?= mkdir -p
+RMALL ?= rm -f -r
+
+HEADERS := $(wildcard include/*.h include/*/*.h include/*/*/*.h)
+SOURCES := $(wildcard src/*.c src/*/*.c)
+SHARED_OBJECTS := $(subst src/,build/shared/,$(SOURCES:.c=.o))
+STATIC_OBJECTS := $(subst src/,build/static/,$(SOURCES:.c=.o))
+
+all: shared static
+
+shared: build/libprism.$(SOEXT)
+static: build/libprism.a
+wasm: javascript/src/prism.wasm
+java-wasm: java/wasm/src/main/wasm/prism.wasm
+playground: doc/playground
+
+build/libprism.$(SOEXT): $(SHARED_OBJECTS)
+	$(ECHO) "linking $@ with $(CC)"
+	$(Q) $(CC) $(DEBUG_FLAGS) $(CFLAGS) -shared $(SHARED_LDFLAGS) -o $@ $(SHARED_OBJECTS)
+
+build/libprism.a: $(STATIC_OBJECTS)
+	$(ECHO) "building $@ with $(AR)"
+	$(Q) $(AR) $(ARFLAGS) $@ $(STATIC_OBJECTS)
+
+javascript/src/prism.wasm: Makefile $(SOURCES) $(HEADERS)
+	$(ECHO) "building $@"
+	$(Q) $(WASI_SDK_PATH)/bin/clang --sysroot=$(WASI_SDK_PATH)/share/wasi-sysroot/ \
+		$(DEBUG_FLAGS) \
+		-DPRISM_EXPORT_SYMBOLS -DPRISM_EXCLUDE_PRETTYPRINT -DPRISM_EXCLUDE_JSON \
+		-D_WASI_EMULATED_MMAN -lwasi-emulated-mman $(CPPFLAGS) $(CFLAGS) \
+		$(WASM_EXPORTS) -Wl,--gc-sections -Wl,--strip-all -Wl,--lto-O3 -Wl,--no-entry -mexec-model=reactor \
+		-Oz -g0 -flto -fdata-sections -ffunction-sections \
+		-o $@ $(SOURCES)
+
+# The playground parses with the JavaScript package built from this checkout, so
+# the page is served the parser the rest of the site was generated from. The
+# JavaScript half of the package is generated by `rake templates`.
+doc/playground: javascript/src/prism.wasm
+	$(ECHO) "building $@"
+	$(Q) $(MAKEDIRS) $@
+	$(Q) cp javascript/src/*.js javascript/src/prism.wasm javascript/package.json $@
+
+java/wasm/src/main/wasm/prism.wasm: Makefile $(SOURCES) $(HEADERS)
+	$(ECHO) "building $@"
+	$(Q) $(MAKEDIRS) $(@D)
+	$(Q) $(WASI_SDK_PATH)/bin/clang \
+		$(DEBUG_FLAGS) \
+		-DPRISM_EXCLUDE_PRETTYPRINT -DPRISM_EXPORT_SYMBOLS -D_WASI_EMULATED_MMAN \
+		-lwasi-emulated-mman $(CPPFLAGS) $(JAVA_WASM_CFLAGS) \
+		-Wl,--export-all -Wl,--no-entry -mexec-model=reactor -lc++ -lc++abi \
+		-o $@ $(SOURCES)
+
+build/shared/%.o: src/%.c Makefile $(HEADERS)
+	$(ECHO) "compiling $@"
+	$(Q) $(MAKEDIRS) $(@D)
+	$(Q) $(CC) $(DEBUG_FLAGS) -DPRISM_EXPORT_SYMBOLS $(CPPFLAGS) $(CFLAGS) -c -o $@ $<
+
+build/static/%.o: src/%.c Makefile $(HEADERS)
+	$(ECHO) "compiling $@"
+	$(Q) $(MAKEDIRS) $(@D)
+	$(Q) $(CC) $(DEBUG_FLAGS) $(CPPFLAGS) $(CFLAGS) -c -o $@ $<
+
+build/fuzz.%: $(SOURCES) fuzz/%.c fuzz/fuzz.c
+	$(ECHO) "building $* fuzzer"
+	$(Q) $(MAKEDIRS) $(@D)
+	$(ECHO) "building main fuzz binary"
+	$(Q) afl-clang-lto $(DEBUG_FLAGS) $(CPPFLAGS) $(CFLAGS) $(FUZZ_FLAGS) -O0 -fsanitize=fuzzer,address -ggdb3 -std=c99 -Iinclude -o $@ $^
+	$(ECHO) "building cmplog binary"
+	$(Q) AFL_LLVM_CMPLOG=1 afl-clang-lto $(DEBUG_FLAGS) $(CPPFLAGS) $(CFLAGS) $(FUZZ_FLAGS) -O0 -fsanitize=fuzzer,address -ggdb3 -std=c99 -Iinclude -o $@.cmplog $^
+
+build/fuzz.heisenbug.%: $(SOURCES) fuzz/%.c fuzz/heisenbug.c
+	$(Q) afl-clang-lto $(DEBUG_FLAGS) $(CPPFLAGS) $(CFLAGS) $(FUZZ_FLAGS) -O0 -fsanitize=fuzzer,address -ggdb3 -std=c99 -Iinclude -o $@ $^
+
+fuzz-debug:
+	$(ECHO) "entering debug shell"
+	$(Q) docker run -it --rm -e HISTFILE=/prism/fuzz/output/.bash_history -v $(CURDIR):/prism -v $(FUZZ_OUTPUT_DIR):/fuzz_output prism/fuzz
+
+fuzz-docker-build: fuzz/docker/Dockerfile
+	$(ECHO) "building docker image"
+	$(Q) docker build -t prism/fuzz fuzz/docker/
+
+fuzz-run-%: FORCE fuzz-docker-build
+	$(ECHO) "generating templates"
+	$(Q) bundle exec rake templates
+	$(ECHO) "running $* fuzzer"
+	$(Q) docker run --rm -v $(CURDIR):/prism prism/fuzz /bin/bash -c "FUZZ_FLAGS=\"$(FUZZ_FLAGS)\" make build/fuzz.$*"
+	$(ECHO) "starting AFL++ run"
+	$(Q) $(MAKEDIRS) $(FUZZ_OUTPUT_DIR)/$*
+	$(Q) docker run -it --rm -v $(CURDIR):/prism -v $(FUZZ_OUTPUT_DIR):/fuzz_output prism/fuzz /bin/bash -c "./fuzz/$*.sh /fuzz_output/$*"
+FORCE:
+
+fuzz-clean:
+	$(Q) $(RMALL) fuzz/output
+
+clean:
+	$(Q) $(RMALL) build
+
+.PHONY: clean doc/playground fuzz-clean
+
+all-no-debug: DEBUG_FLAGS := -DNDEBUG=1
+all-no-debug: OPTFLAGS := -O3
+all-no-debug: all
+
+minimal: CFLAGS := $(CFLAGS) -DPRISM_BUILD_MINIMAL
+minimal: all
+
+run: Makefile $(STATIC_OBJECTS) $(HEADERS) test.c
+	$(ECHO) "compiling test.c"
+	$(Q) $(CC) $(CPPFLAGS) $(CFLAGS) $(STATIC_OBJECTS) test.c
+	$(ECHO) "running test.c"
+	$(Q) ./a.out

data/README.md

@@ -0,0 +1,81 @@
+<h1 align="center">Prism</h1>
+
+This is a parser for the Ruby programming language. It is designed to be portable, error tolerant, and maintainable. It is written in C99 and has no dependencies.
+
+## Getting started
+
+To compile the parser, you will need:
+
+* C99 compiler
+* GNU make
+* Ruby 2.7.0 or later
+
+Once you have these dependencies, run:
+
+```
+bundle install
+```
+
+to fetch the Ruby dependencies. Finally, run:
+
+```
+bundle exec rake compile
+```
+
+to compile the parser. It will be built in the `build` directory. To test that everything is working, run:
+
+```
+bin/parse -e "1 + 2"
+```
+
+to see the syntax tree for the expression `1 + 2`.
+
+## Overview
+
+The repository contains the infrastructure for both a shared library (libprism) and a native CRuby extension. The shared library has no bindings to CRuby itself, and so can be used by other projects. The native CRuby extension links against `ruby.h`, and so is suitable in the context of CRuby.
+
+```
+.
+├── Makefile              configuration to compile the shared library and native tests
+├── Rakefile              configuration to compile the native extension and Ruby tests
+├── bin
+│   ├── lex               runs the lexer on a file or string and prints the tokens
+│   ├── parse             runs the parse on a file or string and prints the AST
+│   └── prism             a CLI for development and debugging
+├── config.yml            specification for tokens and nodes in the tree
+├── doc                   documentation website
+├── docs                  markdown documentation about the project
+├── ext
+│   └── prism
+│       ├── extconf.rb    configuration to generate the Makefile for the native extension
+│       └── extension.c   the native extension that interacts with libprism
+├── fuzz                  files related to fuzz testing
+├── gemfiles              gemfiles used by different Ruby versions in CI
+├── include
+│   ├── prism             header files for the shared library
+│   └── prism.h           main header file for the shared library
+├── java
+|   ├── api               Java API for Prism
+|   ├── native            Java native bindings for the shared library
+|   └── wasm              Java WASM bindings for the shared library
+├── javascript            JavaScript WASM bindings for the shared library
+├── lib
+│   ├── prism             Ruby library files
+│   └── prism.rb          main entrypoint for the Ruby library
+├── rakelib               various Rake tasks for the project
+├── rbi                   RBI type signatures for the Ruby library
+├── rust
+│   ├── ruby-prism        Rustified crate for the shared library
+│   └── ruby-prism-sys    FFI binding for Rust
+├── sample
+│   └── prism             Sample code that uses the Ruby API for documentation purposes
+├── sig                   RBS type signatures for the Ruby library
+├── src
+│   └── prism.c           main entrypoint for the shared library
+├── templates             contains ERB templates generated by templates/template.rb
+│   └── template.rb       generates code from the nodes and tokens configured by config.yml
+└── test
+    └── prism
+        ├── fixtures      Ruby code used for testing
+        └── snapshots     snapshots of generated syntax trees corresponding to fixtures
+```