format.h

Go to the documentation of this file.

/**********************************************************************
obconversion.cpp -  Declarations for OBFormat

Copyright (C) 2004-2007 by Chris Morley
Some portions Copyright (C) 2005-2007 by Geoffrey Hutchison

This file is part of the Open Babel project.
For more information, see <http://openbabel.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 version 2 of the License.

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.
***********************************************************************/
#ifndef OB_FORMAT_H
#define OB_FORMAT_H
#include <openbabel/babelconfig.h>
#include <openbabel/plugin.h>
#include <typeinfo>

namespace OpenBabel
{
  class OBBase;
  class OBConversion;

#define NOTREADABLE     0x01
#define READONEONLY     0x02
#define READBINARY      0x04
#define ZEROATOMSOK     0x08
#define NOTWRITABLE     0x10
#define WRITEONEONLY    0x20
#define WRITEBINARY     0x40
#define READXML         0x80
#define DEPICTION2D     0x100
#define DEFAULTFORMAT   0x4000

  // class introduction in obconversion.cpp
class OBCONV OBFormat : public OBPlugin
  {
    //Macro to include functions to handle plugin operations
    MAKE_PLUGIN(OBFormat);

  public:

    OBFormat(){}

    const char* TypeID(){ return "formats"; }


    virtual bool ReadMolecule(OBBase* /*pOb*/, OBConversion* /*pConv*/)
      { std::cerr << "HIER" << std::endl;
std::cerr << "Not a valid input format"; return false;}


    virtual bool ReadChemObject(OBConversion* /*pConv*/)
      { std::cerr << "Not a valid input format"; return false;}


    virtual bool WriteMolecule(OBBase* /*pOb*/, OBConversion* /*pConv*/)
      { std::cerr << "Not a valid output format"; return false;}


    virtual bool WriteChemObject(OBConversion* /*pConv*/)
      { std::cerr << "Not a valid output format"; return false;}


    virtual const char* Description()=0;


    virtual const char* TargetClassDescription();


    virtual const std::type_info& GetType();

    virtual const char* SpecificationURL() { return ""; }

    virtual const char* GetMIMEType() { return pMime; }


    virtual unsigned int Flags() { return 0;};


    virtual int SkipObjects(int /*n*/, OBConversion* /*pConv*/)
      {
        return 0; //shows not implemented in the format class
      };


    virtual OBFormat* MakeNewInstance()
      {
        return NULL; //shows not implemented in the format class
      }

    //New functions since OBFormat is derived from OBPlugin
    //\brief Called from, and an alternative to, OBConversion::RegisterFormat();
    int RegisterFormat(const char* ID, const char* MIME = NULL);

    virtual bool Display(std::string& txt, const char* param, const char* ID=NULL);

    static OBFormat* FormatFromMIME(const char* MIME);

private:
    static PluginMapType &FormatsMIMEMap()
    {
      static PluginMapType m;
      return m;
    }

    const char* pMime;
/* Functions provided by the MAKE_PLUGIN macro

  Not currently used for formats
  OBFormat(const char* ID, bool IsDefault=false);

  static OBFormat* FindType(const char* ID);

*/};

}//namespace
#endif