# =============================================================================
#               ____ _   _ ____  _       _ _ _           _         _ _
#  _ __  _   _ / ___| | | |  _ \| |     | (_) |__   __ _| |__   __| | |
# | '_ \| | | | |  _| |_| | | | | |     | | | '_ \ / _` | '_ \ / _` | |
# | |_) | |_| | |_| |  _  | |_| | |___ _| | | |_) | (_| | | | | (_| | |
# | .__/ \__, |\____|_| |_|____/|_____(_)_|_|_.__/ \__, |_| |_|\__,_|_|
# |_|    |___/                                     |___/
# =============================================================================
# Authors:          Tristan Gingold
#                   Patrick Lehmann
#
# Package module:   Python binding and low-level API for shared library 'libghdl'.
#
# License:
# ============================================================================
# Copyright (C) 2019-2021 Tristan Gingold
#
#	GHDL 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, or (at your option) any later
#	version.
#
#	GHDL 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 GHDL; see the file COPYING.  If not, write to the Free
#	Software Foundation, 59 Temple Place - Suite 330, Boston, MA
#	02111-1307, USA.
#
# SPDX-License-Identifier: GPL-2.0-or-later
# ============================================================================
#
from ctypes import c_int32

from pydecor import export

from pyGHDL.libghdl import libghdl

__all__ = [
	'Flist_Type',
	'Ffirst'
]

Flist_Type = c_int32  #: First index of a ``FList``.

Ffirst = 0

@export
def Flast(FList) -> int:
	"""
	Last index of :obj:`FList`.

	.. hint:: Could be used to iterate.

	:param FList: List to query.
	:return:      Index of the last element in the list.
	"""
	return libghdl.vhdl__flists__flast(FList)


@export
def Length(FList) -> int:
	"""
	Get the length of :obj:`FList`.

	:param FList: List to query.
	:return:      Number of elements in the list.
	"""
	return libghdl.vhdl__flists__length(FList)


@export
def Get_Nth_Element(FList, N: int):
	"""
	Get the N-th element of :obj:`FList`.

	First element has index 0.

	:param FList: List to query.
	:return:      Type: ``El_Type``
	"""
	return libghdl.vhdl__flists__get_nth_element(FList, N)