[osg-users] .ive plugin: incorrect ReadResult?

[Paul Martz]

Thanks, Jeremy. I'll try to facilitate things further by taking the lab
example that Bob mentioned, and identify "areas of suspicion. I'll post my
results tonight or tomorrow.
   -Paul

> 
> Broken up into lists of 10:
> 
> 3dc
> 3ds
> ac
> bmp
> bsp
> cfg
> curl
> dae
> dds
> dw
> 
> dxf
> freetype
> gdal
> geo
> gif
> glsl
> hdr
> Inventor
> ive
> jp2
> 
> jpeg
> logo
> lwo
> lws
> md2
> net
> normals
> obj
> ogr
> OpenFlight
> 
> osg
> osga
> osgFX
> osgParticle
> osgShadow
> osgSim
> osgTerrain
> osgText
> osgtgz
> osgViewer
> 
> pfb
> pic
> png
> pnm
> quicktime
> rgb
> rot
> scale
> shp
> stl
> 
> tga
> tgz
> tiff
> trans
> txf
> txp
> vrml
> x
> xine
> zip
> 
> Also, you don't HAVE to return a ReadResult::ReadStatus enum 
> directly; it can also be a string (I submitted a patch for 
> this a long time ago) giving some useful error message; in 
> this case, the status is set to ERROR_IN_READING_FILE.
> 
> I'll certainly volunteer to take 10 of these, though it'll be 
> a day or two before I can finish. :)
> 
> On Tue, 2008-05-06 at 14:45 +0100, Robert Osfield wrote:
> > Hi Bob and Paul,
> > 
> > Bob's doc explanation for the different ReadReasult is 
> appropriate.  I 
> > must admit not have done a project wide review of the 
> return results, 
> > the number of plugins that are available is one hindrance 
> to this so 
> > community support would be useful. Perhaps half a dozen volunteers 
> > could take a 10 each and we'll complete in no time at all.
> > 
> > Thoughts?
> > 
> > Robert.
> > 
> > On Tue, Apr 29, 2008 at 6:48 PM, Bob Kuehne 
> <rpk at blue-newt.com> wrote:
> > > hi robert, osg community,
> > >
> > >  to amplify on what paul said:
> > >
> > >  * we do a lab in our course in which we explore what 
> plugins are  
> > > capable of reading/writing.
> > >
> > >  * but! our results always show that plugins support an 
> inconsistent  
> > > mix of return values,
> > >    sometimes returning "ERROR_IN_READING_FILE" when they 
> really mean  
> > > that they don't handle
> > >    files of that extension, sometimes returning "FILE_NOT_HANDLED"
> > >  when there's an error in
> > >    reading the file data.
> > >
> > >  * as part of our course in paris this week, we've then wondered 
> > > aloud  if there's an official
> > >    osg policy for these return values, and if robert had 
> an original  
> > > design idea behind each
> > >    return value. our impression is that these mean, as follows:
> > >
> > >    FILE_NOT_HANDLED, //!< file is not appropriate for this file  
> > > reader, due to some incompatibility, but *not* a read error
> > >    FILE_NOT_FOUND, //!< file could not be found or could 
> not be read
> > >    FILE_LOADED, //!< file successfully found, loaded, and 
> converted  
> > > into osg
> > >    FILE_LOADED_FROM_CACHE, //!< file found in cache and returned
> > >    ERROR_IN_READING_FILE //!< file found, loaded, but an 
> error was  
> > > encountered during processing
> > >
> > >  if this interpretation of the errors are correct, i'd 
> like to add  
> > > doxygen documentation  to that effect, and the above 
> comments can be 
> > > in-line replaced in the  code to do so. and  i've sent a fixed 
> > > osgDB/ReadResult to osg-submissions for this purpose.
> > >
> > >  the second thing i'd like to do, though i don't have the 
> time, is 
> > > to  clean up the loaders  so that the above return scheme is used 
> > > consistently. the big problem  with the current  loaders is that 
> > > there seems to not be a lot of consistency in error  
> reporting among 
> > > all  loaders.
> > >
> > >  thoughts?
> > >  bob
> > >
> > >
> > >
> > >
> > >  On Apr 29, 2008, at 12:11 PM, Paul Martz wrote:
> > >
> > >  > Hi Robert --
> > >  >
> > >  > If the .ive file can't read a node file for any reason, it 
> > > returns  > FILE_NOT_HANDLED. This is correct if the file 
> type isn't 
> > > .ive, but  > if it  > _is_ a .ive file and it is simply 
> corrupt or 
> > > something else went wrong  > (permissions, whatever), the plugin 
> > > should return  > ERROR_IN_READING_FILE,  > shouldn't it?
> > >  >
> > >  > Many plugins appear to use return values 
> inconsistently, so this  
> > > > might be a  > widespread issue.
> > >  >
> > >  > Paul Martz
> > >  > Skew Matrix Software LLC
> > >  > http://www.skew-matrix.com <http://www.skew-matrix.com/>  > +1 
> > > 303 859 9466  >  > _______________________________________________
> > >  > osg-users mailing list
> > >  > osg-users at lists.openscenegraph.org
> > >  > 
> > > 
> http://lists.openscenegraph.org/listinfo.cgi/osg-users-openscenegrap
> > > h.org
> > >
> > >  _______________________________________________
> > >  osg-users mailing list
> > >  osg-users at lists.openscenegraph.org
> > >  
> > > 
> http://lists.openscenegraph.org/listinfo.cgi/osg-users-openscenegrap
> > > h.org
> > >
> > _______________________________________________
> > osg-users mailing list
> > osg-users at lists.openscenegraph.org
> > 
> http://lists.openscenegraph.org/listinfo.cgi/osg-users-openscenegraph.
> > org
> > 
> 
> _______________________________________________
> osg-users mailing list
> osg-users at lists.openscenegraph.org
> http://lists.openscenegraph.org/listinfo.cgi/osg-users-opensce
> negraph.org