Address.cs

/*
 * NanoXLSX is a small .NET library to generate and read XLSX (Microsoft Excel 2007 or newer) files in an easy and native way  
 * Copyright Raphael Stoeckli © 2025
 * This library is licensed under the MIT License.
 * You find a copy of the license in project folder or on: http://opensource.org/licenses/MIT
 */
 
using System;
 
namespace NanoXLSX
{
    public struct Address : IEquatable<Address>, IComparable<Address>
    {
        private readonly int column;
        private readonly int row;
        private readonly Cell.AddressType type;

        public int Column { get => column; }
        public int Row { get => row; }

        public Cell.AddressType Type { get => type; }

        public Address(int column, int row) : this(column, row, Cell.AddressType.Default)
        {
            // No actions
        }

        public Address(int column, int row, Cell.AddressType type)
        {
            Cell.ValidateColumnNumber(column);
            Cell.ValidateRowNumber(row);
            this.column = column;
            this.row = row;
            this.type = type;
        }

        public Address(string address)
        {
            Cell.ResolveCellCoordinate(address, out this.column, out this.row, out this.type);
        }

        public Address(string address, Cell.AddressType type)
        {
            this.type = type;
            Cell.ResolveCellCoordinate(address, out this.column, out this.row);
        }

        public string GetAddress()
        {
            return Cell.ResolveCellAddress(Column, Row, Type);
        }

        public string GetColumn()
        {
            return Cell.ResolveColumnAddress(Column);
        }

        public override string ToString()
        {
            return GetAddress();
        }

        public bool Equals(Address other)
        {
            if (Row == other.Row && Column == other.Column && Type == other.Type)
            { return true; }
 
            return false;
        }

        public override bool Equals(object obj)
        {
            if (!(obj is Address))
            {
                return false;
            }
            return Equals((Address)obj);
        }

        public override int GetHashCode()
        {
            return ToString().GetHashCode();
        }
 
        // Operator overloads
        public static bool operator ==(Address address1, Address address2)
        {
            return address1.Equals(address2);
        }

        public static bool operator !=(Address address1, Address address2)
        {
            return !address1.Equals(address2);
        }

        public int CompareTo(Address other)
        {
            long thisCoordinate = (long)Column * (long)Worksheet.MaxRowNumber + Row;
            long otherCoordinate = (long)other.Column * (long)Worksheet.MaxRowNumber + other.Row;
            return thisCoordinate.CompareTo(otherCoordinate);
        }

        public static bool operator <(Address left, Address right)
        {
            return left.CompareTo(right) < 0;
        }

        public static bool operator <=(Address left, Address right)
        {
            return left.CompareTo(right) <= 0;
        }

        public static bool operator >(Address left, Address right)
        {
            return left.CompareTo(right) > 0;
        }

        public static bool operator >=(Address left, Address right)
        {
            return left.CompareTo(right) >= 0;
        }

        internal Address Copy()
        {
            return new Address(this.Column, this.Row, this.Type);
        }
    }
 
}