Files
OpenSceneGraph/src/osgDB/Input.cpp
Robert Osfield dd996a3289 Introduced CMake option OSG_PROVIDE_READFILE option that defaults to ON, but when switched to OFF disables the building of the osgDB::read*File() methods,
forcing users to use osgDB::readRef*File() methods.  The later is preferable as it closes a potential threading bug when using paging databases in conjunction
with the osgDB::Registry Object Cache.  This threading bug occurs when one thread gets an object from the Cache via an osgDB::read*File() call where only
a pointer to the object is passed back, so taking a reference to the object is delayed till it gets reassigned to a ref_ptr<>, but at the same time another
thread calls a flush of the Object Cache deleting this object as it's referenceCount is now zero.  Using osgDB::readREf*File() makes sure the a ref_ptr<> is
passed back and the referenceCount never goes to zero.

To ensure the OSG builds when OSG_PROVIDE_READFILE is to OFF the many cases of osgDB::read*File() usage had to be replaced with a ref_ptr<> osgDB::readRef*File()
usage.  The avoid this change causing lots of other client code to be rewritten to handle the use of ref_ptr<> in place of C pointer I introduced a serious of
templte methods in various class to adapt ref_ptr<> to the underly C pointer to be passed to old OSG API's, example of this is found in include/osg/Group:

    bool addChild(Node* child); // old method which can only be used with a Node*

    tempalte<class T> bool addChild(const osg::ref_ptr<T>& child) { return addChild(child.get()); } // adapter template method

These changes together cover 149 modified files, so it's a large submission. This extent of changes are warrent to make use of the Object Cache
and multi-threaded loaded more robust.



git-svn-id: http://svn.openscenegraph.org/osg/OpenSceneGraph/trunk@15164 16af8721-9629-0410-8352-f15c8da7e697
2015-10-22 13:42:19 +00:00

414 lines
13 KiB
C++

/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
*
* This library is open source and may be redistributed and/or modified under
* the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
* (at your option) any later version. The full license is in LICENSE file
* included with this distribution, and on the openscenegraph.org website.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* OpenSceneGraph Public License for more details.
*/
#include <osg/Object>
#include <osgDB/Registry>
#include <osgDB/ReadFile>
#include <osgDB/Input>
using namespace osgDB;
Input::Input()
{
}
Input::~Input()
{
}
osg::Object* Input::getObjectForUniqueID(const std::string& uniqueID)
{
UniqueIDToObjectMapping::iterator fitr = _uniqueIDToObjectMap.find(uniqueID);
if (fitr != _uniqueIDToObjectMap.end()) return (*fitr).second.get();
else return NULL;
}
void Input::registerUniqueIDForObject(const std::string& uniqueID,osg::Object* obj)
{
_uniqueIDToObjectMap[uniqueID] = obj;
}
osg::Object* Input::readObjectOfType(const osg::Object& compObj)
{
return Registry::instance()->getDeprecatedDotOsgObjectWrapperManager()->readObjectOfType(compObj,*this);
}
osg::Object* Input::readObjectOfType(const basic_type_wrapper &btw)
{
return Registry::instance()->getDeprecatedDotOsgObjectWrapperManager()->readObjectOfType(btw,*this);
}
osg::Object* Input::readObject()
{
return Registry::instance()->getDeprecatedDotOsgObjectWrapperManager()->readObject(*this);
}
osg::Image* Input::readImage()
{
return Registry::instance()->getDeprecatedDotOsgObjectWrapperManager()->readImage(*this);
}
osg::Drawable* Input::readDrawable()
{
return Registry::instance()->getDeprecatedDotOsgObjectWrapperManager()->readDrawable(*this);
}
osg::StateAttribute* Input::readStateAttribute()
{
return Registry::instance()->getDeprecatedDotOsgObjectWrapperManager()->readStateAttribute(*this);
}
osg::Uniform* Input::readUniform()
{
return Registry::instance()->getDeprecatedDotOsgObjectWrapperManager()->readUniform(*this);
}
osg::Node* Input::readNode()
{
return Registry::instance()->getDeprecatedDotOsgObjectWrapperManager()->readNode(*this);
}
osg::Shader* Input::readShader()
{
return Registry::instance()->getDeprecatedDotOsgObjectWrapperManager()->readShader(*this);
}
osg::ref_ptr<osg::Object> Input::readObject(const std::string& fileName)
{
return readRefObjectFile(fileName,_options.get());
}
osg::ref_ptr<osg::Image> Input::readImage(const std::string& fileName)
{
return readRefImageFile(fileName,_options.get());
}
osg::ref_ptr<osg::Node> Input::readNode(const std::string& fileName)
{
return readRefNodeFile(fileName,_options.get());
}
osg::ref_ptr<osg::Shader> Input::readShader(const std::string& fileName)
{
return readRefShaderFile(fileName,_options.get());
}
bool Input::read(Parameter value1)
{
if (value1.valid((*this)[0].getStr()))
{
value1.assign((*this)[0].getStr());
(*this) += 1;
return true;
}
else return false;
}
bool Input::read(Parameter value1, Parameter value2)
{
if (value1.valid((*this)[0].getStr()) &&
value2.valid((*this)[1].getStr()))
{
value1.assign((*this)[0].getStr());
value2.assign((*this)[1].getStr());
(*this) += 2;
return true;
}
else return false;
}
bool Input::read(Parameter value1, Parameter value2, Parameter value3)
{
if (value1.valid((*this)[0].getStr()) &&
value2.valid((*this)[1].getStr()) &&
value3.valid((*this)[2].getStr()))
{
value1.assign((*this)[0].getStr());
value2.assign((*this)[1].getStr());
value3.assign((*this)[2].getStr());
(*this) += 3;
return true;
}
else return false;
}
bool Input::read(Parameter value1, Parameter value2, Parameter value3, Parameter value4)
{
if (value1.valid((*this)[0].getStr()) &&
value2.valid((*this)[1].getStr()) &&
value3.valid((*this)[2].getStr()) &&
value4.valid((*this)[3].getStr()))
{
value1.assign((*this)[0].getStr());
value2.assign((*this)[1].getStr());
value3.assign((*this)[2].getStr());
value4.assign((*this)[3].getStr());
(*this) += 4;
return true;
}
else return false;
}
bool Input::read(Parameter value1, Parameter value2, Parameter value3, Parameter value4, Parameter value5)
{
if (value1.valid((*this)[0].getStr()) &&
value2.valid((*this)[1].getStr()) &&
value3.valid((*this)[2].getStr()) &&
value4.valid((*this)[3].getStr()) &&
value5.valid((*this)[4].getStr()))
{
value1.assign((*this)[0].getStr());
value2.assign((*this)[1].getStr());
value3.assign((*this)[2].getStr());
value4.assign((*this)[3].getStr());
value5.assign((*this)[4].getStr());
(*this) += 5;
return true;
}
else return false;
}
bool Input::read(Parameter value1, Parameter value2, Parameter value3, Parameter value4, Parameter value5, Parameter value6)
{
if (value1.valid((*this)[0].getStr()) &&
value2.valid((*this)[1].getStr()) &&
value3.valid((*this)[2].getStr()) &&
value4.valid((*this)[3].getStr()) &&
value5.valid((*this)[4].getStr()) &&
value6.valid((*this)[5].getStr()))
{
value1.assign((*this)[0].getStr());
value2.assign((*this)[1].getStr());
value3.assign((*this)[2].getStr());
value4.assign((*this)[3].getStr());
value5.assign((*this)[4].getStr());
value6.assign((*this)[5].getStr());
(*this) += 6;
return true;
}
else return false;
}
bool Input::read(Parameter value1, Parameter value2, Parameter value3, Parameter value4, Parameter value5, Parameter value6, Parameter value7)
{
if (value1.valid((*this)[0].getStr()) &&
value2.valid((*this)[1].getStr()) &&
value3.valid((*this)[2].getStr()) &&
value4.valid((*this)[3].getStr()) &&
value5.valid((*this)[4].getStr()) &&
value6.valid((*this)[5].getStr()) &&
value7.valid((*this)[6].getStr()))
{
value1.assign((*this)[0].getStr());
value2.assign((*this)[1].getStr());
value3.assign((*this)[2].getStr());
value4.assign((*this)[3].getStr());
value5.assign((*this)[4].getStr());
value6.assign((*this)[5].getStr());
value7.assign((*this)[6].getStr());
(*this) += 7;
return true;
}
else return false;
}
bool Input::read(Parameter value1, Parameter value2, Parameter value3, Parameter value4, Parameter value5, Parameter value6, Parameter value7, Parameter value8)
{
if (value1.valid((*this)[0].getStr()) &&
value2.valid((*this)[1].getStr()) &&
value3.valid((*this)[2].getStr()) &&
value4.valid((*this)[3].getStr()) &&
value5.valid((*this)[4].getStr()) &&
value6.valid((*this)[5].getStr()) &&
value7.valid((*this)[6].getStr()) &&
value8.valid((*this)[7].getStr()))
{
value1.assign((*this)[0].getStr());
value2.assign((*this)[1].getStr());
value3.assign((*this)[2].getStr());
value4.assign((*this)[3].getStr());
value5.assign((*this)[4].getStr());
value6.assign((*this)[5].getStr());
value7.assign((*this)[6].getStr());
value8.assign((*this)[7].getStr());
(*this) += 8;
return true;
}
else return false;
}
bool Input::read(const char* str)
{
if ((*this)[0].matchWord(str))
{
(*this) += 1;
return true;
}
else return false;
}
bool Input::read(const char* str, Parameter value1)
{
if ((*this)[0].matchWord(str) && value1.valid((*this)[1].getStr()))
{
value1.assign((*this)[1].getStr());
(*this) += 2;
return true;
}
else return false;
}
bool Input::read(const char* str, Parameter value1, Parameter value2)
{
if ((*this)[0].matchWord(str) &&
value1.valid((*this)[1].getStr()) &&
value2.valid((*this)[2].getStr()))
{
value1.assign((*this)[1].getStr());
value2.assign((*this)[2].getStr());
(*this) += 3;
return true;
}
else return false;
}
bool Input::read(const char* str, Parameter value1, Parameter value2, Parameter value3)
{
if ((*this)[0].matchWord(str) &&
value1.valid((*this)[1].getStr()) &&
value2.valid((*this)[2].getStr()) &&
value3.valid((*this)[3].getStr()))
{
value1.assign((*this)[1].getStr());
value2.assign((*this)[2].getStr());
value3.assign((*this)[3].getStr());
(*this) += 4;
return true;
}
else return false;
}
bool Input::read(const char* str, Parameter value1, Parameter value2, Parameter value3, Parameter value4)
{
if ((*this)[0].matchWord(str) &&
value1.valid((*this)[1].getStr()) &&
value2.valid((*this)[2].getStr()) &&
value3.valid((*this)[3].getStr()) &&
value4.valid((*this)[4].getStr()))
{
value1.assign((*this)[1].getStr());
value2.assign((*this)[2].getStr());
value3.assign((*this)[3].getStr());
value4.assign((*this)[4].getStr());
(*this) += 5;
return true;
}
else return false;
}
bool Input::read(const char* str, Parameter value1, Parameter value2, Parameter value3, Parameter value4, Parameter value5)
{
if ((*this)[0].matchWord(str) &&
value1.valid((*this)[1].getStr()) &&
value2.valid((*this)[2].getStr()) &&
value3.valid((*this)[3].getStr()) &&
value4.valid((*this)[4].getStr()) &&
value5.valid((*this)[5].getStr()))
{
value1.assign((*this)[1].getStr());
value2.assign((*this)[2].getStr());
value3.assign((*this)[3].getStr());
value4.assign((*this)[4].getStr());
value5.assign((*this)[5].getStr());
(*this) += 6;
return true;
}
else return false;
}
bool Input::read(const char* str, Parameter value1, Parameter value2, Parameter value3, Parameter value4, Parameter value5, Parameter value6)
{
if ((*this)[0].matchWord(str) &&
value1.valid((*this)[1].getStr()) &&
value2.valid((*this)[2].getStr()) &&
value3.valid((*this)[3].getStr()) &&
value4.valid((*this)[4].getStr()) &&
value5.valid((*this)[5].getStr()) &&
value6.valid((*this)[6].getStr()))
{
value1.assign((*this)[1].getStr());
value2.assign((*this)[2].getStr());
value3.assign((*this)[3].getStr());
value4.assign((*this)[4].getStr());
value5.assign((*this)[5].getStr());
value6.assign((*this)[6].getStr());
(*this) += 7;
return true;
}
else return false;
}
bool Input::read(const char* str, Parameter value1, Parameter value2, Parameter value3, Parameter value4, Parameter value5, Parameter value6, Parameter value7)
{
if ((*this)[0].matchWord(str) &&
value1.valid((*this)[1].getStr()) &&
value2.valid((*this)[2].getStr()) &&
value3.valid((*this)[3].getStr()) &&
value4.valid((*this)[4].getStr()) &&
value5.valid((*this)[5].getStr()) &&
value6.valid((*this)[6].getStr()) &&
value7.valid((*this)[7].getStr()))
{
value1.assign((*this)[1].getStr());
value2.assign((*this)[2].getStr());
value3.assign((*this)[3].getStr());
value4.assign((*this)[4].getStr());
value5.assign((*this)[5].getStr());
value6.assign((*this)[6].getStr());
value7.assign((*this)[7].getStr());
(*this) += 8;
return true;
}
else return false;
}
bool Input::read(const char* str, Parameter value1, Parameter value2, Parameter value3, Parameter value4, Parameter value5, Parameter value6, Parameter value7, Parameter value8)
{
if ((*this)[0].matchWord(str) &&
value1.valid((*this)[1].getStr()) &&
value2.valid((*this)[2].getStr()) &&
value3.valid((*this)[3].getStr()) &&
value4.valid((*this)[4].getStr()) &&
value5.valid((*this)[5].getStr()) &&
value6.valid((*this)[6].getStr()) &&
value7.valid((*this)[7].getStr()) &&
value8.valid((*this)[8].getStr()))
{
value1.assign((*this)[1].getStr());
value2.assign((*this)[2].getStr());
value3.assign((*this)[3].getStr());
value4.assign((*this)[4].getStr());
value5.assign((*this)[5].getStr());
value6.assign((*this)[6].getStr());
value7.assign((*this)[7].getStr());
value8.assign((*this)[8].getStr());
(*this) += 9;
return true;
}
else return false;
}