Compare commits

..
62 Commits
Author SHA1 Message Date
Dmitry Kakurin 762989b39f Fix Path.absname/1 to correctly handle UNC paths on Windows (#9689) 2020-01-06 21:44:27 +01:00
Lasse Skindstad Ebert 1767df4747 Fix release tar when include_erts is false (#9570)
Now excludes files that does not exist on the file system. This could
happen e.g. if the release is built with `include_erts: false`.

Otherwise building the tar would fail with `:enoent`.
2019-11-22 11:20:54 +01:00
José Valim 055526057a Release v1.9.4 2019-11-05 16:29:34 +01:00
José Valim 5af52898d3 Release v1.9.3 2019-11-05 13:42:49 +01:00
José Valim 34dc2466e4 Remove warnings from rebar3 safe install 2019-11-05 12:42:33 +01:00
Bram Verburg fad48c401f Warn when using unsafe URL local installs 2019-11-05 11:53:35 +01:00
Michał Kalbarczyk 215229c28f Make release's boot scripts deterministic (#9387) 2019-11-03 18:02:23 +01:00
José Valim 1ea09243c5 Clarify escaping rules in sigils, closes #9471 2019-11-03 11:14:39 +01:00
Chris de Graaf 96c9500afd Use default_release option when name is not given (#9158) 2019-10-21 18:27:19 +02:00
Gary Rennie b6ea714339 Add :tar option for releases to create a tarball (#9290) 2019-10-16 17:37:26 +02:00
José Valim ffe7a577cc Release v1.9.2 2019-10-12 00:21:23 +02:00
José Valim a2f14bd007 Consider options when running regexes on the fly
Closes #9343.
2019-10-11 17:45:12 +02:00
Fernando Tapia Rico 66ac6a3d8a Ensure reproducible builds (boostrapping issue) (#9385)
During bootstrap, the generated AST for the `defexception` macro
does not include import metadata when calling to Kernel functions
without using the qualified name. That's not the case when the
Kernel is later recompiled.

When compiling the standard library, exceptions like
`FunctionClauseError` were generating different ASTs (different
metadata) depending on if they were compiled with the bootstrapped
Kernel or the later compiled one.
2019-10-09 19:12:24 +02:00
José Valim 50caa25d41 Ensure compilation works for a variable named super, closes #9390 2019-10-09 19:12:05 +02:00
José Valim 92af3fdf0f Use Base.encode32 when generating cookie to avoid unsafe chars, closes #9328 2019-09-06 09:57:18 +02:00
José Valim c443cdee36 Move specification of env variables to their own block 2019-08-23 16:07:29 +02:00
José Valim 8ca3876b10 Fixes for release install command on Windows, closes #9310 2019-08-23 15:57:28 +02:00
José Valim c7e822345b Ask user to manually clean manifests if we can't do it, closes #9308 2019-08-22 16:25:30 +02:00
Gary Rennie b43a6a923e Allow {:from_app, app_name} as a version for releases (#9280)
Sometimes it is desireable to lookup the version from another
application to use as the version for a release. This is true in the
case of umbrella applications, where a particular app may be targetted
for a release.

Using `{:from_app, :my_app}` will allow the version returned from
`Application.spec(:my_app, :vsn)` to be used as the version.
2019-08-09 12:35:58 +02:00
Wouter Klijn e60fe36740 Fix release RPC tests (#9253) 2019-07-30 22:17:27 +02:00
Derrick Zhang f5735eb697 Make the wildcard example equivalent with Mix.Config in an umbrella project (#9251) 2019-07-30 09:49:21 +02:00
José Valim 7002554a47 Ensure local captures work correctly on macro expansion
Closes #9245
2019-07-27 11:30:34 +02:00
José Valim 660a09b3af Quote executable path on Windows, closes #9242 (#9243) 2019-07-26 16:02:04 +02:00
José Valim 79388035f5 Release v1.9.1 2019-07-18 12:17:13 +02:00
José Valim edc204f0b2 Make sure contents are not empty before decoding
Signed-off-by: José Valim <jose.valim@plataformatec.com.br>
2019-07-18 11:41:37 +02:00
Jason Axelson 7d2cee20f6 Increase understandability of the tuple documentation (#9226)
[ci skip]

Since Elixir data structures are immutable, emphasize that creating a new tuple
is required. Also add a "result" binding to make it more clear that the last
line is being used as a result for later.
2019-07-18 10:29:09 +02:00
José Valim a58a924e10 :start cannot be customized on use
Signed-off-by: José Valim <jose.valim@plataformatec.com.br>
2019-07-18 10:29:00 +02:00
José Valim e0a9b4b476 Preserve UTF8 encoding in release config files
Closes #9225

Signed-off-by: José Valim <jose.valim@plataformatec.com.br>
2019-07-18 10:28:42 +02:00
José Valim eb8121c790 Print relative paths in the formatter error 2019-07-15 13:26:47 +02:00
José Valim 3f0608bdc3 Raise readable error for mismatched sources, closes #9218 2019-07-15 13:09:45 +02:00
José Valim 9797a466fc Only run tests if epmd is available, closes #9167 2019-07-11 00:15:17 +02:00
Sven Gehring 418c277dfb Fix formatter removing nested parens in call on call (#9211) 2019-07-10 20:19:54 +02:00
José Valim 580bd764f7 Clarify potentially breaking bug fix, closes #9191 2019-07-04 16:45:46 +02:00
José Valim 49dec48926 Improve docs for releases
Closes #9187.
2019-07-04 09:39:02 +02:00
José Valim c8c7663c83 Run the formatter 2019-07-02 21:35:22 +02:00
José Valim 4e6261a392 Support included applications, closes #9163 2019-07-02 21:20:55 +02:00
José Valim f10cf8bdc8 Make sure locals tracker can be stopped 2019-06-27 10:12:20 +02:00
José Valim 75313ababc Add catch all for bad supervisor names
Otherwise if a different supervisor implementation,
such as a `ConsumerSupervisor` in GenStage, pass a
different name by accident, logging would fail.

Closes #8126.
2019-06-26 14:32:30 +02:00
Nathan Long 570d44b502 More details about the :native time unit, from the Erlang docs (#9157)
[ci skip]
2019-06-25 14:13:42 +02:00
José Valim 71c335ac26 Release v1.9.0 2019-06-24 11:20:18 +02:00
Julius Putra Tanu Setiaji 02f5d57871 Fix typespec of Macro.Env.t (#9155) 2019-06-24 07:15:11 +02:00
José Valim 6c16486b4a Clarify the relationship with config/releases.exs, closes #9153 2019-06-21 18:59:33 +02:00
José Valim bfa5d6d23c Do not pass Meta to Erlang AST, closes #9152
Signed-off-by: José Valim <jose.valim@plataformatec.com.br>
2019-06-21 16:57:49 +02:00
José Valim c30b6d675b Rename :end metadata to less ambiguous :closing
Signed-off-by: José Valim <jose.valim@plataformatec.com.br>
2019-06-16 00:02:26 +02:00
José Valim b59937b80f Add missing @doc since annotation
Signed-off-by: José Valim <jose.valim@plataformatec.com.br>
2019-06-14 07:57:47 +02:00
Eksperimental 5b0f17130f Place Version.Requirement module under Basic Types in docs.exs (#9139)
Signed-off-by: José Valim <jose.valim@plataformatec.com.br>
2019-06-14 07:57:46 +02:00
José Valim 2548965a1e Ensure started/loaded apps do not leak between Mix tests, closes #9137 2019-06-13 13:49:59 +02:00
Fernando Tapia Rico 09c01da205 Fix bad naming on release script for Windows (#9135)
Signed-off-by: José Valim <jose.valim@plataformatec.com.br>
2019-06-12 19:32:08 +02:00
Andrea Leopardi 9ed78dea24 Improve a comment in env.*.eex for releases (#9134)
Signed-off-by: José Valim <jose.valim@plataformatec.com.br>
2019-06-12 19:32:06 +02:00
Justin Schneck e5888e7b93 Add RELEASE_BOOT_SCRIPT and RELEASE_BOOT_SCRIPT_CLEAN (#9132)
Signed-off-by: José Valim <jose.valim@plataformatec.com.br>
2019-06-12 09:35:09 +02:00
Jonatan Männchen 13af842c66 IEx: Sort Types in t helper (#9131) 2019-06-11 23:50:56 +02:00
José Valim a211223810 Keep struct fields ordered in types
Closes https://github.com/elixir-lang/ex_doc/issues/1016
2019-06-11 13:50:07 +02:00
Chris Wögi 8bc3c826b1 Fix redirection to null on windows (#9130)
Concerning generated `bin/release.bat` from `mix release`.
2019-06-11 13:25:54 +02:00
José Valim 7a3d6ec928 Remove timestamps from release, closes #9127 2019-06-11 10:48:30 +02:00
José Valim 9b2e7892ca Do not crash formatter on false positive sigils, closes #9123
Signed-off-by: José Valim <jose.valim@plataformatec.com.br>
2019-06-10 11:19:09 +02:00
Tristan Sloughter 04794d5dfd --paths= in rebar3 bare compile fixes subcommand splitting on comma bug (#9120)
Signed-off-by: José Valim <jose.valim@plataformatec.com.br>
2019-06-08 16:00:21 +02:00
José Valim 36c2787fc6 Immediately shutdown the lexical tracker
Otherwise we may have a race condition if the code
is passing __ENV__ to an eval function which may keep
the lexical tracker if it is alive by the time it is
checked.
2019-06-07 12:02:41 +02:00
Justin Schneck 2bafa0b50b Add preferred_cli_target (#9118) 2019-06-07 08:21:43 +02:00
José Valim c953de0036 Enforce atom keys for config 2019-06-04 15:21:39 +02:00
José Valim aad7aa4d22 Release v1.9.0-rc.0 2019-06-04 13:21:07 +02:00
Tobiasz Małecki ebe23614f7 Remove redundant "a" from Inspect.Opts moduledoc (#9114) 2019-06-04 12:00:44 +02:00
José Valim d8d6ab48c8 Prepare v1.9 for release 2019-06-03 17:36:28 +02:00
380 changed files with 11929 additions and 23479 deletions
+18
View File
@@ -0,0 +1,18 @@
version: 1-{branch}+{build}
build_script:
- cmd: C:\MinGW\msys\1.0\bin\make
- cmd: rmdir /s /q .git
before_test:
- cmd: set PATH=%PATH%;C:\Program Files\erl8.3\erts-8.3\bin
test_script:
- cmd: C:\MinGW\msys\1.0\bin\make --keep-going test_windows
environment:
ELIXIR_ASSERT_TIMEOUT: 2000
matrix:
allow_failures:
- platform: x86
- platform: x64
- platform: Any CPU
-165
View File
@@ -1,165 +0,0 @@
env:
CIRRUS_CLONE_DEPTH: 50
ELIXIR_ASSERT_TIMEOUT: 2000
ELIXIRC_OPTS: "--warnings-as-errors"
ERLC_OPTS: "+warnings_as_errors"
LANG: C.UTF-8
test_template: &DEFAULT_TEST_SETTINGS
# don't cancel the task execution if it's master or a release branch
auto_cancellation: $CIRRUS_BRANCH != 'master' && $CIRRUS_BRANCH !=~ 'v\d+\.\d+.*'
test_linux_task:
<<: *DEFAULT_TEST_SETTINGS
container:
image: buildpack-deps:trusty
cpu: 8
memory: 1536Mi
env:
PATH: "${CIRRUS_WORKING_DIR}/otp/bin:${PATH}"
matrix:
- name: Linux, ${OTP_RELEASE}, Ubuntu 14.04
alias: Linux Stable
matrix:
- env:
CHECK_POSIX_COMPLIANT: true
CHECK_REPRODUCIBLE: true
OTP_RELEASE: OTP-23.0
- env:
OTP_RELEASE: OTP-22.3
- env:
OTP_RELEASE: OTP-22.0
- env:
OTP_RELEASE: OTP-21.3.8
- env:
OTP_RELEASE: OTP-21.0
- name: Linux, OTP-${OTP_RELEASE}, development, Ubuntu 14.04
alias: Linux Development
allow_failures: true
skip_notifications: true
depends_on:
- Linux Stable
- FreeBSD Stable
matrix:
- env:
OTP_RELEASE: master
- env:
OTP_RELEASE: maint
install_script:
- wget -O otp.tar.gz https://repo.hex.pm/builds/otp/ubuntu-14.04/${OTP_RELEASE}.tar.gz
- mkdir -p otp
- tar zxf otp.tar.gz -C otp --strip-components=1
- otp/Install -minimal ${CIRRUS_WORKING_DIR}/otp
- rm -rf .git
- make compile
build_info_script: bin/elixir --version
test_formatted_script:
- make test_formatted &&
echo "All Elixir source code files are properly formatted."
dialyzer_script: dialyzer -pa lib/elixir/ebin --build_plt --output_plt elixir.plt --apps lib/elixir/ebin/elixir.beam lib/elixir/ebin/Elixir.Kernel.beam
test_erlang_script: make test_erlang
test_elixir_script: make test_elixir
check_posix_compliant_script: |
if [ -n "$CHECK_POSIX_COMPLIANT" ]; then
apt update
apt install -y shellcheck
shellcheck -e SC2039,2086 bin/elixir && echo "bin/elixir is POSIX compliant"
shellcheck bin/elixirc && echo "bin/elixirc is POSIX compliant"
shellcheck bin/iex && echo "bin/iex is POSIX compliant"
else
echo "The format of the shell scripts is only checked in the last stable Erlang/OTP version."
fi
check_reproducible_script: |
if [ -n "$CHECK_REPRODUCIBLE" ]; then
make check_reproducible
else
echo "The reproducibility of the build is only checked in the last stable Erlang/OTP version."
fi
test_windows_task:
<<: *DEFAULT_TEST_SETTINGS
name: Windows, OTP-${OTP_RELEASE}, Windows Server 2019
alias: Windows Stable
matrix:
- env:
OS_VERSION: 2019
OTP_RELEASE: 22.0
- env:
OS_VERSION: 2019
OTP_RELEASE: 21.0.1
windows_container:
image: fertapric/elixir-ci:otp-win64-${OTP_RELEASE}
os_version: ${OS_VERSION}
cpu: 4
memory: 6GB
install_script:
- rmdir /s /q .git
- make compile
build_info_script: bin/elixir --version
test_formatted_script:
- make test_formatted &&
echo "All Elixir source code files are properly formatted."
test_erlang_script: make --keep-going test_erlang
test_elixir_script: make --keep-going test_elixir
test_freebsd_task:
<<: *DEFAULT_TEST_SETTINGS
name: FreeBSD 12.1
alias: FreeBSD Stable
freebsd_instance:
image_family: freebsd-12-1
cpu: 8
memory: 7424Mi
env:
CHECK_REPRODUCIBLE: true
LC_ALL: en_US.UTF-8
install_script:
- pkg install -y erlang git gmake
- rm -rf .git
- gmake compile
build_info_script: bin/elixir --version
test_formatted_script:
- gmake test_formatted &&
echo "All Elixir source code files are properly formatted."
dialyzer_script: dialyzer -pa lib/elixir/ebin --build_plt --output_plt elixir.plt --apps lib/elixir/ebin/elixir.beam lib/elixir/ebin/Elixir.Kernel.beam
test_erlang_script: gmake test_erlang
test_elixir_script: gmake test_elixir
check_reproducible_script: |
if [ -n "$CHECK_REPRODUCIBLE" ]; then
gmake check_reproducible
else
echo "The reproducibility of the build is only checked in the last stable Erlang/OTP version."
fi
-17
View File
@@ -1,17 +0,0 @@
on: check_suite
name: CI email
jobs:
sendEmail:
name: Send email
runs-on: ubuntu-latest
steps:
- name: Send email
# Source: https://github.com/elixir-lang/elixir-ci
uses: docker://fertapric/elixir-ci-email:latest
env:
APP_NAME: Cirrus CI
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
MAIL_FROM: ci@elixir-lang.org
MAIL_HOST: smtp.sendgrid.net
MAIL_PASSWORD: ${{ secrets.CI_EMAIL_PASSWORD }}
MAIL_USERNAME: ${{ secrets.CI_EMAIL_USERNAME }}
+47
View File
@@ -0,0 +1,47 @@
language: bash
sudo: false
env:
global:
- ELIXIR_ASSERT_TIMEOUT=2000
matrix:
- OTP_RELEASE=OTP-22.0 CHECK_REPRODUCIBLE=true CHECK_POSIX_COMPLIANT=true
- OTP_RELEASE=OTP-21.3.8
- OTP_RELEASE=OTP-21.2
- OTP_RELEASE=OTP-21.1
- OTP_RELEASE=OTP-21.0
- OTP_RELEASE=OTP-20.3
- OTP_RELEASE=OTP-20.2
- OTP_RELEASE=OTP-20.1
- OTP_RELEASE=OTP-20.0
- OTP_RELEASE=maint
- OTP_RELEASE=master
matrix:
fast_finish: true
allow_failures:
- env: OTP_RELEASE=maint
- env: OTP_RELEASE=master
install:
- wget -O otp.tar.gz https://repo.hex.pm/builds/otp/ubuntu-14.04/${OTP_RELEASE}.tar.gz
- mkdir -p otp
- tar zxf otp.tar.gz -C otp --strip-components=1
- otp/Install -minimal $(pwd)/otp
- PATH=$(pwd)/otp/bin:$PATH
script:
- rm -rf .git
- ELIXIRC_OPTS="--warnings-as-errors" ERLC_OPTS="+warning_as_errors" make compile
- make test
- dialyzer -pa lib/elixir/ebin --build_plt --output_plt elixir.plt --apps lib/elixir/ebin/elixir.beam lib/elixir/ebin/Elixir.Kernel.beam
# Check for reproducible builds only in the latest OTP release
- if [ -n "$CHECK_REPRODUCIBLE" ]; then make check_reproducible; fi
# Check for POSIX compliant shell scripts
- if [ -n "$CHECK_POSIX_COMPLIANT" ]; then
shellcheck -e SC2039,2086 bin/elixir && echo "bin/elixir is POSIX compliant";
shellcheck bin/elixirc && echo "bin/elixirc is POSIX compliant";
shellcheck bin/iex && echo "bin/iex is POSIX compliant";
fi
+205 -301
View File
@@ -1,391 +1,295 @@
# Changelog for Elixir v1.10
# Changelog for Elixir v1.9
## Support for Erlang/OTP 21+
## Releases
Elixir v1.10 requires Erlang/OTP 21+, allowing Elixir to integrate with Erlang/OTP's new logger. Currently, this means that the logger level, logger metadata, as well as all log messages are now shared between Erlang and Elixir APIs.
The main feature in Elixir v1.9 is the addition of releases. A release is a self-contained directory that consists of your application code, all of its dependencies, plus the whole Erlang Virtual Machine (VM) and runtime. Once a release is assembled, it can be packaged and deployed to a target as long as the target runs on the same operating system (OS) distribution and version as the machine running the `mix release` command.
We will continue improving the relationship between the logging systems in future releases. In particular, we plan to expose all log levels and runtime filtering functionalities available in Erlang directly into Elixir in the next Elixir version.
You can start a new project and assemble a release for it in three easy steps:
This release also adds two new guards, `is_struct/1` and `is_map_key/2`, thanks to the strict requirement on Erlang/OTP 21+.
$ mix new my_app
$ cd my_app
$ MIX_ENV=prod mix release
## Releases improvements
A release will be assembled in `_build/prod/rel/my_app`. Inside the release, there will be a `bin/my_app` file which is the entry point to your system. It supports multiple commands, such as:
Elixir v1.9 introduced releases as a mechanism to package self-contained applications. Elixir v1.10 further improves releases with bug fixes and new enhancements based on feedback we got from the community. The highlights are:
* `bin/my_app start`, `bin/my_app start_iex`, `bin/my_app restart`, and `bin/my_app stop` - for general management of the release
* Allow the dual boot system of releases to be disabled on environments that are boot-time sensitive, such as embedded devices
* `bin/my_app rpc COMMAND` and `bin/my_app remote` - for running commands on the running system or to connect to the running system
* Track and raise if compile-time configuration is set or changes at runtime (more in the next section)
* `bin/my_app eval COMMAND` - to start a fresh system that runs a single command and then shuts down
* Support for easily adding extra files to releases via overlays
* `bin/my_app daemon` and `bin/my_app daemon_iex` - to start the system as a daemon on Unix-like systems
* Allow `RELEASE_DISTRIBUTION` to be set to `none` in order to fully disable it
* `bin/my_app install` - to install the system as a service on Windows machines
* Add a built-in `:tar` step that automatically packages releases
### Why releases?
See the full CHANGELOG for more improvements.
Releases allow developers to precompile and package all of their code and the runtime into a single unit. The benefits of releases are:
## Improvements to sort-based APIs in Enum
* Code preloading. The VM has two mechanisms for loading code: interactive and embedded. By default, it runs in the interactive mode which dynamically loads modules when they are used for the first time. The first time your application calls `Enum.map/2`, the VM will find the `Enum` module and load it. There’s a downside. When you start a new server in production, it may need to load many other modules, causing the first requests to have an unusual spike in response time. Releases run in embedded mode, which loads all available modules upfront, guaranteeing your system is ready to handle requests after booting.
`Enum.sort/1` in Elixir by default sorts from lowest to highest:
* Configuration and customization. Releases give developers fine grained control over system configuration and the VM flags used to start the system.
```elixir
iex> Enum.sort(["banana", "apple", "pineapple"])
["apple", "banana", "pineapple"]
```
* Self-contained. A release does not require the source code to be included in your production artifacts. All of the code is precompiled and packaged. Releases do not even require Erlang or Elixir in your servers, as they include the Erlang VM and its runtime by default. Furthermore, both Erlang and Elixir standard libraries are stripped to bring only the parts you are actually using.
If you want to sort from highest to lowest, you need to call `Enum.sort/2` with a custom sorting function, such as `Enum.sort(collection, &>=/2)`, which is not immediately obvious to someone reading the code:
* Multiple releases. You can assemble different releases with different configuration per application or even with different applications altogether.
```elixir
iex> Enum.sort(["banana", "apple", "pineapple"], &>=/2)
["pineapple", "banana", "apple"]
```
### Hooks and Configuration
Furthermore, comparison operators, such as `<=` and `>=`, perform structural sorting, instead of a semantic one. For example, using `>=` to sort dates descendingly won't yield the correct result:
Releases also provide built-in hooks for configuring almost every need of the production system:
```elixir
iex> Enum.sort([~D[2019-12-31], ~D[2020-01-01]])
[~D[2020-01-01], ~D[2019-12-31]]
```
* `config/config.exs` (and `config/prod.exs`) - provides build-time application configuration, which is executed when the release is assembled
To perform proper semantic comparison for dates, one would also need to pass a custom sorting function:
* `config/releases.exs` - provides runtime application configuration. It is executed every time the release boots and is further extensible via config providers
```elixir
iex> Enum.sort([~D[2019-12-31], ~D[2020-01-01]], &(Date.compare(&1, &2) != :lt))
[~D[2019-12-31], ~D[2020-01-01]]
```
* `rel/vm.args.eex` - a template file that is copied into every release and provides static configuration of the Erlang Virtual Machine and other runtime flags
Elixir v1.10 streamlines the sorting functions by introducing both `:asc` and `:desc` shortcuts:
* `rel/env.sh.eex` and `rel/env.bat.eex` - template files that are copied into every release and executed on every command to set up environment variables, including ones specific to the VM, and the general environment
```elixir
iex> Enum.sort(["banana", "apple", "pineapple"], :asc)
["apple", "banana", "pineapple"]
iex> Enum.sort(["banana", "apple", "pineapple"], :desc)
["pineapple", "banana", "apple"]
```
We have written extensive documentation on releases, so we recommend checking it out for more information.
As well as adding the possibility to pass a module to perform semantic comparisons. For example, to sort dates, one now only needs to pass the `Date` module or even `{:desc, Date}` for descending semantical sort:
## Configuration overhaul
```elixir
iex> Enum.sort([~D[2019-12-31], ~D[2020-01-01]], Date)
[~D[2019-12-31], ~D[2020-01-01]]
iex> Enum.sort([~D[2019-12-31], ~D[2020-01-01]], {:desc, Date})
[~D[2020-01-01], ~D[2019-12-31]]
```
A new `Config` module has been added to Elixir. The previous configuration API, `Mix.Config`, was part of the Mix build tool. But since releases provide runtime configuration and Mix is not included in releases, we ported the `Mix.Config` API to Elixir. In other words, `use Mix.Config` has been soft-deprecated in favor of `import Config`.
These API improvements make the code more concise and readable and they have also been added to `Enum.sort_by`, `Enum.min_by`, `Enum.max_by`, and friends.
## Tracking of compile-time configuration
In Elixir, we organize our code in applications. Libraries, your dependencies, and your own project are all separate applications. All applications in Elixir also come with an application environment.
The application environment is a key-value store that allows us to configure said application. While reading the application environment at runtime is the preferred approach, in some rare occasions you may want to use the application environment to configure the compilation of a certain project. This is often done by calling `Application.get_env/3` outside of a function:
```elixir
defmodule MyApp.DBClient do
@db_host Application.get_env(:my_app, :db_host, "db.local")
def start_link() do
SomeLib.DBClient.start_link(host: @db_host)
end
end
```
This approach has one big limitation: if you change the value of the application environment after the code is compiled, the value used at runtime is not going to change! For example, if you are using `mix release` and your `config/releases.exs` has:
config :my_app, :db_host, "db.production"
Because `config/releases.exs` is read after the code is compiled, the new value will have no effect as the code was compiled to connect to "db.local".
Of course, the obvious solution to this mismatch is to not read the application environment at compilation time in the first place, and instead move the code to inside a function:
```elixir
defmodule MyApp.DBClient do
def start_link() do
SomeLib.DBClient.start_link(host: db_host())
end
defp db_host() do
Application.get_env(:my_app, :db_host, "db.local")
end
end
```
While this is the preferred approach, there are still two scenarios we need to address:
1. Not everyone may be aware of this pitfall, so they will mistakenly read the application environemnt at compile-time, until they are bitten by this behaviour
2. In rare occasions, you trully need to read the application environment at compile-time, and you want to be warned when you try to configure at runtime something that is valid only at compilation time
Elixir v1.10 aims to solve these two scenarios by introducing a `Application.compile_env/3` function. For example, to read the value at compile time, you can now do:
```elixir
@db_host Application.compile_env(:my_app, :db_host, "db.local")
```
By using `compile_env/3`, Elixir will store the values used during compilation and compare them with the runtime values whenever your system starts, raising an error in case they differ. This helps developers ensure they are running their production systems with the configuration they intend to.
In future versions, we will deprecate the use `Application.get_env` at compile-time with a clear message pointing users to configuration best practices, effectively addressing the scenario where users read from the application environment at compile time unaware of its pitfalls.
## Compiler tracing
This release brings enhancements to the Elixir compiler and adds new capabilities for developers to listen to compilation events.
In previous Elixir versions, Elixir would compile a database of cross references between modules (such as function calls, references, structs, etc) for each project in order to perform all kinds of checks, such as deprecations and undefined functions.
Although this database was not public, developers would still use it to run their own checks against their projects. With time, developers would request more data to be included in the database, which was problematic as Elixir itself did not have a use for the additional data, and the database was not meant to be used externally in the first place.
In Elixir v1.10, we have addressed these problems by introducing compiler tracing. The compiler tracing allows developers to listen to events as they are emitted by the compiler, so they can store all of the information they need - and only the information they need.
Elixir itself is using the new compiler tracing to provide new functionality. One advantage of this approach is that developers can now disable undefined function warnings directly on the callsite. For example, imagine you have an optional dependency which may not be available in some cases. You can tell the compiler to skip warning on calls to optional modules with:
@compile {:no_warn_undefined, OptionalDependency}
defdelegate my_function_call(arg), to: OptionalDependency
Previously, this information had to be added to the overall project configuration, which was far away from where the optional call effectively happened.
Another important change related to configuration is that `mix new` will no longer generate a `config/config.exs` file. [Relying on configuration is undesired for most libraries](https://hexdocs.pm/elixir/library-guidelines.html#avoid-application-configuration) and the generated config files pushed library authors in the wrong direction. Furthermore, `mix new --umbrella` will no longer generate a configuration for each child app, instead all configuration should be declared in the umbrella root. That's how it has always behaved, we are now making it explicit.
## Other enhancements
Elixir's calendar data types got many improvements, such as sigil support for third-party calendars, as well as the additions of `DateTime.now!/2`, `DateTime.shift_zone!/3`, and `NaiveDateTime.local_now/0`.
There are many other enhancements. The Elixir CLI got a handful of new options in order to best support releases. `Logger` now computes its sync/async/discard thresholds in a decentralized fashion, reducing contention. `EEx` templates support more complex expressions than before. Finally, there is a new `~U` sigil for working with UTC DateTimes as well as new functions in the `File`, `Registry`, and `System` modules.
There are many improvements related to Elixir's AST in this release too. First of all, `Code.string_to_quoted/2` has two new options, `:token_metadata` and `:literal_encoder`, that give more control over Elixir's parser. This information was already available to the Elixir code formatter and has now been made public. We have also extensively documented all of Elixir's AST metadata. These changes alongside compiler tracing means static analyzers and IDE integrations have a better foundation to analyze the source code.
ExUnit, our test framework, ships two small but important improvements: `ExUnit.CaptureIO` can now be used by tests that run concurrently and we have added "pattern-matching diffing". To understand the last feature, take this code:
```elixir
assert %{"status" => 200, "body" => %{"key" => "foo"}} = json_payload
```
Now imagine that `json_payload` is a large JSON blob and the `"key"` inside the `"body"` did not have value of `"foo"`. In previous Elixir versions, if the assertion failed, Elixir would print the right side and let you up to your own devices to figure out what went wrong. In Elixir v1.10, we diff the data structure against the pattern so you can see exactly which parts of the data matched the pattern and which ones did not. Note ExUnit already performed diffing when comparing data types, this new version adds diffing when matching data against a pattern.
## v1.10.4 (2020-07-04)
## v1.9.4 (2019-11-05)
### 1. Bug fixes
#### Elixir
* [Kernel] Fix a bug where custom types were printed as built-in types
* [Kernel] Don't add compile-time dependency on `defdelegate`
* [Kernel] Add line numbers to warnings on deprecated imports
* [Kernel] Report the correct line number when raising inside a macro
* [Task] Include callers in translated Logger metadata for Task
* [Task] Fix Task PID and caller in Task Supervisor reports
#### ExUnit
* [ExUnit.Formatter] Avoid crashes when diffing guards when the pattern does not match
* [ExUnit.Formatter] Also blame exceptions that come from linked and trapped exits
#### IEx
* [IEx.Helpers] Do not crash when printing a type that cannot be code formatted
#### Mix
* [mix app.start] Fix reading `.app` file located in archives (`.ez` files)
* [mix local.hex] Provide more guidance when Hex can't be installed
* [mix release] Properly encode config in releases
## v1.10.3 (2020-04-25)
### 1. Bug fixes
#### Elixir
* [Code] Return `[{mod, bin}]` from `Code.compile_file/2`, `Code.require_file/2`, `Code.load_file/2`
* [Code] Make sure the formatter respects newlines before and after module attributes
* [Kernel.ParallelCompiler] Fix a bug where the parallel compiler would raise in long compilation cycles
* [Kernel.ParallelCompiler] Fix a bug where the parallel compiler would raise if some of the modules being compiled referred to a module that has been loaded directly to memory
* [Module] Fix accidental breaking change where bodiless clauses had their body value on `@on_definition` callbacks set to an empty list instead of `nil`
* [String] Undeprecate `String.normalize/2` normalize and fix infinite loop caused by certain invalid strings
#### ExUnit
* [ExUnit.Assertions] Fix pattern matching diff when matching on pinned variables
* [ExUnit.Assertions] Fix pattern matching diff when matching variable struct names
* [ExUnit.Assertions] Fix pattern matching diff when matching on the binary concat operator (`<>`) and the left side is not a literal string
* [ExUnit.Assertions] Fix pattern matching diff when matching on pseudo-vars (`__MODULE__`, `__DIR__`, etc)
#### Mix
* [mix release] Respect the `:path` option when creating a `:tar` file for releases
* [mix local.hex] Remove invalid deprecation warning on `mix local.hex` command
## v1.10.2 (2020-02-26)
## v1.9.3 (2019-11-05)
### 1. Bug fixes
Note this release deprecates the use of URLs on `mix archive.install`, `mix escript.install`, and `mix local.rebar`. Support for passing URLs to said commands will be fully removed on Elixir v1.10, as they are unsafe. Thanks to Bram Verburg for the report and for providing a fix.
#### Elixir
The alternative is straight-forward: you can simply download the artifact via the command line and then invoke the command with a file system path. For example, instead of:
* [Macro] Fix a bug where `Macro.to_string/1` would emit invalid code for sigils
* [Task] Do not crash `async_stream` monitor if it receives spurious DOWN messages
$ mix archive.install https://example.org/installer.ez
#### Logger
You can execute on Unix (Linux, MacOS X):
* [Logger] Fix a bug where the Logger formatter would fail when handling unknown metadata values
$ wget https://example.org/installer.ez
$ mix archive.install installer.ez
#### Mix
or
* [mix compile] Do not write files to disk if `--warnings-as-errors` was given and warnings were emitted
$ curl -o installer.ez https://example.org/installer.ez
$ mix archive.install installer.ez
## v1.10.1 (2020-02-10)
On Windows (Win7 or later):
### 1. Bug fixes
> powershell -Command "Invoke-WebRequest https://example.org/installer.ez -OutFile installer.ez"
> mix archive.install installer.ez
#### Elixir
or
* [Code] Do not emit invalid code when formatting `nil`, `false`, and `true` keys in maps
* [Kernel] Ensure `with` clauses properly unpack "implicit guards" (such as matching on the struct name)
* [Kernel] Do not warn if commas are used by themselves in `~w`/`~W` sigils
* [Kernel] Do not validate the `:line` option in quote (the validation has been moved to v1.11 to give users more time to update their code)
* [Module] Ensure the code verifier handles the `:erlang.size/1` guard properly
> powershell -Command "(New-Object Net.WebClient).DownloadFile('https://example.org/installer.ez', 'installer.ez')"
> mix archive.install installer.ez
#### Logger
Note that, if you are a library author, consider providing installable escripts and archives through Hex, such as Phoenix:
* [Logger] Properly handle the `report_cb/2` option from Erlang
* [Logger] Fix truncation for multi-byte characters
* [Logger] Do not rebroadcast messages from remote nodes as this is now taken care by Erlang's logger
$ mix archive.install hex phx_new
#### ExUnit
* [ExUnit] Ensure `assert_receive` produces valid exception messages in case of errors
#### Mix
* [mix release] Make sure the install command (Window specific) works on paths with spaces in the name
* [mix release] Allow using `remote` and `rpc` commands with `Application.compile_env/3`
## v1.10.0 (2020-01-27)
Installations through Hex are always safe and they come with version management and all other benefits from Hex too.
### 1. Enhancements
#### Elixir
#### Mix
* [Application] Add `Application.compile_env/3` and `Application.compile_env!/2` for reading values at compilation time and tracking if they accidentally change during runtime
* [Calendar] Allow custom calendar representations in calendar sigils
* [Calendar] Add `c:Calendar.parse_time/1`, `c:Calendar.parse_date/1`, `c:Calendar.parse_naive_datetime/1` and `c:Calendar.parse_utc_datetime/1` callbacks to calendar behaviour
* [CLI] Add support for `NO_COLOR` environment variable
* [Code] Add `:token_metadata` and `:literal_encoder` support to `Code.string_to_quoted/2`
* [Code] Add compiler tracing to lift events done by the compiler
* [Code] Return `{:error, :unavailable}` in `Code.ensure_compiled/1` if module is in a deadlock
* [DateTime] Add `DateTime.now!/2` and `DateTime.shift_zone!/3`
* [Enum] Speed up getting one random element from enumerables
* [Enum] Add `Enum.frequencies/1`, `Enum.frequencies_by/2`, and `Enum.map_intersperse/2`
* [Enum] Allow a sorting function on `Enum.min/max/min_by/max_by`
* [Enum] Add `asc/desc` and `compare/1` support to `Enum.sort/2`
* [Exception] Add version alongside app names in stacktraces
* [Function] Add `Function.identity/1`
* [Kernel] Add `Kernel.is_struct/1` and `Kernel.is_map_key/2`
* [Kernel] Warn when function head comes immediately after the implementation instead of before the implementation
* [Kernel] Warn if duplicate key is found in struct declaration
* [Kernel] Print all undefined functions as warnings and then raise. This allows users to see all undefined calls at once, when it would otherwise require them to compile the code multiple times
* [Kernel] Allow file, line and context to be dynamically set on `quote`
* [Keyword] Add `Keyword.pop!/2` and `Keyword.pop_values/2`
* [Map] Add `Map.pop!/2`
* [MapSet] Optimize multiple operations
* [Module] Add `Module.has_attribute?/2`
* [Module] Add `@compile {:no_warn_undefined, mfa_or_module}` to turn off undefined function warnings
* [NaiveDateTime] Add `NaiveDateTime.local_now/0`
* [Record] Warn if duplicate key is found in record declaration
* [String] Update to Unicode 12.1
* [StringIO] Add `:encoding` option to StringIO and optimize `get_chars` operation
* [mix release] Add :tar option for releases to create a tarball
#### ExUnit
* [ExUnit.Assertions] Support diffs in pattern matching and in `assert_receive`
* [ExUnit.CaptureIO] Supports capturing named devices in asynchronous tests
#### IEx
* [IEx] Warn on circular file imports when loading default `.iex.exs`
* [IEx] Allow customization of the continuation prompt on IEx
#### Logger
* [Logger] Allow `start_options` to be configured on Logger's GenEvent
* [Logger] Integrate Elixir's Logger with Erlang/OTP 21+'s logger. This means setting up the logger level in Elixir will automatically change the logger level for Erlang and vice-versa
### 2. Bug fixes
#### Mix
* [mix compile] Add `--profile time` flag to profile compilation steps
* [mix deps.compile] Add `--skip-umbrella-children` flag. The new flag does not compile umbrella apps. This is useful for building caches in CD/CI pipelines
* [mix deps.unlock] Add `--check-unused` flag. The new flag raises if there are any unused dependencies in the lock file
* [mix release] Allow `RELEASE_DISTRIBUTION` to be set to `none`
* [mix release] Support overlays in `rel/overlays`
* [mix release] Allow configuration reboot to be disabled in releases
* [mix test] Add support for simple round-robin test partitioning across multiple machines
* [Mix.Project] Add `MIX_DEPS_PATH` environment variable for setting `:deps_path`
* [Mix.Project] Add `Mix.Project.deps_scms/1` that returns deps with their SCMs
* [Mix.Task] Add `Mix.Task.Compiler.after_compiler/2` callback, to simplify compilers that may need to run something at multiple steps
* [mix release] Use `default_release` option when name is not given
* [mix release] Make release's boot script contents deterministic
### 3. Deprecations
#### Mix
* [mix archive.install] Warn when installing from URI
* [mix escript.install] Warn when installing from URI
* [mix local.rebar] Warn when installing from URI
## v1.9.2 (2019-10-12)
### 1. Enhancements
#### Mix
* [mix release] Allow `{:from_app, app_name}` as a version for releases
### 2. Bug fixes
#### Elixir
* [Kernel] Ensure compilation works for a variable named `super`
* [Kernel] Ensure capture operator of a local function expands correctly inside a macro
* [Regex] Ensure dynamic recompilation of regexes considers options. This fixes an issue where parsing the protocol in `URI.parse/1` seemingly looked case sensitive when running Elixir precompiled on another machine
#### Mix
* [mix release] Use `Base.encode32` when generating cookie to avoid unsafe chars
* [mix release] Fix `install` command on Windows
* [mix release] Quote executable path on Windows to ensure it works on directories with spaces
## v1.9.1 (2019-07-18)
### 1. Enhancements
#### Mix
* [mix format] Print relative paths in `--check-formatted` output
* [mix release] Support included applications
### 2. Bug fixes
#### Elixir
* [Code] Fix formatter wrongly removing nested parens in nested calls
#### Logger
* [Logger] Do not crash translator on poorly formatted supervisor names
#### Mix
* [mix compile] Raise readable error for mismatched sources during compilation
* [mix release] Preserve UTF8 encoding in release config files
## v1.9.0 (2019-06-24)
### 1. Enhancements
#### EEx
* [EEx] Allow more complex mixed expressions when tokenizing
#### Elixir
* [Access] Allow `Access.at/1` to handle negative index
* [CLI] Add support for `--boot`, `--boot-var`, `--erl-config`, `--pipe-to`, `--rpc-eval`, and `--vm-args` options
* [Code] Add `static_atom_encoder` option to `Code.string_to_quoted/2`
* [Code] Support `:force_do_end_blocks` on `Code.format_string!/2` and `Code.format_file!/2`
* [Code] Do not raise on deadlocks on `Code.ensure_compiled/1`
* [Config] Add `Config`, `Config.Reader`, and `Config.Provider` modules for working with configuration
* [File] Add `File.rename!/2`
* [Inspect] Add `:inspect_fun` and `:custom_options` to `Inspect.Opts`
* [Kernel] Add `~U` sigil for UTC date times
* [Kernel] Optimize `&super/arity` and `&super(&1)`
* [Kernel] Optimize generated code for `with` with a catch-all clause
* [Kernel] Validate `__struct__` key in map returned by `__struct__/0,1`
* [Module] Add `Module.get_attribute/3`
* [Protocol] Improve `Protocol.UndefinedError` messages to also include the type that was attempted to dispatch on
* [Protocol] Optimize performance of dynamic dispatching for non-consolidated protocols
* [Record] Include field names in generated type for records
* [Regex] Automatically recompile regexes
* [Registry] Add `Registry.select/2`
* [System] Add `System.restart/0`, `System.pid/0` and `System.no_halt/1`
* [System] Add `System.get_env/2`, `System.fetch_env/1`, and `System.fetch_env!/1`
* [System] Support `SOURCE_DATE_EPOCH` for reproducible builds
#### ExUnit
* [ExUnit] Allow multiple `:exclude` on configuration/CLI
* [ExUnit.DocTest] No longer wrap doctest errors in custom exceptions. They ended-up hiding more information than showing
* [ExUnit.DocTest] Display the actual doctest code when doctest fails
#### IEx
* [IEx.CLI] Copy ticktime from remote node on IEx `--remsh`
* [IEx.CLI] Automatically add a host on node given to `--remsh`
#### Logger
* [Logger] Use a decentralized mode computation for Logger which allows overloads to be detected more quickly
* [Logger] Use `persistent_term` to store configuration whenever available for performance
#### Mix
* [Mix] Follow XDG base dir specification in Mix for temporary and configuration files
* [Mix.Generator] Add `copy_file/3`, `copy_template/4`, and `overwite?/2`
* [Mix.Project] Add `preferred_cli_target` that works like `preferred_cli_env`
* [mix archive.uninstall] Allow `mix archive.uninstall APP` to uninstall any installed version of APP
* [mix new] No longer generate a `config/` directory for mix new
* [mix release] Add support for releases
* [mix release.init] Add templates for release configuration
* [mix test] Allow running tests for a given umbrella app from the umbrella root with `mix test apps/APP/test`. Test failures also include the `apps/APP` prefix in the test location
### 2. Bug fixes
#### EEx
* [EEx] Ensure multiline do/end with no spaces compile under trim mode
* [EEx] Consistently trim newlines when you have a single EEx expression per line on multiple lines
#### Elixir
* [Enum] Allow positive range slices on infinite streams given to `Enum.slice/2`
* [Kernel] Raise error on functions/guards without implementation
* [Kernel] Do not expand expressions inside interpolation twice
* [Keyword] Ensure keyword replace and update preserve order
* [Module] Raise instead of silently failing when performing a write module operation during after-compile
* [Module] Fix `@macrocallback` definitions with a `when` clause
* [Path] Fix `Path.absname/1` to correctly handle UNC paths on Windows
* [Stream] Close with correct accumulator in `Stream.resource/3` when called for a single-element list
* [Stream] Allow `Stream.cycle/1` to be double nested inside `Stream.cycle/1`
* [URI] Preserve slashes in URIs without authority
* [URI] Require a nil or an absolute path on URIs with host or authority
* [Code] Quote `::` in `Code.format_string!/1` to avoid ambiguity
* [Code] Do not crash formatter on false positive sigils
* [Enum] Ensure the first equal entry is returned by `Enum.min/2` and `Enum.max/2`
* [Kernel] Improve error message when string interpolation is used in a guard
* [Kernel] Properly merge and handle docs for callbacks with multiple clauses
* [Kernel] Guarantee reproducible builds on modules with dozens of specs
* [Kernel] Resolve `__MODULE__` accordingly in nested `defmodule` to avoid double nesting
* [Kernel] Type variables starting with an underscore (`_foo`) should not raise compile error
* [Kernel] Keep order of elements when macro `in/2` is expanded with a literal list on the right-hand side
* [Kernel] Print proper location on undefined function error from dynamically generated functions
* [Kernel] **Potentially breaking** Do not leak aliases when nesting module definitions that are fully namespaced modules. If you defined `defmodule Elixir.Foo.Bar` inside `defmodule Foo`, previous Elixir versions would automatically define an alias, but fully namespaced modules such as `Elixir.Foo.Bar` should never define or require an alias. If you were accidentally relying on this broken behaviour, your code may no longer work
* [System] Make sure `:init.get_status/0` is set to `{:started, :started}` once the system starts
* [Path] Do not expand `~` in `Path.expand/2` when not followed by a path separator
* [Protocol] Ensure `debug_info` is kept in protocols
* [Regex] Ensure inspect returns valid `~r//` expressions when they are manually compiled with backslashes
* [Registry] Fix ETS leak in `Registry.register/2` for already registered calls in unique registries while the process is still alive
#### ExUnit
* [ExUnit.Assertions] Fix `assert_receive` and `assert match?` to behave consistently compared `receive` and `match?` when given an invalid macro
* [ExUnit] Raise error if attempting to run single line tests on multiple files
* [ExUnit] Return proper error on duplicate child IDs on `start_supervised`
#### IEx
* [IEx] Exit IEx session if the group leader exits
* [IEx] Allow `pry` to be used in non-tty terminals
* [IEx] Automatically shut down IEx if we receive EOF
#### Logger
* [Logger] Don't discard Logger messages from other nodes as to leave a trail on both systems
#### Mix
* [mix compile] Do not filter out warning for external files from diagnostics
* [Mix.Project] Ensure user given `:manager` to dependencies has higher precedence than the SCM one
* [Mix.Project] Recompile umbrella children when config files change and `mix compile` is called from the umbrella root
* [Mix.Task] Always recompile before running tasks from dependencies
* [Mix.Task] Ensure project's Logger config is used when running Mix tasks
* [mix compile] Ensure Erlang-based Mix compilers (erlang, leex, yecc) set valid position on diagnostics
* [mix compile] Ensure compilation halts in an umbrella project if one of the siblings fail to compile
* [mix deps] Raise an error if the umbrella app's dir name and `mix.exs` app name don't match
* [mix deps.compile] Fix subcommand splitting bug in rebar3
* [mix test] Do not consider modules that are no longer cover compiled when computing coverage report, which could lead to flawed reports
### 3. Soft-deprecations (no warnings emitted)
#### Elixir
* [Code] `compiler_options/0` is deprecated in favor of `compiler_option/1`
#### Mix
* [Mix.Config] `Mix.Config.persist/1` has been deprecated. Instead of `Mix.Config.persist(config)` use `Application.put_all_env(config, persistent: true)` (`Application.put_all_env/2` was added in v1.9)
* [mix xref] `calls/0` is deprecated in favor of compiler tracer
* [mix xref] The `xref.exclude` option has been moved to `elixirc_options.no_warn_undefined` as the `xref` pass has been moved into the compiler
* [Mix.Config] `Mix.Config` has been deprecated in favor of the `Config` module that now ships as part of Elixir itself. Reading configuration files should now be done by the `Config.Reader` module
### 4. Hard-deprecations
#### Elixir
* [Code] `Code.load_file/2` has been deprecated in favor of `Code.require_file/2` or `Code.compile_file/2`
* [Code] `Code.loaded_files/0` and `Code.unload_file/1` have been deprecated in favor of `Code.required_files/0` and `Code.unrequire_file/1` respectively
* [Code] `Code.ensure_compiled?/1` is deprecated in favor of `Code.ensure_compiled/1`
* [String] `String.normalize/2` has been deprecated in favor of `:unicode.characters_to_nfc_binary/1` or `:unicode.characters_to_nfd_binary/1` which ship as part of Erlang/OTP 20+
* [Supervisor] `Supervisor.Spec.supervise/2` has been deprecated in favor of the new Supervisor child specification
* [Supervisor] The `:simple_one_for_one` strategy in `Supervisor` has been deprecated in favor of `DynamicSupervisor`
#### Logger
* [Logger] `:compile_time_purge_level` application environment configuration has been deprecated in favor of the more general `:compile_time_purge_matching` config
* [Logger] Deprecate logging non-chardata values
* [CLI] Deprecate `--detached` option, use `--erl "-detached"` instead
* [Map] Deprecate Enumerable keys in `Map.drop/2`, `Map.split/2`, and `Map.take/2`
* [String] The `:insert_replaced` option in `String.replace/4` has been deprecated. Instead you may pass a function as a replacement or use `:binary.replace/4` if you need to support earlier Elixir versions
#### Mix
* [mix compile.xref] This check has been moved into the compiler and has no effect now
* [mix xref] `xref` now only tracks dependencies between modules and files, no longer between functions. See "Compilation tracers" to learn more about how to track this information directly
* [mix xref deprecations] This check has been moved into the compiler and has no effect now
* [mix xref unreachable] This check has been moved into the compiler and has no effect now
* [Mix.Project] Deprecate `Mix.Project.load_paths/1` in favor of `Mix.Project.compile_path/1`
## v1.9
## v1.8
The CHANGELOG for v1.9 releases can be found [in the v1.9 branch](https://github.com/elixir-lang/elixir/blob/v1.9/CHANGELOG.md).
The CHANGELOG for v1.8 releases can be found [in the v1.8 branch](https://github.com/elixir-lang/elixir/blob/v1.8/CHANGELOG.md).
+13 -28
View File
@@ -1,8 +1,7 @@
PREFIX ?= /usr/local
TEST_FILES ?= "*_test.exs"
SHARE_PREFIX ?= $(PREFIX)/share
MAN_PREFIX ?= $(SHARE_PREFIX)/man
CANONICAL := v1.10/ # master/ or vMAJOR.MINOR/
CANONICAL := v1.9/ # master/ or vMAJOR.MINOR/
ELIXIRC := bin/elixirc --verbose --ignore-module-conflict $(ELIXIRC_OPTS)
ERLC := erlc -I lib/elixir/include $(ERLC_OPTS)
ERL := erl -I lib/elixir/include -noshell -pa lib/elixir/ebin
@@ -20,15 +19,15 @@ GIT_TAG = $(strip $(shell head="$(call GIT_REVISION)"; git tag --points-at $$hea
SOURCE_DATE_EPOCH_PATH = lib/elixir/tmp/ebin_reproducible
SOURCE_DATE_EPOCH_FILE = $(SOURCE_DATE_EPOCH_PATH)/SOURCE_DATE_EPOCH
.PHONY: install compile erlang elixir unicode app build_plt clean_plt dialyze test check_reproducible clean clean_residual_files format install_man clean_man docs Docs.zip Precompiled.zip zips
.PHONY: install compile erlang elixir unicode app build_plt clean_plt dialyze test check_reproducible clean clean_residual_files install_man clean_man docs Docs.zip Precompiled.zip zips
.NOTPARALLEL: compile
#==> Functions
define CHECK_ERLANG_RELEASE
erl -noshell -eval '{V,_} = string:to_integer(erlang:system_info(otp_release)), io:fwrite("~s", [is_integer(V) and (V >= 21)])' -s erlang halt | grep -q '^true'; \
erl -noshell -eval '{V,_} = string:to_integer(erlang:system_info(otp_release)), io:fwrite("~s", [is_integer(V) and (V >= 20)])' -s erlang halt | grep -q '^true'; \
if [ $$? != 0 ]; then \
echo "At least Erlang/OTP 21.0 is required to build Elixir"; \
echo "At least Erlang/OTP 20.0 is required to build Elixir"; \
exit 1; \
fi
endef
@@ -46,7 +45,7 @@ lib/$(1)/ebin/Elixir.$(2).beam: $(wildcard lib/$(1)/lib/*.ex) $(wildcard lib/$(1
test_$(1): compile $(1)
@ echo "==> $(1) (ex_unit)"
$(Q) cd lib/$(1) && ../../bin/elixir -r "test/test_helper.exs" -pr "test/**/$(TEST_FILES)";
$(Q) cd lib/$(1) && ../../bin/elixir -r "test/test_helper.exs" -pr "test/**/*_test.exs";
endef
define WRITE_SOURCE_DATE_EPOCH
@@ -90,9 +89,10 @@ $(KERNEL): lib/elixir/lib/*.ex lib/elixir/lib/*/*.ex lib/elixir/lib/*/*/*.ex
echo "==> bootstrap (compile)"; \
$(ERL) -s elixir_compiler bootstrap -s erlang halt; \
fi
$(Q) $(MAKE) unicode
@ echo "==> elixir (compile)";
$(Q) cd lib/elixir && ../../$(ELIXIRC) "lib/kernel.ex" -o ebin;
$(Q) cd lib/elixir && ../../$(ELIXIRC) "lib/**/*.ex" -o ebin;
$(Q) $(MAKE) unicode
$(Q) $(MAKE) app
app: $(APP)
@@ -133,13 +133,11 @@ check_reproducible: compile
$(call WRITE_SOURCE_DATE_EPOCH)
$(Q) mkdir -p lib/elixir/tmp/ebin_reproducible/ \
lib/eex/tmp/ebin_reproducible/ \
lib/ex_unit/tmp/ebin_reproducible/ \
lib/iex/tmp/ebin_reproducible/ \
lib/logger/tmp/ebin_reproducible/ \
lib/mix/tmp/ebin_reproducible/
$(Q) mv lib/elixir/ebin/* lib/elixir/tmp/ebin_reproducible/
$(Q) mv lib/eex/ebin/* lib/eex/tmp/ebin_reproducible/
$(Q) mv lib/ex_unit/ebin/* lib/ex_unit/tmp/ebin_reproducible/
$(Q) mv lib/iex/ebin/* lib/iex/tmp/ebin_reproducible/
$(Q) mv lib/logger/ebin/* lib/logger/tmp/ebin_reproducible/
$(Q) mv lib/mix/ebin/* lib/mix/tmp/ebin_reproducible/
@@ -147,7 +145,6 @@ check_reproducible: compile
$(Q) echo "Diffing..."
$(Q) diff -r lib/elixir/ebin/ lib/elixir/tmp/ebin_reproducible/
$(Q) diff -r lib/eex/ebin/ lib/eex/tmp/ebin_reproducible/
$(Q) diff -r lib/ex_unit/ebin/ lib/ex_unit/tmp/ebin_reproducible/
$(Q) diff -r lib/iex/ebin/ lib/iex/tmp/ebin_reproducible/
$(Q) diff -r lib/logger/ebin/ lib/logger/tmp/ebin_reproducible/
$(Q) diff -r lib/mix/ebin/ lib/mix/tmp/ebin_reproducible/
@@ -176,16 +173,16 @@ clean_residual_files:
#==> Documentation tasks
LOGO_PATH = $(shell test -f ../docs/logo.png && echo "--logo ../docs/logo.png")
SOURCE_REF = $(shell tag="$(call GIT_TAG)" revision="$(call GIT_REVISION)"; echo "$${tag:-$$revision}")
SOURCE_REF = $(shell tag="$(call GIT_TAG)" revision="$(call GIT_REVISION)"; echo "$${tag:-$$revision}\c")
DOCS_FORMAT = html
COMPILE_DOCS = bin/elixir ../ex_doc/bin/ex_doc "$(1)" "$(VERSION)" "lib/$(2)/ebin" --main "$(3)" --source-url "https://github.com/elixir-lang/elixir" --source-ref "$(call SOURCE_REF)" $(call LOGO_PATH) --output doc/$(2) --canonical "https://hexdocs.pm/$(2)/$(CANONICAL)" --homepage-url "https://elixir-lang.org/docs.html" --formatter "$(DOCS_FORMAT)" $(4)
COMPILE_DOCS = bin/elixir ../ex_doc/bin/ex_doc "$(1)" "$(VERSION)" "lib/$(2)/ebin" -m "$(3)" -u "https://github.com/elixir-lang/elixir" --source-ref "$(call SOURCE_REF)" $(call LOGO_PATH) -o doc/$(2) -n https://hexdocs.pm/$(2)/$(CANONICAL) -p https://elixir-lang.org/docs.html -f "$(DOCS_FORMAT)" $(4)
docs: compile ../ex_doc/bin/ex_doc docs_elixir docs_eex docs_mix docs_iex docs_ex_unit docs_logger
docs_elixir: compile ../ex_doc/bin/ex_doc
@ echo "==> ex_doc (elixir)"
$(Q) rm -rf doc/elixir
$(call COMPILE_DOCS,Elixir,elixir,Kernel,--config "lib/elixir/docs.exs")
$(call COMPILE_DOCS,Elixir,elixir,Kernel,-c lib/elixir/docs.exs)
docs_eex: compile ../ex_doc/bin/ex_doc
@ echo "==> ex_doc (eex)"
@@ -240,7 +237,6 @@ zips: Precompiled.zip Docs.zip
#==> Test tasks
# If you modify this task, please update .cirrus.yml accordingly
test: test_formatted test_erlang test_elixir
test_windows: test test_taskkill
@@ -253,19 +249,8 @@ TEST_ERL = lib/elixir/test/erlang
TEST_EBIN = lib/elixir/test/ebin
TEST_ERLS = $(addprefix $(TEST_EBIN)/, $(addsuffix .beam, $(basename $(notdir $(wildcard $(TEST_ERL)/*.erl)))))
define FORMAT
$(Q) if [ "$(OS)" = "Windows_NT" ]; then \
cmd //C call ./bin/mix.bat format $(1); \
else \
bin/elixir bin/mix format $(1); \
fi
endef
format: compile
$(call FORMAT)
test_formatted: compile
$(call FORMAT,--check-formatted)
bin/elixir bin/mix format --check-formatted
test_erlang: compile $(TEST_ERLS)
@ echo "==> elixir (eunit)"
@@ -282,9 +267,9 @@ test_stdlib: compile
@ echo "==> elixir (ex_unit)"
$(Q) exec epmd & exit
$(Q) if [ "$(OS)" = "Windows_NT" ]; then \
cd lib/elixir && cmd //C call ../../bin/elixir.bat -r "test/elixir/test_helper.exs" -pr "test/elixir/**/$(TEST_FILES)"; \
cd lib/elixir && cmd //C call ../../bin/elixir.bat -r "test/elixir/test_helper.exs" -pr "test/elixir/**/*_test.exs"; \
else \
cd lib/elixir && ../../bin/elixir -r "test/elixir/test_helper.exs" -pr "test/elixir/**/$(TEST_FILES)"; \
cd lib/elixir && ../../bin/elixir -r "test/elixir/test_helper.exs" -pr "test/elixir/**/*_test.exs"; \
fi
#==> Dialyzer tasks
+10 -8
View File
@@ -1,6 +1,8 @@
![Elixir](https://github.com/elixir-lang/elixir-lang.github.com/raw/master/images/logo/logo.png)
=========
[![Build status](https://api.cirrus-ci.com/github/elixir-lang/elixir.svg?branch=master)](https://cirrus-ci.com/github/elixir-lang/elixir)
[![Travis build](https://secure.travis-ci.org/elixir-lang/elixir.svg?branch=master
"Build Status")](https://travis-ci.org/elixir-lang/elixir)
[![Windows build](https://ci.appveyor.com/api/projects/status/macwuxq7aiiv61g1?svg=true)](https://ci.appveyor.com/project/josevalim/elixir)
Elixir is a dynamic, functional language designed for building scalable
and maintainable applications.
@@ -48,10 +50,10 @@ If Elixir fails to build (specifically when pulling in a new version via
If tests pass, you can use Interactive Elixir by running `bin/iex` in your terminal.
However, if tests fail, it is likely that you have an outdated Erlang/OTP version
(Elixir requires Erlang/OTP 21.0 or later). You can check your Erlang/OTP version
by calling `erl` in the command line. You will see some information similar to:
(Elixir requires Erlang/OTP 20.0 or later). You can check your Erlang/OTP version
by calling `erl` in the command line. You will see some information as follows:
Erlang/OTP 21 [erts-9.0] [smp:2:2] [async-threads:10] [kernel-poll:false]
Erlang/OTP 20 [erts-9.0] [smp:2:2] [async-threads:10] [kernel-poll:false]
If you have properly set up your dependencies and tests still fail,
you may want to open up a bug report, as explained next.
@@ -110,7 +112,7 @@ To recompile (including Erlang modules):
make compile
```
After your changes are done, please remember to run `make format` to guarantee
After your changes are done, please remember to run `mix format` to guarantee
all files are properly formatted and then run the full suite with
`make test`.
@@ -123,7 +125,7 @@ make clean_elixir compile
Similarly, if you can't get Elixir to compile or the tests to pass after
updating an existing checkout, run `make clean compile`. You can check
[the official build status on Cirrus CI](https://cirrus-ci.com/github/elixir-lang/elixir).
[the official build status on Travis-CI](https://travis-ci.org/elixir-lang/elixir).
More tasks can be found by reading the [Makefile](Makefile).
With tests running and passing, you are ready to contribute to Elixir and
@@ -177,8 +179,8 @@ make docs # to generate HTML pages
make docs DOCS_FORMAT=epub # to generate EPUB documents
```
This will produce documentation sets for `elixir`, `eex`, `ex_unit`, `iex`, `logger`,
and `mix` under the `doc` directory. If you are planning to contribute documentation,
This will produce documentation sets for `elixir`, `mix`, etc. under
the `doc` directory. If you are planning to contribute documentation,
[please check our best practices for writing documentation](https://hexdocs.pm/elixir/writing-documentation.html).
## Development links
+2 -2
View File
@@ -20,7 +20,7 @@
9. Publish new zips with `make zips`, upload `Precompiled.zip` and `Docs.zip` to GitHub Releases, and include SHAs+CHANGELOG
10. Add the release to `elixir.csv` (all releases), update `erlang.csv` to the precompiled OTP version, and `_data/elixir-versions.yml` (except for RCs) files in `elixir-lang/elixir-lang.github.com`
10. Add the release to `elixir.csv` (all releases) and `_data/elixir-versions.yml` (except for RCs) files in `elixir-lang/elixir-lang.github.com`
11. Send an e-mail to elixir-lang-ann@googlegroups.com with title "Elixir vVERSION released". The body should be a link to the Release page on GitHub and the checksums. If it is a security release, prefix the title with the `[security]` tag
@@ -40,6 +40,6 @@
2. Start new /CHANGELOG.md
3. Update tables in /SECURITY.md in "Compatibility and Deprecations"
3. Update tables in "Compatibility and Deprecations"
4. Commit "Start vMAJOR.MINOR+1"
+2 -2
View File
@@ -6,11 +6,11 @@ Elixir applies bug fixes only to the latest minor branch. Security patches are a
| Elixir version | Support
| -------------- | ------------------------------
| 1.10 | Bug fixes and security patches
| 1.9 | Security patches only
| 1.9 | Bug fixes and security patches
| 1.8 | Security patches only
| 1.7 | Security patches only
| 1.6 | Security patches only
| 1.5 | Security patches only
## Announcements
+1 -1
View File
@@ -1 +1 @@
1.10.4
1.9.4
+18 -20
View File
@@ -2,23 +2,22 @@
set -e
if [ $# -eq 0 ] || [ "$1" = "--help" ] || [ "$1" = "-h" ]; then
cat <<USAGE >&2
Usage: $(basename "$0") [options] [.exs file] [data]
echo "Usage: $(basename "$0") [options] [.exs file] [data]
## General options
-e "COMMAND" Evaluates the given command (*)
-e \"COMMAND\" Evaluates the given command (*)
-h, --help Prints this message and exits
-r "FILE" Requires the given files/patterns (*)
-r \"FILE\" Requires the given files/patterns (*)
-S SCRIPT   Finds and executes the given script in \$PATH
-pr "FILE" Requires the given files/patterns in parallel (*)
-pa "PATH" Prepends the given path to Erlang code path (*)
-pz "PATH" Appends the given path to Erlang code path (*)
-pr \"FILE\" Requires the given files/patterns in parallel (*)
-pa \"PATH\" Prepends the given path to Erlang code path (*)
-pz \"PATH\" Appends the given path to Erlang code path (*)
-v, --version Prints Elixir version and exits
--app APP Starts the given app and its dependencies (*)
--erl "SWITCHES" Switches to be passed down to Erlang (*)
--eval "COMMAND" Evaluates the given command, same as -e (*)
--erl \"SWITCHES\" Switches to be passed down to Erlang (*)
--eval \"COMMAND\" Evaluates the given command, same as -e (*)
--logger-otp-reports BOOL Enables or disables OTP reporting
--logger-sasl-reports BOOL Enables or disables SASL reporting
--no-halt Does not halt the Erlang VM after execution
@@ -34,25 +33,24 @@ The following options are related to node distribution.
--cookie COOKIE Sets a cookie for this distributed node
--hidden Makes a hidden node
--name NAME Makes and assigns a name to the distributed node
--rpc-eval NODE "COMMAND" Evaluates the given command on the given remote node (*)
--rpc-eval NODE \"COMMAND\" Evaluates the given command on the given remote node (*)
--sname NAME Makes and assigns a short name to the distributed node
## Release options
The following options are generally used under releases.
--boot "FILE" Uses the given FILE.boot to start the system
--boot-var VAR "VALUE" Makes \$VAR available as VALUE to FILE.boot (*)
--erl-config "FILE" Loads configuration in FILE.config written in Erlang (*)
--pipe-to "PIPEDIR" "LOGDIR" Starts the Erlang VM as a named PIPEDIR and LOGDIR
--vm-args "FILE" Passes the contents in file as arguments to the VM
--boot \"FILE\" Uses the given FILE.boot to start the system
--boot-var VAR \"VALUE\" Makes \$VAR available as VALUE to FILE.boot (*)
--erl-config \"FILE\" Loads configuration in FILE.config written in Erlang (*)
--pipe-to \"PIPEDIR\" \"LOGDIR\" Starts the Erlang VM as a named PIPEDIR and LOGDIR
--vm-args \"FILE\" Passes the contents in file as arguments to the VM
--pipe-to starts Elixir detached from console (Unix-like only).
It will attempt to create PIPEDIR and LOGDIR if they don't exist.
See run_erl to learn more. To reattach, run: to_erl PIPEDIR.
** Options marked with (*) can be given more than once.
USAGE
** Options marked with (*) can be given more than once." >&2
exit 1
fi
@@ -66,7 +64,7 @@ readlink_f () {
fi
}
# Stores static Erlang arguments and --erl (which is passed as is)
# Stores static erlang arguments and --erl (which is passed as is)
ERL=""
# Stores erl arguments preserving spaces/quotes (mimics an array)
@@ -206,7 +204,7 @@ SCRIPT_PATH=$(dirname "$SELF")
if [ "$OSTYPE" = "cygwin" ]; then SCRIPT_PATH=$(cygpath -m "$SCRIPT_PATH"); fi
if [ "$MODE" != "iex" ]; then ERL="-noshell -s elixir start_cli $ERL"; fi
if [ "$OS" != "Windows_NT" ] && [ -z "$NO_COLOR" ]; then
if [ "$OS" != "Windows_NT" ]; then
if test -t 1 -a -t 2; then ERL="-elixir ansi_enabled true $ERL"; fi
fi
@@ -228,4 +226,4 @@ if [ -n "$ELIXIR_CLI_DRY_RUN" ]; then
echo "$@"
else
exec "$@"
fi
fi
+2 -4
View File
@@ -2,8 +2,7 @@
set -e
if [ $# -eq 0 ] || [ "$1" = "--help" ] || [ "$1" = "-h" ]; then
cat <<USAGE >&2
Usage: $(basename "$0") [elixir switches] [compiler switches] [.ex files]
echo "Usage: $(basename "$0") [elixir switches] [compiler switches] [.ex files]
-h, --help Prints this message and exits
-o The directory to output compiled files
@@ -17,8 +16,7 @@ Usage: $(basename "$0") [elixir switches] [compiler switches] [.ex files]
Options given after -- are passed down to the executed code.
Options can be passed to the Erlang runtime using \$ELIXIR_ERL_OPTIONS.
Options can be passed to the Erlang compiler using \$ERL_COMPILER_OPTIONS.
USAGE
Options can be passed to the Erlang compiler using \$ERL_COMPILER_OPTIONS." >&2
exit 1
fi
+3 -5
View File
@@ -2,17 +2,15 @@
set -e
if [ "$1" = "--help" ] || [ "$1" = "-h" ]; then
cat <<USAGE >&2
Usage: $(basename "$0") [options] [.exs file] [data]
echo "Usage: $(basename "$0") [options] [.exs file] [data]
The following options are exclusive to IEx:
--dot-iex "PATH" Overrides default .iex.exs file and uses path instead;
--dot-iex \"PATH\" Overrides default .iex.exs file and uses path instead;
path can be empty, then no file will be loaded
--remsh NAME Connects to a node using a remote shell
It accepts all other options listed by "elixir --help".
USAGE
It accepts all other options listed by \"elixir --help\"." >&2
exit 1
fi
+2 -2
View File
@@ -1,3 +1,3 @@
#!/usr/bin/env elixir
Mix.start()
Mix.CLI.main()
Mix.start
Mix.CLI.main
-6
View File
@@ -76,12 +76,6 @@ defmodule EEx do
This will never appear
<% end %>
To escape an EEx expression in EEx use `<%% content %>`. For example:
<%%= x + 3 %>
will be rendered as `<%= x + 3 %>`.
Notice that different engines may have different rules
for each tag. Other tags may be added in future versions.
+1 -1
View File
@@ -149,7 +149,7 @@ defmodule EEx.Compiler do
{count, new_state}
end
# Look middle expressions that immediately follow a start_expr
# Look middle expressions that immediatelly follow a start_expr
defp look_ahead_middle(
[{:text, text}, {:middle_expr, line, _, chars, _} | rest] = tokens,
-4
View File
@@ -63,7 +63,6 @@ defmodule EEx.Tokenizer do
{:ok, expr, new_line, rest} ->
token = token_name(expr)
{trimmed?, rest, new_line, buffer} = trim_if_needed(rest, new_line, opts, buffer, acc)
expr = pad_if_needed(token, expr, trimmed?)
acc = tokenize_text(buffer, acc)
final = {token, line, marker, Enum.reverse(expr), trimmed?}
tokenize(rest, new_line, opts, [], [final | acc])
@@ -240,7 +239,4 @@ defmodule EEx.Tokenizer do
defp trim_whitespace(list) do
list
end
defp pad_if_needed(:start_expr, [h | _] = expr, true) when h not in @spaces, do: [?\s | expr]
defp pad_if_needed(_, expr, _), do: expr
end
+2 -1
View File
@@ -1,7 +1,8 @@
Code.require_file("../test_helper.exs", __DIR__)
defmodule EEx.SmartEngineTest do
use ExUnit.Case, async: true
# TODO: Make this async: true once capture_io is removed
use ExUnit.Case
test "evaluates simple string" do
assert_eval("foo bar", "foo bar")
+1 -29
View File
@@ -64,20 +64,6 @@ defmodule EExTest do
assert_eval(" • • •\n Jößé Vâlìm Jößé Vâlìm\n", template)
end
test "no spaces" do
string = """
<%=cond do%>
<%false ->%>
this
<%true ->%>
that
<%end%>
"""
expected = "\n that\n\n"
assert_eval(expected, string, [])
end
test "trim mode" do
string = "<%= 123 %> \n456\n <%= 789 %>"
expected = "123456\n789"
@@ -110,20 +96,6 @@ defmodule EExTest do
assert_eval(expected, string, [], trim: true)
end
test "trim mode with no spaces" do
string = """
<%=cond do%>
<%false ->%>
this
<%true ->%>
that
<%end%>
"""
expected = " that\n"
assert_eval(expected, string, [], trim: true)
end
test "embedded code" do
assert_eval("foo bar", "foo <%= :bar %>")
end
@@ -140,7 +112,7 @@ defmodule EExTest do
assert_eval("foo ", "foo <%= if false do %>bar<% end %>")
end
test "embedded code with do preceded by bracket" do
test "embedded code with do preceeded by bracket" do
assert_eval("foo bar", "foo <%= if {true}do %>bar<% end %>")
assert_eval("foo bar", "foo <%= if (true)do %>bar<% end %>")
assert_eval("foo bar", "foo <%= if [true]do %>bar<% end %>")
+1 -1
View File
@@ -10,4 +10,4 @@ main([Source, Target, Version]) ->
Props = lists:keyreplace(vsn, 1, Props1, {vsn, Version}),
AppDef = io_lib:format("~tp.~n", [{application, Name, Props}]),
ok = file:write_file(Target, AppDef),
io:format("Generated ~ts app~n", [Name]).
io:format("Generated ~ts.app~n", [Name]).
-27
View File
@@ -236,25 +236,6 @@ defmodule Access do
:error
end
@doc """
Same as `fetch/2` but returns the value directly,
or raises a `KeyError` exception if `key` is not found.
## Examples
iex> Access.fetch!(%{name: "meg", age: 26}, :name)
"meg"
"""
@doc since: "1.10.0"
@spec fetch!(container, term) :: term
def fetch!(container, key) do
case fetch(container, key) do
{:ok, value} -> value
:error -> raise(KeyError, key: key, term: container)
end
end
@doc """
Gets the value for the given key in a container (a map, keyword
list, or struct that implements the `Access` behaviour).
@@ -329,14 +310,6 @@ defmodule Access do
The returned value is a two-element tuple with the "get" value returned by
`fun` and a new container with the updated value under `key`.
## Examples
iex> Access.get_and_update([a: 1], :a, fn current_value ->
...> {current_value, current_value + 1}
...> end)
{1, [a: 2]}
"""
@spec get_and_update(data, key, (value -> {get_value, value} | :pop)) :: {get_value, data}
when get_value: var, data: container
+1 -28
View File
@@ -201,7 +201,7 @@ defmodule Agent do
@doc false
defmacro __using__(opts) do
quote location: :keep, bind_quoted: [opts: opts] do
unless Module.has_attribute?(__MODULE__, :doc) do
if Module.get_attribute(__MODULE__, :doc) == nil do
@doc """
Returns a specification to start this module under a supervisor.
@@ -423,15 +423,6 @@ defmodule Agent do
Same as `update/3` but a module, function, and arguments are expected
instead of an anonymous function. The state is added as first
argument to the given list of arguments.
## Examples
iex> {:ok, pid} = Agent.start_link(fn -> 42 end)
iex> Agent.update(pid, Kernel, :+, [12])
:ok
iex> Agent.get(pid, fn state -> state end)
54
"""
@spec update(agent, module, atom, [term], timeout) :: :ok
def update(agent, module, fun, args, timeout \\ 5000) do
@@ -447,15 +438,6 @@ defmodule Agent do
Note that `cast` returns `:ok` immediately, regardless of whether `agent` (or
the node it should live on) exists.
## Examples
iex> {:ok, pid} = Agent.start_link(fn -> 42 end)
iex> Agent.cast(pid, fn state -> state + 1 end)
:ok
iex> Agent.get(pid, fn state -> state end)
43
"""
@spec cast(agent, (state -> state)) :: :ok
def cast(agent, fun) when is_function(fun, 1) do
@@ -468,15 +450,6 @@ defmodule Agent do
Same as `cast/2` but a module, function, and arguments are expected
instead of an anonymous function. The state is added as first
argument to the given list of arguments.
## Examples
iex> {:ok, pid} = Agent.start_link(fn -> 42 end)
iex> Agent.cast(pid, Kernel, :+, [12])
:ok
iex> Agent.get(pid, fn state -> state end)
54
"""
@spec cast(agent, module, atom, [term]) :: :ok
def cast(agent, module, fun, args) do
+94 -280
View File
@@ -8,120 +8,78 @@ defmodule Application do
An application is a component implementing some specific functionality, with a
standardized directory structure, configuration, and lifecycle. Applications
are *loaded*, *started*, and *stopped*. Each application also has its own
environment, which provides a unified API for configuring each application.
are *loaded*, *started*, and *stopped*.
Developers typically interact with the application environment and its
callback module. Therefore those will be the topics we will cover first
before jumping into details about the application resource file and life-cycle.
## The application resource file
Applications are specified in their [*resource
file*](http://erlang.org/doc/man/app.html), which is a file called `APP.app`,
where `APP` is the application name. For example, the application resource
file of the OTP application `ex_unit` is called `ex_unit.app`.
You'll find the resource file of an application in its `ebin` directory, it is
generated automatically by Mix. Some of its keys are taken from the keyword
lists returned by the `project/0` and `application/0` functions defined in
`mix.exs`, and others are generated by Mix itself.
You can learn more about the generation of application resource files in the
documentation of `Mix.Tasks.Compile.App`, available as well by running
`mix help compile.app`.
## The application environment
Each application has its own environment. The environment is a keyword list
that maps atoms to terms. Note that this environment is unrelated to the
operating system environment.
The key `env` of an application resource file has a list of tuples that map
atoms to terms, and its contents are known as the application *environment*.
Note that this environment is unrelated to the operating system environment.
By default, the environment of an application is an empty list. In a Mix
project's `mix.exs` file, you can set the `:env` key in `application/0`:
project you can set that key in `application/0`:
def application do
[env: [db_host: "localhost"]]
[env: [redis_host: "localhost"]]
end
Now, in your application, you can read this environment by using functions
such as `fetch_env!/2` and friends:
and the generated application resource file is going to have it included.
defmodule MyApp.DBClient do
def start_link() do
SomeLib.DBClient.start_link(host: db_host())
end
The environment is available after loading the application, which is a process
explained later:
defp db_host do
Application.fetch_env!(:my_app, :db_host)
end
end
Application.load(:APP_NAME)
#=> :ok
Application.get_env(:APP_NAME, :redis_host)
#=> "localhost"
In Mix projects, the environment of the application and its dependencies can
be overridden via the `config/config.exs` file. For example, someone using
your application can override its `:db_host` environment variable as follows:
be overridden via the `config/config.exs` file. If you start the application
with Mix, that configuration is available at compile time, and at runtime too,
but take into account it is not included in the generated application resource
file, and it is not available if you start the application without Mix.
import Config
config :my_app, :db_host, "db.local"
For example, someone using your application can override its `:redis_host`
environment variable as follows:
You can also change the application environment dynamically by using functions
such as `put_env/3` and `delete_env/2`. However, as a rule of thumb, each application
is responsible for its own environment. Please do not use the functions in this
module for directly accessing or modifying the environment of other applications.
config :APP_NAME, redis_host: "redis.local"
### Compile-time environment
The function `put_env/3` allows dynamic configuration of the application
environment, but as a rule of thumb each application is responsible for its
own environment. Please do not use the functions in this module for directly
accessing or modifying the environment of other applications.
In the previous example, we read the application environment at runtime:
defmodule MyApp.DBClient do
def start_link() do
SomeLib.DBClient.start_link(host: db_host())
end
defp db_host do
Application.fetch_env!(:my_app, :db_host)
end
end
In other words, the environment key `:db_host` for application `:my_app`
will only be read when `MyApp.DBClient` effectively starts. While reading
the application environment at runtime is the preferred approach, in some
rare occasions you may want to use the application environment to configure
the compilation of a certain project. This is often done by calling `get_env/3`
outside of a function:
defmodule MyApp.DBClient do
@db_host Application.get_env(:my_app, :db_host, "db.local")
def start_link() do
SomeLib.DBClient.start_link(host: @db_host)
end
end
This approach has one big limitation: if you change the value of the
application environment after the code is compiled, the value used at
runtime is not going to change! For example, if you are using `mix release`
and your `config/releases.exs` has:
config :my_app, :db_host, "db.production"
This value will have no effect as the code was compiled to connect to "db.local",
which is mostly likely unavailable in the production environment.
For those reasons, reading the application environment at runtime should be the
first choice. However, if you really have to read the application environment
during compilation, we recommend you to use `compile_env/3` instead:
@db_host Application.compile_env(:my_app, :db_host, "db.local")
By using `compile_env/3`, tools like Mix will store the values used during
compilation and compare the compilation values with the runtime values whenever
your system starts, raising an error in case they differ.
The application environment can be overridden via the `-config` option of
`erl`, as well as command-line options, as we are going to see below.
## The application callback module
Applications can be loaded, started, and stopped. Generally, build tools
like Mix take care of starting an application and all of its dependencies
for you, but you can also do it manually by calling:
{:ok, _} = Application.ensure_all_started(:some_app)
When an application starts, developers may configure a callback module
that executes custom code. Developers use this callback to start the
application supervision tree.
The first step to do so is to add a `:mod` key to the `application/0`
definition in your `mix.exs` file. It expects a tuple, with the application
callback module and start argument (commonly an empty list):
The `mod` key of an application resource file configures an application
callback module and start argument:
def application do
[mod: {MyApp, []}]
end
This key is optional, only needed for applications that start a supervision tree.
The `MyApp` module given to `:mod` needs to implement the `Application` behaviour.
This can be done by putting `use Application` in that module and implementing the
`c:start/2` callback, for example:
@@ -158,19 +116,6 @@ defmodule Application do
tree is terminated. Its argument is the state returned by `c:start/2`, if it did,
or `[]` otherwise, and its return value is passed to `c:stop/1`.
## The application resource file
In the sections above, we have configured an application in the
`application/0` section of the `mix.exs` file. Ultimately, Mix will use
this configuration to create an [*application resource
file*](http://erlang.org/doc/man/app.html), which is a file called
`APP_NAME.app`. For example, the application resource file of the OTP
application `ex_unit` is called `ex_unit.app`.
You can learn more about the generation of application resource files in
the documentation of `Mix.Tasks.Compile.App`, available as well by running
`mix help compile.app`.
## The application lifecycle
### Loading applications
@@ -181,8 +126,16 @@ defmodule Application do
Application.load(:ex_unit)
#=> :ok
If an application has included applications, they are also loaded. And the
procedure recurses if they in turn have included applications. Included
applications are unrelated to applications in Mix umbrella projects, they are
an Erlang/OTP concept that has to do with coordinated starts.
When an application is loaded, the environment specified in its resource file
is merged with any overrides from config files.
is merged with any overrides from config files passed to `erl` via the
`-config` option. It is worth highlighting that releases pass `sys.config`
this way. The resulting environment can still be overridden again via specific
`-Application` options passed to `erl`.
Loading an application *does not* load its modules.
@@ -202,12 +155,14 @@ defmodule Application do
system. Instead, you start one or more applications, each with their own
initialization and termination logic.
When an application is started, the `Application.load/1` is automatically
invoked if it hasn't been done yet. Then, it checks if the dependencies listed
in the `applications` key of the resource file are already started. Having at
least one dependency not started is an error condition. Functions like
`ensure_all_started/1` takes care of starting an application and all of its
dependencies for you.
When an application is started, the runtime loads it if it hasn't been loaded
yet (in the technical sense described above). Then, it checks if the
dependencies listed in the `applications` key of the resource file are already
started. Having at least one dependency not started is an error condition, but
when you start an application with `mix run`, Mix takes care of starting all
the dependencies for you, so in practice you don't need to worry about it
unless you are starting applications manually with the API provided by this
module.
If the application does not have a callback module configured, starting is
done at this point. Otherwise, its `c:start/2` callback if invoked. The PID of
@@ -226,9 +181,9 @@ defmodule Application do
Stopping an application with a callback module has three steps:
1. If present, invoke the optional callback `c:prep_stop/1`.
2. Terminate the top-level supervisor.
3. Invoke the required callback `c:stop/1`.
1. If present, invoke the optional callback `c:prep_stop/1`.
2. Terminate the top-level supervisor.
3. Invoke the required callback `c:stop/1`.
The arguments passed to the callbacks are related to the state optionally
returned by `c:start/2`, and are documented in the section about the callback
@@ -248,16 +203,17 @@ defmodule Application do
## Tooling
The Mix build tool automates most of the application management tasks. For example,
The Mix build tool can also be used to start your applications. For example,
`mix test` automatically starts your application dependencies and your application
itself before your test runs. `mix run --no-halt` boots your current project and
can be used to start a long running system. See `mix help run`.
Developers can also use `mix release` to build **releases**. Releases are able to
package all of your source code as well as the Erlang VM into a single directory.
Releases also give you explicit control over how each application is started and in
which order. They also provide a more streamlined mechanism for starting and
stopping systems, debugging, logging, as well as system monitoring.
Developers can also use tools like [Distillery](https://github.com/bitwalker/distillery)
that build **releases**. Releases are able to package all of your source code
as well as the Erlang VM into a single directory. Releases also give you explicit
control over how each application is started and in which order. They also provide
a more streamlined mechanism for starting and stopping systems, debugging, logging,
as well as system monitoring.
Finally, Elixir provides tools such as escripts and archives, which are
different mechanisms for packaging your application. Those are typically used
@@ -297,7 +253,7 @@ defmodule Application do
application specification key `:start_phases` is not `:undefined`.
`start_args` are the arguments passed to the application in the `:mod`
specification key (for example, `mod: {MyApp, [:my_args]}`).
specification key (e.g., `mod: {MyApp, [:my_args]}`).
This function should either return `{:ok, pid}` or `{:ok, pid, state}` if
startup is successful. `pid` should be the PID of the top supervisor. `state`
@@ -457,135 +413,12 @@ defmodule Application do
:application.get_all_env(app)
end
@doc """
Reads the application environment at compilation time.
Similar to `get_env/3`, except it must be used to read values
at compile time. This allows Elixir to track when configuration
values change between compile time and runtime.
The first argument is the application name. The second argument
`key_or_path` is either an atom key or a path to traverse in
search of the configuration, starting with an atom key.
For example, imagine the following configuration:
config :my_app, :key, [foo: [bar: :baz]]
We can access it during compile time as:
Application.compile_env(:my_app, :key)
#=> [foo: [bar: :baz]]
Application.compile_env(:my_app, [:key, :foo])
#=> [bar: :baz]
Application.compile_env(:my_app, [:key, :foo, :bar])
#=> :baz
A default value can also be given as third argument. If
any of the keys in the path along the way is missing, the
default value is used:
Application.compile_env(:my_app, [:unknown, :foo, :bar], :default)
#=> :default
Application.compile_env(:my_app, [:key, :unknown, :bar], :default)
#=> :default
Application.compile_env(:my_app, [:key, :foo, :unknown], :default)
#=> :default
Giving a path is useful to let Elixir know that only certain paths
in a large configuration are compile time dependent.
"""
# TODO: Warn if get_env/fetch_env/fetch_env! is used at compile time instead of compile_env
@doc since: "1.10.0"
@spec compile_env(app, key | list, value) :: value
defmacro compile_env(app, key_or_path, default \\ nil) when is_atom(app) do
if __CALLER__.function do
raise "Application.compile_env/3 cannot be called inside functions, only in the module body"
end
quote do
Application.__compile_env__(unquote(app), unquote(key_or_path), unquote(default), __ENV__)
end
end
@doc false
def __compile_env__(app, key_or_path, default, env) do
case fetch_compile_env(app, key_or_path, env) do
{:ok, value} -> value
:error -> default
end
end
@doc """
Reads the application environment at compilation time or raises.
This is the same as `compile_env/3` but it raises an
ArgumentError if the configuration is not available.
"""
@doc since: "1.10.0"
@spec compile_env!(app, key | list) :: value
defmacro compile_env!(app, key_or_path) when is_atom(app) do
if __CALLER__.function do
raise "Application.compile_env!/2 cannot be called inside functions, only in the module body"
end
quote do
Application.__compile_env__!(unquote(app), unquote(key_or_path), __ENV__)
end
end
@doc false
def __compile_env__!(app, key_or_path, env) do
case fetch_compile_env(app, key_or_path, env) do
{:ok, value} ->
value
:error ->
raise ArgumentError,
"could not fetch application environment #{inspect(key_or_path)} for application " <>
"#{inspect(app)} #{fetch_env_failed_reason(app, key_or_path)}"
end
end
defp fetch_compile_env(app, key, env) when is_atom(key),
do: fetch_compile_env(app, key, [], env)
defp fetch_compile_env(app, [key | paths], env) when is_atom(key),
do: fetch_compile_env(app, key, paths, env)
defp fetch_compile_env(app, key, path, env) do
return = traverse_env(fetch_env(app, key), path)
for tracer <- env.tracers do
tracer.trace({:compile_env, app, [key | path], return}, env)
end
return
end
defp traverse_env(return, []), do: return
defp traverse_env(:error, _paths), do: :error
defp traverse_env({:ok, value}, [key | keys]), do: traverse_env(Access.fetch(value, key), keys)
@doc """
Returns the value for `key` in `app`'s environment.
If the configuration parameter does not exist, the function returns the
`default` value.
**Important:** if you are reading the application environment at compilation
time, for example, inside the module definition instead of inside of a
function, see `compile_env/3` instead.
**Important:** if you are writing a library to be used by other developers,
it is generally recommended to avoid the application environment, as the
application environment is effectively a global storage. For more information,
read our [library guidelines](library-guidelines.html).
## Examples
`get_env/3` is commonly used to read the configuration of your OTP applications.
@@ -615,6 +448,11 @@ defmodule Application do
by module names). Our database engine can then traverse each repository in the
list and then call `get_env(:my_app, Databases.RepoOne)` and so forth to retrieve
the configuration of each one.
**Important:** if you are writing a library to be used by other developers,
it is generally recommended to avoid the application environment, as the
application environment is effectively a global storage. For more information,
read our [library guidelines](library-guidelines.html).
"""
@spec get_env(app, key, value) :: value
def get_env(app, key, default \\ nil) when is_atom(app) do
@@ -638,10 +476,6 @@ defmodule Application do
Returns the value for `key` in `app`'s environment.
If the configuration parameter does not exist, raises `ArgumentError`.
**Important:** if you are reading the application environment at compilation
time, for example, inside the module definition instead of inside of a
function, see `compile_env!/2` instead.
"""
@spec fetch_env!(app, key) :: value
def fetch_env!(app, key) when is_atom(app) do
@@ -650,23 +484,23 @@ defmodule Application do
value
:error ->
raise ArgumentError,
"could not fetch application environment #{inspect(key)} for application " <>
"#{inspect(app)} #{fetch_env_failed_reason(app, key)}"
end
end
vsn = :application.get_key(app, :vsn)
app = inspect(app)
key = inspect(key)
defp fetch_env_failed_reason(app, key) do
vsn = :application.get_key(app, :vsn)
case vsn do
{:ok, _} ->
raise ArgumentError,
"could not fetch application environment #{key} for application #{app} " <>
"because configuration #{key} was not set"
case vsn do
{:ok, _} ->
"because configuration at #{inspect(key)} was not set"
:undefined ->
"because the application was not loaded/started. If your application " <>
"depends on #{inspect(app)} at runtime, make sure to load/start it or " <>
"list it under :extra_applications in your mix.exs file"
:undefined ->
raise ArgumentError,
"could not fetch application environment #{key} for application #{app} " <>
"because the application was not loaded/started. If your application " <>
"depends on #{app} at runtime, make sure to load/start it or list it " <>
"under :extra_applications in your mix.exs file"
end
end
end
@@ -692,9 +526,6 @@ defmodule Application do
:application.set_env(app, key, value, opts)
end
# TODO: Remove this once we support Erlang/OTP 22+ exclusively.
@compile {:no_warn_undefined, {:application, :set_env, 2}}
@doc """
Puts the environment for multiple apps at the same time.
@@ -709,7 +540,6 @@ defmodule Application do
It receives the same options as `put_env/4`. Returns `:ok`.
"""
@doc since: "1.9.0"
@spec put_all_env([{app, [{key, value}]}], timeout: timeout, persistent: boolean) :: :ok
def put_all_env(config, opts \\ []) when is_list(config) and is_list(opts) do
# TODO: Remove function exported? check when we require Erlang/OTP 22+
@@ -752,22 +582,6 @@ defmodule Application do
:application.ensure_started(app, type)
end
@doc """
Ensures the given `app` is loaded.
Same as `load/2` but returns `:ok` if the application was already
loaded.
"""
@doc since: "1.10.0"
@spec ensure_loaded(app) :: :ok | {:error, term}
def ensure_loaded(app) when is_atom(app) do
case :application.load(app) do
:ok -> :ok
{:error, {:already_loaded, ^app}} -> :ok
{:error, _} = error -> error
end
end
@doc """
Ensures the given `app` and its applications are started.
+2 -40
View File
@@ -1,46 +1,8 @@
defmodule Atom do
@moduledoc """
Atoms are constants whose values are their own name.
They are often useful to enumerate over distinct values, such as:
iex> :apple
:apple
iex> :orange
:orange
iex> :watermelon
:watermelon
Atoms are equal if their names are equal.
iex> :apple == :apple
true
iex> :apple == :orange
false
Often they are used to express the state of an operation, by using
values such as `:ok` and `:error`.
The booleans `true` and `false` are also atoms:
iex> true == :true
true
iex> is_atom(false)
true
iex> is_boolean(:false)
true
Elixir allows you to skip the leading `:` for the atoms `false`, `true`,
and `nil`.
Atoms must be composed of Unicode characters such as letters, numbers,
underscore, and `@`. If the keyword has a character that does not
belong to the category above, such as spaces, you can wrap it in
quotes:
iex> :"this is an atom with spaces"
:"this is an atom with spaces"
Convenience functions for working with atoms.
See also `Kernel.is_atom/1`.
"""
@doc """
+66 -66
View File
@@ -10,85 +10,85 @@ defmodule Base do
## Base 16 alphabet
| Value | Encoding | Value | Encoding | Value | Encoding | Value | Encoding |
|------:|:---------|------:|:---------|------:|:---------|------:|:---------|
| 0 | 0 | 4 | 4 | 8 | 8 | 12 | C |
| 1 | 1 | 5 | 5 | 9 | 9 | 13 | D |
| 2 | 2 | 6 | 6 | 10 | A | 14 | E |
| 3 | 3 | 7 | 7 | 11 | B | 15 | F |
| Value | Encoding | Value | Encoding | Value | Encoding | Value | Encoding |
|------:|---------:|------:|---------:|------:|---------:|------:|---------:|
| 0| 0| 4| 4| 8| 8| 12| C|
| 1| 1| 5| 5| 9| 9| 13| D|
| 2| 2| 6| 6| 10| A| 14| E|
| 3| 3| 7| 7| 11| B| 15| F|
## Base 32 alphabet
| Value | Encoding | Value | Encoding | Value | Encoding | Value | Encoding |
|------:|:---------|------:|:---------|------:|:---------|------:|:---------|
| 0 | A | 9 | J | 18 | S | 27 | 3 |
| 1 | B | 10 | K | 19 | T | 28 | 4 |
| 2 | C | 11 | L | 20 | U | 29 | 5 |
| 3 | D | 12 | M | 21 | V | 30 | 6 |
| 4 | E | 13 | N | 22 | W | 31 | 7 |
| 5 | F | 14 | O | 23 | X | | |
| 6 | G | 15 | P | 24 | Y | (pad) | = |
| 7 | H | 16 | Q | 25 | Z | | |
| 8 | I | 17 | R | 26 | 2 | | |
| Value | Encoding | Value | Encoding | Value | Encoding | Value | Encoding |
|------:|---------:|------:|---------:|------:|---------:|------:|---------:|
| 0| A| 9| J| 18| S| 27| 3|
| 1| B| 10| K| 19| T| 28| 4|
| 2| C| 11| L| 20| U| 29| 5|
| 3| D| 12| M| 21| V| 30| 6|
| 4| E| 13| N| 22| W| 31| 7|
| 5| F| 14| O| 23| X| | |
| 6| G| 15| P| 24| Y| (pad)| =|
| 7| H| 16| Q| 25| Z| | |
| 8| I| 17| R| 26| 2| | |
## Base 32 (extended hex) alphabet
| Value | Encoding | Value | Encoding | Value | Encoding | Value | Encoding |
|------:|:---------|------:|:---------|------:|:---------|------:|:---------|
| 0 | 0 | 9 | 9 | 18 | I | 27 | R |
| 1 | 1 | 10 | A | 19 | J | 28 | S |
| 2 | 2 | 11 | B | 20 | K | 29 | T |
| 3 | 3 | 12 | C | 21 | L | 30 | U |
| 4 | 4 | 13 | D | 22 | M | 31 | V |
| 5 | 5 | 14 | E | 23 | N | | |
| 6 | 6 | 15 | F | 24 | O | (pad) | = |
| 7 | 7 | 16 | G | 25 | P | | |
| 8 | 8 | 17 | H | 26 | Q | | |
| Value | Encoding | Value | Encoding | Value | Encoding | Value | Encoding |
|------:|---------:|------:|---------:|------:|---------:|------:|---------:|
| 0| 0| 9| 9| 18| I| 27| R|
| 1| 1| 10| A| 19| J| 28| S|
| 2| 2| 11| B| 20| K| 29| T|
| 3| 3| 12| C| 21| L| 30| U|
| 4| 4| 13| D| 22| M| 31| V|
| 5| 5| 14| E| 23| N| | |
| 6| 6| 15| F| 24| O| (pad)| =|
| 7| 7| 16| G| 25| P| | |
| 8| 8| 17| H| 26| Q| | |
## Base 64 alphabet
| Value | Encoding | Value | Encoding | Value | Encoding | Value | Encoding |
|------:|:----------|------:|:---------|------:|:---------|------:|:---------|
| 0 | A | 17 | R | 34 | i | 51 | z |
| 1 | B | 18 | S | 35 | j | 52 | 0 |
| 2 | C | 19 | T | 36 | k | 53 | 1 |
| 3 | D | 20 | U | 37 | l | 54 | 2 |
| 4 | E | 21 | V | 38 | m | 55 | 3 |
| 5 | F | 22 | W | 39 | n | 56 | 4 |
| 6 | G | 23 | X | 40 | o | 57 | 5 |
| 7 | H | 24 | Y | 41 | p | 58 | 6 |
| 8 | I | 25 | Z | 42 | q | 59 | 7 |
| 9 | J | 26 | a | 43 | r | 60 | 8 |
| 10 | K | 27 | b | 44 | s | 61 | 9 |
| 11 | L | 28 | c | 45 | t | 62 | + |
| 12 | M | 29 | d | 46 | u | 63 | / |
| 13 | N | 30 | e | 47 | v | | |
| 14 | O | 31 | f | 48 | w | (pad) | = |
| 15 | P | 32 | g | 49 | x | | |
| 16 | Q | 33 | h | 50 | y | | |
| Value | Encoding | Value | Encoding | Value | Encoding | Value | Encoding |
|------:|---------:|------:|---------:|------:|---------:|------:|---------:|
| 0| A| 17| R| 34| i| 51| z|
| 1| B| 18| S| 35| j| 52| 0|
| 2| C| 19| T| 36| k| 53| 1|
| 3| D| 20| U| 37| l| 54| 2|
| 4| E| 21| V| 38| m| 55| 3|
| 5| F| 22| W| 39| n| 56| 4|
| 6| G| 23| X| 40| o| 57| 5|
| 7| H| 24| Y| 41| p| 58| 6|
| 8| I| 25| Z| 42| q| 59| 7|
| 9| J| 26| a| 43| r| 60| 8|
| 10| K| 27| b| 44| s| 61| 9|
| 11| L| 28| c| 45| t| 62| +|
| 12| M| 29| d| 46| u| 63| /|
| 13| N| 30| e| 47| v| | |
| 14| O| 31| f| 48| w| (pad)| =|
| 15| P| 32| g| 49| x| | |
| 16| Q| 33| h| 50| y| | |
## Base 64 (URL and filename safe) alphabet
| Value | Encoding | Value | Encoding | Value | Encoding | Value | Encoding |
|------:|:---------|------:|:---------|------:|:---------|------:|:---------|
| 0 | A | 17 | R | 34 | i | 51 | z |
| 1 | B | 18 | S | 35 | j | 52 | 0 |
| 2 | C | 19 | T | 36 | k | 53 | 1 |
| 3 | D | 20 | U | 37 | l | 54 | 2 |
| 4 | E | 21 | V | 38 | m | 55 | 3 |
| 5 | F | 22 | W | 39 | n | 56 | 4 |
| 6 | G | 23 | X | 40 | o | 57 | 5 |
| 7 | H | 24 | Y | 41 | p | 58 | 6 |
| 8 | I | 25 | Z | 42 | q | 59 | 7 |
| 9 | J | 26 | a | 43 | r | 60 | 8 |
| 10 | K | 27 | b | 44 | s | 61 | 9 |
| 11 | L | 28 | c | 45 | t | 62 | - |
| 12 | M | 29 | d | 46 | u | 63 | _ |
| 13 | N | 30 | e | 47 | v | | |
| 14 | O | 31 | f | 48 | w | (pad) | = |
| 15 | P | 32 | g | 49 | x | | |
| 16 | Q | 33 | h | 50 | y | | |
| Value | Encoding | Value | Encoding | Value | Encoding | Value | Encoding |
|------:|---------:|------:|---------:|------:|---------:|------:|---------:|
| 0| A| 17| R| 34| i| 51| z|
| 1| B| 18| S| 35| j| 52| 0|
| 2| C| 19| T| 36| k| 53| 1|
| 3| D| 20| U| 37| l| 54| 2|
| 4| E| 21| V| 38| m| 55| 3|
| 5| F| 22| W| 39| n| 56| 4|
| 6| G| 23| X| 40| o| 57| 5|
| 7| H| 24| Y| 41| p| 58| 6|
| 8| I| 25| Z| 42| q| 59| 7|
| 9| J| 26| a| 43| r| 60| 8|
| 10| K| 27| b| 44| s| 61| 9|
| 11| L| 28| c| 45| t| 62| -|
| 12| M| 29| d| 46| u| 63| _|
| 13| N| 30| e| 47| v| | |
| 14| O| 31| f| 48| w| (pad)| =|
| 15| P| 32| g| 49| x| | |
| 16| Q| 33| h| 50| y| | |
"""
+29 -106
View File
@@ -1,11 +1,8 @@
defmodule Bitwise do
@moduledoc """
A set of functions that perform calculations on bits.
A set of macros that perform calculations on bits.
All bitwise functions work only on integers; otherwise an
`ArithmeticError` is raised.
The functions in this module come in two flavors: named or
The macros in this module come in two flavors: named or
operators. For example:
iex> use Bitwise
@@ -29,16 +26,16 @@ defmodule Bitwise do
When invoked with no options, `use Bitwise` is equivalent
to `import Bitwise`.
All bitwise functions can be used in guards:
All bitwise macros can be used in guards:
iex> use Bitwise
iex> odd? = fn
...> int when Bitwise.band(int, 1) == 1 -> true
...> int when band(int, 1) == 1 -> true
...> _ -> false
...> end
iex> odd?.(1)
true
All functions in this module are inlined by the compiler.
"""
@doc false
@@ -63,246 +60,172 @@ defmodule Bitwise do
@doc """
Calculates the bitwise NOT of its argument.
Allowed in guard tests. Inlined by the compiler.
## Examples
iex> bnot(2)
-3
iex> bnot(2) &&& 3
1
"""
@doc guard: true
@spec bnot(integer) :: integer
def bnot(expr) do
:erlang.bnot(expr)
defmacro bnot(expr) do
quote(do: :erlang.bnot(unquote(expr)))
end
@doc """
Prefix (unary) operator; calculates the bitwise NOT of its argument.
Allowed in guard tests. Inlined by the compiler.
## Examples
iex> ~~~2
-3
iex> ~~~2 &&& 3
1
"""
@doc guard: true
@spec ~~~integer :: integer
def ~~~expr do
:erlang.bnot(expr)
defmacro ~~~expr do
quote(do: :erlang.bnot(unquote(expr)))
end
@doc """
Calculates the bitwise AND of its arguments.
Allowed in guard tests. Inlined by the compiler.
## Examples
iex> band(9, 3)
1
"""
@doc guard: true
@spec band(integer, integer) :: integer
def band(left, right) do
:erlang.band(left, right)
defmacro band(left, right) do
quote(do: :erlang.band(unquote(left), unquote(right)))
end
@doc """
Infix operator; calculates the bitwise AND of its arguments.
Allowed in guard tests. Inlined by the compiler.
## Examples
iex> 9 &&& 3
1
"""
@doc guard: true
@spec integer &&& integer :: integer
def left &&& right do
:erlang.band(left, right)
defmacro left &&& right do
quote(do: :erlang.band(unquote(left), unquote(right)))
end
@doc """
Calculates the bitwise OR of its arguments.
Allowed in guard tests. Inlined by the compiler.
## Examples
iex> bor(9, 3)
11
"""
@doc guard: true
@spec bor(integer, integer) :: integer
def bor(left, right) do
:erlang.bor(left, right)
defmacro bor(left, right) do
quote(do: :erlang.bor(unquote(left), unquote(right)))
end
@doc """
Infix operator; calculates the bitwise OR of its arguments.
Allowed in guard tests. Inlined by the compiler.
## Examples
iex> 9 ||| 3
11
"""
@doc guard: true
@spec integer ||| integer :: integer
def left ||| right do
:erlang.bor(left, right)
defmacro left ||| right do
quote(do: :erlang.bor(unquote(left), unquote(right)))
end
@doc """
Calculates the bitwise XOR of its arguments.
Allowed in guard tests. Inlined by the compiler.
## Examples
iex> bxor(9, 3)
10
"""
@doc guard: true
@spec bxor(integer, integer) :: integer
def bxor(left, right) do
:erlang.bxor(left, right)
defmacro bxor(left, right) do
quote(do: :erlang.bxor(unquote(left), unquote(right)))
end
@doc """
Infix operator; calculates the bitwise XOR of its arguments.
Allowed in guard tests. Inlined by the compiler.
## Examples
iex> 9 ^^^ 3
10
"""
@doc guard: true
@spec integer ^^^ integer :: integer
def left ^^^ right do
:erlang.bxor(left, right)
defmacro left ^^^ right do
quote(do: :erlang.bxor(unquote(left), unquote(right)))
end
@doc """
Calculates the result of an arithmetic left bitshift.
Allowed in guard tests. Inlined by the compiler.
## Examples
iex> bsl(1, 2)
4
iex> bsl(1, -2)
0
iex> bsl(-1, 2)
-4
iex> bsl(-1, -2)
-1
"""
@doc guard: true
@spec bsl(integer, integer) :: integer
def bsl(left, right) do
:erlang.bsl(left, right)
defmacro bsl(left, right) do
quote(do: :erlang.bsl(unquote(left), unquote(right)))
end
@doc """
Infix operator; calculates the result of an arithmetic left bitshift.
Allowed in guard tests. Inlined by the compiler.
## Examples
iex> 1 <<< 2
4
iex> 1 <<< -2
0
iex> -1 <<< 2
-4
iex> -1 <<< -2
-1
"""
@doc guard: true
@spec integer <<< integer :: integer
def left <<< right do
:erlang.bsl(left, right)
defmacro left <<< right do
quote(do: :erlang.bsl(unquote(left), unquote(right)))
end
@doc """
Calculates the result of an arithmetic right bitshift.
Allowed in guard tests. Inlined by the compiler.
## Examples
iex> bsr(1, 2)
0
iex> bsr(1, -2)
4
iex> bsr(-1, 2)
-1
iex> bsr(-1, -2)
-4
"""
@doc guard: true
@spec bsr(integer, integer) :: integer
def bsr(left, right) do
:erlang.bsr(left, right)
defmacro bsr(left, right) do
quote(do: :erlang.bsr(unquote(left), unquote(right)))
end
@doc """
Infix operator; calculates the result of an arithmetic right bitshift.
Allowed in guard tests. Inlined by the compiler.
## Examples
iex> 1 >>> 2
0
iex> 1 >>> -2
4
iex> -1 >>> 2
-1
iex> -1 >>> -2
-4
"""
@doc guard: true
@spec integer >>> integer :: integer
def left >>> right do
:erlang.bsr(left, right)
defmacro left >>> right do
quote(do: :erlang.bsr(unquote(left), unquote(right)))
end
end
+6 -52
View File
@@ -11,7 +11,7 @@ defmodule Calendar do
For the actual date, time and datetime structures, see `Date`,
`Time`, `NaiveDateTime` and `DateTime`.
Note designations for year, month, day, and the like, are overspecified
Note the year, month, day, etc. designations are overspecified
(i.e. an integer instead of `1..12` for months) because different
calendars may have a different number of days per month, months per year and so on.
"""
@@ -23,11 +23,6 @@ defmodule Calendar do
@type day_of_week :: non_neg_integer
@type era :: non_neg_integer
@typedoc """
A tuple representing the `day` and the `era`.
"""
@type day_of_era :: {day :: non_neg_integer(), era}
@type hour :: non_neg_integer
@type minute :: non_neg_integer
@type second :: non_neg_integer
@@ -57,15 +52,15 @@ defmodule Calendar do
representing the microseconds to external format. If the precision is 0,
it means microseconds must be skipped.
"""
@type microsecond :: {non_neg_integer, non_neg_integer}
@type microsecond :: {0..999_999, 0..6}
@typedoc "A calendar implementation"
@type calendar :: module
@typedoc "The time zone ID according to the IANA tz database (for example, Europe/Zurich)"
@typedoc "The time zone ID according to the IANA tz database (e.g. Europe/Zurich)"
@type time_zone :: String.t()
@typedoc "The time zone abbreviation (for example, CET or CEST or BST, and such)"
@typedoc "The time zone abbreviation (e.g. CET or CEST or BST etc.)"
@type zone_abbr :: String.t()
@typedoc "The time zone UTC offset in seconds"
@@ -127,7 +122,7 @@ defmodule Calendar do
for any other time zone.
Other time zone databases (including ones provided by packages)
can be configured as default either via configuration:
can be configure as default either via configuration:
config :elixir, :time_zone_database, CustomTimeZoneDatabase
@@ -180,7 +175,7 @@ defmodule Calendar do
@doc """
Calculates the day and era from the given `year`, `month`, and `day`.
"""
@callback day_of_era(year, month, day) :: day_of_era()
@callback day_of_era(year, month, day) :: {non_neg_integer(), era}
@doc """
Converts the date into a string according to the calendar.
@@ -270,47 +265,6 @@ defmodule Calendar do
"""
@callback valid_time?(hour, minute, second, microsecond) :: boolean
@doc """
Parses the string representation for a time returned by `c:time_to_string/4`
into a time-tuple.
"""
@doc since: "1.10.0"
@callback parse_time(String.t()) ::
{:ok, {hour, minute, second, microsecond}}
| {:error, atom}
@doc """
Parses the string representation for a date returned by `c:date_to_string/3`
into a date-tuple.
"""
@doc since: "1.10.0"
@callback parse_date(String.t()) ::
{:ok, {year, month, day}}
| {:error, atom}
@doc """
Parses the string representation for a naive datetime returned by
`c:naive_datetime_to_string/7` into a naive-datetime-tuple.
The given string may contain a timezone offset but it is ignored.
"""
@doc since: "1.10.0"
@callback parse_naive_datetime(String.t()) ::
{:ok, {year, month, day, hour, minute, second, microsecond}}
| {:error, atom}
@doc """
Parses the string representation for a datetime returned by
`c:datetime_to_string/11` into a datetime-tuple.
The returned datetime must be in UTC. The original `utc_offset`
it was written in must be returned in the result.
"""
@doc since: "1.10.0"
@callback parse_utc_datetime(String.t()) ::
{:ok, {year, month, day, hour, minute, second, microsecond}, utc_offset}
| {:error, atom}
# General Helpers
@doc """
+29 -7
View File
@@ -263,9 +263,30 @@ defmodule Date do
"""
@spec from_iso8601(String.t(), Calendar.calendar()) :: {:ok, t} | {:error, atom}
def from_iso8601(string, calendar \\ Calendar.ISO) do
with {:ok, {year, month, day}} <- Calendar.ISO.parse_date(string) do
convert(%Date{year: year, month: month, day: day}, calendar)
def from_iso8601(string, calendar \\ Calendar.ISO)
def from_iso8601(<<?-, rest::binary>>, calendar) do
with {:ok, %{year: year} = date} <- raw_from_iso8601(rest, calendar) do
{:ok, %{date | year: -year}}
end
end
def from_iso8601(<<rest::binary>>, calendar) do
raw_from_iso8601(rest, calendar)
end
[match_date, guard_date, read_date] = Calendar.ISO.__match_date__()
defp raw_from_iso8601(string, calendar) do
with unquote(match_date) <- string,
true <- unquote(guard_date) do
{year, month, day} = unquote(read_date)
with {:ok, date} <- new(year, month, day, Calendar.ISO) do
convert(date, calendar)
end
else
_ -> {:error, :invalid_format}
end
end
@@ -748,11 +769,12 @@ defmodule Date do
end
defimpl Inspect do
def inspect(%{calendar: calendar, year: year, month: month, day: day}, _) do
"~D[" <> calendar.date_to_string(year, month, day) <> suffix(calendar) <> "]"
def inspect(%{calendar: Calendar.ISO, year: year, month: month, day: day}, _) do
"~D[" <> Calendar.ISO.date_to_string(year, month, day) <> "]"
end
defp suffix(Calendar.ISO), do: ""
defp suffix(calendar), do: " " <> inspect(calendar)
def inspect(date, opts) do
Inspect.Any.inspect(date, opts)
end
end
end
+114 -111
View File
@@ -25,17 +25,12 @@ defmodule DateTime do
datetimes and returns `{:error, :utc_only_time_zone_database}`
for any other time zone.
Other time zone databases can also be configured. For example, to use the
[tzdata](https://hexdocs.pm/tzdata/) database, first make sure it is added as
a dependency in `mix.exs`. It can then be configured either via
configuration:
Other time zone databases (including ones provided by packages)
can be configure as default either via configuration:
config :elixir, :time_zone_database, Tzdata.TimeZoneDatabase
or by calling `Calendar.put_time_zone_database/1`:
Calendar.put_time_zone_database(Tzdata.TimeZoneDatabase)
config :elixir, :time_zone_database, CustomTimeZoneDatabase
or by calling `Calendar.put_time_zone_database/1`.
"""
@enforce_keys [:year, :month, :day, :hour, :minute, :second] ++
@@ -417,13 +412,11 @@ defmodule DateTime do
## Examples
iex> {:ok, pacific_datetime} = DateTime.shift_zone(~U[2018-07-16 10:00:00Z], "America/Los_Angeles", FakeTimeZoneDatabase)
iex> cph_datetime = DateTime.from_naive!(~N[2018-07-16 12:00:00], "Europe/Copenhagen", FakeTimeZoneDatabase)
iex> {:ok, pacific_datetime} = DateTime.shift_zone(cph_datetime, "America/Los_Angeles", FakeTimeZoneDatabase)
iex> pacific_datetime
#DateTime<2018-07-16 03:00:00-07:00 PDT America/Los_Angeles>
iex> DateTime.shift_zone(~U[2018-07-16 10:00:00Z], "bad timezone", FakeTimeZoneDatabase)
{:error, :time_zone_not_found}
"""
@doc since: "1.8.0"
@spec shift_zone(t, Calendar.time_zone(), Calendar.time_zone_database()) ::
@@ -478,34 +471,6 @@ defmodule DateTime do
end
end
@doc """
Changes the time zone of a `DateTime` or raises on errors.
See `shift_zone/3` for more information.
## Examples
iex> DateTime.shift_zone!(~U[2018-07-16 10:00:00Z], "America/Los_Angeles", FakeTimeZoneDatabase)
#DateTime<2018-07-16 03:00:00-07:00 PDT America/Los_Angeles>
iex> DateTime.shift_zone!(~U[2018-07-16 10:00:00Z], "bad timezone", FakeTimeZoneDatabase)
** (ArgumentError) cannot shift ~U[2018-07-16 10:00:00Z] to "bad timezone" time zone, reason: :time_zone_not_found
"""
@doc since: "1.10.0"
@spec shift_zone!(t, Calendar.time_zone(), Calendar.time_zone_database()) :: t
def shift_zone!(datetime, time_zone, time_zone_database \\ Calendar.get_time_zone_database()) do
case shift_zone(datetime, time_zone, time_zone_database) do
{:ok, datetime} ->
datetime
{:error, reason} ->
raise ArgumentError,
"cannot shift #{inspect(datetime)} to #{inspect(time_zone)} time zone" <>
", reason: #{inspect(reason)}"
end
end
@doc """
Returns the current datetime in the provided time zone.
@@ -520,11 +485,9 @@ defmodule DateTime do
iex> {:ok, datetime} = DateTime.now("Etc/UTC")
iex> datetime.time_zone
"Etc/UTC"
iex> DateTime.now("Europe/Copenhagen")
{:error, :utc_only_time_zone_database}
iex> DateTime.now("bad timezone", FakeTimeZoneDatabase)
iex> DateTime.now("not a real time zone name", FakeTimeZoneDatabase)
{:error, :time_zone_not_found}
"""
@@ -541,38 +504,6 @@ defmodule DateTime do
shift_zone(utc_now(), time_zone, time_zone_database)
end
@doc """
Returns the current datetime in the provided time zone or raises on errors
See `now/2` for more information.
## Examples
iex> datetime = DateTime.now!("Etc/UTC")
iex> datetime.time_zone
"Etc/UTC"
iex> DateTime.now!("Europe/Copenhagen")
** (ArgumentError) cannot get current datetime in "Europe/Copenhagen" time zone, reason: :utc_only_time_zone_database
iex> DateTime.now!("bad timezone", FakeTimeZoneDatabase)
** (ArgumentError) cannot get current datetime in "bad timezone" time zone, reason: :time_zone_not_found
"""
@doc since: "1.10.0"
@spec now!(Calendar.time_zone(), Calendar.time_zone_database()) :: t
def now!(time_zone, time_zone_database \\ Calendar.get_time_zone_database()) do
case now(time_zone, time_zone_database) do
{:ok, datetime} ->
datetime
{:error, reason} ->
raise ArgumentError,
"cannot get current datetime in #{inspect(time_zone)} time zone, reason: " <>
inspect(reason)
end
end
@doc """
Converts the given `datetime` to Unix time.
@@ -582,10 +513,6 @@ defmodule DateTime do
It will return the integer with the given unit,
according to `System.convert_time_unit/3`.
If you want to get the current time in Unix seconds,
do not do `DateTime.utc_now() |> DateTime.to_unix()`.
Simply call `System.os_time(:second)` instead.
## Examples
iex> 1_464_096_368 |> DateTime.from_unix!() |> DateTime.to_unix()
@@ -774,14 +701,25 @@ defmodule DateTime do
second: second,
microsecond: microsecond,
time_zone: time_zone,
zone_abbr: zone_abbr,
utc_offset: utc_offset,
std_offset: std_offset
} = datetime
Calendar.ISO.date_to_string(year, month, day, format) <>
"T" <>
Calendar.ISO.time_to_string(hour, minute, second, microsecond, format) <>
Calendar.ISO.offset_to_string(utc_offset, std_offset, time_zone, format)
Calendar.ISO.datetime_to_iso8601(
year,
month,
day,
hour,
minute,
second,
microsecond,
time_zone,
zone_abbr,
utc_offset,
std_offset,
format
)
end
def to_iso8601(%{calendar: _} = datetime, format) when format in [:extended, :basic] do
@@ -844,26 +782,91 @@ defmodule DateTime do
@doc since: "1.4.0"
@spec from_iso8601(String.t(), Calendar.calendar()) ::
{:ok, t, Calendar.utc_offset()} | {:error, atom}
def from_iso8601(string, calendar \\ Calendar.ISO) do
with {:ok, {year, month, day, hour, minute, second, microsecond}, offset} <-
Calendar.ISO.parse_utc_datetime(string) do
datetime = %DateTime{
year: year,
month: month,
day: day,
hour: hour,
minute: minute,
second: second,
microsecond: microsecond,
std_offset: 0,
utc_offset: 0,
zone_abbr: "UTC",
time_zone: "Etc/UTC"
}
def from_iso8601(string, calendar \\ Calendar.ISO)
with {:ok, converted} <- convert(datetime, calendar) do
{:ok, converted, offset}
def from_iso8601(<<?-, rest::binary>>, calendar) do
raw_from_iso8601(rest, calendar, true)
end
def from_iso8601(<<rest::binary>>, calendar) do
raw_from_iso8601(rest, calendar, false)
end
@sep [?\s, ?T]
[match_date, guard_date, read_date] = Calendar.ISO.__match_date__()
[match_time, guard_time, read_time] = Calendar.ISO.__match_time__()
defp raw_from_iso8601(string, calendar, is_year_negative) do
with <<unquote(match_date), sep, unquote(match_time), rest::binary>> <- string,
true <- unquote(guard_date) and sep in @sep and unquote(guard_time),
{microsecond, rest} <- Calendar.ISO.parse_microsecond(rest),
{offset, ""} <- Calendar.ISO.parse_offset(rest) do
{year, month, day} = unquote(read_date)
{hour, minute, second} = unquote(read_time)
year = if is_year_negative, do: -year, else: year
cond do
not calendar.valid_date?(year, month, day) ->
{:error, :invalid_date}
not calendar.valid_time?(hour, minute, second, microsecond) ->
{:error, :invalid_time}
offset == 0 ->
datetime = %DateTime{
calendar: calendar,
year: year,
month: month,
day: day,
hour: hour,
minute: minute,
second: second,
microsecond: microsecond,
std_offset: 0,
utc_offset: 0,
zone_abbr: "UTC",
time_zone: "Etc/UTC"
}
{:ok, datetime, 0}
is_nil(offset) ->
{:error, :missing_offset}
true ->
day_fraction = Calendar.ISO.time_to_day_fraction(hour, minute, second, {0, 0})
{{year, month, day}, {hour, minute, second, _}} =
case apply_tz_offset({0, day_fraction}, offset) do
{0, day_fraction} ->
{{year, month, day}, Calendar.ISO.time_from_day_fraction(day_fraction)}
{extra_days, day_fraction} ->
base_days = Calendar.ISO.date_to_iso_days(year, month, day)
{Calendar.ISO.date_from_iso_days(base_days + extra_days),
Calendar.ISO.time_from_day_fraction(day_fraction)}
end
datetime = %DateTime{
calendar: calendar,
year: year,
month: month,
day: day,
hour: hour,
minute: minute,
second: second,
microsecond: microsecond,
std_offset: 0,
utc_offset: 0,
zone_abbr: "UTC",
time_zone: "Etc/UTC"
}
{:ok, datetime, offset}
end
else
_ -> {:error, :invalid_format}
end
end
@@ -1085,7 +1088,7 @@ defmodule DateTime do
@doc """
Returns the given datetime with the microsecond field truncated to the given
precision (`:microsecond`, `:millisecond` or `:second`).
precision (`:microsecond`, `millisecond` or `:second`).
The given datetime is returned unchanged if it already has lower precision than
the given precision.
@@ -1301,7 +1304,7 @@ defmodule DateTime do
end
defimpl Inspect do
def inspect(datetime, _) do
def inspect(%{calendar: Calendar.ISO} = datetime, _) do
%{
year: year,
month: month,
@@ -1313,12 +1316,11 @@ defmodule DateTime do
time_zone: time_zone,
zone_abbr: zone_abbr,
utc_offset: utc_offset,
std_offset: std_offset,
calendar: calendar
std_offset: std_offset
} = datetime
formatted =
calendar.datetime_to_string(
Calendar.ISO.datetime_to_string(
year,
month,
day,
@@ -1334,14 +1336,15 @@ defmodule DateTime do
case datetime do
%{utc_offset: 0, std_offset: 0, time_zone: "Etc/UTC"} ->
"~U[" <> formatted <> suffix(calendar) <> "]"
"~U[" <> formatted <> "]"
_ ->
"#DateTime<" <> formatted <> suffix(calendar) <> ">"
"#DateTime<" <> formatted <> ">"
end
end
defp suffix(Calendar.ISO), do: ""
defp suffix(calendar), do: " " <> inspect(calendar)
def inspect(datetime, opts) do
Inspect.Any.inspect(datetime, opts)
end
end
end
+125 -414
View File
@@ -20,48 +20,9 @@ defmodule Calendar.ISO do
unix_end = 315_569_519_999_999_999 - @unix_epoch * 1_000_000
@unix_range_microseconds unix_start..unix_end
@typedoc """
"Before the Current Era" or "Before the Common Era" (BCE), for those years less than `1`.
"""
@type bce :: 0
@typedoc """
The "Current Era" or the "Common Era" (CE) which starts in year `1`.
"""
@type ce :: 1
@typedoc """
The calendar era.
The ISO calendar has two eras:
* [CE](`t:ce/0`) - which starts in year `1` and is defined as era `1`.
* [BCE](`t:bce/0`) - for those years less than `1` and is defined as era `0`.
"""
@type era :: bce | ce
@type year :: -9999..9999
@type month :: 1..12
@type day :: 1..31
@type hour :: 0..23
@type minute :: 0..59
@type second :: 0..59
@typedoc """
Microseconds with stored precision.
The precision represents the number of digits that must be used when
representing the microseconds to external format. If the precision is 0,
it means microseconds must be skipped.
"""
@type microsecond :: {0..999_999, 0..6}
@typedoc """
Integer that represents the day of the week, where 1 is Monday and 7 is Sunday.
"""
@type day_of_week :: 1..7
@type day_of_year :: 1..366
@type quarter_of_year :: 1..4
@type year_of_era :: {1..10000, era}
@seconds_per_minute 60
@seconds_per_hour 60 * 60
@@ -71,16 +32,18 @@ defmodule Calendar.ISO do
@microseconds_per_second 1_000_000
@parts_per_day @seconds_per_day * @microseconds_per_second
@sep [?\s, ?T]
@days_per_nonleap_year 365
@days_per_leap_year 366
@months_in_year 12
# The ISO epoch starts, in this implementation,
# with ~D[0000-01-01]. Era "1" starts
# on ~D[0001-01-01] which is 366 days later.
@iso_epoch 366
[match_date, guard_date, read_date] =
@doc false
def __match_date__ do
quote do
[
<<y1, y2, y3, y4, ?-, m1, m2, ?-, d1, d2>>,
@@ -94,8 +57,10 @@ defmodule Calendar.ISO do
}
]
end
end
[match_time, guard_time, read_time] =
@doc false
def __match_time__ do
quote do
[
<<h1, h2, ?:, i1, i2, ?:, s1, s2>>,
@@ -108,276 +73,6 @@ defmodule Calendar.ISO do
}
]
end
defguardp is_year(year) when year in -9999..9999
defguardp is_year_BCE(year) when year in -9999..0
defguardp is_year_CE(year) when year in 1..9999
defguardp is_month(month) when month in 1..12
defguardp is_day(day) when day in 1..31
defguardp is_hour(hour) when hour in 0..23
defguardp is_minute(minute) when minute in 0..59
defguardp is_second(second) when second in 0..59
defguardp is_microsecond(microsecond, precision)
when microsecond in 0..999_999 and precision in 0..6
defguardp is_time_zone(term) when is_binary(term)
defguardp is_zone_abbr(term) when is_binary(term)
defguardp is_utc_offset(offset) when is_integer(offset)
defguardp is_std_offset(offset) when is_integer(offset)
@doc """
Parses a time string.
## Examples
iex> Calendar.ISO.parse_time("23:50:07")
{:ok, {23, 50, 7, {0, 0}}}
iex> Calendar.ISO.parse_time("23:50:07Z")
{:ok, {23, 50, 7, {0, 0}}}
iex> Calendar.ISO.parse_time("T23:50:07Z")
{:ok, {23, 50, 7, {0, 0}}}
iex> Calendar.ISO.parse_time("23:50:07,0123456")
{:ok, {23, 50, 7, {12345, 6}}}
iex> Calendar.ISO.parse_time("23:50:07.0123456")
{:ok, {23, 50, 7, {12345, 6}}}
iex> Calendar.ISO.parse_time("23:50:07.123Z")
{:ok, {23, 50, 7, {123000, 3}}}
iex> Calendar.ISO.parse_time("2015:01:23 23-50-07")
{:error, :invalid_format}
iex> Calendar.ISO.parse_time("23:50:07A")
{:error, :invalid_format}
iex> Calendar.ISO.parse_time("23:50:07.")
{:error, :invalid_format}
iex> Calendar.ISO.parse_time("23:50:61")
{:error, :invalid_time}
"""
@doc since: "1.10.0"
@impl true
def parse_time("T" <> string) when is_binary(string),
do: do_parse_time(string)
def parse_time(string) when is_binary(string),
do: do_parse_time(string)
defp do_parse_time(string) do
with <<unquote(match_time), rest::binary>> <- string,
true <- unquote(guard_time),
{microsecond, rest} <- parse_microsecond(rest),
{_offset, ""} <- parse_offset(rest) do
{hour, minute, second} = unquote(read_time)
if valid_time?(hour, minute, second, microsecond) do
{:ok, {hour, minute, second, microsecond}}
else
{:error, :invalid_time}
end
else
_ -> {:error, :invalid_format}
end
end
@doc """
Parses a date string.
## Examples
iex> Calendar.ISO.parse_date("2015-01-23")
{:ok, {2015, 1, 23}}
iex> Calendar.ISO.parse_date("-2015-01-23")
{:ok, {-2015, 1, 23}}
iex> Calendar.ISO.parse_date("2015:01:23")
{:error, :invalid_format}
iex> Calendar.ISO.parse_date("2015-01-32")
{:error, :invalid_date}
"""
@doc since: "1.10.0"
@impl true
def parse_date("-" <> string) when is_binary(string),
do: parse_date(string, -1)
def parse_date(string) when is_binary(string),
do: parse_date(string, 1)
defp parse_date(string, multiplier) do
with unquote(match_date) <- string, true <- unquote(guard_date) do
{year, month, day} = unquote(read_date)
year = multiplier * year
if valid_date?(year, month, day) do
{:ok, {year, month, day}}
else
{:error, :invalid_date}
end
else
_ ->
{:error, :invalid_format}
end
end
@doc """
Parses a naive datetime string.
## Examples
iex> Calendar.ISO.parse_naive_datetime("2015-01-23 23:50:07")
{:ok, {2015, 1, 23, 23, 50, 7, {0, 0}}}
iex> Calendar.ISO.parse_naive_datetime("2015-01-23T23:50:07")
{:ok, {2015, 1, 23, 23, 50, 7, {0, 0}}}
iex> Calendar.ISO.parse_naive_datetime("2015-01-23T23:50:07Z")
{:ok, {2015, 1, 23, 23, 50, 7, {0, 0}}}
iex> Calendar.ISO.parse_naive_datetime("2015-01-23 23:50:07.0")
{:ok, {2015, 1, 23, 23, 50, 7, {0, 1}}}
iex> Calendar.ISO.parse_naive_datetime("2015-01-23 23:50:07,0123456")
{:ok, {2015, 1, 23, 23, 50, 7, {12345, 6}}}
iex> Calendar.ISO.parse_naive_datetime("2015-01-23 23:50:07.0123456")
{:ok, {2015, 1, 23, 23, 50, 7, {12345, 6}}}
iex> Calendar.ISO.parse_naive_datetime("2015-01-23T23:50:07.123Z")
{:ok, {2015, 1, 23, 23, 50, 7, {123000, 3}}}
iex> Calendar.ISO.parse_naive_datetime("2015-01-23P23:50:07")
{:error, :invalid_format}
iex> Calendar.ISO.parse_naive_datetime("2015:01:23 23-50-07")
{:error, :invalid_format}
iex> Calendar.ISO.parse_naive_datetime("2015-01-23 23:50:07A")
{:error, :invalid_format}
iex> Calendar.ISO.parse_naive_datetime("2015-01-23 23:50:61")
{:error, :invalid_time}
iex> Calendar.ISO.parse_naive_datetime("2015-01-32 23:50:07")
{:error, :invalid_date}
iex> Calendar.ISO.parse_naive_datetime("2015-01-23T23:50:07.123+02:30")
{:ok, {2015, 1, 23, 23, 50, 7, {123000, 3}}}
iex> Calendar.ISO.parse_naive_datetime("2015-01-23T23:50:07.123+00:00")
{:ok, {2015, 1, 23, 23, 50, 7, {123000, 3}}}
iex> Calendar.ISO.parse_naive_datetime("2015-01-23T23:50:07.123-02:30")
{:ok, {2015, 1, 23, 23, 50, 7, {123000, 3}}}
iex> Calendar.ISO.parse_naive_datetime("2015-01-23T23:50:07.123-00:00")
{:error, :invalid_format}
iex> Calendar.ISO.parse_naive_datetime("2015-01-23T23:50:07.123-00:60")
{:error, :invalid_format}
iex> Calendar.ISO.parse_naive_datetime("2015-01-23T23:50:07.123-24:00")
{:error, :invalid_format}
"""
@doc since: "1.10.0"
@impl true
def parse_naive_datetime("-" <> string) when is_binary(string),
do: parse_naive_datetime(string, -1)
def parse_naive_datetime(string) when is_binary(string),
do: parse_naive_datetime(string, 1)
defp parse_naive_datetime(string, multiplier) do
with <<unquote(match_date), sep, unquote(match_time), rest::binary>> <- string,
true <- unquote(guard_date) and sep in @sep and unquote(guard_time),
{microsecond, rest} <- parse_microsecond(rest),
{_offset, ""} <- parse_offset(rest) do
{year, month, day} = unquote(read_date)
{hour, minute, second} = unquote(read_time)
year = multiplier * year
cond do
not valid_date?(year, month, day) ->
{:error, :invalid_date}
not valid_time?(hour, minute, second, microsecond) ->
{:error, :invalid_time}
true ->
{:ok, {year, month, day, hour, minute, second, microsecond}}
end
else
_ -> {:error, :invalid_format}
end
end
@doc """
Parses a UTC datetime string.
## Examples
iex> Calendar.ISO.parse_utc_datetime("2015-01-23T23:50:07Z")
{:ok, {2015, 1, 23, 23, 50, 7, {0, 0}}, 0}
iex> Calendar.ISO.parse_utc_datetime("2015-01-23T23:50:07.123+02:30")
{:ok, {2015, 1, 23, 21, 20, 7, {123000, 3}}, 9000}
iex> Calendar.ISO.parse_utc_datetime("2015-01-23T23:50:07,123+02:30")
{:ok, {2015, 1, 23, 21, 20, 7, {123000, 3}}, 9000}
iex> Calendar.ISO.parse_utc_datetime("-2015-01-23T23:50:07Z")
{:ok, {-2015, 1, 23, 23, 50, 7, {0, 0}}, 0}
iex> Calendar.ISO.parse_utc_datetime("-2015-01-23T23:50:07,123+02:30")
{:ok, {-2015, 1, 23, 21, 20, 7, {123000, 3}}, 9000}
iex> Calendar.ISO.parse_utc_datetime("2015-01-23P23:50:07")
{:error, :invalid_format}
iex> Calendar.ISO.parse_utc_datetime("2015-01-23T23:50:07")
{:error, :missing_offset}
iex> Calendar.ISO.parse_utc_datetime("2015-01-23 23:50:61")
{:error, :invalid_time}
iex> Calendar.ISO.parse_utc_datetime("2015-01-32 23:50:07")
{:error, :invalid_date}
iex> Calendar.ISO.parse_utc_datetime("2015-01-23T23:50:07.123-00:00")
{:error, :invalid_format}
"""
@doc since: "1.10.0"
@impl true
def parse_utc_datetime("-" <> string) when is_binary(string),
do: parse_utc_datetime(string, -1)
def parse_utc_datetime(string) when is_binary(string),
do: parse_utc_datetime(string, 1)
defp parse_utc_datetime(string, multiplier) do
with <<unquote(match_date), sep, unquote(match_time), rest::binary>> <- string,
true <- unquote(guard_date) and sep in @sep and unquote(guard_time),
{microsecond, rest} <- parse_microsecond(rest),
{offset, ""} <- parse_offset(rest) do
{year, month, day} = unquote(read_date)
{hour, minute, second} = unquote(read_time)
year = multiplier * year
cond do
not valid_date?(year, month, day) ->
{:error, :invalid_date}
not valid_time?(hour, minute, second, microsecond) ->
{:error, :invalid_time}
offset == 0 ->
{:ok, {year, month, day, hour, minute, second, microsecond}, offset}
is_nil(offset) ->
{:error, :missing_offset}
true ->
day_fraction = time_to_day_fraction(hour, minute, second, {0, 0})
{{year, month, day}, {hour, minute, second, _}} =
case add_day_fraction_to_iso_days({0, day_fraction}, -offset, 86400) do
{0, day_fraction} ->
{{year, month, day}, time_from_day_fraction(day_fraction)}
{extra_days, day_fraction} ->
base_days = date_to_iso_days(year, month, day)
{date_from_iso_days(base_days + extra_days), time_from_day_fraction(day_fraction)}
end
{:ok, {year, month, day, hour, minute, second, microsecond}, offset}
end
else
_ ->
{:error, :invalid_format}
end
end
@doc """
@@ -484,7 +179,7 @@ defmodule Calendar.ISO do
@doc since: "1.5.0"
@impl true
@spec time_from_day_fraction(Calendar.day_fraction()) ::
{hour(), minute(), second(), microsecond()}
{Calendar.hour(), Calendar.minute(), Calendar.second(), Calendar.microsecond()}
def time_from_day_fraction({0, _}) do
{0, 0, 0, {0, 6}}
end
@@ -517,7 +212,7 @@ defmodule Calendar.ISO do
719_528
end
def date_to_iso_days(year, month, day) do
def date_to_iso_days(year, month, day) when year in -9999..9999 do
ensure_day_in_month!(year, month, day)
days_in_previous_years(year) + days_before_month(month) + leap_day_offset(year, month) + day -
@@ -568,16 +263,14 @@ defmodule Calendar.ISO do
@doc since: "1.4.0"
@spec days_in_month(year, month) :: 28..31
@impl true
def days_in_month(year, month) when is_year(year) and is_month(month) do
days_in_month_guarded(year, month)
end
def days_in_month(year, month)
defp days_in_month_guarded(year, 2) do
def days_in_month(year, 2) do
if leap_year?(year), do: 29, else: 28
end
defp days_in_month_guarded(_, month) when month in [4, 6, 9, 11], do: 30
defp days_in_month_guarded(_, _), do: 31
def days_in_month(_, month) when month in [4, 6, 9, 11], do: 30
def days_in_month(_, month) when month in 1..12, do: 31
@doc """
Returns how many months there are in the given year.
@@ -591,8 +284,8 @@ defmodule Calendar.ISO do
@doc since: "1.7.0"
@impl true
@spec months_in_year(year) :: 12
def months_in_year(year) when is_year(year) do
12
def months_in_year(_year) do
@months_in_year
end
@doc """
@@ -615,7 +308,7 @@ defmodule Calendar.ISO do
@doc since: "1.3.0"
@spec leap_year?(year) :: boolean()
@impl true
def leap_year?(year) when is_year(year) do
def leap_year?(year) when is_integer(year) do
rem(year, 4) === 0 and (rem(year, 100) !== 0 or rem(year, 400) === 0)
end
@@ -645,11 +338,11 @@ defmodule Calendar.ISO do
"""
@doc since: "1.4.0"
@spec day_of_week(year, month, day) :: day_of_week()
@spec day_of_week(year, month, day) :: 1..7
@impl true
def day_of_week(year, month, day) do
date_to_iso_days(year, month, day)
|> iso_days_to_day_of_week()
def day_of_week(year, month, day)
when is_integer(year) and is_integer(month) and is_integer(day) do
iso_days_to_day_of_week(date_to_iso_days(year, month, day))
end
defp iso_days_to_day_of_week(iso_days) do
@@ -672,9 +365,10 @@ defmodule Calendar.ISO do
"""
@doc since: "1.8.0"
@spec day_of_year(year, month, day) :: day_of_year()
@spec day_of_year(year, month, day) :: 1..366
@impl true
def day_of_year(year, month, day) do
def day_of_year(year, month, day)
when is_integer(year) and is_integer(month) and is_integer(day) do
ensure_day_in_month!(year, month, day)
days_before_month(month) + leap_day_offset(year, month) + day
end
@@ -697,19 +391,20 @@ defmodule Calendar.ISO do
"""
@doc since: "1.8.0"
@spec quarter_of_year(year, month, day) :: quarter_of_year()
@spec quarter_of_year(year, month, day) :: 1..4
@impl true
def quarter_of_year(year, month, day)
when is_year(year) and is_month(month) and is_day(day) do
when is_integer(year) and is_integer(month) and is_integer(day) do
div(month - 1, 3) + 1
end
@doc """
Calculates the year and era from the given `year`.
The ISO calendar has two eras: the "current era" (CE) which
starts in year `1` and is defined as era `1`. And "before the current
era" (BCE) for those years less than `1`, defined as era `0`.
The ISO calendar has two eras: the current era which
starts in year 1 and is defined as era "1". And a
second era for those years less than 1 defined as
era "0".
## Examples
@@ -724,13 +419,13 @@ defmodule Calendar.ISO do
"""
@doc since: "1.8.0"
@spec year_of_era(year) :: {1..10000, era}
@spec year_of_era(year) :: {year, era :: 0..1}
@impl true
def year_of_era(year) when is_year_CE(year) do
def year_of_era(year) when is_integer(year) and year > 0 do
{year, 1}
end
def year_of_era(year) when is_year_BCE(year) do
def year_of_era(year) when is_integer(year) and year < 1 do
{abs(year) + 1, 0}
end
@@ -752,14 +447,16 @@ defmodule Calendar.ISO do
"""
@doc since: "1.8.0"
@spec day_of_era(year, month, day) :: Calendar.day_of_era()
@spec day_of_era(year, month, day) :: {day :: pos_integer(), era :: 0..1}
@impl true
def day_of_era(year, month, day) when is_year_CE(year) do
def day_of_era(year, month, day)
when is_integer(year) and is_integer(month) and is_integer(day) and year > 0 do
day = date_to_iso_days(year, month, day) - @iso_epoch + 1
{day, 1}
end
def day_of_era(year, month, day) when is_year_BCE(year) do
def day_of_era(year, month, day)
when is_integer(year) and is_integer(month) and is_integer(day) and year < 1 do
day = abs(date_to_iso_days(year, month, day) - @iso_epoch)
{day, 0}
end
@@ -795,23 +492,14 @@ defmodule Calendar.ISO do
Calendar.microsecond(),
:basic | :extended
) :: String.t()
def time_to_string(
hour,
minute,
second,
{ms_value, ms_precision} = microsecond,
format \\ :extended
)
when is_hour(hour) and is_minute(minute) and is_second(second) and
is_microsecond(ms_value, ms_precision) and format in [:basic, :extended] do
time_to_string_guarded(hour, minute, second, microsecond, format)
end
def time_to_string(hour, minute, second, microsecond, format \\ :extended)
defp time_to_string_guarded(hour, minute, second, {_, 0}, format) do
def time_to_string(hour, minute, second, {_, 0}, format) when format in [:basic, :extended] do
time_to_string_format(hour, minute, second, format)
end
defp time_to_string_guarded(hour, minute, second, {microsecond, precision}, format) do
def time_to_string(hour, minute, second, {microsecond, precision}, format)
when format in [:basic, :extended] do
time_to_string_format(hour, minute, second, format) <>
"." <> (microsecond |> zero_pad(6) |> binary_part(0, precision))
end
@@ -850,16 +538,12 @@ defmodule Calendar.ISO do
@spec date_to_string(year, month, day, :basic | :extended) :: String.t()
@impl true
def date_to_string(year, month, day, format \\ :extended)
when is_integer(year) and is_integer(month) and is_integer(day) and
format in [:basic, :extended] do
date_to_string_guarded(year, month, day, format)
end
defp date_to_string_guarded(year, month, day, :extended) do
def date_to_string(year, month, day, :extended) do
zero_pad(year, 4) <> "-" <> zero_pad(month, 2) <> "-" <> zero_pad(day, 2)
end
defp date_to_string_guarded(year, month, day, :basic) do
def date_to_string(year, month, day, :basic) do
zero_pad(year, 4) <> zero_pad(month, 2) <> zero_pad(day, 2)
end
@@ -902,7 +586,8 @@ defmodule Calendar.ISO do
second,
microsecond,
format \\ :extended
) do
)
when format in [:basic, :extended] do
date_to_string(year, month, day, format) <>
" " <> time_to_string(hour, minute, second, microsecond, format)
end
@@ -916,14 +601,6 @@ defmodule Calendar.ISO do
## Examples
iex> time_zone = "Etc/UTC"
iex> Calendar.ISO.datetime_to_string(2017, 8, 1, 1, 2, 3, {4, 5}, time_zone, "UTC", 0, 0)
"2017-08-01 01:02:03.00000Z"
iex> Calendar.ISO.datetime_to_string(2017, 8, 1, 1, 2, 3, {4, 5}, time_zone, "UTC", 3600, 0)
"2017-08-01 01:02:03.00000+01:00"
iex> Calendar.ISO.datetime_to_string(2017, 8, 1, 1, 2, 3, {4, 5}, time_zone, "UTC", 3600, 3600)
"2017-08-01 01:02:03.00000+02:00"
iex> time_zone = "Europe/Berlin"
iex> Calendar.ISO.datetime_to_string(2017, 8, 1, 1, 2, 3, {4, 5}, time_zone, "CET", 3600, 0)
"2017-08-01 01:02:03.00000+01:00 CET Europe/Berlin"
@@ -971,8 +648,7 @@ defmodule Calendar.ISO do
std_offset,
format \\ :extended
)
when is_time_zone(time_zone) and is_zone_abbr(zone_abbr) and is_utc_offset(utc_offset) and
is_std_offset(std_offset) do
when format in [:basic, :extended] do
date_to_string(year, month, day, format) <>
" " <>
time_to_string(hour, minute, second, microsecond, format) <>
@@ -980,28 +656,6 @@ defmodule Calendar.ISO do
zone_to_string(utc_offset, std_offset, zone_abbr, time_zone)
end
@doc false
def offset_to_string(0, 0, "Etc/UTC", _format), do: "Z"
def offset_to_string(utc, std, _zone, format) do
total = utc + std
second = abs(total)
minute = second |> rem(3600) |> div(60)
hour = div(second, 3600)
format_offset(total, hour, minute, format)
end
defp format_offset(total, hour, minute, :extended) do
sign(total) <> zero_pad(hour, 2) <> ":" <> zero_pad(minute, 2)
end
defp format_offset(total, hour, minute, :basic) do
sign(total) <> zero_pad(hour, 2) <> zero_pad(minute, 2)
end
defp zone_to_string(_, _, _, "Etc/UTC"), do: ""
defp zone_to_string(_, _, abbr, zone), do: " " <> abbr <> " " <> zone
@doc """
Determines if the date given is valid according to the proleptic Gregorian calendar.
@@ -1020,9 +674,9 @@ defmodule Calendar.ISO do
@doc since: "1.5.0"
@impl true
@spec valid_date?(year, month, day) :: boolean
def valid_date?(year, month, day)
when is_integer(year) and is_integer(month) and is_integer(day) do
is_year(year) and is_month(month) and day in 1..days_in_month(year, month)
def valid_date?(year, month, day) do
month in 1..12 and year in -9999..9999 and
(is_integer(day) and day >= 1 and day <= days_in_month(year, month))
end
@doc """
@@ -1046,11 +700,9 @@ defmodule Calendar.ISO do
@impl true
@spec valid_time?(Calendar.hour(), Calendar.minute(), Calendar.second(), Calendar.microsecond()) ::
boolean
def valid_time?(hour, minute, second, {ms_value, ms_precision} = _microsecond)
when is_integer(hour) and is_integer(minute) and is_integer(second) and is_integer(ms_value) and
is_integer(ms_value) do
is_hour(hour) and is_minute(minute) and is_second(second) and
is_microsecond(ms_value, ms_precision)
def valid_time?(hour, minute, second, {microsecond, precision}) do
hour in 0..23 and minute in 0..59 and second in 0..59 and microsecond in 0..999_999 and
precision in 0..6
end
@doc """
@@ -1063,6 +715,27 @@ defmodule Calendar.ISO do
{0, 1}
end
defp offset_to_string(0, 0, "Etc/UTC", _format), do: "Z"
defp offset_to_string(utc, std, _zone, format) do
total = utc + std
second = abs(total)
minute = second |> rem(3600) |> div(60)
hour = div(second, 3600)
format_offset(total, hour, minute, format)
end
defp format_offset(total, hour, minute, :extended) do
sign(total) <> zero_pad(hour, 2) <> ":" <> zero_pad(minute, 2)
end
defp format_offset(total, hour, minute, :basic) do
sign(total) <> zero_pad(hour, 2) <> zero_pad(minute, 2)
end
defp zone_to_string(0, 0, _abbr, "Etc/UTC"), do: ""
defp zone_to_string(_, _, abbr, zone), do: " " <> abbr <> " " <> zone
defp sign(total) when total < 0, do: "-"
defp sign(_), do: "+"
@@ -1104,7 +777,44 @@ defmodule Calendar.ISO do
end
end
defp parse_microsecond("." <> rest) do
@doc false
def naive_datetime_to_iso8601(
year,
month,
day,
hour,
minute,
second,
microsecond,
format \\ :extended
) do
date_to_string(year, month, day, format) <>
"T" <> time_to_string(hour, minute, second, microsecond, format)
end
@doc false
def datetime_to_iso8601(
year,
month,
day,
hour,
minute,
second,
microsecond,
time_zone,
_zone_abbr,
utc_offset,
std_offset,
format \\ :extended
) do
date_to_string(year, month, day, format) <>
"T" <>
time_to_string(hour, minute, second, microsecond, format) <>
offset_to_string(utc_offset, std_offset, time_zone, format)
end
@doc false
def parse_microsecond("." <> rest) do
case parse_microsecond(rest, 0, "") do
{"", 0, _} ->
:error
@@ -1118,11 +828,11 @@ defmodule Calendar.ISO do
end
end
defp parse_microsecond("," <> rest) do
def parse_microsecond("," <> rest) do
parse_microsecond("." <> rest)
end
defp parse_microsecond(rest) do
def parse_microsecond(rest) do
{{0, 0}, rest}
end
@@ -1131,25 +841,26 @@ defmodule Calendar.ISO do
defp parse_microsecond(rest, precision, acc), do: {acc, precision, rest}
defp parse_offset(""), do: {nil, ""}
defp parse_offset("Z"), do: {0, ""}
defp parse_offset("-00:00"), do: :error
@doc false
def parse_offset(""), do: {nil, ""}
def parse_offset("Z"), do: {0, ""}
def parse_offset("-00:00"), do: :error
defp parse_offset(<<?+, hour::2-bytes, ?:, min::2-bytes, rest::binary>>),
def parse_offset(<<?+, hour::2-bytes, ?:, min::2-bytes, rest::binary>>),
do: parse_offset(1, hour, min, rest)
defp parse_offset(<<?-, hour::2-bytes, ?:, min::2-bytes, rest::binary>>),
def parse_offset(<<?-, hour::2-bytes, ?:, min::2-bytes, rest::binary>>),
do: parse_offset(-1, hour, min, rest)
defp parse_offset(<<?+, hour::2-bytes, min::2-bytes, rest::binary>>),
def parse_offset(<<?+, hour::2-bytes, min::2-bytes, rest::binary>>),
do: parse_offset(1, hour, min, rest)
defp parse_offset(<<?-, hour::2-bytes, min::2-bytes, rest::binary>>),
def parse_offset(<<?-, hour::2-bytes, min::2-bytes, rest::binary>>),
do: parse_offset(-1, hour, min, rest)
defp parse_offset(<<?+, hour::2-bytes, rest::binary>>), do: parse_offset(1, hour, "00", rest)
defp parse_offset(<<?-, hour::2-bytes, rest::binary>>), do: parse_offset(-1, hour, "00", rest)
defp parse_offset(_), do: :error
def parse_offset(<<?+, hour::2-bytes, rest::binary>>), do: parse_offset(1, hour, "00", rest)
def parse_offset(<<?-, hour::2-bytes, rest::binary>>), do: parse_offset(-1, hour, "00", rest)
def parse_offset(_), do: :error
defp parse_offset(sign, hour, min, rest) do
with {hour, ""} when hour < 24 <- Integer.parse(hour),
@@ -1326,7 +1037,7 @@ defmodule Calendar.ISO do
{hour, minute, second}
end
defp ensure_day_in_month!(year, month, day) when is_integer(day) do
defp ensure_day_in_month!(year, month, day) do
if day < 1 or day > days_in_month(year, month) do
raise ArgumentError, "invalid date: #{date_to_string(year, month, day)}"
end
+49 -74
View File
@@ -117,53 +117,6 @@ defmodule NaiveDateTime do
|> DateTime.to_naive()
end
@doc """
Returns the "local time" for the machine the Elixir program is running on.
WARNING: This function can cause insidious bugs. It depends on the time zone
configuration at run time. This can changed and be set to a time zone that has
daylight saving jumps (spring forward or fall back).
This function can be used to display what the time is right now for the time
zone configuration that the machine happens to have. An example would be a
desktop program displaying a clock to the user. For any other uses it is
probably a bad idea to use this function.
For most cases, use `DateTime.now/2` or `DateTime.utc_now/1` instead.
Does not include fractional seconds.
## Examples
iex> naive_datetime = NaiveDateTime.local_now()
iex> naive_datetime.year >= 2019
true
"""
@doc since: "1.10.0"
@spec local_now(Calendar.calendar()) :: t
def local_now(calendar \\ Calendar.ISO)
def local_now(Calendar.ISO) do
{{year, month, day}, {hour, minute, second}} = :erlang.localtime()
{:ok, ndt} = NaiveDateTime.new(year, month, day, hour, minute, second)
ndt
end
def local_now(calendar) do
naive_datetime = local_now()
case convert(naive_datetime, calendar) do
{:ok, value} ->
value
{:error, :incompatible_calendars} ->
raise ArgumentError,
~s(cannot get "local now" in target calendar #{inspect(calendar)}, ) <>
"reason: cannot convert from Calendar.ISO to #{inspect(calendar)}."
end
end
@doc """
Builds a new ISO naive datetime.
@@ -208,7 +161,7 @@ defmodule NaiveDateTime do
Calendar.hour(),
Calendar.minute(),
Calendar.second(),
Calendar.microsecond() | non_neg_integer,
Calendar.microsecond(),
Calendar.calendar()
) :: {:ok, t} | {:error, atom}
def new(year, month, day, hour, minute, second, microsecond \\ {0, 0}, calendar \\ Calendar.ISO)
@@ -581,21 +534,35 @@ defmodule NaiveDateTime do
"""
@spec from_iso8601(String.t(), Calendar.calendar()) :: {:ok, t} | {:error, atom}
def from_iso8601(string, calendar \\ Calendar.ISO) do
with {:ok, {year, month, day, hour, minute, second, microsecond}} <-
Calendar.ISO.parse_naive_datetime(string) do
convert(
%NaiveDateTime{
year: year,
month: month,
day: day,
hour: hour,
minute: minute,
second: second,
microsecond: microsecond
},
calendar
)
def from_iso8601(string, calendar \\ Calendar.ISO)
def from_iso8601(<<?-, rest::binary>>, calendar) do
with {:ok, %{year: year} = naive_datetime} <- raw_from_iso8601(rest, calendar) do
{:ok, %{naive_datetime | year: -year}}
end
end
def from_iso8601(<<rest::binary>>, calendar) do
raw_from_iso8601(rest, calendar)
end
@sep [?\s, ?T]
[match_date, guard_date, read_date] = Calendar.ISO.__match_date__()
[match_time, guard_time, read_time] = Calendar.ISO.__match_time__()
defp raw_from_iso8601(string, calendar) do
with <<unquote(match_date), sep, unquote(match_time), rest::binary>> <- string,
true <- unquote(guard_date) and sep in @sep and unquote(guard_time),
{microsec, rest} <- Calendar.ISO.parse_microsecond(rest),
{_offset, ""} <- Calendar.ISO.parse_offset(rest) do
{year, month, day} = unquote(read_date)
{hour, min, sec} = unquote(read_time)
with {:ok, iso_naive_dt} <- new(year, month, day, hour, min, sec, microsec, Calendar.ISO) do
convert(iso_naive_dt, calendar)
end
else
_ -> {:error, :invalid_format}
end
end
@@ -673,8 +640,16 @@ defmodule NaiveDateTime do
microsecond: microsecond
} = naive_datetime
Calendar.ISO.date_to_string(year, month, day, format) <>
"T" <> Calendar.ISO.time_to_string(hour, minute, second, microsecond, format)
Calendar.ISO.naive_datetime_to_iso8601(
year,
month,
day,
hour,
minute,
second,
microsecond,
format
)
end
def to_iso8601(%{calendar: _} = naive_datetime, format) when format in [:basic, :extended] do
@@ -697,8 +672,8 @@ defmodule NaiveDateTime do
iex> NaiveDateTime.to_erl(~N[2000-01-01 13:30:15])
{{2000, 1, 1}, {13, 30, 15}}
This function can also be used to convert a DateTime to an Erlang
datetime tuple without the time zone information:
This function can also be used to convert a DateTime to a erl format
without the time zone information:
iex> dt = %DateTime{year: 2000, month: 2, day: 29, zone_abbr: "CET",
...> hour: 23, minute: 0, second: 7, microsecond: {0, 0},
@@ -961,7 +936,7 @@ defmodule NaiveDateTime do
end
defimpl Inspect do
def inspect(naive_datetime, _) do
def inspect(%{calendar: Calendar.ISO} = naive_datetime, _) do
%{
year: year,
month: month,
@@ -969,17 +944,17 @@ defmodule NaiveDateTime do
hour: hour,
minute: minute,
second: second,
microsecond: microsecond,
calendar: calendar
microsecond: microsecond
} = naive_datetime
formatted =
calendar.naive_datetime_to_string(year, month, day, hour, minute, second, microsecond)
Calendar.ISO.naive_datetime_to_string(year, month, day, hour, minute, second, microsecond)
"~N[" <> formatted <> suffix(calendar) <> "]"
"~N[" <> formatted <> "]"
end
defp suffix(Calendar.ISO), do: ""
defp suffix(calendar), do: " " <> inspect(calendar)
def inspect(naive, opts) do
Inspect.Any.inspect(naive, opts)
end
end
end
+31 -13
View File
@@ -110,7 +110,7 @@ defmodule Time do
Calendar.hour(),
Calendar.minute(),
Calendar.second(),
Calendar.microsecond() | non_neg_integer,
Calendar.microsecond() | integer,
Calendar.calendar()
) :: {:ok, t} | {:error, atom}
def new(hour, minute, second, microsecond \\ {0, 0}, calendar \\ Calendar.ISO)
@@ -213,12 +213,30 @@ defmodule Time do
"""
@spec from_iso8601(String.t(), Calendar.calendar()) :: {:ok, t} | {:error, atom}
def from_iso8601(string, calendar \\ Calendar.ISO) do
with {:ok, {hour, minute, second, microsecond}} <- Calendar.ISO.parse_time(string) do
convert(
%Time{hour: hour, minute: minute, second: second, microsecond: microsecond},
calendar
)
def from_iso8601(string, calendar \\ Calendar.ISO)
def from_iso8601(<<?T, rest::binary>>, calendar) do
raw_from_iso8601(rest, calendar)
end
def from_iso8601(<<rest::binary>>, calendar) do
raw_from_iso8601(rest, calendar)
end
[match_time, guard_time, read_time] = Calendar.ISO.__match_time__()
defp raw_from_iso8601(string, calendar) do
with <<unquote(match_time), rest::binary>> <- string,
true <- unquote(guard_time),
{microsec, rest} <- Calendar.ISO.parse_microsecond(rest),
{_offset, ""} <- Calendar.ISO.parse_offset(rest) do
{hour, min, sec} = unquote(read_time)
with {:ok, utc_time} <- new(hour, min, sec, microsec, Calendar.ISO) do
convert(utc_time, calendar)
end
else
_ -> {:error, :invalid_format}
end
end
@@ -675,20 +693,20 @@ defmodule Time do
end
defimpl Inspect do
def inspect(time, _) do
def inspect(%{calendar: Calendar.ISO} = time, _) do
%{
hour: hour,
minute: minute,
second: second,
microsecond: microsecond,
calendar: calendar
calendar: Calendar.ISO
} = time
"~T[" <>
calendar.time_to_string(hour, minute, second, microsecond) <> suffix(calendar) <> "]"
"~T[" <> Calendar.ISO.time_to_string(hour, minute, second, microsecond) <> "]"
end
defp suffix(Calendar.ISO), do: ""
defp suffix(calendar), do: " " <> inspect(calendar)
def inspect(time, opts) do
Inspect.Any.inspect(time, opts)
end
end
end
+106 -316
View File
@@ -1,5 +1,5 @@
defmodule Code do
@moduledoc ~S"""
@moduledoc """
Utilities for managing code compilation, code evaluation, and code loading.
This module complements Erlang's [`:code` module](http://www.erlang.org/doc/man/code.html)
@@ -19,8 +19,7 @@ defmodule Code do
* `eval_file/2` - evaluates the file contents without tracking its name. It
returns the result of the last expression in the file, instead of the modules
defined in it. Evaluated files do not trigger the compilation tracers described
in the next section.
defined in it.
In a nutshell, the first must be used when you want to keep track of the files
handled by the system, to avoid the same file from being compiled multiple
@@ -29,100 +28,9 @@ defmodule Code do
`compile_file/2` must be used when you are interested in the modules defined in a
file, without tracking. `eval_file/2` should be used when you are interested in
the result of evaluating the file rather than the modules it defines.
## Compilation tracers
Elixir supports compilation tracers, which allows modules to observe constructs
handled by the Elixir compiler when compiling files. A tracer is a module
that implements the `trace/2` function. The function receives the event name
as first argument and `Macro.Env` as second and it must return `:ok`. It is
very important for a tracer to do as little work as possible synchronously
and dispatch the bulk of the work to a separate process. **Slow tracers will
slow down compilation**.
You can configure your list of tracers via `put_compiler_option/2`. The
following events are available to tracers:
* `:start` - (since v1.11.0) invoked whenever the compiler starts to trace
a new lexical context, such as a new file. Keep in mind the compiler runs
in parallel, so multiple files may invoke `:start` and run at the same
time. The value of the `lexical_tracker` of the macro environment, albeit
opaque, can be used to uniquely identify the environment.
* `:stop` - (since v1.11.0) invoked whenever the compiler stops tracing a
new lexical context, such as a new file.
* `{:import, meta, module, opts}` - traced whenever `module` is imported.
`meta` is the import AST metadata and `opts` are the import options.
* `{:imported_function, meta, module, name, arity}` and
`{:imported_macro, meta, module, name, arity}` - traced whenever an
imported function or macro is invoked. `meta` is the call AST metadata,
`module` is the module the import is from, followed by the `name` and `arity`
of the imported function/macro.
* `{:alias, meta, alias, as, opts}` - traced whenever `alias` is aliased
to `as`. `meta` is the alias AST metadata and `opts` are the alias options.
* `{:alias_expansion, meta, as, alias}` traced whenever there is an alias
expansion for a previously defined `alias`, i.e. when the user writes `as`
which is expanded to `alias`. `meta` is the alias expansion AST metadata.
* `{:alias_reference, meta, module}` - traced whenever there is an alias
in the code, i.e. whenever the user writes `MyModule.Foo.Bar` in the code,
regardless if it was expanded or not.
* `{:require, meta, module, opts}` - traced whenever `module` is required.
`meta` is the require AST metadata and `opts` are the require options.
* `{:struct_expansion, meta, module, keys}` - traced whenever `module`'s struct
is expanded. `meta` is the struct AST metadata and `keys` are the keys being
used by expansion
* `{:remote_function, meta, module, name, arity}` and
`{:remote_macro, meta, module, name, arity}` - traced whenever a remote
function or macro is referenced. `meta` is the call AST metadata, `module`
is the invoked module, followed by the `name` and `arity`.
* `{:local_function, meta, name, arity}` and
`{:local_macro, meta, name, arity}` - traced whenever a local
function or macro is referenced. `meta` is the call AST metadata, `module`
is the invoked module, followed by the `name` and `arity`.
* `{:compile_env, app, path, return}` - traced whenever `Application.compile_env/3`
or `Application.compile_env!/2` are called. `app` is an atom, `path` is a list
of keys to traverse in the application environemnt and `return` is either
`{:ok, value}` or `:error`.
The `:tracers` compiler option can be combined with the `:parser_options`
compiler option to enrich the metadata of the traced events above.
New events may be added at any time in the future, therefore it is advised
for the `trace/2` function to have a "catch-all" clause.
Below is an example tracer that prints all remote function invocations:
defmodule MyTracer do
def trace({:remote_function, _meta, module, name, arity}, env) do
IO.puts "#{env.file}:#{env.line} #{inspect(module)}.#{name}/#{arity}"
:ok
end
def trace(_event, _env) do
:ok
end
end
"""
@typedoc """
A list with all variable bindings.
The binding keys are usually atoms, but they may be a tuple for variables
defined in a different context.
"""
@type binding :: [{atom() | tuple(), any}]
@boolean_compiler_options [
@available_compiler_options [
:docs,
:debug_info,
:ignore_module_conflict,
@@ -130,10 +38,6 @@ defmodule Code do
:warnings_as_errors
]
@list_compiler_options [:no_warn_undefined, :tracers, :parser_options]
@available_compiler_options @boolean_compiler_options ++ @list_compiler_options
@doc """
Lists all required files.
@@ -150,7 +54,7 @@ defmodule Code do
:elixir_code_server.call(:required)
end
@deprecated "Use Code.required_files/0 instead"
# TODO: Deprecate on v1.9
@doc false
def loaded_files do
required_files()
@@ -182,7 +86,7 @@ defmodule Code do
:elixir_code_server.cast({:unrequire_files, files})
end
@deprecated "Use Code.unrequire_files/1 instead"
# TODO: Deprecate on v1.9
@doc false
def unload_files(files) do
unrequire_files(files)
@@ -259,7 +163,7 @@ defmodule Code do
@doc """
Evaluates the contents given by `string`.
The `binding` argument is a list of variable bindings.
The `binding` argument is a keyword list of variable bindings.
The `opts` argument is a keyword list of environment options.
**Warning**: `string` can be any Elixir code and will be executed with
@@ -300,8 +204,8 @@ defmodule Code do
where `value` is the value returned from evaluating `string`.
If an error occurs while evaluating `string` an exception will be raised.
`binding` is a list with all variable bindings
after evaluating `string`. The binding keys are usually atoms, but they
`binding` is a keyword list with the value of all variable bindings
after evaluating `string`. The binding key is usually an atom, but it
may be a tuple for variables defined in a different context.
## Examples
@@ -323,22 +227,17 @@ defmodule Code do
{3, [a: 1, b: 2]}
"""
@spec eval_string(List.Chars.t(), binding, Macro.Env.t() | keyword) :: {term, binding}
@spec eval_string(List.Chars.t(), list, Macro.Env.t() | keyword) :: {term, binding :: list}
def eval_string(string, binding \\ [], opts \\ [])
def eval_string(string, binding, %Macro.Env{} = env) do
eval_string_with_error_handling(string, binding, Map.to_list(env))
{value, binding, _env, _scope} = :elixir.eval(to_charlist(string), binding, Map.to_list(env))
{value, binding}
end
def eval_string(string, binding, opts) when is_list(opts) do
validate_eval_opts(opts)
eval_string_with_error_handling(string, binding, opts)
end
defp eval_string_with_error_handling(string, binding, opts) do
%{line: line, file: file} = env = :elixir.env_for_eval(opts)
forms = :elixir.string_to_quoted!(to_charlist(string), line, file, [])
{value, binding, _env} = :elixir.eval_forms(forms, binding, env)
{value, binding, _env, _scope} = :elixir.eval(to_charlist(string), binding, opts)
{value, binding}
end
@@ -395,7 +294,7 @@ defmodule Code do
a whole.
The formatter does not hard code names. The formatter will not behave
specially because a function is named `defmodule`, `def`, or the like. This
specially because a function is named `defmodule`, `def`, etc. This
principle mirrors Elixir's goal of being an extensible language where
developers can extend the language with new constructs as if they were
part of the language. When it is absolutely necessary to change behaviour
@@ -532,7 +431,7 @@ defmodule Code do
rules in the future. The goal of documenting them is to provide better
understanding on what to expect from the formatter.
### Multi-line lists, maps, tuples, and the like
### Multi-line lists, maps, tuples, etc.
You can force lists, tuples, bitstrings, maps, structs and function
calls to have one entry per line by adding a newline after the opening
@@ -677,7 +576,7 @@ defmodule Code do
Macro arguments are typically transformed by unquoting them into the
returned quoted expressions (instead of evaluated).
See `eval_string/3` for a description of `binding` and options.
See `eval_string/3` for a description of bindings and options.
## Examples
@@ -693,17 +592,17 @@ defmodule Code do
{3, [a: 1, b: 2]}
"""
@spec eval_quoted(Macro.t(), binding, Macro.Env.t() | keyword) :: {term, binding}
@spec eval_quoted(Macro.t(), list, Macro.Env.t() | keyword) :: {term, binding :: list}
def eval_quoted(quoted, binding \\ [], opts \\ [])
def eval_quoted(quoted, binding, %Macro.Env{} = env) do
{value, binding, _env} = :elixir.eval_quoted(quoted, binding, Map.to_list(env))
{value, binding, _env, _scope} = :elixir.eval_quoted(quoted, binding, Map.to_list(env))
{value, binding}
end
def eval_quoted(quoted, binding, opts) when is_list(opts) do
validate_eval_opts(opts)
{value, binding, _env} = :elixir.eval_quoted(quoted, binding, opts)
{value, binding, _env, _scope} = :elixir.eval_quoted(quoted, binding, opts)
{value, binding}
end
@@ -745,7 +644,7 @@ defmodule Code do
end
end
@doc ~S"""
@doc """
Converts the given string to its quoted form.
Returns `{:ok, quoted_form}` if it succeeds,
@@ -766,23 +665,11 @@ defmodule Code do
when non-existing atoms are found by the tokenizer.
Defaults to `false`.
* `:token_metadata` (since v1.10.0) - when `true`, includes token-related
metadata in the expression AST, such as metadata for `do` and `end`
tokens, for closing tokens, end of expressions, as well as delimiters
for sigils. See `t:Macro.metadata/0`. Defaults to `false`.
* `:literal_encoder` (since v1.10.0) - how to encode literals in the AST.
It must be a function that receives two arguments, the literal and its
metadata, and it must return `{:ok, ast :: Macro.t}` or
`{:error, reason :: binary}`. If you return anything than the literal
itself as the `term`, then the AST is no longer valid. This option
may still useful for textual analysis of the source code.
* `:static_atoms_encoder` - the static atom encoder function, see
"The `:static_atoms_encoder` function" section below. Note this
option overrides the `:existing_atoms_only` behaviour for static
atoms but `:existing_atoms_only` is still used for dynamic atoms,
such as atoms with interpolations.
* `:static_atom_encoder` - The static atom encoder function, see
"The `:static_atom_encoder` function" section below. This option
overrides the `:existing_atoms_only` behaviour for static atoms
but `:existing_atoms_only` is still used for dynamic atoms, such
as atoms with interpolations.
* `:warn_on_unnecessary_quotes` - when `false`, does not warn
when atoms, keywords or calls have unnecessary quotes on
@@ -794,9 +681,9 @@ defmodule Code do
`Macro.to_string/2`, which converts a quoted form to a string/binary
representation.
## The `:static_atoms_encoder` function
## The `:static_atom_encoder` function
When `static_atoms_encoder: &my_encoder/2` is passed as an argument,
When `static_atom_encoder: &my_encoder/2` is passed as an argument,
`my_encoder/2` is called every time the tokenizer needs to create a
"static" atom. Static atoms are atoms in the AST that function as
aliases, remote calls, local calls, variable names, regular atoms
@@ -807,8 +694,8 @@ defmodule Code do
`{:ok, token :: term} | {:error, reason :: binary}`.
The encoder function is supposed to create an atom from the given
string. To produce a valid AST, it is required to return `{:ok, term}`,
where `term` is an atom. It is possible to return something other than an atom,
string. It is required to return either `{:ok, term}`, where term is
an atom. It is possible to return something else than an atom,
however, in that case the AST is no longer "valid" in that it cannot
be used to compile or evaluate Elixir code. A use case for this is
if you want to use the Elixir parser in a user-facing situation, but
@@ -821,7 +708,7 @@ defmodule Code do
* syntax keywords (`fn`, `do`, `else`, and so on)
* atoms containing interpolation (`:"#{1 + 1} is two"`), as these
* atoms containing interpolation (`:"\#{1 + 1} is two"`), as these
atoms are constructed at runtime.
"""
@@ -864,22 +751,22 @@ defmodule Code do
While `require_file/2` and `compile_file/2` return the loaded modules and their
bytecode, `eval_file/2` simply evaluates the file contents and returns the
evaluation result and its binding (exactly the same return value as `eval_string/3`).
evaluation result and its bindings (exactly the same return value as `eval_string/3`).
"""
@spec eval_file(binary, nil | binary) :: {term, binding}
@spec eval_file(binary, nil | binary) :: {term, binding :: list}
def eval_file(file, relative_to \\ nil) when is_binary(file) do
file = find_file(file, relative_to)
eval_string(File.read!(file), [], file: file, line: 1)
end
@deprecated "Use Code.require_file/2 or Code.compile_file/2 instead"
# TODO: Deprecate on v1.9
@doc false
def load_file(file, relative_to \\ nil) when is_binary(file) do
file = find_file(file, relative_to)
:elixir_code_server.call({:acquire, file})
loaded = :elixir_compiler.file(file, fn _, _ -> :ok end)
:elixir_code_server.cast({:required, file})
verify_loaded(loaded)
loaded
end
@doc """
@@ -925,15 +812,14 @@ defmodule Code do
:proceed ->
loaded = :elixir_compiler.file(file, fn _, _ -> :ok end)
:elixir_code_server.cast({:required, file})
verify_loaded(loaded)
loaded
end
end
@doc """
Gets all compilation options from the code server.
Gets the compilation options from the code server.
To get invidual options, see `get_compiler_option/1`.
For a description of all options, see `put_compiler_option/2`.
Check `compiler_options/1` for more information.
## Examples
@@ -941,54 +827,15 @@ defmodule Code do
#=> %{debug_info: true, docs: true, ...}
"""
@spec compiler_options :: map
@spec compiler_options() :: %{optional(atom) => boolean}
def compiler_options do
for key <- @available_compiler_options, into: %{} do
{key, :elixir_config.get(key)}
end
:elixir_config.get(:compiler_options)
end
@doc """
Stores all given compilation options.
Returns a list with the available compiler options.
To store invidual options, see `put_compiler_option/2`.
For a description of all options, see `put_compiler_option/2`.
## Examples
Code.compiler_options()
#=> %{debug_info: true, docs: true, ...}
"""
@spec compiler_options(Enumerable.t()) :: %{optional(atom) => boolean}
def compiler_options(opts) do
for {key, value} <- opts, into: %{} do
put_compiler_option(key, value)
{key, value}
end
end
@doc """
Returns the value of a given compiler option.
For a description of all options, see `put_compiler_option/2`.
## Examples
Code.get_compiler_option(:debug_info)
#=> true
"""
@doc since: "1.10.0"
@spec get_compiler_option(atom) :: term
def get_compiler_option(key) when key in @available_compiler_options do
:elixir_config.get(key)
end
@doc """
Returns a list with all available compiler options.
For a description of all options, see `put_compiler_option/2`.
See `compiler_options/1` for more information.
## Examples
@@ -1001,101 +848,11 @@ defmodule Code do
@available_compiler_options
end
@doc """
Stores a compilation option.
These options are global since they are stored by Elixir's code server.
Available options are:
* `:docs` - when `true`, retain documentation in the compiled module.
Defaults to `true`.
* `:debug_info` - when `true`, retain debug information in the compiled
module. This allows a developer to reconstruct the original source
code. Defaults to `true`.
* `:ignore_module_conflict` - when `true`, override modules that were
already defined without raising errors. Defaults to `false`.
* `:relative_paths` - when `true`, use relative paths in quoted nodes,
warnings and errors generated by the compiler. Note disabling this option
won't affect runtime warnings and errors. Defaults to `true`.
* `:warnings_as_errors` - causes compilation to fail when warnings are
generated. Defaults to `false`.
* `:no_warn_undefined` (since v1.10.0) - list of modules and `{Mod, fun, arity}`
tuples that will not emit warnings that the module or function does not exist
at compilation time. Pass atom `:all` to skip warning for all undefined
functions. This can be useful when doing dynamic compilation. Defaults to `[]`.
* `:tracers` (since v1.10.0) - a list of tracers (modules) to be used during
compilation. See the module docs for more information. Defaults to `[]`.
* `:parser_options` (since v1.10.0) - a keyword list of options to be given
to the parser when compiling files. It accepts the same options as
`string_to_quoted/2` (except by the options that change the AST itself).
This can be used in combination with the tracer to retrieve localized
information about events happening during compilation. Defaults to `[]`.
It always returns `:ok`. Raises an error for invalid options.
## Examples
Code.put_compiler_option(:debug_info, true)
#=> :ok
"""
@doc since: "1.10.0"
@spec put_compiler_option(atom, term) :: :ok
def put_compiler_option(key, value) when key in @boolean_compiler_options do
if not is_boolean(value) do
raise "compiler option #{inspect(key)} should be a boolean, got: #{inspect(value)}"
end
:elixir_config.put(key, value)
:ok
end
def put_compiler_option(:no_warn_undefined, value) do
if value != :all and not is_list(value) do
raise "compiler option :no_warn_undefined should be a list or the atom :all, " <>
"got: #{inspect(value)}"
end
:elixir_config.put(:no_warn_undefined, value)
:ok
end
def put_compiler_option(key, value) when key in @list_compiler_options do
if not is_list(value) do
raise "compiler option #{inspect(key)} should be a list, got: #{inspect(value)}"
end
if key == :parser_options and not Keyword.keyword?(value) do
raise "compiler option #{inspect(key)} should be a keyword list, " <>
"got: #{inspect(value)}"
end
if key == :tracers and not Enum.all?(value, &is_atom/1) do
raise "compiler option #{inspect(key)} should be a list of modules, " <>
"got: #{inspect(value)}"
end
:elixir_config.put(key, value)
:ok
end
def put_compiler_option(key, _value) do
raise "unknown compiler option: #{inspect(key)}"
end
@doc """
Purge compiler modules.
The compiler utilizes temporary modules to compile code. For example,
`elixir_compiler_1`, `elixir_compiler_2`, and so on. In case the compiled code
`elixir_compiler_1`, `elixir_compiler_2`, etc. In case the compiled code
stores references to anonymous functions or similar, the Elixir compiler
may be unable to reclaim those modules, keeping an unnecessary amount of
code in memory and eventually leading to modules such as `elixir_compiler_12345`.
@@ -1112,6 +869,54 @@ defmodule Code do
:elixir_code_server.call(:purge_compiler_modules)
end
@doc """
Sets compilation options.
These options are global since they are stored by Elixir's Code Server.
Available options are:
* `:docs` - when `true`, retain documentation in the compiled module.
Defaults to `true`.
* `:debug_info` - when `true`, retain debug information in the compiled
module. This allows a developer to reconstruct the original source
code. Defaults to `false`.
* `:ignore_module_conflict` - when `true`, override modules that were
already defined without raising errors. Defaults to `false`.
* `:relative_paths` - when `true`, use relative paths in quoted nodes,
warnings and errors generated by the compiler. Note disabling this option
won't affect runtime warnings and errors. Defaults to `true`.
* `:warnings_as_errors` - causes compilation to fail when warnings are
generated. Defaults to `false`.
It returns the new map of compiler options.
## Examples
Code.compiler_options(debug_info: true)
#=> %{debug_info: true, docs: true,
#=> warnings_as_errors: false, ignore_module_conflict: false}
"""
@spec compiler_options(Enumerable.t()) :: %{optional(atom) => boolean}
def compiler_options(opts) do
Enum.each(opts, fn
{key, value} when key in @available_compiler_options ->
if not is_boolean(value) do
raise "compiler option #{inspect(key)} should be a boolean, got: #{inspect(value)}"
end
{key, _} ->
raise "unknown compiler option: #{inspect(key)}"
end)
:elixir_config.update(:compiler_options, &Enum.into(opts, &1))
end
@doc """
Compiles the given string.
@@ -1128,8 +933,7 @@ defmodule Code do
"""
@spec compile_string(List.Chars.t(), binary) :: [{module, binary}]
def compile_string(string, file \\ "nofile") when is_binary(file) do
loaded = :elixir_compiler.string(to_charlist(string), file, fn _, _ -> :ok end)
Enum.map(loaded, fn {module, _map, binary} -> {module, binary} end)
:elixir_compiler.string(to_charlist(string), file, fn _, _ -> :ok end)
end
@doc """
@@ -1142,8 +946,7 @@ defmodule Code do
"""
@spec compile_quoted(Macro.t(), binary) :: [{module, binary}]
def compile_quoted(quoted, file \\ "nofile") when is_binary(file) do
loaded = :elixir_compiler.quoted(quoted, file, fn _, _ -> :ok end)
Enum.map(loaded, fn {module, _map, binary} -> {module, binary} end)
:elixir_compiler.quoted(quoted, file, fn _, _ -> :ok end)
end
@doc """
@@ -1163,8 +966,7 @@ defmodule Code do
@doc since: "1.7.0"
@spec compile_file(binary, nil | binary) :: [{module, binary}]
def compile_file(file, relative_to \\ nil) when is_binary(file) do
loaded = :elixir_compiler.file(find_file(file, relative_to), fn _, _ -> :ok end)
verify_loaded(loaded)
:elixir_compiler.file(find_file(file, relative_to), fn _, _ -> :ok end)
end
@doc """
@@ -1247,39 +1049,27 @@ defmodule Code do
Ensures the given module is compiled and loaded.
If the module is already loaded, it works as no-op. If the module was
not compiled yet, `ensure_compiled/1` halts the compilation of the caller
until the module given to `ensure_compiled/1` becomes available or
all files for the current project have been compiled. If compilation
finishes and the module is not available, an error tuple is returned.
Given this function halts compilation, use it carefully. In particular,
avoid using it to guess which modules are in the system. Overuse of this
function can also lead to deadlocks, where two modules check at the same time
if the other is compiled. This returns a specific unavailable error code,
where we cannot successfully verify a module is available or not.
not loaded yet, it checks if it needs to be compiled first and then
tries to load it.
If it succeeds in loading the module, it returns `{:module, module}`.
If not, returns `{:error, reason}` with the error reason.
If the module being checked is currently in a compiler deadlock,
this function returns `{:error, :unavailable}`. Unavailable doesn't
necessarily mean the module doesn't exist, just that it is not currently
available, but it (or may not) become available in the future.
this functions returns `{:error, :nofile}`.
Check `ensure_loaded/1` for more information on module loading
and when to use `ensure_loaded/1` or `ensure_compiled/1`.
"""
@spec ensure_compiled(module) ::
{:module, module}
| {:error, :embedded | :badfile | :nofile | :on_load_failure | :unavailable}
{:module, module} | {:error, :embedded | :badfile | :nofile | :on_load_failure}
def ensure_compiled(module) when is_atom(module) do
case :code.ensure_loaded(module) do
{:error, :nofile} = error ->
if is_pid(:erlang.get(:elixir_compiler_pid)) do
case Kernel.ErrorHandler.ensure_compiled(module, :module, :soft) do
:found -> {:module, module}
:deadlock -> {:error, :unavailable}
:not_found -> {:error, :nofile}
:not_found -> error
end
else
error
@@ -1290,8 +1080,14 @@ defmodule Code do
end
end
@doc false
@deprecated "Use Code.ensure_compiled/1 instead (see the proper disclaimers in its docs)"
@doc """
Ensures the given module is compiled and loaded.
Similar to `ensure_compiled/1`, but returns `true` if the module
is already loaded or was successfully loaded and compiled.
Returns `false` otherwise.
"""
@spec ensure_compiled?(module) :: boolean
def ensure_compiled?(module) when is_atom(module) do
match?({:module, ^module}, ensure_compiled(module))
end
@@ -1313,7 +1109,7 @@ defmodule Code do
# Module documentation of an existing module
iex> {:docs_v1, _, :elixir, _, %{"en" => module_doc}, _, _} = Code.fetch_docs(Atom)
iex> module_doc |> String.split("\n") |> Enum.at(0)
"Atoms are constants whose values are their own name."
"Convenience functions for working with atoms."
# A module that doesn't exist
iex> Code.fetch_docs(ModuleNotGood)
@@ -1397,10 +1193,4 @@ defmodule Code do
raise Code.LoadError, file: file
end
end
defp verify_loaded(loaded) do
maps_binaries = Enum.map(loaded, fn {_module, map, binary} -> {map, binary} end)
Module.ParallelChecker.verify(maps_binaries, [])
Enum.map(loaded, fn {module, _map, binary} -> {module, binary} end)
end
end
+152 -179
View File
@@ -205,13 +205,8 @@ defmodule Code.Formatter do
warn_on_unnecessary_quotes: false
]
parser_options = [
literal_encoder: &{:ok, {:__block__, &2, [&1]}},
token_metadata: true
]
with {:ok, tokens} <- :elixir.string_to_tokens(charlist, line, file, tokenizer_options),
{:ok, forms} <- :elixir.tokens_to_quoted(tokens, file, parser_options) do
{:ok, forms} <- :elixir.tokens_to_quoted(tokens, file, formatter_metadata: true) do
state =
Process.get(:code_formatter_comments)
|> Enum.reverse()
@@ -353,7 +348,7 @@ defmodule Code.Formatter do
not interpolated?(entries) ->
bitstring_to_algebra(meta, entries, state)
meta[:delimiter] == ~s["""] ->
meta[:format] == :bin_heredoc ->
{doc, state} =
entries
|> prepend_heredoc_line()
@@ -375,7 +370,7 @@ defmodule Code.Formatter do
not list_interpolated?(entries) ->
remote_to_algebra(quoted, context, state)
meta[:delimiter] == ~s['''] ->
meta[:format] == :list_heredoc ->
{doc, state} =
entries
|> prepend_heredoc_line()
@@ -433,12 +428,12 @@ defmodule Code.Formatter do
end
defp quoted_to_algebra({:__block__, meta, [list]}, _context, state) when is_list(list) do
case meta[:delimiter] do
~s['''] ->
case meta[:format] do
:list_heredoc ->
string = list |> List.to_string() |> escape_heredoc()
{@single_heredoc |> concat(string) |> concat(@single_heredoc) |> force_unfit(), state}
~s['] ->
:charlist ->
string = list |> List.to_string() |> escape_string(@single_quote)
{@single_quote |> concat(string) |> concat(@single_quote), state}
@@ -448,7 +443,7 @@ defmodule Code.Formatter do
end
defp quoted_to_algebra({:__block__, meta, [string]}, _context, state) when is_binary(string) do
if meta[:delimiter] == ~s["""] do
if meta[:format] == :bin_heredoc do
string = escape_heredoc(string)
{@double_heredoc |> concat(string) |> concat(@double_heredoc) |> force_unfit(), state}
else
@@ -463,11 +458,11 @@ defmodule Code.Formatter do
defp quoted_to_algebra({:__block__, meta, [integer]}, _context, state)
when is_integer(integer) do
{integer_to_algebra(Keyword.fetch!(meta, :token)), state}
{integer_to_algebra(Keyword.fetch!(meta, :original)), state}
end
defp quoted_to_algebra({:__block__, meta, [float]}, _context, state) when is_float(float) do
{float_to_algebra(Keyword.fetch!(meta, :token)), state}
{float_to_algebra(Keyword.fetch!(meta, :original)), state}
end
defp quoted_to_algebra(
@@ -484,7 +479,7 @@ defmodule Code.Formatter do
end
defp quoted_to_algebra({:__block__, meta, _} = block, _context, state) do
{block, state} = block_to_algebra(block, line(meta), closing_line(meta), state)
{block, state} = block_to_algebra(block, line(meta), end_line(meta), state)
{surround("(", block, ")"), state}
end
@@ -518,7 +513,7 @@ defmodule Code.Formatter do
defp quoted_to_algebra({:not, meta, [{:in, _, [left, right]} = arg]}, context, state) do
%{rename_deprecated_at: since} = state
# TODO: Remove metadata and always rewrite to left not in right in Elixir v2.0.
# TODO: Remove since check on Elixir v2.0 and the OP arrangement is removed.
if meta[:operator] == :"not in" || (since && Version.match?(since, "~> 1.5")) do
binary_op_to_algebra(:in, "not in", meta, left, right, context, state)
else
@@ -527,7 +522,7 @@ defmodule Code.Formatter do
end
defp quoted_to_algebra({:fn, meta, [_ | _] = clauses}, _context, state) do
anon_fun_to_algebra(clauses, line(meta), closing_line(meta), state, eol?(meta))
anon_fun_to_algebra(clauses, line(meta), end_line(meta), state, eol?(meta))
end
defp quoted_to_algebra({fun, meta, args}, context, state) when is_atom(fun) and is_list(args) do
@@ -611,14 +606,14 @@ defmodule Code.Formatter do
end
defp block_args_to_algebra(args, min_line, max_line, state) do
quoted_to_algebra = fn {kind, meta, _} = arg, _args, state ->
newlines = meta[:end_of_expression][:newlines] || 1
quoted_to_algebra = fn {kind, meta, _} = arg, _args, doc_newlines, state ->
doc_newlines = Keyword.get(meta, :newlines, doc_newlines)
{doc, state} = quoted_to_algebra(arg, :block, state)
{{doc, block_next_line(kind), newlines}, state}
{doc, block_next_line(kind), doc_newlines, state}
end
{args_docs, _comments?, state} =
quoted_to_algebra_with_comments(args, [], min_line, max_line, state, quoted_to_algebra)
quoted_to_algebra_with_comments(args, [], min_line, max_line, 2, state, quoted_to_algebra)
case args_docs do
[] -> {@empty, state}
@@ -673,11 +668,11 @@ defmodule Code.Formatter do
# There are five kinds of operators.
#
# 1. no space binary operators, for example, 1..2
# 2. no newline binary operators, for example, left in right
# 3. strict newlines before a left precedent operator, for example, foo |> bar |> baz
# 4. strict newlines before a right precedent operator, for example, foo when bar when baz
# 5. flex newlines after the operator, for example, foo ++ bar ++ baz
# 1. no space binary operators, e.g. 1..2
# 2. no newline binary operators, e.g. left in right
# 3. strict newlines before a left precedent operator, e.g. foo |> bar |> baz
# 4. strict newlines before a right precedent operator, e.g. foo when bar when baz
# 5. flex newlines after the operator, e.g. foo ++ bar ++ baz
#
# Cases 1, 2 and 5 are handled fairly easily by relying on the
# operator precedence and making sure nesting is applied only once.
@@ -706,14 +701,14 @@ defmodule Code.Formatter do
unwrap_right(right_arg, op, meta, right_context, [{{:root, left_context}, left_arg}])
operand_to_algebra = fn
{{:root, context}, arg}, _args, state ->
{{:root, context}, arg}, _args, newlines, state ->
{doc, state} = binary_operand_to_algebra(arg, context, state, op, op_info, :left, 2)
{{doc, @empty, 1}, state}
{doc, @empty, newlines, state}
{{kind, context}, arg}, _args, state ->
{{kind, context}, arg}, _args, newlines, state ->
{doc, state} = binary_operand_to_algebra(arg, context, state, op, op_info, kind, 0)
doc = doc |> nest_by_length(op_string) |> force_keyword(arg)
{{concat(op_string, doc), @empty, 1}, state}
{concat(op_string, doc), @empty, newlines, state}
end
{doc, state} =
@@ -744,15 +739,15 @@ defmodule Code.Formatter do
unwrap_pipes(left_arg, meta, left_context, [{{op, right_context}, right_arg}])
operand_to_algebra = fn
{{:root, context}, arg}, _args, state ->
{{:root, context}, arg}, _args, newlines, state ->
{doc, state} = binary_operand_to_algebra(arg, context, state, op, op_info, :left, 2)
{{doc, @empty, 1}, state}
{doc, @empty, newlines, state}
{{op, context}, arg}, _args, state ->
{{op, context}, arg}, _args, newlines, state ->
op_info = Code.Identifier.binary_op(op)
op_string = Atom.to_string(op) <> " "
{doc, state} = binary_operand_to_algebra(arg, context, state, op, op_info, :right, 0)
{{concat(op_string, doc), @empty, 1}, state}
{concat(op_string, doc), @empty, newlines, state}
end
operand_to_algebra_with_comments(pipes, meta, min_line, max_line, state, operand_to_algebra)
@@ -885,7 +880,7 @@ defmodule Code.Formatter do
defp operand_to_algebra_with_comments(operands, meta, min_line, max_line, state, fun) do
{docs, comments?, state} =
quoted_to_algebra_with_comments(operands, [], min_line, max_line, state, fun)
quoted_to_algebra_with_comments(operands, [], min_line, max_line, 1, state, fun)
if comments? or eol?(meta) do
{docs |> Enum.reduce(&line(&2, &1)) |> force_unfit(), state}
@@ -905,11 +900,11 @@ defmodule Code.Formatter do
# @foo bar
# @foo(bar)
defp module_attribute_to_algebra(meta, {name, call_meta, [_] = args} = expr, context, state)
defp module_attribute_to_algebra(meta, {name, _, [_] = args} = expr, context, state)
when is_atom(name) and name not in [:__block__, :__aliases__] do
if Code.Identifier.classify(name) == :callable_local do
{{call_doc, state}, wrap_in_parens?} =
call_args_to_algebra(args, call_meta, context, :skip_unless_many_args, false, state)
call_args_to_algebra(args, meta, context, :skip_unless_many_args, false, state)
doc =
"@#{name}"
@@ -1000,7 +995,8 @@ defmodule Code.Formatter do
fun = remote_fun_to_algebra(target, fun, length(args), state)
remote_doc = target_doc |> concat(".") |> concat(string(fun))
if args == [] and not remote_target_is_a_module?(target) and not meta?(meta, :closing) do
if args == [] and not remote_target_is_a_module?(target) and
Keyword.get(meta, :no_parens, false) do
{remote_doc, state}
else
{{call_doc, state}, wrap_in_parens?} =
@@ -1079,7 +1075,7 @@ defmodule Code.Formatter do
defp local_to_algebra(fun, meta, args, context, state) when is_atom(fun) do
skip_parens =
cond do
meta?(meta, :closing) -> :skip_if_only_do_end
not Keyword.get(meta, :no_parens, false) -> :skip_if_only_do_end
local_without_parens?(fun, args, state) -> :skip_unless_many_args
true -> :skip_if_do_end
end
@@ -1114,7 +1110,7 @@ defmodule Code.Formatter do
defp call_args_to_algebra(args, meta, context, parens, list_to_keyword?, state) do
{rest, last} = split_last(args)
if blocks = do_end_blocks(meta, last, state) do
if blocks = do_end_blocks(last, state) do
{call_doc, state} =
case rest do
[] when parens == :required ->
@@ -1145,7 +1141,7 @@ defmodule Code.Formatter do
defp call_args_to_algebra_no_blocks(meta, args, skip_parens?, list_to_keyword?, extra, state) do
{left, right} = split_last(args)
{keyword?, right} = last_arg_to_keyword(right, list_to_keyword?, skip_parens?, state.comments)
{keyword?, right} = last_arg_to_keyword(right, list_to_keyword?)
context =
if left == [] and not keyword? do
@@ -1273,15 +1269,15 @@ defmodule Code.Formatter do
not Enum.any?(args, &match?({:<-, _, [_, _]}, &1))
end
defp do_end_blocks(meta, [{{:__block__, _, [:do]}, _} | rest] = blocks, state) do
if meta?(meta, :do) or can_force_do_end_blocks?(rest, state) do
defp do_end_blocks([{{:__block__, meta, [:do]}, _} | rest] = blocks, state) do
if meta[:format] == :block or can_force_do_end_blocks?(rest, state) do
blocks
|> Enum.map(fn {{:__block__, meta, [key]}, value} -> {key, line(meta), value} end)
|> do_end_blocks_with_range(end_line(meta))
end
end
defp do_end_blocks(_, _, _), do: nil
defp do_end_blocks(_, _), do: nil
defp can_force_do_end_blocks?(rest, state) do
state.force_do_end_blocks and
@@ -1346,7 +1342,7 @@ defmodule Code.Formatter do
defp list_interpolation_to_algebra([entry | entries], escape, state, acc, last) do
{{:., _, [Kernel, :to_string]}, meta, [quoted]} = entry
{doc, state} = block_to_algebra(quoted, line(meta), closing_line(meta), state)
{doc, state} = block_to_algebra(quoted, line(meta), end_line(meta), state)
doc = surround("\#{", doc, "}")
list_interpolation_to_algebra(entries, escape, state, concat(acc, doc), last)
end
@@ -1363,7 +1359,7 @@ defmodule Code.Formatter do
defp interpolation_to_algebra([entry | entries], escape, state, acc, last) do
{:"::", _, [{{:., _, [Kernel, :to_string]}, meta, [quoted]}, {:binary, _, _}]} = entry
{doc, state} = block_to_algebra(quoted, line(meta), closing_line(meta), state)
{doc, state} = block_to_algebra(quoted, line(meta), end_line(meta), state)
doc = surround("\#{", doc, "}")
interpolation_to_algebra(entries, escape, state, concat(acc, doc), last)
end
@@ -1377,22 +1373,22 @@ defmodule Code.Formatter do
defp maybe_sigil_to_algebra(fun, meta, args, state) do
with <<"sigil_", name>> <- Atom.to_string(fun),
[{:<<>>, _, entries}, modifiers] when is_list(modifiers) <- args,
opening_delimiter when not is_nil(opening_delimiter) <- meta[:delimiter] do
doc = <<?~, name, opening_delimiter::binary>>
opening_terminator when not is_nil(opening_terminator) <- Keyword.get(meta, :terminator) do
doc = <<?~, name, opening_terminator::binary>>
if opening_delimiter in [@double_heredoc, @single_heredoc] do
closing_delimiter = concat(opening_delimiter, List.to_string(modifiers))
if opening_terminator in [@double_heredoc, @single_heredoc] do
closing_terminator = concat(opening_terminator, List.to_string(modifiers))
{doc, state} =
entries
|> prepend_heredoc_line()
|> interpolation_to_algebra(:heredoc, state, doc, closing_delimiter)
|> interpolation_to_algebra(:heredoc, state, doc, closing_terminator)
{force_unfit(doc), state}
else
escape = closing_sigil_delimiter(opening_delimiter)
closing_delimiter = concat(escape, List.to_string(modifiers))
interpolation_to_algebra(entries, escape, state, doc, closing_delimiter)
escape = closing_sigil_terminator(opening_terminator)
closing_terminator = concat(escape, List.to_string(modifiers))
interpolation_to_algebra(entries, escape, state, doc, closing_terminator)
end
else
_ ->
@@ -1400,11 +1396,11 @@ defmodule Code.Formatter do
end
end
defp closing_sigil_delimiter("("), do: ")"
defp closing_sigil_delimiter("["), do: "]"
defp closing_sigil_delimiter("{"), do: "}"
defp closing_sigil_delimiter("<"), do: ">"
defp closing_sigil_delimiter(other) when other in ["\"", "'", "|", "/"], do: other
defp closing_sigil_terminator("("), do: ")"
defp closing_sigil_terminator("["), do: "]"
defp closing_sigil_terminator("{"), do: "}"
defp closing_sigil_terminator("<"), do: ">"
defp closing_sigil_terminator(other) when other in ["\"", "'", "|", "/"], do: other
## Bitstrings
@@ -1550,40 +1546,43 @@ defmodule Code.Formatter do
defp integer_to_algebra(text) do
case text do
<<?0, ?x, rest::binary>> ->
"0x" <> String.upcase(rest)
[?0, ?x | rest] ->
"0x" <> String.upcase(List.to_string(rest))
<<?0, base, _::binary>> = digits when base in [?b, ?o] ->
digits
[?0, base | _rest] = digits when base in [?b, ?o] ->
List.to_string(digits)
<<??, _::binary>> = char ->
char
[?? | _rest] = char ->
List.to_string(char)
decimal ->
insert_underscores(decimal)
List.to_string(insert_underscores(decimal))
end
end
defp float_to_algebra(text) do
[int_part, decimal_part] = :binary.split(text, ".")
decimal_part = String.downcase(decimal_part)
insert_underscores(int_part) <> "." <> decimal_part
{int_part, [?. | decimal_part]} = Enum.split_while(text, &(&1 != ?.))
decimal_part =
decimal_part
|> List.to_string()
|> String.downcase()
List.to_string(insert_underscores(int_part)) <> "." <> decimal_part
end
defp insert_underscores(digits) do
cond do
digits =~ "_" ->
?_ in digits ->
digits
byte_size(digits) >= 6 ->
length(digits) >= 6 ->
digits
|> String.to_charlist()
|> Enum.reverse()
|> Enum.chunk_every(3)
|> Enum.intersperse('_')
|> List.flatten()
|> Enum.reverse()
|> List.to_string()
true ->
digits
@@ -1629,9 +1628,9 @@ defmodule Code.Formatter do
defp args_to_algebra_with_comments(args, meta, skip_parens?, last_arg_mode, join, state, fun) do
min_line = line(meta)
max_line = closing_line(meta)
max_line = end_line(meta)
arg_to_algebra = fn arg, args, state ->
arg_to_algebra = fn arg, args, newlines, state ->
{doc, state} = fun.(arg, state)
doc =
@@ -1642,7 +1641,7 @@ defmodule Code.Formatter do
[] when last_arg_mode == :none -> doc
end
{{doc, @empty, 1}, state}
{doc, @empty, newlines, state}
end
# If skipping parens, we cannot extract the comments of the first
@@ -1650,15 +1649,15 @@ defmodule Code.Formatter do
{args, acc, state} =
case args do
[head | tail] when skip_parens? ->
{doc_triplet, state} = arg_to_algebra.(head, tail, state)
{tail, [doc_triplet], state}
{head, next_line, newlines, state} = arg_to_algebra.(head, tail, 1, state)
{tail, [{head, next_line, newlines}], state}
_ ->
{args, [], state}
end
{args_docs, comments?, state} =
quoted_to_algebra_with_comments(args, acc, min_line, max_line, state, arg_to_algebra)
quoted_to_algebra_with_comments(args, acc, min_line, max_line, 1, state, arg_to_algebra)
cond do
args_docs == [] ->
@@ -1830,7 +1829,7 @@ defmodule Code.Formatter do
end
defp clause_to_algebra({:->, meta, [[], body]}, _min_line, state) do
{body_doc, state} = block_to_algebra(body, line(meta), closing_line(meta), state)
{body_doc, state} = block_to_algebra(body, line(meta), end_line(meta), state)
{"() ->" |> glue(body_doc) |> nest(2), state}
end
@@ -1841,7 +1840,7 @@ defmodule Code.Formatter do
{args_doc, state} = clause_args_to_algebra(args, min_line, state)
state = %{state | operand_nesting: nesting}
{body_doc, state} = block_to_algebra(body, min_line, closing_line(meta), state)
{body_doc, state} = block_to_algebra(body, min_line, end_line(meta), state)
doc =
args_doc
@@ -1862,13 +1861,13 @@ defmodule Code.Formatter do
end
defp clause_args_to_algebra(args, min_line, state) do
arg_to_algebra = fn arg, _args, state ->
arg_to_algebra = fn arg, _args, newlines, state ->
{doc, state} = clause_args_to_algebra(arg, state)
{{doc, @empty, 1}, state}
{doc, @empty, newlines, state}
end
{args_docs, comments?, state} =
quoted_to_algebra_with_comments([args], [], min_line, @min_line, state, arg_to_algebra)
quoted_to_algebra_with_comments([args], [], min_line, @min_line, 1, state, arg_to_algebra)
if comments? do
{Enum.reduce(args_docs, &line(&2, &1)), state}
@@ -1896,75 +1895,65 @@ defmodule Code.Formatter do
## Quoted helpers for comments
defp quoted_to_algebra_with_comments(args, acc, min_line, max_line, state, fun) do
defp quoted_to_algebra_with_comments(args, acc, min_line, max_line, newlines, state, fun) do
{pre_comments, state} =
get_and_update_in(state.comments, fn comments ->
Enum.split_while(comments, fn {line, _, _} -> line <= min_line end)
end)
{docs, comments?, state} =
each_quoted_to_algebra_with_comments(args, acc, max_line, state, false, fun)
each_quoted_to_algebra_with_comments(args, acc, max_line, newlines, state, false, fun)
{docs, comments?, update_in(state.comments, &(pre_comments ++ &1))}
end
defp each_quoted_to_algebra_with_comments([], acc, max_line, state, comments?, _fun) do
{acc, comments, comments?} = extract_comments_before(max_line, acc, state.comments, comments?)
args_docs = merge_algebra_with_comments(Enum.reverse(acc), @empty)
{args_docs, comments?, %{state | comments: comments}}
defp each_quoted_to_algebra_with_comments([], acc, max_line, _newlines, state, comments?, _fun) do
%{comments: comments} = state
{current, comments} = Enum.split_with(comments, fn {line, _, _} -> line < max_line end)
extra = for {_, {previous, _}, doc} <- current, do: {doc, @empty, previous}
args_docs = merge_algebra_with_comments(Enum.reverse(acc, extra), @empty)
{args_docs, comments? or extra != [], %{state | comments: comments}}
end
defp each_quoted_to_algebra_with_comments([arg | args], acc, max_line, state, comments?, fun) do
defp each_quoted_to_algebra_with_comments(args, acc, max_line, newlines, state, comments?, fun) do
[arg | args] = args
{doc_start, doc_end} = traverse_line(arg, {@max_line, @min_line})
{acc, comments, comments?} =
extract_comments_before(doc_start, acc, state.comments, comments?)
{doc_newlines, acc, comments, comments?} =
extract_comments_before(doc_start, newlines, acc, state.comments, comments?)
{doc_triplet, state} = fun.(arg, args, %{state | comments: comments})
{doc, next_line, doc_newlines, state} =
fun.(arg, args, doc_newlines, %{state | comments: comments})
{acc, comments, comments?} =
extract_comments_trailing(doc_start, doc_end, acc, state.comments, comments?)
{doc_newlines, acc, comments, comments?} =
extract_comments_trailing(doc_start, doc_end, doc_newlines, acc, state.comments, comments?)
acc = [adjust_trailing_newlines(doc_triplet, doc_end, comments) | acc]
acc = [{doc, next_line, doc_newlines} | acc]
state = %{state | comments: comments}
each_quoted_to_algebra_with_comments(args, acc, max_line, state, comments?, fun)
each_quoted_to_algebra_with_comments(args, acc, max_line, newlines, state, comments?, fun)
end
defp extract_comments_before(max, acc, [{line, _, _} = comment | rest], _) when line < max do
defp extract_comments_before(max, _, acc, [{line, _, _} = comment | rest], _) when line < max do
{_, {previous, next}, doc} = comment
acc = [{doc, @empty, next} | add_previous_to_acc(acc, previous)]
extract_comments_before(max, acc, rest, true)
acc = [{doc, @empty, previous} | acc]
extract_comments_before(max, next, acc, rest, true)
end
defp extract_comments_before(_max, acc, rest, comments?) do
{acc, rest, comments?}
defp extract_comments_before(_max, newlines, acc, rest, comments?) do
{newlines, acc, rest, comments?}
end
defp add_previous_to_acc([{doc, next_line, newlines} | acc], previous) when newlines < previous,
do: [{doc, next_line, previous} | acc]
defp add_previous_to_acc(acc, _previous),
do: acc
defp extract_comments_trailing(min, max, acc, [{line, _, doc_comment} | rest], _)
defp extract_comments_trailing(min, max, newlines, acc, [{line, _, doc_comment} | rest], _)
when line >= min and line <= max do
acc = [{doc_comment, @empty, 1} | acc]
extract_comments_trailing(min, max, acc, rest, true)
acc = [{doc_comment, @empty, newlines} | acc]
extract_comments_trailing(min, max, 1, acc, rest, true)
end
defp extract_comments_trailing(_min, _max, acc, rest, comments?) do
{acc, rest, comments?}
defp extract_comments_trailing(_min, _max, newlines, acc, rest, comments?) do
{newlines, acc, rest, comments?}
end
# If the document is immediately followed by comment which is followed by newlines,
# its newlines wouldn't have considerd the comment, so we need to adjust it.
defp adjust_trailing_newlines({doc, next_line, newlines}, doc_end, [{line, _, _} | _])
when newlines > 1 and line == doc_end + 1 do
{doc, next_line, 1}
end
defp adjust_trailing_newlines(doc_triplet, _, _), do: doc_triplet
defp traverse_line({expr, meta, args}, {min, max}) do
acc =
case Keyword.fetch(meta, :line) do
@@ -1994,8 +1983,8 @@ defmodule Code.Formatter do
# (except for module attributes)
# 3. empty lines are collapsed as to not exceed more than one
#
defp merge_algebra_with_comments([{doc, next_line, newlines} | docs], left) do
right = if newlines >= @newlines, do: line(), else: next_line
defp merge_algebra_with_comments([{doc, next_line, _newlines} | docs], left) do
right = next_line_separator(docs, next_line)
doc =
if left != @empty do
@@ -2076,6 +2065,14 @@ defmodule Code.Formatter do
end)
end
defp next_line_separator([{_doc, _next_line, newlines} | _], next_line) do
if newlines >= @newlines, do: line(), else: next_line
end
defp next_line_separator([], _) do
line()
end
defp module_attribute_read?({:@, _, [{var, _, var_context}]})
when is_atom(var) and is_atom(var_context) do
Code.Identifier.classify(var) == :callable_local
@@ -2130,12 +2127,12 @@ defmodule Code.Formatter do
end
defp next_break_fits?({:<<>>, meta, [_ | _] = entries}, state) do
meta[:delimiter] == ~s["""] or
meta[:format] == :bin_heredoc or
(not interpolated?(entries) and eol_or_comments?(meta, state))
end
defp next_break_fits?({{:., _, [List, :to_charlist]}, meta, [[_ | _]]}, _state) do
meta[:delimiter] == ~s[''']
meta[:format] == :list_heredoc
end
defp next_break_fits?({{:., _, [_left, :{}]}, _, _}, _state) do
@@ -2143,11 +2140,11 @@ defmodule Code.Formatter do
end
defp next_break_fits?({:__block__, meta, [string]}, _state) when is_binary(string) do
meta[:delimiter] == ~s["""]
meta[:format] == :bin_heredoc
end
defp next_break_fits?({:__block__, meta, [list]}, _state) when is_list(list) do
meta[:delimeter] != ~s[']
meta[:format] != :charlist
end
defp next_break_fits?({form, _, [_ | _]}, _state) when form in [:fn, :%{}, :%] do
@@ -2155,7 +2152,7 @@ defmodule Code.Formatter do
end
defp next_break_fits?({fun, meta, args}, _state) when is_atom(fun) and is_list(args) do
meta[:delimiter] in [@double_heredoc, @single_heredoc] and
meta[:terminator] in [@double_heredoc, @single_heredoc] and
fun |> Atom.to_string() |> String.starts_with?("sigil_")
end
@@ -2171,47 +2168,23 @@ defmodule Code.Formatter do
eol?(meta) or
(
min_line = line(meta)
max_line = closing_line(meta)
max_line = end_line(meta)
Enum.any?(comments, fn {line, _, _} -> line > min_line and line < max_line end)
)
end
# A literal list is a keyword or (... -> ...)
defp last_arg_to_keyword([_ | _] = arg, _list_to_keyword?, _skip_parens?, _comments) do
defp last_arg_to_keyword([_ | _] = arg, _list_to_keyword?) do
{keyword?(arg), arg}
end
# This is a list of tuples, it can be converted to keywords.
defp last_arg_to_keyword(
{:__block__, meta, [[_ | _] = arg]} = block,
true,
skip_parens?,
comments
) do
cond do
not keyword?(arg) ->
{false, block}
skip_parens? ->
block_line = line(meta)
{{_, arg_meta, _}, _} = hd(arg)
first_line = line(arg_meta)
case Enum.drop_while(comments, fn {line, _, _} -> line <= block_line end) do
[{line, _, _} | _] when line <= first_line ->
{false, block}
_ ->
{true, arg}
end
true ->
{true, arg}
end
defp last_arg_to_keyword({:__block__, _, [[_ | _] = arg]} = block, true) do
if keyword?(arg), do: {true, arg}, else: {false, block}
end
# Otherwise we don't have a keyword.
defp last_arg_to_keyword(arg, _list_to_keyword?, _skip_parens?, _comments) do
defp last_arg_to_keyword(arg, _list_to_keyword?) do
{false, arg}
end
@@ -2243,24 +2216,28 @@ defmodule Code.Formatter do
if force_args?(arg), do: force_unfit(doc), else: doc
end
defp keyword?([{_, _} | list]), do: keyword?(list)
defp keyword?(rest), do: rest == []
defp keyword_key?({:__block__, meta, [atom]}) when is_atom(atom),
do: meta[:format] == :keyword
defp keyword_key?({{:., _, [:erlang, :binary_to_atom]}, meta, [{:<<>>, _, _}, :utf8]}),
do: meta[:format] == :keyword
defp keyword_key?(_),
do: false
defp eol?(meta) do
Keyword.get(meta, :newlines, 0) > 0
defp keyword?([{key, _} | list]) do
keyword_key?(key) and keyword?(list)
end
defp meta?(meta, key) do
is_list(meta[key])
defp keyword?(rest) do
rest == []
end
defp keyword_key?({:__block__, meta, [_]}) do
meta[:format] == :keyword
end
defp keyword_key?({{:., _, [:erlang, :binary_to_atom]}, _, [{:<<>>, meta, _}, :utf8]}) do
meta[:format] == :keyword
end
defp keyword_key?(_) do
false
end
defp eol?(meta) do
Keyword.get(meta, :eol, false)
end
defp line(meta) do
@@ -2268,10 +2245,6 @@ defmodule Code.Formatter do
end
defp end_line(meta) do
meta[:end][:line] || @min_line
end
defp closing_line(meta) do
meta[:closing][:line] || @min_line
end
+1 -2
View File
@@ -217,8 +217,7 @@ defmodule Code.Typespec do
end
defp typespec_to_quoted({:user_type, line, name, args}) do
args = for arg <- args, do: typespec_to_quoted(arg)
{name, [line: line], args}
typespec_to_quoted({:type, line, name, args})
end
defp typespec_to_quoted({:type, line, :tuple, :any}) do
+2 -2
View File
@@ -37,7 +37,7 @@ defprotocol Collectable do
iex> collector_fun.(updated_acc, :done)
#MapSet<[1, 2, 3]>
To show how the protocol can be implemented, we can again look at the
To show how the protocol can be implemented, we can take again a look at the
implementation for `MapSet`. In this implementation "collecting" elements
simply means inserting them in the set through `MapSet.put/2`.
@@ -143,7 +143,7 @@ end
defimpl Collectable, for: Map do
def into(original) do
fun = fn
map, {:cont, {k, v}} -> Map.put(map, k, v)
map, {:cont, {k, v}} -> :maps.put(k, v, map)
map, :done -> map
_, :halt -> :ok
end
+3 -3
View File
@@ -61,11 +61,11 @@ defmodule Config do
## config/releases.exs
If you are using releases, see `mix release`, there is another configuration
If you are using releases, see `mix release`, there another configuration
file called `config/releases.exs`. While `config/config.exs` and friends
mentioned in the previous section are executed whenever you run a Mix
command, including when you assemble a release, `config/releases.exs` is
executed every time your production system boots. Since Mix is not available
execute every time your production system boots. Since Mix is not available
in a production system, `config/releases.exs` must not use any of the
functions from Mix.
"""
@@ -196,7 +196,7 @@ defmodule Config do
end
@doc false
@spec __import__!(Path.t()) :: {term, Code.binding()}
@spec __import__!(Path.t()) :: keyword()
def __import__!(file) when is_binary(file) do
current_files = get_files!()
+25 -153
View File
@@ -39,15 +39,9 @@ defmodule Config.Provider do
end
end
Then when specifying your release, you can specify the provider in
the release configuration:
Then when specifying your release, you can specify the provider:
releases: [
demo: [
# ...,
config_providers: [{JSONConfigProvider, "/etc/config.json"}]
]
]
config_providers: [{JSONConfigProvider, "/etc/config.json"}]
Now once the system boots, it will invoke the provider early in
the boot process, save the merged configuration to the disk, and
@@ -65,9 +59,8 @@ defmodule Config.Provider do
* a binary representing an absolute path
* a `{:system, system_var, path}` tuple where the config is the
concatenation of the environment variable `system_var` with
the given `path`
* a tuple {:system, system_var, path} where the config is the
concatenation of the `system_var` with the given `path`
"""
@type config_path :: {:system, binary(), binary()} | binary()
@@ -105,14 +98,7 @@ defmodule Config.Provider do
@callback load(config, state) :: config
@doc false
defstruct [
:providers,
:config_path,
extra_config: [],
prune_after_boot: false,
reboot_after_config: true,
validate_compile_env: false
]
defstruct [:providers, :config_path, extra_config: [], prune_after_boot: false]
@doc """
Validates a `t:config_path/0`.
@@ -155,7 +141,7 @@ defmodule Config.Provider do
end
@doc false
def boot(app, key, restart_fun \\ &restart_and_sleep/0) do
def boot(app, key, restart_fun \\ &System.restart/0) do
# The app with the config provider settings may not
# have been loaded at this point, so make sure we load
# its environment before querying it.
@@ -166,146 +152,32 @@ defmodule Config.Provider do
# before we go around running Elixir code.
{:ok, _} = :application.ensure_all_started(:elixir)
# The key we store if the system already booted
booted_key = :"#{key}_booted"
case :application.get_env(app, key) do
{:ok, %Config.Provider{} = provider} ->
path = resolve_config_path!(provider.config_path)
validate_no_cyclic_boot!(path)
read_config!(path)
|> Config.__merge__([{app, [{key, booted_key(provider, path)}]} | provider.extra_config])
|> run_providers(provider)
|> write_config!(path)
restart_fun.()
case :application.get_env(app, booted_key) do
{:ok, {:booted, path}} ->
path && File.rm(path)
with {:ok, %Config.Provider{} = provider} <- :application.get_env(app, key) do
maybe_validate_compile_env(provider)
end
File.rm(path)
:booted
{:ok, :booted} ->
:booted
_ ->
case :application.get_env(app, key) do
{:ok, %Config.Provider{} = provider} ->
path = resolve_config_path!(provider.config_path)
reboot_config = [{app, [{booted_key, booted_value(provider, path)}]}]
boot_providers(path, provider, reboot_config, restart_fun)
_ ->
:skip
end
:skip
end
end
defp boot_providers(path, provider, reboot_config, restart_fun) do
validate_no_cyclic_boot!(path)
loaded_applications = :application.loaded_applications()
original_config = read_config!(path)
config =
original_config
|> Config.__merge__(provider.extra_config)
|> run_providers(provider)
if provider.reboot_after_config do
config
|> Config.__merge__(reboot_config)
|> write_config!(path)
restart_fun.()
else
for {app, _, _} <- loaded_applications, config[app] != original_config[app] do
abort("""
Cannot configure #{inspect(app)} because :reboot_after_config has been set \
to false and #{inspect(app)} has already been loaded, meaning any further \
configuration won't have an effect.
The configuration for #{inspect(app)} before config providers was:
#{inspect(original_config[app])}
The configuration for #{inspect(app)} after config providers was:
#{inspect(config[app])}
""")
end
_ = Application.put_all_env(config, persistent: true)
maybe_validate_compile_env(provider)
:ok
end
end
defp maybe_validate_compile_env(provider) do
with [_ | _] = compile_env <- provider.validate_compile_env do
validate_compile_env(compile_env)
end
end
@doc false
def validate_compile_env(compile_env) do
for {app, [key | path], compile_return} <- compile_env,
Application.ensure_loaded(app) == :ok do
try do
traverse_env(Application.fetch_env(app, key), path)
rescue
e ->
abort("""
application #{inspect(app)} failed reading its compile environment #{path(key, path)}:
#{Exception.format(:error, e, __STACKTRACE__)}
Expected it to match the compile time value of #{return_to_text(compile_return)}.
#{compile_env_tips(app)}
""")
else
^compile_return ->
:ok
runtime_return ->
abort("""
the application #{inspect(app)} has a different value set #{path(key, path)} \
during runtime compared to compile time. Since this application environment entry was \
marked as compile time, this difference can lead to different behaviour than expected:
* Compile time value #{return_to_text(compile_return)}
* Runtime value #{return_to_text(runtime_return)}
#{compile_env_tips(app)}
""")
end
end
:ok
end
defp path(key, []), do: "for key #{inspect(key)}"
defp path(key, path), do: "for path #{inspect(path)} inside key #{inspect(key)}"
defp compile_env_tips(app),
do: """
To fix this error, you might:
* Make the runtime value match the compile time one
* Recompile your project. If the misconfigured application is a dependency, \
you may need to run "mix deps.compile #{app} --force"
* Alternatively, you can disable this check. If you are using releases, you can \
set :validate_compile_env to false in your release configuration. If you are \
using Mix to start your system, you can pass the --no-validate-compile-env flag
"""
defp return_to_text({:ok, value}), do: "was set to: #{inspect(value)}"
defp return_to_text(:error), do: "was not set"
defp traverse_env(return, []), do: return
defp traverse_env(:error, _paths), do: :error
defp traverse_env({:ok, value}, [key | keys]), do: traverse_env(Access.fetch(value, key), keys)
defp restart_and_sleep do
:init.restart()
Process.sleep(:infinity)
end
defp booted_value(%{prune_after_boot: true}, path), do: {:booted, path}
defp booted_value(%{prune_after_boot: false}, _path), do: {:booted, nil}
defp booted_key(%{prune_after_boot: true}, path), do: {:booted, path}
defp booted_key(%{prune_after_boot: false}, _path), do: :booted
defp validate_no_cyclic_boot!(path) do
if System.get_env("ELIXIR_CONFIG_PROVIDER_BOOTED") do
@@ -350,7 +222,7 @@ defmodule Config.Provider do
defp write_config!(config, path) do
contents = :io_lib.format("%% coding: utf-8~n~tw.~n", [config])
case File.write(path, IO.chardata_to_string(contents)) do
case File.write(path, contents, [:utf8]) do
:ok ->
:ok
@@ -372,6 +244,6 @@ defmodule Config.Provider do
defp abort(msg) do
IO.puts(:stderr, "ERROR! " <> msg)
:erlang.raise(:error, "aborting boot", [{Config.Provider, :boot, 2, []}])
raise(msg)
end
end
+5 -18
View File
@@ -4,24 +4,11 @@ defmodule Config.Reader do
## As a provider
`Config.Reader` can also be used as a `Config.Provider`. When used
as a provider, it expects a single argument: the configuration path
(as outlined in `t:Config.Provider.config_path/0`) for the file to
be read and loaded during the system boot.
For example, if you expect the target system to have a config file
in an absolute path, you can configure your `mix release` as:
config_providers: [{Config.Reader, "/etc/config.exs"}]
Or if you want to read a custom path inside the release:
config_provider: [{Config.Reader, {:system, "RELEASE_ROOT", "/config.exs"}}]
Note by default Mix releases supports runtime configuration via
a `config/releases.exs`. If a `config/releases.exs` exists in your
application, it is automatically copied inside the release and
automatically set as a config provider.
`Config.Reader` can also be used as a `Config.Provider`.
When used as a provider, it expects a single argument:
which the configuration path (as outlined in
`t:Config.Provider.config_path/0`) for the configuration
to be read and loaded during the system boot.
"""
@behaviour Config.Provider
+21 -54
View File
@@ -11,8 +11,9 @@ defmodule DynamicSupervisor do
## Examples
A dynamic supervisor is started with no children, a supervision strategy
(the only strategy currently supported is `:one_for_one`), and a name:
A dynamic supervisor is started with no children, often under a
supervisor with the supervision strategy (the only strategy currently
supported is `:one_for_one`) and a name:
children = [
{DynamicSupervisor, strategy: :one_for_one, name: MyApp.DynamicSupervisor}
@@ -148,9 +149,12 @@ defmodule DynamicSupervisor do
}
@typedoc "Option values used by the `start*` functions"
@type option :: GenServer.option()
@type option :: {:name, Supervisor.name()} | init_option()
@typedoc "Options given to `start_link/1` and `init/1`"
@typedoc "Options used by the `start*` functions"
@type options :: [option, ...]
@typedoc "Options given to `start_link/2` and `init/1`"
@type init_option ::
{:strategy, strategy()}
| {:max_restarts, non_neg_integer()}
@@ -207,7 +211,7 @@ defmodule DynamicSupervisor do
defmacro __using__(opts) do
quote location: :keep, bind_quoted: [opts: opts] do
@behaviour DynamicSupervisor
unless Module.has_attribute?(__MODULE__, :doc) do
if Module.get_attribute(__MODULE__, :doc) == nil do
@doc """
Returns a specification to start this module under a supervisor.
@@ -251,7 +255,7 @@ defmodule DynamicSupervisor do
with `:normal` reason.
"""
@doc since: "1.6.0"
@spec start_link([option | init_option]) :: Supervisor.on_start()
@spec start_link(options) :: Supervisor.on_start()
def start_link(options) when is_list(options) do
keys = [:extra_arguments, :max_children, :max_seconds, :max_restarts, :strategy]
{sup_opts, start_opts} = Keyword.split(options, keys)
@@ -277,7 +281,7 @@ defmodule DynamicSupervisor do
section in the `GenServer` module docs.
"""
@doc since: "1.6.0"
@spec start_link(module, term, [option]) :: Supervisor.on_start()
@spec start_link(module, term, GenServer.options()) :: Supervisor.on_start()
def start_link(mod, init_arg, opts \\ []) do
GenServer.start_link(__MODULE__, {mod, init_arg, opts[:name]}, opts)
end
@@ -286,7 +290,7 @@ defmodule DynamicSupervisor do
Dynamically adds a child specification to `supervisor` and starts that child.
`child_spec` should be a valid child specification as detailed in the
"Child specification" section of the documentation for `Supervisor`. The child
"child_spec/1" section of the documentation for `Supervisor`. The child
process will be started as defined in the child specification.
If the child process start function returns `{:ok, child}` or `{:ok, child,
@@ -306,13 +310,7 @@ defmodule DynamicSupervisor do
this function returns `{:error, :max_children}`.
"""
@doc since: "1.6.0"
@spec start_child(
Supervisor.supervisor(),
Supervisor.child_spec()
| {module, term}
| module
| (old_erlang_child_spec :: :supervisor.child_spec())
) ::
@spec start_child(Supervisor.supervisor(), Supervisor.child_spec() | {module, term} | module) ::
on_start_child()
def start_child(supervisor, {_, _, _, _, _, _} = child_spec) do
validate_and_start_child(supervisor, child_spec)
@@ -475,7 +473,7 @@ defmodule DynamicSupervisor do
module-based supervisors. See the "Module-based supervisors" section
in the module documentation for more information.
The `options` received by this function are also supported by `start_link/1`.
The `options` received by this function are also supported by `start_link/2`.
This function returns a tuple containing the supervisor options.
@@ -747,20 +745,7 @@ defmodule DynamicSupervisor do
end
def handle_info(msg, state) do
:logger.error(
%{
label: {DynamicSupervisor, :unexpected_msg},
report: %{
msg: msg
}
},
%{
domain: [:otp, :elixir],
error_logger: %{tag: :error_msg},
report_cb: &__MODULE__.format_report/1
}
)
:error_logger.error_msg('DynamicSupervisor received unexpected message: ~p~n', [msg])
{:noreply, state}
end
@@ -1003,22 +988,12 @@ defmodule DynamicSupervisor do
end
defp report_error(error, reason, pid, child, %{name: name, extra_arguments: extra}) do
:logger.error(
%{
label: {:supervisor, error},
report: [
{:supervisor, name},
{:errorContext, error},
{:reason, reason},
{:offender, extract_child(pid, child, extra)}
]
},
%{
domain: [:otp, :sasl],
report_cb: &:logger.format_otp_report/1,
logger_formatter: %{title: "SUPERVISOR REPORT"},
error_logger: %{tag: :error_report, type: :supervisor_report}
}
:error_logger.error_report(
:supervisor_report,
supervisor: name,
errorContext: error,
reason: reason,
offender: extract_child(pid, child, extra)
)
end
@@ -1049,12 +1024,4 @@ defmodule DynamicSupervisor do
defp call(supervisor, req) do
GenServer.call(supervisor, req, :infinity)
end
@doc false
def format_report(%{
label: {__MODULE__, :unexpected_msg},
report: %{msg: msg}
}) do
{'DynamicSupervisor received unexpected message: ~p~n', [msg]}
end
end
+187 -549
View File
File diff suppressed because it is too large Load Diff
+30 -50
View File
@@ -544,17 +544,8 @@ defmodule Exception do
defp format_application(module) do
# We cannot use Application due to bootstrap issues
case :application.get_application(module) do
{:ok, app} ->
case :application.get_key(app, :vsn) do
{:ok, vsn} when is_list(vsn) ->
"(" <> Atom.to_string(app) <> " " <> List.to_string(vsn) <> ") "
_ ->
"(" <> Atom.to_string(app) <> ") "
end
:undefined ->
""
{:ok, app} -> "(" <> Atom.to_string(app) <> ") "
:undefined -> ""
end
end
@@ -1062,8 +1053,6 @@ end
defmodule FunctionClauseError do
defexception [:module, :function, :arity, :kind, :args, :clauses]
@clause_limit 10
@impl true
def message(exception) do
case exception do
@@ -1109,46 +1098,37 @@ defmodule FunctionClauseError do
mfa = Exception.format_mfa(module, function, arity)
format_clause_fun = fn {args, guards} ->
code = Enum.reduce(guards, {function, [], args}, &{:when, [], [&2, &1]})
" #{kind} " <> Macro.to_string(code, ast_fun) <> "\n"
end
formatted_args =
args
|> Enum.with_index(1)
|> Enum.map(fn {arg, i} ->
["\n # ", Integer.to_string(i), "\n ", pad(inspect_fun.(arg)), "\n"]
end)
"\n\nThe following arguments were given to #{mfa}:\n" <>
"#{format_args(args, inspect_fun)}" <>
"#{format_clauses(clauses, format_clause_fun, @clause_limit)}"
formatted_clauses =
if clauses do
format_clause_fun = fn {args, guards} ->
code = Enum.reduce(guards, {function, [], args}, &{:when, [], [&2, &1]})
" #{kind} " <> Macro.to_string(code, ast_fun) <> "\n"
end
top_10 =
clauses
|> Enum.take(10)
|> Enum.map(format_clause_fun)
[
"\nAttempted function clauses (showing #{length(top_10)} out of #{length(clauses)}):",
"\n\n",
top_10
]
else
""
end
"\n\nThe following arguments were given to #{mfa}:\n#{formatted_args}#{formatted_clauses}"
end
defp format_args(args, inspect_fun) do
args
|> Enum.with_index(1)
|> Enum.map(fn {arg, i} ->
[pad("\n# "), Integer.to_string(i), pad("\n"), pad(inspect_fun.(arg)), "\n"]
end)
end
defp format_clauses(clauses, format_clause_fun, limit)
defp format_clauses(nil, _, _), do: ""
defp format_clauses([], _, _), do: ""
defp format_clauses(clauses, format_clause_fun, limit) do
top_clauses =
clauses
|> Enum.take(limit)
|> Enum.map(format_clause_fun)
[
"\nAttempted function clauses (showing #{length(top_clauses)} out of #{length(clauses)}):",
"\n\n",
top_clauses,
non_visible_clauses(length(clauses) - limit)
]
end
defp non_visible_clauses(n) when n <= 0, do: []
defp non_visible_clauses(1), do: [" ...\n (1 clause not shown)\n"]
defp non_visible_clauses(n), do: [" ...\n (#{n} clauses not shown)\n"]
defp pad(string) do
String.replace(string, "\n", "\n ")
end
+12 -14
View File
@@ -6,7 +6,7 @@ defmodule File do
to interact with files or IO devices, like `open/2`,
`copy/3` and others. This module also provides higher
level functions that work with filenames and have their naming
based on Unix variants. For example, one can copy a file
based on UNIX variants. For example, one can copy a file
via `cp/3` and remove files and directories recursively
via `rm_rf/1`.
@@ -585,7 +585,7 @@ defmodule File do
File.touch!("/tmp/a.txt", {{2018, 1, 30}, {13, 59, 59}})
#=> :ok
File.touch!("/fakedir/b.txt", {{2018, 1, 30}, {13, 59, 59}})
** (File.Error) could not touch "/fakedir/b.txt": no such file or directory
#=> ** (File.Error) could not touch "/fakedir/b.txt": no such file or directory
File.touch!("/tmp/a.txt", 1544519753)
@@ -722,7 +722,7 @@ defmodule File do
Returns `:ok` in case of success, `{:error, reason}` otherwise.
Note: The command `mv` in Unix-like systems behaves differently depending on
Note: The command `mv` in Unix systems behaves differently depending on
whether `source` is a file and the `destination` is an existing directory.
We have chosen to explicitly disallow this behaviour.
@@ -778,7 +778,7 @@ defmodule File do
or do a straight copy from a source to a destination without
preserving modes, check `copy/3` instead.
Note: The command `cp` in Unix-like systems behaves differently depending on
Note: The command `cp` in Unix systems behaves differently depending on
whether the destination is an existing directory or not. We have chosen to
explicitly disallow copying to a destination which is a directory,
and an error will be returned if tried.
@@ -846,7 +846,7 @@ defmodule File do
success, `files_and_directories` lists all files and directories copied in no
specific order. It returns `{:error, reason, file}` otherwise.
Note: The command `cp` in Unix-like systems behaves differently depending on
Note: The command `cp` in Unix systems behaves differently depending on
whether `destination` is an existing directory or not. We have chosen to
explicitly disallow this behaviour. If `source` is a `file` and `destination`
is a directory, `{:error, :eisdir}` will be returned.
@@ -1243,7 +1243,7 @@ defmodule File do
end
# On Windows, symlinks are treated as directory and must be removed
# with rmdir/1. But on Unix-like systems, we remove them via rm/1. So we first try
# with rmdir/1. But on Unix, we remove them via rm/1. So we first try
# to remove it as a directory and, if we get :enotdir, we fall back to
# a file removal.
defp do_rm_directory(path, {:ok, acc} = entry) do
@@ -1310,7 +1310,7 @@ defmodule File do
The allowed modes:
* `:binary` - opens the file in binary mode, disabling special handling of Unicode sequences
* `:binary` - opens the file in binary mode, disabling special handling of unicode sequences
(default mode).
* `:read` - the file, which must exist, is opened for reading.
@@ -1355,11 +1355,9 @@ defmodule File do
* `{:ok, io_device}` - the file has been opened in the requested mode.
`io_device` is actually the PID of the process which handles the file.
This process monitors the process that originally opened the file (the
owner process). If the owner process terminates, the file is closed and
the process itself terminates too. If any process to which the `io_device`
is linked terminates, the file will be closed and the process itself will
be terminated.
This process is linked to the process which originally opened the file.
If any process to which the `io_device` is linked terminates, the file
will be closed and the process itself will be terminated.
An `io_device` returned from this call can be used as an argument to the
`IO` module functions.
@@ -1464,7 +1462,7 @@ defmodule File do
@doc """
Gets the current working directory.
In rare circumstances, this function can fail on Unix-like systems. It may happen
In rare circumstances, this function can fail on Unix. It may happen
if read permissions do not exist for the parent directories of the
current directory. For this reason, returns `{:ok, cwd}` in case
of success, `{:error, reason}` otherwise.
@@ -1612,7 +1610,7 @@ defmodule File do
in raw mode for performance reasons. Therefore, Elixir **will** open
streams in `:raw` mode with the `:read_ahead` option unless an encoding
is specified. This means any data streamed into the file must be
converted to `t:iodata/0` type. If you pass, for example, `[encoding: :utf8]`
converted to `t:iodata/0` type. If you pass e.g. `[encoding: :utf8]`
or `[encoding: {:utf16, :little}]` in the modes parameter,
the underlying stream will use `IO.write/2` and the `String.Chars` protocol
to convert the data. See `IO.binwrite/2` and `IO.write/2` .
+5 -5
View File
@@ -23,7 +23,7 @@ defmodule File.Stat do
* `mtime` - the last time the file was written.
* `ctime` - the interpretation of this time field depends on the operating
system. On Unix-like operating systems, it is the last time the file or the inode was changed.
system. On Unix, it is the last time the file or the inode was changed.
In Windows, it is the time of creation.
* `mode` - the file permissions.
@@ -35,17 +35,17 @@ defmodule File.Stat do
In Windows, the number indicates a drive as follows: 0 means A:, 1 means
B:, and so on.
* `minor_device` - only valid for character devices on Unix-like systems. In all other
* `minor_device` - only valid for character devices on Unix. In all other
cases, this field is zero.
* `inode` - gives the inode number. On non-Unix-like file systems, this field
* `inode` - gives the inode number. On non-Unix file systems, this field
will be zero.
* `uid` - indicates the owner of the file. Will be zero for non-Unix-like file
* `uid` - indicates the owner of the file. Will be zero for non-Unix file
systems.
* `gid` - indicates the group that owns the file. Will be zero for
non-Unix-like file systems.
non-Unix file systems.
The time type returned in `atime`, `mtime`, and `ctime` is dependent on the
time type set in options. `{:time, type}` where type can be `:local`,
+5 -60
View File
@@ -2,43 +2,11 @@ defmodule Function do
@moduledoc """
A set of functions for working with functions.
Anonymous functions are typically created by using `fn`:
iex> add = fn a, b -> a + b end
iex> add.(1, 2)
3
It is also possible to capture module functions and pass them around
as if they were anonymous functions by using the capture operator `&/1`:
iex> add = &Kernel.+/2
iex> add.(1, 2)
3
iex> length = &String.length/1
iex> length.("hello")
5
It is also possible to capture a definition in the current module by
skipping the module prefix, such as `&my_fun/2`.
The capture operator can also be used to create anonymous functions
that expect at least one argument:
iex> add = &(&1 + &2)
iex> add.(1, 2)
3
In such cases, using the capture operator is no different than using `fn`.
We say that functions that point to definitions residing in modules, such
as `&String.length/1`, are **external** functions. All other functions are
**local** and they are always bound to the file or module that defined them.
Besides the functions in this module to work with functions, `Kernel` also
has an `apply/2` function that invokes a function with a dynamic number of
arguments, as well as `is_function/1` and `is_function/2`, to check
respectively if a given value is a function or a function of a given arity.
There are two types of captured functions: **external** and **local**.
External functions are functions residing in modules that are captured
with `&/1`, such as `&String.length/1`. Local functions are anonymous functions
defined with `fn/1` or with the capture operator `&/1` using `&1`, `&2`,
and so on as replacements.
"""
@type information ::
@@ -166,27 +134,4 @@ defmodule Function do
@doc since: "1.7.0"
@spec info(fun, item) :: {item, term} when item: information
def info(fun, item), do: :erlang.fun_info(fun, item)
@doc """
Returns its input `value`. This function can be passed as an anonymous function
to transformation functions.
## Examples
iex> Function.identity("Hello world!")
"Hello world!"
iex> 'abcdaabccc' |> Enum.sort() |> Enum.chunk_by(&Function.identity/1)
['aaa', 'bb', 'cccc', 'd']
iex> Enum.group_by('abracadabra', &Function.identity/1)
%{97 => 'aaaaa', 98 => 'bb', 99 => 'c', 100 => 'd', 114 => 'rr'}
iex> Enum.map([1, 2, 3, 4], &Function.identity/1)
[1, 2, 3, 4]
"""
@doc since: "1.10.0"
@spec identity(value) :: value when value: var
def identity(value), do: value
end
+5 -27
View File
@@ -629,7 +629,7 @@ defmodule GenServer do
Therefore it is not guaranteed that `c:terminate/2` is called when a `GenServer`
exits. For such reasons, we usually recommend important clean-up rules to
happen in separated processes either by use of monitoring or by links
themselves. There is no cleanup needed when the `GenServer` controls a `port` (for example,
themselves. There is no cleanup needed when the `GenServer` controls a `port` (e.g.
`:gen_tcp.socket`) or `t:File.io_device/0`, because these will be closed on
receiving a `GenServer`'s exit signal and do not need to be closed manually
in `c:terminate/2`.
@@ -640,7 +640,7 @@ defmodule GenServer do
This callback is optional.
"""
@callback terminate(reason, state :: term) :: term
when reason: :normal | :shutdown | {:shutdown, term} | term
when reason: :normal | :shutdown | {:shutdown, term}
@doc """
Invoked to change the state of the `GenServer` when a different version of a
@@ -737,7 +737,7 @@ defmodule GenServer do
quote location: :keep, bind_quoted: [opts: opts] do
@behaviour GenServer
unless Module.has_attribute?(__MODULE__, :doc) do
if Module.get_attribute(__MODULE__, :doc) == nil do
@doc """
Returns a specification to start this module under a supervisor.
@@ -785,22 +785,8 @@ defmodule GenServer do
{_, name} -> name
end
:logger.error(
%{
label: {GenServer, :no_handle_info},
report: %{
module: __MODULE__,
message: msg,
name: proc
}
},
%{
domain: [:otp, :elixir],
error_logger: %{tag: :error_msg},
report_cb: &GenServer.format_report/1
}
)
pattern = '~p ~p received unexpected message in handle_info/2: ~p~n'
:error_logger.error_msg(pattern, [__MODULE__, proc, msg])
{:noreply, state}
end
@@ -1219,12 +1205,4 @@ defmodule GenServer do
def whereis({name, node} = server) when is_atom(name) and is_atom(node) do
server
end
@doc false
def format_report(%{
label: {GenServer, :no_handle_info},
report: %{module: mod, message: msg, name: proc}
}) do
{'~p ~p received unexpected message in handle_info/2: ~p~n', [mod, proc, msg]}
end
end
+20 -36
View File
@@ -32,10 +32,11 @@ defprotocol Inspect do
end
The [`concat/1`](`Inspect.Algebra.concat/1`) function comes from `Inspect.Algebra` and it
concatenates algebra documents together. In the example above it is
concatenating the string `"MapSet<"`, the document returned by
`Inspect.Algebra.to_doc/2`, and the final string `">"`. All strings are
valid algebra documents that keep their formatting when pretty printed.
concatenates algebra documents together. In the example above,
it is concatenating the string `"MapSet<"` (all strings are
valid algebra documents that keep their formatting when pretty
printed), the document returned by `Inspect.Algebra.to_doc/2` and the
other string `">"`.
Since regular strings are valid entities in an algebra document,
an implementation of the `Inspect` protocol may simply return a
@@ -252,7 +253,7 @@ defimpl Inspect, for: Map do
end
def inspect(map, name, opts) do
map = Map.to_list(map)
map = :maps.to_list(map)
open = color("%" <> name <> "{", :map, opts)
sep = color(",", :map, opts)
close = color("}", :map, opts)
@@ -408,7 +409,11 @@ end
defimpl Inspect, for: Any do
defmacro __deriving__(module, struct, options) do
fields = Map.keys(struct) -- [:__exception__, :__struct__]
fields =
struct
|> Map.drop([:__exception__, :__struct__])
|> Map.keys()
only = Keyword.get(options, :only, fields)
except = Keyword.get(options, :except, [])
@@ -419,17 +424,17 @@ defimpl Inspect, for: Any do
inspect_module =
if fields == only and except == [] do
Inspect.Map
quote(do: Inspect.Map)
else
Inspect.Any
quote(do: Inspect.Any)
end
quote do
defimpl Inspect, for: unquote(module) do
def inspect(var!(struct), var!(opts)) do
var!(map) = Map.take(var!(struct), unquote(filtered_fields))
var!(name) = Identifier.inspect_as_atom(unquote(module))
unquote(inspect_module).inspect(var!(map), var!(name), var!(opts))
def inspect(struct, opts) do
map = Map.take(struct, unquote(filtered_fields))
name = Identifier.inspect_as_atom(unquote(module))
unquote(inspect_module).inspect(map, name, opts)
end
end
end
@@ -442,8 +447,8 @@ defimpl Inspect, for: Any do
_ -> Inspect.Map.inspect(struct, opts)
else
dunder ->
if Map.keys(dunder) == Map.keys(struct) do
pruned = Map.drop(struct, [:__struct__, :__exception__])
if :maps.keys(dunder) == :maps.keys(struct) do
pruned = :maps.remove(:__exception__, :maps.remove(:__struct__, struct))
Inspect.Map.inspect(pruned, Identifier.inspect_as_atom(module), opts)
else
Inspect.Map.inspect(struct, opts)
@@ -455,7 +460,7 @@ defimpl Inspect, for: Any do
# Use the :limit option and an extra element to force
# `container_doc/6` to append "...".
opts = %{opts | limit: min(opts.limit, map_size(map))}
map = Map.to_list(map) ++ ["..."]
map = :maps.to_list(map) ++ ["..."]
open = color("#" <> name <> "<", :map, opts)
sep = color(",", :map, opts)
@@ -464,24 +469,3 @@ defimpl Inspect, for: Any do
container_doc(open, map, close, opts, &Inspect.List.keyword/2, separator: sep, break: :strict)
end
end
require Protocol
Protocol.derive(
Inspect,
Macro.Env,
only: [
:module,
:file,
:line,
:function,
:context,
:aliases,
:requires,
:functions,
:macros,
:macro_aliases,
:context_modules,
:lexical_tracker
]
)
+62 -64
View File
@@ -4,15 +4,13 @@ defmodule Inspect.Opts do
The following fields are available:
* `:base` - prints integers as `:binary`, `:octal`, `:decimal`, or `:hex`,
defaults to `:decimal`. When inspecting binaries any `:base` other than
`:decimal` implies `binaries: :as_binaries`.
* `:structs` - when `false`, structs are not formatted by the inspect
protocol, they are instead printed as maps, defaults to `true`.
* `:binaries` - when `:as_binaries` all binaries will be printed in bit
syntax.
* `:binaries` - when `:as_strings` all binaries will be printed as strings,
non-printable bytes will be escaped.
When `:as_strings` all binaries will be printed as strings, non-printable
bytes will be escaped.
When `:as_binaries` all binaries will be printed in bit syntax.
When the default `:infer`, the binary will be printed as a string if it
is printable, otherwise in bit syntax. See `String.printable?/1` to learn
@@ -27,81 +25,81 @@ defmodule Inspect.Opts do
is printable, otherwise as list. See `List.ascii_printable?/1` to learn
when a charlist is printable.
* `:custom_options` (since v1.9.0) - a keyword list storing custom user-defined
options. Useful when implementing the `Inspect` protocol for nested structs
to pass the custom options through.
* `:inspect_fun` (since v1.9.0) - a function to build algebra documents,
defaults to `Inspect.inspect/2`.
* `:limit` - limits the number of items that are inspected for tuples,
bitstrings, maps, lists and any other collection of items. It does not
apply to printable strings nor printable charlists and defaults to 50.
If you don't want to limit the number of items to a particular number,
use `:infinity`.
* `:pretty` - if set to `true` enables pretty printing, defaults to `false`.
* `:printable_limit` - limits the number of characters that are inspected
on printable strings and printable charlists. You can use `String.printable?/1`
and `List.ascii_printable?/1` to check if a given string or charlist is
printable. Defaults to 4096. If you don't want to limit the number of
characters to a particular number, use `:infinity`.
* `:safe` - when `false`, failures while inspecting structs will be raised
as errors instead of being wrapped in the `Inspect.Error` exception. This
is useful when debugging failures and crashes for custom inspect
implementations.
* `:structs` - when `false`, structs are not formatted by the inspect
protocol, they are instead printed as maps, defaults to `true`.
* `:syntax_colors` - when set to a keyword list of colors the output is
colorized. The keys are types and the values are the colors to use for
each type (for example, `[number: :red, atom: :blue]`). Types can include
`:atom`, `:binary`, `:boolean`, `:list`, `:map`, `:number`, `:regex`,
`:string`, and `:tuple`. Custom data types may provide their own options.
Colors can be any `t:IO.ANSI.ansidata/0` as accepted by `IO.ANSI.format/1`.
* `:pretty` - if set to `true` enables pretty printing, defaults to `false`.
* `:width` - defaults to 80 characters, used when pretty is `true` or when
printing to IO devices. Set to 0 to force each item to be printed on its
own line. If you don't want to limit the number of items to a particular
number, use `:infinity`.
* `:base` - prints integers as `:binary`, `:octal`, `:decimal`, or `:hex`,
defaults to `:decimal`. When inspecting binaries any `:base` other than
`:decimal` implies `binaries: :as_binaries`.
* `:safe` - when `false`, failures while inspecting structs will be raised
as errors instead of being wrapped in the `Inspect.Error` exception. This
is useful when debugging failures and crashes for custom inspect
implementations.
* `:syntax_colors` - when set to a keyword list of colors the output is
colorized. The keys are types and the values are the colors to use for
each type (for example, `[number: :red, atom: :blue]`). Types can include
`:number`, `:atom`, `regex`, `:tuple`, `:map`, `:list`, and `:reset`.
Colors can be any `t:IO.ANSI.ansidata/0` as accepted by `IO.ANSI.format/1`.
* `:inspect_fun` (since v1.9.0) - a function to build algebra documents,
defaults to `Inspect.inspect/2`
* `:custom_options` (since v1.9.0) - a keyword list storing custom user-defined
options. Useful when implementing the `Inspect` protocol for nested structs
to pass the custom options through.
"""
# TODO: Remove :char_lists key on v2.0
defstruct base: :decimal,
defstruct structs: true,
binaries: :infer,
char_lists: :infer,
charlists: :infer,
custom_options: [],
inspect_fun: &Inspect.inspect/2,
char_lists: :infer,
limit: 50,
pretty: false,
printable_limit: 4096,
width: 80,
base: :decimal,
pretty: false,
safe: true,
structs: true,
syntax_colors: [],
width: 80
inspect_fun: &Inspect.inspect/2,
custom_options: []
@type color_key :: atom
# TODO: Remove :char_lists key and :as_char_lists value on v2.0
@type t :: %__MODULE__{
base: :decimal | :binary | :hex | :octal,
binaries: :infer | :as_binaries | :as_strings,
char_lists: :infer | :as_lists | :as_char_lists,
charlists: :infer | :as_lists | :as_charlists,
custom_options: keyword,
inspect_fun: (any, t -> Inspect.Algebra.t()),
limit: pos_integer | :infinity,
pretty: boolean,
printable_limit: pos_integer | :infinity,
safe: boolean,
structs: boolean,
binaries: :infer | :as_binaries | :as_strings,
charlists: :infer | :as_lists | :as_charlists,
char_lists: :infer | :as_lists | :as_char_lists,
limit: pos_integer | :infinity,
printable_limit: pos_integer | :infinity,
width: pos_integer | :infinity,
base: :decimal | :binary | :hex | :octal,
pretty: boolean,
safe: boolean,
syntax_colors: [{color_key, IO.ANSI.ansidata()}],
width: pos_integer | :infinity
inspect_fun: (any, t -> Inspect.Algebra.t()),
custom_options: keyword
}
end
@@ -193,17 +191,17 @@ defmodule Inspect.Algebra do
@type t ::
binary
| :doc_line
| :doc_nil
| doc_break
| doc_collapse
| doc_color
| doc_cons
| doc_fits
| doc_force
| doc_group
| doc_nest
| :doc_line
| doc_string
| doc_cons
| doc_nest
| doc_break
| doc_group
| doc_color
| doc_force
| doc_fits
| doc_collapse
@typep doc_string :: {:doc_string, t, non_neg_integer}
defmacrop doc_string(string, length) do
@@ -251,15 +249,15 @@ defmodule Inspect.Algebra do
end
@docs [
:doc_break,
:doc_collapse,
:doc_color,
:doc_string,
:doc_cons,
:doc_fits,
:doc_force,
:doc_group,
:doc_nest,
:doc_string
:doc_break,
:doc_group,
:doc_color,
:doc_force,
:doc_fits,
:doc_collapse
]
defguard is_doc(doc)
+5 -5
View File
@@ -233,7 +233,7 @@ defmodule Integer do
raise ArgumentError, "invalid base #{inspect(base)}"
end
def parse(binary, base) when is_binary(binary) do
def parse(binary, base) do
case count_digits(binary, base) do
0 ->
:error
@@ -244,14 +244,14 @@ defmodule Integer do
end
end
defp count_digits(<<sign, rest::bits>>, base) when sign in '+-' do
defp count_digits(<<sign, rest::binary>>, base) when sign in '+-' do
case count_digits_nosign(rest, base, 1) do
1 -> 0
count -> count
end
end
defp count_digits(<<rest::bits>>, base) do
defp count_digits(<<rest::binary>>, base) do
count_digits_nosign(rest, base, 0)
end
@@ -261,13 +261,13 @@ defmodule Integer do
char <- chars do
digit = char + diff
defp count_digits_nosign(<<unquote(char), rest::bits>>, base, count)
defp count_digits_nosign(<<unquote(char), rest::binary>>, base, count)
when base > unquote(digit) do
count_digits_nosign(rest, base, count + 1)
end
end
defp count_digits_nosign(<<_::bits>>, _, count), do: count
defp count_digits_nosign(<<_::binary>>, _, count), do: count
# TODO: Remove Integer.to_string/1 once the minimum supported version is
# Erlang/OTP 22, since it is covered by the now BIF Integer.to_string/2.
+9 -24
View File
@@ -84,7 +84,7 @@ defmodule IO do
Building IO data is cheaper than concatenating binaries. Concatenating multiple
pieces of IO data just means putting them together inside a list since IO data
can be arbitrarily nested, and that's a cheap and efficient operation. Most of
the IO-based APIs, such as `:gen_tcp` and `IO`, receive IO data and write it
the IO-based APIs, such as `:gen_tcp`, `IO`, etc, receive IO data and write it
to the socket directly without converting it to binary.
One drawback of IO data is that you can't do things like pattern match on the
@@ -98,14 +98,14 @@ defmodule IO do
Erlang and Elixir also have the idea of `t:chardata/0`. Chardata is very
similar to IO data: the only difference is that integers in IO data represent
bytes while integers in chardata represent Unicode code points. Bytes
(`t:byte/0`) are integers in the `0..255` range, while Unicode code points
bytes while integers in chardata represent Unicode codepoints. Bytes
(`t:byte/0`) are integers in the `0..255` range, while Unicode codepoints
(`t:char/0`) are integers in the range `0..0x10FFFF`. The `IO` module provides
the `chardata_to_string/1` function for chardata as the "counter-part" of the
`iodata_to_binary/1` function for IO data.
If you try to use `iodata_to_binary/1` on chardata, it will result in an
argument error. For example, let's try to put a code point that is not
argument error. For example, let's try to put a codepoint that is not
representable with one byte, like `?π`, inside IO data:
iex> IO.iodata_to_binary(["The symbol for pi is: ", ?π])
@@ -148,7 +148,7 @@ defmodule IO do
def read(device \\ :stdio, line_or_chars)
def read(device, :all) do
do_read_all(map_dev(device), :empty)
do_read_all(map_dev(device), "")
end
def read(device, :line) do
@@ -161,27 +161,12 @@ defmodule IO do
defp do_read_all(mapped_dev, acc) do
case :io.get_line(mapped_dev, "") do
line when is_binary(line) or is_list(line) -> do_read_all(mapped_dev, concat(acc, line))
:eof -> read_eof(mapped_dev, acc)
line when is_binary(line) -> do_read_all(mapped_dev, acc <> line)
:eof -> acc
other -> other
end
end
defp concat(:empty, line), do: line
defp concat(acc, line) when is_binary(acc), do: acc <> line
defp concat(acc, line) when is_list(acc), do: acc ++ line
defp read_eof(device, :empty) do
with [_ | _] = opts <- :io.getopts(device),
false <- Keyword.get(opts, :binary, true) do
''
else
_ -> ""
end
end
defp read_eof(_device, acc), do: acc
@doc """
Reads from the IO `device`. The operation is Unicode unsafe.
@@ -317,7 +302,7 @@ defmodule IO do
@spec warn(chardata | String.Chars.t(), Exception.stacktrace()) :: :ok
def warn(message, []) do
message = [to_chardata(message), ?\n]
:elixir_errors.io_warn(0, nil, message, message)
:elixir_errors.io_warn(nil, nil, message, message)
end
def warn(message, [{_, _, _, opts} | _] = stacktrace) do
@@ -327,7 +312,7 @@ defmodule IO do
file = opts[:file]
:elixir_errors.io_warn(
line || 0,
line,
file && List.to_string(file),
message,
[message, ?\n, " ", formatted_trace, ?\n]
+13 -83
View File
@@ -14,7 +14,6 @@ defmodule IO.ANSI.Docs do
* `:doc_code` - code blocks (cyan)
* `:doc_headings` - h1, h2, h3, h4, h5, h6 headings (yellow)
* `:doc_metadata` - documentation metadata keys (yellow)
* `:doc_quote` - leading quote character `> ` (light black)
* `:doc_inline_code` - inline code (cyan)
* `:doc_table_heading` - the style for table headings
* `:doc_title` - top level heading (reverse, yellow)
@@ -32,7 +31,6 @@ defmodule IO.ANSI.Docs do
doc_code: [:cyan],
doc_headings: [:yellow],
doc_metadata: [:yellow],
doc_quote: [:light_black],
doc_inline_code: [:cyan],
doc_table_heading: [:reverse],
doc_title: [:reverse, :yellow],
@@ -75,7 +73,7 @@ defmodule IO.ANSI.Docs do
{key, value}, _printed when is_binary(value) and key in @metadata_filter ->
label = metadata_label(key, options)
indent = String.duplicate(" ", length_without_escape(label, 0) + 1)
write_with_wrap([label | String.split(value, @spaces)], options[:width], indent, true, "")
write_with_wrap([label | String.split(value, @spaces)], options[:width], indent, true)
{key, value}, _printed when is_boolean(value) and key in @metadata_filter ->
IO.puts([metadata_label(key, options), ' ', to_string(value)])
@@ -141,11 +139,6 @@ defmodule IO.ANSI.Docs do
write_heading(heading, rest, text, indent, options)
end
defp process([">" <> line | rest], text, indent, options) do
write_text(text, indent, options)
process_quote(rest, [line], indent, options)
end
defp process(["" | rest], text, indent, options) do
write_text(text, indent, options)
process(rest, [], indent, options)
@@ -190,47 +183,6 @@ defmodule IO.ANSI.Docs do
process(rest, [], "", options)
end
## Quotes
defp process_quote([], lines, indent, options) do
write_quote(lines, indent, options, false)
end
defp process_quote([">", ">" <> line | rest], lines, indent, options) do
write_quote(lines, indent, options, true)
write_empty_quote_line(options)
process_quote(rest, [line], indent, options)
end
defp process_quote([">" <> line | rest], lines, indent, options) do
process_quote(rest, [line | lines], indent, options)
end
defp process_quote(rest, lines, indent, options) do
write_quote(lines, indent, options, false)
process(rest, [], indent, options)
end
defp write_quote(lines, indent, options, no_wrap) do
lines
|> Enum.map(&String.trim/1)
|> Enum.reverse()
|> write_lines(
indent,
options,
no_wrap,
quote_prefix(options)
)
end
defp quote_prefix(options), do: "#{color(:doc_quote, options)}> #{IO.ANSI.reset()}"
defp write_empty_quote_line(options) do
options
|> quote_prefix()
|> IO.puts()
end
## Lists
defp process_rest(stripped, rest, count, text, indent, options) do
@@ -315,25 +267,16 @@ defmodule IO.ANSI.Docs do
end
defp write_text(lines, indent, options, no_wrap) do
write_lines(lines, indent, options, no_wrap, "")
end
defp write_lines(lines, indent, options, no_wrap, prefix) do
lines
|> Enum.join(" ")
|> format_text(options)
|> handle_links
|> handle_inline(options)
|> String.split(@spaces)
|> write_with_wrap(options[:width] - byte_size(indent), indent, no_wrap, prefix)
|> write_with_wrap(options[:width] - byte_size(indent), indent, no_wrap)
unless no_wrap, do: newline_after_block()
end
defp format_text(text, options) do
text
|> handle_links()
|> handle_inline(options)
end
## Code blocks
defp process_code([], code, indent, options) do
@@ -405,17 +348,17 @@ defmodule IO.ANSI.Docs do
defp split_into_columns(line, options) do
line
|> String.trim(" ")
|> String.trim("|")
|> String.split("|")
|> String.trim()
|> String.split(" | ")
|> Enum.map(&render_column(&1, options))
end
defp render_column(col, options) do
col =
col
|> String.trim()
|> String.replace("\\\|", "|")
|> String.trim()
|> handle_links
|> handle_inline(options)
@@ -507,7 +450,7 @@ defmodule IO.ANSI.Docs do
end
defp table_line?(line) do
line =~ ~r/[:\ -]\|[:\ -]/
line =~ " | "
end
## Helpers
@@ -527,27 +470,14 @@ defmodule IO.ANSI.Docs do
IO.puts([color(style, options), string, IO.ANSI.reset()])
end
defp write_with_wrap([], _available, _indent, _first, _prefix) do
defp write_with_wrap([], _available, _indent, _first) do
:ok
end
defp write_with_wrap(words, available, indent, first, prefix) do
words
|> wrap_text(available, indent, first, prefix, [])
|> Enum.join("\n")
|> IO.puts()
end
defp wrap_text([], _available, _indent, _first, _prefix, wrapped_lines) do
Enum.reverse(wrapped_lines)
end
defp wrap_text(words, available, indent, first, prefix, wrapped_lines) do
prefix_length = length_without_escape(prefix, 0)
{words, rest} = take_words(words, available - prefix_length, [])
line = [if(first, do: "", else: indent), prefix, Enum.join(words, " ")]
wrap_text(rest, available, indent, false, prefix, [line | wrapped_lines])
defp write_with_wrap(words, available, indent, first) do
{words, rest} = take_words(words, available, [])
IO.puts(if(first, do: "", else: indent) <> Enum.join(words, " "))
write_with_wrap(rest, available, indent, false)
end
defp take_words([word | words], available, acc) do
+117 -308
View File
@@ -13,13 +13,13 @@ defmodule Kernel do
It mainly consists of:
* basic language primitives, such as arithmetic operators, spawning of processes,
data type handling, and others
* macros for control-flow and defining new functionality (modules, functions, and the like)
data type handling, etc.
* macros for control-flow and defining new functionality (modules, functions, and so on)
* guard checks for augmenting pattern matching
You can invoke `Kernel` functions and macros anywhere in Elixir code
without the use of the `Kernel.` prefix since they have all been
automatically imported. For example, in IEx, you can call:
You can use `Kernel` functions/macros without the `Kernel` prefix anywhere in
Elixir code as all its functions and macros are automatically imported. For
example, in IEx:
iex> is_number(13)
true
@@ -130,12 +130,11 @@ defmodule Kernel do
* [Compatibility and Deprecations](compatibility-and-deprecations.html) - lists
compatibility between every Elixir version and Erlang/OTP, release schema;
lists all deprecated functions, when they were deprecated and alternatives
* [Guards](guards.html) - an introduction to guards and extensions
* [Library Guidelines](library-guidelines.html) - general guidelines, anti-patterns,
and rules for those writing libraries
* [Naming Conventions](naming-conventions.html) - naming conventions for Elixir code
* [Operators](operators.html) - lists all Elixir operators and their precedence
* [Patterns and Guards](patterns-and-guards.html) - an introduction to patterns,
guards, and extensions
* [Syntax Reference](syntax-reference.html) - the language syntax reference
* [Typespecs](typespecs.html)- types and function specifications, including list of types
* [Unicode Syntax](unicode-syntax.html) - outlines Elixir support for Unicode
@@ -153,10 +152,8 @@ defmodule Kernel do
end
The clause above will only be invoked if the user's age is more than
or equal to 16. Guards also support joining multiple conditions with
`and` and `or`. The whole guard is true if all guard expressions will
evaluate to `true`. A more complete introduction to guards is available
[in the "Patterns and Guards" page](patterns-and-guards.html).
or equal to 16. A more complete introduction to guards is available
[in the Guards page](guards.html).
## Inlining
@@ -179,7 +176,7 @@ defmodule Kernel do
## Truthy and falsy values
Besides the booleans `true` and `false`, Elixir has the
Besides the booleans `true` and `false` Elixir also has the
concept of a "truthy" or "falsy" value.
* a value is truthy when it is neither `false` nor `nil`
@@ -396,7 +393,7 @@ defmodule Kernel do
#=> -49
div(100, 0)
** (ArithmeticError) bad argument in arithmetic expression
#=> ** (ArithmeticError) bad argument in arithmetic expression
"""
@doc guard: true
@@ -440,7 +437,7 @@ defmodule Kernel do
Exiting with any other reason is considered abnormal and treated
as a crash. This means the default supervisor behaviour kicks in,
error reports are emitted, and so forth.
error reports are emitted, etc.
This behaviour is relied on in many different places. For example,
`ExUnit` uses `exit(:shutdown)` when exiting the test process to
@@ -498,7 +495,7 @@ defmodule Kernel do
#=> 1
hd([])
** (ArgumentError) argument error
#=> ** (ArgumentError) argument error
hd([1 | 2])
#=> 1
@@ -704,19 +701,6 @@ defmodule Kernel do
:erlang.is_map(term)
end
@doc """
Returns `true` if `key` is a key in `map`; otherwise returns `false`.
It raises `BadMapError` if the first element is not a map.
Allowed in guard tests. Inlined by the compiler.
"""
@doc guard: true, since: "1.10.0"
@spec is_map_key(map, term) :: boolean
def is_map_key(map, key) do
:erlang.is_map_key(key, map)
end
@doc """
Returns the length of `list`.
@@ -915,7 +899,8 @@ defmodule Kernel do
"""
@doc guard: true
@spec round(number) :: integer
@spec round(float) :: integer
@spec round(value) :: value when value: integer
def round(number) do
:erlang.round(number)
end
@@ -1131,7 +1116,7 @@ defmodule Kernel do
#=> [2, 3, :go]
tl([])
** (ArgumentError) argument error
#=> ** (ArgumentError) argument error
tl([:one])
#=> []
@@ -1168,7 +1153,8 @@ defmodule Kernel do
"""
@doc guard: true
@spec trunc(number) :: integer
@spec trunc(value) :: value when value: integer
@spec trunc(float) :: integer
def trunc(number) do
:erlang.trunc(number)
end
@@ -1244,8 +1230,7 @@ defmodule Kernel do
"""
@doc guard: true
@spec +integer :: integer
@spec +float :: float
@spec +value :: value when value: number
def +value do
:erlang.+(value)
end
@@ -1312,7 +1297,7 @@ defmodule Kernel do
#=> 5.0
7 / 0
** (ArithmeticError) bad argument in arithmetic expression
#=> ** (ArithmeticError) bad argument in arithmetic expression
"""
@doc guard: true
@@ -1325,7 +1310,7 @@ defmodule Kernel do
Concatenates a proper list and a term, returning a list.
The complexity of `a ++ b` is proportional to `length(a)`, so avoid repeatedly
appending to lists of arbitrary length, for example, `list ++ [element]`.
appending to lists of arbitrary length, e.g. `list ++ [element]`.
Instead, consider prepending via `[element | rest]` and then reversing.
If the `right` operand is not a proper list, it returns an improper list.
@@ -1593,10 +1578,10 @@ defmodule Kernel do
#=> :bar
elem({}, 0)
** (ArgumentError) argument error
#=> ** (ArgumentError) argument error
elem({:foo, :bar}, 2)
** (ArgumentError) argument error
#=> ** (ArgumentError) argument error
"""
@doc guard: true
@@ -1817,8 +1802,8 @@ defmodule Kernel do
defp invalid_concat_left_argument_error(arg) do
:erlang.error(
ArgumentError.exception(
"the left argument of <> operator inside a match should always be a literal " <>
"binary because its size can't be verified. Got: #{arg}"
"the left argument of <> operator inside a match should be always a literal " <>
"binary as its size can't be verified, got: #{arg}"
)
)
end
@@ -1927,31 +1912,26 @@ defmodule Kernel do
defmacro reraise(message, stacktrace) do
# Try to figure out the type at compilation time
# to avoid dead code and make Dialyzer happy.
case Macro.expand(message, __CALLER__) do
message when is_binary(message) ->
quote do
:erlang.error(
:erlang.raise(:error, RuntimeError.exception(unquote(message)), unquote(stacktrace))
)
:erlang.raise(:error, RuntimeError.exception(unquote(message)), unquote(stacktrace))
end
{:<<>>, _, _} = message ->
quote do
:erlang.error(
:erlang.raise(:error, RuntimeError.exception(unquote(message)), unquote(stacktrace))
)
:erlang.raise(:error, RuntimeError.exception(unquote(message)), unquote(stacktrace))
end
alias when is_atom(alias) ->
quote do
:erlang.error(:erlang.raise(:error, unquote(alias).exception([]), unquote(stacktrace)))
:erlang.raise(:error, unquote(alias).exception([]), unquote(stacktrace))
end
message ->
quote do
:erlang.error(
:erlang.raise(:error, Kernel.Utils.raise(unquote(message)), unquote(stacktrace))
)
:erlang.raise(:error, Kernel.Utils.raise(unquote(message)), unquote(stacktrace))
end
end
end
@@ -2088,7 +2068,7 @@ defmodule Kernel do
end
@doc """
Creates and updates a struct.
Creates and updates structs.
The `struct` argument may be an atom (which defines `defstruct`)
or a `struct` itself. The second argument is any `Enumerable` that
@@ -2096,8 +2076,7 @@ defmodule Kernel do
Keys in the `Enumerable` that don't exist in the struct are automatically
discarded. Note that keys must be atoms, as only atoms are allowed when
defining a struct. If keys in the `Enumerable` are duplicated, the last
entry will be taken (same behaviour as `Map.new/1`).
defining a struct.
This function is useful for dynamically creating and updating structs, as
well as for converting maps to structs; in the latter case, just inserting
@@ -2214,42 +2193,6 @@ defmodule Kernel do
:erlang.error(ArgumentError.exception(error_message))
end
@doc """
Returns true if `term` is a struct; otherwise returns `false`.
Allowed in guard tests.
## Examples
iex> is_struct(URI.parse("/"))
true
iex> is_struct(%{})
false
"""
@doc since: "1.10.0", guard: true
defmacro is_struct(term) do
case __CALLER__.context do
nil ->
quote do
case unquote(term) do
%_{} -> true
_ -> false
end
end
:match ->
invalid_match!(:is_struct)
:guard ->
quote do
is_map(unquote(term)) and :erlang.is_map_key(:__struct__, unquote(term)) and
is_atom(:erlang.map_get(:__struct__, unquote(term)))
end
end
end
@doc """
Gets a value from a nested structure.
@@ -2263,7 +2206,8 @@ defmodule Kernel do
iex> get_in(users, ["john", :age])
27
In case any of the keys returns `nil`, `nil` will be returned:
In case any of the entries in the middle returns `nil`, `nil` will
be returned as per the `Access` module:
iex> users = %{"john" => %{age: 27}, "meg" => %{age: 23}}
iex> get_in(users, ["unknown", :age])
@@ -2279,6 +2223,9 @@ defmodule Kernel do
* a function to be invoked next
This means `get_in/2` can be extended to provide custom lookups.
The downside is that functions cannot be stored as keys in the accessed
data structures.
In the example below, we use a function to get all the maps inside
a list:
@@ -2621,7 +2568,7 @@ defmodule Kernel do
get_and_update_in(struct.foo.bar, &{&1, &1 + 1})
Note that in order for this macro to work, the complete path must always
be visible by this macro. See the "Paths" section below.
be visible by this macro. See the Paths section below.
## Examples
@@ -2834,6 +2781,9 @@ defmodule Kernel do
iex> match?(1, 1)
true
iex> match?(1, 2)
false
iex> match?({1, _}, {1, 2})
true
@@ -2868,17 +2818,15 @@ defmodule Kernel do
"""
defmacro match?(pattern, expr) do
success =
quote do
unquote(pattern) -> true
end
quote do
case unquote(expr) do
unquote(pattern) ->
true
failure =
quote generated: true do
_ -> false
_ ->
false
end
{:case, [], [expr, [do: success ++ failure]]}
end
end
@doc """
@@ -2897,8 +2845,7 @@ defmodule Kernel do
defmodule MyServer do
@my_data 13
IO.inspect(@my_data)
#=> 13
IO.inspect(@my_data) #=> 13
end
Unlike Erlang, such attributes are not stored in the module by default since
@@ -3299,7 +3246,7 @@ defmodule Kernel do
@doc """
Provides a short-circuit operator that evaluates and returns
the second expression only if the first one evaluates to a truthy value
the second expression only if the first one evaluates to to a truthy value
(neither `false` nor `nil`). Returns the first expression
otherwise.
@@ -3455,6 +3402,18 @@ defmodule Kernel do
[{h, _} | t] = Macro.unpipe({:|>, [], [left, right]})
fun = fn {x, pos}, acc ->
case x do
{op, _, [_]} when op == :+ or op == :- ->
message =
<<"piping into a unary operator is deprecated, please use the ",
"qualified name. For example, Kernel.+(5), instead of +5">>
IO.warn(message, Macro.Env.stacktrace(__CALLER__))
_ ->
:ok
end
Macro.pipe(acc, x, pos)
end
@@ -3841,17 +3800,11 @@ defmodule Kernel do
## Examples
defmodule Number do
def one, do: 1
def two, do: 2
end
#=> {:module, Number, <<70, 79, 82, ...>>, {:two, 0}}
Number.one()
#=> 1
Number.two()
#=> 2
iex> defmodule Foo do
...> def bar, do: :baz
...> end
iex> Foo.bar()
:baz
## Nesting
@@ -3908,7 +3861,7 @@ defmodule Kernel do
defmodule Any do
# code
end
** (CompileError) iex:1: module Any is reserved and cannot be defined
#=> ** (CompileError) iex:1: module Any is reserved and cannot be defined
Elixir reserves the following module names: `Elixir`, `Any`, `BitString`,
`PID`, and `Reference`.
@@ -3958,7 +3911,8 @@ defmodule Kernel do
:elixir_quote.escape(block, :default, false)
end
module_vars = :lists.map(&module_var/1, :maps.keys(elem(env.current_vars, 0)))
# We reimplement Macro.Env.vars/1 due to bootstrap concerns.
module_vars = module_vars(:maps.keys(env.current_vars), 0)
quote do
unquote(with_alias)
@@ -3993,11 +3947,25 @@ defmodule Kernel do
{module, module, nil}
end
defp module_var({name, kind}) when is_atom(kind), do: {name, [generated: true], kind}
defp module_var({name, kind}), do: {name, [counter: kind, generated: true], nil}
# quote vars to be injected into the module definition
defp module_vars([{key, kind} | vars], counter) do
var =
case is_atom(kind) do
true -> {key, [generated: true], kind}
false -> {key, [counter: kind, generated: true], nil}
end
under = String.to_atom(<<"_@", :erlang.integer_to_binary(counter)::binary>>)
args = [key, kind, under, var]
[{:{}, [], args} | module_vars(vars, counter + 1)]
end
defp module_vars([], _counter) do
[]
end
@doc ~S"""
Defines a public function with the given name and body.
Defines a function with the given name and body.
## Examples
@@ -4131,7 +4099,7 @@ defmodule Kernel do
#=> 3
Foo.sum(1, 2)
** (UndefinedFunctionError) undefined function Foo.sum/2
#=> ** (UndefinedFunctionError) undefined function Foo.sum/2
"""
defmacro defp(call, expr \\ nil) do
@@ -4139,7 +4107,7 @@ defmodule Kernel do
end
@doc """
Defines a public macro with the given name and body.
Defines a macro with the given name and body.
Macros must be defined before its usage.
@@ -4273,7 +4241,7 @@ defmodule Kernel do
defstruct name: nil, age: 10 + 11
end
MyProtocol.call(john) # it works!
MyProtocol.call(john) #=> works
For each protocol in the `@derive` list, Elixir will assert the protocol has
been implemented for `Any`. If the `Any` implementation defines a
@@ -4374,7 +4342,7 @@ defmodule Kernel do
end
quote do
if Module.has_attribute?(__MODULE__, :struct) do
if Module.get_attribute(__MODULE__, :struct) do
raise ArgumentError,
"defstruct has already been called for " <>
"#{Kernel.inspect(__MODULE__)}, defstruct can only be called once per module"
@@ -4470,11 +4438,11 @@ defmodule Kernel do
end
end
# TODO: Change the implementation on v2.0 to simply call Kernel.struct!/2
# Calls to Kernel functions must be fully-qualified to ensure
# reproducible builds; otherwise, this macro will generate ASTs
# with different metadata (:import, :context) depending on if
# it is the bootstrapped version or not.
# TODO: Change the implementation on v2.0 to simply call Kernel.struct!/2
@impl true
def exception(args) when Kernel.is_list(args) do
struct = __struct__()
@@ -4881,18 +4849,6 @@ defmodule Kernel do
defmacro defdelegate(funs, opts) do
funs = Macro.escape(funs, unquote: true)
# don't add compile-time dependency on :to
opts =
with true <- is_list(opts),
{:ok, target} <- Keyword.fetch(opts, :to),
{:__aliases__, _, _} <- target do
target = Macro.expand(target, %{__CALLER__ | function: {:__info__, 1}})
Keyword.replace!(opts, :to, target)
else
_ ->
opts
end
quote bind_quoted: [funs: funs, opts: opts] do
target =
Keyword.get(opts, :to) || raise ArgumentError, "expected to: to be given as argument"
@@ -5087,21 +5043,6 @@ defmodule Kernel do
@doc ~S"""
Handles the sigil `~D` for dates.
By default, this sigil uses the built-in `Calendar.ISO`, which
requires dates to be written in the ISO8601 format:
~D[yyyy-mm-dd]
such as:
~D[2015-01-13]
If you are using alternative calendars, any representation can
be used as long as you follow the representation by a single space
and the calendar name:
~D[SOME-REPRESENTATION My.Alternative.Calendar]
The lower case `~d` variant does not exist as interpolation
and escape characters are not useful for date sigils.
@@ -5116,30 +5057,12 @@ defmodule Kernel do
defmacro sigil_D(date_string, modifiers)
defmacro sigil_D({:<<>>, _, [string]}, []) do
{{:ok, {year, month, day}}, calendar} = parse_with_calendar!(string, :parse_date, "Date")
to_calendar_struct(Date, calendar: calendar, year: year, month: month, day: day)
Macro.escape(Date.from_iso8601!(string))
end
@doc ~S"""
Handles the sigil `~T` for times.
By default, this sigil uses the built-in `Calendar.ISO`, which
requires times to be written in the ISO8601 format:
~T[hh:mm:ss]
~T[hh:mm:ss.ssssss]
such as:
~T[13:00:07]
~T[13:00:07.123]
If you are using alternative calendars, any representation can
be used as long as you follow the representation by a single space
and the calendar name:
~T[SOME-REPRESENTATION My.Alternative.Calendar]
The lower case `~t` variant does not exist as interpolation
and escape characters are not useful for time sigils.
@@ -5156,44 +5079,16 @@ defmodule Kernel do
defmacro sigil_T(time_string, modifiers)
defmacro sigil_T({:<<>>, _, [string]}, []) do
{{:ok, {hour, minute, second, microsecond}}, calendar} =
parse_with_calendar!(string, :parse_time, "Time")
to_calendar_struct(Time,
calendar: calendar,
hour: hour,
minute: minute,
second: second,
microsecond: microsecond
)
Macro.escape(Time.from_iso8601!(string))
end
@doc ~S"""
Handles the sigil `~N` for naive date times.
By default, this sigil uses the built-in `Calendar.ISO`, which
requires naive date times to be written in the ISO8601 format:
~N[yyyy-mm-dd hh:mm:ss]
~N[yyyy-mm-dd hh:mm:ss.ssssss]
~N[yyyy-mm-ddThh:mm:ss.ssssss]
such as:
~N[2015-01-13 13:00:07]
~N[2015-01-13T13:00:07.123]
If you are using alternative calendars, any representation can
be used as long as you follow the representation by a single space
and the calendar name:
~N[SOME-REPRESENTATION My.Alternative.Calendar]
The lower case `~n` variant does not exist as interpolation
and escape characters are not useful for date time sigils.
More information on naive date times can be found in the
`NaiveDateTime` module.
More information on naive date times can be found in the `NaiveDateTime` module.
## Examples
@@ -5206,48 +5101,18 @@ defmodule Kernel do
defmacro sigil_N(naive_datetime_string, modifiers)
defmacro sigil_N({:<<>>, _, [string]}, []) do
{{:ok, {year, month, day, hour, minute, second, microsecond}}, calendar} =
parse_with_calendar!(string, :parse_naive_datetime, "NaiveDateTime")
to_calendar_struct(NaiveDateTime,
calendar: calendar,
year: year,
month: month,
day: day,
hour: hour,
minute: minute,
second: second,
microsecond: microsecond
)
Macro.escape(NaiveDateTime.from_iso8601!(string))
end
@doc ~S"""
Handles the sigil `~U` to create a UTC `DateTime`.
By default, this sigil uses the built-in `Calendar.ISO`, which
requires UTC date times to be written in the ISO8601 format:
~U[yyyy-mm-dd hh:mm:ssZ]
~U[yyyy-mm-dd hh:mm:ss.ssssssZ]
~U[yyyy-mm-ddThh:mm:ss.ssssss+00:00]
such as:
~U[2015-01-13 13:00:07Z]
~U[2015-01-13T13:00:07.123+00:00]
If you are using alternative calendars, any representation can
be used as long as you follow the representation by a single space
and the calendar name:
~U[SOME-REPRESENTATION My.Alternative.Calendar]
The given `datetime_string` must include "Z" or "00:00" offset
which marks it as UTC, otherwise an error is raised.
The lower case `~u` variant does not exist as interpolation
and escape characters are not useful for date time sigils.
The given `datetime_string` must include "Z" or "00:00" offset which marks it
as UTC, otherwise an error is raised.
More information on date times can be found in the `DateTime` module.
## Examples
@@ -5262,64 +5127,21 @@ defmodule Kernel do
defmacro sigil_U(datetime_string, modifiers)
defmacro sigil_U({:<<>>, _, [string]}, []) do
{{:ok, {year, month, day, hour, minute, second, microsecond}, offset}, calendar} =
parse_with_calendar!(string, :parse_utc_datetime, "UTC DateTime")
if offset != 0 do
raise ArgumentError,
"cannot parse #{inspect(string)} as UTC DateTime for #{inspect(calendar)}, reason: :non_utc_offset"
end
to_calendar_struct(DateTime,
calendar: calendar,
year: year,
month: month,
day: day,
hour: hour,
minute: minute,
second: second,
microsecond: microsecond,
time_zone: "Etc/UTC",
zone_abbr: "UTC",
utc_offset: 0,
std_offset: 0
)
Macro.escape(datetime_from_utc_iso8601!(string))
end
defp parse_with_calendar!(string, fun, context) do
{calendar, string} = extract_calendar(string)
result = apply(calendar, fun, [string])
{maybe_raise!(result, calendar, context, string), calendar}
end
defp datetime_from_utc_iso8601!(string) do
case DateTime.from_iso8601(string) do
{:ok, utc_datetime, 0} ->
utc_datetime
defp extract_calendar(string) do
case :binary.split(string, " ", [:global]) do
[_] -> {Calendar.ISO, string}
parts -> maybe_atomize_calendar(List.last(parts), string)
end
end
{:ok, _datetime, _offset} ->
raise ArgumentError,
"cannot parse #{inspect(string)} as UTC datetime, reason: :non_utc_offset"
defp maybe_atomize_calendar(<<alias, _::binary>> = last_part, string)
when alias >= ?A and alias <= ?Z do
string = binary_part(string, 0, byte_size(string) - byte_size(last_part) - 1)
{String.to_atom("Elixir." <> last_part), string}
end
defp maybe_atomize_calendar(_last_part, string) do
{Calendar.ISO, string}
end
defp maybe_raise!({:error, reason}, calendar, type, string) do
raise ArgumentError,
"cannot parse #{inspect(string)} as #{type} for #{inspect(calendar)}, " <>
"reason: #{inspect(reason)}"
end
defp maybe_raise!(other, _calendar, _type, _string), do: other
defp to_calendar_struct(type, fields) do
quote do
%{unquote_splicing([__struct__: type] ++ fields)}
{:error, reason} ->
raise ArgumentError,
"cannot parse #{inspect(string)} as UTC datetime, reason: #{inspect(reason)}"
end
end
@@ -5353,12 +5175,12 @@ defmodule Kernel do
defmacro sigil_w(term, modifiers)
defmacro sigil_w({:<<>>, _meta, [string]}, modifiers) when is_binary(string) do
split_words(:elixir_interpolation.unescape_chars(string), modifiers, __CALLER__)
split_words(:elixir_interpolation.unescape_chars(string), modifiers)
end
defmacro sigil_w({:<<>>, meta, pieces}, modifiers) do
binary = {:<<>>, meta, unescape_tokens(pieces)}
split_words(binary, modifiers, __CALLER__)
split_words(binary, modifiers)
end
@doc ~S"""
@@ -5383,32 +5205,19 @@ defmodule Kernel do
defmacro sigil_W(term, modifiers)
defmacro sigil_W({:<<>>, _meta, [string]}, modifiers) when is_binary(string) do
split_words(string, modifiers, __CALLER__)
split_words(string, modifiers)
end
defp split_words(string, [], caller) do
split_words(string, [?s], caller)
defp split_words(string, []) do
split_words(string, [?s])
end
defp split_words(string, [mod], caller)
defp split_words(string, [mod])
when mod == ?s or mod == ?a or mod == ?c do
case is_binary(string) do
true ->
parts = String.split(string)
parts_with_trailing_comma =
:lists.filter(&(byte_size(&1) > 1 and :binary.last(&1) == ?,), parts)
if parts_with_trailing_comma != [] do
stacktrace = Macro.Env.stacktrace(caller)
IO.warn(
"the sigils ~w/~W do not allow trailing commas at the end of each word. " <>
"If the comma is necessary, define a regular list with [...], otherwise remove the comma.",
stacktrace
)
end
case mod do
?s -> parts
?a -> :lists.map(&String.to_atom/1, parts)
@@ -5426,7 +5235,7 @@ defmodule Kernel do
end
end
defp split_words(_string, _mods, _caller) do
defp split_words(_string, _mods) do
raise ArgumentError, "modifier must be one of: s, a, c"
end
@@ -5454,7 +5263,7 @@ defmodule Kernel do
:guard ->
raise ArgumentError,
"invalid expression in guard, #{exp} is not allowed in guards. " <>
"To learn more about guards, visit: https://hexdocs.pm/elixir/patterns-and-guards.html"
"To learn more about guards, visit: https://hexdocs.pm/elixir/guards.html"
_ ->
:ok
+3 -21
View File
@@ -1,8 +1,6 @@
defmodule Kernel.CLI do
@moduledoc false
@compile {:no_warn_undefined, [Logger, IEx]}
@blank_config %{
commands: [],
output: ".",
@@ -12,8 +10,7 @@ defmodule Kernel.CLI do
errors: [],
pa: [],
pz: [],
verbose_compile: false,
profile: nil
verbose_compile: false
}
@doc """
@@ -102,7 +99,7 @@ defmodule Kernel.CLI do
Function invoked across nodes for `--rpc-eval`.
"""
def rpc_eval(expr) do
wrapper(fn -> Code.eval_string(expr) end)
wrapper(fn -> :elixir.eval(to_charlist(expr), [], []) end)
catch
kind, reason -> {kind, reason, __STACKTRACE__}
end
@@ -357,12 +354,6 @@ defmodule Kernel.CLI do
parse_compiler(t, %{config | verbose_compile: true})
end
# Private compiler options
defp parse_compiler(["--profile", "time" | t], config) do
parse_compiler(t, %{config | profile: :time})
end
defp parse_compiler([h | t] = list, config) do
case h do
"-" <> _ ->
@@ -496,22 +487,13 @@ defmodule Kernel.CLI do
wrapper(fn ->
Code.compiler_options(config.compiler_options)
verbose_opts =
opts =
if config.verbose_compile do
[each_long_compilation: &IO.puts("Compiling #{&1} (it's taking more than 15s)")]
else
[]
end
profile_opts =
if config.profile do
[profile: config.profile]
else
[]
end
opts = verbose_opts ++ profile_opts
case Kernel.ParallelCompiler.compile_to_path(files, config.output, opts) do
{:ok, _, _} -> :ok
{:error, _, _} -> exit({:shutdown, 1})
+75 -36
View File
@@ -6,14 +6,21 @@
# any of the `GenServer.Behaviour` conveniences.
defmodule Kernel.LexicalTracker do
@moduledoc false
@timeout :infinity
@timeout 30000
@behaviour :gen_server
@doc """
Returns all references in this lexical scope.
Returns all remotes referenced in this lexical scope.
"""
def references(pid) do
:gen_server.call(pid, :references, @timeout)
def remote_references(pid) do
:gen_server.call(pid, :remote_references, @timeout)
end
@doc """
Returns all remote dispatches in this lexical scope.
"""
def remote_dispatches(pid) do
:gen_server.call(pid, :remote_dispatches, @timeout)
end
# Internal API
@@ -40,18 +47,23 @@ defmodule Kernel.LexicalTracker do
end
@doc false
def remote_dispatch(pid, module, mode) when is_atom(module) do
:gen_server.cast(pid, {:remote_dispatch, module, mode})
def remote_reference(pid, module, mode) when is_atom(module) do
:gen_server.cast(pid, {:remote_reference, module, mode})
end
@doc false
def remote_struct(pid, module) when is_atom(module) do
:gen_server.cast(pid, {:remote_struct, module})
def remote_dispatch(pid, module, fa, line, mode) when is_atom(module) do
:gen_server.cast(pid, {:remote_dispatch, module, fa, line, mode})
end
@doc false
def import_dispatch(pid, module, fa) when is_atom(module) do
:gen_server.cast(pid, {:import_dispatch, module, fa})
def remote_struct(pid, module, line) when is_atom(module) do
:gen_server.cast(pid, {:remote_struct, module, line})
end
@doc false
def import_dispatch(pid, module, fa, line, mode) when is_atom(module) do
:gen_server.cast(pid, {:import_dispatch, module, fa, line, mode})
end
@doc false
@@ -59,11 +71,6 @@ defmodule Kernel.LexicalTracker do
:gen_server.cast(pid, {:alias_dispatch, module})
end
@doc false
def add_compile_env(pid, app, path, return) do
:gen_server.cast(pid, {:compile_env, app, path, return})
end
@doc false
def set_file(pid, file) do
:gen_server.cast(pid, {:set_file, file})
@@ -106,9 +113,10 @@ defmodule Kernel.LexicalTracker do
state = %{
directives: %{},
references: %{},
compile: %{},
runtime: %{},
structs: %{},
cache: %{},
compile_env: :ordsets.new(),
file: nil
}
@@ -125,13 +133,17 @@ defmodule Kernel.LexicalTracker do
{:reply, Enum.sort(directives), state}
end
def handle_call(:references, _from, state) do
{compile, runtime} = partition(Map.to_list(state.references), [], [])
{:reply, {compile, Map.keys(state.structs), runtime, state.compile_env}, state}
def handle_call(:remote_references, _from, state) do
{compile, runtime} = partition(:maps.to_list(state.references), [], [])
{:reply, {compile, :maps.keys(state.structs), runtime}, state}
end
def handle_call(:remote_dispatches, _from, state) do
{:reply, {state.compile, state.runtime}, state}
end
def handle_call({:read_cache, key}, _from, %{cache: cache} = state) do
{:reply, Map.get(cache, key), state}
{:reply, :maps.get(key, cache), state}
end
def handle_call(:stop, _from, state) do
@@ -139,21 +151,31 @@ defmodule Kernel.LexicalTracker do
end
def handle_cast({:write_cache, key, value}, %{cache: cache} = state) do
{:noreply, %{state | cache: Map.put(cache, key, value)}}
{:noreply, %{state | cache: :maps.put(key, value, cache)}}
end
def handle_cast({:remote_struct, module}, state) do
structs = Map.put(state.structs, module, true)
def handle_cast({:remote_reference, module, mode}, state) do
{:noreply, %{state | references: add_reference(state.references, module, mode)}}
end
def handle_cast({:remote_struct, module, line}, state) do
state = add_remote_dispatch(state, module, {:__struct__, 0}, line, :compile)
structs = :maps.put(module, true, state.structs)
{:noreply, %{state | structs: structs}}
end
def handle_cast({:remote_dispatch, module, mode}, state) do
def handle_cast({:remote_dispatch, module, fa, line, mode}, state) do
references = add_reference(state.references, module, mode)
state = add_remote_dispatch(state, module, fa, line, mode)
{:noreply, %{state | references: references}}
end
def handle_cast({:import_dispatch, module, {function, arity}}, state) do
state = add_import_dispatch(state, module, function, arity)
def handle_cast({:import_dispatch, module, {function, arity} = fa, line, mode}, state) do
state =
state
|> add_import_dispatch(module, function, arity)
|> add_remote_dispatch(module, fa, line, mode)
{:noreply, state}
end
@@ -169,15 +191,11 @@ defmodule Kernel.LexicalTracker do
{:noreply, %{state | file: nil}}
end
def handle_cast({:compile_env, app, path, return}, state) do
{:noreply, update_in(state.compile_env, &:ordsets.add_element({app, path, return}, &1))}
end
def handle_cast({:add_import, module, fas, line, warn}, state) do
directives =
state.directives
|> Enum.reject(&match?({{:import, {^module, _, _}}, _}, &1))
|> Map.new()
|> :maps.from_list()
|> add_directive(module, line, warn, :import)
directives =
@@ -218,15 +236,28 @@ defmodule Kernel.LexicalTracker do
# Callbacks helpers
defp add_reference(references, module, :compile) when is_atom(module),
do: Map.put(references, module, :compile)
do: :maps.put(module, :compile, references)
defp add_reference(references, module, :runtime) when is_atom(module) do
case Map.fetch(references, module) do
case :maps.find(module, references) do
{:ok, _} -> references
:error -> Map.put(references, module, :runtime)
:error -> :maps.put(module, :runtime, references)
end
end
defp add_remote_dispatch(state, module, fa, line, mode) when is_atom(module) do
location = location(state.file, line)
map_update(mode, %{module => %{fa => [location]}}, state, fn mode_dispatches ->
map_update(module, %{fa => [location]}, mode_dispatches, fn module_dispatches ->
map_update(fa, [location], module_dispatches, &[location | List.delete(&1, location)])
end)
end)
end
defp location(nil, line), do: line
defp location(file, line), do: {file, line}
defp add_import_dispatch(state, module, function, arity) do
directives =
add_dispatch(state.directives, module, :import)
@@ -235,6 +266,7 @@ defmodule Kernel.LexicalTracker do
# Always compile time because we depend
# on the module at compile time
references = add_reference(state.references, module, :compile)
%{state | directives: directives, references: references}
end
@@ -243,10 +275,17 @@ defmodule Kernel.LexicalTracker do
# If the value is true, it was imported/aliased and used
defp add_directive(directives, module_or_mfa, line, warn, tag) do
marker = if warn, do: line, else: true
Map.put(directives, {tag, module_or_mfa}, marker)
:maps.put({tag, module_or_mfa}, marker, directives)
end
defp add_dispatch(directives, module_or_mfa, tag) do
Map.put(directives, {tag, module_or_mfa}, true)
:maps.put({tag, module_or_mfa}, true, directives)
end
defp map_update(key, initial, map, fun) do
case :maps.find(key, map) do
{:ok, val} -> :maps.put(key, fun.(val), map)
:error -> :maps.put(key, initial, map)
end
end
end
+37 -158
View File
@@ -62,24 +62,16 @@ defmodule Kernel.ParallelCompiler do
the file, module and the module bytecode
* `:each_cycle` - after the given files are compiled, invokes this function
that should return the following values:
* `{:compile, modules}` - to continue compilation with a list of further modules to compile
* `{:runtime, modules}` - to stop compilation and verify the list of modules because
dependent modules have changed
that return a list with potentially more files to compile
* `:long_compilation_threshold` - the timeout (in seconds) after the
`:each_long_compilation` callback is invoked; defaults to `15`
* `:profile` - if set to `:time` measure the compilation time of each compilation cycle
and group pass checker
* `:dest` - the destination directory for the BEAM files. When using `compile/2`,
this information is only used to properly annotate the BEAM files before
they are loaded into memory. If you want a file to actually be written to
`dest`, use `compile_to_path/3` instead.
* `:beam_timestamp` - the modification timestamp to give all BEAM files
"""
@doc since: "1.6.0"
def compile(files, options \\ []) when is_list(options) do
@@ -139,20 +131,16 @@ defmodule Kernel.ParallelCompiler do
compiler_pid = self()
:elixir_code_server.cast({:reset_warnings, compiler_pid})
schedulers = max(:erlang.system_info(:schedulers_online), 2)
beam_timestamp = Keyword.get(options, :beam_timestamp)
outcome =
result =
spawn_workers(files, 0, [], [], %{}, [], %{
dest: Keyword.get(options, :dest),
each_cycle: Keyword.get(options, :each_cycle, fn -> {:runtime, []} end),
each_cycle: Keyword.get(options, :each_cycle, fn -> [] end),
each_file: Keyword.get(options, :each_file, fn _, _ -> :ok end) |> each_file(),
each_long_compilation: Keyword.get(options, :each_long_compilation, fn _file -> :ok end),
each_module: Keyword.get(options, :each_module, fn _file, _module, _binary -> :ok end),
long_compilation_threshold: Keyword.get(options, :long_compilation_threshold, 15),
profile: Keyword.get(options, :profile),
cycle_start: System.monotonic_time(),
module_counter: 0,
output: output,
long_compilation_threshold: Keyword.get(options, :long_compilation_threshold, 15),
schedulers: schedulers
})
@@ -160,7 +148,7 @@ defmodule Kernel.ParallelCompiler do
# compilation status will be set to error.
compilation_status = :elixir_code_server.call({:compilation_status, compiler_pid})
case {outcome, compilation_status} do
case {result, compilation_status} do
{{:ok, _, warnings}, :error} ->
message = "Compilation failed due to warnings while using the --warnings-as-errors option"
IO.puts(:stderr, message)
@@ -169,11 +157,8 @@ defmodule Kernel.ParallelCompiler do
{{:error, errors, warnings}, :error} ->
{:error, errors ++ warnings, []}
{{:ok, outcome, warnings}, _} ->
{:ok, write_module_binaries(outcome, output, beam_timestamp), warnings}
{{:error, errors, warnings}, _} ->
{:error, errors, warnings}
_ ->
result
end
end
@@ -190,74 +175,6 @@ defmodule Kernel.ParallelCompiler do
end
end
defp write_module_binaries(result, {:compile, path}, timestamp) do
Enum.flat_map(result, fn
{{:module, module}, {binary, _map}} ->
full_path = Path.join(path, Atom.to_string(module) <> ".beam")
File.write!(full_path, binary)
if timestamp, do: File.touch!(full_path, timestamp)
[module]
_ ->
[]
end)
end
defp write_module_binaries(result, _output, _timestamp) do
for {{:module, module}, _} <- result, do: module
end
## Verification
defp verify_modules(result, warnings, dependent_modules, state) do
checker_warnings = maybe_check_modules(result, dependent_modules, state)
warnings = Enum.reverse(warnings, checker_warnings)
{:ok, result, warnings}
end
defp maybe_check_modules(result, runtime_modules, state) do
%{schedulers: schedulers, profile: profile} = state
if :elixir_config.get(:bootstrap) do
[]
else
compiled_modules = checker_compiled_modules(result)
runtime_modules = checker_runtime_modules(runtime_modules)
profile_checker(profile, compiled_modules, runtime_modules, fn ->
Module.ParallelChecker.verify(compiled_modules, runtime_modules, schedulers)
end)
end
end
defp checker_compiled_modules(result) do
for {{:module, _module}, {binary, module_map}} <- result do
{module_map, binary}
end
end
defp checker_runtime_modules(modules) do
for module <- modules,
path = :code.which(module),
is_list(path) and path != [] do
{module, File.read!(path)}
end
end
defp profile_checker(_profile = :time, compiled_modules, runtime_modules, fun) do
{time, result} = :timer.tc(fun)
time = div(time, 1000)
num_modules = length(compiled_modules) + length(runtime_modules)
IO.puts(:stderr, "[profile] Finished group pass check of #{num_modules} modules in #{time}ms")
result
end
defp profile_checker(_profile = nil, _compiled_modules, _runtime_modules, fun) do
fun.()
end
## Compiler worker spawning
# We already have n=schedulers currently running, don't spawn new ones
defp spawn_workers(
queue,
@@ -301,9 +218,25 @@ defmodule Kernel.ParallelCompiler do
try do
case output do
{:compile, path} -> compile_file(file, path, parent)
:compile -> compile_file(file, dest, parent)
:require -> require_file(file, parent)
{:compile, path} ->
:erlang.process_flag(:error_handler, Kernel.ErrorHandler)
:erlang.put(:elixir_compiler_dest, path)
:elixir_compiler.file_to_path(file, path, &each_file(&1, &2, parent))
:compile ->
:erlang.process_flag(:error_handler, Kernel.ErrorHandler)
:erlang.put(:elixir_compiler_dest, dest)
:elixir_compiler.file(file, &each_file(&1, &2, parent))
:require ->
case :elixir_code_server.call({:acquire, file}) do
:required ->
send(parent, {:file_cancel, self()})
:proceed ->
:elixir_compiler.file(file, &each_file(&1, &2, parent))
:elixir_code_server.cast({:required, file})
end
end
catch
kind, reason ->
@@ -320,16 +253,13 @@ defmodule Kernel.ParallelCompiler do
# No more queue, nothing waiting, this cycle is done
defp spawn_workers([], 0, [], [], result, warnings, state) do
state = cycle_timing(result, state)
case state.each_cycle.() do
[] ->
modules = for {{:module, mod}, _} <- result, do: mod
warnings = Enum.reverse(warnings)
{:ok, modules, warnings}
case each_cycle_return(state.each_cycle.()) do
{:runtime, dependent_modules} ->
verify_modules(result, warnings, dependent_modules, state)
{:compile, []} ->
verify_modules(result, warnings, [], state)
{:compile, more} ->
more ->
spawn_workers(more, 0, [], [], result, warnings, state)
end
end
@@ -355,7 +285,7 @@ defmodule Kernel.ParallelCompiler do
# There is potentially a deadlock. We will release modules with
# the following order:
#
# 1. Code.ensure_compiled/1 checks (deadlock = soft)
# 1. Code.ensure_compiled?/1 checks (deadlock = soft)
# 2. Struct checks (deadlock = hard)
# 3. Modules without a known definition
# 4. Code invocation (deadlock = raise)
@@ -381,64 +311,19 @@ defmodule Kernel.ParallelCompiler do
wait_for_messages([], spawned, waiting, files, result, warnings, state)
end
defp compile_file(file, path, parent) do
:erlang.process_flag(:error_handler, Kernel.ErrorHandler)
:erlang.put(:elixir_compiler_dest, path)
:elixir_compiler.file(file, &each_file(&1, &2, parent))
end
defp require_file(file, parent) do
case :elixir_code_server.call({:acquire, file}) do
:required ->
send(parent, {:file_cancel, self()})
:proceed ->
:elixir_compiler.file(file, &each_file(&1, &2, parent))
:elixir_code_server.cast({:required, file})
end
end
defp cycle_timing(result, %{profile: :time} = state) do
%{cycle_start: cycle_start, module_counter: module_counter} = state
num_modules = count_modules(result)
diff_modules = num_modules - module_counter
now = System.monotonic_time()
time = System.convert_time_unit(now - cycle_start, :native, :millisecond)
IO.puts(
:stderr,
"[profile] Finished compilation cycle of #{diff_modules} modules in #{time}ms"
)
%{state | cycle_start: now, module_counter: num_modules}
end
defp cycle_timing(_result, %{profile: nil} = state) do
state
end
defp count_modules(result) do
Enum.count(result, &match?({{:module, _}, _}, &1))
end
# TODO: Deprecate on v1.14
defp each_cycle_return(modules) when is_list(modules), do: {:compile, modules}
defp each_cycle_return(other), do: other
# The goal of this function is to find leaves in the dependency graph,
# i.e. to find code that depends on code that we know is not being defined.
# Note that not all files have been compile yet, so they may not be in waiting.
defp without_definition(waiting, files) do
nillify_empty(
for {pid, _, _, _} <- files,
{_, ^pid, ref, on, _, _} <- List.wrap(List.keyfind(waiting, pid, 1)),
{_, ^pid, ref, on, _, _} = List.keyfind(waiting, pid, 1),
not Enum.any?(waiting, fn {_, _, _, _, defining, _} -> on in defining end),
do: {ref, :not_found}
)
end
defp deadlocked(waiting, type) do
nillify_empty(for {_, _, ref, _, _, ^type} <- waiting, do: {ref, :deadlock})
nillify_empty(for {_, _, ref, _, _, ^type} <- waiting, do: {ref, :not_found})
end
defp nillify_empty([]), do: nil
@@ -461,7 +346,7 @@ defmodule Kernel.ParallelCompiler do
result = Map.put(result, {kind, module}, true)
spawn_workers(available ++ queue, spawned, waiting, files, result, warnings, state)
{:module_available, child, ref, file, module, binary, module_map} ->
{:module_available, child, ref, file, module, binary} ->
state.each_module.(file, module, binary)
# Release the module loader which is waiting for an ack
@@ -472,7 +357,7 @@ defmodule Kernel.ParallelCompiler do
do: {ref, :found}
cancel_waiting_timer(files, child)
result = Map.put(result, {:module, module}, {binary, module_map})
result = Map.put(result, {:module, module}, true)
spawn_workers(available ++ queue, spawned, waiting, files, result, warnings, state)
# If we are simply requiring files, we do not add to waiting.
@@ -652,12 +537,6 @@ defmodule Kernel.ParallelCompiler do
end
end
defp get_line(file, _reason, [{_, _, _, [file: 'expanding macro']}, {_, _, _, info} | _]) do
if Keyword.get(info, :file) == to_charlist(Path.relative_to_cwd(file)) do
Keyword.get(info, :line)
end
end
defp get_line(file, _reason, [{_, _, _, info} | _]) do
if Keyword.get(info, :file) == to_charlist(Path.relative_to_cwd(file)) do
Keyword.get(info, :line)
+38 -44
View File
@@ -3,21 +3,14 @@ defmodule Kernel.SpecialForms do
Special forms are the basic building blocks of Elixir, and therefore
cannot be overridden by the developer.
The `Kernel.SpecialForms` module consists solely of macros that can be
invoked anywhere in Elixir code without the use of the
`Kernel.SpecialForms.` prefix. This is possible because they all have
been automatically imported, in the same fashion as the functions and
macros from the `Kernel` module.
These building blocks are defined in this module. Some of these special forms are lexical (such as
`alias/2` and `case/2`). The macros `{}/1` and `<<>>/1` are also special
We define them in this module. Some of these forms are lexical (like
`alias/2`, `case/2`, etc.). The macros `{}/1` and `<<>>/1` are also special
forms used to define tuple and binary data structures respectively.
This module also documents macros that return information about Elixir's
compilation environment, such as (`__ENV__/0`, `__MODULE__/0`, `__DIR__/0`,
`__STACKTRACE__/0`, and `__CALLER__/0`).
compilation environment, such as (`__ENV__/0`, `__MODULE__/0`, `__DIR__/0` and `__CALLER__/0`).
Additionally, it documents two special forms, `__block__/1` and
Finally, it also documents two special forms, `__block__/1` and
`__aliases__/1`, which are not intended to be called directly by the
developer but they appear in quoted contents since they are essential
in Elixir's constructs.
@@ -351,8 +344,8 @@ defmodule Kernel.SpecialForms do
13::size(8), 10::size(8), 26::size(8), 10::size(8)>>
@jpg_signature <<255::size(8), 216::size(8)>>
def type(<<@png_signature, _rest::binary>>), do: :png
def type(<<@jpg_signature, _rest::binary>>), do: :jpg
def type(<<@png_signature, rest::binary>>), do: :png
def type(<<@jpg_signature, rest::binary>>), do: :jpg
def type(_), do: :unknown
end
@@ -805,7 +798,7 @@ defmodule Kernel.SpecialForms do
* The first element of the tuple is always an atom or
another tuple in the same representation.
* The second element of the tuple represents [metadata](t:Macro.metadata/0).
* The second element of the tuple represents metadata.
* The third element of the tuple are the arguments for the
function call. The third argument may be an atom, which is
@@ -827,22 +820,6 @@ defmodule Kernel.SpecialForms do
## Options
* `:bind_quoted` - passes a binding to the macro. Whenever a binding is
given, `unquote/1` is automatically disabled.
* `:context` - sets the resolution context.
* `:generated` - marks the given chunk as generated so it does not emit warnings.
Currently it only works on special forms (for example, you can annotate a `case`
but not an `if`).
* `:file` - sets the quoted expressions to have the given file.
* `:line` - sets the quoted expressions to have the given line.
* `:location` - when set to `:keep`, keeps the current line and file from
quote. Read the "Stacktrace information" section below for more information.
* `:unquote` - when `false`, disables unquoting. This means any `unquote`
call will be kept as is in the AST, instead of replaced by the `unquote`
arguments. For example:
@@ -857,6 +834,21 @@ defmodule Kernel.SpecialForms do
...> end
{:unquote, [], ["hello"]}
* `:location` - when set to `:keep`, keeps the current line and file from
quote. Read the Stacktrace information section below for more
information.
* `:line` - sets the quoted expressions to have the given line.
* `:generated` - marks the given chunk as generated so it does not emit warnings.
Currently it only works on special forms (for example, you can annotate a `case`
but not an `if`).
* `:context` - sets the resolution context.
* `:bind_quoted` - passes a binding to the macro. Whenever a binding is
given, `unquote/1` is automatically disabled.
## Quote and macros
`quote/2` is commonly used with macros for code generation. As an exercise,
@@ -956,7 +948,7 @@ defmodule Kernel.SpecialForms do
import Math
squared(5)
x
** (CompileError) undefined variable x or undefined function x/0
#=> ** (CompileError) undefined variable x or undefined function x/0
We can see that `x` did not leak to the user context. This happens
because Elixir macros are hygienic, a topic we will discuss at length
@@ -1021,7 +1013,7 @@ defmodule Kernel.SpecialForms do
Hygiene.write()
Hygiene.read()
** (RuntimeError) undefined variable a or undefined function a/0
#=> ** (RuntimeError) undefined variable a or undefined function a/0
For such, you can explicitly pass the current module scope as
argument:
@@ -1112,7 +1104,7 @@ defmodule Kernel.SpecialForms do
require Hygiene
Hygiene.no_interference()
** (UndefinedFunctionError) ...
#=> ** (UndefinedFunctionError) ...
Hygiene.interference()
#=> "world"
@@ -1199,8 +1191,8 @@ defmodule Kernel.SpecialForms do
require Sample
Sample.add(:one, :two)
** (ArithmeticError) bad argument in arithmetic expression
adder.ex:5: Sample.add/2
#=> ** (ArithmeticError) bad argument in arithmetic expression
#=> adder.ex:5: Sample.add/2
When using `location: :keep` and invalid arguments are given to
`Sample.add/2`, the stacktrace information will point to the file
@@ -1521,7 +1513,7 @@ defmodule Kernel.SpecialForms do
non-matched value:
with :foo = :bar, do: :ok
** (MatchError) no match of right hand side value: :bar
#=> ** (MatchError) no match of right hand side value: :bar
As with any other function or macro call in Elixir, explicit parens can
also be used around the arguments before the `do`/`end` block:
@@ -1686,7 +1678,7 @@ defmodule Kernel.SpecialForms do
unambiguously identified by the operator `:.`. For example:
iex> quote do
...> Foo.bar()
...> Foo.bar
...> end
{{:., [], [{:__aliases__, [alias: false], [:Foo]}, :bar]}, [], []}
@@ -1745,7 +1737,8 @@ defmodule Kernel.SpecialForms do
## Variable handling
Notice that variables bound in a clause do not leak to the outer context:
Notice that variables bound in a clause "head" do not leak to the
outer context:
case data do
{:ok, value} -> value
@@ -1755,8 +1748,8 @@ defmodule Kernel.SpecialForms do
value
#=> unbound variable value
When binding variables with the same names as variables in the outer context,
the variables in the outer context are not affected.
However, variables explicitly bound in the clause "body" are
accessible from the outer context:
value = 7
@@ -1766,11 +1759,12 @@ defmodule Kernel.SpecialForms do
end
value
#=> 7
#=> 7 or 13
In the example above, `value` is going to be `7` regardless of the value of
`lucky?`. The variable `value` bound in the clause and the variable `value`
bound in the outer context are two entirely separate variables.
In the example above, `value` is going to be `7` or `13` depending on
the value of `lucky?`. In case `value` has no previous value before
case, clauses that do not explicitly bind a value have the variable
bound to `nil`.
If you want to pattern match against an existing variable,
you need to use the `^/1` operator:
+11 -19
View File
@@ -285,7 +285,7 @@ defmodule Kernel.Typespec do
if is_atom(args) do
[]
else
:lists.map(&variable/1, args)
for(arg <- args, do: variable(arg))
end
vars = :lists.filter(&match?({:var, _, _}, &1), args)
@@ -661,7 +661,7 @@ defmodule Kernel.Typespec do
:elixir_errors.erl_warn(caller.line, caller.file, message)
# This may be generating an invalid typespec but we need to generate it
# to avoid breaking existing code that was valid but only broke Dialyzer
# to avoid breaking existing code that was valid but only broke dialyzer
{right, state} = typespec(expr, vars, caller, state)
{{:ann_type, line(meta), [{:var, line(var_meta), var_name}, right]}, state}
@@ -680,7 +680,7 @@ defmodule Kernel.Typespec do
:elixir_errors.erl_warn(caller.line, caller.file, message)
# This may be generating an invalid typespec but we need to generate it
# to avoid breaking existing code that was valid but only broke Dialyzer
# to avoid breaking existing code that was valid but only broke dialyzer
state = %{state | undefined_type_error_enabled?: false}
{left, state} = typespec(left, vars, caller, state)
state = %{state | undefined_type_error_enabled?: true}
@@ -725,19 +725,14 @@ defmodule Kernel.Typespec do
# aliases in typespecs as compile time dependencies.
remote = Macro.expand(remote, %{caller | function: {:typespec, 0}})
cond do
not is_atom(remote) ->
compile_error(caller, "invalid remote in typespec: #{Macro.to_string(orig)}")
remote == caller.module ->
typespec({name, meta, args}, vars, caller, state)
true ->
{remote_spec, state} = typespec(remote, vars, caller, state)
{name_spec, state} = typespec(name, vars, caller, state)
type = {remote_spec, meta, name_spec, args}
remote_type(type, vars, caller, state)
unless is_atom(remote) do
compile_error(caller, "invalid remote in typespec: #{Macro.to_string(orig)}")
end
{remote_spec, state} = typespec(remote, vars, caller, state)
{name_spec, state} = typespec(name, vars, caller, state)
type = {remote_spec, meta, name_spec, args}
remote_type(type, vars, caller, state)
end
# Handle tuples
@@ -833,10 +828,7 @@ defmodule Kernel.Typespec do
false ->
if state.undefined_type_error_enabled? and
not Map.has_key?(state.defined_type_pairs, {name, arity}) do
compile_error(
caller,
"type #{name}/#{arity} undefined (no such type in #{inspect(caller.module)})"
)
compile_error(caller, "type #{name}/#{arity} undefined")
end
state =
-16
View File
@@ -94,9 +94,6 @@ defmodule Kernel.Utils do
fields = :lists.map(mapper, fields)
enforce_keys = List.wrap(Module.get_attribute(module, :enforce_keys))
# TODO: Make it raise on v2.0
warn_on_duplicate_struct_key(:lists.keysort(1, fields))
foreach = fn
key when is_atom(key) ->
:ok
@@ -111,19 +108,6 @@ defmodule Kernel.Utils do
{struct, enforce_keys, Module.get_attribute(module, :derive)}
end
defp warn_on_duplicate_struct_key([]) do
:ok
end
defp warn_on_duplicate_struct_key([{key, _} | [{key, _} | _] = rest]) do
IO.warn("duplicate key #{inspect(key)} found in struct")
warn_on_duplicate_struct_key(rest)
end
defp warn_on_duplicate_struct_key([_ | rest]) do
warn_on_duplicate_struct_key(rest)
end
@doc """
Announcing callback for defstruct.
"""
+103 -154
View File
@@ -1,10 +1,10 @@
defmodule Keyword do
@moduledoc """
Keyword lists are lists of two-element tuples, where the first
element of the tuple is an atom and the second element can be any
value, used mostly to work with optional values.
A set of functions for working with keywords.
## Examples
A keyword list is a list of two-element tuples where the first
element of the tuple is an atom and the second element
can be any value.
For example, the following is a keyword list:
@@ -15,68 +15,62 @@ defmodule Keyword do
[exit_on_close: true, active: :once, packet_size: 1024]
The two syntaxes are completely equivalent. Like atoms, keyword
lists keys must be composed of Unicode characters such as letters,
numbers, underscore, and `@`. If the keyword has a character that
does not belong to the category above, such as spaces, you can wrap
it in quotes:
This is also the syntax that Elixir uses to inspect keyword lists:
iex> [{:active, :once}]
[active: :once]
The two syntaxes are completely equivalent. Like atoms, keywords
must be composed of Unicode characters such as letters, numbers,
underscore, and `@`. If the keyword has a character that does not
belong to the category above, such as spaces, you can wrap it in
quotes:
iex> ["exit on close": true]
["exit on close": true]
Wrapping a keyword in quotes does not make it a string. Keyword lists
keys are always atoms. If you use quotes around the key when quoting
is not necessary, Elixir will warn.
Wrapping a keyword in quotes does not make it a string. Keywords are
always atoms. If you use quotes when all characters are a valid part
of a keyword without quotes, Elixir will warn.
## Duplicate keys and ordering
Note that when keyword lists are passed as the last argument to a function,
if the short-hand syntax is used then the square brackets around the keyword list
can be omitted as well. For example, the following:
A keyword may have duplicated keys so it is not strictly a key-value
data type. However most of the functions in this module behave exactly
as a key-value so they work similarly to the functions you would find
in the `Map` module. For example, `Keyword.get/3` will get the first
entry matching the given key, regardless if duplicated entries exist.
Similarly, `Keyword.put/3` and `Keyword.delete/2` ensure all duplicated
entries for a given key are removed when invoked. Note however that
keyword list operations need to traverse the list in order to find
keys, so these operations are slower than their map counterparts.
String.split("1-0", "-", trim: true, parts: 2)
A handful of functions exist to handle duplicated keys, for example,
`get_values/2` returns all values for a given key and `delete_first/2`
deletes just one of the existing entries.
is equivalent to:
The functions in `Keyword` do not guarantee any property when it comes
to ordering. However, since a keyword list is simply a list, all the
operations defined in `Enum` and `List` can be applied too, especially
when ordering is required.
String.split("1-0", "-", [trim: true, parts: 2])
A keyword may have duplicated keys so it is not strictly
a key-value store. However most of the functions in this module
behave exactly as a dictionary so they work similarly to
the functions you would find in the `Map` module.
For example, `Keyword.get/3` will get the first entry matching
the given key, regardless if duplicated entries exist.
Similarly, `Keyword.put/3` and `Keyword.delete/3` ensure all
duplicated entries for a given key are removed when invoked.
Note that operations that require keys to be found in the keyword
list (like `Keyword.get/3`) need to traverse the list in order
to find keys, so these operations may be slower than their map
counterparts.
A handful of functions exist to handle duplicated keys, in
particular, `Enum.into/2` allows creating new keywords without
removing duplicated keys, `get_values/2` returns all values for
a given key and `delete_first/2` deletes just one of the existing
entries.
The functions in `Keyword` do not guarantee any property when
it comes to ordering. However, since a keyword list is simply a
list, all the operations defined in `Enum` and `List` can be
applied too, especially when ordering is required.
Most of the functions in this module work in linear time. This means
that, the time it takes to perform an operation grows at the same
rate as the length of the list.
## Call syntax
When keyword lists are passed as the last argument to a function, then
the square brackets around the keyword list can be omitted as well. For
example, the keyword list syntax:
String.split("1-0", "-", [trim: true, parts: 2])
can be written without the enclosing brackets whenever it is the last
argument of a function call:
String.split("1-0", "-", trim: true, parts: 2)
Since tuples, lists, maps, and others are treated the same as function
calls in Elixir syntax, this property is also available to them:
iex> {1, 2, foo: :bar}
{1, 2, [{:foo, :bar}]}
iex> [1, 2, foo: :bar]
[1, 2, {:foo, :bar}]
iex> %{1 => 2, foo: :bar}
%{1 => 2, :foo => :bar}
"""
@compile :inline_list_funcs
@@ -415,12 +409,13 @@ defmodule Keyword do
"""
@spec get_values(t, key) :: [value]
def get_values(keywords, key) when is_list(keywords) and is_atom(key) do
get_values(keywords, key, [])
end
fun = fn
{^key, val} -> {true, val}
{_, _} -> false
end
defp get_values([{key, value} | tail], key, values), do: get_values(tail, key, [value | values])
defp get_values([{_, _} | tail], key, values), do: get_values(tail, key, values)
defp get_values([], _key, values), do: :lists.reverse(values)
:lists.filtermap(fun, keywords)
end
@doc """
Returns all keys from the keyword list.
@@ -458,8 +453,24 @@ defmodule Keyword do
:lists.map(fn {_, v} -> v end, keywords)
end
@doc false
@deprecated "Use Keyword.fetch/2 + Keyword.delete/2 instead"
@doc """
Deletes the entries in the keyword list for a `key` with `value`.
If no `key` with `value` exists, returns the keyword list unchanged.
## Examples
iex> Keyword.delete([a: 1, b: 2], :a, 1)
[b: 2]
iex> Keyword.delete([a: 1, b: 2, a: 3], :a, 3)
[a: 1, b: 2]
iex> Keyword.delete([a: 1], :a, 5)
[a: 1]
iex> Keyword.delete([a: 1], :b, 5)
[a: 1]
"""
@spec delete(t, key, value) :: t
def delete(keywords, key, value) when is_list(keywords) and is_atom(key) do
case :lists.keymember(key, 1, keywords) do
true -> delete_key_value(keywords, key, value)
@@ -505,9 +516,17 @@ defmodule Keyword do
end
end
defp delete_key([{key, _} | tail], key), do: delete_key(tail, key)
defp delete_key([{_, _} = pair | tail], key), do: [pair | delete_key(tail, key)]
defp delete_key([], _key), do: []
defp delete_key([{key, _} | tail], key) do
delete_key(tail, key)
end
defp delete_key([{_, _} = pair | tail], key) do
[pair | delete_key(tail, key)]
end
defp delete_key([], _key) do
[]
end
@doc """
Deletes the first entry in the keyword list for a specific `key`.
@@ -629,10 +648,8 @@ defmodule Keyword do
## Examples
iex> Keyword.replace!([a: 1, b: 2, a: 3], :a, :new)
[a: :new, b: 2]
iex> Keyword.replace!([a: 1, b: 2, c: 3, b: 4], :b, :new)
[a: 1, b: :new, c: 3]
iex> Keyword.replace!([a: 1, b: 2, a: 4], :a, 3)
[a: 3, b: 2]
iex> Keyword.replace!([a: 1], :b, 2)
** (KeyError) key :b not found in: [a: 1]
@@ -641,19 +658,10 @@ defmodule Keyword do
@doc since: "1.5.0"
@spec replace!(t, key, value) :: t
def replace!(keywords, key, value) when is_list(keywords) and is_atom(key) do
replace!(keywords, key, value, keywords)
end
defp replace!([{key, _} | keywords], key, value, _original) do
[{key, value} | delete(keywords, key)]
end
defp replace!([{_, _} = e | keywords], key, value, original) do
[e | replace!(keywords, key, value, original)]
end
defp replace!([], key, _value, original) when is_atom(key) do
raise(KeyError, key: key, term: original)
case :lists.keyfind(key, 1, keywords) do
{^key, _} -> [{key, value} | delete(keywords, key)]
false -> raise KeyError, key: key, term: keywords
end
end
@doc """
@@ -813,10 +821,10 @@ defmodule Keyword do
## Examples
iex> Keyword.update!([a: 1, b: 2, a: 3], :a, &(&1 * 2))
[a: 2, b: 2]
iex> Keyword.update!([a: 1, b: 2, c: 3], :b, &(&1 * 2))
[a: 1, b: 4, c: 3]
iex> Keyword.update!([a: 1], :a, &(&1 * 2))
[a: 2]
iex> Keyword.update!([a: 1, a: 2], :a, &(&1 * 2))
[a: 2]
iex> Keyword.update!([a: 1], :b, &(&1 * 2))
** (KeyError) key :b not found in: [a: 1]
@@ -828,16 +836,16 @@ defmodule Keyword do
update!(keywords, key, fun, keywords)
end
defp update!([{key, value} | keywords], key, fun, _original) do
defp update!([{key, value} | keywords], key, fun, _dict) do
[{key, fun.(value)} | delete(keywords, key)]
end
defp update!([{_, _} = e | keywords], key, fun, original) do
[e | update!(keywords, key, fun, original)]
defp update!([{_, _} = e | keywords], key, fun, dict) do
[e | update!(keywords, key, fun, dict)]
end
defp update!([], key, _fun, original) when is_atom(key) do
raise(KeyError, key: key, term: original)
defp update!([], key, _fun, dict) when is_atom(key) do
raise(KeyError, key: key, term: dict)
end
@doc """
@@ -968,73 +976,14 @@ defmodule Keyword do
@spec pop(t, key, value) :: {value, t}
def pop(keywords, key, default \\ nil) when is_list(keywords) and is_atom(key) do
case fetch(keywords, key) do
{:ok, value} -> {value, delete(keywords, key)}
:error -> {default, keywords}
{:ok, value} ->
{value, delete(keywords, key)}
:error ->
{default, keywords}
end
end
@doc """
Returns the first value for `key` and removes all associated antries in the keyword list,
raising if `key` is not present.
This function behaves like `pop/3`, but raises in cases the `key` is not present in the
given `keywords`.
## Examples
iex> Keyword.pop!([a: 1], :a)
{1, []}
iex> Keyword.pop!([a: 1, a: 2], :a)
{1, []}
iex> Keyword.pop!([a: 1], :b)
** (KeyError) key :b not found in: [a: 1]
"""
@doc since: "1.10.0"
@spec pop!(t, key) :: {value, t}
def pop!(keywords, key) when is_list(keywords) and is_atom(key) do
case fetch(keywords, key) do
{:ok, value} -> {value, delete(keywords, key)}
:error -> raise KeyError, key: key, term: keywords
end
end
@doc """
Returns all values for `key` and removes all associated entries in the keyword list.
It returns a tuple where the first element is a list of values for `key` and the
second element is a keyword list with all entries associated with `key` removed.
If the `key` is not present in the keyword list, `{[], keyword_list}` is
returned.
If you don't want to remove all the entries associated with `key` use `pop_first/3`
instead, that function will remove only the first entry.
## Examples
iex> Keyword.pop_values([a: 1], :a)
{[1], []}
iex> Keyword.pop_values([a: 1], :b)
{[], [a: 1]}
iex> Keyword.pop_values([a: 1, a: 2], :a)
{[1, 2], []}
"""
@doc since: "1.10.0"
@spec pop_values(t, key) :: {[value], t}
def pop_values(keywords, key) when is_list(keywords) and is_atom(key) do
pop_values(:lists.reverse(keywords), key, [], [])
end
defp pop_values([{key, value} | tail], key, values, acc),
do: pop_values(tail, key, [value | values], acc)
defp pop_values([{_, _} = pair | tail], key, values, acc),
do: pop_values(tail, key, values, [pair | acc])
defp pop_values([], _key, values, acc),
do: {values, acc}
@doc """
Lazily returns and removes all values associated with `key` in the keyword list.
+19 -32
View File
@@ -1,6 +1,19 @@
defmodule List do
@moduledoc """
Linked lists hold zero, one, or more elements in the choosen order.
Functions that work on (linked) lists.
Many of the functions provided for lists, which implement
the `Enumerable` protocol, are found in the `Enum` module.
Additionally, the following functions and operators for lists are
found in `Kernel`:
* `++/2`
* `--/2`
* `hd/1`
* `tl/1`
* `in/2`
* `length/1`
Lists in Elixir are specified between square brackets:
@@ -56,17 +69,6 @@ defmodule List do
time because they need to iterate through every element of the list, but
`first/1` will run in constant time because it only needs the first element.
Lists also implement the `Enumerable` protocol, so many functions to work with
lists are found in the `Enum` module. Additionally, the following functions and
operators for lists are found in `Kernel`:
* `++/2`
* `--/2`
* `hd/1`
* `tl/1`
* `in/2`
* `length/1`
## Charlists
If a list is made of non-negative integers, where each integer represents a
@@ -88,23 +90,10 @@ defmodule List do
iex> 'abc'
'abc'
Even though the representation changed, the raw data does remain a list of
numbers, which can be handled as such:
iex> inspect('abc', charlists: :as_list)
"[97, 98, 99]"
iex> Enum.map('abc', fn num -> 1000 + num end)
[1097, 1098, 1099]
You can use the `IEx.Helpers.i/1` helper to get a condensed rundown on
charlists in IEx when you encounter them, which shows you the type, description
and also the raw representation in one single summary.
The rationale behind this behaviour is to better support
Erlang libraries which may return text as charlists
instead of Elixir strings. In Erlang, charlists are the default
way of handling strings, while in Elixir it's binaries. One
example of such functions is `Application.loaded_applications/0`:
instead of Elixir strings. One example of such functions
is `Application.loaded_applications/0`:
Application.loaded_applications()
#=> [
@@ -857,8 +846,6 @@ defmodule List do
Inlined by the compiler.
The base needs to be between `2` and `36`.
## Examples
iex> List.to_integer('3FF', 16)
@@ -898,7 +885,7 @@ defmodule List do
* a list containing one of these three elements
Notice that this function expects a list of integers representing
Unicode code points. If you have a list of bytes, you must instead use
UTF-8 code points. If you have a list of bytes, you must instead use
the [`:binary` module](http://www.erlang.org/doc/man/binary.html).
## Examples
@@ -949,11 +936,11 @@ defmodule List do
end
@doc """
Converts a list of integers representing Unicode code points, lists or
Converts a list of integers representing code points, lists or
strings into a charlist.
Notice that this function expects a list of integers representing
Unicode code points. If you have a list of bytes, you must instead use
UTF-8 code points. If you have a list of bytes, you must instead use
the [`:binary` module](http://www.erlang.org/doc/man/binary.html).
## Examples
-2
View File
@@ -24,8 +24,6 @@ defprotocol List.Chars do
end
defimpl List.Chars, for: Atom do
def to_charlist(nil), do: ''
def to_charlist(atom), do: Atom.to_charlist(atom)
end
+66 -241
View File
@@ -2,62 +2,16 @@ import Kernel, except: [to_string: 1]
defmodule Macro do
@moduledoc ~S"""
Macros are compile-time constructs that are invoked with Elixir's AST
as input and a superset of Elixir's AST as output.
Let's see a simple example that shows the difference between functions and macros:
defmodule Example do
defmacro macro_inspect(value) do
IO.inspect(value)
value
end
def fun_inspect(value) do
IO.inpect(value)
value
end
end
Now let's give it a try:
import Example
macro_inspect(1)
#=> 1
#=> 1
fun_inspect(1)
#=> 1
#=> 1
So far they behave the same, as we are passing an integer as argument.
But what happens when we pass an expresion:
macro_inspect(1 + 2)
#=> {:+, [line: 3], [1, 2]}
#=> 3
fun_inspect(1 + 2)
#=> 3
#=> 3
The macro receives the representation of the code given as argument,
while a function receives the result of the code given as argument.
A macro must return a superset of the code representation. See
`t:input/0` and `t:output/0` for more information.
To learn more about Elixir's AST and how to build them programmatically,
see `quote/2`.
Conveniences for working with macros.
## Custom Sigils
Macros are also commonly used to implement custom sigils. To create a custom
sigil, define a function with the name `sigil_{identifier}` that takes two
arguments. The first argument will be the string, the second will be a charlist
containing any modifiers. If the sigil is lower case (such as `sigil_x`) then
the string argument will allow interpolation. If the sigil is upper case
(such as `sigil_X`) then the string will not be interpolated.
To create a custom sigil, define a function with the name
`sigil_{identifier}` that takes two arguments. The first argument will be
the string, the second will be a charlist containing any modifiers. If the
sigil is lower case (such as `sigil_x`) then the string argument will allow
interpolation. If the sigil is upper case (such as `sigil_X`) then the string
will not be interpolated.
Valid modifiers include only lower and upper case letters. Other characters
will cause a syntax error.
@@ -105,94 +59,13 @@ defmodule Macro do
alias Code.Identifier
@typedoc "Abstract Syntax Tree (AST)"
@type t :: input
@type t :: expr | literal
@typedoc "The inputs of a macro"
@type input ::
input_expr
| {input, input}
| [input]
| atom
| number
| binary
@typedoc "Represents expressions in the AST"
@type expr :: {expr | atom, keyword, atom | [t]}
@typep input_expr :: {input_expr | atom, metadata, atom | [input]}
@typedoc "The output of a macro"
@type output ::
output_expr
| {output, output}
| [output]
| atom
| number
| binary
| captured_remote_function
| pid
@typep output_expr :: {output_expr | atom, metadata, atom | [output]}
@typedoc """
A keyword list of AST metadata.
The metadata in Elixir AST is a keyword list of values. Any key can be used
and different parts of the compiler may use different keys. For example,
the AST received by a macro will always include the `:line` annotation,
while the AST emitted by `quote/2` will only have the `:line` annotation if
the `:line` option is provided.
The following metadata keys are public:
* `:context` - Defines the context in which the AST was generated.
For example, `quote/2` will include the module calling `quote/2`
as the context. This is often used to distinguish regular code from code
generated by a macro or by `quote/2`.
* `:counter` - The variable counter used for variable hygiene. In terms of
the compiler, each variable is identified by the combination of either
`name` and `metadata[:counter]`, or `name` and `context`.
* `:generated` - Whether the code should be considered as generated by
the compiler or not. This means the compiler and tools like Dialyzer may not
emit certain warnings.
* `:keep` - Used by `quote/2` with the option `location: :keep` to annotate
the file and the line number of the quoted source.
* `:line` - The line number of the AST node.
The following metadata keys are enabled by `Code.string_to_quoted/2`:
* `:closing` - contains metadata about the closing pair, such as a `}`
in a tuple or in a map, or such as the closing `)` in a function call
with parens. The `:closing` does not delimit the end of expression if
there are `:do` and `:end` metadata (when `:token_metadata` is true)
* `:column` - the column number of the AST node (when `:columns` is true)
* `:delimiter` - contains the opening delimiter for sigils, strings,
and charlists as a string (such as `"{"`, `"/"`, `"'"`, and the like)
* `:format` - set to `:keyword` when an atom is defined as a keyword
* `:do` - contains metadata about the `do` location in a function call with
`do/end` blocks (when `:token_metadata` is true)
* `:end` - contains metadata about the `end` location in a function call with
`do/end` blocks (when `:token_metadata` is true)
* `:end_of_expression` - denotes when the end of expression effectively
happens. Available for all expressions except the last one inside a
`__block__` (when `:token_metadata` is true)
The following metadata keys are private:
* `:alias` - Used for alias hygiene.
* `:ambiguous_op` - Used for improved error messages in the compiler.
* `:import` - Used for import hygiene.
* `:var` - Used for improved error messages on undefined variables.
Do not rely on them as they may change or be fully removed in future versions
of the language. They are often used by `quote/2` and the compiler to provide
features like hygiene, better error messages, and so forth.
If you introduce custom keys into the AST metadata, please make sure to prefix
them with the name of your library or application, so that they will not conflict
with keys that could potentially be introduced by the compiler in the future.
"""
@type metadata :: keyword
@typedoc "A captured remote function in the format of &Mod.fun/arity"
@type captured_remote_function :: fun
@typedoc "Represents literals in the AST"
@type literal :: atom | number | binary | fun | {t, t} | [t]
@doc """
Breaks a pipeline expression into a list.
@@ -265,7 +138,7 @@ defmodule Macro do
end
# {:fn, _, _} is what we get when we pipe into an anonymous function without
# calling it, for example, `:foo |> (fn x -> x end)`.
# calling it, e.g., `:foo |> (fn x -> x end)`.
def pipe(expr, {:fn, _, _}, _integer) do
raise ArgumentError,
"cannot pipe #{to_string(expr)} into an anonymous function without" <>
@@ -277,26 +150,13 @@ defmodule Macro do
{call, line, List.insert_at([], integer, expr)}
end
def pipe(_expr, {op, _line, [arg]}, _integer) when op == :+ or op == :- do
raise ArgumentError,
"piping into a unary operator is not supported, please use the qualified name: " <>
"Kernel.#{op}(#{to_string(arg)}), instead of #{op}#{to_string(arg)}"
end
def pipe(expr, {op, line, args} = op_args, integer) when is_list(args) do
cond do
is_atom(op) and Identifier.unary_op(op) != :error ->
raise ArgumentError,
"cannot pipe #{to_string(expr)} into #{to_string(op_args)}, " <>
"the #{to_string(op)} operator can only take one argument"
is_atom(op) and Identifier.binary_op(op) != :error ->
raise ArgumentError,
"cannot pipe #{to_string(expr)} into #{to_string(op_args)}, " <>
"the #{to_string(op)} operator can only take two arguments"
true ->
{op, line, List.insert_at(args, integer, expr)}
def pipe(expr, {call, line, args} = call_args, integer) when is_list(args) do
if is_atom(call) and Identifier.binary_op(call) != :error do
raise ArgumentError,
"cannot pipe #{to_string(expr)} into #{to_string(call_args)}, " <>
"the #{to_string(call)} operator can only take two arguments"
else
{call, line, List.insert_at(args, integer, expr)}
end
end
@@ -895,16 +755,6 @@ defmodule Macro do
end
# All other calls
def to_string({target, meta, []} = ast, fun) do
target = call_to_string(target, fun)
if meta[:no_parens] do
fun.(ast, target)
else
fun.(ast, target <> "()")
end
end
def to_string({target, _, args} = ast, fun) when is_list(args) do
with :error <- unary_call(ast, fun),
:error <- binary_call(ast, fun),
@@ -1008,13 +858,7 @@ defmodule Macro do
false
end
defp interpolate(ast, fun), do: interpolate(ast, "\"", "\"", fun)
defp interpolate({:<<>>, _, [parts]}, left, right, _) when left in [~s["""\n], ~s['''\n]] do
<<left::binary, parts::binary, right::binary>>
end
defp interpolate({:<<>>, _, parts}, left, right, fun) do
defp interpolate({:<<>>, _, parts}, fun) do
parts =
Enum.map_join(parts, "", fn
{:"::", _, [{{:., _, [Kernel, :to_string]}, _, [arg]}, {:binary, _, _}]} ->
@@ -1022,19 +866,12 @@ defmodule Macro do
binary when is_binary(binary) ->
binary = inspect_no_limit(binary)
binary = binary_part(binary, 1, byte_size(binary) - 2)
escape_sigil(binary, left)
binary_part(binary, 1, byte_size(binary) - 2)
end)
<<left::binary, parts::binary, right::binary>>
<<?", parts::binary, ?">>
end
defp escape_sigil(parts, "("), do: String.replace(parts, ")", ~S"\)")
defp escape_sigil(parts, "{"), do: String.replace(parts, "}", ~S"\}")
defp escape_sigil(parts, "["), do: String.replace(parts, "]", ~S"\]")
defp escape_sigil(parts, "<"), do: String.replace(parts, ">", ~S"\>")
defp escape_sigil(parts, delimiter), do: String.replace(parts, delimiter, "\\#{delimiter}")
defp module_to_string(atom, _fun) when is_atom(atom) do
inspect_no_limit(atom)
end
@@ -1094,22 +931,25 @@ defmodule Macro do
:error
end
defp sigil_call({sigil, meta, [{:<<>>, _, _} = parts, args]} = ast, fun)
defp sigil_call({sigil, _, [{:<<>>, _, _} = parts, args]} = ast, fun)
when is_atom(sigil) and is_list(args) do
delimiter = Keyword.get(meta, :delimiter, "\"")
{left, right} = delimiter_pair(delimiter)
case Atom.to_string(sigil) do
<<"sigil_", name>> when name >= ?A and name <= ?Z ->
args = sigil_args(args, fun)
{:<<>>, _, [binary]} = parts
formatted = <<?~, name, left::binary, binary::binary, right::binary, args::binary>>
formatted =
if :binary.last(binary) == ?\n do
binary = String.replace(binary, ~s["""], ~s["\\""])
<<?~, name, ~s["""\n], binary::binary, ~s["""], sigil_args(args, fun)::binary>>
else
{left, right} = select_sigil_container(binary)
<<?~, name, left, binary::binary, right, sigil_args(args, fun)::binary>>
end
{:ok, fun.(ast, formatted)}
<<"sigil_", name>> when name >= ?a and name <= ?z ->
args = sigil_args(args, fun)
formatted = "~" <> <<name>> <> interpolate(parts, left, right, fun) <> args
{:ok, fun.(ast, formatted)}
{:ok, fun.(ast, "~" <> <<name>> <> interpolate(parts, fun) <> sigil_args(args, fun))}
_ ->
:error
@@ -1120,13 +960,17 @@ defmodule Macro do
:error
end
defp delimiter_pair("["), do: {"[", "]"}
defp delimiter_pair("{"), do: {"{", "}"}
defp delimiter_pair("("), do: {"(", ")"}
defp delimiter_pair("<"), do: {"<", ">"}
defp delimiter_pair("\"\"\""), do: {"\"\"\"\n", "\"\"\""}
defp delimiter_pair("'''"), do: {"'''\n", "'''"}
defp delimiter_pair(str), do: {str, str}
defp select_sigil_container(binary) do
cond do
:binary.match(binary, ["\""]) == :nomatch -> {?", ?"}
:binary.match(binary, ["\'"]) == :nomatch -> {?', ?'}
:binary.match(binary, ["(", ")"]) == :nomatch -> {?(, ?)}
:binary.match(binary, ["[", "]"]) == :nomatch -> {?[, ?]}
:binary.match(binary, ["{", "}"]) == :nomatch -> {?{, ?}}
:binary.match(binary, ["<", ">"]) == :nomatch -> {?<, ?>}
true -> {?/, ?/}
end
end
defp sigil_args([], _fun), do: ""
defp sigil_args(args, fun), do: fun.(args, List.to_string(args))
@@ -1369,10 +1213,10 @@ defmodule Macro do
elem(do_expand_once(ast, env), 0)
end
defp do_expand_once({:__aliases__, meta, _} = original, env) do
case :elixir_aliases.expand(original, env) do
defp do_expand_once({:__aliases__, _, _} = original, env) do
case :elixir_aliases.expand(original, env.aliases, env.macro_aliases, env.lexical_tracker) do
receiver when is_atom(receiver) ->
:elixir_env.trace({:alias_reference, meta, receiver}, env)
:elixir_lexical.record_remote(receiver, env.function, env.lexical_tracker)
{receiver, true}
aliases ->
@@ -1381,7 +1225,7 @@ defmodule Macro do
case :lists.all(&is_atom/1, aliases) do
true ->
receiver = :elixir_aliases.concat(aliases)
:elixir_env.trace({:alias_reference, meta, receiver}, env)
:elixir_lexical.record_remote(receiver, env.function, env.lexical_tracker)
{receiver, true}
false ->
@@ -1408,9 +1252,17 @@ defmodule Macro do
end
end
defp do_expand_once({atom, meta, context} = original, _env)
# Expand possible macro import invocation
defp do_expand_once({atom, meta, context} = original, env)
when is_atom(atom) and is_list(meta) and is_atom(context) do
{original, false}
if Macro.Env.has_var?(env, {atom, Keyword.get(meta, :counter, context)}) do
{original, false}
else
case do_expand_once({atom, meta, []}, env) do
{_, true} = exp -> exp
{_, false} -> {original, false}
end
end
end
defp do_expand_once({atom, meta, args} = original, env)
@@ -1495,46 +1347,19 @@ defmodule Macro do
def operator?(name, arity) when is_atom(name) and is_integer(arity), do: false
@doc """
Returns `true` if the given quoted expression represents a quoted literal.
Atoms, numbers, and functions are always literals. Binaries, lists, tuples,
maps, and structs are only literals if all of their terms are also literals.
## Examples
iex> Macro.quoted_literal?(quote(do: "foo"))
true
iex> Macro.quoted_literal?(quote(do: {"foo", 1}))
true
iex> Macro.quoted_literal?(quote(do: {"foo", 1, :baz}))
true
iex> Macro.quoted_literal?(quote(do: %{foo: "bar"}))
true
iex> Macro.quoted_literal?(quote(do: %URI{path: "/"}))
true
iex> Macro.quoted_literal?(quote(do: URI.parse("/")))
false
iex> Macro.quoted_literal?(quote(do: {foo, var}))
false
Returns `true` if the given quoted expression is an AST literal.
"""
@doc since: "1.7.0"
@spec quoted_literal?(t) :: boolean
@spec quoted_literal?(literal) :: true
@spec quoted_literal?(expr) :: false
def quoted_literal?(term)
def quoted_literal?({:__aliases__, _, args}),
do: quoted_literal?(args)
def quoted_literal?({:%, _, [left, right]}),
do: quoted_literal?(left) and quoted_literal?(right)
def quoted_literal?({:%{}, _, args}), do: quoted_literal?(args)
def quoted_literal?({:{}, _, args}), do: quoted_literal?(args)
def quoted_literal?({left, right}), do: quoted_literal?(left) and quoted_literal?(right)
def quoted_literal?(list) when is_list(list), do: Enum.all?(list, &quoted_literal?/1)
def quoted_literal?(term),
do: is_atom(term) or is_number(term) or is_binary(term) or is_function(term)
def quoted_literal?(term) do
is_atom(term) or is_number(term) or is_binary(term) or is_function(term)
end
@doc """
Receives an AST node and expands it until it can no longer
+66 -77
View File
@@ -21,31 +21,31 @@ defmodule Macro.Env do
It contains the following fields:
* `aliases` - a list of two-element tuples, where the first
element is the aliased name and the second one the actual name
* `context` - the context of the environment; it can be `nil`
(default context), `:guard` (inside a guard) or `:match` (inside a match)
* `context_modules` - a list of modules defined in the current context
* `module` - the current module name
* `file` - the current file name as a binary
* `line` - the current line as an integer
* `function` - a tuple as `{atom, integer}`, where the first
element is the function name and the second its arity; returns
`nil` if not inside a function
* `functions` - a list of functions imported from each module
* `line` - the current line as an integer
* `macro_aliases` - a list of aliases defined inside the current macro
* `macros` - a list of macros imported from each module
* `module` - the current module name
* `context` - the context of the environment; it can be `nil`
(default context), `:guard` (inside a guard) or `:match` (inside a match)
* `aliases` - a list of two-element tuples, where the first
element is the aliased name and the second one the actual name
* `requires` - the list of required modules
* `functions` - a list of functions imported from each module
* `macros` - a list of macros imported from each module
* `macro_aliases` - a list of aliases defined inside the current macro
* `context_modules` - a list of modules defined in the current context
* `lexical_tracker` - PID of the lexical tracker which is responsible for
keeping user info
The following fields are private to Elixir's macro expansion mechanism and
must not be accessed directly:
The following fields pertain to variable handling and must not be accessed or
relied on. To get a list of all variables, see `vars/1`:
* `contextual_vars`
* `current_vars`
* `lexical_tracker`
* `prematch_vars`
* `tracers`
* `unused_vars`
* `prematch_vars`
* `contextual_vars`
The following fields are deprecated and must not be accessed or relied on:
@@ -53,80 +53,69 @@ defmodule Macro.Env do
"""
@type aliases :: [{module, module}]
@type context :: :match | :guard | nil
@type context_modules :: [module]
@type file :: binary
@type functions :: [{module, [name_arity]}]
@type lexical_tracker :: pid | nil
@type line :: non_neg_integer
@type macro_aliases :: [{module, {term, module}}]
@type macros :: [{module, [name_arity]}]
@type name_arity :: {atom, arity}
@type file :: binary
@type line :: non_neg_integer
@type aliases :: [{module, module}]
@type macro_aliases :: [{module, {term, module}}]
@type context :: :match | :guard | nil
@type requires :: [module]
@type functions :: [{module, [name_arity]}]
@type macros :: [{module, [name_arity]}]
@type context_modules :: [module]
@type lexical_tracker :: pid | nil
@type variable :: {atom, atom | term}
@typep contextual_vars :: [atom]
@typep current_vars ::
{%{optional(variable) => {var_version, var_type}},
%{optional(variable) => {var_version, var_type}} | false}
@typep unused_vars ::
{%{optional({atom, var_version}) => non_neg_integer | false}, non_neg_integer}
@typep prematch_vars ::
{%{optional(variable) => {var_version, var_type}}, non_neg_integer}
| :warn
| :raise
| :pin
| :apply
@typep tracers :: [module]
@typep vars :: [variable]
@typep var_type :: :term
@typep var_version :: non_neg_integer
@typep vars :: [variable]
@typep unused_vars :: %{optional({variable, var_version}) => non_neg_integer | false}
@typep current_vars :: %{optional(variable) => {var_version, var_type}}
@typep prematch_vars :: current_vars | :warn | :raise | :pin | :apply
@typep contextual_vars :: [atom]
@type t :: %{
__struct__: __MODULE__,
aliases: aliases,
context: context,
context_modules: context_modules,
contextual_vars: contextual_vars,
current_vars: current_vars,
file: file,
function: name_arity | nil,
functions: functions,
lexical_tracker: lexical_tracker,
line: line,
macro_aliases: macro_aliases,
macros: macros,
module: atom,
prematch_vars: prematch_vars,
unused_vars: unused_vars,
file: file,
line: line,
function: name_arity | nil,
context: context,
requires: requires,
tracers: tracers,
vars: vars
aliases: aliases,
functions: functions,
macros: macros,
macro_aliases: macro_aliases,
context_modules: context_modules,
vars: vars,
unused_vars: unused_vars,
current_vars: current_vars,
prematch_vars: prematch_vars,
lexical_tracker: lexical_tracker,
contextual_vars: contextual_vars
}
# TODO: Remove :vars field on v2.0
def __struct__ do
%{
__struct__: __MODULE__,
aliases: [],
context: nil,
context_modules: [],
contextual_vars: [],
current_vars: {%{}, %{}},
file: "nofile",
function: nil,
functions: [],
lexical_tracker: nil,
line: 0,
macro_aliases: [],
macros: [],
module: nil,
prematch_vars: :warn,
file: "nofile",
line: 0,
function: nil,
context: nil,
requires: [],
tracers: [],
unused_vars: {%{}, 0},
vars: []
aliases: [],
functions: [],
macros: [],
macro_aliases: [],
context_modules: [],
vars: [],
unused_vars: %{},
current_vars: %{},
prematch_vars: :warn,
lexical_tracker: nil,
contextual_vars: []
}
end
@@ -146,8 +135,8 @@ defmodule Macro.Env do
@spec vars(t) :: [variable]
def vars(env)
def vars(%{__struct__: Macro.Env, current_vars: {read, _}}) do
Map.keys(read)
def vars(%{__struct__: Macro.Env, current_vars: current_vars}) do
Map.keys(current_vars)
end
@doc """
@@ -157,8 +146,8 @@ defmodule Macro.Env do
@spec has_var?(t, variable) :: boolean()
def has_var?(env, var)
def has_var?(%{__struct__: Macro.Env, current_vars: {read, _}}, var) do
Map.has_key?(read, var)
def has_var?(%{__struct__: Macro.Env, current_vars: current_vars}, var) do
Map.has_key?(current_vars, var)
end
@doc """
@@ -180,8 +169,8 @@ defmodule Macro.Env do
env
end
def to_match(%{__struct__: Macro.Env, current_vars: {read, _}, unused_vars: {_, counter}} = env) do
%{env | context: :match, prematch_vars: {read, counter}}
def to_match(%{__struct__: Macro.Env, current_vars: vars} = env) do
%{env | context: :match, prematch_vars: vars}
end
@doc """
+22 -40
View File
@@ -1,9 +1,15 @@
defmodule Map do
@moduledoc """
Maps are the "go to" key-value data structure in Elixir.
A set of functions for working with maps.
Maps can be created with the `%{}` syntax, and key-value pairs can be
expressed as `key => value`:
Many functions for maps, which implement the `Enumerable` protocol,
are found in the `Enum` module. Additionally, the following functions
for maps are found in `Kernel`:
* `map_size/1`
Maps are the "go to" key-value data structure in Elixir. Maps can be created
with the `%{}` syntax, and key-value pairs can be expressed as `key => value`:
iex> %{}
%{}
@@ -91,13 +97,6 @@ defmodule Map do
it performs better because lists have a linear time complexity. Some functions,
such as `keys/1` and `values/1`, run in linear time because they need to get to every
element in the map.
Maps also implement the `Enumerable` protocol, so many functions to work with maps
are found in the `Enum` module. Additionally, the following functions for maps are
found in `Kernel`:
* `map_size/1`
"""
@type key :: any
@@ -265,6 +264,8 @@ defmodule Map do
iex> Map.fetch!(%{a: 1}, :a)
1
iex> Map.fetch!(%{a: 1}, :b)
** (KeyError) key :b not found in: %{a: 1}
"""
@spec fetch!(map, key) :: value
@@ -341,8 +342,8 @@ defmodule Map do
in `map` unless `key` is already present.
This function is useful in case you want to compute the value to put under
`key` only if `key` is not already present, as for example, when the value is expensive to
calculate or generally difficult to setup and teardown again.
`key` only if `key` is not already present (e.g., the value is expensive to
calculate or generally difficult to setup and teardown again).
## Examples
@@ -634,31 +635,6 @@ defmodule Map do
end
end
@doc """
Returns and removes the value associated with `key` in `map` or raises
if `key` is not present.
Behaves the same as `pop/3` but raises if `key` is not present in `map`.
## Examples
iex> Map.pop!(%{a: 1}, :a)
{1, %{}}
iex> Map.pop!(%{a: 1, b: 2}, :a)
{1, %{b: 2}}
iex> Map.pop!(%{a: 1}, :b)
** (KeyError) key :b not found in: %{a: 1}
"""
@doc since: "1.10.0"
@spec pop!(map, key) :: {value, map}
def pop!(map, key) do
case :maps.take(key, map) do
{_, _} = tuple -> tuple
:error -> raise KeyError, key: key, term: map
end
end
@doc """
Lazily returns and removes the value associated with `key` in `map`.
@@ -685,9 +661,15 @@ defmodule Map do
"""
@spec pop_lazy(map, key, (() -> value)) :: {value, map}
def pop_lazy(map, key, fun) when is_function(fun, 0) do
case :maps.take(key, map) do
{_, _} = tuple -> tuple
:error -> {fun.(), map}
case map do
%{^key => value} ->
{value, delete(map, key)}
%{} ->
{fun.(), map}
other ->
:erlang.error({:badmap, other}, [map, key, fun])
end
end
+37 -48
View File
@@ -2,26 +2,14 @@ defmodule MapSet do
@moduledoc """
Functions that work on sets.
A set is a data structure that can contain unique elements of any kind,
without any particular order. `MapSet` is the "go to" set data structure in Elixir.
A set can be constructed using `MapSet.new/0`:
`MapSet` is the "go to" set data structure in Elixir. A set can be constructed
using `MapSet.new/0`:
iex> MapSet.new()
#MapSet<[]>
Elements in a set don't have to be of the same type and they can be
populated from an [enumerable](`t:Enumerable.t/0`) using `MapSet.new/1`:
iex> MapSet.new([1, :two, {"three"}])
#MapSet<[1, :two, {"three"}]>
Elements can be inserted using `MapSet.put/2`:
iex> MapSet.new([2]) |> MapSet.put(4) |> MapSet.put(0)
#MapSet<[0, 2, 4]>
By definition, sets can't contain duplicate elements: when
A set can contain any kind of elements, and elements in a set don't have to be
of the same type. By definition, sets can't contain duplicate elements: when
inserting an element in a set where it's already present, the insertion is
simply a no-op.
@@ -117,7 +105,7 @@ defmodule MapSet do
end
defp new_from_list([], acc) do
Map.new(acc)
:maps.from_list(acc)
end
defp new_from_list([element | rest], acc) do
@@ -125,7 +113,7 @@ defmodule MapSet do
end
defp new_from_list_transform([], _fun, acc) do
Map.new(acc)
:maps.from_list(acc)
end
defp new_from_list_transform([element | rest], fun, acc) do
@@ -163,14 +151,14 @@ defmodule MapSet do
@spec difference(t(val1), t(val2)) :: t(val1) when val1: value, val2: value
def difference(map_set1, map_set2)
# If the first set is less than twice the size of the second map, it is fastest
# to re-accumulate elements in the first set that are not present in the second set.
# If the first set is less than twice the size of the second map,
# it is fastest to re-accumulate elements in the first set that are not
# present in the second set.
def difference(%MapSet{map: map1}, %MapSet{map: map2})
when map_size(map1) < map_size(map2) * 2 do
map =
map1
|> :maps.iterator()
|> :maps.next()
|> Map.keys()
|> filter_not_in(map2, [])
%MapSet{map: map}
@@ -183,13 +171,12 @@ defmodule MapSet do
%{map_set | map: Map.drop(map1, Map.keys(map2))}
end
defp filter_not_in(:none, _map2, acc), do: Map.new(acc)
defp filter_not_in([], _map2, acc), do: :maps.from_list(acc)
defp filter_not_in({key, _val, iter}, map2, acc) do
if :erlang.is_map_key(key, map2) do
filter_not_in(:maps.next(iter), map2, acc)
else
filter_not_in(:maps.next(iter), map2, [{key, @dummy_value} | acc])
defp filter_not_in([key | rest], map2, acc) do
case map2 do
%{^key => _} -> filter_not_in(rest, map2, acc)
_ -> filter_not_in(rest, map2, [{key, @dummy_value} | acc])
end
end
@@ -209,15 +196,19 @@ defmodule MapSet do
{map1, map2} = order_by_size(map1, map2)
map1
|> :maps.iterator()
|> :maps.next()
|> Map.keys()
|> none_in?(map2)
end
defp none_in?(:none, _), do: true
defp none_in?([], _) do
true
end
defp none_in?({key, _val, iter}, map2) do
not :erlang.is_map_key(key, map2) and none_in?(:maps.next(iter), map2)
defp none_in?([key | rest], map2) do
case map2 do
%{^key => _} -> false
_ -> none_in?(rest, map2)
end
end
@doc """
@@ -241,7 +232,7 @@ defmodule MapSet do
# Elixir v1.5 change the map representation, so on
# version mismatch we need to compare the keys directly.
def equal?(%MapSet{map: map1}, %MapSet{map: map2}) do
map_size(map1) == map_size(map2) and all_in?(map1, map2)
map_size(map1) == map_size(map2) and map_subset?(Map.keys(map1), map2)
end
@doc """
@@ -275,7 +266,7 @@ defmodule MapSet do
"""
@spec member?(t, value) :: boolean
def member?(%MapSet{map: map}, value) do
:erlang.is_map_key(value, map)
match?(%{^value => _}, map)
end
@doc """
@@ -323,20 +314,19 @@ defmodule MapSet do
"""
@spec subset?(t, t) :: boolean
def subset?(%MapSet{map: map1}, %MapSet{map: map2}) do
map_size(map1) <= map_size(map2) and all_in?(map1, map2)
if map_size(map1) <= map_size(map2) do
map1
|> Map.keys()
|> map_subset?(map2)
else
false
end
end
defp all_in?(:none, _), do: true
defp map_subset?([], _), do: true
defp all_in?({key, _val, iter}, map2) do
:erlang.is_map_key(key, map2) and all_in?(:maps.next(iter), map2)
end
defp all_in?(map1, map2) when is_map(map1) and is_map(map2) do
map1
|> :maps.iterator()
|> :maps.next()
|> all_in?(map2)
defp map_subset?([key | rest], map2) do
match?(%{^key => _}, map2) and map_subset?(rest, map2)
end
@doc """
@@ -388,8 +378,7 @@ defmodule MapSet do
end
def slice(map_set) do
size = MapSet.size(map_set)
{:ok, size, &Enumerable.List.slice(MapSet.to_list(map_set), &1, &2, size)}
{:ok, MapSet.size(map_set), &Enumerable.List.slice(MapSet.to_list(map_set), &1, &2)}
end
def reduce(map_set, acc, fun) do
+26 -85
View File
@@ -56,9 +56,6 @@ defmodule Module do
If the behaviour changes or `URI.HTTP` does not implement
one of the callbacks, a warning will be raised.
For detailed documentation, see the
[behaviour typespec documentation](typespecs.html#behaviours).
### `@impl`
To aid in the correct implementation of behaviours, you may optionally declare
@@ -140,7 +137,7 @@ defmodule Module do
end
The Mix compiler automatically looks for calls to deprecated modules
and emit warnings during compilation.
and emit warnings during compilation, computed via `mix xref warnings`.
Using the `@deprecated` attribute will also be reflected in the
documentation of the given function and macro. You can choose between
@@ -349,7 +346,7 @@ defmodule Module do
In addition to the built-in attributes outlined above, custom attributes may
also be added. Custom attributes are expressed using the `@/1` operator followed
by a valid variable name. The value given to the custom attribute must be a valid
by a valid variable name. The value given to the custom attribute must be a valid
Elixir value:
defmodule MyModule do
@@ -373,7 +370,7 @@ defmodule Module do
When just a module is provided, the function is assumed to be
`__after_compile__/2`.
Callbacks will run in the order they are registered.
Callbacks registered first will run last.
#### Example
@@ -397,11 +394,10 @@ defmodule Module do
When just a module is provided, the function/macro is assumed to be
`__before_compile__/1`.
Callbacks will run in the order they are registered. Any overridable
definition will be made concrete before the first callback runs.
A definition may be made overridable again in another before compile
callback and it will be made concrete one last time after all callbacks
run.
Callbacks registered first will run last. Any overridable definition
will be made concrete before the first callback runs. A definition may
be made overridable again in another before compile callback and it
will be made concrete one last time after after all callbacks run.
*Note*: unlike `@after_compile`, the callback function/macro must
be placed in a separate module (because when the callback is invoked,
@@ -439,6 +435,10 @@ defmodule Module do
* the list of quoted guards
* the quoted function body
Note the hook receives the quoted arguments and it is invoked before
the function is stored in the module. So `Module.defines?/2` will return
`false` for the first clause of every function.
If the function/macro being defined has multiple clauses, the hook will
be called for each clause.
@@ -482,10 +482,10 @@ defmodule Module do
below:
* `@compile :debug_info` - includes `:debug_info` regardless of the
corresponding setting in `Code.get_compiler_option/1`
corresponding setting in `Code.compiler_options/1`
* `@compile {:debug_info, false}` - disables `:debug_info` regardless
of the corresponding setting in `Code.get_compiler_option/1`
of the corresponding setting in `Code.compiler_options/1`
* `@compile {:inline, some_fun: 2, other_fun: 3}` - inlines the given
name/arity pairs. Inlining is applied locally, calls from another
@@ -495,10 +495,6 @@ defmodule Module do
modules after compilation. Instead, the module will be loaded after
it is dispatched to
* `@compile {:no_warn_undefined, Mod}` or
`@compile {:no_warn_undefined, {Mod, fun, arity}}` - does not warn if
the given module or the given `Mod.fun/arity` are not defined
You can see a handful more options used by the Erlang compiler in
the documentation for the [`:compile` module](http://www.erlang.org/doc/man/compile.html).
'''
@@ -610,7 +606,7 @@ defmodule Module do
assert_not_compiled!(__ENV__.function, module)
:elixir_def.reset_last(module)
{value, binding, _env} =
{value, binding, _env, _scope} =
:elixir.eval_quoted(quoted, binding, Keyword.put(opts, :module, module))
{value, binding}
@@ -1070,7 +1066,7 @@ defmodule Module do
"""
@spec make_overridable(module, [definition]) :: :ok
def make_overridable(module, tuples) when is_atom(module) and is_list(tuples) do
assert_not_readonly!(__ENV__.function, module)
assert_not_compiled!(__ENV__.function, module)
func = fn
{function_name, arity} = tuple
@@ -1126,7 +1122,7 @@ defmodule Module do
behaviour_definitions = bag_lookup_element(bag, {:accumulate, :behaviour}, 2)
cond do
Code.ensure_compiled(behaviour) != {:module, behaviour} ->
not Code.ensure_compiled?(behaviour) ->
{:error, "it was not defined"}
not function_exported?(behaviour, :behaviour_info, 1) ->
@@ -1231,42 +1227,6 @@ defmodule Module do
end
end
@doc """
Checks if the given attribute has been defined.
An attribute is defined if it has been registered with `register_attribute/3`
or assigned a value. If an attribute has been deleted with `delete_attribute/2`
it is no longer considered defined.
This function can only be used on modules that have not yet been compiled.
## Examples
defmodule MyModule do
@value 1
Module.register_attribute(__MODULE__, :other_value)
Module.put_attribute(__MODULE__, :another_value, 1)
Module.has_attribute?(__MODULE__, :value) #=> true
Module.has_attribute?(__MODULE__, :other_value) #=> true
Module.has_attribute?(__MODULE__, :another_value) #=> true
Module.has_attribute?(__MODULE__, :undefined) #=> false
Module.delete_attribute(__MODULE__, :value)
Module.has_attribute?(__MODULE__, :value) #=> false
end
"""
@doc since: "1.10.0"
@spec has_attribute?(module, atom) :: boolean
def has_attribute?(module, key) when is_atom(module) and is_atom(key) do
assert_not_compiled!(__ENV__.function, module)
{set, _bag} = data_tables_for(module)
:ets.member(set, key)
end
@doc """
Deletes the module attribute that matches the given key.
@@ -1282,7 +1242,7 @@ defmodule Module do
"""
@spec delete_attribute(module, atom) :: term
def delete_attribute(module, key) when is_atom(module) and is_atom(key) do
assert_not_readonly!(__ENV__.function, module)
assert_not_compiled!(__ENV__.function, module)
{set, bag} = data_tables_for(module)
case :ets.lookup(set, key) do
@@ -1334,7 +1294,7 @@ defmodule Module do
@spec register_attribute(module, atom, [{:accumulate, boolean}, {:persist, boolean}]) :: :ok
def register_attribute(module, attribute, options)
when is_atom(module) and is_atom(attribute) and is_list(options) do
assert_not_readonly!(__ENV__.function, module)
assert_not_compiled!(__ENV__.function, module)
{set, bag} = data_tables_for(module)
if Keyword.get(options, :persist) do
@@ -1344,9 +1304,6 @@ defmodule Module do
if Keyword.get(options, :accumulate) do
:ets.insert_new(set, {attribute, [], :accumulate}) ||
:ets.update_element(set, attribute, {3, :accumulate})
else
:ets.insert_new(bag, {:warn_attributes, attribute})
:ets.insert_new(set, {attribute, nil, :unset})
end
:ok
@@ -1537,7 +1494,7 @@ defmodule Module do
:ok
end
defp check_behaviours(env, behaviours) do
defp check_behaviours(%{lexical_tracker: pid} = env, behaviours) do
Enum.reduce(behaviours, %{}, fn behaviour, acc ->
cond do
not is_atom(behaviour) ->
@@ -1547,7 +1504,7 @@ defmodule Module do
IO.warn(message, Macro.Env.stacktrace(env))
acc
Code.ensure_compiled(behaviour) != {:module, behaviour} ->
not Code.ensure_compiled?(behaviour) ->
message =
"@behaviour #{inspect(behaviour)} does not exist (in module #{inspect(env.module)})"
@@ -1562,7 +1519,7 @@ defmodule Module do
acc
true ->
:elixir_env.trace({:require, [], behaviour, []}, env)
:elixir_lexical.record_remote(behaviour, nil, pid)
optional_callbacks = behaviour_info(behaviour, :optional_callbacks)
callbacks = behaviour_info(behaviour, :callbacks)
Enum.reduce(callbacks, acc, &add_callback(&1, behaviour, env, optional_callbacks, &2))
@@ -1814,11 +1771,11 @@ defmodule Module do
[{_, _, :accumulate}] ->
:lists.reverse(bag_lookup_element(bag, {:accumulate, key}, 2))
[{_, val, line}] when is_integer(line) ->
:ets.update_element(set, key, {3, :used})
[{_, val, nil}] ->
val
[{_, val, _}] ->
:ets.update_element(set, key, {3, nil})
val
[] when is_integer(line) ->
@@ -1839,7 +1796,7 @@ defmodule Module do
# Used internally by Kernel's @.
# This function is private and must be used only internally.
def __put_attribute__(module, key, value, line) when is_atom(key) do
assert_not_readonly!(__ENV__.function, module)
assert_not_compiled!(__ENV__.function, module)
{set, bag} = data_tables_for(module)
value = preprocess_attribute(key, value)
put_attribute(module, key, value, line, set, bag)
@@ -1889,7 +1846,7 @@ defmodule Module do
catch
:error, :badarg ->
:ets.insert(set, {:on_load, value, line})
:ets.insert(bag, {:warn_attributes, :on_load})
:ets.insert(bag, {:attributes, :on_load})
else
_ -> raise ArgumentError, "the @on_load attribute can only be set once per module"
end
@@ -1901,7 +1858,7 @@ defmodule Module do
catch
:error, :badarg ->
:ets.insert(set, {key, value, line})
:ets.insert(bag, {:warn_attributes, key})
:ets.insert(bag, {:attributes, key})
else
:accumulate -> :ets.insert(bag, {{:accumulate, key}, value})
_ -> :ets.insert(set, {key, value, line})
@@ -2084,22 +2041,6 @@ defmodule Module do
assert_not_compiled_message(function_name_arity, module, extra_msg)
end
defp assert_not_readonly!({function_name, arity}, module) do
case :elixir_module.mode(module) do
:all ->
:ok
:readonly ->
raise ArgumentError,
"could not call Module.#{function_name}/#{arity} because the module " <>
"#{inspect(module)} is in read-only mode (@after_compile)"
:closed ->
raise ArgumentError,
assert_not_compiled_message({function_name, arity}, module, "")
end
end
defp assert_not_compiled_message({function_name, arity}, module, extra_msg) do
mfa = "Module.#{function_name}/#{arity}"
-317
View File
@@ -1,317 +0,0 @@
defmodule Module.Checker do
alias Module.ParallelChecker
@moduledoc false
def verify(module, cache) do
case prepare_module(module) do
{:ok, map} ->
undefined_and_deprecation_warnings = undefined_and_deprecation_warnings(map, cache)
infer_warnings = infer_definitions(map)
warnings = infer_warnings ++ undefined_and_deprecation_warnings
emit_warnings(warnings)
:error ->
[]
end
end
defp prepare_module({module, module_map}) when is_map(module_map) do
{:ok,
%{
module: module,
file: module_map.file,
definitions: module_map.definitions,
deprecated: module_map.deprecated,
no_warn_undefined: no_warn_undefined(module_map.compile_opts)
}}
end
defp prepare_module({module, binary}) when is_binary(binary) do
with {:ok, debug_info} <- debug_info(module, binary),
{:ok, checker_info} <- checker_chunk(binary) do
{:ok,
%{
module: module,
file: debug_info.file,
definitions: debug_info.definitions,
deprecated: checker_info.deprecated,
no_warn_undefined: checker_info.no_warn_undefined
}}
end
end
defp no_warn_undefined(compile_opts) do
for(
{:no_warn_undefined, values} <- compile_opts,
value <- List.wrap(values),
do: value
)
end
defp debug_info(module, binary) do
with {:ok, {_, [debug_info: chunk]}} <- :beam_lib.chunks(binary, [:debug_info]),
{:debug_info_v1, backend, data} <- chunk,
{:ok, info} <- backend.debug_info(:elixir_v1, module, data, []) do
{:ok, %{definitions: info.definitions, file: info.relative_file}}
else
_ -> :error
end
end
defp checker_chunk(binary) do
with {:ok, {_, [{'ExCk', chunk}]}} <- :beam_lib.chunks(binary, ['ExCk']),
{:elixir_checker_v1, contents} <- :erlang.binary_to_term(chunk) do
deprecated = Enum.map(contents.exports, fn {fun, map} -> {fun, map.deprecated_reason} end)
{:ok, %{deprecated: deprecated, no_warn_undefined: contents.no_warn_undefined}}
else
_ -> :error
end
end
defp infer_definitions(map) do
results = Module.Types.infer_definitions(map.file, map.module, map.definitions)
Enum.flat_map(results, fn {_function, reasons} -> reasons end)
end
defp undefined_and_deprecation_warnings(map, cache) do
state = %{
cache: cache,
file: map.file,
module: map.module,
no_warn_undefined: merge_no_warn_undefined(map),
function: nil,
warnings: []
}
state = check_definitions(map.definitions, state)
state.warnings
|> merge_warnings()
|> sort_warnings()
end
defp merge_no_warn_undefined(map) do
case Code.get_compiler_option(:no_warn_undefined) do
:all ->
:all
list when is_list(list) ->
map.no_warn_undefined ++ list
end
end
defp check_definitions(definitions, state) do
Enum.reduce(definitions, state, &check_definition/2)
end
defp check_definition({function, _kind, meta, clauses}, state) do
with_file_meta(%{state | function: function}, meta, fn state ->
Enum.reduce(clauses, state, &check_clause/2)
end)
end
defp with_file_meta(%{file: original_file} = state, meta, fun) do
case Keyword.fetch(meta, :file) do
{:ok, {meta_file, _}} ->
state = fun.(%{state | file: meta_file})
%{state | file: original_file}
:error ->
fun.(state)
end
end
defp check_clause({_meta, args, _guards, body}, state) do
state = check_expr(args, state)
check_expr(body, state)
end
# &Mod.fun/arity
defp check_expr({:&, meta, [{:/, _, [{{:., _, [module, fun]}, _, []}, arity]}]}, state)
when is_atom(module) and is_atom(fun) do
check_remote(module, fun, arity, meta, state)
end
# Mod.fun(...)
defp check_expr({{:., meta, [module, fun]}, _, args}, state)
when is_atom(module) and is_atom(fun) do
state = check_remote(module, fun, length(args), meta, state)
check_expr(args, state)
end
# %Module{...}
defp check_expr({:%, meta, [module, {:%{}, _meta, args}]}, state)
when is_atom(module) and is_list(args) do
state = check_remote(module, :__struct__, 0, meta, state)
check_expr(args, state)
end
# Function call
defp check_expr({left, _meta, right}, state) when is_list(right) do
state = check_expr(right, state)
check_expr(left, state)
end
# {x, y}
defp check_expr({left, right}, state) do
state = check_expr(right, state)
check_expr(left, state)
end
# [...]
defp check_expr(list, state) when is_list(list) do
Enum.reduce(list, state, &check_expr/2)
end
defp check_expr(_other, state) do
state
end
defp check_remote(module, fun, arity, meta, state) do
# TODO: In the future we may want to warn for modules defined
# in the local context
if Keyword.get(meta, :context_module, false) and state.module != module do
state
else
ParallelChecker.preload_module(state.cache, module)
check_export(module, fun, arity, meta, state)
end
end
defp check_export(module, fun, arity, meta, state) do
case ParallelChecker.fetch_export(state.cache, module, fun, arity) do
{:ok, :def, reason} ->
check_deprecated(module, fun, arity, reason, meta, state)
{:ok, :defmacro, reason} ->
state = warn(meta, state, {:unrequired_module, module, fun, arity})
check_deprecated(module, fun, arity, reason, meta, state)
{:error, :module} ->
if warn_undefined?(module, fun, arity, state) do
warn(meta, state, {:undefined_module, module, fun, arity})
else
state
end
{:error, :function} ->
if warn_undefined?(module, fun, arity, state) do
exports = ParallelChecker.all_exports(state.cache, module)
warn(meta, state, {:undefined_function, module, fun, arity, exports})
else
state
end
end
end
defp check_deprecated(module, fun, arity, reason, meta, state) do
if reason do
warn(meta, state, {:deprecated, module, fun, arity, reason})
else
state
end
end
# TODO: Do not warn inside guards
# TODO: Properly handle protocols
defp warn_undefined?(_module, :__impl__, 1, _state), do: false
defp warn_undefined?(_module, :module_info, 0, _state), do: false
defp warn_undefined?(_module, :module_info, 1, _state), do: false
defp warn_undefined?(:erlang, :orelse, 2, _state), do: false
defp warn_undefined?(:erlang, :andalso, 2, _state), do: false
defp warn_undefined?(_, _, _, %{no_warn_undefined: :all}) do
false
end
defp warn_undefined?(module, fun, arity, state) do
not Enum.any?(state.no_warn_undefined, &(&1 == module or &1 == {module, fun, arity}))
end
defp warn(meta, state, warning) do
{fun, arity} = state.function
location = {state.file, meta[:line] || 0, {state.module, fun, arity}}
%{state | warnings: [{__MODULE__, warning, location} | state.warnings]}
end
defp merge_warnings(warnings) do
Enum.reduce(warnings, %{}, fn {module, warning, location}, acc ->
locations = MapSet.new([location])
Map.update(acc, {module, warning}, locations, &MapSet.put(&1, location))
end)
end
defp sort_warnings(warnings) do
warnings
|> Enum.map(fn {{module, warning}, locations} -> {module, warning, Enum.sort(locations)} end)
|> Enum.sort()
end
defp emit_warnings(warnings) do
Enum.flat_map(warnings, fn {module, warning, locations} ->
message = module.format_warning(warning)
print_warning([message, ?\n, format_locations(locations)])
Enum.map(locations, fn {file, line, _mfa} ->
{file, line, message}
end)
end)
end
def format_warning({:undefined_module, module, fun, arity}) do
[
Exception.format_mfa(module, fun, arity),
" is undefined (module ",
inspect(module),
" is not available or is yet to be defined)"
]
end
def format_warning({:undefined_function, module, fun, arity, exports}) do
[
Exception.format_mfa(module, fun, arity),
" is undefined or private",
UndefinedFunctionError.hint_for_loaded_module(module, fun, arity, exports)
]
end
def format_warning({:deprecated, module, fun, arity, reason}) do
[
Exception.format_mfa(module, fun, arity),
" is deprecated. ",
reason
]
end
def format_warning({:unrequired_module, module, fun, arity}) do
[
"you must require ",
inspect(module),
" before invoking the macro ",
Exception.format_mfa(module, fun, arity)
]
end
defp format_locations([location]) do
format_location(location)
end
defp format_locations(locations) do
[
"Found at #{length(locations)} locations:\n",
Enum.map(locations, &format_location/1)
]
end
defp format_location({file, line, {module, fun, arity}}) do
file = Path.relative_to_cwd(file)
line = if line > 0, do: [Integer.to_string(line), ": "], else: []
mfa = Exception.format_mfa(module, fun, arity)
[" ", file, ?:, line, mfa, ?\n]
end
defp print_warning(message) do
IO.puts(:stderr, [:elixir_errors.warning_prefix(), message])
end
end
-296
View File
@@ -1,296 +0,0 @@
defmodule Module.ParallelChecker do
@moduledoc false
@type cache() :: {pid(), :ets.tid()}
@type warning() :: term()
@type kind() :: :def | :defmacro
@doc """
Receives pairs of module maps and BEAM binaries. In parallel it verifies
the modules and adds the ExCk chunk to the binaries. Returns the updated
binaries and a list of warnings from the verification.
"""
@spec verify([{map(), binary()}], [{module(), binary()}], pos_integer()) :: [warning()]
def verify(compiled_modules, runtime_binaries, schedulers \\ nil) do
compiled_maps = Enum.map(compiled_modules, fn {map, _binary} -> {map.module, map} end)
check_modules = compiled_maps ++ runtime_binaries
schedulers = schedulers || max(:erlang.system_info(:schedulers_online), 2)
{:ok, server} = :gen_server.start_link(__MODULE__, [check_modules, self(), schedulers], [])
preload_cache(get_ets(server), check_modules)
start(server)
collect_results(length(check_modules), [])
end
defp collect_results(0, warnings) do
warnings
end
defp collect_results(count, warnings) do
receive do
{__MODULE__, _module, new_warnings} ->
collect_results(count - 1, new_warnings ++ warnings)
end
end
@doc """
Preloads a module into the cache. Call this function before any other
cache lookups for the module.
"""
@spec preload_module(cache(), module()) :: :ok
def preload_module({server, ets}, module) do
case :ets.lookup(ets, {:cached, module}) do
[{_key, _}] -> :ok
[] -> cache_module({server, ets}, module)
end
end
@doc """
Returns the export kind and deprecation reason for the given MFA from
the cache. If the module does not exist return `{:error, :module}`,
or if the function does not exist return `{:error, :function}`.
"""
@spec fetch_export(cache(), module(), atom(), arity()) ::
{:ok, kind(), binary() | nil} | {:error, :function | :module}
def fetch_export({_server, ets}, module, fun, arity) do
case :ets.lookup(ets, {:cached, module}) do
[{_key, true}] ->
case :ets.lookup(ets, {:export, {module, fun, arity}}) do
[{_key, kind, reason}] -> {:ok, kind, reason}
[] -> {:error, :function}
end
[{_key, false}] ->
{:error, :module}
end
end
@doc """
Returns all exported functions and macros for the given module from
the cache.
"""
@spec all_exports(cache(), module()) :: [{atom(), arity()}]
def all_exports({_server, ets}, module) do
# This is only called after we get a deprecation notice
# so we can assume it's a cached module
[{_key, exports}] = :ets.lookup(ets, {:all_exports, module})
exports
|> Enum.map(fn {function, _kind} -> function end)
|> Enum.sort()
end
def init([modules, send_results, schedulers]) do
ets = :ets.new(:checker_cache, [:set, :public, {:read_concurrency, true}])
state = %{
ets: ets,
waiting: %{},
send_results: send_results,
modules: modules,
spawned: 0,
schedulers: schedulers
}
{:ok, state}
end
def handle_call({:lock, module}, from, %{waiting: waiting} = state) do
case waiting do
%{^module => froms} ->
waiting = Map.put(state.waiting, module, [from | froms])
{:noreply, %{state | waiting: waiting}}
%{} ->
waiting = Map.put(state.waiting, module, [])
{:reply, true, %{state | waiting: waiting}}
end
end
def handle_call({:unlock, module}, _from, %{waiting: waiting} = state) do
froms = Map.fetch!(waiting, module)
Enum.each(froms, &:gen_server.reply(&1, false))
waiting = Map.delete(waiting, module)
{:reply, :ok, %{state | waiting: waiting}}
end
def handle_call(:get_ets, _from, %{ets: ets} = state) do
{:reply, ets, state}
end
def handle_cast(:start, %{modules: []} = state) do
{:stop, :normal, state}
end
def handle_cast(:start, state) do
{:noreply, spawn_checkers(state)}
end
def handle_info({__MODULE__, :done}, state) do
state = %{state | spawned: state.spawned - 1}
if state.spawned == 0 and state.modules == [] do
{:stop, :normal, state}
else
state = spawn_checkers(state)
{:noreply, state}
end
end
defp lock(server, module) do
:gen_server.call(server, {:lock, module}, :infinity)
end
defp unlock(server, module) do
:gen_server.call(server, {:unlock, module})
end
defp get_ets(server) do
:gen_server.call(server, :get_ets)
end
defp start(server) do
:gen_server.cast(server, :start)
end
defp preload_cache(ets, modules) do
Enum.each(modules, fn
{_module, map} when is_map(map) -> cache_from_module_map(ets, map)
{module, binary} when is_binary(binary) -> cache_from_chunk(ets, module, binary)
end)
end
defp spawn_checkers(%{modules: []} = state) do
state
end
defp spawn_checkers(%{spawned: spawned, schedulers: schedulers} = state)
when spawned >= schedulers do
state
end
defp spawn_checkers(%{modules: [{module, _} = verify | modules]} = state) do
parent = self()
ets = state.ets
send_results_pid = state.send_results
spawn_link(fn ->
warnings = Module.Checker.verify(verify, {parent, ets})
send(send_results_pid, {__MODULE__, module, warnings})
send(parent, {__MODULE__, :done})
end)
spawn_checkers(%{state | modules: modules, spawned: state.spawned + 1})
end
defp cache_module({server, ets}, module) do
if lock(server, module) do
cache_from_chunk(ets, module) || cache_from_info(ets, module)
unlock(server, module)
end
end
defp cache_from_chunk(ets, module) do
case :code.get_object_code(module) do
{^module, binary, _filename} -> cache_from_chunk(ets, module, binary)
_other -> false
end
end
defp cache_from_chunk(ets, module, binary) do
with {:ok, {_, [{'ExCk', chunk}]}} <- :beam_lib.chunks(binary, ['ExCk']),
{:elixir_checker_v1, contents} <- :erlang.binary_to_term(chunk) do
cache_chunk(ets, module, contents.exports)
true
else
_ -> false
end
end
defp cache_from_module_map(ets, map) do
exports =
[{{:__info__, 1}, :def}] ++
behaviour_exports(map) ++
definitions_to_exports(map.definitions)
deprecated = Map.new(map.deprecated)
cache_info(ets, map.module, exports, deprecated)
end
defp cache_from_info(ets, module) do
if Code.ensure_loaded?(module) do
exports = info_exports(module)
deprecated = info_deprecated(module)
cache_info(ets, module, exports, deprecated)
else
:ets.insert(ets, {{:cached, module}, false})
end
end
defp info_exports(module) do
Map.new(
[{{:__info__, 1}, :def}] ++
behaviour_exports(module) ++
Enum.map(module.__info__(:macros), &{&1, :defmacro}) ++
Enum.map(module.__info__(:functions), &{&1, :def})
)
rescue
_ -> Map.new(Enum.map(module.module_info(:exports), &{&1, :def}))
end
defp info_deprecated(module) do
Map.new(module.__info__(:deprecated))
rescue
_ -> %{}
end
defp cache_info(ets, module, exports, deprecated) do
exports =
Enum.map(exports, fn {{fun, arity}, kind} ->
reason = Map.get(deprecated, {fun, arity})
:ets.insert(ets, {{:export, {module, fun, arity}}, kind, reason})
{{fun, arity}, kind}
end)
:ets.insert(ets, {{:all_exports, module}, exports})
:ets.insert(ets, {{:cached, module}, true})
end
defp cache_chunk(ets, module, exports) do
exports =
Enum.map(exports, fn {{fun, arity}, %{kind: kind, deprecated_reason: reason}} ->
:ets.insert(ets, {{:export, {module, fun, arity}}, kind, reason})
{{fun, arity}, kind}
end)
:ets.insert(ets, {{:export, {module, :__info__, 1}}, :def, nil})
exports = [{{:__info__, 1}, :def} | exports]
:ets.insert(ets, {{:all_exports, module}, exports})
:ets.insert(ets, {{:cached, module}, true})
end
defp behaviour_exports(%{is_behaviour: true}), do: [{{:behaviour_info, 1}, :def}]
defp behaviour_exports(%{is_behaviour: false}), do: []
defp behaviour_exports(module) when is_atom(module) do
if {:behaviour_info, 1} in module.module_info(:functions) do
[{{:behaviour_info, 1}, :def}]
else
[]
end
end
defp definitions_to_exports(definitions) do
Enum.flat_map(definitions, fn {function, kind, _meta, _clauses} ->
if kind in [:def, :defmacro] do
[{function, kind}]
else
[]
end
end)
end
end
-387
View File
@@ -1,387 +0,0 @@
defmodule Module.Types do
@moduledoc false
import Module.Types.Helpers
alias Module.Types.{Expr, Pattern}
@doc """
Infer function definitions' types.
"""
def infer_definitions(file, module, defs) do
clauses = infer_signatures(file, module, defs)
infer_bodies(clauses)
end
defp infer_signatures(file, module, defs) do
Enum.map(defs, fn {{fun, _arity} = function, kind, meta, clauses} ->
stack = head_stack()
context = head_context(file, module, function)
clauses =
Enum.map(clauses, fn {_meta, params, guards, body} ->
def_expr = {kind, meta, [guards_to_expr(guards, {fun, [], params})]}
stack = push_expr_stack(def_expr, stack)
case of_head(params, guards, stack, context) do
{:ok, _signature, context} -> {:ok, {context, body}}
{:error, reason} -> {:error, reason}
end
end)
{function, clauses}
end)
end
defp infer_bodies(clauses) do
Enum.map(clauses, fn {function, clauses} ->
errors =
Enum.flat_map(clauses, fn
{:ok, {head_context, body}} ->
stack = body_stack()
context = body_context(head_context)
case Expr.of_expr(body, stack, context) do
{:ok, _type, _context} -> []
{:error, reason} -> [reason]
end
{:error, reason} ->
[reason]
end)
{function, errors}
end)
end
@doc false
def of_head(params, guards, stack, context) do
with {:ok, types, context} <-
map_reduce_ok(params, context, &Pattern.of_pattern(&1, stack, &2)),
# TODO: Check that of_guard/3 returns boolean() | :fail
{:ok, _, context} <- Pattern.of_guard(guards_to_or(guards), stack, context),
do: {:ok, lift_types(types, context), context}
end
@doc false
def head_context(file, module, function) do
%{
# File of module
file: file,
# Module of definitions
module: module,
# Current function
function: function,
# Expression variable to type variable
vars: %{},
# Type variable to expression variable
types_to_vars: %{},
# Type variable to type
types: %{},
# Trace of all variables that have been refined to a type,
# including the type they were refined to, why, and where
traces: %{},
# Counter to give type variables unique names
counter: 0,
# Track if a variable was infered from a type guard function such is_tuple/1
# or a guard function that fails such as elem/2, possible values are:
# `:guarded` when `is_tuple(x)`
# `:fail` when `elem(x, 0)`
# `:guarded_fail` when `is_tuple and elem(x, 0)`
guard_sources: %{}
}
end
@doc false
def head_stack() do
%{
# Stack of expression we have recursed through during inference,
# used for tracing
expr_stack: [],
# When false do not add a trace when a type variable is refined,
# useful when merging contexts where the variables already have traces
trace: true,
# Track if we are in a context where type guard functions should
# affect inference
type_guards_enabled?: true,
# Context used to determine if unification is bi-directional, :expr
# is directional, :pattern is bi-directional
context: :pattern
}
end
@doc false
def body_context(head_context) do
%{
# File of module
file: head_context.file,
# Module of definitions
module: head_context.module,
# Current function
function: head_context.function,
# Expression variable to type variable
vars: head_context.vars,
# Type variable to expression variable
types_to_vars: head_context.types_to_vars,
# Type variable to type
types: head_context.types,
# Trace of all variables that have been refined to a type,
# including the type they were refined to, why, and where
traces: head_context.traces,
# Counter to give type variables unique names
counter: head_context.counter
}
end
@doc false
def body_stack() do
%{
# Stack of expression we have recursed through during inference,
# used for tracing
expr_stack: [],
# When false do not add a trace when a type variable is refined,
# useful when merging contexts where the variables already have traces
trace: true,
# Context used to determine if unification is bi-directional, :expr
# is directional, :pattern is bi-directional
context: :expr
}
end
@doc """
Lifts type variables to their infered types from the context.
"""
def lift_types(types, context) do
context = %{
types: context.types,
lifted_types: %{},
lifted_counter: 0
}
{types, _context} = Enum.map_reduce(types, context, &do_lift_type/2)
types
end
@doc false
def lift_type(type, context) do
context = %{
types: context.types,
lifted_types: %{},
lifted_counter: 0
}
{type, _context} = do_lift_type(type, context)
type
end
## GUARDS
# TODO: Remove this and let multiple when be treated as multiple clauses,
# meaning they will be intersection types
defp guards_to_or([]) do
[]
end
defp guards_to_or(guards) do
Enum.reduce(guards, fn guard, acc -> {{:., [], [:erlang, :orelse]}, [], [guard, acc]} end)
end
defp guards_to_expr([], left) do
left
end
defp guards_to_expr([guard | guards], left) do
guards_to_expr(guards, {:when, [], [left, guard]})
end
## VARIABLE LIFTING
# Lift type variable to its infered (hopefully concrete) types from the context
defp do_lift_type({:var, var}, context) do
case Map.fetch(context.lifted_types, var) do
{:ok, lifted_var} ->
{{:var, lifted_var}, context}
:error ->
case Map.fetch(context.types, var) do
{:ok, :unbound} ->
new_lifted_var(var, context)
{:ok, type} ->
# Remove visited types to avoid infinite loops
# then restore after we are done recursing on vars
types = context.types
context = %{context | types: Map.delete(context.types, var)}
{type, context} = do_lift_type(type, context)
{type, %{context | types: types}}
:error ->
new_lifted_var(var, context)
end
end
end
defp do_lift_type({:tuple, types}, context) do
{types, context} = Enum.map_reduce(types, context, &do_lift_type/2)
{{:tuple, types}, context}
end
defp do_lift_type({:map, pairs}, context) do
{pairs, context} =
Enum.map_reduce(pairs, context, fn {key, value}, context ->
{key, context} = do_lift_type(key, context)
{value, context} = do_lift_type(value, context)
{{key, value}, context}
end)
{{:map, pairs}, context}
end
defp do_lift_type({:list, type}, context) do
{type, context} = do_lift_type(type, context)
{{:list, type}, context}
end
defp do_lift_type(other, context) do
{other, context}
end
defp new_lifted_var(original_var, context) do
types = Map.put(context.lifted_types, original_var, context.lifted_counter)
counter = context.lifted_counter + 1
type = {:var, context.lifted_counter}
context = %{context | lifted_types: types, lifted_counter: counter}
{type, context}
end
## ERROR FORMATTING
def format_warning({:unable_unify, left, right, expr, traces}) do
[
"incompatible types:\n\n ",
format_type(left),
" !~ ",
format_type(right),
"\n\n",
format_expr(expr),
format_traces(traces),
"Conflict found at"
]
end
defp format_expr(nil) do
[]
end
defp format_expr(expr) do
[
"in expression:\n\n ",
expr_to_string(expr),
"\n\n"
]
end
defp format_traces([]) do
[]
end
defp format_traces(traces) do
Enum.map(traces, fn
{var, {:type, type, expr, location}} ->
[
"where \"",
Macro.to_string(var),
"\" was given the type ",
Module.Types.format_type(type),
" in:\n\n # ",
format_location(location),
" ",
expr_to_string(expr),
"\n\n"
]
{var1, {:var, var2, expr, location}} ->
[
"where \"",
Macro.to_string(var1),
"\" was given the same type as \"",
Macro.to_string(var2),
"\" in:\n\n # ",
format_location(location),
" ",
expr_to_string(expr),
"\n\n"
]
end)
end
defp format_location({file, line}) do
file = Path.relative_to_cwd(file)
line = if line, do: [Integer.to_string(line)], else: []
[file, ?:, line, ?\n]
end
@doc false
def format_type({:union, types}) do
"#{Enum.map_join(types, " | ", &format_type/1)}"
end
def format_type({:tuple, types}) do
"{#{Enum.map_join(types, ", ", &format_type/1)}}"
end
def format_type({:list, type}) do
"[#{format_type(type)}]"
end
def format_type({:map, pairs}) do
case List.keytake(pairs, :__struct__, 0) do
{{:__struct__, struct}, pairs} ->
"%#{inspect(struct)}{#{format_map_pairs(pairs)}}"
nil ->
"%{#{format_map_pairs(pairs)}}"
end
end
def format_type({:atom, literal}) do
inspect(literal)
end
def format_type(atom) when is_atom(atom) do
"#{atom}()"
end
def format_type({:var, index}) do
"var#{index}"
end
defp format_map_pairs(pairs) do
Enum.map_join(pairs, ", ", fn {left, right} ->
"#{format_type(left)} => #{format_type(right)}"
end)
end
@doc false
def expr_to_string(expr) do
expr
|> reverse_rewrite()
|> Macro.to_string()
end
defp reverse_rewrite(guard) do
Macro.prewalk(guard, fn
{:., _, [:erlang, :orelse]} -> :or
{:., _, [:erlang, :andalso]} -> :and
{{:., _, [mod, fun]}, _, args} -> erl_to_ex(mod, fun, args)
other -> other
end)
end
defp erl_to_ex(mod, fun, args) do
case :elixir_rewrite.erl_to_ex(mod, fun, args) do
{Kernel, fun, args} -> {fun, [], args}
{mod, fun, args} -> {{:., [], [mod, fun]}, [], args}
end
end
end
-7
View File
@@ -1,7 +0,0 @@
defmodule Module.Types.Expr do
@moduledoc false
def of_expr(_expr, _stack, context) do
{:ok, :dynamic, context}
end
end
-126
View File
@@ -1,126 +0,0 @@
defmodule Module.Types.Helpers do
@moduledoc false
@doc """
Guard function to check if an AST node is a variable.
"""
defmacro is_var(expr) do
quote do
is_tuple(unquote(expr)) and
tuple_size(unquote(expr)) == 3 and
is_atom(elem(unquote(expr), 0)) and
is_atom(elem(unquote(expr), 2))
end
end
@doc """
Returns unique identifier for the current assignment of the variable.
"""
def var_name({_name, meta, _context}), do: Keyword.fetch!(meta, :version)
@doc """
Push expression to stack.
The expression stack is used to give the context where a type variable
was refined when show a type conflict error.
"""
def push_expr_stack(expr, stack) do
%{stack | expr_stack: [expr | stack.expr_stack]}
end
@doc """
Like `Enum.reduce/3` but only continues while `fun` returns `{:ok, acc}`
and stops on `{:error, reason}`.
"""
def reduce_ok(list, acc, fun) do
do_reduce_ok(list, acc, fun)
end
defp do_reduce_ok([head | tail], acc, fun) do
case fun.(head, acc) do
{:ok, acc} ->
do_reduce_ok(tail, acc, fun)
result when elem(result, 0) == :ok ->
result = Tuple.delete_at(result, 0)
do_reduce_ok(tail, result, fun)
{:error, reason} ->
{:error, reason}
end
end
defp do_reduce_ok([], acc, _fun), do: {:ok, acc}
@doc """
Like `Enum.unzip/1` but only continues while `fun` returns `{:ok, elem1, elem2}`
and stops on `{:error, reason}`.
"""
def unzip_ok(list) do
do_unzip_ok(list, [], [])
end
defp do_unzip_ok([{:ok, head1, head2} | tail], acc1, acc2) do
do_unzip_ok(tail, [head1 | acc1], [head2 | acc2])
end
defp do_unzip_ok([{:error, reason} | _tail], _acc1, _acc2), do: {:error, reason}
defp do_unzip_ok([], acc1, acc2), do: {:ok, Enum.reverse(acc1), Enum.reverse(acc2)}
@doc """
Like `Enum.map/2` but only continues while `fun` returns `{:ok, elem}`
and stops on `{:error, reason}`.
"""
def map_ok(list, fun) do
do_map_ok(list, [], fun)
end
defp do_map_ok([head | tail], acc, fun) do
case fun.(head) do
{:ok, elem} ->
do_map_ok(tail, [elem | acc], fun)
result when elem(result, 0) == :ok ->
result = Tuple.delete_at(result, 0)
do_map_ok(tail, [result | acc], fun)
{:error, reason} ->
{:error, reason}
end
end
defp do_map_ok([], acc, _fun), do: {:ok, Enum.reverse(acc)}
@doc """
Like `Enum.map_reduce/3` but only continues while `fun` returns `{:ok, elem, acc}`
and stops on `{:error, reason}`.
"""
def map_reduce_ok(list, acc, fun) do
do_map_reduce_ok(list, {[], acc}, fun)
end
defp do_map_reduce_ok([head | tail], {list, acc}, fun) do
case fun.(head, acc) do
{:ok, elem, acc} ->
do_map_reduce_ok(tail, {[elem | list], acc}, fun)
{:error, reason} ->
{:error, reason}
end
end
defp do_map_reduce_ok([], {list, acc}, _fun), do: {:ok, Enum.reverse(list), acc}
@doc """
Given a list of `[{:ok, term()} | {:error, term()}]` it returns a list of
errors `{:error, [term()]}` in case of at least one error or `{:ok, [term()]}`
if there are no errors.
"""
def oks_or_errors(list) do
case Enum.split_with(list, &match?({:ok, _}, &1)) do
{oks, []} -> {:ok, Enum.map(oks, fn {:ok, ok} -> ok end)}
{_oks, errors} -> {:error, Enum.map(errors, fn {:error, error} -> error end)}
end
end
end
-356
View File
@@ -1,356 +0,0 @@
defmodule Module.Types.Infer do
@moduledoc false
import Module.Types.Helpers
@doc """
Unifies two types and returns the unified type and an updated typing context
or an error in case of a typing conflict.
"""
def unify(source, target, stack, context) do
case do_unify(source, target, stack, context) do
{:ok, type, context} ->
{:ok, type, context}
{:error, reason} ->
if stack.context == :pattern do
case do_unify(target, source, stack, context) do
{:ok, type, context} ->
{:ok, type, context}
{:error, _} ->
{:error, reason}
end
else
{:error, reason}
end
end
end
defp do_unify(same, same, _stack, context) do
{:ok, same, context}
end
defp do_unify({:var, var}, type, stack, context) do
unify_var(var, type, stack, context, _var_source = true)
end
defp do_unify(type, {:var, var}, stack, context) do
unify_var(var, type, stack, context, _var_source = false)
end
defp do_unify({:tuple, sources}, {:tuple, targets}, stack, context)
when length(sources) == length(targets) do
result =
map_reduce_ok(Enum.zip(sources, targets), context, fn {source, target}, context ->
unify(source, target, stack, context)
end)
case result do
{:ok, types, context} -> {:ok, {:tuple, types}, context}
{:error, reason} -> {:error, reason}
end
end
defp do_unify({:list, source}, {:list, target}, stack, context) do
case unify(source, target, stack, context) do
{:ok, type, context} -> {:ok, {:list, type}, context}
{:error, reason} -> {:error, reason}
end
end
defp do_unify({:map, source_pairs}, {:map, target_pairs}, stack, context) do
# Since maps in patterns only support literal keys (excluding maps)
# we can do exact type match without subtype checking
unique_right_pairs =
Enum.reject(target_pairs, fn {key, _value} ->
:lists.keyfind(key, 1, source_pairs)
end)
unique_pairs = source_pairs ++ unique_right_pairs
# Build union of all unique key-value pairs between the maps
result =
map_reduce_ok(unique_pairs, context, fn {source_key, source_value}, context ->
case :lists.keyfind(source_key, 1, target_pairs) do
{^source_key, target_value} ->
case unify(source_value, target_value, stack, context) do
{:ok, value, context} -> {:ok, {source_key, value}, context}
{:error, reason} -> {:error, reason}
end
false ->
{:ok, {source_key, source_value}, context}
end
end)
case result do
{:ok, pairs, context} -> {:ok, {:map, pairs}, context}
{:error, reason} -> {:error, reason}
end
end
defp do_unify(source, :dynamic, _stack, context) do
{:ok, source, context}
end
defp do_unify(source, target, stack, context) do
if subtype?(source, target, context) do
{:ok, source, context}
else
error({:unable_unify, source, target}, stack, context)
end
end
defp unify_var(var, type, stack, context, var_source?) do
case Map.fetch!(context.types, var) do
:unbound ->
context = refine_var(var, type, stack, context)
if recursive_type?(type, [], context) do
if var_source? do
error({:unable_unify, {:var, var}, type}, stack, context)
else
error({:unable_unify, type, {:var, var}}, stack, context)
end
else
{:ok, {:var, var}, context}
end
var_type ->
context = trace_var(var, type, stack, context)
unify_result =
if var_source? do
unify(var_type, type, stack, context)
else
unify(type, var_type, stack, context)
end
case unify_result do
{:ok, var_type, context} ->
context = refine_var(var, var_type, stack, context)
{:ok, {:var, var}, context}
{:error, reason} ->
{:error, reason}
end
end
end
@doc """
Adds a variable to the typing context and returns its type variables.
If the variable has already been added, return the existing type variable.
"""
def new_var(var, context) do
case Map.fetch(context.vars, var_name(var)) do
{:ok, type} ->
{type, context}
:error ->
type = {:var, context.counter}
vars = Map.put(context.vars, var_name(var), type)
types_to_vars = Map.put(context.types_to_vars, context.counter, var)
types = Map.put(context.types, context.counter, :unbound)
traces = Map.put(context.traces, context.counter, [])
context = %{
context
| vars: vars,
types_to_vars: types_to_vars,
types: types,
traces: traces,
counter: context.counter + 1
}
{type, context}
end
end
@doc """
Set the type for a variable and add trace.
"""
def refine_var(var, type, stack, context) do
types = Map.put(context.types, var, type)
context = %{context | types: types}
trace_var(var, type, stack, context)
end
@doc """
Remove type variable and all its traces.
"""
def remove_var(var, context) do
types = Map.delete(context.types, var)
traces = Map.delete(context.traces, var)
%{context | types: types, traces: traces}
end
defp trace_var(var, type, %{trace: true, expr_stack: expr_stack} = _stack, context) do
line = get_meta(hd(expr_stack))[:line]
trace = {type, expr_stack, {context.file, line}}
traces = Map.update!(context.traces, var, &[trace | &1])
%{context | traces: traces}
end
defp trace_var(_var, _type, %{trace: false} = _stack, context) do
context
end
# Check if a variable is recursive and incompatible with itself
# Bad: `{var} = var`
# Good: `x = y; y = z; z = x`
defp recursive_type?({:var, var} = parent, parents, context) do
case Map.fetch!(context.types, var) do
:unbound ->
false
type ->
if type in parents do
not Enum.all?(parents, &match?({:var, _}, &1))
else
recursive_type?(type, [parent | parents], context)
end
end
end
defp recursive_type?({:list, type} = parent, parents, context) do
recursive_type?(type, [parent | parents], context)
end
defp recursive_type?({:tuple, types} = parent, parents, context) do
Enum.any?(types, &recursive_type?(&1, [parent | parents], context))
end
defp recursive_type?({:map, pairs} = parent, parents, context) do
Enum.any?(pairs, fn {key, value} ->
recursive_type?(key, [parent | parents], context) or
recursive_type?(value, [parent | parents], context)
end)
end
defp recursive_type?(_other, _parents, _context) do
false
end
@doc """
Checks if the first argument is a subtype of the second argument.
Only checks for simple and concrete types.
"""
def subtype?({:atom, boolean}, :boolean, _context) when is_boolean(boolean), do: true
def subtype?({:atom, atom}, :atom, _context) when is_atom(atom), do: true
def subtype?(:boolean, :atom, _context), do: true
def subtype?(:float, :number, _context), do: true
def subtype?(:integer, :number, _context), do: true
def subtype?({:tuple, _}, :tuple, _context), do: true
# TODO: Lift unions to unify/3?
def subtype?({:union, left_types}, {:union, _} = right_union, context) do
Enum.all?(left_types, &subtype?(&1, right_union, context))
end
def subtype?(left, {:union, right_types}, context) do
Enum.any?(right_types, &subtype?(left, &1, context))
end
def subtype?(left, right, _context), do: left == right
@doc """
Returns a "simplified" union using `subtype?/3` to remove redundant types.
Due to limitations in `subtype?/3` some overlapping types may still be
included. For example unions with overlapping non-concrete types such as
`{boolean()} | {atom()}` will not be merged or types with variables that
are distinct but equivalent such as `a | b when a ~ b`.
"""
# TODO: Translate union of all top types to dynamic()
def to_union(types, context) when types != [] do
if :dynamic in types do
:dynamic
else
case unique_super_types(flatten_union(types), context) do
[type] -> type
types -> {:union, types}
end
end
end
defp flatten_union(types) do
Enum.flat_map(types, fn
{:union, types} -> flatten_union(types)
type -> [type]
end)
end
# Filter subtypes
# `boolean() | atom()` => `atom()`
# `:foo | atom()` => `atom()`
# Does not unify `true | false` => `boolean()`
defp unique_super_types([type | types], context) do
types = Enum.reject(types, &subtype?(&1, type, context))
if Enum.any?(types, &subtype?(type, &1, context)) do
unique_super_types(types, context)
else
[type | unique_super_types(types, context)]
end
end
defp unique_super_types([], _context) do
[]
end
# Collect relevant information from context and traces to report error
defp error({:unable_unify, left, right}, stack, context) do
{fun, arity} = context.function
line = get_meta(hd(stack.expr_stack))[:line]
location = {context.file, line, {context.module, fun, arity}}
traces = type_traces(context)
common_expr = common_super_expr(traces) || hd(stack.expr_stack)
traces = simplify_traces(traces, context)
{:error, {Module.Types, {:unable_unify, left, right, common_expr, traces}, [location]}}
end
defp type_traces(context) do
Enum.flat_map(context.traces, fn {var_index, traces} ->
expr_var = Map.fetch!(context.types_to_vars, var_index)
Enum.map(traces, &{expr_var, &1})
end)
end
# Only use last expr from trace and tag if trace is for
# a concrete type or type variable
defp simplify_traces(traces, context) do
Enum.flat_map(traces, fn {var, {type, [expr | _], location}} ->
case type do
{:var, var_index} ->
var2 = Map.fetch!(context.types_to_vars, var_index)
[{var, {:var, var2, expr, location}}]
_ ->
[{var, {:type, type, expr, location}}]
end
end)
end
# Find first common super expression among all traces
defp common_super_expr([]) do
nil
end
defp common_super_expr([{_var, {_type, expr_stack, _location}} | traces]) do
Enum.find_value(expr_stack, fn expr ->
common? =
Enum.all?(traces, fn {_var, {_type, expr_stack, _location}} -> expr in expr_stack end)
if common? do
expr
end
end)
end
defp get_meta({_fun, meta, _args}) when is_list(meta), do: meta
defp get_meta(_other), do: []
end
-585
View File
@@ -1,585 +0,0 @@
defmodule Module.Types.Pattern do
@moduledoc false
import Module.Types.{Helpers, Infer}
@doc """
Return the type and typing context of a pattern expression or an error
in case of a typing conflict.
"""
# :atom
def of_pattern(atom, _stack, context) when is_atom(atom) do
{:ok, {:atom, atom}, context}
end
# 12
def of_pattern(literal, _stack, context) when is_integer(literal) do
{:ok, :integer, context}
end
# 1.2
def of_pattern(literal, _stack, context) when is_float(literal) do
{:ok, :float, context}
end
# "..."
def of_pattern(literal, _stack, context) when is_binary(literal) do
{:ok, :binary, context}
end
# <<...>>>
def of_pattern({:<<>>, _meta, args} = expr, stack, context) do
stack = push_expr_stack(expr, stack)
case reduce_ok(args, context, &of_binary(&1, stack, &2)) do
{:ok, context} -> {:ok, :binary, context}
{:error, reason} -> {:error, reason}
end
end
# left | []
def of_pattern({:|, _meta, [left_expr, []]} = expr, stack, context) do
stack = push_expr_stack(expr, stack)
of_pattern(left_expr, stack, context)
end
# left | right
def of_pattern({:|, _meta, [left_expr, right_expr]} = expr, stack, context) do
stack = push_expr_stack(expr, stack)
case of_pattern(left_expr, stack, context) do
{:ok, left, context} ->
case of_pattern(right_expr, stack, context) do
{:ok, {:list, right}, context} ->
{:ok, to_union([left, right], context), context}
{:ok, right, context} ->
{:ok, to_union([left, right], context), context}
{:error, reason} ->
{:error, reason}
end
{:error, reason} ->
{:error, reason}
end
end
# []
def of_pattern([], _stack, context) do
{:ok, {:list, :dynamic}, context}
end
# [expr, ...]
def of_pattern(exprs, stack, context) when is_list(exprs) do
stack = push_expr_stack(exprs, stack)
case map_reduce_ok(exprs, context, &of_pattern(&1, stack, &2)) do
{:ok, types, context} -> {:ok, {:list, to_union(types, context)}, context}
{:error, reason} -> {:error, reason}
end
end
# left ++ right
def of_pattern(
{{:., _meta1, [:erlang, :++]}, _meta2, [left_expr, right_expr]} = expr,
stack,
context
) do
stack = push_expr_stack(expr, stack)
case of_pattern(left_expr, stack, context) do
{:ok, {:list, left}, context} ->
case of_pattern(right_expr, stack, context) do
{:ok, {:list, right}, context} ->
{:ok, {:list, to_union([left, right], context)}, context}
{:ok, right, context} ->
{:ok, {:list, to_union([left, right], context)}, context}
{:error, reason} ->
{:error, reason}
end
{:error, reason} ->
{:error, reason}
end
end
# _
def of_pattern({:_, _meta, atom}, _stack, context) when is_atom(atom) do
{:ok, :dynamic, context}
end
# var
def of_pattern(var, _stack, context) when is_var(var) do
{type, context} = new_var(var, context)
{:ok, type, context}
end
# {left, right}
def of_pattern({left, right}, stack, context) do
of_pattern({:{}, [], [left, right]}, stack, context)
end
# {...}
def of_pattern({:{}, _meta, exprs} = expr, stack, context) do
stack = push_expr_stack(expr, stack)
case map_reduce_ok(exprs, context, &of_pattern(&1, stack, &2)) do
{:ok, types, context} -> {:ok, {:tuple, types}, context}
{:error, reason} -> {:error, reason}
end
end
# left = right
def of_pattern({:=, _meta, [left_expr, right_expr]} = expr, stack, context) do
stack = push_expr_stack(expr, stack)
with {:ok, left_type, context} <- of_pattern(left_expr, stack, context),
{:ok, right_type, context} <- of_pattern(right_expr, stack, context),
do: unify(left_type, right_type, stack, context)
end
# %{...}
def of_pattern({:%{}, _meta, args} = expr, stack, context) do
stack = push_expr_stack(expr, stack)
case of_pairs(args, stack, context) do
{:ok, pairs, context} -> {:ok, {:map, pairs_to_unions(pairs, context)}, context}
{:error, reason} -> {:error, reason}
end
end
# %_{...}
def of_pattern(
{:%, _meta1, [{:_, _meta2, var_context}, {:%{}, _meta3, args}]} = expr,
stack,
context
)
when is_atom(var_context) do
stack = push_expr_stack(expr, stack)
case of_pairs(args, stack, context) do
{:ok, pairs, context} ->
pairs = [{{:atom, :__struct__}, :atom} | pairs]
{:ok, {:map, pairs}, context}
{:error, reason} ->
{:error, reason}
end
end
# %var{...}
def of_pattern({:%, _meta1, [var, {:%{}, _meta2, args}]} = expr, stack, context)
when is_var(var) do
stack = push_expr_stack(expr, stack)
with {:ok, pairs, context} <- of_pairs(args, stack, context),
{var_type, context} = new_var(var, context),
{:ok, _, context} <- unify(var_type, :atom, stack, context) do
pairs = [{{:atom, :__struct__}, var_type} | pairs]
{:ok, {:map, pairs}, context}
end
end
# %Struct{...}
def of_pattern({:%, _meta1, [module, {:%{}, _meta2, args}]} = expr, stack, context)
when is_atom(module) do
stack = push_expr_stack(expr, stack)
case of_pairs(args, stack, context) do
{:ok, pairs, context} ->
pairs = [{{:atom, :__struct__}, {:atom, module}} | pairs]
{:ok, {:map, pairs}, context}
{:error, reason} ->
{:error, reason}
end
end
defp of_pairs(pairs, stack, context) do
map_reduce_ok(pairs, context, fn {key, value}, context ->
with {:ok, key_type, context} <- of_pattern(key, stack, context),
{:ok, value_type, context} <- of_pattern(value, stack, context),
do: {:ok, {key_type, value_type}, context}
end)
end
defp pairs_to_unions(pairs, context) do
# Maps only allow simple literal keys in patterns so
# we do not have to do subtype checking
Enum.reduce(pairs, [], fn {key, value}, pairs ->
case :lists.keyfind(key, 1, pairs) do
{^key, {:union, union}} ->
:lists.keystore(key, 1, pairs, {key, to_union([value | union], context)})
{^key, original_value} ->
:lists.keystore(key, 1, pairs, {key, to_union([value, original_value], context)})
false ->
[{key, value} | pairs]
end
end)
end
## GUARDS
# TODO: Some guards can be changed to intersection types or higher order types
@guard_functions %{
{:is_atom, 1} => {[:atom], :boolean},
{:is_binary, 1} => {[:binary], :boolean},
{:is_bitstring, 1} => {[:binary], :boolean},
{:is_boolean, 1} => {[:boolean], :boolean},
{:is_float, 1} => {[:float], :boolean},
{:is_function, 1} => {[:fun], :boolean},
{:is_function, 2} => {[:fun, :integer], :boolean},
{:is_integer, 1} => {[:integer], :boolean},
{:is_list, 1} => {[{:list, :dynamic}], :boolean},
{:is_map, 1} => {[{:map, []}], :boolean},
{:is_map_key, 2} => {[:dynamic, {:map, []}], :dynamic},
{:is_number, 1} => {[:number], :boolean},
{:is_pid, 1} => {[:pid], :boolean},
{:is_port, 1} => {[:port], :boolean},
{:is_reference, 1} => {[:reference], :boolean},
{:is_tuple, 1} => {[:tuple], :boolean},
{:<, 2} => {[:dynamic, :dynamic], :boolean},
{:"=<", 2} => {[:dynamic, :dynamic], :boolean},
{:>, 2} => {[:dynamic, :dynamic], :boolean},
{:>=, 2} => {[:dynamic, :dynamic], :boolean},
{:"/=", 2} => {[:dynamic, :dynamic], :boolean},
{:"=/=", 2} => {[:dynamic, :dynamic], :boolean},
{:==, 2} => {[:dynamic, :dynamic], :boolean},
{:"=:=", 2} => {[:dynamic, :dynamic], :boolean},
{:*, 2} => {[:number, :number], :number},
{:+, 1} => {[:number], :number},
{:+, 2} => {[:number, :number], :number},
{:-, 1} => {[:number], :number},
{:-, 2} => {[:number, :number], :number},
{:/, 2} => {[:number, :number], :number},
{:abs, 1} => {[:number], :number},
{:ceil, 1} => {[:number], :integer},
{:floor, 1} => {[:number], :integer},
{:round, 1} => {[:number], :integer},
{:trunc, 1} => {[:number], :integer},
{:element, 2} => {[:integer, :tuple], :dynamic},
{:hd, 1} => {[{:list, :dynamic}], :dynamic},
{:length, 1} => {[{:list, :dynamic}], :integer},
{:map_get, 2} => {[:dynamic, {:map, []}], :dynamic},
{:map_size, 1} => {[{:map, []}], :integer},
{:tl, 1} => {[{:list, :dynamic}], :dynamic},
{:tuple_size, 1} => {[:tuple], :integer},
{:node, 1} => {[{:union, [:pid, :reference, :port]}], :atom},
{:binary_part, 3} => {[:binary, :integer, :integer], :binary},
{:bit_size, 1} => {[:binary], :integer},
{:byte_size, 1} => {[:binary], :integer},
{:size, 1} => {[{:union, [:binary, :tuple]}], :boolean},
{:div, 2} => {[:integer, :integer], :integer},
{:rem, 2} => {[:integer, :integer], :integer},
{:node, 0} => {[], :atom},
{:self, 0} => {[], :pid},
{:bnot, 1} => {[:integer], :integer},
{:band, 2} => {[:integer, :integer], :integer},
{:bor, 2} => {[:integer, :integer], :integer},
{:bxor, 2} => {[:integer, :integer], :integer},
{:bsl, 2} => {[:integer, :integer], :integer},
{:bsr, 2} => {[:integer, :integer], :integer},
{:xor, 2} => {[:boolean, :boolean], :boolean},
{:not, 1} => {[:boolean], :boolean}
# Following guards are matched explicitly to handle
# type guard functions such as is_atom/1
# {:andalso, 2} => {[:boolean, :boolean], :boolean}
# {:orelse, 2} => {[:boolean, :boolean], :boolean}
}
@type_guards [
:is_atom,
:is_binary,
:is_bitstring,
:is_boolean,
:is_float,
:is_function,
:is_function,
:is_integer,
:is_list,
:is_map,
:is_number,
:is_pid,
:is_port,
:is_reference,
:is_tuple
]
@doc """
Refines the type variables in the typing context using type check guards
such as `is_integer/1`.
"""
def of_guard({{:., _, [:erlang, :andalso]}, _, [left, right]} = expr, stack, context) do
stack = push_expr_stack(expr, stack)
fresh_context = fresh_context(context)
with {:ok, left_type, left_context} <- of_guard(left, stack, fresh_context),
{:ok, right_type, right_context} <- of_guard(right, stack, fresh_context),
{:ok, context} <- merge_context_and(context, stack, left_context, right_context),
{:ok, _, context} <- unify(left_type, :boolean, stack, context),
{:ok, _, context} <- unify(right_type, :boolean, stack, context),
do: {:ok, :boolean, context}
end
def of_guard({{:., _, [:erlang, :orelse]}, _, [left, right]} = expr, stack, context) do
stack = push_expr_stack(expr, stack)
fresh_context = fresh_context(context)
with {:ok, left_type, left_context} <- of_guard(left, stack, fresh_context),
{:ok, _right_type, right_context} <- of_guard(right, stack, fresh_context),
{:ok, context} <- merge_context_or(context, stack, left_context, right_context),
{:ok, _, context} <- unify(left_type, :boolean, stack, context),
do: {:ok, :boolean, context}
end
def of_guard({{:., _, [:erlang, guard]}, _, args} = expr, stack, context) do
stack = push_expr_stack(expr, stack)
{param_types, return_type} = guard_signature(guard, length(args))
type_guard? = type_guard?(guard)
# Only check type guards in the context of and/or/not,
# a type guard in the context of is_tuple(x) > :foo
# should not affect the inference of x
if not type_guard? or stack.type_guards_enabled? do
arg_stack = %{stack | type_guards_enabled?: type_guard?}
with {:ok, arg_types, context} <-
map_reduce_ok(args, context, &of_guard(&1, arg_stack, &2)),
{:ok, context} <- unify_call(param_types, arg_types, stack, context) do
{arg_types, guard_sources} =
case arg_types do
[{:var, index} | rest_arg_types] when type_guard? ->
guard_sources =
Map.update(context.guard_sources, index, [:guarded], &[:guarded | &1])
{rest_arg_types, guard_sources}
_ ->
{arg_types, context.guard_sources}
end
guard_sources =
Enum.reduce(arg_types, guard_sources, fn
{:var, index}, guard_sources ->
Map.update(guard_sources, index, [:fail], &[:fail | &1])
_, guard_sources ->
guard_sources
end)
{:ok, return_type, %{context | guard_sources: guard_sources}}
end
else
{:ok, return_type, context}
end
end
def of_guard(var, _stack, context) when is_var(var) do
type = Map.fetch!(context.vars, var_name(var))
{:ok, type, context}
end
def of_guard(expr, stack, context) do
# Fall back to of_pattern/3 for literals
of_pattern(expr, stack, context)
end
defp fresh_context(context) do
types = Map.new(context.types, fn {var, _} -> {var, :unbound} end)
traces = Map.new(context.traces, fn {var, _} -> {var, []} end)
%{context | types: types, traces: traces}
end
defp unify_call(params, args, stack, context) do
reduce_ok(Enum.zip(params, args), context, fn {param, arg}, context ->
case unify(param, arg, stack, context) do
{:ok, _, context} -> {:ok, context}
{:error, reason} -> {:error, reason}
end
end)
end
defp merge_context_and(context, stack, left, right) do
with {:ok, context} <- unify_new_types(context, stack, left),
{:ok, context} <- unify_new_types(context, stack, right) do
guard_sources = and_guard_sources(left.guard_sources, right.guard_sources)
guard_sources = merge_guard_sources([context.guard_sources, guard_sources])
{:ok, %{context | guard_sources: guard_sources}}
end
end
defp unify_new_types(context, stack, new_context) do
context = merge_traces(context, new_context)
reduce_ok(Map.to_list(new_context.types), context, fn
{_index, :unbound}, context ->
{:ok, context}
{index, new_type}, context ->
case unify({:var, index}, new_type, %{stack | trace: false}, context) do
{:ok, _, context} ->
{:ok, context}
{:error, reason} ->
{:error, reason}
end
end)
end
defp merge_guard_sources(sources) do
Enum.reduce(sources, fn left, right ->
Map.merge(left, right, fn _index, left, right -> join_guard_source(left, right) end)
end)
end
defp join_guard_source(left, right) do
sources = left ++ right
cond do
:fail in sources -> [:fail]
:guarded_fail in sources -> [:guarded_fail]
:guarded in sources -> [:guarded]
true -> []
end
end
defp and_guard_sources(left, right) do
Map.merge(left, right, fn _index, left, right ->
# When the failing guard function wont fail due to type check function before it,
# for example: is_list(x) and length(x)
if :guarded in left and :fail in right do
[:guarded_fail]
else
join_guard_source(left, right)
end
end)
end
defp merge_traces(context, new_context) do
traces =
:maps.fold(
fn index, new_traces, traces ->
:maps.update_with(index, &(new_traces ++ &1), new_traces, traces)
end,
context.traces,
new_context.traces
)
%{context | traces: traces}
end
defp merge_context_or(context, stack, left, right) do
context =
case {Map.to_list(left.types), Map.to_list(right.types)} do
{[{index, :unbound}], [{index, type}]} ->
refine_var(index, type, stack, context)
{[{index, type}], [{index, :unbound}]} ->
refine_var(index, type, stack, context)
{[{index, left_type}], [{index, right_type}]} ->
# Only include right side if left side is from type guard such as is_list(x),
# do not refine in case of length(x)
left_guard_sources = Map.get(left.guard_sources, index, [])
if :fail in left_guard_sources do
guard_sources = Map.put(context.guard_sources, index, [:fail])
context = %{context | guard_sources: guard_sources}
refine_var(index, left_type, stack, context)
else
guard_sources =
merge_guard_sources([
context.guard_sources,
left.guard_sources,
right.guard_sources
])
context = %{context | guard_sources: guard_sources}
refine_var(index, to_union([left_type, right_type], context), stack, context)
end
{left_types, _right_types} ->
Enum.reduce(left_types, context, fn {index, left_type}, context ->
left_guard_sources = Map.get(left.guard_sources, index, [])
if :fail in left_guard_sources do
guard_sources =
merge_guard_sources([
context.guard_sources,
left.guard_sources,
right.guard_sources
])
context = %{context | guard_sources: guard_sources}
refine_var(index, left_type, stack, context)
else
context
end
end)
end
{:ok, context}
end
# binary-pattern :: specifier
defp of_binary({:"::", _meta, [expr, specifiers]} = full_expr, stack, context) do
{expected_type, utf?} = collect_binary_type(specifiers) || {:integer, false}
stack = push_expr_stack(full_expr, stack)
# Special case utf specifiers with binary literals since they allow
# both integer and binary literals but variables are always integer
if is_binary(expr) and utf? do
{:ok, context}
else
with {:ok, type, context} <- of_pattern(expr, stack, context),
{:ok, _type, context} <- unify(type, expected_type, stack, context),
do: {:ok, context}
end
end
# binary-pattern
defp of_binary(expr, stack, context) do
case of_pattern(expr, stack, context) do
{:ok, type, context} when type in [:integer, :float, :binary] ->
{:ok, context}
{:ok, type, _context} ->
{:error, {:invalid_binary_type, type}}
{:error, reason} ->
{:error, reason}
end
end
# Collect binary type specifiers,
# from `<<pattern::integer-size(10)>>` collect `integer`
defp collect_binary_type({:-, _meta, [left, right]}),
do: collect_binary_type(left) || collect_binary_type(right)
defp collect_binary_type({:integer, _, _}), do: {:integer, false}
defp collect_binary_type({:float, _, _}), do: {:float, false}
defp collect_binary_type({:bits, _, _}), do: {:binary, false}
defp collect_binary_type({:bitstring, _, _}), do: {:binary, false}
defp collect_binary_type({:bytes, _, _}), do: {:binary, false}
defp collect_binary_type({:binary, _, _}), do: {:binary, false}
defp collect_binary_type({:utf8, _, _}), do: {:integer, true}
defp collect_binary_type({:utf16, _, _}), do: {:integer, true}
defp collect_binary_type({:utf32, _, _}), do: {:integer, true}
defp collect_binary_type(_), do: nil
defp guard_signature(name, arity) do
Map.fetch!(@guard_functions, {name, arity})
end
defp type_guard?(name) do
name in @type_guards
end
end
+2 -17
View File
@@ -13,23 +13,8 @@ defmodule Node do
@doc """
Turns a non-distributed node into a distributed node.
This functionality starts the `:net_kernel` and other related
processes.
This function is rarely invoked in practice. Instead, nodes are
named and started via the command line by using the `--sname` and
`--name` flags. If you need to use this function to dynamically
name a node, please make sure the `epmd` operating system process
is running by calling `epmd -daemon`.
Invoking this function when the distribution has already been started,
either via the command line interface or dynamically, will return an
error.
## Examples
{:ok, pid} = Node.start(:example, :shortnames, 15000)
This functionality starts the `:net_kernel` and other
related processes.
"""
@spec start(node, :longnames | :shortnames, non_neg_integer) :: {:ok, pid} | {:error, term}
def start(name, type \\ :longnames, tick_time \\ 15000) do
+4 -5
View File
@@ -20,7 +20,7 @@ defmodule Path do
## Examples
### Unix-like operating systems
### Unix
Path.absname("foo")
#=> "/usr/local/foo"
@@ -195,7 +195,7 @@ defmodule Path do
## Examples
### Unix-like operating systems
### Unix
Path.type("/") #=> :absolute
Path.type("/usr/local/bin") #=> :absolute
@@ -223,7 +223,7 @@ defmodule Path do
## Examples
### Unix-like operating systems
### Unix
Path.relative("/usr/local/bin") #=> "usr/local/bin"
Path.relative("usr/local/bin") #=> "usr/local/bin"
@@ -522,7 +522,6 @@ defmodule Path do
do_join(left, right, os_type) |> remove_dir_sep(os_type)
end
defp do_join(left, "/", os_type), do: remove_dir_sep(left, os_type)
defp do_join("", right, os_type), do: relative(right, os_type)
defp do_join("/", right, os_type), do: "/" <> relative(right, os_type)
@@ -565,7 +564,7 @@ defmodule Path do
"""
@spec split(t) :: [binary]
# Work around a bug in Erlang on Unix-like operating systems
# Work around a bug in Erlang on UNIX
def split(""), do: []
def split(path) do
+14 -36
View File
@@ -20,7 +20,7 @@ defmodule Port do
:ok
In the example above, we have created a new port that executes the
program `cat`. `cat` is a program available on Unix-like operating systems that
program `cat`. `cat` is a program available on UNIX systems that
receives data from multiple inputs and concatenates them in the output.
After the port was created, we sent it two commands in the form of
@@ -124,42 +124,20 @@ defmodule Port do
will have its stdin and stdout channels closed but **it won't be automatically
terminated**.
While most Unix command line tools will exit once its communication channels
are closed, not all command line applications will do so. You can easily check
this by starting the port and then shutting down the VM and inspecting your
operating system to see if the port process is still running.
While most UNIX command line tools will exit once its communication channels
are closed, not all command line applications will do so. While we encourage
graceful termination by detecting if stdin/stdout has been closed, we do not
always have control over how third-party software terminates. In those cases,
you can wrap the application in a script that checks for stdin. Here is such
script in Bash:
While we encourage graceful termination by detecting if stdin/stdout has been
closed, we do not always have control over how third-party software terminates.
In those cases, you can wrap the application in a script that checks for stdin.
Here is such script that has been verified to work on bash shells:
#!/usr/bin/env bash
# Start the program in the background
exec "$@" &
pid1=$!
# Silence warnings from here on
exec >/dev/null 2>&1
# Read from stdin in the background and
# kill running program when stdin closes
exec 0<&0 $(
while read; do :; done
kill -KILL $pid1
) &
pid2=$!
# Clean up
wait $pid1
ret=$?
kill -KILL $pid2
exit $ret
Note the program above hijacks stdin, so you won't be able to communicate
with the underlying software via stdin (on the positive side, software that
reads from stdin typically terminates when stdin closes).
#!/bin/bash
"$@" &
pid=$!
while read line ; do
:
done
kill -KILL $pid
Now instead of:
+4 -2
View File
@@ -583,7 +583,7 @@ defmodule Process do
send(:test, :hello)
#=> :hello
send(:wrong_name, :hello)
** (ArgumentError) argument error
#=> ** (ArgumentError) argument error
"""
@spec register(pid | port, atom) :: true
@@ -620,7 +620,7 @@ defmodule Process do
Process.unregister(:test)
#=> true
Process.unregister(:wrong_name)
** (ArgumentError) argument error
#=> ** (ArgumentError) argument error
"""
@spec unregister(atom) :: true
@@ -708,6 +708,8 @@ defmodule Process do
@spec flag(:message_queue_data, :erlang.message_queue_data()) :: :erlang.message_queue_data()
@spec flag(:min_bin_vheap_size, non_neg_integer) :: non_neg_integer
@spec flag(:min_heap_size, non_neg_integer) :: non_neg_integer
@spec flag(:monitor_nodes, term) :: term
@spec flag({:monitor_nodes, term()}, term) :: term
@spec flag(:priority, priority_level) :: priority_level
@spec flag(:save_calls, 0..10000) :: 0..10000
@spec flag(:sensitive, boolean) :: boolean
+15 -32
View File
@@ -163,15 +163,15 @@ defmodule Protocol do
* `:consolidated?` - returns whether the protocol is consolidated
* `:functions` - returns a keyword list of protocol functions and their arities
* `:functions` - returns keyword list of protocol functions and their arities
* `:impls` - if consolidated, returns `{:consolidated, modules}` with the list of modules
implementing the protocol, otherwise `:not_consolidated`
implementing the protocol, otherwise `:not_consolidated`
* `:module` - the protocol module atom name
* `impl_for/1` - returns the module that implements the protocol for the given argument,
`nil` otherwise
* `impl_for/1` - receives a structure and returns the module that
implements the protocol for the structure, `nil` otherwise
* `impl_for!/1` - same as above but raises an error if an implementation is
not found
@@ -187,22 +187,6 @@ defmodule Protocol do
iex> Enumerable.impl_for(42)
nil
In addition, every protocol implementation module contains the `__impl__/1` function. The
function takes one of the following atoms:
* `:for` - returns the module responsible for the data structure of the protocol implementation
* `:protocol` - returns the protocol module for which this implementation is provided
For example, the module implementing the `Enumerable` protocol for lists is `Enumerable.List`.
Therefore, we can invoke `__impl__/1` on this module:
iex(1)> Enumerable.List.__impl__(:for)
List
iex(2)> Enumerable.List.__impl__(:protocol)
Enumerable
## Consolidation
In order to cope with code loading in development, protocols in
@@ -211,7 +195,7 @@ defmodule Protocol do
In order to speed up dispatching in production environments, where
all implementations are known up-front, Elixir provides a feature
called *protocol consolidation*. Consolidation directly links protocols
called protocol consolidation. Consolidation directly links protocols
to their implementations in a way that invoking a function from a
consolidated protocol is equivalent to invoking two remote functions.
@@ -246,10 +230,9 @@ defmodule Protocol do
Although doing so is not recommended as it may affect your test suite
performance.
Finally, note all protocols are compiled with `debug_info` set to `true`,
regardless of the option set by the `elixirc` compiler. The debug info is
used for consolidation and it is removed after consolidation unless
globally set.
Finally note all protocols are compiled with `debug_info` set to `true`,
regardless of the option set by `elixirc` compiler. The debug info is
used for consolidation and it may be removed after consolidation.
"""
@doc false
@@ -475,7 +458,6 @@ defmodule Protocol do
defp extract_matching_by_attribute(paths, prefix, callback) do
for path <- paths,
path = to_charlist(path),
file <- list_dir(path),
mod = extract_from_file(path, file, prefix, callback),
do: mod
@@ -488,6 +470,8 @@ defmodule Protocol do
end
end
defp list_dir(path), do: list_dir(to_charlist(path))
defp extract_from_file(path, file, prefix, callback) do
if :lists.prefix(prefix, file) and :filename.extension(file) == '.beam' do
extract_from_beam(:filename.join(path, file), callback)
@@ -547,14 +531,13 @@ defmodule Protocol do
end
defp beam_protocol(protocol) do
chunk_ids = [:debug_info, 'Docs', 'ExCk']
chunk_ids = [:debug_info, 'Docs', 'ExDp']
opts = [:allow_missing_chunks]
case :beam_lib.chunks(beam_file(protocol), chunk_ids, opts) do
{:ok, {^protocol, [{:debug_info, debug_info} | chunks]}} ->
{:debug_info_v1, _backend, {:elixir_v1, info, specs}} = debug_info
%{attributes: attributes, definitions: definitions} = info
chunks = :lists.filter(fn {_name, value} -> value != :missing_chunk end, chunks)
chunks = :lists.map(fn {name, value} -> {List.to_string(name), value} end, chunks)
case attributes[:protocol] do
@@ -636,14 +619,14 @@ defmodule Protocol do
end
defp built_in_clause_for(mod, guard, protocol, meta, line) do
x = {:x, [line: line, version: -1], __MODULE__}
x = quote(line: line, do: x)
guard = quote(line: line, do: :erlang.unquote(guard)(unquote(x)))
body = load_impl(protocol, mod)
{meta, [x], [guard], body}
end
defp struct_clause_for(meta, line) do
x = {:x, [line: line, version: -1], __MODULE__}
x = quote(line: line, do: x)
head = quote(line: line, do: %{__struct__: unquote(x)})
guard = quote(line: line, do: :erlang.is_atom(unquote(x)))
body = quote(line: line, do: struct_impl_for(unquote(x)))
@@ -715,7 +698,7 @@ defmodule Protocol do
nil
end
# Disable Dialyzer checks - before and after consolidation
# Disable dialyzer checks - before and after consolidation
# the types could be more strict
@dialyzer {:nowarn_function, __protocol__: 1, impl_for: 1, impl_for!: 1}
@@ -917,7 +900,7 @@ defmodule Protocol do
"the #{inspect(protocol)} protocol has already been consolidated, an " <>
"implementation for #{inspect(for)} has no effect. If you want to " <>
"implement protocols after compilation or during tests, check the " <>
"\"Consolidation\" section in the Protocol module documentation"
"\"Consolidation\" section in the documentation for Kernel.defprotocol/2"
IO.warn(message, Macro.Env.stacktrace(env))
end
+4 -8
View File
@@ -1,7 +1,9 @@
defmodule Range do
@moduledoc """
Ranges represent a sequence of one or many, ascending
or descending, consecutive integers.
Defines a range.
A range represents a sequence of one or many,
ascending or descending, consecutive integers.
Ranges can be either increasing (`first <= last`) or
decreasing (`first > last`). Ranges are also always
@@ -47,12 +49,6 @@ defmodule Range do
@doc """
Creates a new range.
## Examples
iex> Range.new(-100, 100)
-100..100
"""
@spec new(integer, integer) :: t
def new(first, last) when is_integer(first) and is_integer(last) do
+30 -43
View File
@@ -149,11 +149,12 @@ defmodule Record do
## Examples
Record.is_record({User, "john", 27})
#=> true
Record.is_record({})
#=> false
iex> record = {User, "john", 27}
iex> Record.is_record(record)
true
iex> tuple = {}
iex> Record.is_record(tuple)
false
"""
defguard is_record(data)
@@ -240,8 +241,8 @@ defmodule Record do
functions for defaults.
Record.defrecord(:my_rec, Record.extract(...))
** (ArgumentError) invalid value for record field fun_field,
cannot escape #Function<12.90072148/2 in :erl_eval.expr/5>.
#=> ** (ArgumentError) invalid value for record field fun_field,
#=> cannot escape #Function<12.90072148/2 in :erl_eval.expr/5>.
To work around this error, redefine the field with your own &M.f/a function,
like so:
@@ -255,11 +256,20 @@ defmodule Record do
"""
defmacro defrecord(name, tag \\ nil, kv) do
quote bind_quoted: [name: name, tag: tag, kv: kv] do
fields = Record.__fields__(:defrecord, kv)
Record.__validate__(__MODULE__, name, fields)
defined_arity =
Enum.find(0..2, fn arity ->
Module.defines?(__MODULE__, {name, arity})
end)
if defined_arity do
raise ArgumentError,
"cannot define record #{inspect(name)} because a definition #{name}/#{defined_arity} already exists"
end
tag = tag || name
fields = Record.__fields__(:defrecord, kv)
defmacro unquote(name)(args \\ []) do
Record.__access__(unquote(tag), unquote(fields), args, __CALLER__)
end
@@ -275,11 +285,20 @@ defmodule Record do
"""
defmacro defrecordp(name, tag \\ nil, kv) do
quote bind_quoted: [name: name, tag: tag, kv: kv] do
fields = Record.__fields__(:defrecordp, kv)
Record.__validate__(__MODULE__, name, fields)
defined_arity =
Enum.find(0..2, fn arity ->
Module.defines?(__MODULE__, {name, arity})
end)
if defined_arity do
raise ArgumentError,
"cannot define record #{inspect(name)} because a definition #{name}/#{defined_arity} already exists"
end
tag = tag || name
fields = Record.__fields__(:defrecordp, kv)
defmacrop unquote(name)(args \\ []) do
Record.__access__(unquote(tag), unquote(fields), args, __CALLER__)
end
@@ -290,38 +309,6 @@ defmodule Record do
end
end
@doc false
def __validate__(module, name, fields) do
error_on_duplicate_record(module, name)
# TODO: Make it raise on v2.0
warn_on_duplicate_key(:lists.keysort(1, fields))
end
defp error_on_duplicate_record(module, name) do
defined_arity =
Enum.find(0..2, fn arity ->
Module.defines?(module, {name, arity})
end)
if defined_arity do
raise ArgumentError,
"cannot define record #{inspect(name)} because a definition #{name}/#{defined_arity} already exists"
end
end
defp warn_on_duplicate_key([]) do
:ok
end
defp warn_on_duplicate_key([{key, _} | [{key, _} | _] = rest]) do
IO.warn("duplicate key #{inspect(key)} found in record")
warn_on_duplicate_key(rest)
end
defp warn_on_duplicate_key([_ | rest]) do
warn_on_duplicate_key(rest)
end
# Normalizes of record fields to have default values.
@doc false
def __fields__(type, fields) do
+8 -10
View File
@@ -86,8 +86,7 @@ defmodule Regex do
* `:none` - does not return matching subpatterns at all
* `:all_names` - captures all named subpattern matches in the Regex as a list
ordered **alphabetically** by the names of the subpatterns
* `:all_names` - captures all names in the Regex
* `list(binary)` - a list of named captures to capture
@@ -134,10 +133,10 @@ defmodule Regex do
shared during development is compiled on the target (such as dependencies,
archives, and escripts) and, when running in production, the code must either
be compiled on the target (via `mix compile` or similar) or released on the
host (via `mix releases` or similar) with a matching OTP, operating system
and architecture as the target.
host (via `mix releases` or similar) with a matching OTP, OS and architecture
as as the target.
If you know you are running on a different system than the current one and
If you know you are running on a different system that the current one and
you are doing multiple matches with the regex, you can manually invoke
`Regex.recompile/1` or `Regex.recompile!/1` to perform a runtime version
check and recompile the regex if necessary.
@@ -294,7 +293,7 @@ defmodule Regex do
## Options
* `:return` - when set to `:index`, returns byte index and match length.
* `:return` - set to `:index` to return byte index and match length.
Defaults to `:binary`.
* `:capture` - what to capture in the result. Check the moduledoc for `Regex`
to see the possible capture values.
@@ -330,7 +329,7 @@ defmodule Regex do
## Options
* `:return` - when set to `:index`, returns byte index and match length.
* `:return` - set to `:index` to return byte index and match length.
Defaults to `:binary`.
## Examples
@@ -423,7 +422,7 @@ defmodule Regex do
## Options
* `:return` - when set to `:index`, returns byte index and match length.
* `:return` - set to `:index` to return byte index and match length.
Defaults to `:binary`.
* `:capture` - what to capture in the result. Check the moduledoc for `Regex`
to see the possible capture values.
@@ -491,8 +490,7 @@ defmodule Regex do
affect the splitting process.
* `:include_captures` - when `true`, includes in the result the matches of
the regular expression. The matches are not counted towards the maximum
number of parts if combined with the `:parts` option. Defaults to `false`.
the regular expression. Defaults to `false`.
## Examples
+29 -38
View File
@@ -198,25 +198,17 @@ defmodule Registry do
@type match_pattern :: atom | term
@typedoc "A guard to be evaluated when matching on objects in a registry"
@type guard :: atom | tuple
@type guard :: {atom | term}
@typedoc "A list of guards to be evaluated when matching on objects in a registry"
@type guards :: [guard]
@type guards :: [guard] | []
@typedoc "A pattern used to representing the output format part of a match spec"
@type body :: [term]
@type body :: [atom | tuple]
@typedoc "A full match spec used when selecting objects in the registry"
@type spec :: [{match_pattern, guards, body}]
@typedoc "Options used for `child_spec/1` and `start_link/1`"
@type start_option ::
{:keys, keys}
| {:name, registry}
| {:partitions, pos_integer}
| {:listeners, [atom]}
| {:meta, [{meta_key, meta_value}]}
## Via callbacks
@doc false
@@ -300,7 +292,7 @@ defmodule Registry do
The registry requires the following keys:
* `:keys` - chooses if keys are `:unique` or `:duplicate`
* `:keys` - choose if keys are `:unique` or `:duplicate`
* `:name` - the name of the registry and its tables
The following keys are optional:
@@ -314,7 +306,14 @@ defmodule Registry do
"""
@doc since: "1.5.0"
@spec start_link([start_option]) :: {:ok, pid} | {:error, term}
@spec start_link(
keys: keys,
name: registry,
partitions: pos_integer,
listeners: [atom],
meta: meta
) :: {:ok, pid} | {:error, term}
when meta: [{meta_key, meta_value}]
def start_link(options) do
keys = Keyword.get(options, :keys)
@@ -376,11 +375,10 @@ defmodule Registry do
See `Supervisor`.
"""
@doc since: "1.5.0"
@spec child_spec([start_option]) :: Supervisor.child_spec()
def child_spec(options) do
def child_spec(opts) do
%{
id: Keyword.get(options, :name, Registry),
start: {Registry, :start_link, [options]},
id: Keyword.get(opts, :name, Registry),
start: {Registry, :start_link, [opts]},
type: :supervisor
}
end
@@ -600,8 +598,7 @@ defmodule Registry do
Optionally, it is possible to pass a list of guard conditions for more precise matching.
Each guard is a tuple, which describes checks that should be passed by assigned part of pattern.
For example the `$1 > 1` guard condition would be expressed as the `{:>, :"$1", 1}` tuple.
Please note that guard conditions will work only for assigned
variables like `:"$1"`, `:"$2"`, and so forth.
Please note that guard conditions will work only for assigned variables like `:"$1"`, `:"$2"`, etc.
Avoid usage of special match variables `:"$_"` and `:"$$"`, because it might not work as expected.
An empty list will be returned if there is no match.
@@ -930,13 +927,13 @@ defmodule Registry do
counter = System.unique_integer()
true = :ets.insert(pid_ets, {self, key, key_ets, counter})
case register_key(kind, key_ets, key, {key, {self, value}}) do
:ok ->
case register_key(kind, pid_server, key_ets, key, {key, {self, value}}) do
{:ok, _} = ok ->
for listener <- listeners do
Kernel.send(listener, {:register, registry, key, self, value})
end
{:ok, pid_server}
ok
{:error, {:already_registered, ^self}} = error ->
true = :ets.delete_object(pid_ets, {self, key, key_ets, counter})
@@ -949,14 +946,14 @@ defmodule Registry do
end
end
defp register_key(:duplicate, key_ets, _key, entry) do
defp register_key(:duplicate, pid_server, key_ets, _key, entry) do
true = :ets.insert(key_ets, entry)
:ok
{:ok, pid_server}
end
defp register_key(:unique, key_ets, key, entry) do
defp register_key(:unique, pid_server, key_ets, key, entry) do
if :ets.insert_new(key_ets, entry) do
:ok
{:ok, pid_server}
else
# Notice we have to call register_key recursively
# because we are always at odds of a race condition.
@@ -966,11 +963,11 @@ defmodule Registry do
{:error, {:already_registered, pid}}
else
:ets.delete_object(key_ets, current)
register_key(:unique, key_ets, key, entry)
register_key(:unique, pid_server, key_ets, key, entry)
end
[] ->
register_key(:unique, key_ets, key, entry)
register_key(:unique, pid_server, key_ets, key, entry)
end
end
end
@@ -1094,8 +1091,7 @@ defmodule Registry do
Optionally, it is possible to pass a list of guard conditions for more precise matching.
Each guard is a tuple, which describes checks that should be passed by assigned part of pattern.
For example the `$1 > 1` guard condition would be expressed as the `{:>, :"$1", 1}` tuple.
Please note that guard conditions will work only for assigned
variables like `:"$1"`, `:"$2"`, and so forth.
Please note that guard conditions will work only for assigned variables like `:"$1"`, `:"$2"`, etc.
Avoid usage of special match variables `:"$_"` and `:"$$"`, because it might not work as expected.
Zero will be returned if there is no match.
@@ -1162,8 +1158,7 @@ defmodule Registry do
The second part, the guards, is a list of conditions that allow filtering the results.
Each guard is a tuple, which describes checks that should be passed by assigned part of pattern.
For example the `$1 > 1` guard condition would be expressed as the `{:>, :"$1", 1}` tuple.
Please note that guard conditions will work only for assigned
variables like `:"$1"`, `:"$2"`, and so forth.
Please note that guard conditions will work only for assigned variables like `:"$1"`, `:"$2"`, etc.
The third part, the body, is a list of shapes of the returned entries. Like guards, you have access to
assigned variables like `:"$1"`, which you can combine with hardcoded values to freely shape entries
@@ -1325,14 +1320,10 @@ defmodule Registry.Supervisor do
key_partition = Registry.Partition.key_name(registry, i)
pid_partition = Registry.Partition.pid_name(registry, i)
arg = {kind, registry, i, partitions, key_partition, pid_partition, listeners}
%{
id: pid_partition,
start: {Registry.Partition, :start_link, [pid_partition, arg]}
}
worker(Registry.Partition, [pid_partition, arg], id: pid_partition)
end
Supervisor.init(children, strategy: strategy_for_kind(kind))
supervise(children, strategy: strategy_for_kind(kind))
end
# Unique registries have their key partition hashed by key.
+46 -72
View File
@@ -107,7 +107,6 @@ defmodule Stream do
@type index :: non_neg_integer
@type default :: any
@type timer :: non_neg_integer | :infinity
# Require Stream.Reducers and its callbacks
require Stream.Reducers, as: R
@@ -506,10 +505,8 @@ defmodule Stream do
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
"""
@spec interval(timer()) :: Enumerable.t()
def interval(n)
when is_integer(n) and n >= 0
when n == :infinity do
@spec interval(non_neg_integer) :: Enumerable.t()
def interval(n) when is_integer(n) and n >= 0 do
unfold(0, fn count ->
Process.sleep(n)
{count, count + 1}
@@ -790,10 +787,8 @@ defmodule Stream do
[0]
"""
@spec timer(timer()) :: Enumerable.t()
def timer(n)
when is_integer(n) and n >= 0
when n == :infinity do
@spec timer(non_neg_integer) :: Enumerable.t()
def timer(n) when is_integer(n) and n >= 0 do
take(interval(n), 1)
end
@@ -801,12 +796,13 @@ defmodule Stream do
Transforms an existing stream.
It expects an accumulator and a function that receives each stream element
and an accumulator. It must return a tuple, where the first element is a new
stream (often a list) or the atom `:halt`, and the second element is the
accumulator to be used by the next element, if any, in both cases.
and an accumulator, and must return a tuple containing a new stream
(often a list) with the new accumulator or a tuple with `:halt` as first
element and the accumulator as second.
Note: this function is equivalent to `Enum.flat_map_reduce/3`, except this
function does not return the accumulator once the stream is processed.
Note: this function is similar to `Enum.flat_map_reduce/3` except the
latter returns both the flat list and accumulator, while this one returns
only the stream.
## Examples
@@ -814,13 +810,13 @@ defmodule Stream do
many of the functions defined in this module. For example, we can implement
`Stream.take(enum, n)` as follows:
iex> enum = 1001..9999
iex> enum = 1..100
iex> n = 3
iex> stream = Stream.transform(enum, 0, fn i, acc ->
...> if acc < n, do: {[i], acc + 1}, else: {:halt, acc}
...> end)
iex> Enum.to_list(stream)
[1001, 1002, 1003]
[1, 2, 3]
"""
@spec transform(Enumerable.t(), acc, fun) :: Enumerable.t()
@@ -1260,37 +1256,41 @@ defmodule Stream do
def cycle(enumerable) do
fn acc, fun ->
step = &do_cycle_step(&1, &2)
cycle = &Enumerable.reduce(enumerable, &1, step)
reduce = check_cycle_first_element(cycle)
do_cycle(reduce, [], cycle, acc, fun)
inner = &do_cycle_each(&1, &2, fun)
outer = &Enumerable.reduce(enumerable, &1, inner)
reduce = check_cycle_first_element(outer)
do_cycle(reduce, outer, acc)
end
end
defp do_cycle(reduce, inner_acc, _cycle, {:halt, acc}, _fun) do
reduce.({:halt, inner_acc})
defp do_cycle(_reduce, _cycle, {:halt, acc}) do
{:halted, acc}
end
defp do_cycle(reduce, inner_acc, cycle, {:suspend, acc}, fun) do
{:suspended, acc, &do_cycle(reduce, inner_acc, cycle, &1, fun)}
defp do_cycle(reduce, cycle, {:suspend, acc}) do
{:suspended, acc, &do_cycle(reduce, cycle, &1)}
end
defp do_cycle(reduce, inner_acc, cycle, {:cont, acc}, fun) do
case reduce.({:cont, inner_acc}) do
{:suspended, [element], new_reduce} ->
do_cycle(new_reduce, inner_acc, cycle, fun.(element, acc), fun)
defp do_cycle(reduce, cycle, acc) do
try do
reduce.(acc)
catch
{:stream_cycle, acc} ->
{:halted, acc}
else
{state, acc} when state in [:done, :halted] ->
do_cycle(cycle, cycle, {:cont, acc})
{_, [element]} ->
do_cycle(cycle, [], cycle, fun.(element, acc), fun)
{_, []} ->
do_cycle(cycle, [], cycle, {:cont, acc}, fun)
{:suspended, acc, continuation} ->
{:suspended, acc, &do_cycle(continuation, cycle, &1)}
end
end
defp do_cycle_step(x, acc) do
{:suspend, [x | acc]}
defp do_cycle_each(x, acc, f) do
case f.(x, acc) do
{:halt, h} -> throw({:stream_cycle, h})
{_, _} = o -> o
end
end
defp check_cycle_first_element(reduce) do
@@ -1333,9 +1333,9 @@ defmodule Stream do
## Examples
# Although not necessary, let's seed the random algorithm
iex> :rand.seed(:exrop, {1, 2, 3})
iex> :rand.seed(:exsplus, {1, 2, 3})
iex> Stream.repeatedly(&:rand.uniform/0) |> Enum.take(3)
[0.7498295129076106, 0.06161655489244533, 0.7924073127680873]
[0.40502929729990744, 0.45336720247823126, 0.04094511692041057]
"""
@spec repeatedly((() -> element)) :: Enumerable.t()
@@ -1384,21 +1384,6 @@ defmodule Stream do
fn file -> File.close(file) end
)
iex> Stream.resource(
...> fn ->
...> {:ok, pid} = StringIO.open("string")
...> pid
...> end,
...> fn pid ->
...> case IO.getn(pid, "", 1) do
...> :eof -> {:halt, pid}
...> char -> {[char], pid}
...> end
...> end,
...> fn pid -> StringIO.close(pid) end
...> ) |> Enum.to_list()
["s", "t", "r", "i", "n", "g"]
"""
@spec resource((() -> acc), (acc -> {[element], acc} | {:halt, acc}), (acc -> term)) ::
Enumerable.t()
@@ -1418,21 +1403,23 @@ defmodule Stream do
defp do_resource(next_acc, next_fun, {:cont, acc}, fun, after_fun) do
try do
next_fun.(next_acc)
# Optimize the most common cases
case next_fun.(next_acc) do
{[], next_acc} -> {:opt, {:cont, acc}, next_acc}
{[v], next_acc} -> {:opt, fun.(v, acc), next_acc}
{_, _} = other -> other
end
catch
kind, reason ->
after_fun.(next_acc)
:erlang.raise(kind, reason, __STACKTRACE__)
else
{:opt, acc, next_acc} ->
do_resource(next_acc, next_fun, acc, fun, after_fun)
{:halt, next_acc} ->
do_resource(next_acc, next_fun, {:halt, acc}, fun, after_fun)
{[], next_acc} ->
do_resource(next_acc, next_fun, {:cont, acc}, fun, after_fun)
{[v], next_acc} ->
do_element_resource(next_acc, next_fun, acc, fun, after_fun, v)
{list, next_acc} when is_list(list) ->
reduce = &Enumerable.List.reduce(list, &1, fun)
do_list_resource(next_acc, next_fun, {:cont, acc}, fun, after_fun, reduce)
@@ -1444,19 +1431,6 @@ defmodule Stream do
end
end
defp do_element_resource(next_acc, next_fun, acc, fun, after_fun, v) do
try do
fun.(v, acc)
catch
kind, reason ->
after_fun.(next_acc)
:erlang.raise(kind, reason, __STACKTRACE__)
else
acc ->
do_resource(next_acc, next_fun, acc, fun, after_fun)
end
end
defp do_list_resource(next_acc, next_fun, acc, fun, after_fun, reduce) do
try do
reduce.(acc)
+48 -119
View File
@@ -2,85 +2,25 @@ import Kernel, except: [length: 1]
defmodule String do
@moduledoc ~S"""
Strings in Elixir are UTF-8 encoded binaries.
Strings in Elixir are a sequence of Unicode characters,
typically written between double quoted strings, such
as `"hello"` and `"héllò"`.
In case a string must have a double-quote in itself,
the double quotes must be escaped with a backslash,
for example: `"this is a string with \"double quotes\""`.
You can concatenate two strings with the `<>/2` operator:
iex> "hello" <> " " <> "world"
"hello world"
## Interpolation
Strings in Elixir also support interpolation. This allows
you to place some value in the middle of a string by using
the `#{}` syntax:
iex> name = "joe"
iex> "hello #{name}"
"hello joe"
Any Elixir expression is valid inside the interpolation.
If a string is given, the string is interpolated as is.
If any other value is given, Elixir will attempt to convert
it to a string using the `String.Chars` protocol. This
allows, for example, to output an integer from the interpolation:
iex> "2 + 2 = #{2 + 2}"
"2 + 2 = 4"
In case the value you want to interpolate cannot be
converted to a string, because it doesn't have an human
textual representation, a protocol error will be raised.
## Escape characters
Besides allowing double-quotes to be escaped with a backslash,
strings also support the following escape characters:
* `\a` - Bell
* `\b` - Backspace
* `\t` - Horizontal tab
* `\n` - Line feed (New lines)
* `\v` - Vertical tab
* `\f` - Form feed
* `\r` - Carriage return
* `\e` - Command Escape
* `\#` - Returns the `#` character itself, skipping interpolation
* `\xNN` - A byte represented by the hexadecimal `NN`
* `\uNNNN` - A Unicode code point represented by `NNNN`
Note it is generally not advised to use `\xNN` in Elixir
strings, as introducing an invalid byte sequence would
make the string invalid. If you have to introduce a
character by its hexdecimal representation, it is best
to work with Unicode code points, such as `\uNNNN`. In fact,
understanding Unicode code points can be essential when doing
low-level manipulations of string, so let's explore them in
detail next.
A String in Elixir is a UTF-8 encoded binary.
## Code points and grapheme cluster
The functions in this module act according to the Unicode
Standard, version 12.1.0.
Standard, version 11.0.0.
As per the standard, a code point is a single Unicode Character,
which may be represented by one or more bytes.
For example, although the code point "é" is a single character,
its underlying representation uses two bytes:
For example, the code point "é" is two bytes:
iex> byte_size("é")
2
However, this module returns the proper length:
iex> String.length("é")
1
iex> byte_size("é")
2
Furthermore, this module also presents the concept of grapheme cluster
(from now on referenced as graphemes). Graphemes can consist of multiple
@@ -109,8 +49,11 @@ defmodule String do
In general, the functions in this module rely on the Unicode
Standard, but do not contain any of the locale specific behaviour.
More information about graphemes can be found in the [Unicode
Standard Annex #29](https://www.unicode.org/reports/tr29/).
The current Elixir version implements Extended Grapheme Cluster
algorithm.
For converting a binary to a different encoding and for Unicode
normalization mechanisms, see Erlang's `:unicode` module.
@@ -131,7 +74,7 @@ defmodule String do
* `Kernel.binary_part/3` - retrieves part of the binary
* `Kernel.bit_size/1` and `Kernel.byte_size/1` - size related functions
* `Kernel.is_bitstring/1` and `Kernel.is_binary/1` - type-check function
* `Kernel.is_bitstring/1` and `Kernel.is_binary/1` - type checking function
* Plus a number of functions for working with binaries (bytes)
in the [`:binary` module](http://www.erlang.org/doc/man/binary.html)
@@ -217,16 +160,9 @@ defmodule String do
As we have seen above, code points can be inserted into
a string by their hexadecimal code:
iex> "ol\u00E1"
"ol\u0061\u0301" #=>
"olá"
Finally, to convert a String into a list of integers
code points, usually known as "char lists", you can call
`Strig.to_charlist`:
iex> String.to_charlist("olá")
[111, 108, 225]
## Self-synchronization
The UTF-8 encoding is self-synchronizing. This means that
@@ -244,7 +180,7 @@ defmodule String do
responsible to check the validity of the encoding. `String.chunk/2`
can be used for breaking a string into valid and invalid parts.
## Compile binary patterns
## Patterns
Many functions in this module work with patterns. For example,
`String.split/2` can split a string into multiple strings given
@@ -276,7 +212,7 @@ defmodule String do
"""
@type t :: binary
@typedoc "A single Unicode code point encoded in UTF-8. It may be one or more bytes."
@typedoc "A UTF-8 code point. It may be one or more bytes."
@type codepoint :: t
@typedoc "Multiple code points that may be perceived as a single character by readers"
@@ -484,18 +420,15 @@ defmodule String do
end
end
def split(string, pattern, []) when is_tuple(pattern) or is_binary(string) do
:binary.split(string, pattern, [:global])
end
def split(string, pattern, options) when is_binary(string) do
parts = Keyword.get(options, :parts, :infinity)
trim = Keyword.get(options, :trim, false)
case {parts, trim} do
{:infinity, false} ->
:binary.split(string, pattern, [:global])
_ ->
pattern = maybe_compile_pattern(pattern)
split_each(string, pattern, trim, parts_to_index(parts))
end
pattern = maybe_compile_pattern(pattern)
split_each(string, pattern, trim, parts_to_index(parts))
end
defp parts_to_index(:infinity), do: 0
@@ -650,9 +583,9 @@ defmodule String do
String.normalize(string1, :nfd) == String.normalize(string2, :nfd)
If you plan to compare multiple strings, multiple times in a row, you
may normalize them upfront and compare them directly to avoid multiple
normalization passes.
Therefore, if you plan to compare multiple strings, multiple times
in a row, you may normalize them upfront and compare them directly
to avoid multiple normalization passes.
## Examples
@@ -678,11 +611,6 @@ defmodule String do
Converts all characters in `string` to Unicode normalization
form identified by `form`.
Invalid Unicode codepoints are skipped and the remaining of
the string is converted. If you want the algorith to stop
and return on invalid codepoint, use `:unicode.characters_to_nfd_binary/1`
and `:unicode.characters_to_nfc_binary/1` instead.
## Forms
The supported forms are:
@@ -704,19 +632,22 @@ defmodule String do
"leña"
"""
# TODO: Fully deprecate it on v1.10
@doc deprecated:
"Use :unicode.characters_to_nfc_binary/1 or :unicode.characters_to_nfd_binary/1 instead"
def normalize(string, form)
def normalize(string, :nfd) do
case :unicode.characters_to_nfd_binary(string) do
string when is_binary(string) -> string
{:error, good, <<head, rest::binary>>} -> good <> <<head>> <> normalize(rest, :nfd)
{:error, bad, rest} -> bad <> normalize(rest, :nfd)
end
end
def normalize(string, :nfc) do
case :unicode.characters_to_nfc_binary(string) do
string when is_binary(string) -> string
{:error, good, <<head, rest::binary>>} -> good <> <<head>> <> normalize(rest, :nfc)
{:error, bad, rest} -> bad <> normalize(rest, :nfc)
end
end
@@ -1372,7 +1303,7 @@ defmodule String do
"a-b,c"
The pattern may also be a list of strings and the replacement may also
be a function that receives the matches:
be a function that receives the matched patterns:
iex> String.replace("a,b,c", ["a", "c"], fn <<char>> -> <<char + 1>> end)
"b,b,d"
@@ -1386,7 +1317,8 @@ defmodule String do
Notice we had to escape the backslash escape character (i.e., we used `\\N`
instead of just `\N` to escape the backslash; same thing for `\\g{N}`). By
giving `\0`, one can inject the whole match in the replacement string.
giving `\0`, one can inject the whole matched pattern in the replacement
string.
A compiled pattern can also be given:
@@ -1408,38 +1340,35 @@ defmodule String do
"""
@spec replace(t, pattern | Regex.t(), t | (t -> t | iodata), keyword) :: t
def replace(subject, pattern, replacement, options \\ [])
when is_binary(subject) and
(is_binary(replacement) or is_function(replacement, 1)) and
is_list(options) do
replace_guarded(subject, pattern, replacement, options)
end
defp replace_guarded(subject, %{__struct__: Regex} = regex, replacement, options) do
def replace(subject, %{__struct__: Regex} = regex, replacement, options)
when is_binary(replacement) or is_function(replacement, 1) do
Regex.replace(regex, subject, replacement, options)
end
defp replace_guarded(subject, "", "", _) do
def replace(subject, "", "", _) when is_binary(subject) do
subject
end
defp replace_guarded(subject, "", replacement_binary, options)
when is_binary(replacement_binary) do
def replace(subject, "", replacement, options)
when is_binary(subject) and is_binary(replacement) do
if Keyword.get(options, :global, true) do
IO.iodata_to_binary([replacement_binary | intersperse_bin(subject, replacement_binary)])
IO.iodata_to_binary([replacement | intersperse_bin(subject, replacement)])
else
replacement_binary <> subject
replacement <> subject
end
end
defp replace_guarded(subject, "", replacement_fun, options) do
def replace(subject, "", replacement, options)
when is_binary(subject) and is_function(replacement, 1) do
if Keyword.get(options, :global, true) do
IO.iodata_to_binary([replacement_fun.("") | intersperse_fun(subject, replacement_fun)])
IO.iodata_to_binary([replacement.("") | intersperse_fun(subject, replacement)])
else
IO.iodata_to_binary([replacement_fun.("") | subject])
IO.iodata_to_binary([replacement.("") | subject])
end
end
defp replace_guarded(subject, pattern, replacement, options) do
def replace(subject, pattern, replacement, options) when is_binary(subject) do
if insert = Keyword.get(options, :insert_replaced) do
IO.warn(
"String.replace/4 with :insert_replaced option is deprecated. " <>
@@ -2202,13 +2131,13 @@ defmodule String do
For example, take the grapheme "é" which is made of the characters
"e" and the acute accent. The following returns `true`:
iex> String.contains?(String.normalize("é", :nfd), "e")
iex> String.contains?(:unicode.characters_to_nfd_binary("é"), "e")
true
However, if "é" is represented by the single character "e with acute"
accent, then it will return `false`:
iex> String.contains?(String.normalize("é", :nfc), "e")
iex> String.contains?(:unicode.characters_to_nfc_binary("é"), "e")
false
"""
@@ -2321,7 +2250,7 @@ defmodule String do
Passing a string that does not represent an integer leads to an error:
String.to_integer("invalid data")
** (ArgumentError) argument error
#=> ** (ArgumentError) argument error
"""
@spec to_integer(String.t()) :: integer
@@ -2363,7 +2292,7 @@ defmodule String do
3.0
String.to_float("3")
** (ArgumentError) argument error
#=> ** (ArgumentError) argument error
"""
@spec to_float(String.t()) :: float
+26 -36
View File
@@ -21,19 +21,14 @@ defmodule StringIO do
`string` will be the initial input of the newly created
device.
If the `:capture_prompt` option is set to `true`,
prompts (specified as arguments to `IO.get*` functions)
are captured in the output.
The device will be created and sent to the function given.
When the function returns, the device will be closed. The final
result will be a tuple with `:ok` and the result of the function.
## Options
* `:capture_prompt` - if set to `true`, prompts (specified as
arguments to `IO.get*` functions) are captured in the output.
Defaults to `false`.
* `:encoding` (since v1.10.0) - encoding of the IO device. Allowed
values are `:unicode` (default) and `:latin1`.
## Examples
iex> StringIO.open("foo", [], fn pid ->
@@ -174,8 +169,7 @@ defmodule StringIO do
@impl true
def init({string, options}) do
capture_prompt = options[:capture_prompt] || false
encoding = options[:encoding] || :unicode
{:ok, %{encoding: encoding, input: string, output: "", capture_prompt: capture_prompt}}
{:ok, %{input: string, output: "", capture_prompt: capture_prompt}}
end
@impl true
@@ -203,7 +197,7 @@ defmodule StringIO do
defp io_request(from, reply_as, req, state) do
{reply, state} = io_request(req, state)
io_reply(from, reply_as, reply)
io_reply(from, reply_as, to_reply(reply))
state
end
@@ -251,16 +245,12 @@ defmodule StringIO do
get_line(encoding, "", state)
end
defp io_request({:setopts, [encoding: encoding]}, state) when encoding in [:latin1, :unicode] do
{:ok, %{state | encoding: encoding}}
end
defp io_request({:setopts, _opts}, state) do
{{:error, :enotsup}, state}
end
defp io_request(:getopts, state) do
{[binary: true, encoding: state.encoding], state}
{{:ok, [binary: true, encoding: :unicode]}, state}
end
defp io_request({:get_geometry, :columns}, state) do
@@ -281,10 +271,10 @@ defmodule StringIO do
## put_chars
defp put_chars(encoding, chars, req, state) do
case :unicode.characters_to_binary(chars, encoding, state.encoding) do
defp put_chars(encoding, chars, req, %{output: output} = state) do
case :unicode.characters_to_binary(chars, encoding, :unicode) do
string when is_binary(string) ->
{:ok, %{state | output: state.output <> string}}
{:ok, %{state | output: output <> string}}
{_, _, _} ->
{{:error, req}, state}
@@ -318,25 +308,22 @@ defmodule StringIO do
{chars, rest}
end
defp get_chars(input, :unicode, count) do
with {:ok, count} <- split_at(input, count, 0) do
<<chars::binary-size(count), rest::binary>> = input
{chars, rest}
defp get_chars(input, encoding, count) do
try do
case :file_io_server.count_and_find(input, count, encoding) do
{buf_count, split_pos} when buf_count < count or split_pos == :none ->
{input, ""}
{_buf_count, split_pos} ->
<<chars::binary-size(split_pos), rest::binary>> = input
{chars, rest}
end
catch
:exit, :invalid_unicode ->
{:error, :invalid_unicode}
end
end
defp split_at(_, 0, acc),
do: {:ok, acc}
defp split_at(<<h::utf8, t::binary>>, count, acc),
do: split_at(t, count - 1, acc + byte_size(<<h::utf8>>))
defp split_at(<<_, _::binary>>, _count, _acc),
do: {:error, :invalid_unicode}
defp split_at(<<>>, _count, acc),
do: {:ok, acc}
## get_line
defp get_line(encoding, prompt, %{input: input} = state) do
@@ -458,4 +445,7 @@ defmodule StringIO do
defp io_reply(from, reply_as, reply) do
send(from, {:io_reply, reply_as, reply})
end
defp to_reply(list) when is_list(list), do: IO.chardata_to_string(list)
defp to_reply(other), do: other
end
+34 -43
View File
@@ -108,8 +108,8 @@ defmodule Supervisor do
The child specification describes how the supervisor starts, shuts down,
and restarts child processes.
The child specification is a map which contains 6 elements. The first two keys
in the following list are required, and the remaining ones are optional:
The child specification contains 6 keys. The first two are required,
and the remaining ones are optional:
* `:id` - any term used to identify the child specification
internally by the supervisor; defaults to the given module.
@@ -123,16 +123,16 @@ defmodule Supervisor do
should be restarted (see the "Restart values" section below).
This key is optional and defaults to `:permanent`.
* `:shutdown` - an integer or atom that defines how a child process should
be terminated (see the "Shutdown values" section below). This key
is optional and defaults to `5_000` if the type is `:worker` or
* `:shutdown` - an atom that defines how a child process should be
terminated (see the "Shutdown values" section below). This key
is optional and defaults to `5000` if the type is `:worker` or
`:infinity` if the type is `:supervisor`.
* `:type` - specifies that the child process is a `:worker` or a
`:supervisor`. This key is optional and defaults to `:worker`.
There is a sixth key, `:modules`, which is optional and is rarely changed.
It is set automatically based on the `:start` value.
There is a sixth key, `:modules`, that is rarely changed. It is set
automatically based on the value in `:start`.
Let's understand what the `:shutdown` and `:restart` options control.
@@ -368,7 +368,12 @@ defmodule Supervisor do
In the above, process termination refers to unsuccessful termination, which
is determined by the `:restart` option.
To dynamically supervise children, see `DynamicSupervisor`.
There is also a deprecated strategy called `:simple_one_for_one` which
has been replaced by the `DynamicSupervisor`. The `:simple_one_for_one`
supervisor was similar to `:one_for_one` but suits better when dynamically
attaching children. Many functions in this module behaved slightly
differently when this strategy was used. See the `DynamicSupervisor` module
for more information and migration strategies.
### Name registration
@@ -445,7 +450,7 @@ defmodule Supervisor do
import Supervisor.Spec
@behaviour Supervisor
unless Module.has_attribute?(__MODULE__, :doc) do
if Module.get_attribute(__MODULE__, :doc) == nil do
@doc """
Returns a specification to start this module under a supervisor.
@@ -495,7 +500,10 @@ defmodule Supervisor do
@type name :: atom | {:global, term} | {:via, module, term}
@typedoc "Option values used by the `start*` functions"
@type option :: {:name, name}
@type option :: {:name, name} | init_option()
@typedoc "Options used by the `start*` functions"
@type options :: [option, ...]
@typedoc "The supervisor reference"
@type supervisor :: pid | name | {atom, node}
@@ -549,7 +557,7 @@ defmodule Supervisor do
process and exits not only on crashes but also if the parent process exits
with `:normal` reason.
"""
@spec start_link([:supervisor.child_spec() | {module, term} | module], [option | init_option]) ::
@spec start_link([:supervisor.child_spec() | {module, term} | module], options) ::
{:ok, pid} | {:error, {:already_started, pid} | {:shutdown, term} | term}
def start_link(children, options) when is_list(children) do
{sup_opts, start_opts} = Keyword.split(options, [:strategy, :max_seconds, :max_restarts])
@@ -580,7 +588,8 @@ defmodule Supervisor do
## Options
* `:strategy` - the supervision strategy option. It can be either
`:one_for_one`, `:rest_for_one`, or `:one_for_all`
`:one_for_one`, `:rest_for_one`, `:one_for_all`, or the deprecated
`:simple_one_for_one`.
* `:max_restarts` - the maximum number of restarts allowed in
a time frame. Defaults to `3`.
@@ -593,23 +602,12 @@ defmodule Supervisor do
description of the available strategies.
"""
@doc since: "1.5.0"
# TODO: Warn if simple_one_for_one strategy is used on Elixir v1.10
@spec init([:supervisor.child_spec() | {module, term} | module], [init_option]) :: {:ok, tuple}
def init(children, options) when is_list(children) and is_list(options) do
strategy =
case options[:strategy] do
nil ->
raise ArgumentError, "expected :strategy option to be given"
:simple_one_for_one ->
IO.warn(
":simple_one_for_one strategy is deprecated, please use DynamicSupervisor instead"
)
:simple_one_for_one
other ->
other
end
unless strategy = options[:strategy] do
raise ArgumentError, "expected :strategy option to be given"
end
intensity = Keyword.get(options, :max_restarts, 3)
period = Keyword.get(options, :max_seconds, 5)
@@ -763,7 +761,7 @@ defmodule Supervisor do
# It is important to keep the 2-arity spec because it is a catch
# all to start_link(children, options).
@spec start_link(module, term) :: on_start
@spec start_link(module, term, [option]) :: on_start
@spec start_link(module, term, GenServer.options()) :: on_start
def start_link(module, init_arg, options \\ []) when is_list(options) do
case Keyword.get(options, :name) do
nil ->
@@ -816,18 +814,14 @@ defmodule Supervisor do
returns `{:error, error}` where `error` is a term containing information about
the error and child specification.
"""
@spec start_child(supervisor, :supervisor.child_spec() | {module, term} | module) ::
@spec start_child(supervisor, :supervisor.child_spec() | {module, term} | module | [term]) ::
on_start_child
def start_child(supervisor, {_, _, _, _, _, _} = child_spec) do
call(supervisor, {:start_child, child_spec})
end
# TODO: Deprecate this clause on Elixir v1.10
def start_child(supervisor, args) when is_list(args) do
# TODO: Deprecate in v1.11
# IO.warn(
# "Supervisor.start_child/2 with a list of args is deprecated, please use DynamicSupervisor instead"
# )
call(supervisor, {:start_child, args})
end
@@ -849,15 +843,12 @@ defmodule Supervisor do
specification for the given child ID, this function returns
`{:error, :not_found}`.
"""
@spec terminate_child(supervisor, term()) :: :ok | {:error, :not_found}
@spec terminate_child(supervisor, term()) :: :ok | {:error, error}
when error: :not_found | :simple_one_for_one
def terminate_child(supervisor, child_id)
# TODO: Deprecate this clause on Elixir v1.10
def terminate_child(supervisor, pid) when is_pid(pid) do
# TODO: Deprecate in v1.11
# IO.warn(
# "Supervisor.terminate_child/2 with a PID is deprecated, please use DynamicSupervisor instead"
# )
call(supervisor, {:terminate_child, pid})
end
@@ -876,7 +867,7 @@ defmodule Supervisor do
current process is running or being restarted.
"""
@spec delete_child(supervisor, term()) :: :ok | {:error, error}
when error: :not_found | :running | :restarting
when error: :not_found | :simple_one_for_one | :running | :restarting
def delete_child(supervisor, child_id) do
call(supervisor, {:delete_child, child_id})
end
@@ -904,7 +895,7 @@ defmodule Supervisor do
or if it fails, this function returns `{:error, error}`.
"""
@spec restart_child(supervisor, term()) :: {:ok, child} | {:ok, child, term} | {:error, error}
when error: :not_found | :running | :restarting | term
when error: :not_found | :simple_one_for_one | :running | :restarting | term
def restart_child(supervisor, child_id) do
call(supervisor, {:restart_child, child_id})
end
@@ -959,7 +950,7 @@ defmodule Supervisor do
workers: non_neg_integer
}
def count_children(supervisor) do
call(supervisor, :count_children) |> Map.new()
call(supervisor, :count_children) |> :maps.from_list()
end
@doc """
+3 -5
View File
@@ -109,6 +109,9 @@ defmodule Supervisor.Spec do
@moduledoc deprecated:
"Use the new child specifications outlined in the Supervisor module instead"
# TODO: Deprecate all functions in this module on Elixir v1.9.
# Also deprecate entry in Supervisor.Default.
@typedoc "Supported strategies"
@type strategy :: :simple_one_for_one | :one_for_one | :one_for_all | :rest_for_one
@@ -166,7 +169,6 @@ defmodule Supervisor.Spec do
max_restarts: non_neg_integer,
max_seconds: pos_integer
) :: {:ok, tuple}
@deprecated "Use the new child specifications outlined in the Supervisor module instead"
def supervise(children, options) do
unless strategy = options[:strategy] do
raise ArgumentError, "expected :strategy option to be given"
@@ -234,8 +236,6 @@ defmodule Supervisor.Spec do
function: atom,
modules: modules
) :: spec
# TODO: Deprecate on v1.11
# @deprecated "Use the new child specifications outlined in the Supervisor module instead"
def worker(module, args, options \\ []) do
child(:worker, module, args, options)
end
@@ -269,8 +269,6 @@ defmodule Supervisor.Spec do
function: atom,
modules: modules
) :: spec
# TODO: Deprecate on v1.11
# @deprecated "Use the new child specifications outlined in the Supervisor module instead"
def supervisor(module, args, options \\ []) do
options = Keyword.put_new(options, :shutdown, :infinity)
child(:supervisor, module, args, options)
+8 -12
View File
@@ -186,7 +186,7 @@ defmodule System do
* `:build` - the Elixir version, short Git revision hash and
Erlang/OTP release it was compiled with
* `:date` - a string representation of the ISO8601 date and time it was built
* `:otp_release` - OTP release it was compiled with
* `:opt_release` - OTP release it was compiled with
* `:revision` - short Git revision hash. If Git was not available at building
time, it is set to `""`
* `:version` - the Elixir version
@@ -312,9 +312,7 @@ defmodule System do
"""
@spec user_home() :: String.t() | nil
def user_home do
{:ok, [[home] | _]} = :init.get_argument(:home)
encoding = :file.native_name_encoding()
:unicode.characters_to_binary(home, encoding, encoding)
:elixir_config.get(:home)
end
@doc """
@@ -337,7 +335,7 @@ defmodule System do
1. the directory named by the TMPDIR environment variable
2. the directory named by the TEMP environment variable
3. the directory named by the TMP environment variable
4. `C:\TMP` on Windows or `/tmp` on Unix-like operating systems
4. `C:\TMP` on Windows or `/tmp` on Unix
5. as a last resort, the current working directory
Returns `nil` if none of the above are writable.
@@ -398,7 +396,7 @@ defmodule System do
The handler always executes in a different process from the one it was
registered in. As a consequence, any resources managed by the calling process
(ETS tables, open files, and others) won't be available by the time the handler
(ETS tables, open files, etc.) won't be available by the time the handler
function is invoked.
The function must receive the exit status code as an argument.
@@ -413,8 +411,8 @@ defmodule System do
Locates an executable on the system.
This function looks up an executable program given
its name using the environment variable PATH on Windows and Unix-like
operating systems. It also considers the proper executable
its name using the environment variable PATH on Unix
and Windows. It also considers the proper executable
extension for each operating system, so for Windows it will try to
lookup files with `.com`, `.cmd` or similar extensions.
"""
@@ -529,8 +527,6 @@ defmodule System do
For more information, see `:os.getpid/0`.
"""
# TODO: deprecate permanently on v1.13
@doc deprecated: "Use System.pid/0 instead"
@spec get_pid() :: binary
def get_pid, do: IO.iodata_to_binary(:os.getpid())
@@ -638,7 +634,7 @@ defmodule System do
Returns the operating system PID for the current Erlang runtime system instance.
Returns a string containing the (usually) numerical identifier for a process.
On Unix-like operating systems, this is typically the return value of the `getpid()` system call.
On UNIX, this is typically the return value of the `getpid()` system call.
On Windows, the process ID as returned by the `GetCurrentProcessId()` system
call is used.
@@ -948,7 +944,7 @@ defmodule System do
time and the Erlang VM system time.
The result is returned in the given time unit `unit`. The returned
offset, added to an Erlang monotonic time (for instance, one obtained with
offset, added to an Erlang monotonic time (e.g., obtained with
`monotonic_time/1`), gives the Erlang system time that corresponds
to that monotonic time.
"""
+1 -1
View File
@@ -257,7 +257,7 @@ defmodule Task do
@doc false
defmacro __using__(opts) do
quote location: :keep, bind_quoted: [opts: opts] do
unless Module.has_attribute?(__MODULE__, :doc) do
if Module.get_attribute(__MODULE__, :doc) == nil do
@doc """
Returns a specification to start this module under a supervisor.
+6 -34
View File
@@ -96,27 +96,7 @@ defmodule Task.Supervised do
:erlang.raise(:exit, value, __STACKTRACE__)
kind, value ->
{fun, args} = get_running(mfa)
:logger.error(
%{
label: {Task.Supervisor, :terminating},
report: %{
name: self(),
starter: get_from(owner),
function: fun,
args: args,
reason: {log_value(kind, value), __STACKTRACE__}
}
},
%{
domain: [:otp, :elixir],
error_logger: %{tag: :error_msg},
report_cb: &__MODULE__.format_report/1,
callers: Process.get(:"$callers")
}
)
log(owner, mfa, {log_value(kind, value), __STACKTRACE__})
:erlang.raise(kind, value, __STACKTRACE__)
end
end
@@ -124,24 +104,16 @@ defmodule Task.Supervised do
defp log_value(:throw, value), do: {:nocatch, value}
defp log_value(_, value), do: value
@doc false
def format_report(%{
label: {Task.Supervisor, :terminating},
report: %{
name: name,
starter: starter,
function: fun,
args: args,
reason: reason
}
}) do
defp log(owner, mfa, reason) do
{fun, args} = get_running(mfa)
message =
'** Task ~p terminating~n' ++
'** Started from ~p~n' ++
'** When function == ~p~n' ++
'** arguments == ~p~n' ++ '** Reason for termination == ~n' ++ '** ~p~n'
{message, [starter, name, fun, args, get_reason(reason)]}
:error_logger.format(message, [self(), get_from(owner), fun, args, get_reason(reason)])
end
defp get_from({node, pid_or_name, _pid}) when node == node(), do: pid_or_name
@@ -540,7 +512,7 @@ defmodule Task.Supervised do
# One of the spawned processes went down. We inform the parent process of
# this and keep going.
{:DOWN, ref, _, _, reason} when is_map_key(running_tasks, ref) ->
{:DOWN, ref, _, _, reason} ->
{task, running_tasks} = Map.pop(running_tasks, ref)
%{position: position, timer_ref: timer_ref, timed_out?: timed_out?} = task
+7 -16
View File
@@ -26,7 +26,7 @@ defmodule Task.Supervisor do
@typedoc "Option values used by `start_link`"
@type option ::
DynamicSupervisor.option()
Supervisor.option()
| {:restart, :supervisor.restart()}
| {:shutdown, :supervisor.shutdown()}
@@ -78,21 +78,14 @@ defmodule Task.Supervisor do
give them directly to `start_child` and `async`.
"""
@spec start_link([option]) :: Supervisor.on_start()
# TODO: Deprecate passing restart and shutdown here on Elixir v1.10.
def start_link(options \\ []) do
{restart, options} = Keyword.pop(options, :restart)
{shutdown, options} = Keyword.pop(options, :shutdown)
if restart || shutdown do
IO.warn(
":restart and :shutdown options in Task.Supervisor.start_link/1 " <>
"are deprecated. Please pass those options on start_child/3 instead"
)
end
{restart, options} = Keyword.pop(options, :restart, :temporary)
{shutdown, options} = Keyword.pop(options, :shutdown, 5000)
keys = [:max_children, :max_seconds, :max_restarts]
{sup_opts, start_opts} = Keyword.split(options, keys)
restart_and_shutdown = {restart || :temporary, shutdown || 5000}
DynamicSupervisor.start_link(__MODULE__, {restart_and_shutdown, sup_opts}, start_opts)
DynamicSupervisor.start_link(__MODULE__, {{restart, shutdown}, sup_opts}, start_opts)
end
@doc false
@@ -424,10 +417,8 @@ defmodule Task.Supervisor do
defp start_child_with_spec(supervisor, args, restart, shutdown) do
# TODO: This only exists because we need to support reading restart/shutdown
# from two different places. Remove this, the init function and the associated
# clause in DynamicSupervisor on Elixir v2.0
# TODO: Once we do this, we can also make it so the task arguments are never
# sent to the supervisor if the restart is temporary
# from two different places. Remove this and the associated clause in DynamicSupervisor
# on Elixir v2.0
GenServer.call(supervisor, {:start_task, args, restart, shutdown}, :infinity)
end
+13 -53
View File
@@ -74,7 +74,7 @@ defmodule URI do
Encodes an enumerable into a query string.
Takes an enumerable that enumerates as a list of two-element
tuples (for instance, a map or a keyword list) and returns a string
tuples (e.g., a map or a keyword list) and returns a string
in the form of `key1=value1&key2=value2...` where keys and
values are URL encoded as per `encode_www_form/1`.
@@ -234,7 +234,7 @@ defmodule URI do
the following characters are unreserved:
* Alphanumeric characters: `A-Z`, `a-z`, `0-9`
* `~`, `_`, `-`, `.`
* `~`, `_`, `-`
## Examples
@@ -251,8 +251,7 @@ defmodule URI do
Checks if `character` is allowed unescaped in a URI.
This is the default used by `URI.encode/2` where both
[reserved](`char_reserved?/1`) and [unreserved characters](`char_unreserved?/1`)
are kept unescaped.
reserved and unreserved characters are kept unescaped.
## Examples
@@ -272,15 +271,14 @@ defmodule URI do
so-called unreserved characters, which have the same meaning both
escaped and unescaped, won't be escaped by default.
See `encode_www_form/1` if you are interested in escaping reserved
See `encode_www_form` if you are interested in escaping reserved
characters too.
This function also accepts a `predicate` function as an optional
argument. If passed, this function will be called with each byte
in `string` as its argument and should return a truthy value (anything other
than `false` or `nil`) if the given byte should be left as is, or return a
falsy value (`false` or `nil`) if the character should be escaped. Defaults
to `URI.char_unescaped?/1`.
falsy value (`false` or `nil`) if the character should be escaped.
## Examples
@@ -454,38 +452,18 @@ defmodule URI do
def parse(string) when is_binary(string) do
# From https://tools.ietf.org/html/rfc3986#appendix-B
# Parts: 12 3 4 5 6 7 8 9
regex = ~r{^(([a-z][a-z0-9\+\-\.]*):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?}i
parts = Regex.run(regex, string)
destructure [
_full,
# 1
_scheme_with_colon,
# 2
scheme,
# 3
authority_with_slashes,
# 4
_authority,
# 5
path,
# 6
query_with_question_mark,
# 7
_query,
# 8
_fragment_with_hash,
# 9
fragment
],
destructure [_, _, scheme, _, authority, path, query_with_question_mark, _, _, fragment],
parts
scheme = nillify(scheme)
authority = nillify(authority)
path = nillify(path)
query = nillify_query(query_with_question_mark)
{authority, userinfo, host, port} = split_authority(authority_with_slashes)
{userinfo, host, port} = split_authority(authority)
scheme = scheme && String.downcase(scheme)
port = port || (scheme && default_port(scheme))
@@ -506,24 +484,16 @@ defmodule URI do
defp nillify_query(_other), do: nil
# Split an authority into its userinfo, host and port parts.
defp split_authority("") do
{nil, nil, nil, nil}
end
defp split_authority("//") do
{"", nil, "", nil}
end
defp split_authority("//" <> authority) do
defp split_authority(string) do
regex = ~r/(^(.*)@)?(\[[a-zA-Z0-9:.]*\]|[^:]*)(:(\d*))?/
components = Regex.run(regex, authority)
components = Regex.run(regex, string || "")
destructure [_, _, userinfo, host, _, port], components
userinfo = nillify(userinfo)
host = if nillify(host), do: host |> String.trim_leading("[") |> String.trim_trailing("]")
port = if nillify(port), do: String.to_integer(port)
{authority, userinfo, host, port}
{userinfo, host, port}
end
# Regex.run returns empty strings sometimes. We want
@@ -536,12 +506,10 @@ defmodule URI do
## Examples
iex> uri = URI.parse("http://google.com")
iex> URI.to_string(uri)
iex> URI.to_string(URI.parse("http://google.com"))
"http://google.com"
iex> uri = URI.parse("foo://bar.baz")
iex> URI.to_string(uri)
iex> URI.to_string(%URI{scheme: "foo", host: "bar.baz"})
"foo://bar.baz"
Note that when creating this string representation, the `:authority` value will be
@@ -656,14 +624,6 @@ defmodule URI do
end
defimpl String.Chars, for: URI do
def to_string(%{host: host, authority: authority, path: path} = uri)
when (host != nil or authority != nil) and is_binary(path) and
path != "" and binary_part(path, 0, 1) != "/" do
raise ArgumentError,
":path in URI must be nil or an absolute path if :host or :authority are given, " <>
"got: #{inspect(uri)}"
end
def to_string(%{scheme: scheme, port: port, path: path, query: query, fragment: fragment} = uri) do
uri =
case scheme && URI.default_port(scheme) do
+3 -3
View File
@@ -5,8 +5,8 @@ defmodule Version do
A version is a string in a specific format or a `Version`
generated after parsing via `Version.parse/1`.
Although Elixir projects are not required to follow SemVer,
they must follow the format outlined on [SemVer 2.0 schema](https://semver.org/).
`Version` parsing and requirements follow
[SemVer 2.0 schema](https://semver.org/).
## Versions
@@ -29,7 +29,7 @@ defmodule Version do
## Struct
The version is represented by the `Version` struct and fields
are named according to SemVer 2.0: `:major`, `:minor`, `:patch`,
are named according to SemVer: `:major`, `:minor`, `:patch`,
`:pre`, and `:build`.
## Requirements
@@ -8,11 +8,11 @@ Elixir applies bug fixes only to the latest minor branch. Security patches are a
Elixir version | Support
:------------- | :-----------------------------
1.10 | Bug fixes and security patches
1.9 | Security patches only
1.9 | Bug fixes and security patches
1.8 | Security patches only
1.7 | Security patches only
1.6 | Security patches only
1.5 | Security patches only
New releases are announced in the read-only [announcements mailing list](https://groups.google.com/group/elixir-lang-ann). All security releases [will be tagged with `[security]`](https://groups.google.com/forum/#!searchin/elixir-lang-ann/%5Bsecurity%5D%7Csort:date).
@@ -52,7 +52,6 @@ Elixir version | Supported Erlang/OTP versions
1.7 | 19 - 22
1.8 | 20 - 22
1.9 | 20 - 22
1.10 | 21 - 22 (and Erlang/OTP 23 from v1.10.3)
While Elixir often adds compatibility to new Erlang/OTP versions on released branches, such as support for Erlang/OTP 20 in v1.4.5, those releases usually contain the minimum changes for Elixir to run without errors. Only the next minor release, in this case v1.5.0, does effectively leverage the new features provided by the latest Erlang/OTP release.
@@ -74,63 +73,51 @@ The first column is the version the feature was hard deprecated. The second colu
Version | Deprecated feature | Replaced by (available since)
:-------| :-------------------------------------------------- | :---------------------------------------------------------------
[v1.10] | `Code.ensure_compiled?/1` | `Code.ensure_compiled/1` (v1.0)
[v1.10] | `Code.load_file/2` | `Code.require_file/2` (v1.0) or `Code.compile_file/2` (v1.7)
[v1.10] | `Code.loaded_files/0` | `Code.required_files/0` (v1.7)
[v1.10] | `Code.unload_file/1` | `Code.unrequire_files/1` (v1.7)
[v1.10] | Passing non-chardata to `Logger.log/2` | Explicitly convert to string with `to_string/1` (v1.0)
[v1.10] | `:compile_time_purge_level` in `Logger` app environment | `:compile_time_purge_matching` in `Logger` app environment (v1.7)
[v1.10] | `Supervisor.Spec.supervise/2` | The new child specs outlined in `Supervisor` (v1.5)
[v1.10] | `:simple_one_for_one` strategy in `Supervisor` | `DynamicSupervisor` (v1.6)
[v1.10] | `:restart` and `:shutdown` in `Task.Supervisor.start_link/1` | `:restart` and `:shutdown` in `Task.Supervisor.start_child/3` (v1.6)
[v1.9] | Passing `:insert_replaced` to `String.replace/4` | Use `:binary.replace/4` (v1.0)
[v1.9] | Enumerable keys in `Map.drop/2`, `Map.split/2`, and `Map.take/2` | Call `Enum.to_list/1` on the second argument before hand (v1.0)
[v1.9] | `Mix.Project.load_paths/1` | `Mix.Project.compile_path/1` (v1.0)
[v1.9] | Passing `:insert_replaced` to `String.replace/4` | Use `:binary.replace/4` (v1.0)
[v1.8] | Passing a non-empty list to `:into` in [`for`](`Kernel.SpecialForms.for/1`) | `Kernel.++/2` or `Keyword.merge/2` (v1.0)
[v1.9] | `--detached` in CLI | `--erl "-detached"` (v1.0)
[v1.8] | Passing a non-empty list to `Enum.into/2` | `Kernel.++/2` or `Keyword.merge/2` (v1.0)
[v1.8] | Time units in its plural form, such as: `:seconds`, `:milliseconds`, and the like | Use the singular form, such as: `:second`, `:millisecond`, and so on (v1.4)
[v1.8] | Passing a non-empty list to `:into` in `for` | `Kernel.++/2` or `Keyword.merge/2` (v1.0)
[v1.8] | `:seconds`, `:milliseconds`, etc. as time units | `:second`, `:millisecond`, etc. (v1.4)
[v1.8] | `Inspect.Algebra.surround/3` | `Inspect.Algebra.concat/2` and `Inspect.Algebra.nest/2` (v1.0)
[v1.8] | `Inspect.Algebra.surround_many/6` | `Inspect.Algebra.container_doc/6` (v1.6)
[v1.9] | `--detached` in `Kernel.CLI` | `--erl "-detached"` (v1.0)
[v1.8] | `Kernel.ParallelCompiler.files/2` | `Kernel.ParallelCompiler.compile/2` (v1.6)
[v1.8] | `Kernel.ParallelCompiler.files_to_path/2` | `Kernel.ParallelCompiler.compile_to_path/2` (v1.6)
[v1.8] | `Kernel.ParallelRequire.files/2` | `Kernel.ParallelCompiler.require/2` (v1.6)
[v1.8] | Returning `{:ok, contents}` or `:error` from `Mix.Compilers.Erlang.compile/6`'s callback | Return `{:ok, contents, warnings}` or `{:error, errors, warnings}` (v1.6)
[v1.8] | `System.cwd/0` and `System.cwd!/0` | `File.cwd/0` and `File.cwd!/0` (v1.0)
[v1.8] | Returning `{:ok, contents}` or `:error` from `Mix.Compilers.Erlang.compile/6`'s callback | Return `{:ok, contents, warnings}` or `{:error, errors, warnings}` (v1.6)
[v1.7] | `Code.get_docs/2` | `Code.fetch_docs/1` (v1.7)
[v1.7] | `Enum.chunk/2,3,4` | `Enum.chunk_every/2` and [`Enum.chunk_every/3,4`](`Enum.chunk_every/4`) (v1.5)
[v1.7] | Calling `super/1` in`GenServer` callbacks | Implenting the behaviour explicitly without calling `super/1` (v1.0)
[v1.7] | [`not left in right`](`Kernel.in/2`) | [`left not in right`](`Kernel.in/2`) (v1.5)
[v1.7] | Calling `super/1` on GenServer callbacks | Implenting the behaviour explicitly without calling `super/1` (v1.0)
[v1.7] | `Enum.chunk/2`[`/3/4`](`Enum.chunk/4`) | `Enum.chunk_every/2`[`/3/4`](`Enum.chunk_every/4`) (v1.5)
[v1.7] | `not left in right` | [`left not in right`](`Kernel.in/2`) (v1.5)
[v1.7] | `Registry.start_link/3` | `Registry.start_link/1` (v1.5)
[v1.7] | `Stream.chunk/2,3,4` | `Stream.chunk_every/2` and [`Stream.chunk_every/3,4`](`Stream.chunk_every/4`) (v1.5)
[v1.7] | `Stream.chunk/2`[`/3/4`](`Stream.chunk/4`) | `Stream.chunk_every/2`[`/3/4`](`Stream.chunk_every/4`) (v1.5)
[v1.6] | `Enum.partition/2` | `Enum.split_with/2` (v1.4)
[v1.6] | `Keyword.replace/3` | `Keyword.fetch/2` + `Keyword.put/3` (v1.0)
[v1.6] | `Macro.unescape_tokens/1,2` | Use `Enum.map/2` to traverse over the arguments (v1.0)
[v1.6] | `Macro.unescape_tokens/1/2` | Use `Enum.map/2` to traverse over the arguments (v1.0)
[v1.6] | `Module.add_doc/6` | `@doc` module attribute (v1.0)
[v1.6] | `Map.replace/3` | `Map.fetch/2` + `Map.put/3` (v1.0)
[v1.6] | `Module.add_doc/6` | [`@doc`](`Module`) module attribute (v1.0)
[v1.6] | `Range.range?/1` | Pattern match on [`_.._`](`Kernel.../2`) (v1.0)
[v1.5] | `()` to mean `nil` | `nil` (v1.0)
[v1.5] | `char_list/0` type | `t:charlist/0` type (v1.3)
[v1.6] | `Range.range?/1` | Pattern match on `_.._` (v1.0)
[v1.5] | `Atom.to_char_list/1` | `Atom.to_charlist/1` (v1.3)
[v1.5] | `Enum.filter_map/3` | `Enum.filter/2` + `Enum.map/2` or [`for`](`Kernel.SpecialForms.for/1`) comprehensions (v1.0)
[v1.5] | `Float.to_char_list/1` | `Float.to_charlist/1` (v1.3)
[v1.5] | `GenEvent` module | `Supervisor` and `GenServer` (v1.0);<br/>[`GenStage`](https://hex.pm/packages/gen_stage) (v1.3);<br/>[`:gen_event`](http://www.erlang.org/doc/man/gen_event.html) (Erlang/OTP 17)
[v1.5] | `<%=` in middle and end expressions in `EEx` | Use `<%` (`<%=` is allowed only in start expressions) (v1.0)
[v1.5] | `:as_char_lists` value in `t:Inspect.Opts.t/0` type | `:as_charlists` value (v1.3)
[v1.5] | `:char_lists` key in `t:Inspect.Opts.t/0` type | `:charlists` key (v1.3)
[v1.5] | `Integer.to_char_list/1,2` | `Integer.to_charlist/1` and `Integer.to_charlist/2` (v1.3)
[v1.5] | `Integer.to_char_list/1/2` | `Integer.to_charlist/1` and `Integer.to_charlist/2` (v1.3)
[v1.5] | `Kernel.to_char_list/1` | `Kernel.to_charlist/1` (v1.3)
[v1.5] | `List.Chars.to_char_list/1` | `List.Chars.to_charlist/1` (v1.3)
[v1.5] | `@compile {:parse_transform, _}` in `Module` | *None*
[v1.5] | `Stream.filter_map/3` | `Stream.filter/2` + `Stream.map/2` (v1.0)
[v1.5] | `String.ljust/3` and `String.rjust/3` | Use `String.pad_leading/3` and `String.pad_trailing/3` with a binary padding (v1.3)
[v1.5] | `String.strip/1` and `String.strip/2` | `String.trim/1` and `String.trim/2` (v1.3)
[v1.5] | `String.lstrip/1` and `String.rstrip/1` | `String.trim_leading/1` and `String.trim_trailing/1` (v1.3)
[v1.5] | `String.lstrip/2` and `String.rstrip/2` | Use `String.trim_leading/2` and `String.trim_trailing/2` with a binary as second argument (v1.3)
[v1.5] | `String.strip/1` and `String.strip/2` | `String.trim/1` and `String.trim/2` (v1.3)
[v1.5] | `String.to_char_list/1` | `String.to_charlist/1` (v1.3)
[v1.4] | [Anonymous functions](`Kernel.SpecialForms.fn/1`) with no expression after `->` | Use an expression or explicitly return `nil` (v1.0)
[v1.4] | Support for making [private functions](`Kernel.defp/2`) overridable | Use [public functions](`Kernel.def/2`) (v1.0)
[v1.4] | Variable used as function call | Use parentheses (v1.0)
[v1.5] | `()` to mean `nil` | `nil` (v1.0)
[v1.5] | `char_list/0` type | `t:charlist/0` type (v1.3)
[v1.5] | `:char_lists` key in `t:Inspect.Opts.t/0` type | `:charlists` key (v1.3)
[v1.5] | `:as_char_lists` value in `t:Inspect.Opts.t/0` type | `:as_charlists` value (v1.3)
[v1.5] | `@compile {:parse_transform, _}` in `Module` | *None*
[v1.5] | EEx: `<%=` in middle and end expressions | Use `<%` (`<%=` is allowed only on start expressions) (v1.0)
[v1.4] | `Access.key/1` | `Access.key/2` (v1.3)
[v1.4] | `Behaviour` module | `@callback` module attribute (v1.0)
[v1.4] | `Enum.uniq/2` | `Enum.uniq_by/2` (v1.2)
@@ -138,27 +125,30 @@ Version | Deprecated feature | Replaced by (ava
[v1.4] | `Float.to_string/2` | `:erlang.float_to_binary/2` (Erlang/OTP 17)
[v1.4] | `HashDict` module | `Map` (v1.2)
[v1.4] | `HashSet` module | `MapSet` (v1.1)
[v1.4] | `IEx.Helpers.import_file/2` | `IEx.Helpers.import_file_if_available/1` (v1.3)
[v1.4] | `Mix.Utils.camelize/1` | `Macro.camelize/1` (v1.2)
[v1.4] | `Mix.Utils.underscore/1` | `Macro.underscore/1` (v1.2)
[v1.4] | Multi-letter aliases in `OptionParser` | Use single-letter aliases (v1.0)
[v1.4] | `Set` module | `MapSet` (v1.1)
[v1.4] | `Stream.uniq/2` | `Stream.uniq_by/2` (v1.2)
[v1.3] | `\x{X*}` inside strings/sigils/charlists | `\uXXXX` or `\u{X*}` (v1.1)
[v1.4] | `IEx.Helpers.import_file/2` | `IEx.Helpers.import_file_if_available/1` (v1.3)
[v1.4] | `Mix.Utils.camelize/1` | `Macro.camelize/1` (v1.2)
[v1.4] | `Mix.Utils.underscore/1` | `Macro.underscore/1` (v1.2)
[v1.4] | Variable used as function call | Use parentheses (v1.0)
[v1.4] | Anonymous functions with no expression after `->` | Use an expression or explicitly return `nil` (v1.0)
[v1.4] | Support for making private functions overridable | Use public functions (v1.0)
[v1.3] | `Dict` module | `Keyword` (v1.0) or `Map` (v1.2)
[v1.3] | `:append_first` option in `Kernel.defdelegate/2` | Define the function explicitly (v1.0)
[v1.3] | Map/dictionary as 2nd argument in `Enum.group_by/3` | `Enum.reduce/3` (v1.0)
[v1.3] | `Keyword.size/1` | `Kernel.length/1` (v1.0)
[v1.3] | `Map.size/1` | `Kernel.map_size/1` (v1.0)
[v1.3] | `/r` option in `Regex` | `/U` (v1.1)
[v1.3] | `Set` behaviour | `MapSet` data structure (v1.1)
[v1.3] | `String.valid_character?/1` | `String.valid?/1` (v1.0)
[v1.3] | `Task.find/2` | Use direct message matching (v1.0)
[v1.3] | `:append_first` option in `Kernel.defdelegate/2` | Define the function explicitly (v1.0)
[v1.3] | `/r` option in `Regex` | `/U` (v1.1)
[v1.3] | `\x{X*}` inside strings/sigils/charlists | `\uXXXX` or `\u{X*}` (v1.1)
[v1.3] | Map/dictionary as 2nd argument in `Enum.group_by/3` | `Enum.reduce/3` (v1.0)
[v1.3] | Non-map as 2nd argument in `URI.decode_query/2` | Use a map (v1.0)
[v1.2] | `Dict` behaviour | `MapSet` data structure (v1.1)
[v1.1] | `?\xHEX` | `0xHEX` (v1.0)
[v1.1] | `Access` protocol | `Access` behaviour (v1.1)
[v1.1] | `as: true \| false` in `alias/2` and `require/2` | *None*
[v1.1] | `?\xHEX` | `0xHEX` (v1.0)
[v1.1]: https://github.com/elixir-lang/elixir/blob/v1.1/CHANGELOG.md#4-deprecations
[v1.2]: https://github.com/elixir-lang/elixir/blob/v1.2/CHANGELOG.md#changelog-for-elixir-v12
@@ -169,4 +159,3 @@ Version | Deprecated feature | Replaced by (ava
[v1.7]: https://github.com/elixir-lang/elixir/blob/v1.7/CHANGELOG.md#4-hard-deprecations
[v1.8]: https://github.com/elixir-lang/elixir/blob/v1.8/CHANGELOG.md#4-hard-deprecations
[v1.9]: https://github.com/elixir-lang/elixir/blob/v1.9/CHANGELOG.md#4-hard-deprecations
[v1.10]: https://github.com/elixir-lang/elixir/blob/v1.10/CHANGELOG.md#4-hard-deprecations
+185
View File
@@ -0,0 +1,185 @@
# Guards
Guards are a way to augment pattern matching with more complex checks. They are allowed in a predefined set of constructs where pattern matching is allowed.
Not all expressions are allowed in guard clauses, but only a handful of them. This is a deliberate choice. This way, Elixir (and Erlang) can make sure that nothing bad happens while executing guards and no mutations happen anywhere. It also allows the compiler to optimize the code related to guards efficiently.
## List of allowed expressions
You can find the built-in list of guards [in the `Kernel` module](Kernel.html#guards). Here is an overview:
* comparison operators ([`==`](`==/2`), [`!=`](`!=/2`), [`===`](`===/2`), [`!==`](`!==/2`),
[`>`](`>/2`), [`>=`](`>=/2`), [`<`](`</2`), [`<=`](`<=/2`))
* strictly boolean operators ([`and`](`and/2`), [`or`](`or/2`), [`not`](`not/1`)). Note [`&&`](`&&/2`), [`||`](`||/2`), and [`!`](`!/1`) sibling operators are **not allowed** as they're not *strictly* boolean - meaning they don't require arguments to be booleans
* arithmetic unary and binary operators ([`+`](`+/1`), [`-`](`-/1`), [`+`](`+/2`), [`-`](`-/2`), [`*`](`*/2`), [`/`](`//2`))
* [`in`](`in/2`) and [`not in`](`in/2`) operators (as long as the right-hand side is a list or a range)
* "type-check" functions ([`is_list/1`](`is_list/1`), [`is_number/1`](`is_number/1`), etc.)
* functions that work on built-in datatypes ([`abs/1`](`abs/1`), [`map_size/1`](`map_size/1`), etc.)
The module `Bitwise` also includes a handful of [Erlang bitwise operations as guards](Bitwise.html#guards).
Macros constructed out of any combination of the above guards are also valid guards - for example, `Integer.is_even/1`. For more information, see the "Defining custom guard expressions" section shown below.
## Why guards
Let's see an example of a guard used in a function clause:
```elixir
def empty_map?(map) when map_size(map) == 0, do: true
def empty_map?(map) when is_map(map), do: false
```
Guards start with the `when` keyword, which is followed by a boolean expression (we will define the grammar of guards more formally later on).
Writing the `empty_map?/1` function by only using pattern matching would not be possible (as pattern matching on `%{}` would match *every* map, not empty maps).
## Where guards can be used
In the example above, we show how guards can be used in function clauses. There are several constructs that allow guards; for example:
* function clauses:
```elixir
def foo(term) when is_integer(term), do: term
def foo(term) when is_float(term), do: round(term)
```
* [`case`](`case/2`) expressions:
```elixir
case x do
1 -> :one
2 -> :two
n when is_integer(n) and n > 2 -> :larger_than_two
end
```
* anonymous functions ([`fn`](`fn/1`)s):
```elixir
larger_than_two? = fn
n when is_integer(n) and n > 2 -> true
n when is_integer(n) -> false
end
```
* custom guards can also be defined with `defguard/1` and `defguardp/1`.
A custom guard is always defined based on existing guards.
Other constructs are [`for`](`for/1`), [`with`](`with/1`), [`try/rescue/catch/else`](`try/1`), and the `match?/2`.
## Failing guards
In guards, when functions would normally raise exceptions, they cause the guard to fail instead.
For example, the `length/1` function only works with lists. If we use it with anything else, a runtime error is raised:
```elixir
iex> length("hello")
** (ArgumentError) argument error
```
However, when used in guards, the corresponding clause simply fails to match:
```elixir
iex> case "hello" do
...> something when length(something) > 0 ->
...> :length_worked
...> _anything_else ->
...> :length_failed
...> end
:length_failed
```
In many cases, we can take advantage of this. In the code above, we used `length/1` to both check that the given thing is a list *and* check some properties of its length (instead of using `is_list(something) and length(something) > 0`).
## Defining custom guard expressions
As mentioned before, only the expressions listed in this page are allowed in guards. However, we can take advantage of macros to write custom guards that can simplify our programs or make them more domain-specific. At the end of the day, what matters is that the *output* of the macros (which is what will be compiled) boils down to a combinations of the allowed expressions.
Let's look at a quick case study: we want to check that a function argument is an even or odd integer. With pattern matching, this is impossible to do since there are infinite integers, and thus we can't pattern match on the single even/odd numbers. Let's focus on checking for even numbers since checking for odd ones is almost identical.
Such a guard would look like this:
```elixir
def my_function(number) when is_integer(number) and rem(number, 2) == 0 do
# do stuff
end
```
This would be repetitive to write every time we need this check, so, as mentioned at the beginning of this section, we can abstract this away using a macro. Remember that defining a function that performs this check wouldn't work because we can't use custom functions in guards. Use `defguard` and `defguardp` to create guard macros. Here's an example:
```elixir
defmodule MyInteger do
defguard is_even(value) when is_integer(value) and rem(value, 2) == 0
end
```
and then:
```elixir
import MyInteger, only: [is_even: 1]
def my_function(number) when is_even(number) do
# do stuff
end
```
While it's possible to create custom guards with macros, it's recommended to define them using `defguard` and `defguardp` which perform additional compile-time checks.
## Multiple guards in the same clause
There exists an additional way to simplify a chain of `or`s in guards: Elixir supports writing "multiple guards" in the same clause. This:
```elixir
def foo(term) when is_integer(term) or is_float(term) or is_nil(term),
do: :maybe_number
def foo(_other),
do: :something_else
```
can be alternatively written as:
```elixir
def foo(term)
when is_integer(term)
when is_float(term)
when is_nil(term) do
:maybe_number
end
def foo(_other) do
:something_else
end
```
If each guard expression always returns a boolean, the two forms are equivalent. However, recall that if any function call in a guard raises an exception, the entire guard fails. So this function will not detect empty tuples:
```elixir
defmodule Check do
# If given a tuple, map_size/1 will raise, and tuple_size/1 will not be evaluated
def empty?(val) when map_size(val) == 0 or tuple_size(val) == 0, do: true
def empty?(_val), do: false
end
Check.empty?(%{}) #=> true
Check.empty?({}) #=> false # true was expected!
```
This could be corrected by ensuring that no exception is raised, either via type checks like `is_map(val) and map_size(val) == 0`, or by checking equality instead, like `val == %{}`.
It could also be corrected by using multiple guards, so that if an exception causes one guard to fail, the next one is evaluated.
```elixir
defmodule Check do
# If given a tuple, map_size/1 will raise, and the second guard will be evaluated
def empty?(val)
when map_size(val) == 0
when tuple_size(val) == 0,
do: true
def empty?(_val), do: false
end
Check.empty?(%{}) #=> true
Check.empty?({}) #=> true
```
+1 -29
View File
@@ -144,34 +144,6 @@ The application environment should be reserved only for configurations that are
For all remaining scenarios, libraries should not force their users to use the application environment for configuration. If the user of a library believes that certain parameter should be configured globally, then they can wrap the library functionality with their own application environment configuration.
### Avoid compile-time application configuration
Assuming you need to use the application configuration and you cannot avoid it as explained in the previous section, you should also avoid compile-time application configuration. For example, instead of doing this:
```elixir
@http_client Application.fetch_env!(:my_app, :http_client)
def request(path) do
@http_client.request(path)
end
```
you should do this:
```elixir
def request(path) do
http_client().request(path)
end
defp http_client() do
Application.fetch_env!(:my_app, :http_client)
end
```
That's because by reading the application in the module body and storing it in a module attribute, we are effectively reading the configuration at compile-time, which may become an issue when configuring the system later.
If, for some reason, you must read the application environment at compile time, use `Application.compile_env/2`. Read [the "Compile-time environment" section of the Application docs](Application.html#module-compile-time-environment) for more information.
### Avoid `use` when an `import` is enough
A library should not provide `use MyLib` functionality if all `use MyLib` does is to `import`/`alias` the module itself. For example, this is an anti-pattern:
@@ -230,7 +202,7 @@ When you absolutely have to use a macro, make sure that a macro is not the only
A developer must never use a process for code organization purposes. A process must be used to model runtime properties such as:
* Mutable state and access to shared resources (such as ETS, files, and others)
* Mutable state and access to shared resources (such as ETS, files, etc.)
* Concurrency and distribution
* Initialization, shutdown and restart logic (as seen in supervisors)
* System messages such as timer messages and monitoring events
+2 -2
View File
@@ -4,7 +4,7 @@ This document covers some naming conventions in Elixir code, from casing to punc
## Casing
Elixir developers must use `snake_case` when defining variables, function names, module attributes, and the like:
Elixir developers must use `snake_case` when defining variables, function names, module attributes, etc.:
some_map = %{this_is_a_key: "and a value"}
is_map(some_map)
@@ -65,7 +65,7 @@ The version without `!` is preferred when you want to handle different outcomes
{:error, reason} -> # handle the error caused by `reason`
end
However, if you expect the outcome to always to be successful (for instance, if you expect the file always to exist), the bang variation can be more convenient and will raise a more helpful error message (than a failed pattern match) on failure.
However, if you expect the outcome to always to be successful (e.g. if you expect the file always to exist), the bang variation can be more convenient and will raise a more helpful error message (than a failed pattern match) on failure.
More examples of paired functions: `Base.decode16/2` and `Base.decode16!/2`, `File.cwd/0` and `File.cwd!/0`.
-469
View File
@@ -1,469 +0,0 @@
# Patterns and Guards
Elixir provides pattern matching, which allows us to assert on the shape or extract values from data-structures. Patterns are often augmented with guards, which give developers the ability to perform more complex checks, albeit limited.
This page describes the semantics of patterns and guards, where they are all allowed, and how to extend them.
## Patterns
Patterns in Elixir are made of variables, literals, and data-structure specific syntax. One of the most used constructs to perform pattern matching is the match operator (`=`):
```iex
iex> x = 1
1
iex> 1 = x
1
```
In the example above, `x` starts without a value and has `1` assigned to it. Then, we compare the value of `x` to the literal `1`, which succeeds as they are both `1`.
Matching `x` against 2 would raise:
```iex
iex> 2 = x
** (MatchError) no match of right hand side value: 1
```
Patterns are not bidirectional. If you have a variable `y` that was never assigned to (often called an unbound variable) and you write `1 = y`, an error will be raised:
```iex
iex> 1 = y
** (CompileError) iex:2: undefined function y/0
```
In other words, patterns are allowed only on the left side of `=`. The right side of `=` follows the regular evaluation semantics of the language.
Now let's cover the pattern matching rules for each construct and then for each relevant data-types.
### Variables
Variables in patterns are always assigned to:
```iex
iex> x = 1
1
iex> x = 2
2
iex> x
2
```
In other words, Elixir supports rebinding. In case you don't want the value of a variable to change, you can use the pin operator (`^`):
```iex
iex> x = 1
1
iex> ^x = 2
** (MatchError) no match of right hand side value: 2
```
If the same variable appears twice in the same pattern, then they must be bound to the same value:
```iex
iex> {x, x} = {1, 1}
{1, 1}
iex> {x, x} = {1, 2}
** (MatchError) no match of right hand side value: {1, 2}
```
The underscore variable (`_`) has a special meaning as it can never be bound to any value. It is especially useful when you don't care about certain value in a pattern:
```iex
iex> {_, integer} = {:not_important, 1}
{:not_important, 1}
iex> integer
1
iex> _
** (CompileError) iex:3: invalid use of _
```
### Literals (numbers and atoms)
Atoms and numbers (integers and floats) can appear in patterns and they are always represented as is. For example, an atom will only match an atom if they are the same atom:
```iex
iex> :atom = :atom
:atotm
iex> :atom = :another_atom
** (MatchError) no match of right hand side value: :another_atom
```
Similar rule applies to numbers. Finally, note that numbers in patterns perform strict comparison. In other words, integers to do not match floats:
```iex
iex> 1 = 1.0
** (MatchError) no match of right hand side value: 1.0
```
### Tuples
Tuples may appear in patterns using the curly brackets syntax (`{}`). A tuple in a pattern will match only tuples of the same size, where each individual tuple element must also match:
```iex
iex> {:ok, integer} = {:ok, 13}
{:ok, 13}
# won't match due to different size
iex> {:ok, integer} = {:ok, 11, 13}
** (MatchError) no match of right hand side value: {:ok, 11, 13}
# won't match due to mismatch on first element
iex> {:ok, binary} = {:error, :enoent}
** (MatchError) no match of right hand side value: {:error, :enoent}
```
### Lists
Lists may appear in patterns using the square brackets syntax (`[]`). A list in a pattern will match only lists of the same size, where each individual list element must also match:
```iex
iex> [:ok, integer] = [:ok, 13]
[:ok, 13]
# won't match due to different size
iex> [:ok, integer] = [:ok, 11, 13]
** (MatchError) no match of right hand side value: [:ok, 11, 13]
# won't match due to mismatch on first element
iex> [:ok, binary] = [:error, :enoent]
** (MatchError) no match of right hand side value: [:error, :enoent]
```
Opposite to tuples, lists also allow matching on non-empty lists by using the `[head | tail]` notation, which matches on the `head` and `tail` of a list:
```iex
iex> [head | tail] = [1, 2, 3]
[1, 2, 3]
iex> head
1
iex> tail
[2, 3]
```
Multiple elements may prefix the `| tail` construct:
```iex
iex> [first, second | tail] = [1, 2, 3]
[1, 2, 3]
iex> tail
[3]
```
Note `[head | tail]` does not match empty lists:
```elixir
iex> [head | tail] = []
** (MatchError) no match of right hand side value: []
```
Given charlists are represented as a list of integers, one can also perform prefix matches on charlists using the list concatenation operator (`++`):
```elixir
iex> 'hello ' ++ world = 'hello world'
'hello world'
iex> world
'world'
```
Which is equivalent to matching on `[?h, ?e, ?l, ?l, ?o, ?\s | world]`. Suffix matches (`hello ++ ' world'`) are not valid patterns.
### Maps
Maps may appear in patterns using the percentage sign followed by the curly brackets syntax (`%{}`). Opposite to lists and tuples, maps perform a subset match. This means a map pattern will match any other map that has at least all of the keys in the pattern.
Here is an example where all keys match:
```iex
iex> %{name: name} = %{name: "meg"}
%{name: "meg"}
iex> name
"meg"
```
Here is when a subset of the keys match:
```iex
iex> %{name: name} = %{name: "meg", age: 23}
%{age: 23, name: "meg"}
iex> name
"meg"
```
If a key in the pattern is not available in the map, then they won't match:
```iex
iex> %{name: name, age: age} = %{name: "meg"}
** (MatchError) no match of right hand side value: %{name: "meg"}
```
Note that the empty map will match all maps, which is a contrast to tuples and lists, where an empty tuple or an empty list will only match empty tuples and empty lists respectively:
```iex
iex> %{} = %{name: "meg"}
%{name: "meg"}
```
Finally, note map keys in patterns must always be literals or previously bound variables matched with the pin operator.
### Binaries
Binaries may appear in patterns using the double less-than/greater-than syntax (`<<>>`). A binary in a pattern can match multiple segments at the same, each with different type, size, and unit:
```iex
iex> <<val::unit(8)-size(2)-integer>> = <<123, 56>>
"{8"
iex> val
31544
```
See the documentation for `<<>>` for a complete definition of pattern matching for binaries.
Finally, remember that strings in Elixir are UTF-8 encoded binaries. This means that, similar to charlists, prefix matches on strings are also possible with the binary concatenation operator (`<>`):
```elixir
iex> "hello " <> world = "hello world"
"hello world"
iex> world
"world"
```
Suffix matches (`hello <> " world"`) are not valid patterns.
## Guards
Guards are a way to augment pattern matching with more complex checks. They are allowed in a predefined set of constructs where pattern matching is allowed, such as function definitions, case clauses, and ohers.
Not all expressions are allowed in guard clauses, but only a handful of them. This is a deliberate choice. This way, Elixir (and Erlang) can make sure that nothing bad happens while executing guards and no mutations happen anywhere. It also allows the compiler to optimize the code related to guards efficiently.
### List of allowed functions and operators
You can find the built-in list of guards [in the `Kernel` module](Kernel.html#guards). Here is an overview:
* comparison operators ([`==`](`==/2`), [`!=`](`!=/2`), [`===`](`===/2`), [`!==`](`!==/2`),
[`<`](`</2`), [`<=`](`<=/2`), [`>`](`>/2`), [`>=`](`>=/2`))
* strictly boolean operators ([`and`](`and/2`), [`or`](`or/2`), [`not`](`not/1`)). Note [`&&`](`&&/2`), [`||`](`||/2`), and [`!`](`!/1`) sibling operators are **not allowed** as they're not *strictly* boolean - meaning they don't require arguments to be booleans
* arithmetic unary operators ([`+`](`+/1`), [`-`](`-/1`))
* arithmetic binary operators [`+`](`+/2`), [`-`](`-/2`), [`*`](`*/2`), [`/`](`//2`))
* [`in`](`in/2`) and [`not in`](`in/2`) operators (as long as the right-hand side is a list or a range)
* "type-check" functions (`is_list/1`, `is_number/1`, and the like)
* functions that work on built-in datatypes (`abs/1`, `hd/1`, `map_size/1`, and others)
The module `Bitwise` also includes a handful of [Erlang bitwise operations as guards](Bitwise.html#guards).
Macros constructed out of any combination of the above guards are also valid guards - for example, `Integer.is_even/1`. For more information, see the "Defining custom guard expressions" section shown below.
### Why guards
Let's see an example of a guard used in a function clause:
```elixir
def empty_map?(map) when map_size(map) == 0, do: true
def empty_map?(map) when is_map(map), do: false
```
Guards start with the `when` operator, followed by a guard expression. The clause will be executed if and only if the guard expression returns `true`. Multiple boolean conditions can be combined with the [`and`](`and/2`) and [`or`](`or/2`) operators.
Writing the `empty_map?/1` function by only using pattern matching would not be possible (as pattern matching on `%{}` would match *any* map, not only the empty ones).
### Failing guards
A function clause will be executed if and only if its guard expression evaluates to `true`. If any other value is returned, the function clause will be skipped. In particular, guards have no concept of "truthy" or "falsey".
For example, imagine a function that checks that the head of a list is not `nil`:
```elixir
def not_nil_head?([head | _]) when head, do: true
def not_nil_head?(_), do: false
not_nil_head?(["some_value", "another_value"])
#=> false
```
Even though the head of the list is not `nil`, the first clause for `not_nil_head?/1` fails because the expression does not evaluate to `true`, but to `"some_value"`, therefore triggering the second clause which returns `false`. To make the guard behave correctly, you must ensure that the guard evaluates to `true`, like so:
```elixir
def not_nil_head?(term) when head != nil, do: true
def not_nil_head?(_), do: false
not_nil_head?(["some_value", "another_value"])
#=> true
```
### Errors in guards
In guards, when functions would normally raise exceptions, they cause the guard to fail instead.
For example, the `tuple_size/1` function only works with tuples. If we use it with anything else, an argument error is raised:
```elixir
iex> tuple_size("hello")
** (ArgumentError) argument error
```
However, when used in guards, the corresponding clause will fail to match instead of raising an error:
```elixir
iex> case "hello" do
...> something when tuple_size(something) == 2 ->
...> :worked
...> _anything_else ->
...> :failed
...> end
:worked
```
In many cases, we can take advantage of this. In the code above, we used `tuple_size/1` to both check that the given value is a tuple *and* check its size (instead of using `is_tuple(something) and tuple_size(something) == 2`).
However, if your guard has multiple conditions, such as checking for tuples or maps, it is best to call type-check functions like `is_tuple/1` before `tuple_size/1`, otherwise the whole guard will fail if a tuple is not given. Alternatively your function clause can use multiple guards as shown in the following section.
### Multiple guards in the same clause
There exists an additional way to simplify a chain of `or` expressions in guards: Elixir supports writing "multiple guards" in the same clause. The following code:
```elixir
def is_number_or_nil(term) when is_integer(term) or is_float(term) or is_nil(term),
do: :maybe_number
def is_number_or_nil(_other),
do: :something_else
```
can be alternatively written as:
```elixir
def is_number_or_nil(term)
when is_integer(term)
when is_float(term)
when is_nil(term) do
:maybe_number
end
def is_number_or_nil(_other) do
:something_else
end
```
If each guard expression always returns a boolean, the two forms are equivalent. However, recall that if any function call in a guard raises an exception, the entire guard fails. To illustrate this, the following function will not detect empty tuples:
```elixir
defmodule Check do
# If given a tuple, map_size/1 will raise, and tuple_size/1 will not be evaluated
def empty?(val) when map_size(val) == 0 or tuple_size(val) == 0, do: true
def empty?(_val), do: false
end
Check.empty?(%{})
#=> true
Check.empty?({})
#=> false # true was expected!
```
This could be corrected by ensuring that no exception is raised, either via type checks like `is_map(val) and map_size(val) == 0`, or by using multiple guards, so that if an exception causes one guard to fail, the next one is evaluated.
```elixir
defmodule Check do
# If given a tuple, map_size/1 will raise, and the second guard will be evaluated
def empty?(val)
when map_size(val) == 0
when tuple_size(val) == 0,
do: true
def empty?(_val), do: false
end
Check.empty?(%{})
#=> true
Check.empty?({})
#=> true
```
## Where patterns and guards can be used
In the examples above, we have used the match operator (`=`) and function clauses to showcase patterns and guards respectively. Here is the list of the built-in constructs in Elixir that support patterns and guards.
* the match operator (`=`) (exceptionally does not support guards):
```elixir
{:ok, binary} = File.read("some/file")
```
* `match?/2`:
```elixir
match?({:ok, value} when value > 0, {:ok, 13})
```
* function clauses:
```elixir
def type(term) when is_integer(term), do: :integer
def type(term) when is_float(term), do: :float
```
* [`case`](`case/2`) expressions:
```elixir
case x do
1 -> :one
2 -> :two
n when is_integer(n) and n > 2 -> :larger_than_two
end
```
* anonymous functions (`fn/1`):
```elixir
larger_than_two? = fn
n when is_integer(n) and n > 2 -> true
n when is_integer(n) -> false
end
```
* [`for`](`for/1`) and [`with`](`with/1`) support patterns and guards on the left side of `<-`:
```elixir
for x when x >= 0 <- [1, -2, 3, -4], do: x
```
`with` also supports the `else` keyword, which supports patterns matching and guards.
* [`try`](`try/1`) supports patterns and guards on `catch` and `else`
* custom guards can also be defined with `defguard/1` and `defguardp/1`. A custom guard can only be defined based on existing guards.
## Custom patterns and guards expressions
Only the constructs listed in this page are allowed in patterns and guards. However, we can take advantage of macros to write custom patterns guards that can simplify our programs or make them more domain-specific. At the end of the day, what matters is that the *output* of the macros boils down to a combination of the constructs above.
For example, the `Record` module in Elixir provides a series of macros to be used in patterns and guards that allows tuples to have named fields during compilation.
For defining your own guards, Elixir even provides conveniences in `defguard` and `defguardp`. Let's look at a quick case study: we want to check whether an argument is an even or an odd integer. With pattern matching this is impossible because there is an infinite number of integers, and therefore we can't pattern match on every single one of them. Therefore we must use guards. We will just focus on checking for even numbers since checking for the odd ones is almost identical.
Such a guard would look like this:
```elixir
def my_function(number) when is_integer(number) and rem(number, 2) == 0 do
# do stuff
end
```
It would be repetitive to write every time we need this check. Instead you can use `defguard/1` and `defguardp/1` to create guard macros. Here's an example how:
```elixir
defmodule MyInteger do
defguard is_even(term) when is_integer(term) and rem(term, 2) == 0
end
```
and then:
```elixir
import MyInteger, only: [is_even: 1]
def my_function(number) when is_even(number) do
# do stuff
end
```
While it's possible to create custom guards with macros, it's recommended to define them using `defguard/1` and `defguardp/1` which perform additional compile-time checks.
+2 -2
View File
@@ -173,7 +173,7 @@ If the sigil letter is in uppercase, no interpolation is allowed in the sigil, o
~S/f#{"o"}o/
```
Sigils are useful to encode text with their own escaping rules, such as regular expressions, datetimes, and others.
Sigils are useful to encode text with their own escaping rules, such as regular expressions, datetimes, etc.
## The Elixir AST
@@ -221,7 +221,7 @@ end
You can see that variables are also represented with a tuple, except the third element is an atom expressing the variable context.
Over the course of this section, we will explore many Elixir syntax constructs alongside their AST representations.
Over the next section, we will explore many of Elixir syntax constructs alongside their AST representation.
### Operators

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