/*
 * This file is part of TREB.
 *
 * TREB 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 3 of the License, or (at your option) any 
 * later version.
 *
 * TREB 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 TREB. If not, see <https://www.gnu.org/licenses/>. 
 *
 * Copyright 2022-2026 trebco, llc. 
 * info@treb.app
 * 
 */

/** represents address in a sheet */
export interface AddressType {
  row: number;
  col: number;
  sheet?: string;
}

/** typeguard for address */
export const is_address = (candidate: any): candidate is AddressType => {
  return 'row' in candidate &&
    'col' in candidate;
};

/** represents range in a sheet (e.g. A1:B2) */
export interface RangeType {
  from: AddressType;
  to: AddressType;
  sheet?: string;
}

export interface HyperlinkType {
  address: AddressType;
  reference: string;
  text: string;
}

/** typeguard for range */
export const is_range = (candidate: any): candidate is RangeType => {
  return 'from' in candidate &&
    'to' in candidate &&
    is_address(candidate.from) &&
    is_address(candidate.to);
};

export const InRange = (range: RangeType, address: AddressType) => {
  return address.sheet === range.sheet &&
    address.row >= range.from.row &&
    address.row <= range.to.row &&
    address.col >= range.from.col &&
    address.col <= range.to.col;
};

export const ShiftRange = (range: RangeType, rows = 0, columns = 0) => {
  return {
    from: {
      row: range.from.row + rows,
      col: range.from.col + columns,
      sheet: range.from.sheet,
    }, to: {
      row: range.to.row + rows,
      col: range.to.col + columns,
      sheet: range.to.sheet,
    },
  };
};