Project Lucy has retired. For details please refer to its Attic page.
Clownfish::Boolean – C API Documentation
Apache Lucy™

Clownfish::Boolean

parcel Clownfish
class variable CFISH_BOOLEAN
struct symbol cfish_Boolean
class nickname cfish_Bool
header file Clownfish/Boolean.h

Name

Clownfish::Boolean – Boolean type.

Description

There are only two singleton instances of this class: CFISH_TRUE and CFISH_FALSE.

Functions

singleton
cfish_Boolean*
cfish_Bool_singleton(
    bool value
);

Return either CFISH_TRUE or CFISH_FALSE depending on the supplied value.

Methods

Get_Value
bool
cfish_Bool_Get_Value(
    cfish_Boolean *self
);

Return the value of the Boolean.

Clone
cfish_Boolean* // incremented
cfish_Bool_Clone(
    cfish_Boolean *self
);

Return a clone of the object.

Equals
bool
cfish_Bool_Equals(
    cfish_Boolean *self,
    cfish_Obj *other
);

Equality test.

Returns: true if other is a Boolean with the same value as self.

To_String
cfish_String* // incremented
cfish_Bool_To_String(
    cfish_Boolean *self
);

Return “true” for true values and “false” for false values.

Inheritance

Clownfish::Boolean is a Clownfish::Obj.