ddnet/docs/doctool/Modules/NaturalDocs/Languages/Advanced/ScopeChange.pm

71 lines
1.7 KiB
Perl
Raw Normal View History

2007-05-22 15:06:55 +00:00
###############################################################################
#
# Class: NaturalDocs::Languages::Advanced::ScopeChange
#
###############################################################################
#
# A class used to store a scope change.
#
###############################################################################
# This file is part of Natural Docs, which is Copyright (C) 2003-2005 Greg Valure
# Natural Docs is licensed under the GPL
use strict;
use integer;
package NaturalDocs::Languages::Advanced::ScopeChange;
#
# Constants: Implementation
#
# The object is implemented as a blessed arrayref. The constants below are used as indexes.
#
# SCOPE - The new scope <SymbolString>.
# LINE_NUMBER - The line number of the change.
#
use NaturalDocs::DefineMembers 'SCOPE', 'LINE_NUMBER';
# Dependency: New() depends on the order of these constants as well as that there is no inherited members.
#
# Function: New
#
# Creates and returns a new object.
#
# Parameters:
#
# scope - The <SymbolString> the scope was changed to.
# lineNumber - What line it occurred on.
#
sub New #(scope, lineNumber)
{
# Dependency: This depends on the order of the parameters matching the constants, and that there are no inherited
# members.
my $self = shift;
my $object = [ @_ ];
bless $object, $self;
return $object;
};
# Function: Scope
# Returns the <SymbolString> the scope was changed to.
sub Scope
{ return $_[0]->[SCOPE]; };
# Function: SetScope
# Replaces the <SymbolString> the scope was changed to.
sub SetScope #(scope)
{ $_[0]->[SCOPE] = $_[1]; };
# Function: LineNumber
# Returns the line number of the change.
sub LineNumber
{ return $_[0]->[LINE_NUMBER]; };
1;