vos/applibs/otd/otdutil.hh

Go to the documentation of this file.

/*  $Id: otdutil.hh,v 1.4 2003/07/22 05:09:53 tetron Exp $

    Copyright (C) 2002 Reed Hedges <reed@interreality.org>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program 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
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/


/*  This code is partially based on the "outline.c" example distributed
    with expat. (debian: libexpat1-dev) 

    This code requires expat (debian: libexpat1, libexpat1-dev), and
    VOS core libs. 
*/

#ifndef _OTD_UTIL_HH_
#define _OTD_UTIL_HH_

#include <deque>
#include <vos/corelibs/vos/vos.hh>


/** A small OTD utility library. Allows you to perform actions based on
    a local directory containing OTD files.  Currently the only action
    available is the automatic creation of required subobjects. 
    
    @ingroup applibs
    @ingroup otdutil
*/

namespace OTD {

    /** Looks for OTDs in directories in the VOS_OTD_PATH environment 
        variable, or in the default location if there is no such environment
        variable.
        If used, VOS_OTD_PATH should be a colon seperated list of directories.
        The default OTD directory is <INSTALL PREFIX>/share/vos/otd.
    */
    void scan();

    /** Scan one directory 'dirname', recursing into subdirectories,
        parsing all OTDs until some basic info is gathered. 
        Files are left open.
    */
    void scanDir(string d); 

    /** Free heap memory and close all open files.  */
    void cleanup(); 

    /** Rescan the OTD directories for added/removed OTDs.
        @see scan()
      */
    void rescan(); 

    /** Parse OTDs for each type string in 'types', and create required
        subobjects. If you have registered the Metaobjects extenders, then
        the created object of that type will contain that metaobject, otherwise,
        it will just have the typestring it its type list, but no metaobject 
        instance attached. 
        The new objects will be added as children with
        the correct names under 'vobj'.  If site is 0, then the site for
        'vobj' is used to create the new objects.
    */
    void initObject(deque<string>& types, Vobject* vobj, Site* site); 

};  // ns OTD


#endif // ifdef _OTD_UTIL_HH_

---