Line data    Source code

       1             : /*
       2             :  * SPDX-License-Identifier: MPL-2.0
       3             :  *
       4             :  * This Source Code Form is subject to the terms of the Mozilla Public
       5             :  * License, v. 2.0.  If a copy of the MPL was not distributed with this
       6             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       7             :  *
       8             :  * Copyright 2024, 2025 MonetDB Foundation;
       9             :  * Copyright August 2008 - 2023 MonetDB B.V.;
      10             :  * Copyright 1997 - July 2008 CWI.
      11             :  */
      12             : 
      13             : /*
      14             :  * (c) Martin Kersten
      15             :  * This module provides a wrapping of the help function in the .../mal/mal_modules.c
      16             :  * and the list of all MAL functions for analysis using SQL.
      17             :  */
      18             : #include "monetdb_config.h"
      19             : #include "gdk.h"
      20             : #include <time.h>
      21             : #include "mal_resolve.h"
      22             : #include "mal_client.h"
      23             : #include "mal_exception.h"
      24             : #include "mal_interpreter.h"
      25             : #include "mal_namespace.h"
      26             : 
      27             : static str
      28          16 : MANUALcreateOverview(Client cntxt, MalBlkPtr mb, MalStkPtr stk, InstrPtr pci)
      29             : {
      30          16 :         BAT *mod, *fcn, *sig, *adr, *com;
      31          16 :         bat *mx = getArgReference_bat(stk, pci, 0);
      32          16 :         bat *fx = getArgReference_bat(stk, pci, 1);
      33          16 :         bat *sx = getArgReference_bat(stk, pci, 2);
      34          16 :         bat *ax = getArgReference_bat(stk, pci, 3);
      35          16 :         bat *cx = getArgReference_bat(stk, pci, 4);
      36          16 :         Module *moduleList;
      37          16 :         int length;
      38             : 
      39          16 :         mod = COLnew(0, TYPE_str, 0, TRANSIENT);
      40          16 :         fcn = COLnew(0, TYPE_str, 0, TRANSIENT);
      41          16 :         sig = COLnew(0, TYPE_str, 0, TRANSIENT);
      42          16 :         adr = COLnew(0, TYPE_str, 0, TRANSIENT);
      43          16 :         com = COLnew(0, TYPE_str, 0, TRANSIENT);
      44          16 :         if (mod == NULL || fcn == NULL || sig == NULL || adr == NULL || com == NULL) {
      45           0 :                 BBPreclaim(mod);
      46           0 :                 BBPreclaim(fcn);
      47           0 :                 BBPreclaim(sig);
      48           0 :                 BBPreclaim(adr);
      49           0 :                 BBPreclaim(com);
      50           0 :                 throw(MAL, "manual.functions", SQLSTATE(HY013) MAL_MALLOC_FAIL);
      51             :         }
      52             : 
      53          16 :         getModuleList(&moduleList, &length);
      54          16 :         if (moduleList == NULL)
      55           0 :                 goto bailout;
      56             : 
      57        1094 :         for (int k = 0; k <= length; k++) {
      58        1078 :                 Module s = k < length ? moduleList[k] : cntxt->usermodule;
      59      277046 :                 for (int j = 0; j < MAXSCOPE; j++) {
      60      275968 :                         if (s->space[j]) {
      61      169975 :                                 for (Symbol t = s->space[j]; t != NULL; t = t->peer) {
      62      162443 :                                         if (t->kind == FUNCTIONsymbol && t->def->stmt[0]->fcnname[0] == '#')
      63           0 :                                                 continue;
      64      162443 :                                         char buf[1024];
      65      162443 :                                         const char *comment = NULL;
      66      162443 :                                         const char *tt = NULL;
      67      162443 :                                         if (t->kind == FUNCTIONsymbol) {
      68          16 :                                                 comment = t->def->help;
      69          16 :                                                 (void) fcnDefinition(t->def, getInstrPtr(t->def, 0), buf, LIST_MAL_NOCFUNC, buf, sizeof(buf));
      70          16 :                                                 tt = t->def->binding;
      71             :                                         } else {
      72      162427 :                                                 assert(t->func);
      73      162427 :                                                 comment = t->func->comment;
      74      162427 :                                                 (void) cfcnDefinition(t, buf, sizeof(buf));
      75      162427 :                                                 tt = t->func->cname;
      76             :                                         }
      77      162443 :                                         if (comment == NULL)
      78          16 :                                                 comment = "";
      79      162443 :                                         if (tt == NULL)
      80           0 :                                                 tt = "";
      81      162443 :                                         if (BUNappend(mod, s->name, false) != GDK_SUCCEED
      82      162443 :                                                 || BUNappend(fcn, t->name, false) != GDK_SUCCEED
      83      162443 :                                                 || BUNappend(com, comment, false) != GDK_SUCCEED
      84      162443 :                                                 || BUNappend(sig, buf, false) != GDK_SUCCEED
      85      162443 :                                                 || BUNappend(adr, tt, false) != GDK_SUCCEED) {
      86           0 :                                                 goto bailout;
      87             :                                         }
      88             :                                 }
      89             :                         }
      90             :                 }
      91             :         }
      92          16 :         freeModuleList(moduleList);
      93             : 
      94          16 :         *mx = mod->batCacheid;
      95          16 :         BBPkeepref(mod);
      96          16 :         *fx = fcn->batCacheid;
      97          16 :         BBPkeepref(fcn);
      98          16 :         *sx = sig->batCacheid;
      99          16 :         BBPkeepref(sig);
     100          16 :         *ax = adr->batCacheid;
     101          16 :         BBPkeepref(adr);
     102          16 :         *cx = com->batCacheid;
     103          16 :         BBPkeepref(com);
     104          16 :         (void) mb;
     105          16 :         return MAL_SUCCEED;
     106             : 
     107           0 :   bailout:
     108           0 :         freeModuleList(moduleList);
     109           0 :         BBPreclaim(mod);
     110           0 :         BBPreclaim(fcn);
     111           0 :         BBPreclaim(sig);
     112           0 :         BBPreclaim(adr);
     113           0 :         BBPreclaim(com);
     114           0 :         throw(MAL, "manual.functions", GDK_EXCEPTION);
     115             : }
     116             : 
     117             : #include "mel.h"
     118             : mel_func manual_init_funcs[] = {
     119             :  pattern("manual", "functions", MANUALcreateOverview, false, "Produces a table with all MAL functions known", args(5,5, batarg("mod",str),batarg("fcn",str),batarg("sig",str),batarg("adr",str),batarg("com",str))),
     120             :  { .imp=NULL }
     121             : };
     122             : #include "mal_import.h"
     123             : #ifdef _MSC_VER
     124             : #undef read
     125             : #pragma section(".CRT$XCU",read)
     126             : #endif
     127         350 : LIB_STARTUP_FUNC(init_manual_mal)
     128         350 : { mal_module("manual", NULL, manual_init_funcs); }