about summary refs log tree commit diff
path: root/docs/doctool/Modules/NaturalDocs/SymbolTable/Reference.pm
diff options
context:
space:
mode:
authorMagnus Auvinen <magnus.auvinen@gmail.com>2008-01-17 12:56:19 +0000
committerMagnus Auvinen <magnus.auvinen@gmail.com>2008-01-17 12:56:19 +0000
commite42c493d0c294ccb0a314c8447818c8d613195df (patch)
tree27e56d9415313ddccdb1550da64ed3ef80b1dcca /docs/doctool/Modules/NaturalDocs/SymbolTable/Reference.pm
parent037569c4e52f37196275dbafec670f54da249cf8 (diff)
downloadzcatch-e42c493d0c294ccb0a314c8447818c8d613195df.tar.gz
zcatch-e42c493d0c294ccb0a314c8447818c8d613195df.zip
removed olds docs
Diffstat (limited to 'docs/doctool/Modules/NaturalDocs/SymbolTable/Reference.pm')
-rw-r--r--docs/doctool/Modules/NaturalDocs/SymbolTable/Reference.pm273
1 files changed, 0 insertions, 273 deletions
diff --git a/docs/doctool/Modules/NaturalDocs/SymbolTable/Reference.pm b/docs/doctool/Modules/NaturalDocs/SymbolTable/Reference.pm
deleted file mode 100644
index 830bf60b..00000000
--- a/docs/doctool/Modules/NaturalDocs/SymbolTable/Reference.pm
+++ /dev/null
@@ -1,273 +0,0 @@
-###############################################################################
-#
-#   Package: NaturalDocs::SymbolTable::Reference
-#
-###############################################################################
-#
-#   A class representing a symbol or a potential symbol.
-#
-###############################################################################
-
-# 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::SymbolTable::Reference;
-
-
-###############################################################################
-# Group: Implementation
-
-#
-#   Constants: Members
-#
-#   The class is implemented as a blessed arrayref.  The following constants are its members.
-#
-#       DEFINITIONS                        - An existence hashref of the <FileNames> that define this reference.
-#       INTERPRETATIONS                - A hashref of the possible interpretations of this reference.  The keys are the <SymbolStrings>
-#                                                     and the values are the scores.
-#       CURRENT_INTERPRETATION  - The interpretation currently used as the reference target.  It will be the interpretation with
-#                                                     the highest score that is actually defined.  If none are defined, this item will be undef.
-#
-
-# DEPENDENCY: New() depends on the order of these constants.  If they change, New() has to be updated.
-use constant DEFINITIONS => 0;
-use constant INTERPRETATIONS => 1;
-use constant CURRENT_INTERPRETATION => 2;
-
-
-###############################################################################
-# Group: Modification Functions
-
-
-#
-#   Function: New
-#
-#   Creates and returns a new object.
-#
-sub New
-    {
-    my $package = shift;
-
-    # Let's make it safe, since normally you can pass values to New.  Having them just be ignored would be an obscure error.
-    if (scalar @_)
-        {  die "You can't pass values to NaturalDocs::SymbolTable::Reference->New()\n";  };
-
-    # DEPENDENCY: This code depends on the order of the member constants.
-    my $object = [ { }, { }, undef ];
-    bless $object, $package;
-
-    return $object;
-    };
-
-
-#
-#   Function: AddDefinition
-#
-#   Adds a reference definition.
-#
-#   Parameters:
-#
-#       file   - The <FileName> that defines the reference.
-#
-sub AddDefinition #(file)
-    {
-    my ($self, $file) = @_;
-
-    $self->[DEFINITIONS]{$file} = 1;
-    };
-
-
-#
-#   Function: DeleteDefinition
-#
-#   Removes a reference definition.
-#
-#   Parameters:
-#
-#       file - The <FileName> which has the definition to delete.
-#
-sub DeleteDefinition #(file)
-    {
-    my ($self, $file) = @_;
-
-    delete $self->[DEFINITIONS]{$file};
-    };
-
-
-#
-#   Function: AddInterpretation
-#
-#   Adds a symbol that this reference can be interpreted as.
-#
-#   Parameters:
-#
-#       symbol  - The <SymbolString>.
-#       score     - The score of this interpretation.
-#
-sub AddInterpretation #(symbol, score)
-    {
-    my ($self, $symbol, $score) = @_;
-
-    $self->[INTERPRETATIONS]{$symbol} = $score;
-    };
-
-
-#
-#   Function: DeleteInterpretation
-#
-#   Deletes a symbol that this reference can be interpreted as.
-#
-#   Parameters:
-#
-#       symbol - The <SymbolString> to delete.
-#
-sub DeleteInterpretation #(symbol)
-    {
-    my ($self, $symbol) = @_;
-
-    delete $self->[INTERPRETATIONS]{$symbol};
-    };
-
-
-#
-#   Function: DeleteAllInterpretationsButCurrent
-#
-#   Deletes all interpretations except for the current one.
-#
-sub DeleteAllInterpretationsButCurrent
-    {
-    my $self = shift;
-
-    if ($self->HasCurrentInterpretation())
-        {
-        my $score = $self->CurrentScore();
-
-        # Fastest way to clear a hash except for one item?  Make a new hash with just that item.
-        %{$self->[INTERPRETATIONS]} = ( $self->[CURRENT_INTERPRETATION] => $score );
-        };
-    };
-
-
-#
-#   Function: SetCurrentInterpretation
-#
-#   Changes the current interpretation.  The new one must already have been added via <AddInterpretation()>.
-#
-#   Parameters:
-#
-#       symbol - The <SymbolString>l to make the current interpretation.  Can be set to undef to clear it.
-#
-sub SetCurrentInterpretation #(symbol)
-    {
-    my ($self, $symbol) = @_;
-
-    $self->[CURRENT_INTERPRETATION] = $symbol;
-    };
-
-
-###############################################################################
-# Group: Information Functions
-
-
-#
-#   Function: Definitions
-#
-#   Returns an array of all the <FileNames> that define this reference.  If none do, returns an empty array.
-#
-sub Definitions
-    {
-    return keys %{$_[0]->[DEFINITIONS]};
-    };
-
-
-#
-#   Function: IsDefined
-#
-#   Returns whether the reference has any definitions or not.
-#
-sub IsDefined
-    {
-    return scalar keys %{$_[0]->[DEFINITIONS]};
-    };
-
-
-#
-#   Function: IsDefinedIn
-#
-#   Returns whether the reference is defined in the passed <FileName>.
-#
-sub IsDefinedIn #(file)
-    {
-    my ($self, $file) = @_;
-
-    return exists $self->[DEFINITIONS]{$file};
-    };
-
-
-#
-#   Function: Interpretations
-#
-#   Returns an array of all the <SymbolStrings> that this reference can be interpreted as.  If none, returns an empty array.
-#
-sub Interpretations
-    {
-    return keys %{$_[0]->[INTERPRETATIONS]};
-    };
-
-
-#
-#   Function: InterpretationsAndScores
-#
-#   Returns a hash of all the <SymbolStrings> that this reference can be interpreted as and their scores.  The keys are the <SymbolStrings>
-#   and the values are the scores.  If none, returns an empty hash.
-#
-sub InterpretationsAndScores
-    {
-    return %{$_[0]->[INTERPRETATIONS]};
-    };
-
-
-#
-#   Function: HasCurrentInterpretation
-#
-#   Returns whether the reference has a current interpretation or not.
-#
-sub HasCurrentInterpretation
-    {
-    return defined $_[0]->[CURRENT_INTERPRETATION];
-    };
-
-
-#
-#   Function: CurrentInterpretation
-#
-#   Returns the <SymbolString> of the current interpretation, or undef if none.
-#
-sub CurrentInterpretation
-    {
-    return $_[0]->[CURRENT_INTERPRETATION];
-    };
-
-
-#
-#   Function: CurrentScore
-#
-#   Returns the score of the current interpretation, or undef if none.
-#
-sub CurrentScore
-    {
-    my $self = shift;
-
-    if (defined $self->[CURRENT_INTERPRETATION])
-        {
-        return $self->[INTERPRETATIONS]{ $self->[CURRENT_INTERPRETATION] };
-        }
-    else
-        {  return undef;  };
-    };
-
-
-1;