/* -*-C-*-

Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994,
    1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
    2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016,
    2017, 2018, 2019, 2020 Massachusetts Institute of Technology

This file is part of MIT/GNU Scheme.

MIT/GNU Scheme is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at
your option) any later version.

MIT/GNU Scheme is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with MIT/GNU Scheme; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301,
USA.

*/

/* Support for fixed point arithmetic.  This should be used instead of
   generic arithmetic when it is desired to tell the compiler to perform
   open coding of fixnum arithmetic.  It is probably a short-term kludge
   that will eventually go away. */

#include "scheme.h"
#include "prims.h"
#include "bits.h"
#include "fixnum.h"

static long
arg_fixnum (int n)
{
  SCHEME_OBJECT argument = (ARG_REF (n));
  if (!FIXNUM_P (argument))
    error_wrong_type_arg (n);
  return (FIXNUM_TO_LONG (argument));
}

static unsigned long
arg_unsigned_fixnum (int n)
{
  SCHEME_OBJECT argument = (ARG_REF (n));
  if (!FIXNUM_P (argument))
    error_wrong_type_arg (n);
  return (OBJECT_DATUM (argument));
}

/* Predicates */

#define BOOLEAN_RESULT(expr)						\
  PRIMITIVE_RETURN (BOOLEAN_TO_OBJECT (expr))

DEFINE_PRIMITIVE ("FIXNUM?", Prim_zero_fixnum_p, 1, 1, 0)
{
  PRIMITIVE_HEADER (1);
  BOOLEAN_RESULT (FIXNUM_P (ARG_REF (1)));
}

DEFINE_PRIMITIVE ("INDEX-FIXNUM?", Prim_index_fixnum_p, 1, 1, 0)
{
  PRIMITIVE_HEADER (1);
  BOOLEAN_RESULT (UNSIGNED_FIXNUM_P (ARG_REF (1)));
}

DEFINE_PRIMITIVE ("ZERO-FIXNUM?", Prim_zero_fixnum, 1, 1, 0)
{
  PRIMITIVE_HEADER (1);
  BOOLEAN_RESULT ((arg_fixnum (1)) == 0);
}

DEFINE_PRIMITIVE ("NEGATIVE-FIXNUM?", Prim_negative_fixnum, 1, 1, 0)
{
  PRIMITIVE_HEADER (1);
  BOOLEAN_RESULT ((arg_fixnum (1)) < 0);
}

DEFINE_PRIMITIVE ("POSITIVE-FIXNUM?", Prim_positive_fixnum, 1, 1, 0)
{
  PRIMITIVE_HEADER (1);
  BOOLEAN_RESULT ((arg_fixnum (1)) > 0);
}

DEFINE_PRIMITIVE ("EQUAL-FIXNUM?", Prim_equal_fixnum, 2, 2, 0)
{
  PRIMITIVE_HEADER (2);
  BOOLEAN_RESULT ((arg_fixnum (1)) == (arg_fixnum (2)));
}

DEFINE_PRIMITIVE ("LESS-THAN-FIXNUM?", Prim_less_fixnum, 2, 2, 0)
{
  PRIMITIVE_HEADER (2);
  BOOLEAN_RESULT ((arg_fixnum (1)) < (arg_fixnum (2)));
}

DEFINE_PRIMITIVE ("GREATER-THAN-FIXNUM?", Prim_greater_fixnum, 2, 2, 0)
{
  PRIMITIVE_HEADER (2);
  BOOLEAN_RESULT ((arg_fixnum (1)) > (arg_fixnum (2)));
}

/* Operators */

#define FIXNUM_RESULT(fixnum) do					\
{									\
  long result = (fixnum);						\
  if (!LONG_TO_FIXNUM_P (result))					\
    error_bad_range_arg (1);						\
  PRIMITIVE_RETURN (LONG_TO_FIXNUM (result));				\
} while (false)

DEFINE_PRIMITIVE ("ONE-PLUS-FIXNUM", Prim_one_plus_fixnum, 1, 1, 0)
{
  PRIMITIVE_HEADER (1);
  FIXNUM_RESULT ((arg_fixnum (1)) + 1);
}

DEFINE_PRIMITIVE ("MINUS-ONE-PLUS-FIXNUM", Prim_m_1_plus_fixnum, 1, 1, 0)
{
  PRIMITIVE_HEADER (1);
  FIXNUM_RESULT ((arg_fixnum (1)) - 1);
}

DEFINE_PRIMITIVE ("PLUS-FIXNUM", Prim_plus_fixnum, 2, 2, 0)
{
  PRIMITIVE_HEADER (2);
  FIXNUM_RESULT ((arg_fixnum (1)) + (arg_fixnum (2)));
}

DEFINE_PRIMITIVE ("MINUS-FIXNUM", Prim_minus_fixnum, 2, 2, 0)
{
  PRIMITIVE_HEADER (2);
  FIXNUM_RESULT ((arg_fixnum (1)) - (arg_fixnum (2)));
}

DEFINE_PRIMITIVE ("FIXNUM-NEGATE", Prim_fixnum_negate, 1, 1, 0)
{
  PRIMITIVE_HEADER (1);
  FIXNUM_RESULT (- (arg_fixnum (1)));
}

/* Fixnum multiplication routine with overflow detection. */
#include "mul.c"

DEFINE_PRIMITIVE ("MULTIPLY-FIXNUM", Prim_multiply_fixnum, 2, 2, 0)
{
  PRIMITIVE_HEADER (2);
  CHECK_ARG (1, FIXNUM_P);
  CHECK_ARG (2, FIXNUM_P);
  {
    long result = (Mul ((ARG_REF (1)), (ARG_REF (2))));
    if (result == SHARP_F)
      error_bad_range_arg (1);
    PRIMITIVE_RETURN (result);
  }
}

DEFINE_PRIMITIVE ("DIVIDE-FIXNUM", Prim_divide_fixnum, 2, 2, 0)
{
  long numerator;
  long denominator;
  long quotient;
  long remainder;
  PRIMITIVE_HEADER (2);
  numerator = (arg_fixnum (1));
  denominator = (arg_fixnum (2));
  if (denominator == 0)
    error_bad_range_arg (2);
  /* Now, unbelievable hair because C doesn't fully specify / and %
     when their arguments are negative.  We must get consistent
     answers for all valid arguments. */
  if (numerator < 0)
    {
      numerator = (- numerator);
      if (denominator < 0)
	{
	  denominator = (- denominator);
	  quotient = (numerator / denominator);
	}
      else
	quotient = (- (numerator / denominator));
      remainder = (- (numerator % denominator));
    }
  else
    {
      if (denominator < 0)
	{
	  denominator = (- denominator);
	  quotient = (- (numerator / denominator));
	}
      else
	quotient = (numerator / denominator);
      remainder = (numerator % denominator);
    }
  if (!LONG_TO_FIXNUM_P (quotient))
    error_bad_range_arg (1);
  PRIMITIVE_RETURN
    (cons ((LONG_TO_FIXNUM (quotient)), (LONG_TO_FIXNUM (remainder))));
}

DEFINE_PRIMITIVE ("FIXNUM-QUOTIENT", Prim_fixnum_quotient, 2, 2, 0)
{
  PRIMITIVE_HEADER (2);
  {
    long numerator = (arg_fixnum (1));
    long denominator = (arg_fixnum (2));
    if (denominator == 0)
      error_bad_range_arg (2);
    FIXNUM_RESULT (FIXNUM_QUOTIENT (numerator, denominator));
  }
}

DEFINE_PRIMITIVE ("FIXNUM-REMAINDER", Prim_fixnum_remainder, 2, 2, 0)
{
  PRIMITIVE_HEADER (2);
  {
    long numerator = (arg_fixnum (1));
    long denominator = (arg_fixnum (2));
    if (denominator == 0)
      error_bad_range_arg (2);
    FIXNUM_RESULT (FIXNUM_REMAINDER (numerator, denominator));
  }
}

DEFINE_PRIMITIVE ("GCD-FIXNUM", Prim_gcd_fixnum, 2, 2, 0)
{
  PRIMITIVE_HEADER (2);
  {
    long x = (arg_fixnum (1));
    long y = (arg_fixnum (2));
    if (x < 0) x = (-x);
    if (y < 0) y = (-y);
    while (y != 0)
      {
	long z = x;
	x = y;
	y = (z % y);
      }
    PRIMITIVE_RETURN (LONG_TO_FIXNUM (x));
  }
}

/* Bitwise operations */

#define LOGICAL_RESULT(fixnum)						\
  PRIMITIVE_RETURN (MAKE_OBJECT (TC_FIXNUM, ((fixnum) & DATUM_MASK)))

#define BINARY_LOGICAL_OP(operation)					\
{									\
  PRIMITIVE_HEADER (2);							\
  LOGICAL_RESULT							\
    ((arg_unsigned_fixnum (1)) operation (arg_unsigned_fixnum (2)));	\
}

DEFINE_PRIMITIVE ("FIXNUM-ANDC", Prim_fixnum_andc, 2, 2, 0)
  BINARY_LOGICAL_OP (&~)

DEFINE_PRIMITIVE ("FIXNUM-AND", Prim_fixnum_and, 2, 2, 0)
  BINARY_LOGICAL_OP (&)

DEFINE_PRIMITIVE ("FIXNUM-OR", Prim_fixnum_or, 2, 2, 0)
  BINARY_LOGICAL_OP (|)

DEFINE_PRIMITIVE ("FIXNUM-XOR", Prim_fixnum_xor, 2, 2, 0)
  BINARY_LOGICAL_OP (^)

DEFINE_PRIMITIVE ("FIXNUM-NOT", Prim_fixnum_not, 1, 1, 0)
{
  PRIMITIVE_HEADER (1);
  LOGICAL_RESULT (~ (arg_unsigned_fixnum (1)));
}

DEFINE_PRIMITIVE ("FIXNUM-LSH", Prim_fixnum_lsh, 2, 2, 0)
{
  PRIMITIVE_HEADER (2);
  {
    unsigned long x = (arg_unsigned_fixnum (1));
    long y = (arg_fixnum (2));

    LOGICAL_RESULT (FIXNUM_LSH (x, y));
  }
}

DEFINE_PRIMITIVE ("FXBIT-COUNT", Prim_fxbit_count, 1, 1, 0)
{
  PRIMITIVE_HEADER (1);
  FIXNUM_RESULT (ulong_bit_count ((unsigned long) (arg_fixnum(1))));
}

DEFINE_PRIMITIVE ("FXLENGTH", Prim_fxlength, 1, 1, 0)
{
  PRIMITIVE_HEADER (1);
  long n = (arg_fixnum(1));
  FIXNUM_RESULT (ulong_length_in_bits ((unsigned long) ((n < 0) ? ~n : n)));
}

DEFINE_PRIMITIVE ("FXFIRST-SET-BIT", fxfirst_set_bit, 1, 1, 0)
{
  PRIMITIVE_HEADER (1);
  FIXNUM_RESULT (ulong_first_set_bit ((unsigned long) (arg_fixnum(1))));
}

DEFINE_PRIMITIVE ("FIXNUM->FLONUM", Prim_fixnum_to_flonum, 1, 1,
		  "(FIXNUM)\n\
Equivalent to (INTEGER->FLONUM FIXNUM 2)")
{
  PRIMITIVE_HEADER (1);
  PRIMITIVE_RETURN (double_to_flonum ((double) (arg_fixnum (1))));
}
