Changeset 8858 for code/trunk/src/modules/docking

Timestamp:

Aug 23, 2011, 12:45:53 AM (13 years ago)

Author:

landauf

Message:

merged output branch back to trunk.

Changes:

• you have to include util/Output.h instead of util/Debug.h
• COUT(x) is now called orxout(level)
• output levels are now defined by an enum instead of numbers. see util/Output.h for the definition
• it's possible to use output contexts with orxout(level, context). see util/Output.h for some common contexts. you can define more contexts
• you must use 'endl' at the end of an output message, '\n' does not flush the message

Output levels:

• instead of COUT(0) use orxout()
• instead of COUT(1) use orxout(user_error) or orxout(internal_error)
• instead of COUT(2) use orxout(user_warning) or orxout(internal_warning)
• instead of COUT(3) use orxout(user_status/user_info) or orxout(internal_status/internal_info)
• instead of COUT(4) use orxout(verbose)
• instead of COUT(5) use orxout(verbose_more)
• instead of COUT(6) use orxout(verbose_ultra)

Guidelines:

• user_* levels are for the user, visible in the console and the log-file
• internal_* levels are for developers, visible in the log-file
• verbose_* levels are for debugging, only visible if the context of the output is activated

Usage in C++:

• orxout() << "message" << endl;
• orxout(level) << "message" << endl;
• orxout(level, context) << "message" << endl;

Usage in Lua:

• orxout("message")
• orxout(orxonox.level.levelname, "message")
• orxout(orxonox.level.levelname, "context", "message")

Usage in Tcl (and in the in-game-console):

• orxout levelname message
• orxout_context levelname context message
• shortcuts: log message, error message, warning message, status message, info message, debug message

Location:

code/trunk

Files:

• . (modified) (2 props)
• src/modules/docking/Dock.cc (modified) (6 diffs)
• src/modules/docking/DockToShip.cc (modified) (4 diffs)
• src/modules/docking/DockingController.cc (modified) (2 diffs)
• src/modules/docking/DockingTarget.cc (modified) (1 diff)

code/trunk

@@ -1 +1 @@
 build
 codeblocks
+vs
 dependencies

@@ -1 +1 @@
 build
 codeblocks
+vs
 dependencies

code/trunk/src/modules/docking/Dock.cc

@@ -87 +87 @@
         {
             if(!pTrigger->isForPlayer()) {  // The PlayerTrigger is not exclusively for Pawns which means we cannot extract one.
-                COUT(4) << "Docking:execute PlayerTrigger was not triggered by a player.." << std::endl;
+                orxout(verbose, context::docking) << "Docking:execute PlayerTrigger was not triggered by a player.." << endl;
                 return false;
             }
@@ -94 +94 @@
         else
         {
-            COUT(4) << "Docking::execute Not a player trigger, can't extract pawn from it.." << std::endl;
+            orxout(verbose, context::docking) << "Docking::execute Not a player trigger, can't extract pawn from it.." << endl;
             return false;
         }
         if(player == NULL)
         {
-            COUT(4) << "Docking::execute Can't retrieve PlayerInfo from Trigger. (" << trigger->getIdentifier()->getName() << ")" << std::endl;
+            orxout(verbose, context::docking) << "Docking::execute Can't retrieve PlayerInfo from Trigger. (" << trigger->getIdentifier()->getName() << ")" << endl;
             return false;
         }
@@ -168 +168 @@
         if(candidates_.find(player) == candidates_.end())
         {
-            COUT(2) << "Dock::dock Player is not a candidate!" << std::endl;
+            orxout(internal_warning, context::docking) << "Dock::dock Player is not a candidate!" << endl;
             return false;
         }
@@ -187 +187 @@
         if(docked_.find(player) == docked_.end())
         {
-            COUT(2) << "Dock::dockingAnimationFinished Player is not currently docked." << std::endl;
+            orxout(internal_warning, context::docking) << "Dock::dockingAnimationFinished Player is not currently docked." << endl;
             return false;
         }
@@ -200 +200 @@
         if(docked_.find(player) == docked_.end())
         {
-            COUT(2) << "Dock::undock Player is not docked to this Dock." << std::endl;
+            orxout(internal_warning, context::docking) << "Dock::undock Player is not docked to this Dock." << endl;
             return false;
         }
@@ -218 +218 @@
 
     bool Dock::undockingAnimationFinished(PlayerInfo* player) {
-        COUT(4) << "Dock::undockingAnimationFinished executed" << std::endl;
+        orxout(verbose, context::docking) << "Dock::undockingAnimationFinished executed" << endl;
         return true;
     }

code/trunk/src/modules/docking/DockToShip.cc

@@ -43 +43 @@
     {
         RegisterObject(DockToShip);
-        COUT(4) << "DockToShip instance created.." << endl;
+        orxout(verbose, context::docking) << "DockToShip instance created.." << endl;
     }
 
@@ -69 +69 @@
     bool DockToShip::docking(PlayerInfo* player)
     {
-        COUT(4) << "DockToShip::attach" << endl;
+        orxout(verbose, context::docking) << "DockToShip::attach" << endl;
 
         DockingTarget *target = DockingEffect::findTarget(this->target_);
         if (target == NULL) {
-            COUT(0) << "Can't retrieve target for '" << this->target_ << "'.." << std::endl;
+            orxout(internal_warning, context::docking) << "Can't retrieve target for '" << this->target_ << "'.." << endl;
             return false;
         }
@@ -79 +79 @@
         ControllableEntity *dockTo = (ControllableEntity*) target->getParent();
         if (dockTo == NULL) {
-            COUT(2) << "Parent is not a ControllableEntity.." << std::endl;
+            orxout(internal_warning, context::docking) << "Parent is not a ControllableEntity.." << endl;
             return false;
         }
@@ -92 +92 @@
     bool DockToShip::release(PlayerInfo* player)
     {
-        COUT(4) << "DockToShip::release" << endl;
+        orxout(verbose, context::docking) << "DockToShip::release" << endl;
 
         player->stopTemporaryControl();

code/trunk/src/modules/docking/DockingController.cc

@@ -97 +97 @@
         if (docking)
         {
-            COUT(4) << "DockingController::takeControl Taking over control." << std::endl;
+            orxout(verbose, context::docking) << "DockingController::takeControl Taking over control." << endl;
 
             this->entity_->setDestroyWhenPlayerLeft(false);
@@ -108 +108 @@
     void DockingController::positionReached()
     {
-        COUT(4) << "DockingController::positionReached() called." << std::endl;
+        orxout(verbose, context::docking) << "DockingController::positionReached() called." << endl;
 
         assert(this->player_);

code/trunk/src/modules/docking/DockingTarget.cc

@@ -53 +53 @@
         SUPER(DockingTarget, XMLPort, xmlelement, mode);
 
-        COUT(4) << "DockingTarget with name '" << this->getName() << "' created.." << std::endl;
+        orxout(verbose, context::docking) << "DockingTarget with name '" << this->getName() << "' created.." << endl;
     }
 

@@ -1 +1 @@
 build
 codeblocks
+vs
 dependencies