debugger_event_handler.h
Go to the documentation of this file.
00001 /*
00002  * Copyright 2006-2008 The FLWOR Foundation.
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  * 
00008  * http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #pragma once
00017 
00018 #include <string>
00019 
00020 namespace zorba {
00021   class DebuggerEventHandler {
00022   public:
00023     /**
00024      * @brief This method gets called whenever the debugger client
00025      *        gets a message from the debug engine.
00026      *
00027      * When the client gets a message from the debug engine, it reads the
00028      * message to a string and calls this method. The message is an XML
00029      * document - so the implementation has to parse this node.
00030      *
00031      * @param aMessage The message recieved from the debug engine.
00032      */
00033     virtual void parseMessage(const std::string& aMessage) = 0;
00034 
00035     /**
00036      * @brief Method which gets called if an error occurs.
00037      *
00038      * This method gets called if an error occurs. This can be either
00039      * an error in the client or in the parser.
00040      *
00041      * @param errcode The error code.
00042      * @param msg A UI usable message.
00043      */
00044     virtual void error(unsigned int errcode, const std::string& msg) = 0;
00045   };
00046 }
blog comments powered by Disqus