diff options
Diffstat (limited to 'docs/doctool/Modules/NaturalDocs/StatusMessage.pm')
| -rw-r--r-- | docs/doctool/Modules/NaturalDocs/StatusMessage.pm | 102 |
1 files changed, 0 insertions, 102 deletions
diff --git a/docs/doctool/Modules/NaturalDocs/StatusMessage.pm b/docs/doctool/Modules/NaturalDocs/StatusMessage.pm deleted file mode 100644 index 5edb91c2..00000000 --- a/docs/doctool/Modules/NaturalDocs/StatusMessage.pm +++ /dev/null @@ -1,102 +0,0 @@ -############################################################################### -# -# Package: NaturalDocs::StatusMessage -# -############################################################################### -# -# A package to handle status message updates. Automatically handles <NaturalDocs::Settings->IsQuiet()>. -# -############################################################################### - -# 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::StatusMessage; - - -# -# var: message -# The message to display. -# -my $message; - -# -# var: total -# The number of items to work through. -# -my $total; - -# -# var: completed -# The number of items completed. -# -my $completed; - -# -# var: lastMessageTime -# The time the last message was posted. -# -my $lastMessageTime; - - -# -# constant: TIME_BETWEEN_UPDATES -# The number of seconds that should occur between updates. -# -use constant TIME_BETWEEN_UPDATES => 10; - - - -# -# Function: Start -# -# Starts the status message. -# -# Parameters: -# -# message - The message to post. -# total - The number of items that are going to be worked through. -# -sub Start #(message, total) - { - my $self = shift; - - if (!NaturalDocs::Settings->IsQuiet()) - { - ($message, $total) = @_; - $completed = 0; - - print $message . "\n"; - - $lastMessageTime = time(); - }; - }; - - -# -# Function: CompletedItem -# -# Should be called every time an item is completed. -# -sub CompletedItem - { - my $self = shift; - - if (!NaturalDocs::Settings->IsQuiet()) - { - # We scale completed by 100 since we need to anyway to get the percentage. - - $completed += 100; - - if (time() >= $lastMessageTime + TIME_BETWEEN_UPDATES) - { - print $message . ' (' . ($completed / $total) . '%)' . "\n"; - $lastMessageTime = time(); - }; - }; - }; - -1; |