CallBacks.h

#ifndef REBECCA_CALLBACKS_H
#define REBECCA_CALLBACKS_H

/*
 * RebeccaAIML, Artificial Intelligence Markup Language 
 * C++ api and engine.
 *
 * Copyright (C) 2005,2006,2007 Frank Hassanabad
 *
 * This file is part of RebeccaAIML.
 *
 * RebeccaAIML 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 3 of the License, or
 * (at your option) any later version.
 *
 * RebeccaAIML 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, see <http://www.gnu.org/licenses/>.
 */

//To get the REBECA_EXPORT macro
#include <rebecca/exports.h>

//See AimlFacade for the explanation of this namespace
namespace rebecca
{
//See AimlFacade for the explanation of this namespace
namespace impl
{

//Forward decleration of StringPimpl
class StringPimpl;

class REBECCA_EXPORT CallBacks
{
    public:

        /*
         * Informative callbacks
         *
         */

        virtual void storeGossip(const StringPimpl &gossip,
                                 const StringPimpl &userId,
                                 const StringPimpl &botId,
                                 const StringPimpl &endUserId) 
        { }
        
        virtual void categoryLoaded(const StringPimpl &userId,
                                    const StringPimpl &botId,
                                    const StringPimpl &endUserId) 

        { }

        virtual void filePreLoad(const StringPimpl &fileName,
                                 const StringPimpl &userId,
                                 const StringPimpl &botId,
                                 const StringPimpl &endUserId) 
        { }

        virtual void filePostLoad(const StringPimpl &fileName,
                                  const StringPimpl &userId,
                                  const StringPimpl &botId,
                                  const StringPimpl &endUserId) 
        { }

        virtual void symbolicReduction(const StringPimpl &symbol,
                                       const StringPimpl &userId,
                                       const StringPimpl &botId,
                                       const StringPimpl &endUserId) 
        { }
        
        virtual void infiniteSymbolicReduction(const StringPimpl &userId,
                                               const StringPimpl &botId,
                                               const StringPimpl &endUserId) 
        { } 

        /*
         * XML Parse Errors
         *
         */

        virtual void XMLParseError(const StringPimpl &message,
                                   const StringPimpl &userId,
                                   const StringPimpl &botId,
                                   const StringPimpl &endUserId) 
        { } 

        virtual void XMLParseWarning(const StringPimpl &message,
                                     const StringPimpl &userId,
                                     const StringPimpl &botId,
                                     const StringPimpl &endUserId) 
        { } 

        virtual void XMLParseFatalError(const StringPimpl &message,
                                        const StringPimpl &userId,
                                        const StringPimpl &botId,
                                        const StringPimpl &endUserId) 
        { } 

        /*
         * AIML tag Errors
         *
         */

        virtual void thatStarTagSizeExceeded(const StringPimpl &userId,
                                             const StringPimpl &botId,
                                             const StringPimpl &endUserId) 
        { }

        virtual void topicStarTagSizeExceeded(const StringPimpl &userId,
                                              const StringPimpl &botId,
                                              const StringPimpl &endUserId) 
        { }

        virtual void starTagSizeExceeded(const StringPimpl &userId,
                                         const StringPimpl &botId,
                                         const StringPimpl &endUserId) 
        { }

        virtual void inputTagNumericConversionError(const StringPimpl &message,
                                                    const StringPimpl &userId,
                                                    const StringPimpl &botId,
                                                    const StringPimpl &endUserId) 
        { }

        virtual void inputTagSizeExceeded(const StringPimpl &userId,
                                          const StringPimpl &botId,
                                          const StringPimpl &endUserId) 
        { } 

        virtual void starTagNumericConversionError(const StringPimpl &message,
                                                   const StringPimpl &userId,
                                                   const StringPimpl &botId,
                                                   const StringPimpl &endUserId) 
        { } 

        virtual void thatTagSizeExceeded(const StringPimpl &userId,
                                         const StringPimpl &botId,
                                         const StringPimpl &endUserId) 
        { }

        virtual void thatTagNumericConversionError(const StringPimpl &message,
                                                   const StringPimpl &userId,
                                                   const StringPimpl &botId,
                                                   const StringPimpl &endUserId) 
        { } 

        virtual void topicStarTagNumericConversionError(const StringPimpl &message,
                                                        const StringPimpl &userId,
                                                        const StringPimpl &botId,
                                                        const StringPimpl &endUserId) 
        { } 

        virtual void thatStarTagNumericConversionError(const StringPimpl &message,
                                                       const StringPimpl &userId,
                                                       const StringPimpl &botId,
                                                       const StringPimpl &endUserId) 
        { }
        
        virtual void learnTagFileNotFound(const StringPimpl &message,
                                          const StringPimpl &userId,
                                          const StringPimpl &botId,
                                          const StringPimpl &endUserId) 
        { } 

        virtual ~CallBacks() { }
};


} //end namespace impl

//expose CallBacks to Rebecca namespace 
using rebecca::impl::CallBacks;

} //end namespace rebecca

#endif

---