// ==========================================================================
// This software is subject to the provisions of the Zope Public License,
// Version 2.0 (ZPL).  A copy of the ZPL should accompany this distribution.
// THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
// WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
// FOR A PARTICULAR PURPOSE.
// ==========================================================================

using System;
using System.Runtime.InteropServices;

namespace Python.Runtime {

    /// 
    /// Represents a Python integer object. See the documentation at
    /// http://www.python.org/doc/current/api/intObjects.html for details.
    /// 

    public class PyInt : PyNumber {

	/// 
	/// PyInt Constructor
	/// 
	///
	/// 
	/// Creates a new PyInt from an existing object reference. Note 
	/// that the instance assumes ownership of the object reference.
	/// The object reference is not checked for type-correctness. 
	/// 

	public PyInt(IntPtr ptr) : base(ptr) {}


	/// 
	/// PyInt Constructor
	/// 
	///
	/// 
	/// Copy constructor - obtain a PyInt from a generic PyObject. An 
	/// ArgumentException will be thrown if the given object is not a
	/// Python int object.
	/// 

	public PyInt(PyObject o) : base() {
	    if (!IsIntType(o)) {
		throw new ArgumentException("object is not an int");
	    }
	    Runtime.Incref(o.obj);
	    obj = o.obj;
	}


	/// 
	/// PyInt Constructor
	/// 
	///
	/// 
	/// Creates a new Python int from an int32 value.
	/// 

	public PyInt(int value) : base() {
	    obj = Runtime.PyInt_FromInt32(value);
	    if (obj == IntPtr.Zero) {
		throw new PythonException();
	    }
	}


	/// 
	/// PyInt Constructor
	/// 
	///
	/// 
	/// Creates a new Python int from a uint32 value.
	/// 

	[CLSCompliant(false)]
	public PyInt(uint value) : base(IntPtr.Zero) {
	    obj = Runtime.PyInt_FromInt64((long)value);
	    if (obj == IntPtr.Zero) {
		throw new PythonException();
	    }
	}


	/// 
	/// PyInt Constructor
	/// 
	///
	/// 
	/// Creates a new Python int from an int64 value.
	/// 

	public PyInt(long value) : base(IntPtr.Zero) {
	    obj = Runtime.PyInt_FromInt64(value);
	    if (obj == IntPtr.Zero) {
		throw new PythonException();
	    }
	}


	/// 
	/// PyInt Constructor
	/// 
	///
	/// 
	/// Creates a new Python int from a uint64 value.
	/// 

	[CLSCompliant(false)]
	public PyInt(ulong value) : base(IntPtr.Zero) {
	    obj = Runtime.PyInt_FromInt64((long)value);
	    if (obj == IntPtr.Zero) {
		throw new PythonException();
	    }
	}


	/// 
	/// PyInt Constructor
	/// 
	///
	/// 
	/// Creates a new Python int from an int16 value.
	/// 

	public PyInt(short value) : this((int)value) {}


	/// 
	/// PyInt Constructor
	/// 
	///
	/// 
	/// Creates a new Python int from a uint16 value.
	/// 

	[CLSCompliant(false)]
	public PyInt(ushort value) : this((int)value) {}


	/// 
	/// PyInt Constructor
	/// 
	///
	/// 
	/// Creates a new Python int from a byte value.
	/// 

	public PyInt(byte value) : this((int)value) {}


	/// 
	/// PyInt Constructor
	/// 
	///
	/// 
	/// Creates a new Python int from an sbyte value.
	/// 

	[CLSCompliant(false)]
	public PyInt(sbyte value) : this((int)value) {}


	/// 
	/// PyInt Constructor
	/// 
	///
	/// 
	/// Creates a new Python int from a string value.
	/// 

	public PyInt(string value) : base() {
	    obj = Runtime.PyInt_FromString(value, IntPtr.Zero, 0);
	    if (obj == IntPtr.Zero) {
		throw new PythonException();
	    }
	}


	/// 
	/// IsIntType Method
	/// 
	///
	/// 
	/// Returns true if the given object is a Python int.
	/// 

	public static bool IsIntType(PyObject value) {
	    return Runtime.PyInt_Check(value.obj);
	}


	/// 
	/// AsInt Method
	/// 
	///
	/// 
	/// 
	/// Convert a Python object to a Python int if possible, raising  
	/// a PythonException if the conversion is not possible. This is
	/// equivalent to the Python expression "int(object)".
	/// 

	public static PyInt AsInt(PyObject value) {
	    IntPtr op = Runtime.PyNumber_Int(value.obj);
	    if (op == IntPtr.Zero) {
		throw new PythonException();
	    }
	    return new PyInt(op);
	}


	/// 
	/// ToInt16 Method
	/// 
	///
	/// 
	/// Return the value of the Python int object as an int16.
	/// 

	public short ToInt16() {
	    return System.Convert.ToInt16(this.ToInt32());
	}


	/// 
	/// ToInt32 Method
	/// 
	///
	/// 
	/// Return the value of the Python int object as an int32.
	/// 

	public int ToInt32() {
	    return Runtime.PyInt_AsLong(obj);
	}


	/// 
	/// ToInt64 Method
	/// 
	///
	/// 
	/// Return the value of the Python int object as an int64.
	/// 

	public long ToInt64() {
	    return System.Convert.ToInt64(this.ToInt32());
	}


    }

}