Apache Portable Runtime: apr_inherit.h Source File

00001 /* Licensed to the Apache Software Foundation (ASF) under one or more
00002  * contributor license agreements.  See the NOTICE file distributed with
00003  * this work for additional information regarding copyright ownership.
00004  * The ASF licenses this file to You under the Apache License, Version 2.0
00005  * (the "License"); you may not use this file except in compliance with
00006  * the License.  You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #ifndef APR_INHERIT_H
00018 #define APR_INHERIT_H
00019 
00020 /**
00021  * @file apr_inherit.h 
00022  * @brief APR File Handle Inheritance Helpers
00023  * @remark This internal header includes internal declaration helpers 
00024  * for other headers to declare apr_foo_inherit_[un]set functions.
00025  */
00026 
00027 /**
00028  * Prototype for type-specific declarations of apr_foo_inherit_set 
00029  * functions.  
00030  * @remark Doxygen unwraps this macro (via doxygen.conf) to provide 
00031  * actual help for each specific occurrence of apr_foo_inherit_set.
00032  * @remark the linkage is specified for APR. It would be possible to expand
00033  *       the macros to support other linkages.
00034  */
00035 #define APR_DECLARE_INHERIT_SET(type) \
00036     APR_DECLARE(apr_status_t) apr_##type##_inherit_set( \
00037                                           apr_##type##_t *the##type)
00038 
00039 /**
00040  * Prototype for type-specific declarations of apr_foo_inherit_unset 
00041  * functions.  
00042  * @remark Doxygen unwraps this macro (via doxygen.conf) to provide 
00043  * actual help for each specific occurrence of apr_foo_inherit_unset.
00044  * @remark the linkage is specified for APR. It would be possible to expand
00045  *       the macros to support other linkages.
00046  */
00047 #define APR_DECLARE_INHERIT_UNSET(type) \
00048     APR_DECLARE(apr_status_t) apr_##type##_inherit_unset( \
00049                                           apr_##type##_t *the##type)
00050 
00051 #endif  /* ! APR_INHERIT_H */