RPA Toolkit
Added more documentation files. Added rpastatpriv.h, containing the private interface...
[rpatk.git] / rpa / rpaerror.h
1 /*
2  *  Regular Pattern Analyzer (RPA)
3  *  Copyright (c) 2009-2010 Martin Stoilov
4  *
5  *  This program is free software: you can redistribute it and/or modify
6  *  it under the terms of the GNU General Public License as published by
7  *  the Free Software Foundation, either version 3 of the License, or
8  *  (at your option) any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU General Public License for more details.
14  *
15  *  You should have received a copy of the GNU General Public License
16  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
17  *
18  *  Martin Stoilov <martin@rpasearch.com>
19  */
20
21 /**
22  * \file rpaerror.h
23  * \brief The public interface for examining errors.
24  *
25  *
26  * <h2>Synopsis</h2>
27  * The RPA error(s) interface.
28  */
29
30 #ifndef _RPAERROR_H_
31 #define _RPAERROR_H_
32
33 #include "rtypes.h"
34
35 #define RPA_ERRINFO_NONE 0
36 #define RPA_ERRINFO_CODE (1<<0)
37 #define RPA_ERRINFO_OFFSET (1<<1)
38 #define RPA_ERRINFO_RULEID (1<<2)
39 #define RPA_ERRINFO_NAME (1<<3)
40
41
42 #define RPA_E_NONE 0
43 #define RPA_E_OUTOFMEM 1001
44 #define RPA_E_INVALID_INPUT 1002
45 #define RPA_E_NOTOPEN 1003
46 #define RPA_E_NOTCLOSED 1004
47 #define RPA_E_NOTFOUND 1005
48 #define RPA_E_SYNTAX_ERROR 1006
49 #define RPA_E_UNRESOLVED_SYMBOL 1007
50 #define RPA_E_PARAM 1008
51
52 #define RPA_E_USERABORT 2001
53
54 /**
55  * \typedef rpaerror_t
56  * \brief RPA error description.
57  */
58 typedef struct rpa_errinfo_s rpa_errinfo_t;
59 struct rpa_errinfo_s {
60         rulong mask;
61         rlong code;
62         rlong offset;
63         rlong ruleid;
64         rchar name[128];
65 };
66
67
68 #endif