//------------------------------------------------------------------------------
// GB_BinaryOp_check: check and print a binary operator
//------------------------------------------------------------------------------

// SuiteSparse:GraphBLAS, Timothy A. Davis, (c) 2017-2025, All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

//------------------------------------------------------------------------------

#include "GB.h"
#include "get_set/GB_get_set.h"

GrB_Info GB_BinaryOp_check  // check a GraphBLAS binary operator
(
    const GrB_BinaryOp op,  // GraphBLAS operator to print and check
    const char *name,       // name of the operator
    int pr,                 // print level
    FILE *f                 // file for output
)
{

    //--------------------------------------------------------------------------
    // check inputs
    //--------------------------------------------------------------------------

    GB_CHECK_INIT ;
    GBPR0 ("\n    GraphBLAS BinaryOp: %s ", ((name != NULL) ? name : "")) ;

    if (op == NULL)
    { 
        // this may be an optional argument
        GBPR0 ("NULL\n") ;
        return (GrB_NULL_POINTER) ;
    }
    else if (op == GxB_IGNORE_DUP)
    { 
        // this is a valid dup operator for build
        GBPR0 ("ignore_dup\n") ;
        return (GrB_SUCCESS) ;
    }

    //--------------------------------------------------------------------------
    // check object
    //--------------------------------------------------------------------------

    GB_CHECK_MAGIC (op) ;
    GB_Opcode opcode = op->opcode ;
    if (!(GB_IS_BINARYOP_CODE (opcode) || GB_IS_INDEXBINARYOP_CODE (opcode)))
    { 
        GBPR0 ("    BinaryOp has an invalid opcode\n") ;
        return (GrB_INVALID_OBJECT) ;
    }

    GrB_Info info = GB_Type_check (op->ztype, "ztype", GxB_SILENT, f) ;
    if (info != GrB_SUCCESS)
    { 
        GBPR0 ("    BinaryOp has an invalid ztype\n") ;
        return (GrB_INVALID_OBJECT) ;
    }

    bool op_is_from_idxbinop =
        GB_IS_BUILTIN_BINOP_CODE_POSITIONAL (opcode) ||
        GB_IS_INDEXBINARYOP_CODE (opcode) ;
    bool op_is_first  = (opcode == GB_FIRST_binop_code) ;
    bool op_is_second = (opcode == GB_SECOND_binop_code) ;
    bool op_is_pair   = (opcode == GB_PAIR_binop_code) ;
    int32_t actual_len = (int32_t) strlen (op->name) ;
    int32_t name_len = op->name_len ;
    char *op_name = (actual_len > 0) ? op->name : "f" ;

    if (opcode == GB_USER_binop_code)
    { 
        // user-defined binary operator
        GBPR0 ("(user-defined): z=%s(x,y)\n", op_name) ;
    }
    else if (opcode == GB_USER_idxbinop_code)
    { 
        GBPR0 ("(user-defined index):\n    z=%s(x,ix,iy,y,iy,yj,theta)\n",
            op_name) ;
    }
    else if (op_is_first && op->ztype->code == GB_UDT_code)
    { 
        // FIRST_UDT binary operator created by GB_reduce_to_vector
        GBPR0 ("(generated 1st): z=%s(x,y)\n", op_name) ;
    }
    else if (op_is_second && op->ztype->code == GB_UDT_code)
    { 
        // SECOND_UDT binary operator created by GB_wait or GB_builder
        GBPR0 ("(generated 2nd): z=%s(x,y)\n", op_name) ;
    }
    else if (op_is_from_idxbinop)
    { 
        // built-in index binary operator
        GBPR0 ("(built-in index):\n    z=%s(x,ix,iy,y,iy,yj,theta)\n",
            op_name) ;
    }
    else
    { 
        // built-in
        GBPR0 ("(built-in): z=%s(x,y)\n", op_name) ;
    }

    if ((!(op_is_from_idxbinop || op_is_first || op_is_second)
            && op->binop_function == NULL)
       || (op_is_from_idxbinop && op->idxbinop_function == NULL))
    { 
        GBPR0 ("    BinaryOp has a NULL function pointer\n") ;
        return (GrB_INVALID_OBJECT) ;
    }

    if (opcode == GB_USER_binop_code && name_len != actual_len)
    { 
        GBPR0 ("    BinaryOp has an invalid name_len\n") ;
        return (GrB_INVALID_OBJECT) ;
    }

    // name given by GrB_set, or 'GrB_*' name for built-in operators
    const char *given_name = GB_op_name_get ((GB_Operator) op) ;
    if (given_name != NULL)
    { 
        GBPR0 ("    BinaryOp given name: [%s]\n", given_name) ;
    }

    info = GB_Type_check (op->ztype, "ztype", pr, f) ;
    ASSERT (info == GrB_SUCCESS) ;
    if (!op_is_pair)
    {
        if (!op_is_second)
        {
            info = GB_Type_check (op->xtype, "xtype", pr, f) ;
            if (info != GrB_SUCCESS)
            { 
                GBPR0 ("    BinaryOp has an invalid xtype\n") ;
                return (GrB_INVALID_OBJECT) ;
            }
        }

        if (!op_is_first)
        {
            info = GB_Type_check (op->ytype, "ytype", pr, f) ;
            if (info != GrB_SUCCESS)
            { 
                GBPR0 ("    BinaryOp has an invalid ytype\n") ;
                return (GrB_INVALID_OBJECT) ;
            }
        }
    }

    if (op_is_from_idxbinop)
    {
        info = GB_Type_check (op->theta_type, "theta_type", pr, f) ;
        if (info != GrB_SUCCESS)
        { 
            GBPR0 ("    BinaryOp has an invalid theta_type\n") ;
            return (GrB_INVALID_OBJECT) ;
        }
        if (pr != GxB_SILENT)
        { 
            char *string = NULL ;
            int header_arena = GB_arena (op->header_mem) ;
            uint64_t string_mem = GB_mem (header_arena, 0) ;
            GBPR ("    theta: [ ") ;
            info = GB_entry_check (op->theta_type, op->theta, pr, f, &string,
                &string_mem) ;
            GB_FREE_MEMORY (&string, string_mem) ;
            if (info != GrB_SUCCESS) return (info) ;
            GBPR ("]") ;
        }
        GBPR0 ("\n") ;
    }

    if (op->defn != NULL)
    { 
        GBPR0 ("%s\n", op->defn) ;
    }

    return (GrB_SUCCESS) ;
}

