/net/fileserver/nas/home/mdh/vrq/src/cbackend.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (C) 1997-2007, Mark Hummel
 * This file is part of Vrq.
 *
 * Vrq 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.
 *
 * Vrq 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 library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, 
 * Boston, MA  02110-1301  USA
 *****************************************************************************
 */
/******************************************************************************
 *
 *
 *         cbackend.hpp
 *              - abstract class definition for code generators 
 *
 ******************************************************************************
 */

#ifndef CBACKEND_HPP
#define CBACKEND_HPP

#include <stdio.h>
#include "glue.h"
#include <list>
#include <map>
#include <string>

using namespace std;

class CNode;
class CModule;
class CInstance;
class CObstack;

class CElement
{
private:
    string filename;       // Optional filename for compilation unit
    int    filenameValid;  // non-zero to indicate filename is valid
    CNode* code;           // parse tree pointer for compilation unit
public:
    CElement( const char* filename, int filenameValid, CNode* code ) :
        filename(filename),
        filenameValid( filenameValid ),
        code(code ) {}
    const char* Filename() { return filenameValid ? filename.c_str() : NULL; }
    CNode* Code() { return code; }      
    void   Code( CNode* code ) { this->code = code; }   
};

class CBackendException {};
class CBackendAbort : CBackendException {};
class CBackendExit : CBackendException {};
class CBackendFail : CBackendException {};

class CBackend 
{
protected:
    list<string>       switches;  
    map<string,string> switchDescription; 
public:
        virtual char* GetToolName( void ) = 0;
        virtual char* GetToolDescription( void ) = 0;
        virtual int AcceptAllPlusArgs( void ) { return FALSE; }
        virtual list<string>& GetSwitches( void ) {return switches;}
        virtual const char* GetSwitchDescription( const char* sw ) 
        {
            MASSERT( switchDescription.find(sw) != 
                                switchDescription.end() );
            return switchDescription[sw].c_str();
        }
        virtual void RegisterSwitch( const char* switchName, 
                                                const char* description )
        {
            switches.push_back( switchName );
            switchDescription[switchName] = description;
        }
        virtual int ResolveModules() = 0;
        virtual int ResolveInstance( CModule* module, CInstance* inst ) = 0;
        virtual int HideTool() { return FALSE; } 
        virtual int IgnoreVrqComments() { return FALSE; }
        virtual void Activate() = 0;
        virtual void Process( list<CElement>& inputList,
                              list<CElement>& outputList ) = 0;
};

#endif // CBACKEND_HPP