1 /* fs_skels.h : headers for conversion between fs native types and
4 * ====================================================================
5 * Licensed to the Apache Software Foundation (ASF) under one
6 * or more contributor license agreements. See the NOTICE file
7 * distributed with this work for additional information
8 * regarding copyright ownership. The ASF licenses this file
9 * to you under the Apache License, Version 2.0 (the
10 * "License"); you may not use this file except in compliance
11 * with the License. You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing,
16 * software distributed under the License is distributed on an
17 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18 * KIND, either express or implied. See the License for the
19 * specific language governing permissions and limitations
21 * ====================================================================
24 #ifndef SVN_LIBSVN_FS_FS_SKELS_H
25 #define SVN_LIBSVN_FS_FS_SKELS_H
28 #include "svn_private_config.h"
30 #include <apr_pools.h>
35 #include "private/svn_skel.h"
39 #endif /* __cplusplus */
42 /*** Parsing (conversion from skeleton to native FS type) ***/
45 /* Parse a `REVISION' SKEL and set *REVISION_P to the newly allocated
46 result. Use POOL for all allocations. */
48 svn_fs_base__parse_revision_skel(revision_t **revision_p,
52 /* Parse a `TRANSACTION' SKEL and set *TRANSACTION_P to the newly allocated
53 result. Use POOL for all allocations. */
55 svn_fs_base__parse_transaction_skel(transaction_t **transaction_p,
59 /* Parse a `REPRESENTATION' SKEL and set *REP_P to the newly allocated
60 result. Use POOL for all allocations. */
63 svn_fs_base__parse_representation_skel(representation_t **rep_p,
67 /* Parse a `NODE-REVISION' SKEL and set *NODEREV_P to the newly allocated
68 result. Use POOL for all allocations. */
70 svn_fs_base__parse_node_revision_skel(node_revision_t **noderev_p,
74 /* Parse a `COPY' SKEL and set *COPY_P to the newly allocated result. Use
75 POOL for all allocations. */
77 svn_fs_base__parse_copy_skel(copy_t **copy_p,
81 /* Parse an `ENTRIES' SKEL and set *ENTRIES_P to a new hash with const
82 char * names (the directory entry name) and svn_fs_id_t * values
83 (the node-id of the entry), or NULL if SKEL contains no entries.
84 Use POOL for all allocations. */
86 svn_fs_base__parse_entries_skel(apr_hash_t **entries_p,
90 /* Parse a `CHANGE' SKEL and set *CHANGE_P to the newly allocated result.
91 Use POOL for all allocations. */
93 svn_fs_base__parse_change_skel(change_t **change_p,
97 /* Parse a `LOCK' SKEL and set *LOCK_P to the newly allocated result. Use
98 POOL for all allocations. */
100 svn_fs_base__parse_lock_skel(svn_lock_t **lock_p,
106 /*** Unparsing (conversion from native FS type to skeleton) ***/
109 /* Unparse REVISION into a newly allocated `REVISION' skel and set *SKEL_P
110 to the result. Use POOL for all allocations. */
112 svn_fs_base__unparse_revision_skel(svn_skel_t **skel_p,
113 const revision_t *revision,
116 /* Unparse TRANSACTION into a newly allocated `TRANSACTION' skel and set
117 *SKEL_P to the result. Use POOL for all allocations. */
119 svn_fs_base__unparse_transaction_skel(svn_skel_t **skel_p,
120 const transaction_t *transaction,
123 /* Unparse REP into a newly allocated `REPRESENTATION' skel and set *SKEL_P
124 to the result. Use POOL for all allocations. FORMAT is the format
125 version of the filesystem. */
127 svn_fs_base__unparse_representation_skel(svn_skel_t **skel_p,
128 const representation_t *rep,
132 /* Unparse NODEREV into a newly allocated `NODE-REVISION' skel and set
133 *SKEL_P to the result. Use POOL for all allocations. FORMAT is the
134 format version of the filesystem. */
136 svn_fs_base__unparse_node_revision_skel(svn_skel_t **skel_p,
137 const node_revision_t *noderev,
141 /* Unparse COPY into a newly allocated `COPY' skel and set *SKEL_P to the
142 result. Use POOL for all allocations. */
144 svn_fs_base__unparse_copy_skel(svn_skel_t **skel_p,
148 /* Unparse an ENTRIES hash, which has const char * names (the entry
149 name) and svn_fs_id_t * values (the node-id of the entry) into a newly
150 allocated `ENTRIES' skel and set *SKEL_P to the result. Use POOL for all
153 svn_fs_base__unparse_entries_skel(svn_skel_t **skel_p,
157 /* Unparse CHANGE into a newly allocated `CHANGE' skel and set *SKEL_P to
158 the result. Use POOL for all allocations. */
160 svn_fs_base__unparse_change_skel(svn_skel_t **skel_p,
161 const change_t *change,
164 /* Unparse LOCK into a newly allocated `LOCK' skel and set *SKEL_P to the
165 result. Use POOL for all allocations. */
167 svn_fs_base__unparse_lock_skel(svn_skel_t **skel_p,
168 const svn_lock_t *lock,
175 #endif /* __cplusplus */
177 #endif /* SVN_LIBSVN_FS_FS_SKELS_H */