capitalize dialplan function
[asterisk/asterisk.git] / include / asterisk.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * General Definitions for Asterisk top level program
5  * 
6  * Copyright (C) 1999-2005, Mark Spencer
7  *
8  * Mark Spencer <markster@digium.com>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 #ifndef _ASTERISK_H
15 #define _ASTERISK_H
16
17 #define DEFAULT_LANGUAGE "en"
18
19 #define AST_CONFIG_MAX_PATH 255
20
21 /* provided in asterisk.c */
22 extern char ast_config_AST_CONFIG_DIR[AST_CONFIG_MAX_PATH];
23 extern char ast_config_AST_CONFIG_FILE[AST_CONFIG_MAX_PATH];
24 extern char ast_config_AST_MODULE_DIR[AST_CONFIG_MAX_PATH];
25 extern char ast_config_AST_SPOOL_DIR[AST_CONFIG_MAX_PATH];
26 extern char ast_config_AST_MONITOR_DIR[AST_CONFIG_MAX_PATH];
27 extern char ast_config_AST_VAR_DIR[AST_CONFIG_MAX_PATH];
28 extern char ast_config_AST_LOG_DIR[AST_CONFIG_MAX_PATH];
29 extern char ast_config_AST_AGI_DIR[AST_CONFIG_MAX_PATH];
30 extern char ast_config_AST_DB[AST_CONFIG_MAX_PATH];
31 extern char ast_config_AST_KEY_DIR[AST_CONFIG_MAX_PATH];
32 extern char ast_config_AST_PID[AST_CONFIG_MAX_PATH];
33 extern char ast_config_AST_SOCKET[AST_CONFIG_MAX_PATH];
34 extern char ast_config_AST_RUN_DIR[AST_CONFIG_MAX_PATH];
35 extern char ast_config_AST_CTL_PERMISSIONS[AST_CONFIG_MAX_PATH];
36 extern char ast_config_AST_CTL_OWNER[AST_CONFIG_MAX_PATH];
37 extern char ast_config_AST_CTL_GROUP[AST_CONFIG_MAX_PATH];
38 extern char ast_config_AST_CTL[AST_CONFIG_MAX_PATH];
39
40 /* Provided by asterisk.c */
41 extern int ast_set_priority(int);
42 /* Provided by module.c */
43 extern int load_modules(const int preload_only);
44 /* Provided by pbx.c */
45 extern int load_pbx(void);
46 /* Provided by logger.c */
47 extern int init_logger(void);
48 extern void close_logger(void);
49 /* Provided by frame.c */
50 extern int init_framer(void);
51 /* Provided by logger.c */
52 extern int reload_logger(int);
53 /* Provided by term.c */
54 extern int term_init(void);
55 /* Provided by db.c */
56 extern int astdb_init(void);
57 /* Provided by channel.c */
58 extern void ast_channels_init(void);
59 /* Provided by dnsmgr.c */
60 extern int dnsmgr_init(void);
61 extern void dnsmgr_reload(void);
62
63 /*!
64  * \brief Register the version of a source code file with the core.
65  * \param file the source file name
66  * \param version the version string (typically a CVS revision keyword string)
67  * \return nothing
68  *
69  * This function should not be called directly, but instead the
70  * ASTERISK_FILE_VERSION macro should be used to register a file with the core.
71  */
72 void ast_register_file_version(const char *file, const char *version);
73
74 /*!
75  * \brief Unregister a source code file from the core.
76  * \param file the source file name
77  * \return nothing
78  *
79  * This function should not be called directly, but instead the
80  * ASTERISK_FILE_VERSION macro should be used to automatically unregister
81  * the file when the module is unloaded.
82  */
83 void ast_unregister_file_version(const char *file);
84
85 /*!
86  * \brief Register/unregister a source code file with the core.
87  * \param file the source file name
88  * \param version the version string (typically a CVS revision keyword string)
89  *
90  * This macro will place a file-scope constructor and destructor into the
91  * source of the module using it; this will cause the version of this file
92  * to registered with the Asterisk core (and unregistered) at the appropriate
93  * times.
94  *
95  * Example:
96  *
97  * \code
98  * ASTERISK_FILE_VERSION(__FILE__, "\$Revision\$")
99  * \endcode
100  *
101  * \note The dollar signs above have been protected with backslashes to keep
102  * CVS from modifying them in this file; under normal circumstances they would
103  * not be present and CVS would expand the Revision keyword into the file's
104  * revision number.
105  */
106 #if defined(__GNUC__) && !defined(LOW_MEMORY)
107 #define ASTERISK_FILE_VERSION(file, version) \
108         static void __attribute__((constructor)) __register_file_version(void) \
109         { \
110                 ast_register_file_version(file, version); \
111         } \
112         static void __attribute__((destructor)) __unregister_file_version(void) \
113         { \
114                 ast_unregister_file_version(file); \
115         }
116 #elif !defined(LOW_MEMORY) /* ! __GNUC__  && ! LOW_MEMORY*/
117 #define ASTERISK_FILE_VERSION(file, x) static const char __file_version[] = x;
118 #else /* LOW_MEMORY */
119 #define ASTERISK_FILE_VERSION(file, x)
120 #endif /* __GNUC__ */
121
122 #endif /* _ASTERISK_H */