# build-aux/mypy-stubs/xlrd/book.pyi - Type stubs for xlrd
#
# Copyright (C) 2025  Luke T. Shumaker <lukeshu@lukeshu.com>
# SPDX-License-Identifier: AGPL-3.0-or-later

import collections.abc
import types
import typing

import _typeshed
import xlrd.biffh
import xlrd.formula
import xlrd.sheet

empty_cell: xlrd.sheet.Cell

class Name(xlrd.biffh.BaseObject):
    hidden: typing.Literal[0, 1]
    func: typing.Literal[0, 1]
    vbasic: typing.Literal[0, 1]
    macro: typing.Literal[0, 1]
    complex: typing.Literal[0, 1]
    builtin: typing.Literal[0, 1]
    funcgroup: int
    binary: typing.Literal[0, 1]
    name_index: int
    name: str
    raw_formula: bytes
    scope: int
    result: xlrd.formula.Operand | None

    def cell(self) -> xlrd.sheet.Cell: ...
    def area2d(
        self, clipped: bool = True
    ) -> tuple[xlrd.sheet.Sheet, int, int, int, int]: ...

class Book(xlrd.biffh.BaseObject):
    datemode: typing.Literal[0, 1]
    biff_version: int
    codepage: int | None
    encoding: str | None
    countries: tuple[int, int]
    user_name: str
    font_list: list[_typeshed.Incomplete]
    format_list: list[_typeshed.Incomplete]
    format_map: dict[_typeshed.Incomplete, _typeshed.Incomplete]
    load_time_stage_1: float
    load_time_stage_2: float

    def sheets(self) -> list[xlrd.sheet.Sheet]: ...
    def sheet_by_index(self, sheetx: int) -> xlrd.sheet.Sheet: ...
    def __iter__(self) -> collections.abc.Iterator[xlrd.sheet.Sheet]: ...
    def sheet_by_name(self, sheet_name: str) -> xlrd.sheet.Sheet: ...
    def __getitem__(self, item: int | str) -> xlrd.sheet.Sheet: ...
    def sheet_names(self) -> list[str]: ...
    def sheet_loaded(self, sheet_name_or_index: str | int) -> bool: ...
    def unload_sheet(self, sheet_name_or_index: str | int) -> None: ...
    def release_resources(self) -> None: ...

    name_and_scope_map: dict[_typeshed.Incomplete, _typeshed.Incomplete]
    name_map: dict[_typeshed.Incomplete, _typeshed.Incomplete]
    nsheets: int
    name_obj_list: list[_typeshed.Incomplete]
    colour_map: dict[_typeshed.Incomplete, _typeshed.Incomplete]
    palette_record: list[_typeshed.Incomplete]
    xf_list: list[_typeshed.Incomplete]
    style_name_map: dict[_typeshed.Incomplete, _typeshed.Incomplete]

    def __enter__(self) -> Book: ...
    def __exit__(
        self,
        exc_type: type[BaseException] | None,
        exc_value: BaseException | None,
        exc_tb: types.TracebackType | None,
    ) -> None: ...

def open_workbook_xls(
    filename: str | None = None,
    logfile: typing.TextIO = ...,
    verbosity: int = 0,
    use_mmap: bool = True,
    file_contents: collections.abc.Buffer | None = None,
    encoding_override: str | None = None,
    formatting_info: bool = False,
    on_demand: bool = False,
    ragged_rows: bool = False,
    ignore_workbook_corruption: bool = False,
) -> Book: ...
def expand_cell_address(inrow: int, incol: int) -> tuple[int, int, int, int]: ...
def colname(colx: int, _A2Z: str = "ABCDEFGHIJKLMNOPQRSTUVWXYZ") -> str: ...
def display_cell_address(rowx: int, colx: int, relrow: int, relcol: int) -> str: ...
def unpack_SST_table(
    datatab: _typeshed.Incomplete, nstrings: int
) -> tuple[list[str], dict[int, list[tuple[int, int]]]]: ...