1 /**
2 * Redistribution and use in source and binary forms, with or without
3 * modification, are permitted provided that the following conditions are
4 * met :
5 *
6 * . Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 *
9 * . Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * . The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 package cpptools;
30
31 /**
32 * Defines events associated to analyzis.
33 *
34 * @author Mathieu Champlon
35 */
36 public interface EventHandler
37 {
38 /**
39 * Notify a start event.
40 */
41 void started();
42
43 /**
44 * Notify an end event.
45 *
46 * @param parsed number of files parsed
47 * @param total total number of files
48 */
49 void finished( int parsed, int total );
50
51 /**
52 * Notify an error.
53 *
54 * @param filename the location of the error
55 * @param throwable the error
56 * @param reason the description of the error
57 */
58 void error( String filename, Throwable throwable, String reason );
59
60 /**
61 * Display a diagnostic.
62 *
63 * @param filename the file name
64 * @param line the line number
65 * @param column the column offset
66 */
67 void display( String filename, int line, int column );
68
69 /**
70 * Specify the file being processed.
71 *
72 * @param filename the name of the fle
73 */
74 void changed( String filename );
75 }