vos/corelibs/typechain/typehandler.hh

Go to the documentation of this file.

/* $Id: typehandler.hh,v 1.17 2003/07/24 17:37:44 tetron Exp $ */

/** @file typehandler.hh    defines a rudimentary type handler from which
    you may derive specific type handlers, and a type handler which passes
    data through an external program.
    @author Reed sept 2001
*/

/*
    This file is part of the Virtual Object System of
    the Interreality project (http://interreality.org).

    Copyright (C) 2001, 2002 Reed Hedges <reed@zerohour.net>

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

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

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

#ifndef _TYPEHANDLER_HH_
#define _TYPEHANDLER_HH_

#include <string>
#include <map>
#include <stdio.h>
#include "typechain.hh"






typedef std::map<std::string, std::string> TypeParams;

/** Derive your specific type handlers from this class, for use with the TypeChain
    utility. As is, it implements the "identity" encoding, as described in the
    typechain document ($CVSROOT/s3/doc/typechain.txt), and similiar to encodings
    mentioned in various RFCs.
    @TODO add methods that use streams.
    @see TypeChain
    @author Reed Hedges <reed@zerohour.net> September, 2001
*/

class TypeHandler  {
public:

    /** Type/encoding identifier  */
    string type_name;

    /** A common filename extension for this type. (Used by TypeChain::guessTypeFromFilename()) */
    string filename_extension;

    /** Constructor */
    TypeHandler(string name, string file_ext = "?") : type_name(name), filename_extension(file_ext) {}

    /** Destructor */
    virtual ~TypeHandler() {};

    /** Decode data with parameters params. This class implements the "identity" type, and does no decoding. */
    virtual void decode(std::string& data, TypeParams& params)  {
    }

    /** Create empty params map and decode. */
    void decode(std::string& data) {
        TypeParams empty;
        decode(data, empty);
    }

    /** Encode data with parameters params. This class implements the "identity" type, and does no encoding. */
    virtual void encode(std::string& data, TypeParams& params) {
    }

    /** Create empty params map and encode. */
    void encode(std::string& data) {
        TypeParams empty;
        encode(data, empty);
    }

};



#endif

---