contrib/subversion/subversion/libsvn_delta/debug_editor.h

   1 /*
   2  * ====================================================================
   3  *    Licensed to the Apache Software Foundation (ASF) under one
   4  *    or more contributor license agreements.  See the NOTICE file
   5  *    distributed with this work for additional information
   6  *    regarding copyright ownership.  The ASF licenses this file
   7  *    to you under the Apache License, Version 2.0 (the
   8  *    "License"); you may not use this file except in compliance
   9  *    with the License.  You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  *    Unless required by applicable law or agreed to in writing,
  14  *    software distributed under the License is distributed on an
  15  *    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  16  *    KIND, either express or implied.  See the License for the
  17  *    specific language governing permissions and limitations
  18  *    under the License.
  19  * ====================================================================
  20  */
  21
  22 \f
  23 #ifndef SVN_DEBUG_EDITOR_H
  24 #define SVN_DEBUG_EDITOR_H
  25
  26 #include "svn_delta.h"
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif /* __cplusplus */
  31
  32 /* Return a debug editor that wraps @a wrapped_editor.
  33  *
  34  * The debug editor simply prints an indication of what callbacks are being
  35  * called to @c stdout, and is only intended for use in debugging subversion
  36  * editors.
  37  *
  38  * @a prefix, if non-null, is printed between "DBG: " and each indication.
  39  *
  40  * Note: Our test suite generally ignores stdout lines starting with "DBG:".
  41  */
  42 svn_error_t *
  43 svn_delta__get_debug_editor(const svn_delta_editor_t **editor,
  44                             void **edit_baton,
  45                             const svn_delta_editor_t *wrapped_editor,
  46                             void *wrapped_baton,
  47                             const char *prefix,
  48                             apr_pool_t *pool);
  49
  50 #ifdef __cplusplus
  51 }
  52 #endif /* __cplusplus */
  53
  54 #endif /* SVN_DEBUG_EDITOR_H */