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