debugger_event_handler.h
Go to the documentation of this file.
1 /*
2  * Copyright 2006-2008 The FLWOR Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #pragma once
17 
18 #include <string>
19 
20 namespace zorba {
22  public:
23  /**
24  * @brief This method gets called whenever the debugger client
25  * gets a message from the debug engine.
26  *
27  * When the client gets a message from the debug engine, it reads the
28  * message to a string and calls this method. The message is an XML
29  * document - so the implementation has to parse this node.
30  *
31  * @param aMessage The message recieved from the debug engine.
32  */
33  virtual void parseMessage(const std::string& aMessage) = 0;
34 
35  /**
36  * @brief Method which gets called if an error occurs.
37  *
38  * This method gets called if an error occurs. This can be either
39  * an error in the client or in the parser.
40  *
41  * @param errcode The error code.
42  * @param msg A UI usable message.
43  */
44  virtual void error(unsigned int errcode, const std::string& msg) = 0;
45  };
46 }