Module-level default, no more compat!

Author: BioTurboNick

Project.toml

@@ -1,19 +1,12 @@
 name = "OverflowContexts"
 uuid = "649716ba-0eb1-4560-ace2-251185f55281"
 authors = ["Nicholas Bauer <[email protected]>"]
-version = "0.1.0"
-
-[deps]
-Requires = "ae029012-a4dd-5104-9daa-d747884805df"
+version = "0.2.0"
 
 [compat]
 julia = "1.6"
-Requires = "1.1.3"
 
 [extras]
-Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
-Revise = "295af30f-e4ad-537b-8983-00126c2a3abe"
-SHA = "ea8e919c-243c-51af-8825-aaa63cd721ce"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]

README.md

@@ -1,26 +1,20 @@
 # OverflowContexts.jl
 
 This package conceptually extends `CheckedArithmetic.jl` to provide the following overall features:
-1. Ability to set the global default to overflow-checked or overflow-permissive operations.
+1. Ability to set a Module-level default to overflow-checked or overflow-permissive operations.
 2. Ability to specify whether a block of code should use overflow-checked or overflow-permissive operations regardless of the default.
 
 Together, these provide checked and unchecked contexts, as in other languages like C#:
 https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/checked-and-unchecked
 
-It's important to know how these interact with Julia. When you set a default through `@default_checked` and `@default_unchecked`, the function definitions
-for the `+`, `-`, and `*` operators, and `abs` function, are being redirected. As those methods are new, all methods that are eligible for being recompiled will do so to
-incorporate the new method definitions. Some methods may not be recompiled, and may not adopt the new methods. This may also cause a long delay when running
-code the first time after these are set. Thus, I recommended that you only rarely change the default context.
+`@default_checked` and `@default_unchecked` create shadow copies of the `+`, `-`, `*`, and `abs` functions that redirect to overflow-checked
+or overflow-permissive operations, respectively, within the module it was executed in. All non-integer arguments are passed through to their
+respective Base methods.
 
-The expression-level `@checked` and `@unchecked` work by rewriting the `+`, `-`, and `*` operators, and `abs` function, to methods specific to the checked or permissive operation, and thus are not affected by switching the default.
-
-**NOTE:** If you set `@default_checked`, some operations that expect the Julia default of unchecked arithmetic may not work. Particularly hash functions.
-I've included here a number of such core Julia functions and applied the `@unchecked` macro to them so that they still work. If you encouter an error in
-Julia running in a checked context, please report it as an Issue to this repository so the function can be included here. If the error is in a package,
-you may need to provide your own patch locally. Unless it is a commonly used package, in which case I can conditionally load it here.
-
-Ideally, if this model were to be adopted by Julia itself, such packages could be updated to include functions annotated with `@unchecked` for compatibility
-with the default set to do overflow checking.
+The expression-level `@checked` and `@unchecked` rewrite instances of `+`, `-`, and `*`, and `abs` functions, to functions specific to the
+checked or permissive operation, and thus are not affected by switching the default. Symbols for the functions will also be replaced, to support
+calls like `foldl(+, v)`. If these macros are nested, the lowest level takes precedence so that an unchecked context can be nested inside a checked
+context and vice versa.
 
 ```julia
 using OverflowContexts

src/OverflowContexts.jl

@@ -1,17 +1,8 @@
 module OverflowContexts
 __precompile__(false)
 
-using Requires
-
 include("macros.jl")
 include("base_ext.jl")
-include("unchecked_compat.jl")
-
-function __init__()
-    @require SHA = "ea8e919c-243c-51af-8825-aaa63cd721ce" include("SHA_compat.jl")
-    @require Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c" include("Random_compat.jl")
-    @require Revise = "295af30f-e4ad-537b-8983-00126c2a3abe" include("Revise_compat.jl")
-end
 
 export @default_checked, @default_unchecked, @checked, @unchecked,
     unchecked_neg, unchecked_add, unchecked_sub, unchecked_mul, unchecked_negsub, unchecked_abs,