Merge pull request #11 from rm-dr/dev

Version bump to v1.1.5

.gitignore

@@ -1,4 +1,3 @@
 /target
 /src/target
 /pkg
-/result

CONTRIBUTING.MD

@@ -1,32 +0,0 @@
-# Contribution guidelines for Daisy
-
-
-## Pull requests
-All PRs should merge to `dev`. See "branching" below.
-
-
-## Versioning
-Daisy uses [semantic versioning](https://semver.org/), which looks like `maj.min.patch`. In short:
- - `maj`: Incremented on large, incompatible changes
- - `min`: Incremented on new features
- - `patch`: Incremented on bugfixes
-
-Whenever one of the above fields is incremented, all sub-fields are reset to zero. When `min` is incremented, `patch` is set to zero.
-
-
-## Branching
-Daisy uses a branch model much like the one described [here](https://nvie.com/posts/a-successful-git-branching-model).
- - `master`: 1 commit = 1 release. This is always a merge comit from `dev`, and is always tagged with a version.
- - `dev`: main development branch. Never deleted. Most work happens here.
- - `features`: temporary branches pulled from `dev` and merged to `dev` for larger features.
- - Always merge with git's `--no-ff` option for a more detailed history.
-
-
-## Releases
-What to do 
- - Merge into `master` (`git merge --no-ff dev`)
- - Tag merge commit on `master` (`git tag -a v1.0.0 -m "Version 1.0.0"`)
- - `cargo publish`
- - Update web demo & pull server (`make docker`)
- - Update aur package
- - Update `default.nix` (test with `make nix`)

Cargo.lock

@@ -28,7 +28,7 @@ checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
 
 [[package]]
 name = "daisycalc"
-version = "1.1.7"
+version = "1.1.5"
 dependencies = [
  "cfg-if",
  "num",

Cargo.toml

@@ -1,10 +1,10 @@
 [package]
 name = "daisycalc"
-version = "1.1.7"
+version = "1.1.5"
 edition = "2021"
 build = "buildscript/main.rs"
 license = "GPL-3.0-only"
-description = "A pretty TUI scientific calculator."
+description = "A high-precision terminal scientific calculator."
 repository = "https://git.betalupi.com/Mark/daisy"
 homepage = "https://git.betalupi.com/Mark/daisy"
 readme = "README.md"

Makefile

@@ -1,9 +1,6 @@
 release:
 	cargo build --release
 
-nix:
-	nix-build -E 'let pkgs = import <nixpkgs> { }; in pkgs.callPackage ./default.nix {}'
-
 test:
 	cargo test
 

README.md

@@ -1,31 +1,19 @@
 ![](./server/site/resources/readme-banner.png)
 
-A pretty, general-purpose scientific calculator with support for units, derivatives, and more.
+A high-precision scientific calculator with support for units, derivatives, and more.
 
 Many features are missing, this is still under development.
 
 **Web demo: [here](https://daisy.betalupi.com) (won't work on mobile)**
 
 # 📦 Installation
- - **From source:** `cargo build --release`, binary will be at `./target/release/daisy`
  - **Cargo:** `cargo install daisycalc`
  - **Arch:** `yay -S daisy`
  - **Debian:** coming soon
- - **Nix:** Use `default.nix`. Daisy isn't in nixpkgs yet, you'll need to add something like the following to `configuration.nix`:
 
-```nix
-let
-  daisy = builtins.fetchGit {
-    url = "https://github.com/rm-dr/daisy.git";
-    ref = "master";
-  } + /default.nix;
-in
-{
-  environment.systemPackages = with pkgs; [
-    (callPackage daisy { })
-  ];
-}
-```
+From source: `cargo build --release` \
+Binary will be in `target/release/daisy`
+
 
 # 📹 Screenshot
 
@@ -33,7 +21,9 @@ in
 
 # 🛠️ Features
  - Open-source
- - Carefully designed and easy-to-read prompt
+ - Extremely high precision
+   - Uses a rational datatype when possible, and a high-precision float when not.
+ - Pretty printing in prompt (with special substitutions)
  - Supports many physical units, with metric and binary prefixes
  - Supports exponential notation
  - Clear syntax, parsed input is always re-printed as a sanity check.
@@ -75,10 +65,6 @@ Daisy instead provides four functions (`fromCelsius`, `toCelsius`, `fromFahrenhe
  - "from" functions take a scalar and return a value in Kelvin: `fromCelsius(0) = 273.15K`
  - "to" functions take a value in Kelvin and return a scalar: `toCelsius(273.15 K) = 0`
 
-Functions `FtoC` and `CtoF` are also provided:
- - `FtoC(x) = toCelsius(fromFahrenheit(x))`
- - `CtoF(x) = toFahrenheit(fromCelsius(x))`
-
 
 ## Multiplication Order
 

TODO.md

@@ -1,3 +1,18 @@
+## Version Bump checklist
+ - update Cargo.toml
+ - run cargo test
+ - commit
+ - push
+ - merge
+ - git tag -a v1.0.0 -m "Version 1.0.0" on merge commit
+ - cargo publish
+ - Build wasm & push changes
+ - Update AUR package
+
+## Pre-release
+ - Tuple operations
+ - we don't need vectors as arguments to operators
+
 ## Parser
  - Should functions be operators?
  - Binary, hex, octal numbers
@@ -10,7 +25,6 @@
  - Non-recursive treeify
  - Faster factorial function. Maybe use gamma instead?
  - Arbitrary precision floats
- - we don't need vectors as arguments to operators
 
 ## Math Features
  - Mean, Median, Min
@@ -19,9 +33,6 @@
  - acot/acoth functions
  - Sums and products with functional arguments
  - Add functions: gcd, inverse mod, dice
- - Tuple operations
- - Number theory: select a group, inverses, etc
- - Negative mod
 
 ## Prompt
  - Fix terminal color detection
@@ -35,5 +46,5 @@
  - long prefixes (megatonne, etc)
  - HMS for degrees
  - Exact radians, using pi constant?
- - Odd units: flops, lumen, lux, bel
+ - Weird units: flops, lumen, lux, bel
  - Command to list units

default.nix

@@ -1,19 +0,0 @@
-{ lib, fetchgit, rustPlatform }:
-rustPlatform.buildRustPackage rec {
-	pname = "daisy";
-	version = "1.1.7";
-	cargoLock.lockFile = src + /Cargo.lock;
-
-	src = builtins.fetchGit {
-		url = "https://github.com/rm-dr/daisy.git";
-		ref = "refs/tags/v${version}";
-		#rev = ""; Ideally, we'd have a hash here, but that would make git history messy.
-	};
-
-	meta = with lib; {
-		description = "A general-purpose scientific calculator";
-		homepage = "https://github.com/rm-dr/daisy";
-		#license = licenses.GPL;
-		maintainers = [ maintainers.tailhook ];
-	};
-}

server/site/index.html

@@ -86,7 +86,7 @@
 
 		<div id="header">
 			<img id="banner" src = "resources/daisy-light.svg" alt="Daisy Banner"/>
-			<p>A pretty, general-purpose scientific calculator</p>
+			<p>A high-precision, general-purpose scientific calculator</p>
 		</div>
 		
 		<div id="terminal"></div>

src/command/mod.rs

@@ -57,8 +57,8 @@ pub fn do_command(
 
 			t.push(
 				concat!(
-					"Daisy is a pretty, general-purpose\n",
-					"TUI scientific calculator.\n",
+					"Daisy is a high-precision, general-purpose\n",
+					"scientific calculator.\n",
 					"\n",
 					" - Use Up/Down arrows to navigate history.\n",
 					" - Use Ctrl-C or Ctrl-D to quit.\n",
@@ -152,9 +152,6 @@ pub fn do_command(
 					"  Fahrenheit to Kelvin     [c]fromF, fromFahrenheit[n]\n",
 					"  Kelvin to Fahrenheit     [c]toF,   toFahrenheit[n]\n",
 					"\n",
-					"  Celsius to Fahrenheit    [c]CtoF[n]\n",
-					"  Fahrenheit to Celsius    [c]FtoC[n]\n",
-					"\n",
 					"  convert to base unit     [c]tobase[n]\n",
 					"  remove units             [c]nounit[n]\n",
 					"\n\n"
@@ -250,7 +247,7 @@ pub fn do_command(
 			if args.len() != 2 {
 				return FormattedText::new(
 					format!(
-						"[c]{first}[n] [e]takes exactly one argument.[n]\n\n",
+						"[c]{first}[n] [t]takes exactly one argument.[n]\n\n",
 					)
 				);
 			}
@@ -264,7 +261,7 @@ pub fn do_command(
 				Err(()) => {
 					FormattedText::new(
 						format!(
-							"[c]{v}[n] [e]isn't a variable.[n]\n\n",
+							"[c]{v}[n] [t]isn't a variable.[n]\n\n",
 						)
 					)
 				}

src/context.rs

@@ -90,7 +90,6 @@ impl Context {
 
 	pub fn delete(&mut self, s: &String) -> Result<(), ()> {
 		if !(self.is_varible(s) || self.is_function(s)) { return Err(()) };
-		if s == "ans" { return Err(()) };
 		if self.is_varible(s) { self.variables.remove(s); }
 		if self.is_function(s) { self.functions.remove(s); }
 		return Ok(());

src/evaluate/evaluate.rs

@@ -63,7 +63,7 @@ pub fn evaluate(
 
 					context.get_variable(&s)
 				},
-				Expression::Operator(_, Operator::Function(_), _) => { eval_function(context, g)? },
+				Expression::Operator(_, Operator::Function(_), _) => { eval_function(g)? },
 				Expression::Operator(_, _, _) => { eval_operator(context, g)? },
 			};
 

src/evaluate/function.rs

@@ -1,17 +1,13 @@
-use std::collections::VecDeque;
-
 use crate::parser::Expression;
 use crate::parser::Function;
 use crate::parser::Operator;
 use crate::parser::LineLocation;
 use crate::quantity::FreeUnit;
-use crate::quantity::Unit;
 use crate::quantity::WholeUnit;
 use crate::quantity::Quantity;
 use crate::quantity::Scalar;
 use crate::errors::DaisyError;
-use crate::context::Context;
-use super::evaluate;
+
 
 // If unitless, do nothing
 // If compatible with radians, convert to radians and return unitless
@@ -30,7 +26,7 @@ fn to_radians(q: Quantity) -> Result<Quantity, ()> {
 
 
 
-pub fn eval_function(context: &mut Context, g: &Expression) -> Result<Option<Expression>, (LineLocation, DaisyError)> {
+pub fn eval_function(g: &Expression) -> Result<Option<Expression>, (LineLocation, DaisyError)> {
 
 	let Expression::Operator(loc, Operator::Function(f), args) = g else {unreachable!()};
 
@@ -154,82 +150,21 @@ pub fn eval_function(context: &mut Context, g: &Expression) -> Result<Option<Exp
 		},
 
 
-		Function::CtoF => {
-			return Ok(evaluate(context,
-				&Expression::Operator(
-					*l + *loc,
-					Operator::Function(Function::ToFahrenheit),
-					VecDeque::from(vec![Expression::Operator(
-						*l + *loc,
-						Operator::Function(Function::FromCelsius),
-						VecDeque::from(vec![Expression::Quantity(*l, q.clone())])
-					)])
-				)
-			).ok());
-		},
-
-		Function::FtoC => {
-			return Ok(evaluate(context,
-				&Expression::Operator(
-					*l + *loc,
-					Operator::Function(Function::ToCelsius),
-					VecDeque::from(vec![Expression::Operator(
-						*l + *loc,
-						Operator::Function(Function::FromFahrenheit),
-						VecDeque::from(vec![Expression::Quantity(*l, q.clone())])
-					)])
-				)
-			).ok());
-		},
 
 		Function::ToCelsius => {
 			let mut k = Quantity::new_rational(1f64).unwrap();
 			k.insert_unit(FreeUnit::from_whole(WholeUnit::Kelvin), Scalar::new_rational(1f64).unwrap());
-
-			let q_s: String;
-			if q.unitless() {
-				q_s = String::from("scalar");
-			} else {
-				q_s = q.convert_to_base().unit().display(context);
-			}
-
-			let Some(q) = q.convert_to(k) else {
-				return Err((
-					*loc + *l,
-					DaisyError::IncompatibleUnits(
-						q_s,
-						Unit::from_free(FreeUnit::from_whole(WholeUnit::Kelvin)).display(context)
-					)
-				))
-			};
+			let Some(q) = q.convert_to(k) else { return Err((*loc + *l, DaisyError::IncompatibleUnit)) };
 
 			let mut r = q.without_unit();
 			r += Quantity::new_rational(-273.15f64).unwrap();
 
 			return Ok(Some(Expression::Quantity(*loc + *l, r)));
 		},
-
-
 		Function::ToFahrenheit => {
 			let mut k = Quantity::new_rational(1f64).unwrap();
 			k.insert_unit(FreeUnit::from_whole(WholeUnit::Kelvin), Scalar::new_rational(1f64).unwrap());
-
-			let q_s: String;
-			if q.unitless() {
-				q_s = String::from("scalar");
-			} else {
-				q_s = q.convert_to_base().unit().display(context);
-			}
-
-			let Some(q) = q.convert_to(k) else {
-				return Err((
-					*loc + *l,
-					DaisyError::IncompatibleUnits(
-						q_s,
-						Unit::from_free(FreeUnit::from_whole(WholeUnit::Kelvin)).display(context)
-					)
-				))
-			};
+			let Some(q) = q.convert_to(k) else { return Err((*loc + *l, DaisyError::IncompatibleUnit)) };
 
 			let mut r = q.without_unit();
 			r *= Quantity::new_rational_from_frac(9i64, 5i64).unwrap();
@@ -238,18 +173,8 @@ pub fn eval_function(context: &mut Context, g: &Expression) -> Result<Option<Exp
 
 			return Ok(Some(Expression::Quantity(*loc + *l, r)));
 		},
-
-
 		Function::FromCelsius => {
-			if !q.unitless() {
-				return Err((
-					*loc + *l,
-					DaisyError::IncompatibleUnits(
-						q.convert_to_base().unit().display(context),
-						"scalar".to_string()
-					)
-				));
-			}
+			if !q.unitless() { return Err((*loc + *l, DaisyError::IncompatibleUnit));}
 
 			let mut r = Quantity::new_rational(273.15f64).unwrap();
 			r += q.clone();
@@ -257,18 +182,8 @@ pub fn eval_function(context: &mut Context, g: &Expression) -> Result<Option<Exp
 
 			return Ok(Some(Expression::Quantity(*loc + *l, r)));
 		},
-
-
 		Function::FromFahrenheit => {
-			if !q.unitless() {
-				return Err((
-					*loc + *l,
-					DaisyError::IncompatibleUnits(
-						q.convert_to_base().unit().display(context),
-						"scalar".to_string()
-					)
-				));
-			}
+			if !q.unitless() { return Err((*loc + *l, DaisyError::IncompatibleUnit));}
 
 			let mut r = q.clone();
 			r += Quantity::new_rational(459.67).unwrap();

src/evaluate/operator.rs

@@ -124,8 +124,6 @@ pub fn eval_operator(context: &mut Context, g: &Expression) -> Result<Option<Exp
 			if let Expression::Quantity(la, a) = a {
 				if let Expression::Quantity(lb, b) = b {
 					if !a.unit.compatible_with(&b.unit) {
-						let a = a.convert_to_base().unit;
-						let b = b.convert_to_base().unit;
 
 						let a_s: String;
 						let b_s: String;

src/parser/expression/function.rs

@@ -37,9 +37,7 @@ pub enum Function {
 	FromCelsius,
 	ToCelsius,
 	FromFahrenheit,
-	ToFahrenheit,
-	CtoF,
-	FtoC,
+	ToFahrenheit
 }
 
 
@@ -76,8 +74,6 @@ impl ToString for Function {
 			Function::ToCelsius => {String::from("tocelsius") },
 			Function::FromFahrenheit => { String::from("fromfahrenheit") },
 			Function::ToFahrenheit => { String::from("tofahrenheit") },
-			Function::FtoC => { String::from("FtoC") },
-			Function::CtoF => { String::from("CtoF") },
 		}
 	}
 
@@ -130,11 +126,6 @@ impl Function {
 			"fromF"          => {Some(Function::FromFahrenheit)},
 			"fromfahrenheit" => {Some(Function::FromFahrenheit)},
 			"fromFahrenheit" => {Some(Function::FromFahrenheit)},
-
-			"FtoC" => {Some(Function::FtoC)},
-			"ftoc" => {Some(Function::FtoC)},
-			"ctof" => {Some(Function::CtoF)},
-			"CtoF" => {Some(Function::CtoF)},
 			_ => None
 		}
 	}

src/tests.rs

@@ -232,11 +232,5 @@ fn functions() {
 
 	good_expr("2", "nounit(2 mm)");
 	good_expr("2", "nounit(2 meter * second)");
-
-	good_expr("37.778", "FtoC(100)");
-	good_expr("73.399", "CtoF(23)");
-	good_expr("-17.778", "FtoC(0)");
-	good_expr("31.999", "CtoF(0)");
-
 	//good_expr("5000 m²·g/(s²·A²)", "tobase(5H)");
 }