/*
    * Copyright (c) 2002-2025 Gargoyle Software Inc.
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    * https://www.apache.org/licenses/LICENSE-2.0
    *
    * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.htmlunit.javascript.host.html;
  
  import java.io.Serializable;
  import java.util.ArrayList;
  import java.util.List;
  import java.util.function.Predicate;
  import java.util.function.Supplier;
  
  import org.htmlunit.html.DomElement;
  import org.htmlunit.html.DomNode;
  import org.htmlunit.html.HtmlElement;
  import org.htmlunit.html.HtmlPage;
  import org.htmlunit.html.HtmlTable;
  import org.htmlunit.html.HtmlTableBody;
  import org.htmlunit.html.HtmlTableFooter;
  import org.htmlunit.html.HtmlTableHeader;
  import org.htmlunit.html.HtmlTableRow;
  import org.htmlunit.javascript.HtmlUnitScriptable;
  import org.htmlunit.javascript.JavaScriptEngine;
  import org.htmlunit.javascript.configuration.JsxClass;
  import org.htmlunit.javascript.configuration.JsxConstructor;
  import org.htmlunit.javascript.configuration.JsxFunction;
  import org.htmlunit.javascript.configuration.JsxGetter;
  import org.htmlunit.javascript.configuration.JsxSetter;
  import org.htmlunit.javascript.host.dom.DOMException;
  import org.htmlunit.javascript.host.dom.Node;
  
  /**
   * The JavaScript object {@code HTMLTableElement}.
   *
   * @author David D. Kilzer
   * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
   * @author Daniel Gredler
   * @author Chris Erskine
   * @author Marc Guillemot
   * @author Ahmed Ashour
   * @author Ronald Brill
   * @author Frank Danek
   */
  @JsxClass(domClass = HtmlTable.class)
  public class HTMLTableElement extends HTMLElement {
  
      /**
       * JavaScript constructor.
       */
      @Override
      @JsxConstructor
      public void jsConstructor() {
          super.jsConstructor();
      }
  
      /**
       * Returns the table's caption element, or {@code null} if none exists. If more than one
       * caption is declared in the table, this method returns the first one.
       * @return the table's caption element
       */
      @JsxGetter
      public HtmlUnitScriptable getCaption() {
          final List<HtmlElement> captions = getDomNodeOrDie().getStaticElementsByTagName("caption");
          if (captions.isEmpty()) {
              return null;
          }
          return getScriptableFor(captions.get(0));
      }
  
      /**
       * Sets the caption.
       * @param o the caption
       */
      @JsxSetter
      public void setCaption(final Object o) {
          if (!(o instanceof HTMLTableCaptionElement)) {
              throw JavaScriptEngine.typeError("Not a caption");
          }
  
          // remove old caption (if any)
          deleteCaption();
  
          final HTMLTableCaptionElement caption = (HTMLTableCaptionElement) o;
          getDomNodeOrDie().appendChild(caption.getDomNodeOrDie());
      }
  
      /**
       * Returns the table's tfoot element, or {@code null} if none exists. If more than one
       * tfoot is declared in the table, this method returns the first one.
      * @return the table's tfoot element
      */
     @JsxGetter
     public HtmlUnitScriptable getTFoot() {
         final List<HtmlElement> tfoots = getDomNodeOrDie().getStaticElementsByTagName("tfoot");
         if (tfoots.isEmpty()) {
             return null;
         }
         return getScriptableFor(tfoots.get(0));
     }
 
     /**
      * Sets the tFoot.
      * @param o the tFoot
      */
     @JsxSetter
     public void setTFoot(final Object o) {
         if (!(o instanceof HTMLTableSectionElement
             && "TFOOT".equals(((HTMLTableSectionElement) o).getTagName()))) {
             throw JavaScriptEngine.typeError("Not a tFoot");
         }
 
         // remove old caption (if any)
         deleteTFoot();
 
         final HTMLTableSectionElement tfoot = (HTMLTableSectionElement) o;
         getDomNodeOrDie().appendChild(tfoot.getDomNodeOrDie());
     }
 
     /**
      * Returns the table's thead element, or {@code null} if none exists. If more than one
      * thead is declared in the table, this method returns the first one.
      * @return the table's thead element
      */
     @JsxGetter
     public HtmlUnitScriptable getTHead() {
         final List<HtmlElement> theads = getDomNodeOrDie().getStaticElementsByTagName("thead");
         if (theads.isEmpty()) {
             return null;
         }
         return getScriptableFor(theads.get(0));
     }
 
     /**
      * Sets the {@code tHead}.
      * @param o the {@code tHead}
      */
     @JsxSetter
     public void setTHead(final Object o) {
         if (!(o instanceof HTMLTableSectionElement
             && "THEAD".equals(((HTMLTableSectionElement) o).getTagName()))) {
             throw JavaScriptEngine.typeError("Not a tHead");
         }
 
         // remove old caption (if any)
         deleteTHead();
 
         final HTMLTableSectionElement thead = (HTMLTableSectionElement) o;
         getDomNodeOrDie().appendChild(thead.getDomNodeOrDie());
     }
 
     /**
      * Returns the tbody's in the table.
      * @return the tbody's in the table
      */
     @JsxGetter
     public HtmlUnitScriptable getTBodies() {
         final HtmlTable table = (HtmlTable) getDomNodeOrDie();
         final HTMLCollection bodies = new HTMLCollection(table, false);
         bodies.setElementsSupplier((Supplier<List<DomNode>> & Serializable) () -> new ArrayList<>(table.getBodies()));
         return bodies;
     }
 
     /**
      * If this table does not have a caption, this method creates an empty table caption,
      * adds it to the table and then returns it. If one or more captions already exist,
      * this method returns the first existing caption.
      * @see <a href="http://msdn.microsoft.com/en-us/library/ms536381.aspx">MSDN Documentation</a>
      * @return a newly added caption if no caption exists, or the first existing caption
      */
     @JsxFunction
     public HtmlUnitScriptable createCaption() {
         return getScriptableFor(getDomNodeOrDie().appendChildIfNoneExists("caption"));
     }
 
     /**
      * If this table does not have a tfoot element, this method creates an empty tfoot
      * element, adds it to the table and then returns it. If this table already has a
      * tfoot element, this method returns the existing tfoot element.
      * @see <a href="http://msdn.microsoft.com/en-us/library/ms536402.aspx">MSDN Documentation</a>
      * @return a newly added caption if no caption exists, or the first existing caption
      */
     @JsxFunction
     public HtmlUnitScriptable createTFoot() {
         return getScriptableFor(getDomNodeOrDie().appendChildIfNoneExists("tfoot"));
     }
 
     /**
      * If this table does not have a tbody element, this method creates an empty tbody
      * element, adds it to the table and then returns it. If this table already has a
      * tbody element, this method returns the existing tbody element.
      * @see <a href="http://msdn.microsoft.com/en-us/library/ms536402.aspx">MSDN Documentation</a>
      * @return a newly added caption if no caption exists, or the first existing caption
      */
     @JsxFunction
     public HtmlUnitScriptable createTBody() {
         return getScriptableFor(getDomNodeOrDie().appendChildIfNoneExists("tbody"));
     }
 
     /**
      * If this table does not have a thead element, this method creates an empty
      * thead element, adds it to the table and then returns it. If this table
      * already has a thead element, this method returns the existing thead element.
      * @see <a href="http://msdn.microsoft.com/en-us/library/ms536403.aspx">MSDN Documentation</a>
      * @return a newly added caption if no caption exists, or the first existing caption
      */
     @JsxFunction
     public HtmlUnitScriptable createTHead() {
         return getScriptableFor(getDomNodeOrDie().appendChildIfNoneExists("thead"));
     }
 
     /**
      * Deletes this table's caption. If the table has multiple captions, this method
      * deletes only the first caption. If this table does not have any captions, this
      * method does nothing.
      * @see <a href="http://msdn.microsoft.com/en-us/library/ms536405.aspx">MSDN Documentation</a>
      */
     @JsxFunction
     public void deleteCaption() {
         getDomNodeOrDie().removeChild("caption", 0);
     }
 
     /**
      * Deletes this table's tfoot element. If the table has multiple tfoot elements, this
      * method deletes only the first tfoot element. If this table does not have any tfoot
      * elements, this method does nothing.
      * @see <a href="http://msdn.microsoft.com/en-us/library/ms536409.aspx">MSDN Documentation</a>
      */
     @JsxFunction
     public void deleteTFoot() {
         getDomNodeOrDie().removeChild("tfoot", 0);
     }
 
     /**
      * Deletes this table's thead element. If the table has multiple thead elements, this
      * method deletes only the first thead element. If this table does not have any thead
      * elements, this method does nothing.
      * @see <a href="http://msdn.microsoft.com/en-us/library/ms536410.aspx">MSDN Documentation</a>
      */
     @JsxFunction
     public void deleteTHead() {
         getDomNodeOrDie().removeChild("thead", 0);
     }
 
     /**
      * Inserts a new row at the specified index in the element's row collection. If the index
      * is -1 or there is no index specified, then the row is appended at the end of the
      * element's row collection.
      * @see <a href="http://msdn.microsoft.com/en-us/library/ms536457.aspx">MSDN Documentation</a>
      * @param index specifies where to insert the row in the rows collection.
      *        The default value is -1, which appends the new row to the end of the rows collection
      * @return the newly-created row
      */
     @JsxFunction
     public HtmlUnitScriptable insertRow(final Object index) {
         int rowIndex = -1;
         if (!JavaScriptEngine.isUndefined(index)) {
             rowIndex = (int) JavaScriptEngine.toNumber(index);
         }
         final HTMLCollection rows = getRows();
         final int rowCount = rows.getLength();
         final int r;
         if (rowIndex == -1 || rowIndex == rowCount) {
             r = Math.max(0, rowCount);
         }
         else {
             r = rowIndex;
         }
 
         if (r < 0 || r > rowCount) {
             throw JavaScriptEngine.asJavaScriptException(
                     getWindow(),
                     "Index or size is negative or greater than the allowed amount "
                             + "(index: " + rowIndex + ", " + rowCount + " rows)",
                     DOMException.INDEX_SIZE_ERR);
         }
 
         return insertRow(r);
     }
 
     /**
      * Inserts a new row at the given position.
      * @param index the index where the row should be inserted (0 &lt;= index &lt;= nbRows)
      * @return the inserted row
      */
     public HtmlUnitScriptable insertRow(final int index) {
         // check if a tbody should be created
         if (index != 0) {
             for (final HtmlElement htmlElement : getDomNodeOrDie().getHtmlElementDescendants()) {
                 if (htmlElement instanceof HtmlTableBody
                         || htmlElement instanceof HtmlTableHeader
                         || htmlElement instanceof HtmlTableFooter) {
 
                     final HTMLCollection rows = getRows();
                     final int rowCount = rows.getLength();
                     final DomElement newRow = ((HtmlPage) getDomNodeOrDie().getPage()).createElement("tr");
                     if (rowCount == 0) {
                         getDomNodeOrDie().appendChild(newRow);
                     }
                     else if (index == rowCount) {
                         final HtmlUnitScriptable row = (HtmlUnitScriptable) rows.item(Integer.valueOf(index - 1));
                         row.getDomNodeOrDie().getParentNode().appendChild(newRow);
                     }
                     else {
                         final HtmlUnitScriptable row = (HtmlUnitScriptable) rows.item(Integer.valueOf(index));
                         // if at the end, then in the same "sub-container" as the last existing row
                         if (index > rowCount - 1) {
                             row.getDomNodeOrDie().getParentNode().appendChild(newRow);
                         }
                         else {
                             row.getDomNodeOrDie().insertBefore(newRow);
                         }
                     }
                     return getScriptableFor(newRow);
                 }
             }
         }
 
         final HtmlElement tBody = getDomNodeOrDie().appendChildIfNoneExists("tbody");
         return ((HTMLTableSectionElement) getScriptableFor(tBody)).insertRow(0);
     }
 
     /**
      * Returns the {@code width} property.
      * @return the {@code width} property
      */
     @JsxGetter(propertyName = "width")
     public String getWidth_js() {
         return getDomNodeOrDie().getAttributeDirect("width");
     }
 
     /**
      * Sets the {@code width} property.
      * @param width the {@code width} property
      */
     @JsxSetter(propertyName = "width")
     public void setWidth_js(final String width) {
         getDomNodeOrDie().setAttribute("width", width);
     }
 
     /**
      * Returns the {@code cellSpacing} property.
      * @return the {@code cellSpacing} property
      */
     @JsxGetter
     public String getCellSpacing() {
         return getDomNodeOrDie().getAttributeDirect("cellspacing");
     }
 
     /**
      * Sets the {@code cellSpacing} property.
      * @param cellSpacing the {@code cellSpacing} property
      */
     @JsxSetter
     public void setCellSpacing(final String cellSpacing) {
         getDomNodeOrDie().setAttribute("cellspacing", cellSpacing);
     }
 
     /**
      * Returns the {@code cellPadding} property.
      * @return the {@code cellPadding} property
      */
     @JsxGetter
     public String getCellPadding() {
         return getDomNodeOrDie().getAttributeDirect("cellpadding");
     }
 
     /**
      * Sets the {@code cellPadding} property.
      * @param cellPadding the {@code cellPadding} property
      */
     @JsxSetter
     public void setCellPadding(final String cellPadding) {
         getDomNodeOrDie().setAttribute("cellpadding", cellPadding);
     }
 
     /**
      * Gets the {@code border} property.
      * @return the {@code border} property
      */
     @JsxGetter
     public String getBorder() {
         return getDomNodeOrDie().getAttributeDirect("border");
     }
 
     /**
      * Sets the {@code border} property.
      * @param border the {@code border} property
      */
     @JsxSetter
     public void setBorder(final String border) {
         getDomNodeOrDie().setAttribute("border", border);
     }
 
     /**
      * Returns the value of the {@code bgColor} property.
      * @return the value of the {@code bgColor} property
      * @see <a href="http://msdn.microsoft.com/en-us/library/ms533505.aspx">MSDN Documentation</a>
      */
     @JsxGetter
     public String getBgColor() {
         return getDomNodeOrDie().getAttribute("bgColor");
     }
 
     /**
      * Sets the value of the {@code bgColor} property.
      * @param bgColor the value of the {@code bgColor} property
      * @see <a href="http://msdn.microsoft.com/en-us/library/ms533505.aspx">MSDN Documentation</a>
      */
     @JsxSetter
     public void setBgColor(final String bgColor) {
         setColorAttribute("bgColor", bgColor);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Node appendChild(final Object childObject) {
         final Node appendedChild = super.appendChild(childObject);
         getDomNodeOrDie().getPage().clearComputedStyles(getDomNodeOrDie());
         return appendedChild;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Node removeChild(final Object childObject) {
         final Node removedChild = super.removeChild(childObject);
         getDomNodeOrDie().getPage().clearComputedStyles(getDomNodeOrDie());
         return removedChild;
     }
 
     /**
      * Gets the {@code summary} property.
      * @return the property
      */
     @JsxGetter
     public String getSummary() {
         return getDomNodeOrDie().getAttributeDirect("summary");
     }
 
     /**
      * Sets the {@code summary} property.
      * @param summary the new property
      */
     @JsxSetter
     public void setSummary(final String summary) {
         setAttribute("summary", summary);
     }
 
     /**
      * Gets the {@code rules} property.
      * @return the property
      */
     @JsxGetter
     public String getRules() {
         return getDomNodeOrDie().getAttributeDirect("rules");
     }
 
     /**
      * Sets the {@code rules} property.
      * @param rules the new property
      */
     @JsxSetter
     public void setRules(final String rules) {
         setAttribute("rules", rules);
     }
 
     /**
      * Returns the value of the {@code align} property.
      * @return the value of the {@code align} property
      */
     @JsxGetter
     public String getAlign() {
         return getAlign(true);
     }
 
     /**
      * Sets the value of the {@code align} property.
      * @param align the value of the {@code align} property
      */
     @JsxSetter
     public void setAlign(final String align) {
         setAlign(align, false);
     }
 
     /**
      * Deletes the row at the specified index.
      * @see <a href="http://msdn.microsoft.com/en-us/library/ms536408.aspx">MSDN Documentation</a>
      * @param rowIndex the zero-based index of the row to delete
      */
     @JsxFunction
     public void deleteRow(int rowIndex) {
         final HTMLCollection rows = getRows();
         final int rowCount = rows.getLength();
         if (rowIndex == -1) {
             rowIndex = rowCount - 1;
         }
         final boolean rowIndexValid = rowIndex >= 0 && rowIndex < rowCount;
         if (rowIndexValid) {
             final HtmlUnitScriptable row = (HtmlUnitScriptable) rows.item(Integer.valueOf(rowIndex));
             row.getDomNodeOrDie().remove();
         }
     }
 
     /**
      * Returns the rows in the element.
      * @return the rows in the element
      */
     @JsxGetter
     public HTMLCollection getRows() {
         final HTMLCollection rows = new HTMLCollection(getDomNodeOrDie(), false);
         rows.setIsMatchingPredicate(
                 (Predicate<DomNode> & Serializable)
                 node -> node instanceof HtmlTableRow && isContainedRow((HtmlTableRow) node));
         return rows;
     }
 
     /**
      * Indicates if the row belongs to this container.
      * @param row the row to test
      * @return {@code true} if it belongs to this container
      */
     private boolean isContainedRow(final HtmlTableRow row) {
         final DomNode parent = row.getParentNode(); // the tbody, thead or tfoo
         return parent != null
                 && parent.getParentNode() == getDomNodeOrDie();
     }
 }