summaryrefslogtreecommitdiffabout
path: root/include/sitecing/magic.h
Unidiff
Diffstat (limited to 'include/sitecing/magic.h') (more/less context) (ignore whitespace changes)
-rw-r--r--include/sitecing/magic.h63
1 files changed, 63 insertions, 0 deletions
diff --git a/include/sitecing/magic.h b/include/sitecing/magic.h
new file mode 100644
index 0000000..4802fcc
--- a/dev/null
+++ b/include/sitecing/magic.h
@@ -0,0 +1,63 @@
1 #ifndef__SITECING_MAGIC_H
2#define __SITECING_MAGIC_H
3
4/**
5 * @file
6 * @brief The magic numbers globally defined.
7 */
8
9namespace sitecing {
10
11 /**
12 * The magic numbers enumeration.
13 */
14 enum {
15 /**
16 * There is no magic.
17 */
18 __magic_none = 0,
19 /**
20 * Here is where user-defined magic starts.
21 */
22 __user_magical_numbers_start = 1,
23 /**
24 * Here is where site-C-ing defined magic starts.
25 */
26 __sitecing_magical_numbers_start = 0x8000,
27 /**
28 * The compiler error occured. The parameters passed are:
29 *
30 * char *message, char *root_source, char *root_intermediate, char *root_so, char *component
31 */
32 __magic_compile_error,
33 /**
34 * The preprocessor error occured. The parameters passed are:
35 *
36 * char *message, char *root_source, char *root_intermediate, char *root_so, char *component,
37 * int line_number
38 */
39 __magic_preprocess_error,
40 /**
41 * Exception caught while executing the component. The parameters passed are:
42 *
43 * char *message, char *root_source, char *root_intermediate, char *root_so, char *component,
44 * const exception *exception_caught
45 */
46 __magic_generic_exception,
47 /**
48 * The component called as an action handler. The parameters passed are:
49 *
50 * char *root_source, char *root_intermediate, char *root_so, list<string>* args
51 */
52 __magic_action,
53 /**
54 * The component called as an HTTP status handler. The parameters passed are:
55 *
56 * char *root_source, char *root_intermediate, char *root_so, char *component,
57 * const http_status *http_status_caught
58 */
59 __magic_http_status
60 };
61}
62
63#endif /* __SITECING_MAGIC_H */