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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
###############################################################################
#
# Class: NaturalDocs::Project::ImageFile
#
###############################################################################
#
# A simple information class about project image files.
#
###############################################################################
# This file is part of Natural Docs, which is Copyright (C) 2003-2008 Greg Valure
# Natural Docs is licensed under the GPL
use strict;
use integer;
package NaturalDocs::Project::ImageFile;
###############################################################################
# Group: Implementation
#
# Constants: Members
#
# The class is implemented as a blessed arrayref. The following constants are used as indexes.
#
# LAST_MODIFIED - The integer timestamp of when the file was last modified.
# STATUS - <FileStatus> since the last build.
# REFERENCE_COUNT - The number of references to the image from the source files.
# WAS_USED - Whether the image was used the last time Natural Docs was run.
# WIDTH - The image width. Undef if can't be determined, -1 if haven't attempted to determine yet.
# HEIGHT - The image height. Undef if can't be determined, -1 if haven't attempted to determine yet.
#
use NaturalDocs::DefineMembers 'LAST_MODIFIED', 'LastModified()', 'SetLastModified()',
'STATUS', 'Status()', 'SetStatus()',
'REFERENCE_COUNT', 'ReferenceCount()',
'WAS_USED', 'WasUsed()', 'SetWasUsed()',
'WIDTH', 'Width()',
'HEIGHT', 'Height()';
#
# Topic: WasUsed versus References
#
# <WasUsed()> is a simple true/false that notes whether this image file was used the last time Natural Docs was run.
# <ReferenceCount()> is a counter for the number of times it's used *this* run. As such, it starts at zero regardless of whether
# <WasUsed()> is set or not.
#
###############################################################################
# Group: Functions
#
# Function: New
#
# Creates and returns a new file object.
#
# Parameters:
#
# lastModified - The image file's last modification timestamp
# status - The <FileStatus>.
# wasUsed - Whether this image file was used the *last* time Natural Docs was run.
#
sub New #(timestamp lastModified, FileStatus status, bool wasUsed)
{
my ($package, $lastModified, $status, $width, $height, $wasUsed) = @_;
my $object = [ ];
$object->[LAST_MODIFIED] = $lastModified;
$object->[STATUS] = $status;
$object->[REFERENCE_COUNT] = 0;
$object->[WAS_USED] = $wasUsed;
$object->[WIDTH] = -1;
$object->[HEIGHT] = -1;
bless $object, $package;
return $object;
};
#
# Functions: Member Functions
#
# LastModified - Returns the integer timestamp of when the file was last modified.
# SetLastModified - Sets the file's last modification timestamp.
# Status - Returns the <FileStatus> since the last build.
# SetStatus - Sets the <FileStatus> since the last build.
#
#
# Function: ReferenceCount
# Returns the current number of references to this image file during *this* Natural Docs execution.
#
#
# Function: AddReference
# Increases the number of references to this image file by one. Returns the new reference count.
#
sub AddReference
{
my $self = shift;
$self->[REFERENCE_COUNT]++;
return $self->[REFERENCE_COUNT];
};
#
# Function: DeleteReference
# Decreases the number of references to this image file by one. Returns the new reference count.
#
sub DeleteReference
{
my $self = shift;
$self->[REFERENCE_COUNT]--;
if ($self->[REFERENCE_COUNT] < 0)
{ die "Deleted more references to an image file than existed."; };
return $self->[REFERENCE_COUNT];
};
#
# Functions: Member Functions
#
# WasUsed - Returns whether this image file was used during the *last* Natural Docs execution.
# SetWasUsed - Sets whether this image file was used during the *last* Natural Docs execution.
# Width - Returns the width in pixels, undef if it can't be determined, and -1 if determination hasn't been attempted yet.
# Height - Returns the width in pixels, undef if it can't be determined, and -1 if determination hasn't been attempted yet.
#
#
# Function: SetDimensions
# Sets the width and height of the image. Set to undef if they can't be determined.
#
sub SetDimensions #(int width, int height)
{
my ($self, $width, $height) = @_;
# If either are undef, both should be undef. This will also convert zeroes to undef.
if (!$width || !$height)
{
$self->[WIDTH] = undef;
$self->[HEIGHT] = undef;
}
else
{
$self->[WIDTH] = $width;
$self->[HEIGHT] = $height;
};
};
1;
|