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

src/osgDB/FileCache.cpp

@@ -343,7 +343,7 @@ bool FileCache::loadDatabaseRevisionsForFile(const std::string& originalFileName
         if (!cacheFileName.empty() && osgDB::fileExists(cacheFileName))
         {
             OSG_INFO<<"   found revisions file in local cache, now loading it"<<std::endl;
-            osg::ref_ptr<osg::Object> object = osgDB::readObjectFile(cacheFileName);
+            osg::ref_ptr<osg::Object> object = osgDB::readRefObjectFile(cacheFileName);
             dr_local = dynamic_cast<DatabaseRevisions*>(object.get());
             if (dr_local)
             {
@@ -357,7 +357,7 @@ bool FileCache::loadDatabaseRevisionsForFile(const std::string& originalFileName
     }
 
     // now load revision file from remote server
-    osg::ref_ptr<osg::Object> object = osgDB::readObjectFile(revisionsFileName+".curl");
+    osg::ref_ptr<osg::Object> object = osgDB::readRefObjectFile(revisionsFileName+".curl");
     osg::ref_ptr<DatabaseRevisions> dr_remote = dynamic_cast<DatabaseRevisions*>(object.get());
 
     if (dr_remote.valid())
@@ -463,7 +463,7 @@ FileList* FileCache::readFileList(const std::string& originalFileName) const
     std::string cacheFileListName = createCacheFileName(originalFileName);
     if (!cacheFileListName.empty() && osgDB::fileExists(cacheFileListName))
     {
-        osg::ref_ptr<osg::Object> object = osgDB::readObjectFile(cacheFileListName);
+        osg::ref_ptr<osg::Object> object = osgDB::readRefObjectFile(cacheFileListName);
         fileList = dynamic_cast<osgDB::FileList*>(object.get());
         if (fileList) OSG_INFO<<"     loadeded FileList from local cache "<<fileList->getName()<<std::endl;
     }
@@ -471,7 +471,7 @@ FileList* FileCache::readFileList(const std::string& originalFileName) const
     if (!fileList)
     {
         OSG_INFO<<"       complete_path="<<originalFileName<<std::endl;
-        osg::ref_ptr<osg::Object> object = osgDB::readObjectFile(originalFileName+".curl");
+        osg::ref_ptr<osg::Object> object = osgDB::readRefObjectFile(originalFileName+".curl");
         fileList = dynamic_cast<osgDB::FileList*>(object.get());
         if (fileList)
         {

src/osgDB/ImagePager.cpp

@@ -211,7 +211,7 @@ void ImagePager::ImageThread::run()
         if (imageRequest.valid())
         {
             // OSG_NOTICE<<"doing readImageFile("<<imageRequest->_fileName<<") index to assign = "<<imageRequest->_attachmentIndex<<std::endl;
-            osg::ref_ptr<osg::Image> image = osgDB::readImageFile(imageRequest->_fileName, imageRequest->_readOptions.get());
+            osg::ref_ptr<osg::Image> image = osgDB::readRefImageFile(imageRequest->_fileName, imageRequest->_readOptions.get());
             if (image.valid())
             {
                 // OSG_NOTICE<<"   successful readImageFile("<<imageRequest->_fileName<<") index to assign = "<<imageRequest->_attachmentIndex<<std::endl;
@@ -317,15 +317,14 @@ int ImagePager::cancel()
     return result;
 }
 
-osg::Image* ImagePager::readImageFile(const std::string& fileName, const osg::Referenced* options)
+osg::ref_ptr<osg::Image> ImagePager::readRefImageFile(const std::string& fileName, const osg::Referenced* options)
 {
     osgDB::Options* readOptions = dynamic_cast<osgDB::Options*>(const_cast<osg::Referenced*>(options));
-    return osgDB::readImageFile(fileName, readOptions);
+    return osgDB::readRefImageFile(fileName, readOptions);
 }
 
 void ImagePager::requestImageFile(const std::string& fileName, osg::Object* attachmentPoint, int attachmentIndex, double timeToMergeBy, const osg::FrameStamp* /*framestamp*/, osg::ref_ptr<osg::Referenced>& imageRequest, const osg::Referenced* options)
 {
-
     osgDB::Options* readOptions = dynamic_cast<osgDB::Options*>(const_cast<osg::Referenced*>(options));
     if (!readOptions)
     {

src/osgDB/Input.cpp

@@ -65,10 +65,7 @@ osg::Image*  Input::readImage()
 
 osg::Drawable* Input::readDrawable()
 {
-    osg::Drawable* drawable = Registry::instance()->getDeprecatedDotOsgObjectWrapperManager()->readDrawable(*this);
-    osg::Geometry* geometry = drawable ? drawable->asGeometry() : 0;
-    if (geometry && geometry->containsDeprecatedData()) geometry->fixDeprecatedData();
-    return drawable;
+    return Registry::instance()->getDeprecatedDotOsgObjectWrapperManager()->readDrawable(*this);
 }
 
 osg::StateAttribute* Input::readStateAttribute()
@@ -85,29 +82,29 @@ osg::Node* Input::readNode()
     return Registry::instance()->getDeprecatedDotOsgObjectWrapperManager()->readNode(*this);
 }
 
-osg::Object* Input::readObject(const std::string& fileName)
-{
-    return readObjectFile(fileName,_options.get());
-}
-
 osg::Shader*  Input::readShader()
 {
     return Registry::instance()->getDeprecatedDotOsgObjectWrapperManager()->readShader(*this);
 }
 
-osg::Image*  Input::readImage(const std::string& fileName)
+osg::ref_ptr<osg::Object> Input::readObject(const std::string& fileName)
 {
-    return readImageFile(fileName,_options.get());
+    return readRefObjectFile(fileName,_options.get());
 }
 
-osg::Node* Input::readNode(const std::string& fileName)
+osg::ref_ptr<osg::Image>  Input::readImage(const std::string& fileName)
 {
-    return readNodeFile(fileName,_options.get());
+    return readRefImageFile(fileName,_options.get());
 }
 
-osg::Shader*  Input::readShader(const std::string& fileName)
+osg::ref_ptr<osg::Node> Input::readNode(const std::string& fileName)
 {
-    return readShaderFile(fileName,_options.get());
+    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)

src/osgDB/InputStream.cpp

@@ -320,7 +320,7 @@ InputStream& InputStream::operator>>( osg::BoundingSphered& bs)
 
 
 
-osg::Array* InputStream::readArray()
+osg::ref_ptr<osg::Array> InputStream::readArray()
 {
     osg::ref_ptr<osg::Array> array = NULL;
 
@@ -571,10 +571,10 @@ osg::Array* InputStream::readArray()
     if ( getException() ) return NULL;
     _arrayMap[id] = array;
 
-    return array.release();
+    return array;
 }
 
-osg::PrimitiveSet* InputStream::readPrimitiveSet()
+osg::ref_ptr<osg::PrimitiveSet> InputStream::readPrimitiveSet()
 {
     osg::ref_ptr<osg::PrimitiveSet> primitive = NULL;
 
@@ -663,10 +663,10 @@ osg::PrimitiveSet* InputStream::readPrimitiveSet()
     }
 
     if ( getException() ) return NULL;
-    return primitive.release();
+    return primitive;
 }
 
-osg::Image* InputStream::readImage(bool readFromExternal)
+osg::ref_ptr<osg::Image> InputStream::readImage(bool readFromExternal)
 {
     std::string className = "osg::Image";
     if ( _fileVersion>94 )  // ClassName property is only supported in 3.1.4 and higher
@@ -858,17 +858,17 @@ osg::Image* InputStream::readImage(bool readFromExternal)
     }
     else
     {
-        image = static_cast<osg::Image*>( readObjectFields("osg::Object", id, image.get()) );
+        image = readObjectFieldsOfType<osg::Image>("osg::Object", id, image.get());
         if ( image.valid() )
         {
             image->setFileName( name );
             image->setWriteHint( (osg::Image::WriteHint)writeHint );
         }
     }
-    return image.release();
+    return image;
 }
 
-osg::Object* InputStream::readObject( osg::Object* existingObj )
+osg::ref_ptr<osg::Object> InputStream::readObject( osg::Object* existingObj )
 {
     std::string className;
     unsigned int id = 0;
@@ -880,23 +880,23 @@ osg::Object* InputStream::readObject( osg::Object* existingObj )
     }
 
     *this >> BEGIN_BRACKET >> PROPERTY("UniqueID") >> id;
-    if ( getException() ) return NULL;
+    if ( getException() ) return 0;
 
     IdentifierMap::iterator itr = _identifierMap.find( id );
     if ( itr!=_identifierMap.end() )
     {
         advanceToCurrentEndBracket();
-        return itr->second.get();
+        return itr->second;
     }
 
     osg::ref_ptr<osg::Object> obj = readObjectFields( className, id, existingObj );
 
     advanceToCurrentEndBracket();
 
-    return obj.release();
+    return obj;
 }
 
-osg::Object* InputStream::readObjectFields( const std::string& className, unsigned int id, osg::Object* existingObj )
+osg::ref_ptr<osg::Object> InputStream::readObjectFields( const std::string& className, unsigned int id, osg::Object* existingObj )
 {
     ObjectWrapper* wrapper = Registry::instance()->getObjectWrapperManager()->findWrapper( className );
     if ( !wrapper )
@@ -927,7 +927,7 @@ osg::Object* InputStream::readObjectFields( const std::string& className, unsign
             _fields.pop_back();
         }
     }
-    return obj.release();
+    return obj;
 }
 
 void InputStream::readSchema( std::istream& fin )

src/osgDB/ReadFile.cpp

@@ -29,6 +29,7 @@
 using namespace osg;
 using namespace osgDB;
 
+#ifdef OSG_PROVIDE_READFILE
 Object* osgDB::readObjectFile(const std::string& filename,const Options* options)
 {
     ReaderWriter::ReadResult rr = Registry::instance()->readObject(filename,options);
@@ -75,14 +76,82 @@ Node* osgDB::readNodeFile(const std::string& filename,const Options* options)
 
 Node* osgDB::readNodeFiles(std::vector<std::string>& fileList,const Options* options)
 {
-    typedef std::vector<osg::Node*> NodeList;
+    return readRefNodeFiles(fileList, options).release();
+}
+
+Node* osgDB::readNodeFiles(osg::ArgumentParser& arguments,const Options* options)
+{
+    return readRefNodeFiles(arguments, options).release();
+}
+
+
+Script* osgDB::readScriptFile(const std::string& filename,const Options* options)
+{
+    ReaderWriter::ReadResult rr = Registry::instance()->readScript(filename,options);
+    if (rr.validScript()) return rr.takeScript();
+    if (rr.error()) OSG_WARN << rr.message() << std::endl;
+    return NULL;
+}
+#endif
+
+osg::ref_ptr<osg::Object> osgDB::readRefObjectFile(const std::string& filename,const Options* options)
+{
+    ReaderWriter::ReadResult rr = Registry::instance()->readObject(filename,options);
+    if (rr.validObject()) return osg::ref_ptr<osg::Object>(rr.getObject());
+    if (rr.error()) OSG_WARN << rr.message() << std::endl;
+    return NULL;
+}
+
+osg::ref_ptr<osg::Image> osgDB::readRefImageFile(const std::string& filename,const Options* options)
+{
+    ReaderWriter::ReadResult rr = Registry::instance()->readImage(filename,options);
+    if (rr.validImage()) return osg::ref_ptr<osg::Image>(rr.getImage());
+    if (rr.error()) OSG_WARN << rr.message() << std::endl;
+    return NULL;
+}
+
+osg::ref_ptr<osg::Shader> osgDB::readRefShaderFile(const std::string& filename,const Options* options)
+{
+    ReaderWriter::ReadResult rr = Registry::instance()->readShader(filename,options);
+    if (rr.validShader()) return osg::ref_ptr<osg::Shader>(rr.getShader());
+    if (rr.error()) OSG_WARN << rr.message() << std::endl;
+    return NULL;
+}
+
+osg::ref_ptr<osg::HeightField> osgDB::readRefHeightFieldFile(const std::string& filename,const Options* options)
+{
+    ReaderWriter::ReadResult rr = Registry::instance()->readHeightField(filename,options);
+    if (rr.validHeightField()) return osg::ref_ptr<osg::HeightField>(rr.getHeightField());
+    if (rr.error()) OSG_WARN << rr.message() << std::endl;
+    return NULL;
+}
+
+osg::ref_ptr<osg::Node> osgDB::readRefNodeFile(const std::string& filename,const Options* options)
+{
+    ReaderWriter::ReadResult rr = Registry::instance()->readNode(filename,options);
+    if (rr.validNode()) return osg::ref_ptr<osg::Node>(rr.getNode());
+    if (rr.error()) OSG_WARN << rr.message() << std::endl;
+    return NULL;
+}
+
+osg::ref_ptr<osg::Script> osgDB::readRefScriptFile(const std::string& filename,const Options* options)
+{
+    ReaderWriter::ReadResult rr = Registry::instance()->readScript(filename,options);
+    if (rr.validScript()) return osg::ref_ptr<osg::Script>(rr.getScript());
+    if (rr.error()) OSG_WARN << rr.message() << std::endl;
+    return NULL;
+}
+
+osg::ref_ptr<Node> osgDB::readRefNodeFiles(std::vector<std::string>& fileList,const Options* options)
+{
+    typedef std::vector< osg::ref_ptr<osg::Node> > NodeList;
     NodeList nodeList;
 
     for(std::vector<std::string>::iterator itr=fileList.begin();
         itr!=fileList.end();
         ++itr)
     {
-        osg::Node *node = osgDB::readNodeFile( *itr , options );
+        osg::ref_ptr<osg::Node> node = osgDB::readRefNodeFile( *itr , options );
 
         if( node != (osg::Node *)0L )
         {
@@ -103,7 +172,7 @@ Node* osgDB::readNodeFiles(std::vector<std::string>& fileList,const Options* opt
     }
     else  // size >1
     {
-        osg::Group* group = new osg::Group;
+        osg::ref_ptr<osg::Group> group = new osg::Group;
         for(NodeList::iterator itr=nodeList.begin();
             itr!=nodeList.end();
             ++itr)
@@ -116,7 +185,7 @@ Node* osgDB::readNodeFiles(std::vector<std::string>& fileList,const Options* opt
 
 }
 
-Node* osgDB::readNodeFiles(osg::ArgumentParser& arguments,const Options* options)
+osg::ref_ptr<Node> osgDB::readRefNodeFiles(osg::ArgumentParser& arguments,const Options* options)
 {
 
     typedef std::vector< osg::ref_ptr<osg::Node> > NodeList;
@@ -131,7 +200,7 @@ Node* osgDB::readNodeFiles(osg::ArgumentParser& arguments,const Options* options
 
     while (arguments.read("--image",filename))
     {
-        osg::ref_ptr<osg::Image> image = readImageFile(filename.c_str(), options);
+        osg::ref_ptr<osg::Image> image = readRefImageFile(filename.c_str(), options);
         if (image.valid())
         {
             osg::Geode* geode = osg::createGeodeForImage(image.get());
@@ -149,7 +218,7 @@ Node* osgDB::readNodeFiles(osg::ArgumentParser& arguments,const Options* options
 
     while (arguments.read("--movie",filename))
     {
-        osg::ref_ptr<osg::Image> image = readImageFile(filename.c_str(), options);
+        osg::ref_ptr<osg::Image> image = readRefImageFile(filename.c_str(), options);
         osg::ref_ptr<osg::ImageStream> imageStream = dynamic_cast<osg::ImageStream*>(image.get());
         if (imageStream.valid())
         {
@@ -200,11 +269,11 @@ Node* osgDB::readNodeFiles(osg::ArgumentParser& arguments,const Options* options
 
     while (arguments.read("--dem",filename))
     {
-        osg::HeightField* hf = readHeightFieldFile(filename.c_str(), options);
+        osg::ref_ptr<osg::HeightField> hf = readRefHeightFieldFile(filename.c_str(), options);
         if (hf)
         {
-            osg::Geode* geode = new osg::Geode;
-            geode->addDrawable(new osg::ShapeDrawable(hf));
+            osg::ref_ptr<osg::Geode> geode = new osg::Geode;
+            geode->addDrawable(new osg::ShapeDrawable(hf.get()));
             nodeList.push_back(geode);
         }
     }
@@ -215,7 +284,7 @@ Node* osgDB::readNodeFiles(osg::ArgumentParser& arguments,const Options* options
         if (!arguments.isOption(pos))
         {
             // not an option so assume string is a filename.
-            osg::Node *node = osgDB::readNodeFile( arguments[pos], options);
+            osg::ref_ptr<osg::Node> node = osgDB::readRefNodeFile( arguments[pos], options);
 
             if(node)
             {
@@ -237,73 +306,15 @@ Node* osgDB::readNodeFiles(osg::ArgumentParser& arguments,const Options* options
     }
     else  // size >1
     {
-        osg::Group* group = new osg::Group;
+        osg::ref_ptr<osg::Group> group = new osg::Group;
         for(NodeList::iterator itr=nodeList.begin();
             itr!=nodeList.end();
             ++itr)
         {
-            group->addChild((*itr).get());
+            group->addChild(*itr);
         }
 
         return group;
     }
 
 }
-
-
-Script* osgDB::readScriptFile(const std::string& filename,const Options* options)
-{
-    ReaderWriter::ReadResult rr = Registry::instance()->readScript(filename,options);
-    if (rr.validScript()) return rr.takeScript();
-    if (rr.error()) OSG_WARN << rr.message() << std::endl;
-    return NULL;
-}
-
-
-osg::ref_ptr<osg::Object> osgDB::readRefObjectFile(const std::string& filename,const Options* options)
-{
-    ReaderWriter::ReadResult rr = Registry::instance()->readObject(filename,options);
-    if (rr.validObject()) return osg::ref_ptr<osg::Object>(rr.getObject());
-    if (rr.error()) OSG_WARN << rr.message() << std::endl;
-    return NULL;
-}
-
-osg::ref_ptr<osg::Image> osgDB::readRefImageFile(const std::string& filename,const Options* options)
-{
-    ReaderWriter::ReadResult rr = Registry::instance()->readImage(filename,options);
-    if (rr.validImage()) return osg::ref_ptr<osg::Image>(rr.getImage());
-    if (rr.error()) OSG_WARN << rr.message() << std::endl;
-    return NULL;
-}
-
-osg::ref_ptr<osg::Shader> osgDB::readRefShaderFile(const std::string& filename,const Options* options)
-{
-    ReaderWriter::ReadResult rr = Registry::instance()->readShader(filename,options);
-    if (rr.validShader()) return osg::ref_ptr<osg::Shader>(rr.getShader());
-    if (rr.error()) OSG_WARN << rr.message() << std::endl;
-    return NULL;
-}
-
-osg::ref_ptr<osg::HeightField> osgDB::readRefHeightFieldFile(const std::string& filename,const Options* options)
-{
-    ReaderWriter::ReadResult rr = Registry::instance()->readHeightField(filename,options);
-    if (rr.validHeightField()) return osg::ref_ptr<osg::HeightField>(rr.getHeightField());
-    if (rr.error()) OSG_WARN << rr.message() << std::endl;
-    return NULL;
-}
-
-osg::ref_ptr<osg::Node> osgDB::readRefNodeFile(const std::string& filename,const Options* options)
-{
-    ReaderWriter::ReadResult rr = Registry::instance()->readNode(filename,options);
-    if (rr.validNode()) return osg::ref_ptr<osg::Node>(rr.getNode());
-    if (rr.error()) OSG_WARN << rr.message() << std::endl;
-    return NULL;
-}
-
-osg::ref_ptr<osg::Script> osgDB::readRefScriptFile(const std::string& filename,const Options* options)
-{
-    ReaderWriter::ReadResult rr = Registry::instance()->readScript(filename,options);
-    if (rr.validScript()) return osg::ref_ptr<osg::Script>(rr.getScript());
-    if (rr.error()) OSG_WARN << rr.message() << std::endl;
-    return NULL;
-}