replace some environment constants with functions

kaikalii · kaikalii · commit af4426a5336d · 2025-04-24T16:54:53.000-07:00
diff --git a/changelog.md b/changelog.md
@@ -24,6 +24,10 @@ This version is not yet released. If you are reading this on the website, then t
 - Add the [`pretty`](https://uiua.org/docs/pretty) function, which gives the string representation of an array's pretty-printed output
 - Add numeric subscripts for [`length ⧻`](https://uiua.org/docs/length) to get the length of a specific axis
 - Add numeric subscripts for [`shape △`](https://uiua.org/docs/shape) to get the shape of the first few axes
+- Deprecate various environment-relate constants and replace them with noadic functions
+  - This prevents the details of the compiling environment being used instead of the details from the actual running environment
+  - Deprecrated: `Os`, `Family`, `Arch`, `ExeExt`, `DllExt`, `Sep`, `NumProcs`
+  - Replacements: `os`, `osfamily`, `arch`, `exeext`, `dllext`, `pathsep`, `numprocs`
 - Add experimental [`progressive indexof ⊘`](https://uiua.org/docs/progressiveindexof) for finding sequential indices of each row of an array in another
 - Add experimental [lexical ordering](https://uiua.org/docs/experimental#lexical-ordering) syntax
   - This enables some function packs and array notation to execute in the order they are normally read
diff --git a/site/primitives.json b/site/primitives.json
@@ -358,6 +358,12 @@
     "class": "InversionModifier",
     "description": "Invert the behavior of a function, treating its first argument as a constant"
   },
+  "arch": {
+    "args": 0,
+    "outputs": 1,
+    "class": "Environment",
+    "description": "Get the current architecture"
+  },
   "assert": {
     "glyph": "⍤",
     "args": 2,
@@ -368,7 +374,7 @@
   "astar": {
     "outputs": 2,
     "modifier_args": 3,
-    "class": "Misc",
+    "class": "Algorithm",
     "description": "Find shortest paths in a graph",
     "deprecated": true
   },
@@ -452,7 +458,7 @@
   "bytes": {
     "args": 2,
     "outputs": 1,
-    "class": "Misc",
+    "class": "Encoding",
     "description": "Convert a value to a byte representation",
     "experimental": true
   },
@@ -513,7 +519,7 @@
   "datetime": {
     "args": 1,
     "outputs": 1,
-    "class": "Misc",
+    "class": "Time",
     "description": "Get the date and time information from a time"
   },
   "deduplicate": {
@@ -527,7 +533,7 @@
     "glyph": "∂",
     "outputs": 1,
     "modifier_args": 1,
-    "class": "Misc",
+    "class": "Algorithm",
     "description": "Calculate the derivative of a mathematical expression",
     "experimental": true
   },
@@ -553,6 +559,12 @@
     "class": "DyadicPervasive",
     "description": "Divide values"
   },
+  "dllext": {
+    "args": 0,
+    "outputs": 1,
+    "class": "Environment",
+    "description": "Get the DLL extension for the current platform"
+  },
   "do": {
     "glyph": "⍢",
     "outputs": 1,
@@ -603,6 +615,12 @@
     "class": "Constant",
     "description": "The number of radians in a quarter circle"
   },
+  "exeext": {
+    "args": 0,
+    "outputs": 1,
+    "class": "Environment",
+    "description": "Get the executable extension for the current platform"
+  },
   "fall": {
     "glyph": "⍖",
     "args": 1,
@@ -613,7 +631,7 @@
   "fft": {
     "args": 1,
     "outputs": 1,
-    "class": "Misc",
+    "class": "Algorithm",
     "description": "Run the Fast Fourier Transform on an array",
     "experimental": true
   },
@@ -684,7 +702,7 @@
   "gen": {
     "args": 2,
     "outputs": 1,
-    "class": "Misc",
+    "class": "RNG",
     "description": "Generate an array of random numbers with a seed"
   },
   "get": {
@@ -771,7 +789,7 @@
     "glyph": "∫",
     "outputs": 1,
     "modifier_args": 1,
-    "class": "Misc",
+    "class": "Algorithm",
     "description": "Calculate an antiderivative of a mathematical expression",
     "experimental": true
   },
@@ -813,7 +831,7 @@
     "args": 2,
     "outputs": 1,
     "class": "Encoding",
-    "description": "Render text into an image array",
+    "description": "Get the current Render text into an image array",
     "experimental": true
   },
   "length": {
@@ -933,9 +951,15 @@
   "now": {
     "args": 0,
     "outputs": 1,
-    "class": "Misc",
+    "class": "Time",
     "description": "Get the current time in seconds"
   },
+  "numprocs": {
+    "args": 0,
+    "outputs": 1,
+    "class": "Environment",
+    "description": "Get the number of processors on the current system"
+  },
   "obverse": {
     "glyph": "⌅",
     "outputs": 1,
@@ -980,6 +1004,18 @@
     "class": "DyadicArray",
     "description": "Change the order of the axes of an array"
   },
+  "os": {
+    "args": 0,
+    "outputs": 1,
+    "class": "Environment",
+    "description": "Get the current operating system"
+  },
+  "osfamily": {
+    "args": 0,
+    "outputs": 1,
+    "class": "Environment",
+    "description": "Get the current operating system family"
+  },
   "over": {
     "glyph": ",",
     "args": 2,
@@ -992,7 +1028,7 @@
     "glyph": "⋕",
     "args": 1,
     "outputs": 1,
-    "class": "Misc",
+    "class": "Encoding",
     "description": "Parse a string as a number"
   },
   "partition": {
@@ -1006,9 +1042,15 @@
   "path": {
     "outputs": 2,
     "modifier_args": 2,
-    "class": "Misc",
+    "class": "Algorithm",
     "description": "Find the shortest path between two things"
   },
+  "pathsep": {
+    "args": 0,
+    "outputs": 1,
+    "class": "Environment",
+    "description": "Get the primary path separator for the current platform"
+  },
   "pi": {
     "glyph": "π",
     "args": 0,
@@ -1069,7 +1111,7 @@
     "glyph": "⚂",
     "args": 0,
     "outputs": 1,
-    "class": "Misc",
+    "class": "RNG",
     "description": "Generate a random number in the range [0, 1)"
   },
   "range": {
@@ -1103,7 +1145,7 @@
   "regex": {
     "args": 2,
     "outputs": 1,
-    "class": "Misc",
+    "class": "Algorithm",
     "description": "Match a regex pattern"
   },
   "remove": {
@@ -1322,7 +1364,7 @@
   "timezone": {
     "args": 0,
     "outputs": 1,
-    "class": "Misc",
+    "class": "Time",
     "description": "Get the local timezone offset"
   },
   "trace": {
diff --git a/site/src/docs.rs b/site/src/docs.rs
@@ -482,6 +482,10 @@ impl Allowed {
                 PrimClass::Thread => "threads",
                 PrimClass::Map => "map-functions",
                 PrimClass::Encoding => "encoding",
+                PrimClass::Algorithm => "algorithms",
+                PrimClass::Rng => "rng",
+                PrimClass::Time => "time",
+                PrimClass::Environment => "environment",
                 PrimClass::Misc => "misc-functions",
                 PrimClass::Sys(_) => "system-functions",
             };
@@ -560,6 +564,10 @@ impl Allowed {
                 PrimClass::Thread => ("Thread".into_view(), "Work with OS threads"),
                 PrimClass::Map => ("Map".into_view(), "Use arrays as hash maps"),
                 PrimClass::Encoding => ("Encoding".into_view(), "Convert to and from different encodings"),
+                PrimClass::Algorithm => ("Algorithms".into_view(), "Useful, specific algorithms"),
+                PrimClass::Rng => ("Random Number Generation".into_view(), "Generate random numbers"),
+                PrimClass::Time => ("Time".into_view(), "Work with time"),
+                PrimClass::Environment => ("Environment".into_view(), "Get information about the environment"),
                 PrimClass::Misc => ("Miscellaneous".into_view(), ""),
                 PrimClass::Sys(class) => {
                     match class {
diff --git a/site/src/other.rs b/site/src/other.rs
@@ -1,5 +1,3 @@
-use std::collections::BTreeMap;
-
 use leptos::*;
 use leptos_meta::*;
 use uiua::{ConstClass, Primitive, SysOp, CONSTANTS};
@@ -151,17 +149,6 @@ pub fn RightToLeft() -> impl IntoView {
 pub fn Constants() -> impl IntoView {
     use ConstClass::*;
     use Primitive::*;
-    let mut by_class: BTreeMap<ConstClass, Vec<View>> = BTreeMap::new();
-    for con in CONSTANTS.iter().filter(|con| !con.doc.trim().is_empty()) {
-        let view = view!(<tr>
-            <td><Const con=con/></td>
-            <td><div class="const-desc">{
-                doc_line_fragments_to_view(&con.doc_frags())
-            }</div></td>
-        </tr>)
-        .into_view();
-        by_class.entry(con.class).or_default().push(view);
-    }
     let class_cols = [
         vec![Math, Time, Color, Flags],
         vec![External, Media, Spatial, System, Fun],
@@ -171,8 +158,13 @@ pub fn Constants() -> impl IntoView {
         for class in col_classes {
             let mut rows = Vec::new();
             for con in CONSTANTS.iter().filter(|con| con.class == class) {
+                let style = if con.is_deprecated() {
+                    "text-decoration: line-through;"
+                } else {
+                    ""
+                };
                 let view = view!(<tr>
-                    <td><Const con=con/></td>
+                    <td><div style=style><Const con=con/></div></td>
                     <td><div class="const-desc">{
                         doc_line_fragments_to_view(&con.doc_frags())
                     }</div></td>
diff --git a/src/compile/mod.rs b/src/compile/mod.rs
@@ -74,6 +74,8 @@ pub struct Compiler {
     errors: Vec<UiuaError>,
     /// Primitives that have emitted errors because they are deprecated
     deprecated_prim_errors: HashSet<Primitive>,
+    /// Constants that have emitted errors because they are deprecated
+    deprecated_const_errors: HashSet<&'static str>,
     /// Accumulated diagnostics
     diagnostics: BTreeSet<Diagnostic>,
     /// Print diagnostics as they are encountered
@@ -107,6 +109,7 @@ impl Default for Compiler {
             in_try: false,
             errors: Vec::new(),
             deprecated_prim_errors: HashSet::new(),
+            deprecated_const_errors: HashSet::new(),
             diagnostics: BTreeSet::new(),
             print_diagnostics: false,
             comptime: true,
@@ -1825,6 +1828,20 @@ code:
             Ok(self.global_index(local.index, true, span))
         } else if let Some(constant) = CONSTANTS.iter().find(|c| c.name == ident) {
             // Name is a built-in constant
+            if let Some(suggestion) = constant.deprecation {
+                if self.deprecated_const_errors.insert(constant.name) {
+                    let suggestion = if suggestion.is_empty() {
+                        String::new()
+                    } else {
+                        format!(". {suggestion}")
+                    };
+                    let message = format!(
+                        "{} is deprecated and will be removed in a future version{}",
+                        constant.name, suggestion
+                    );
+                    self.emit_diagnostic(message, DiagnosticKind::Warning, span.clone());
+                }
+            }
             self.code_meta
                 .constant_references
                 .insert(span.clone().sp(ident));
diff --git a/src/constant.rs b/src/constant.rs
@@ -22,6 +22,8 @@ pub struct ConstantDef {
     pub value: Lazy<ConstantValue>,
     /// The constant's documentation
     pub doc: Lazy<String>,
+    /// The suggested replacement because of deprecation
+    pub deprecation: Option<&'static str>,
 }
 
 impl ConstantDef {
@@ -33,6 +35,10 @@ impl ConstantDef {
     pub fn doc_frags(&self) -> Vec<PrimDocFragment> {
         parse_doc_line_fragments(self.doc())
     }
+    /// Check if the constant is deprecated
+    pub fn is_deprecated(&self) -> bool {
+        self.deprecation.is_some()
+    }
 }
 
 /// The value of a shadowable constant
@@ -101,7 +107,16 @@ where
 }
 
 macro_rules! constant {
-    ($($(#[doc = $doc:literal])+ ($(#[$attr:meta])* $name:literal, $class:ident, $value:expr)),* $(,)?) => {
+    ($(
+        $(#[doc = $doc:literal])+
+        (
+            $(#[$attr:meta])*
+            $name:literal,
+            $class:ident,
+            $value:expr
+            $(, deprecated($deprecation:literal))?
+        )
+    ),* $(,)?) => {
         const COUNT: usize = {
             let mut count = 0;
             $(
@@ -114,6 +129,7 @@ macro_rules! constant {
             count
         };
         /// The list of all shadowable constants
+        #[allow(path_statements)]
         pub static CONSTANTS: [ConstantDef; COUNT] =
             [$(
                 $(#[$attr])*
@@ -130,6 +146,7 @@ macro_rules! constant {
                         s.pop();
                         s
                     }),
+                    deprecation: { None::<&'static str> $(; Some($deprecation))? }
                 },
             )*];
     };
@@ -185,17 +202,17 @@ constant!(
         [0, 1, -1], [1, 0, -1], [0, -1, -1], [-1, 0, -1]
     ]),
     /// A string identifying the operating system
-    ("Os", System, std::env::consts::OS),
+    ("Os", System, std::env::consts::OS, deprecated("Use the os function instead")),
     /// A string identifying family of the operating system
-    ("Family", System, std::env::consts::FAMILY),
+    ("Family", System, std::env::consts::FAMILY, deprecated("Use the osfamily function instead")),
     /// A string identifying the architecture of the CPU
-    ("Arch", System, std::env::consts::ARCH),
+    ("Arch", System, std::env::consts::ARCH, deprecated("Use the arch function instead")),
     /// The executable file extension
-    ("ExeExt", System, std::env::consts::EXE_EXTENSION),
+    ("ExeExt", System, std::env::consts::EXE_EXTENSION, deprecated("Use the exeext function instead")),
     /// The file extension for shared libraries
-    ("DllExt", System, std::env::consts::DLL_EXTENSION),
+    ("DllExt", System, std::env::consts::DLL_EXTENSION, deprecated("Use the dllext function instead")),
     /// The primary path separator character
-    ("Sep", System, std::path::MAIN_SEPARATOR),
+    ("Sep", System, std::path::MAIN_SEPARATOR, deprecated("Use the pathsep function instead")),
     /// The path of the current source file relative to `WorkingDir`
     ("ThisFile", System, ConstantValue::ThisFile),
     /// The name of the current source file
@@ -205,7 +222,7 @@ constant!(
     /// The compile-time working directory
     ("WorkingDir", System, ConstantValue::WorkingDir),
     /// The number of processors available
-    ("NumProcs", System, num_cpus::get() as f64),
+    ("NumProcs", System, num_cpus::get() as f64, deprecated("Use the numprocs function instead")),
     /// A boolean `true` value for use in `json`
     ("True", External, Array::json_bool(true)),
     /// A boolean `false` value for use in `json`
diff --git a/src/primitive/defs.rs b/src/primitive/defs.rs
diff --git a/src/primitive/mod.rs b/src/primitive/mod.rs
diff --git a/tests/units.ua b/tests/units.ua
