granicus.if.org Git - apache/blob - include/ap_mmn.h

   1 /* Copyright 1999-2005 The Apache Software Foundation or its licensors, as
   2  * applicable.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef APACHE_AP_MMN_H
  18 #define APACHE_AP_MMN_H
  19
  20 /**
  21  * @package Module Magic Number
  22  */
  23
  24 /*
  25  * MODULE_MAGIC_NUMBER_MAJOR
  26  * Major API changes that could cause compatibility problems for older modules
  27  * such as structure size changes.  No binary compatibility is possible across
  28  * a change in the major version.
  29  *
  30  * MODULE_MAGIC_NUMBER_MINOR
  31  * Minor API changes that do not cause binary compatibility problems.
  32  * Should be reset to 0 when upgrading MODULE_MAGIC_NUMBER_MAJOR.
  33  *
  34  * See the MODULE_MAGIC_AT_LEAST macro below for an example.
  35  */
  36
  37 /*
  38  * 20010224 (2.0.13-dev) MODULE_MAGIC_COOKIE reset to "AP20"
  39  * 20010523 (2.0.19-dev) bump for scoreboard structure reordering
  40  * 20010627 (2.0.19-dev) more API changes than I can count
  41  * 20010726 (2.0.22-dev) more big API changes
  42  * 20010808 (2.0.23-dev) dir d_is_absolute bit introduced, bucket changes, etc
  43  * 20010825 (2.0.25-dev) removed d_is_absolute, introduced map_to_storage hook
  44  * 20011002 (2.0.26-dev) removed 1.3-depreciated request_rec.content_language
  45  * 20011127 (2.0.29-dev) bump for postconfig hook change, and removal of socket
  46  *                       from connection record
  47  * 20011212 (2.0.30-dev) bump for new used_path_info member of request_rec
  48  * 20011218 (2.0.30-dev) bump for new sbh member of conn_rec, different
  49  *                       declarations for scoreboard, new parameter to
  50  *                       create_connection hook
  51  * 20020102 (2.0.30-dev) bump for changed type of limit_req_body in
  52  *                       core_dir_config
  53  * 20020109 (2.0.31-dev) bump for changed shm and scoreboard declarations
  54  * 20020111 (2.0.31-dev) bump for ETag fields added at end of cor_dir_config
  55  * 20020114 (2.0.31-dev) mod_dav changed how it asks its provider to fulfill
  56  *                       a GET request
  57  * 20020118 (2.0.31-dev) Input filtering split of blocking and mode
  58  * 20020127 (2.0.31-dev) bump for pre_mpm hook change
  59  * 20020128 (2.0.31-dev) bump for pre_config hook change
  60  * 20020218 (2.0.33-dev) bump for AddOutputFilterByType directive
  61  * 20020220 (2.0.33-dev) bump for scoreboard.h structure change
  62  * 20020302 (2.0.33-dev) bump for protocol_filter additions.
  63  * 20020306 (2.0.34-dev) bump for filter type renames.
  64  * 20020318 (2.0.34-dev) mod_dav's API for REPORT generation changed
  65  * 20020319 (2.0.34-dev) M_INVALID changed, plus new M_* methods for RFC 3253
  66  * 20020327 (2.0.35-dev) Add parameter to quick_handler hook
  67  * 20020329 (2.0.35-dev) bump for addition of freelists to bucket API
  68  * 20020329.1 (2.0.36) minor bump for new arg to opt fn ap_cgi_build_command
  69  * 20020506 (2.0.37-dev) Removed r->boundary in request_rec.
  70  * 20020529 (2.0.37-dev) Standardized the names of some apr_pool_*_set funcs
  71  * 20020602 (2.0.37-dev) Bucket API change (metadata buckets)
  72  * 20020612 (2.0.38-dev) Changed server_rec->[keep_alive_]timeout to apr time
  73  * 20020625 (2.0.40-dev) Changed conn_rec->keepalive to an enumeration
  74  * 20020628 (2.0.40-dev) Added filter_init to filter registration functions
  75  * 20020903 (2.0.41-dev) APR's error constants changed
  76  * 20020903.1 (2.1.0-dev) allow_encoded_slashes added to core_dir_config
  77  * 20020903.2 (2.0.46-dev) add ap_escape_logitem
  78  * 20030213.1 (2.1.0-dev) changed log_writer optional fn's to return previous
  79  *                        handler
  80  * 20030821 (2.1.0-dev) bumped mod_include's entire API
  81  * 20030821.1 (2.1.0-dev) added XHTML doctypes
  82  * 20030821.2 (2.1.0-dev) added ap_escape_errorlog_item
  83  * 20030821.3 (2.1.0-dev) added ap_get_server_revision / ap_version_t
  84  * 20040425 (2.1.0-dev) removed ap_add_named_module API
  85  *                      changed ap_add_module, ap_add_loaded_module,
  86  *                      ap_setup_prelinked_modules, ap_process_resource_config
  87  * 20040425.1 (2.1.0-dev) Added ap_module_symbol_t and ap_prelinked_module_symbols
  88  * 20050101.0 (2.1.2-dev) Axed misnamed http_method for http_scheme (which it was!)
  89  * 20050127.0 (2.1.3-dev) renamed regex_t->ap_regex_t, regmatch_t->ap_regmatch_t,
  90  *                        REG_*->AP_REG_*, removed reg* in place of ap_reg*;
  91  *                        added ap_regex.h
  92  * 20050217.0 (2.1.3-dev) Axed find_child_by_pid, mpm_*_completion_context (winnt mpm)
  93  *                        symbols from the public sector, and decorated real_exit_code
  94  *                        with ap_ in the win32 os.h.
  95  * 20050305.0 (2.1.4-dev) added pid and generation fields to worker_score
  96  */
  97
  98 #define MODULE_MAGIC_COOKIE 0x41503230UL /* "AP20" */
  99
 100 #ifndef MODULE_MAGIC_NUMBER_MAJOR
 101 #define MODULE_MAGIC_NUMBER_MAJOR 20050217
 102 #endif
 103 #define MODULE_MAGIC_NUMBER_MINOR 0                     /* 0...n */
 104
 105 /**
 106  * Determine if the server's current MODULE_MAGIC_NUMBER is at least a
 107  * specified value.
 108  * <pre>
 109  * Useful for testing for features.
 110  * For example, suppose you wish to use the apr_table_overlap
 111  *    function.  You can do this:
 112  *
 113  * #if AP_MODULE_MAGIC_AT_LEAST(19980812,2)
 114  *     ... use apr_table_overlap()
 115  * #else
 116  *     ... alternative code which doesn't use apr_table_overlap()
 117  * #endif
 118  * </pre>
 119  * @param major The major module magic number
 120  * @param minor The minor module magic number
 121  * @deffunc AP_MODULE_MAGIC_AT_LEAST(int major, int minor)
 122  */
 123 #define AP_MODULE_MAGIC_AT_LEAST(major,minor)           \
 124     ((major) < MODULE_MAGIC_NUMBER_MAJOR                \
 125         || ((major) == MODULE_MAGIC_NUMBER_MAJOR        \
 126             && (minor) <= MODULE_MAGIC_NUMBER_MINOR))
 127
 128 /** @deprecated present for backwards compatibility */
 129 #define MODULE_MAGIC_NUMBER MODULE_MAGIC_NUMBER_MAJOR
 130 #define MODULE_MAGIC_AT_LEAST old_broken_macro_we_hope_you_are_not_using
 131
 132 #endif /* !APACHE_AP_MMN_H */