duk_hbufferobject.h File Reference

Go to the source code of this file.

Data Structures
struct	duk_hbufferobject

Macros
#define	DUK_HBUFFEROBJECT_ELEM_UINT8   0
#define	DUK_HBUFFEROBJECT_ELEM_UINT8CLAMPED   1
#define	DUK_HBUFFEROBJECT_ELEM_INT8   2
#define	DUK_HBUFFEROBJECT_ELEM_UINT16   3
#define	DUK_HBUFFEROBJECT_ELEM_INT16   4
#define	DUK_HBUFFEROBJECT_ELEM_UINT32   5
#define	DUK_HBUFFEROBJECT_ELEM_INT32   6
#define	DUK_HBUFFEROBJECT_ELEM_FLOAT32   7
#define	DUK_HBUFFEROBJECT_ELEM_FLOAT64   8
#define	DUK_HBUFFEROBJECT_ELEM_MAX   8
#define	DUK_ASSERT_HBUFFEROBJECT_VALID(h)
#define	DUK_HBUFFEROBJECT_GET_SLICE_BASE(heap, h)
#define	DUK_HBUFFEROBJECT_FULL_SLICE(h)
#define	DUK_HBUFFEROBJECT_VALID_SLICE(h)
#define	DUK_HBUFFEROBJECT_VALID_BYTEOFFSET_INCL(h, off)
#define	DUK_HBUFFEROBJECT_VALID_BYTEOFFSET_EXCL(h, off)
#define	DUK_HBUFFEROBJECT_CLAMP_BYTELENGTH(h, len)

Functions
DUK_INTERNAL_DECL void	duk_hbufferobject_push_validated_read (duk_context *ctx, duk_hbufferobject *h_bufobj, duk_uint8_t *p, duk_small_uint_t elem_size)
DUK_INTERNAL_DECL void	duk_hbufferobject_validated_write (duk_context *ctx, duk_hbufferobject *h_bufobj, duk_uint8_t *p, duk_small_uint_t elem_size)

Macro Definition Documentation

DUK_ASSERT_HBUFFEROBJECT_VALID

#define DUK_ASSERT_HBUFFEROBJECT_VALID

(

h

)

Value:

        do { \
        DUK_ASSERT((h) != NULL); \
        DUK_ASSERT((h)->shift <= 3); \
        DUK_ASSERT((h)->elem_type <= DUK_HBUFFEROBJECT_ELEM_MAX); \
        DUK_ASSERT(((h)->shift == 0 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_UINT8) || \
                   ((h)->shift == 0 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_UINT8CLAMPED) || \
                   ((h)->shift == 0 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_INT8) || \
                   ((h)->shift == 1 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_UINT16) || \
                   ((h)->shift == 1 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_INT16) || \
                   ((h)->shift == 2 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_UINT32) || \
                   ((h)->shift == 2 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_INT32) || \
                   ((h)->shift == 2 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_FLOAT32) || \
                   ((h)->shift == 3 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_FLOAT64)); \
        DUK_ASSERT((h)->is_view == 0 || (h)->is_view == 1); \
        DUK_ASSERT(DUK_HOBJECT_IS_BUFFEROBJECT((duk_hobject *) (h))); \
        if ((h)->buf == NULL) { \
            DUK_ASSERT((h)->offset == 0); \
            DUK_ASSERT((h)->length == 0); \
        } else { \
            /* No assertions for offset or length; in particular, \
             * it's OK for length to be longer than underlying \
             * buffer.  Just ensure they don't wrap when added. \
             */ \
            DUK_ASSERT((h)->offset + (h)->length >= (h)->offset); \
        } \
    } while (0)

Definition at line 20 of file duktape-1.5.2/src-separate/duk_hbufferobject.h.

#define DUK_ASSERT_HBUFFEROBJECT_VALID(h) do { \
        DUK_ASSERT((h) != NULL); \
        DUK_ASSERT((h)->shift <= 3); \
        DUK_ASSERT((h)->elem_type <= DUK_HBUFFEROBJECT_ELEM_MAX); \
        DUK_ASSERT(((h)->shift == 0 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_UINT8) || \
                   ((h)->shift == 0 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_UINT8CLAMPED) || \
                   ((h)->shift == 0 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_INT8) || \
                   ((h)->shift == 1 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_UINT16) || \
                   ((h)->shift == 1 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_INT16) || \
                   ((h)->shift == 2 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_UINT32) || \
                   ((h)->shift == 2 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_INT32) || \
                   ((h)->shift == 2 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_FLOAT32) || \
                   ((h)->shift == 3 && (h)->elem_type == DUK_HBUFFEROBJECT_ELEM_FLOAT64)); \
        DUK_ASSERT((h)->is_view == 0 || (h)->is_view == 1); \
        DUK_ASSERT(DUK_HOBJECT_IS_BUFFEROBJECT((duk_hobject *) (h))); \
        if ((h)->buf == NULL) { \
            DUK_ASSERT((h)->offset == 0); \
            DUK_ASSERT((h)->length == 0); \
        } else { \
            /* No assertions for offset or length; in particular, \
             * it's OK for length to be longer than underlying \
             * buffer.  Just ensure they don't wrap when added. \
             */ \

DUK_HBUFFEROBJECT_CLAMP_BYTELENGTH

#define DUK_HBUFFEROBJECT_CLAMP_BYTELENGTH	(		h,
			len )

Value:

    (DUK_ASSERT_EXPR((h) != NULL), \
    duk_hbufferobject_clamp_bytelength((h), (len)))

Definition at line 88 of file duktape-1.5.2/src-separate/duk_hbufferobject.h.

 * can be invalidated by any side effect because it may trigger a user
 * callback that resizes the underlying buffer.
 */

DUK_HBUFFEROBJECT_ELEM_FLOAT32

#define DUK_HBUFFEROBJECT_ELEM_FLOAT32   7

Definition at line 16 of file duktape-1.5.2/src-separate/duk_hbufferobject.h.

DUK_HBUFFEROBJECT_ELEM_FLOAT64

#define DUK_HBUFFEROBJECT_ELEM_FLOAT64   8

Definition at line 17 of file duktape-1.5.2/src-separate/duk_hbufferobject.h.

DUK_HBUFFEROBJECT_ELEM_INT16

#define DUK_HBUFFEROBJECT_ELEM_INT16   4

Definition at line 13 of file duktape-1.5.2/src-separate/duk_hbufferobject.h.

DUK_HBUFFEROBJECT_ELEM_INT32

#define DUK_HBUFFEROBJECT_ELEM_INT32   6

Definition at line 15 of file duktape-1.5.2/src-separate/duk_hbufferobject.h.

DUK_HBUFFEROBJECT_ELEM_INT8

#define DUK_HBUFFEROBJECT_ELEM_INT8   2

Definition at line 11 of file duktape-1.5.2/src-separate/duk_hbufferobject.h.

DUK_HBUFFEROBJECT_ELEM_MAX

#define DUK_HBUFFEROBJECT_ELEM_MAX   8

Definition at line 18 of file duktape-1.5.2/src-separate/duk_hbufferobject.h.

DUK_HBUFFEROBJECT_ELEM_UINT16

#define DUK_HBUFFEROBJECT_ELEM_UINT16   3

Definition at line 12 of file duktape-1.5.2/src-separate/duk_hbufferobject.h.

DUK_HBUFFEROBJECT_ELEM_UINT32

#define DUK_HBUFFEROBJECT_ELEM_UINT32   5

Definition at line 14 of file duktape-1.5.2/src-separate/duk_hbufferobject.h.

DUK_HBUFFEROBJECT_ELEM_UINT8

#define DUK_HBUFFEROBJECT_ELEM_UINT8   0

Definition at line 9 of file duktape-1.5.2/src-separate/duk_hbufferobject.h.

DUK_HBUFFEROBJECT_ELEM_UINT8CLAMPED

#define DUK_HBUFFEROBJECT_ELEM_UINT8CLAMPED   1

Definition at line 10 of file duktape-1.5.2/src-separate/duk_hbufferobject.h.

DUK_HBUFFEROBJECT_FULL_SLICE

#define DUK_HBUFFEROBJECT_FULL_SLICE

(

h

)

Value:

    (DUK_ASSERT_EXPR((h) != NULL), DUK_ASSERT_EXPR((h)->buf != NULL), \
    ((h)->offset == 0 && (h)->length == DUK_HBUFFER_GET_SIZE((h)->buf)))

Definition at line 56 of file duktape-1.5.2/src-separate/duk_hbufferobject.h.

 * the underlying buffer is dynamic and changes without the hbufferobject
 * being changed.
 */

DUK_HBUFFEROBJECT_GET_SLICE_BASE

#define DUK_HBUFFEROBJECT_GET_SLICE_BASE	(		heap,
			h )

Value:

    (DUK_ASSERT_EXPR((h) != NULL), DUK_ASSERT_EXPR((h)->buf != NULL), \
    (((duk_uint8_t *) DUK_HBUFFER_GET_DATA_PTR((heap), (h)->buf)) + (h)->offset))

Definition at line 47 of file duktape-1.5.2/src-separate/duk_hbufferobject.h.

/* Get the current data pointer (caller must ensure buf != NULL) as a
 * duk_uint8_t ptr.
 */

DUK_HBUFFEROBJECT_VALID_BYTEOFFSET_EXCL

#define DUK_HBUFFEROBJECT_VALID_BYTEOFFSET_EXCL	(		h,
			off )

Value:

    (DUK_ASSERT_EXPR((h) != NULL), DUK_ASSERT_EXPR((h)->buf != NULL), \
    ((h)->offset + (off) <= DUK_HBUFFER_GET_SIZE((h)->buf)))

Definition at line 78 of file duktape-1.5.2/src-separate/duk_hbufferobject.h.

    (DUK_ASSERT_EXPR((h) != NULL), DUK_ASSERT_EXPR((h)->buf != NULL), \
    ((h)->offset + (off) < DUK_HBUFFER_GET_SIZE((h)->buf)))
 

DUK_HBUFFEROBJECT_VALID_BYTEOFFSET_INCL

#define DUK_HBUFFEROBJECT_VALID_BYTEOFFSET_INCL	(		h,
			off )

Value:

    (DUK_ASSERT_EXPR((h) != NULL), DUK_ASSERT_EXPR((h)->buf != NULL), \
    ((h)->offset + (off) < DUK_HBUFFER_GET_SIZE((h)->buf)))

Definition at line 74 of file duktape-1.5.2/src-separate/duk_hbufferobject.h.

 * unsafe behavior (e.g. if an underlying dynamic buffer changes
 * after being setup).  Caller must ensure 'buf' != NULL.
 */

DUK_HBUFFEROBJECT_VALID_SLICE

#define DUK_HBUFFEROBJECT_VALID_SLICE

(

h

)

Value:

    (DUK_ASSERT_EXPR((h) != NULL), DUK_ASSERT_EXPR((h)->buf != NULL), \
    ((h)->offset + (h)->length <= DUK_HBUFFER_GET_SIZE((h)->buf)))

Definition at line 63 of file duktape-1.5.2/src-separate/duk_hbufferobject.h.

/* Validate that the whole slice [0,length[ is contained in the underlying
 * buffer.  Caller must ensure 'buf' != NULL.
 */

Function Documentation

duk_hbufferobject_push_validated_read()

DUK_INTERNAL_DECL void duk_hbufferobject_push_validated_read	(	duk_context *	ctx,
		duk_hbufferobject *	h_bufobj,
		duk_uint8_t *	p,
		duk_small_uint_t	elem_size )

Definition at line 21855 of file duktape-1.5.2/src-noline/duktape.c.

                                                                                                                                                   {
    duk_double_union du;
 
    DUK_MEMCPY((void *) du.uc, (const void *) p, (size_t) elem_size);
 
    switch (h_bufobj->elem_type) {
    case DUK_HBUFFEROBJECT_ELEM_UINT8:
#if defined(DUK_USE_BUFFEROBJECT_SUPPORT)
    case DUK_HBUFFEROBJECT_ELEM_UINT8CLAMPED:
#endif
        duk_push_uint(ctx, (duk_uint_t) du.uc[0]);
        break;
#if defined(DUK_USE_BUFFEROBJECT_SUPPORT)
    /* These are not needed when only Duktape.Buffer is supported. */
    case DUK_HBUFFEROBJECT_ELEM_INT8:
        duk_push_int(ctx, (duk_int_t) (duk_int8_t) du.uc[0]);
        break;
    case DUK_HBUFFEROBJECT_ELEM_UINT16:
        duk_push_uint(ctx, (duk_uint_t) du.us[0]);
        break;
    case DUK_HBUFFEROBJECT_ELEM_INT16:
        duk_push_int(ctx, (duk_int_t) (duk_int16_t) du.us[0]);
        break;

duk_hbufferobject_validated_write()

DUK_INTERNAL_DECL void duk_hbufferobject_validated_write	(	duk_context *	ctx,
		duk_hbufferobject *	h_bufobj,
		duk_uint8_t *	p,
		duk_small_uint_t	elem_size )

Definition at line 21896 of file duktape-1.5.2/src-noline/duktape.c.

                                     :
        duk_push_int(ctx, (duk_int_t) (duk_int32_t) du.ui[0]);
        break;
    case DUK_HBUFFEROBJECT_ELEM_FLOAT32:
        duk_push_number(ctx, (duk_double_t) du.f[0]);
        break;
    case DUK_HBUFFEROBJECT_ELEM_FLOAT64:
        duk_push_number(ctx, (duk_double_t) du.d);
        break;
#endif  /* DUK_USE_BUFFEROBJECT_SUPPORT */
    default:
        DUK_UNREACHABLE();
    }
}
 
DUK_INTERNAL void duk_hbufferobject_validated_write(duk_context *ctx, duk_hbufferobject *h_bufobj, duk_uint8_t *p, duk_small_uint_t elem_size) {
    duk_double_union du;
 
    /* NOTE! Caller must ensure that any side effects from the
     * coercions below are safe.  If that cannot be guaranteed
     * (which is normally the case), caller must coerce the
     * argument using duk_to_number() before any pointer
     * validations; the result of duk_to_number() always coerces
     * without side effects here.
     */
 
    switch (h_bufobj->elem_type) {
    case DUK_HBUFFEROBJECT_ELEM_UINT8:
        du.uc[0] = (duk_uint8_t) duk_to_uint32(ctx, -1);
        break;
#if defined(DUK_USE_BUFFEROBJECT_SUPPORT)
    /* These are not needed when only Duktape.Buffer is supported. */
    case DUK_HBUFFEROBJECT_ELEM_UINT8CLAMPED:
        du.uc[0] = (duk_uint8_t) duk_to_uint8clamped(ctx, -1);
        break;
    case DUK_HBUFFEROBJECT_ELEM_INT8:
        du.uc[0] = (duk_uint8_t) duk_to_int32(ctx, -1);
        break;
    case DUK_HBUFFEROBJECT_ELEM_UINT16:
        du.us[0] = (duk_uint16_t) duk_to_uint32(ctx, -1);
        break;
    case DUK_HBUFFEROBJECT_ELEM_INT16:
        du.us[0] = (duk_uint16_t) duk_to_int32(ctx, -1);
        break;
    case DUK_HBUFFEROBJECT_ELEM_UINT32:
        du.ui[0] = (duk_uint32_t) duk_to_uint32(ctx, -1);