Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/tools/ResourceLocation.cc @ 9359

Last change on this file since 9359 was 8858, checked in by landauf, 13 years ago

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
  • Property svn:eol-style set to native
File size: 3.5 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Reto Grieder
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#include "ResourceLocation.h"
30
31#include <OgreResourceGroupManager.h>
32#include <OgreException.h>
33#include <boost/filesystem.hpp>
34
35#include "util/Exception.h"
36#include "core/CoreIncludes.h"
37#include "core/PathConfig.h"
38#include "core/XMLFile.h"
39#include "core/XMLPort.h"
40
41namespace orxonox
42{
43    CreateFactory(ResourceLocation);
44
45    ResourceLocation::ResourceLocation(BaseObject* creator)
46        : BaseObject(creator)
47    {
48        RegisterObject(ResourceLocation);
49
50        // Default values
51        archiveType_ = "FileSystem";
52        bRecursive_  = false;
53    }
54
55    ResourceLocation::~ResourceLocation()
56    {
57    }
58
59    void ResourceLocation::XMLPort(Element& xmlelement, XMLPort::Mode mode)
60    {
61        XMLPortParam(ResourceLocation, "path",        setPath,        getPath,        xmlelement, mode);
62        XMLPortParam(ResourceLocation, "archiveType", setArchiveType, getArchiveType, xmlelement, mode);
63        XMLPortParam(ResourceLocation, "recursive",   setRecursive,   getRecursive,   xmlelement, mode);
64        if (path_.empty())
65            ThrowException(AbortLoading, "ResourceLocation: No path given.");
66    }
67
68    void ResourceLocation::load(const std::string& resourceGroup)
69    {
70        if (path_.empty())
71            ThrowException(InitialisationFailed, "ResourceLocation: Trying to add one without the path being set");
72
73        // Find the path
74        namespace bf = boost::filesystem;
75        bf::path path;
76        if (bf::exists(PathConfig::getDataPath() / this->getPath()))
77            path = PathConfig::getDataPath() / this->getPath();
78        else if (PathConfig::buildDirectoryRun() && bf::exists(PathConfig::getExternalDataPath() / this->getPath()))
79            path = PathConfig::getExternalDataPath() / this->getPath();
80        else
81        {
82            orxout(internal_warning) << "ResourceLocation '" << this->getPath() << "' does not seem to exist" << endl;
83            return;
84        }
85
86        // Add it to the Ogre paths
87        Ogre::ResourceGroupManager::getSingleton().addResourceLocation(
88            path.string(), this->getArchiveType(), resourceGroup, this->getRecursive());
89        resourceGroup_ = resourceGroup;
90    }
91
92    void ResourceLocation::unload()
93    {
94        // Remove from Ogre paths
95        resourceGroup_.clear();
96        try
97        {
98            Ogre::ResourceGroupManager::getSingleton().removeResourceLocation(
99                this->getPath(), this->getResourceGroup());
100        }
101        catch (const Ogre::Exception& ex)
102        {
103            orxout(internal_error) << "Removing of a ResourceLocation failed: " << ex.what() << endl;
104        }
105    }
106}
Note: See TracBrowser for help on using the repository browser.