text: /**
   * @copyright
   * ====================================================================
   *    Licensed to the Apache Software Foundation (ASF) under one
   *    or more contributor license agreements.  See the NOTICE file
   *    distributed with this work for additional information
   *    regarding copyright ownership.  The ASF licenses this file
   *    to you under the Apache License, Version 2.0 (the
   *    "License"); you may not use this file except in compliance
   *    with the License.  You may obtain a copy of the License at
   *
   *      http://www.apache.org/licenses/LICENSE-2.0
   *
   *    Unless required by applicable law or agreed to in writing,
   *    software distributed under the License is distributed on an
   *    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   *    KIND, either express or implied.  See the License for the
   *    specific language governing permissions and limitations
   *    under the License.
   * ====================================================================
   * @endcopyright
   *
   * @file svn_iter.h
   * @brief The Subversion Iteration drivers helper routines
   *
   */
  
  #ifndef SVN_ITER_H
  #define SVN_ITER_H
  
  #include <apr.h>         /* for apr_ssize_t */
  #include <apr_pools.h>   /* for apr_pool_t */
  #include <apr_hash.h>    /* for apr_hash_t */
  #include <apr_tables.h>  /* for apr_array_header_t */
  
  #include "svn_types.h"
  
  #ifdef __cplusplus
  extern "C" {
  #endif /* __cplusplus */
  
  
  /** Callback function for use with svn_iter_apr_hash().
   * Use @a pool for temporary allocation, it's cleared between invocations.
   *
   * @a key, @a klen and @a val are the values normally retrieved with
   * apr_hash_this().
   *
   * @a baton is the baton passed into svn_iter_apr_hash().
   *
   * @since New in 1.5.
   */
  typedef svn_error_t *(*svn_iter_apr_hash_cb_t)(void *baton,
                                                 const void *key,
                                                 apr_ssize_t klen,
                                                 void *val, apr_pool_t *pool);
  
  /** Iterate over the elements in @a hash, calling @a func for each one until
   * there are no more elements or @a func returns an error.
   *
   * Uses @a pool for temporary allocations.
   *
   * If @a completed is not NULL, then on return - if @a func returns no
   * errors - @a *completed will be set to @c TRUE.
   *
   * If @a func returns an error other than @c SVN_ERR_ITER_BREAK, that
   * error is returned.  When @a func returns @c SVN_ERR_ITER_BREAK,
   * iteration is interrupted, but no error is returned and @a *completed is
   * set to @c FALSE (even if this iteration was the last one).
   *
   * @since New in 1.5.
   */
  svn_error_t *
  svn_iter_apr_hash(svn_boolean_t *completed,
                    apr_hash_t *hash,
                    svn_iter_apr_hash_cb_t func,
                    void *baton,
                    apr_pool_t *pool);
  
  /** Iteration callback used in conjunction with svn_iter_apr_array().
   *
   * Use @a pool for temporary allocation, it's cleared between invocations.
   *
   * @a baton is the baton passed to svn_iter_apr_array().  @a item
   * is a pointer to the item written to the array with the APR_ARRAY_PUSH()
   * macro.
   *
   * @since New in 1.5.
   */
  typedef svn_error_t *(*svn_iter_apr_array_cb_t)(void *baton,
                                                  void *item,
                                                  apr_pool_t *pool);
  
  /** Iterate over the elements in @a array calling @a func for each one until
   * there are no more elements or @a func returns an error.
   *
   * Uses @a pool for temporary allocations.
   *
   * If @a completed is not NULL, then on return - if @a func returns no
   * errors - @a *completed will be set to @c TRUE.
   *
   * If @a func returns an error other than @c SVN_ERR_ITER_BREAK, that
   * error is returned.  When @a func returns @c SVN_ERR_ITER_BREAK,
   * iteration is interrupted, but no error is returned and @a *completed is
   * set to @c FALSE (even if this iteration was the last one).
   *
   * @since New in 1.5.
   */
  svn_error_t *
  svn_iter_apr_array(svn_boolean_t *completed,
                     const apr_array_header_t *array,
                     svn_iter_apr_array_cb_t func,
                     void *baton,
                     apr_pool_t *pool);
  
  
  /** Internal routine used by svn_iter_break() macro.
   */
  svn_error_t *
  svn_iter__break(void);
  
  
  /** Helper macro to break looping in svn_iter_apr_array() and
   * svn_iter_apr_hash() driven loops.
   *
   * @note The error is just a means of communicating between
   *       driver and callback.  There is no need for it to exist
   *       past the lifetime of the iterpool.
   *
   * @since New in 1.5.
   */
  #define svn_iter_break(pool) return svn_iter__break()
  
  
  #ifdef __cplusplus
  }
  #endif /* __cplusplus */
  
  #endif /* SVN_ITER_H */
  