.TH JudySL_funcs 3
.SH NAME
JudySL \-
C library for creating and accessing a dynamic array, using
a null-terminated string as an index (associative array)
.PP
.SH SYNOPSIS
.PP
.nf
.ps +1
.ft B
PPvoid_t JudySLIns(      PPvoid_t PPJSLArray, const uint8_t * Index, PJError_t PJError);
int      JudySLDel(      PPvoid_t PPJSLArray, const uint8_t * Index, PJError_t PJError);
PPvoid_t JudySLGet(      Pcvoid_t  PJSLArray, const uint8_t * Index, PJError_t PJError);
Word_t   JudySLFreeArray(PPvoid_t PPJSLArray, PJError_t PJError);
PPvoid_t JudySLFirst(    Pcvoid_t  PJSLArray,       uint8_t * Index, PJError_t PJError);
PPvoid_t JudySLNext(     Pcvoid_t  PJSLArray,       uint8_t * Index, PJError_t PJError);
PPvoid_t JudySLLast(     Pcvoid_t  PJSLArray,       uint8_t * Index, PJError_t PJError);
PPvoid_t JudySLPrev(     Pcvoid_t  PJSLArray,       uint8_t * Index, PJError_t PJError);
.ft P
.ps
.fi
.PP
.SH DESCRIPTION
A macro equivalent exists for each function call.
Because the macro forms are sometimes faster and have a simpler error
handling interface than the equivalent functions,
they are the preferred way of calling the JudySL functions.
See \fIJudySL\fP(3)
for more information.
The function call definitions are included here for completeness.
.PP
One of the difficulties in using the JudySL function calls lies in
determining whether to pass a pointer or the address of a pointer.
Since the functions that modify the JudySL array must also modify the
pointer to the JudySL array, you must pass the address of the pointer
rather than the pointer itself.
This often leads to hard-to-debug programmatic errors.
In practice, the macros allow the compiler to catch programming
errors when pointers instead of addresses of pointers are passed.
.PP
The JudySL function calls have an additional parameter beyond
those specified in the macro calls.  This parameter is either a
pointer to an error structure, or \fBNULL\fP (in which case the
detailed error information is not returned).
.PP
In the following descriptions, the functions are described in
terms of how the macros use them (only in the case of
\fB#define JUDYERROR_NOTEST 1\fP).  This is the suggested use
of the macros after your program has been fully debugged.
When the \fBJUDYERROR_NOTEST\fP macro is not specified,
an error structure is declared to store error information
returned from the JudySL functions when an error occurs.
.PP
Notice the placement of the \fB&\fP in the different functions.
.PP
.TP 15
 \fBJudySLIns(&PJSLArray, Index, &JError)\fP
.IP
.nf
.ps +1
#define JSLI(PValue, PJSLArray, Index) \\
   PValue = JudyLIns(&PJSLArray, Index, PJE0)
.IP
.ps
.fi
.IP
.TP 15
 \fBJudySLDel(&PJSLArray, Index, &JError)\fP
.IP
.nf
.ps +1
#define JSLD(Rc_int, PJSLArray, Index) \\
   Rc_int = JudySLDel(&PJSLArray, Index, PJE0)
.IP
.ps
.fi
.IP
.TP 15
 \fBJudySLGet(PJSLArray, Index, &JError)\fP
.IP
.nf
.ps +1
#define JSLG(PValue, PJSLArray, Index) \\
   PValue = JudySLIns(PJSLArray, Index, PJE0)
.IP
.ps
.fi
.IP
.TP 15
 \fBJudySLFreeArray(&PJSLArray, &JError)\fP
.IP
.nf
.ps +1
#define JSLFA(Rc_word, PJSLArray) \\
   Rc_word = JudySLFreeArray(&PJSLArray, PJE0)
.IP
.ps
.fi
.IP
.TP 15
 \fBJudySLFirst(PJSLArray, Index, &JError)\fP
.IP
.nf
.ps +1
#define JSLF(PValue, PJSLArray, Index) \\
   PValue = JudySLFirst(PJSLArray, Index, PJE0)
.IP
.ps
.fi
.IP
.TP 15
 \fBJudySLNext(PJSLArray, Index, &JError)\fP
.IP
.nf
.ps +1
#define JSLN(PValue, PJSLArray, Index) \\
   PValue = JudySLNext(PJSLArray, Index, PJE0)
.IP
.ps
.fi
.IP
.TP 15
 \fBJudySLLast(PJSLArray, Index, &JError)\fP
.IP
.nf
.ps +1
#define JSLL(PValue, PJSLArray, Index) \\
   PValue = JudySLLast(PJSLArray, Index, PJE0)
.IP
.ps
.fi
.IP
.TP 15
 \fBJudySLPrev(PJSLArray, Index, &JError)\fP
.IP
.nf
.ps +1
#define JSLP(PValue, PJSLArray, Index) \\
   PValue = JudySLPrev(PJSLArray, Index, PJE0)
.IP
.ps
.fi
.PP
Definitions for all the Judy functions, the types
\fBPvoid_t\fP,
\fBPcvoid_t\fP,
\fBPPvoid_t\fP,
\fBWord_t \fP,
\fBJError_t\fP,
and
\fBPJError_t\fP,
the constants
\fBNULL\fP,
\fBJU_ERRNO_*\fP,
\fBJERR\fP,
\fBPPJERR\fP,
and
\fBPJE0\fP
are provided in the \fBJudy.h\fP header file
(/usr/include/Judy.h).
\fBNote\fP:  Callers should define JudySL arrays as type \fBPvoid_t\fP,
which can be passed by value to functions that take
\fBPcvoid_t\fP (constant \fBPvoid_t\fP),
and also by address to functions that take \fBPPvoid_t\fP.
.PP
The return type from most \fBJudySL\fP functions is \fBPPvoid_t\fP so
that the values stored in the array can be pointers to other objects,
which is a typical usage, or cast to a \fBWord_t  *\fP when a pointer
to a value is required instead of a pointer to a pointer.
.PP
.SH AUTHOR
Judy was invented by Doug Baskins and implemented \-Packard.
.PP
.SH SEE ALSO
\fIJudy\fP(3),
\fIJudy1\fP(3),
\fIJudyL\fP(3),
\fIJudySL\fP(3),
\fIJudyHS\fP(3),
.br
\fImalloc()\fP,
.br
the Judy website,
\fIhttp://judy.sourceforge.net\fP,
for more information and Application Notes.