ddnet/docs/tool/Modules/NaturalDocs/Project/SourceFile.pm

114 lines
3.3 KiB
Perl
Raw Normal View History

2008-08-02 08:21:29 +00:00
###############################################################################
#
# Class: NaturalDocs::Project::SourceFile
#
###############################################################################
#
# A simple information class about project 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::SourceFile;
###############################################################################
# Group: Implementation
#
# Constants: Members
#
# The class is implemented as a blessed arrayref. The following constants are used as indexes.
#
# HAS_CONTENT - Whether the file contains Natural Docs content or not.
# LAST_MODIFIED - The integer timestamp of when the file was last modified.
# STATUS - <FileStatus> since the last build.
# DEFAULT_MENU_TITLE - The file's default title in the menu.
#
# DEPENDENCY: New() depends on its parameter list being in the same order as these constants. If the order changes, New()
# needs to be changed.
use NaturalDocs::DefineMembers 'HAS_CONTENT', 'LAST_MODIFIED', 'STATUS', 'DEFAULT_MENU_TITLE';
###############################################################################
# Group: Functions
#
# Function: New
#
# Creates and returns a new file object.
#
# Parameters:
#
# hasContent - Whether the file contains Natural Docs content or not.
# lastModified - The integer timestamp of when the file was last modified.
# status - The <FileStatus> since the last build.
# defaultMenuTitle - The file's title in the menu.
#
# Returns:
#
# A reference to the new object.
#
sub New #(hasContent, lastModified, status, defaultMenuTitle)
{
# DEPENDENCY: This function depends on its parameter list being in the same order as the member constants. If either order
# changes, this function needs to be changed.
my $package = shift;
my $object = [ @_ ];
bless $object, $package;
return $object;
};
# Function: HasContent
# Returns whether the file contains Natural Docs content or not.
sub HasContent
{ return $_[0]->[HAS_CONTENT]; };
# Function: SetHasContent
# Sets whether the file contains Natural Docs content or not.
sub SetHasContent #(hasContent)
{ $_[0]->[HAS_CONTENT] = $_[1]; };
# Function: LastModified
# Returns the integer timestamp of when the file was last modified.
sub LastModified
{ return $_[0]->[LAST_MODIFIED]; };
# Function: SetLastModified
# Sets the file's last modification timestamp.
sub SetLastModified #(lastModified)
{ $_[0]->[LAST_MODIFIED] = $_[1]; };
# Function: Status
# Returns the <FileStatus> since the last build.
sub Status
{ return $_[0]->[STATUS]; };
# Function: SetStatus
# Sets the <FileStatus> since the last build.
sub SetStatus #(status)
{ $_[0]->[STATUS] = $_[1]; };
# Function: DefaultMenuTitle
# Returns the file's default title on the menu.
sub DefaultMenuTitle
{ return $_[0]->[DEFAULT_MENU_TITLE]; };
# Function: SetDefaultMenuTitle
# Sets the file's default title on the menu.
sub SetDefaultMenuTitle #(menuTitle)
{ $_[0]->[DEFAULT_MENU_TITLE] = $_[1]; };
1;