Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
tag: RELEASE_0_4_17
Fetching contributors…

Cannot retrieve contributors at this time

548 lines (405 sloc) 10.854 kB
/*
Copyright (C) 2001-2007, The Perl Foundation.
$Id$
=head1 NAME
src/key.c - Base vtable calling functions
=head1 DESCRIPTION
The base vtable calling functions.
=head2 Functions
=over 4
=cut
*/
#include "parrot/parrot.h"
#include "parrot/key.h"
/* HEADERIZER HFILE: include/parrot/key.h */
/*
=item C<key_new>
Returns a new C<Key> PMC.
=cut
*/
PARROT_API
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
PMC *
key_new(PARROT_INTERP)
{
PMC * const key = pmc_new(interp, enum_class_Key);
return key;
}
/*
=item C<key_new_integer>
Returns a new integer C<Key> PMC with value C<value>.
=cut
*/
PARROT_API
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
PMC *
key_new_integer(PARROT_INTERP, INTVAL value)
{
PMC * const key = pmc_new(interp, enum_class_Key);
PObj_get_FLAGS(key) |= KEY_integer_FLAG;
PMC_int_val(key) = value;
return key;
}
/*
=item C<key_new_number>
Returns a new number C<Key> PMC with value C<value>.
=cut
*/
PARROT_API
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
PMC *
key_new_number(PARROT_INTERP, FLOATVAL value)
{
PMC * const key = pmc_new(interp, enum_class_Key);
PObj_get_FLAGS(key) |= KEY_number_FLAG;
PMC_num_val(key) = value;
return key;
}
/*
=item C<key_new_string>
Returns a new string C<Key> PMC with value C<value>.
=cut
*/
PARROT_API
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
PMC *
key_new_string(PARROT_INTERP, NOTNULL(STRING *value))
{
PMC * const key = pmc_new(interp, enum_class_Key);
PObj_get_FLAGS(key) |= KEY_string_FLAG;
PMC_str_val(key) = value;
return key;
}
/*
=item C<key_new_cstring>
Returns a new string C<Key> PMC with value C<value> converted to a
C<STRING>.
=cut
*/
PARROT_API
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
PMC *
key_new_cstring(PARROT_INTERP, NULLOK(const char *value))
{
return key_new_string(interp,
string_from_cstring(interp, value, 0));
}
/*
=item C<key_new_pmc>
Returns a new PMC C<Key> PMC with value C<value>.
=cut
*/
PARROT_API
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
PMC *
key_new_pmc(PARROT_INTERP, NOTNULL(PMC *value))
{
PMC * const key = pmc_new(interp, enum_class_Key);
PObj_get_FLAGS(key) |= KEY_pmc_FLAG;
real_exception(interp, NULL, 1, "this is broken - see slice.pmc");
}
/*
=item C<key_set_integer>
Set the integer C<value> in C<key>.
=cut
*/
PARROT_API
void
key_set_integer(SHIM_INTERP, NOTNULL(PMC *key), INTVAL value)
{
PObj_get_FLAGS(key) &= ~KEY_type_FLAGS;
PObj_get_FLAGS(key) |= KEY_integer_FLAG;
PMC_int_val(key) = value;
return;
}
/*
=item C<key_set_register>
Set the register C<value> in C<key>.
=cut
*/
PARROT_API
void
key_set_register(SHIM_INTERP, NOTNULL(PMC *key), INTVAL value,
INTVAL flag)
{
PObj_get_FLAGS(key) &= ~KEY_type_FLAGS;
PObj_get_FLAGS(key) |= KEY_register_FLAG | flag;
PMC_int_val(key) = value;
return;
}
/*
=item C<key_set_number>
Set the number C<value> in C<key>.
=cut
*/
PARROT_API
void
key_set_number(SHIM_INTERP, NOTNULL(PMC *key), FLOATVAL value)
{
PObj_get_FLAGS(key) &= ~KEY_type_FLAGS;
PObj_get_FLAGS(key) |= KEY_number_FLAG;
PMC_num_val(key) = value;
return;
}
/*
=item C<key_set_string>
Set the string C<value> in C<key>.
=cut
*/
PARROT_API
void
key_set_string(SHIM_INTERP, NOTNULL(PMC *key), NOTNULL(STRING *value))
{
PObj_get_FLAGS(key) &= ~KEY_type_FLAGS;
PObj_get_FLAGS(key) |= KEY_string_FLAG;
PMC_str_val(key) = value;
return;
}
/*
=item C<key_set_pmc>
Set the PMC C<value> in C<key>.
=cut
*/
PARROT_API
void
key_set_pmc(PARROT_INTERP, NOTNULL(PMC *key), NOTNULL(PMC *value))
{
PObj_get_FLAGS(key) &= ~KEY_type_FLAGS;
PObj_get_FLAGS(key) |= KEY_pmc_FLAG;
/*
* XXX leo
* what for is this indirection?
*/
real_exception(interp, NULL, 1, "this is broken - see slice.pmc");
}
/*
=item C<key_type>
Returns the type of C<key>.
=cut
*/
PARROT_API
PARROT_WARN_UNUSED_RESULT
INTVAL
key_type(SHIM_INTERP, NOTNULL(const PMC *key))
{
return (PObj_get_FLAGS(key) & KEY_type_FLAGS) & ~KEY_register_FLAG;
}
PARROT_API
PARROT_WARN_UNUSED_RESULT
INTVAL
key_integer(PARROT_INTERP, NOTNULL(PMC *key))
{
switch (PObj_get_FLAGS(key) & KEY_type_FLAGS) {
case KEY_hash_iterator_FLAGS:
case KEY_integer_FLAG:
return PMC_int_val(key);
case KEY_integer_FLAG | KEY_register_FLAG:
return REG_INT(interp, PMC_int_val(key));
case KEY_pmc_FLAG | KEY_register_FLAG:
{
PMC * const reg = REG_PMC(interp, PMC_int_val(key));
return VTABLE_get_integer(interp, reg);
}
case KEY_string_FLAG:
return string_to_int(interp, PMC_str_val(key));
case KEY_string_FLAG | KEY_register_FLAG:
{
STRING * const s_reg = REG_STR(interp, PMC_int_val(key));
return string_to_int(interp, s_reg);
}
default:
/* TODO check for slice_FLAGs */
return VTABLE_get_integer(interp, key);
}
}
PARROT_API
PARROT_WARN_UNUSED_RESULT
FLOATVAL
key_number(PARROT_INTERP, NOTNULL(PMC *key))
{
switch (PObj_get_FLAGS(key) & KEY_type_FLAGS) {
case KEY_number_FLAG:
return PMC_num_val(key);
case KEY_number_FLAG | KEY_register_FLAG:
return REG_NUM(interp, PMC_int_val(key));
case KEY_pmc_FLAG:
return VTABLE_get_number(interp, key);
/* PMC_pmc_val(key)); */
case KEY_pmc_FLAG | KEY_register_FLAG:
{
PMC * const reg = REG_PMC(interp, PMC_int_val(key));
return VTABLE_get_number(interp, reg);
}
default:
real_exception(interp, NULL, INVALID_OPERATION, "Key not a number!\n");
}
}
PARROT_API
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
STRING *
key_string(PARROT_INTERP, NOTNULL(PMC *key))
{
switch (PObj_get_FLAGS(key) & KEY_type_FLAGS) {
case KEY_string_FLAG:
return PMC_str_val(key);
case KEY_string_FLAG | KEY_register_FLAG:
return REG_STR(interp, PMC_int_val(key));
/* PMC_pmc_val(key)); */
case KEY_pmc_FLAG | KEY_register_FLAG:
{
PMC * const reg = REG_PMC(interp, PMC_int_val(key));
return VTABLE_get_string(interp, reg);
}
case KEY_integer_FLAG:
return string_from_int(interp, PMC_int_val(key));
case KEY_integer_FLAG | KEY_register_FLAG:
return string_from_int(interp, REG_INT(interp, PMC_int_val(key)));
default:
case KEY_pmc_FLAG:
return VTABLE_get_string(interp, key);
}
}
/*
=item C<key_pmc>
These functions return the integer/number/string/PMC values of C<key> if
possible. Otherwise they throws an exceptions.
=cut
*/
PARROT_API
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
PMC *
key_pmc(PARROT_INTERP, NOTNULL(PMC *key))
{
switch (PObj_get_FLAGS(key) & KEY_type_FLAGS) {
case KEY_pmc_FLAG | KEY_register_FLAG:
return REG_PMC(interp, PMC_int_val(key));
default:
return key; /* PMC_pmc_val(key); */
}
}
/*
=item C<key_next>
Returns the next key if C<key> is in a sequence of linked keys.
=cut
*/
PARROT_API
PARROT_CAN_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
PMC *
key_next(SHIM_INTERP, NOTNULL(PMC *key))
{
return key->pmc_ext ? (PMC *)PMC_data(key) : NULL;
}
/*
=item C<key_append>
Appends C<key2> to C<key1>.
Note that if C<key1> is not the last key in a sequence linked keys then
the last key will be found and C<key2> appended to that.
Returns C<key1>.
=cut
*/
PARROT_API
PARROT_CANNOT_RETURN_NULL
PARROT_IGNORABLE_RESULT
PMC *
key_append(SHIM_INTERP, NOTNULL(PMC *key1), NOTNULL(PMC *key2))
{
PMC *tail = key1;
while (PMC_data(tail)) {
tail = (PMC *)PMC_data(tail);
}
PMC_data(tail) = key2;
return key1;
}
/*
=item C<key_mark>
Marks C<key> as live.
=cut
*/
PARROT_API
void
key_mark(PARROT_INTERP, NOTNULL(PMC *key))
{
const UINTVAL flags = PObj_get_FLAGS(key) & KEY_type_FLAGS;
if (flags == KEY_string_FLAG)
pobject_lives(interp, (PObj *)PMC_str_val(key));
/*
* KEY_hash_iterator_FLAGS denote a hash key iteration, PMC_data() is
* the bucket_index and not the next key component
*/
if (flags == KEY_hash_iterator_FLAGS)
return;
/* if iteration hasn't started, above flag isn't set yet */
if (PMC_data(key) && PMC_data(key) != (void *)INITBucketIndex)
pobject_lives(interp, (PObj *)PMC_data(key));
}
PARROT_API
PARROT_CANNOT_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
STRING *
key_set_to_string(PARROT_INTERP, NULLOK(PMC *key))
{
STRING * const semicolon = string_from_cstring(interp, " ; ", 3);
STRING * const quote = string_from_cstring(interp, "'", 1);
STRING *value = string_from_cstring(interp, "[ ", 2);
for (; key; key = (PMC *)PMC_data(key)) {
switch (PObj_get_FLAGS(key) & KEY_type_FLAGS) {
case KEY_integer_FLAG:
value = string_append(interp, value, string_from_int(interp, PMC_int_val(key)));
break;
case KEY_string_FLAG:
value = string_append(interp, value, quote);
value = string_append(interp, value, PMC_str_val(key));
value = string_append(interp, value, quote);
break;
case KEY_pmc_FLAG:
value = string_append(interp, value, VTABLE_get_string(interp, key));
break;
case KEY_integer_FLAG | KEY_register_FLAG:
value = string_append(interp, value,
string_from_int(interp, REG_INT(interp, PMC_int_val(key))));
break;
case KEY_string_FLAG | KEY_register_FLAG:
value = string_append(interp, value, quote);
value = string_append(interp, value, REG_STR(interp, PMC_int_val(key)));
value = string_append(interp, value, quote);
break;
case KEY_pmc_FLAG | KEY_register_FLAG:
{
PMC * const reg = REG_PMC(interp, PMC_int_val(key));
value = string_append(interp, value, VTABLE_get_string(interp, reg));
}
break;
default:
value = string_append(interp, value,
string_from_literal(interp, "Key type unknown"));
break;
}
if (PMC_data(key))
value = string_append(interp, value, semicolon);
}
value = string_append(interp, value, string_from_cstring(interp, " ]", 2));
return value;
}
/*
=back
=head1 SEE ALSO
F<include/parrot/key.h>.
=head1 HISTORY
Initial version by Jeff G. on 2001.12.05.
=cut
*/
/*
* Local variables:
* c-file-style: "parrot"
* End:
* vim: expandtab shiftwidth=4:
*/
Jump to Line
Something went wrong with that request. Please try again.