From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

KIMOTO / SPVM-0.989044 / lib / SPVM / Bool.pm 

            

              
1
2
3
—
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

              
package SPVM::Bool;
1;
=head1 Name
SPVM::Bool - Bool object
=head1 Usage
  use Bool;
   
  my $true = Bool->TRUE;
  my $false = Bool->FALSE;
   
  my $true_value = $true->value;
  my $false_value = $false->value;
=head1 Description
L<Bool|SPVM::Bool> object stores a C<long> value.
This object is immutable and its value cannot be changed.
L<Bool|SPVM::Bool> is automatically loaded just after the program starts.
=head1 Class Methods
=head2 TRUE
C<static method TRUE : L<Bool|SPVM::Bool> ();>
A true singleton. This is created by INIT block when the program start.
=head2 FALSE
C<static method FALSE : L<Bool|SPVM::Bool> ();>
A false singleton. This is created by INIT block when the program start.
=head1 Instance Methods
=head2 value
C<method value : int ();>
Returns a C<int> value.
If L<Bool|SPVM::Bool> object express true, this method return 1.
If L<Bool|SPVM::Bool> object express false, this method return 1.
=head1 Bool Context
the object of Bool class is different behavior in bool context.
If the C<value> of Bool object is 1, it is evaluated as true.
  if (Bool->TRUE) {
    # Run
  }
If the C<value> of Bool object is 0, it is evaluated as false.
  if (Bool->FALSE) {
    # Not run
  }
=head1 Keywords
C<true> keyword means Bool->TRUE. C<false> keyword means Bool->FALSE.
  if (true) {
    # Run
  }
  if (false) {
    # Not run
  }
=head1 Copyright & License
Copyright (c) 2023 Yuki Kimoto
MIT License