apr_inherit.h 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. /* Licensed to the Apache Software Foundation (ASF) under one or more
  2. * contributor license agreements. See the NOTICE file distributed with
  3. * this work for additional information regarding copyright ownership.
  4. * The ASF licenses this file to You under the Apache License, Version 2.0
  5. * (the "License"); you may not use this file except in compliance with
  6. * the License. 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. #ifndef APR_INHERIT_H
  17. #define APR_INHERIT_H
  18. /**
  19. * @file apr_inherit.h
  20. * @brief APR File Handle Inheritance Helpers
  21. * @remark This internal header includes internal declaration helpers
  22. * for other headers to declare apr_foo_inherit_[un]set functions.
  23. */
  24. /**
  25. * Prototype for type-specific declarations of apr_foo_inherit_set
  26. * functions.
  27. * @remark Doxygen unwraps this macro (via doxygen.conf) to provide
  28. * actual help for each specific occurrence of apr_foo_inherit_set.
  29. * @remark the linkage is specified for APR. It would be possible to expand
  30. * the macros to support other linkages.
  31. */
  32. #define APR_DECLARE_INHERIT_SET(type) \
  33. APR_DECLARE(apr_status_t) apr_##type##_inherit_set( \
  34. apr_##type##_t *the##type)
  35. /**
  36. * Prototype for type-specific declarations of apr_foo_inherit_unset
  37. * functions.
  38. * @remark Doxygen unwraps this macro (via doxygen.conf) to provide
  39. * actual help for each specific occurrence of apr_foo_inherit_unset.
  40. * @remark the linkage is specified for APR. It would be possible to expand
  41. * the macros to support other linkages.
  42. */
  43. #define APR_DECLARE_INHERIT_UNSET(type) \
  44. APR_DECLARE(apr_status_t) apr_##type##_inherit_unset( \
  45. apr_##type##_t *the##type)
  46. #endif /* ! APR_INHERIT_H */