regproc.h File Reference

#include "nodes/pg_list.h"

Include dependency graph for regproc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	FORMAT_PROC_INVALID_AS_NULL   0x01 /* NULL if undefined */
#define	FORMAT_PROC_FORCE_QUALIFY   0x02 /* force qualification */
#define	FORMAT_OPERATOR_INVALID_AS_NULL   0x01 /* NULL if undefined */
#define	FORMAT_OPERATOR_FORCE_QUALIFY   0x02 /* force qualification */

Functions
char *	format_procedure_extended (Oid procedure_oid, bits16 flags)
char *	format_operator_extended (Oid operator_oid, bits16 flags)
List *	stringToQualifiedNameList (const char *string, Node *escontext)
char *	format_procedure (Oid procedure_oid)
char *	format_procedure_qualified (Oid procedure_oid)
void	format_procedure_parts (Oid procedure_oid, List **objnames, List **objargs, bool missing_ok)
char *	format_operator (Oid operator_oid)
char *	format_operator_qualified (Oid operator_oid)
void	format_operator_parts (Oid operator_oid, List **objnames, List **objargs, bool missing_ok)

Macro Definition Documentation

FORMAT_OPERATOR_FORCE_QUALIFY

#define FORMAT_OPERATOR_FORCE_QUALIFY   0x02 /* force qualification */

Definition at line 25 of file regproc.h.

FORMAT_OPERATOR_INVALID_AS_NULL

#define FORMAT_OPERATOR_INVALID_AS_NULL   0x01 /* NULL if undefined */

Definition at line 24 of file regproc.h.

FORMAT_PROC_FORCE_QUALIFY

#define FORMAT_PROC_FORCE_QUALIFY   0x02 /* force qualification */

Definition at line 20 of file regproc.h.

FORMAT_PROC_INVALID_AS_NULL

#define FORMAT_PROC_INVALID_AS_NULL   0x01 /* NULL if undefined */

Definition at line 19 of file regproc.h.

Function Documentation

format_operator()

char * format_operator

(

Oid

operator_oid

)

Definition at line 801 of file regproc.c.

{
    return format_operator_extended(operator_oid, 0);
}

References format_operator_extended().

Referenced by blvalidate(), brinvalidate(), btvalidate(), ComputeIndexAttrs(), getObjectDescription(), ginvalidate(), gistvalidate(), hashvalidate(), regoperatorout(), and spgvalidate().

format_operator_extended()

char * format_operator_extended	(	Oid	operator_oid,
		bits16	flags
	)

Definition at line 730 of file regproc.c.

{
    char       *result;
    HeapTuple   opertup;
 
    opertup = SearchSysCache1(OPEROID, ObjectIdGetDatum(operator_oid));
 
    if (HeapTupleIsValid(opertup))
    {
        Form_pg_operator operform = (Form_pg_operator) GETSTRUCT(opertup);
        char       *oprname = NameStr(operform->oprname);
        char       *nspname;
        StringInfoData buf;
 
        /* XXX no support here for bootstrap mode */
        Assert(!IsBootstrapProcessingMode());
 
        initStringInfo(&buf);
 
        /*
         * Would this oper be found (given the right args) by regoperatorin?
         * If not, or if caller explicitly requests it, we need to qualify it.
         */
        if ((flags & FORMAT_OPERATOR_FORCE_QUALIFY) != 0 ||
            !OperatorIsVisible(operator_oid))
        {
            nspname = get_namespace_name(operform->oprnamespace);
            appendStringInfo(&buf, "%s.",
                             quote_identifier(nspname));
        }
 
        appendStringInfo(&buf, "%s(", oprname);
 
        if (operform->oprleft)
            appendStringInfo(&buf, "%s,",
                             (flags & FORMAT_OPERATOR_FORCE_QUALIFY) != 0 ?
                             format_type_be_qualified(operform->oprleft) :
                             format_type_be(operform->oprleft));
        else
            appendStringInfoString(&buf, "NONE,");
 
        if (operform->oprright)
            appendStringInfo(&buf, "%s)",
                             (flags & FORMAT_OPERATOR_FORCE_QUALIFY) != 0 ?
                             format_type_be_qualified(operform->oprright) :
                             format_type_be(operform->oprright));
        else
            appendStringInfoString(&buf, "NONE)");
 
        result = buf.data;
 
        ReleaseSysCache(opertup);
    }
    else if ((flags & FORMAT_OPERATOR_INVALID_AS_NULL) != 0)
    {
        /* If object is undefined, return NULL as wanted by caller */
        result = NULL;
    }
    else
    {
        /*
         * If OID doesn't match any pg_operator entry, return it numerically
         */
        result = (char *) palloc(NAMEDATALEN);
        snprintf(result, NAMEDATALEN, "%u", operator_oid);
    }
 
    return result;
}

References appendStringInfo(), appendStringInfoString(), Assert(), buf, FORMAT_OPERATOR_FORCE_QUALIFY, FORMAT_OPERATOR_INVALID_AS_NULL, format_type_be(), format_type_be_qualified(), get_namespace_name(), GETSTRUCT(), HeapTupleIsValid, initStringInfo(), IsBootstrapProcessingMode, NAMEDATALEN, NameStr, ObjectIdGetDatum(), OperatorIsVisible(), palloc(), quote_identifier(), ReleaseSysCache(), SearchSysCache1(), and snprintf.

Referenced by format_operator(), format_operator_qualified(), getObjectDescription(), and getObjectIdentityParts().

format_operator_parts()

void format_operator_parts	(	Oid	operator_oid,
		List **	objnames,
		List **	objargs,
		bool	missing_ok
	)

Definition at line 814 of file regproc.c.

{
    HeapTuple   opertup;
    Form_pg_operator oprForm;
 
    opertup = SearchSysCache1(OPEROID, ObjectIdGetDatum(operator_oid));
    if (!HeapTupleIsValid(opertup))
    {
        if (!missing_ok)
            elog(ERROR, "cache lookup failed for operator with OID %u",
                 operator_oid);
        return;
    }
 
    oprForm = (Form_pg_operator) GETSTRUCT(opertup);
    *objnames = list_make2(get_namespace_name_or_temp(oprForm->oprnamespace),
                           pstrdup(NameStr(oprForm->oprname)));
    *objargs = NIL;
    if (oprForm->oprleft)
        *objargs = lappend(*objargs,
                           format_type_be_qualified(oprForm->oprleft));
    if (oprForm->oprright)
        *objargs = lappend(*objargs,
                           format_type_be_qualified(oprForm->oprright));
 
    ReleaseSysCache(opertup);
}

References elog, ERROR, format_type_be_qualified(), get_namespace_name_or_temp(), GETSTRUCT(), HeapTupleIsValid, lappend(), list_make2, NameStr, NIL, ObjectIdGetDatum(), pstrdup(), ReleaseSysCache(), and SearchSysCache1().

Referenced by getObjectIdentityParts().

format_operator_qualified()

char * format_operator_qualified

(

Oid

operator_oid

)

Definition at line 807 of file regproc.c.

{
    return format_operator_extended(operator_oid,
                                    FORMAT_OPERATOR_FORCE_QUALIFY);
}

References format_operator_extended(), and FORMAT_OPERATOR_FORCE_QUALIFY.

format_procedure()

char * format_procedure

(

Oid

procedure_oid

)

Definition at line 305 of file regproc.c.

{
    return format_procedure_extended(procedure_oid, 0);
}

References format_procedure_extended().

Referenced by blvalidate(), brinvalidate(), btvalidate(), compile_pltcl_function(), getObjectDescription(), ginvalidate(), gistvalidate(), hashvalidate(), initialize_peragg(), pg_logical_slot_get_changes_guts(), plpgsql_compile_callback(), ProcedureCreate(), regprocedureout(), and spgvalidate().

format_procedure_extended()

char * format_procedure_extended	(	Oid	procedure_oid,
		bits16	flags
	)

Definition at line 332 of file regproc.c.

{
    char       *result;
    HeapTuple   proctup;
 
    proctup = SearchSysCache1(PROCOID, ObjectIdGetDatum(procedure_oid));
 
    if (HeapTupleIsValid(proctup))
    {
        Form_pg_proc procform = (Form_pg_proc) GETSTRUCT(proctup);
        char       *proname = NameStr(procform->proname);
        int         nargs = procform->pronargs;
        int         i;
        char       *nspname;
        StringInfoData buf;
 
        /* XXX no support here for bootstrap mode */
        Assert(!IsBootstrapProcessingMode());
 
        initStringInfo(&buf);
 
        /*
         * Would this proc be found (given the right args) by regprocedurein?
         * If not, or if caller requests it, we need to qualify it.
         */
        if ((flags & FORMAT_PROC_FORCE_QUALIFY) == 0 &&
            FunctionIsVisible(procedure_oid))
            nspname = NULL;
        else
            nspname = get_namespace_name(procform->pronamespace);
 
        appendStringInfo(&buf, "%s(",
                         quote_qualified_identifier(nspname, proname));
        for (i = 0; i < nargs; i++)
        {
            Oid         thisargtype = procform->proargtypes.values[i];
 
            if (i > 0)
                appendStringInfoChar(&buf, ',');
            appendStringInfoString(&buf,
                                   (flags & FORMAT_PROC_FORCE_QUALIFY) != 0 ?
                                   format_type_be_qualified(thisargtype) :
                                   format_type_be(thisargtype));
        }
        appendStringInfoChar(&buf, ')');
 
        result = buf.data;
 
        ReleaseSysCache(proctup);
    }
    else if ((flags & FORMAT_PROC_INVALID_AS_NULL) != 0)
    {
        /* If object is undefined, return NULL as wanted by caller */
        result = NULL;
    }
    else
    {
        /* If OID doesn't match any pg_proc entry, return it numerically */
        result = (char *) palloc(NAMEDATALEN);
        snprintf(result, NAMEDATALEN, "%u", procedure_oid);
    }
 
    return result;
}

References appendStringInfo(), appendStringInfoChar(), appendStringInfoString(), Assert(), buf, FORMAT_PROC_FORCE_QUALIFY, FORMAT_PROC_INVALID_AS_NULL, format_type_be(), format_type_be_qualified(), FunctionIsVisible(), get_namespace_name(), GETSTRUCT(), HeapTupleIsValid, i, initStringInfo(), IsBootstrapProcessingMode, NAMEDATALEN, NameStr, ObjectIdGetDatum(), palloc(), proname, quote_qualified_identifier(), ReleaseSysCache(), SearchSysCache1(), and snprintf.

Referenced by format_procedure(), format_procedure_qualified(), getObjectDescription(), and getObjectIdentityParts().

format_procedure_parts()

void format_procedure_parts	(	Oid	procedure_oid,
		List **	objnames,
		List **	objargs,
		bool	missing_ok
	)

Definition at line 404 of file regproc.c.

{
    HeapTuple   proctup;
    Form_pg_proc procform;
    int         nargs;
    int         i;
 
    proctup = SearchSysCache1(PROCOID, ObjectIdGetDatum(procedure_oid));
 
    if (!HeapTupleIsValid(proctup))
    {
        if (!missing_ok)
            elog(ERROR, "cache lookup failed for procedure with OID %u", procedure_oid);
        return;
    }
 
    procform = (Form_pg_proc) GETSTRUCT(proctup);
    nargs = procform->pronargs;
 
    *objnames = list_make2(get_namespace_name_or_temp(procform->pronamespace),
                           pstrdup(NameStr(procform->proname)));
    *objargs = NIL;
    for (i = 0; i < nargs; i++)
    {
        Oid         thisargtype = procform->proargtypes.values[i];
 
        *objargs = lappend(*objargs, format_type_be_qualified(thisargtype));
    }
 
    ReleaseSysCache(proctup);
}

References elog, ERROR, format_type_be_qualified(), get_namespace_name_or_temp(), GETSTRUCT(), HeapTupleIsValid, i, lappend(), list_make2, NameStr, NIL, ObjectIdGetDatum(), pstrdup(), ReleaseSysCache(), and SearchSysCache1().

Referenced by getObjectIdentityParts().

format_procedure_qualified()

char * format_procedure_qualified

(

Oid

procedure_oid

)

Definition at line 311 of file regproc.c.

{
    return format_procedure_extended(procedure_oid, FORMAT_PROC_FORCE_QUALIFY);
}

References FORMAT_PROC_FORCE_QUALIFY, and format_procedure_extended().

stringToQualifiedNameList()

List * stringToQualifiedNameList	(	const char *	string,
		Node *	escontext
	)

Definition at line 1922 of file regproc.c.

{
    char       *rawname;
    List       *result = NIL;
    List       *namelist;
    ListCell   *l;
 
    /* We need a modifiable copy of the input string. */
    rawname = pstrdup(string);
 
    if (!SplitIdentifierString(rawname, '.', &namelist))
        ereturn(escontext, NIL,
                (errcode(ERRCODE_INVALID_NAME),
                 errmsg("invalid name syntax")));
 
    if (namelist == NIL)
        ereturn(escontext, NIL,
                (errcode(ERRCODE_INVALID_NAME),
                 errmsg("invalid name syntax")));
 
    foreach(l, namelist)
    {
        char       *curname = (char *) lfirst(l);
 
        result = lappend(result, makeString(pstrdup(curname)));
    }
 
    pfree(rawname);
    list_free(namelist);
 
    return result;
}

References ereturn, errcode(), errmsg(), lappend(), lfirst, list_free(), makeString(), NIL, pfree(), pstrdup(), and SplitIdentifierString().

Referenced by call_pltcl_start_proc(), check_default_text_search_config(), getTSCurrentConfig(), parseNameAndArgTypes(), regclassin(), regcollationin(), regconfigin(), regdatabasein(), regdictionaryin(), regnamespacein(), regoperin(), regprocin(), regrolein(), RelationNameGetTupleDesc(), thesaurus_init(), and tsvector_update_trigger().