subversion/libsvn_ra_local/ra_local.h

   1 /*
   2  * ra_local.h : shared internal declarations for ra_local module
   3  *
   4  * ====================================================================
   5  * Copyright (c) 2000-2004 CollabNet.  All rights reserved.
   6  *
   7  * This software is licensed as described in the file COPYING, which
   8  * you should have received as part of this distribution.  The terms
   9  * are also available at http://subversion.tigris.org/license-1.html.
  10  * If newer versions of this license are posted there, you may use a
  11  * newer version instead, at your option.
  12  *
  13  * This software consists of voluntary contributions made by many
  14  * individuals.  For exact contribution history, see the revision
  15  * history and logs, available at http://subversion.tigris.org/.
  16  * ====================================================================
  17  */
  18
  19 #ifndef SVN_LIBSVN_RA_LOCAL_H
  20 #define SVN_LIBSVN_RA_LOCAL_H
  21
  22 #include <apr_pools.h>
  23 #include <apr_tables.h>
  24
  25 #include "svn_types.h"
  26 #include "svn_fs.h"
  27 #include "svn_repos.h"
  28 #include "svn_ra.h"
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif /* __cplusplus */
  33
  34 \f
  35 /** Structures **/
  36
  37 /* A baton which represents a single ra_local session. */
  38 typedef struct svn_ra_local__session_baton_t
  39 {
  40   /* The user accessing the repository. */
  41   const char *username;
  42
  43   /* The URL of the session, split into two components. */
  44   const char *repos_url;
  45   svn_stringbuf_t *fs_path;  /* URI-decoded, always with a leading slash. */
  46
  47   /* A repository object. */
  48   svn_repos_t *repos;
  49
  50   /* The filesystem object associated with REPOS above (for
  51      convenience). */
  52   svn_fs_t *fs;
  53
  54   /* The UUID associated with REPOS above (cached) */
  55   const char *uuid;
  56
  57   /* Callbacks/baton passed to svn_ra_open. */
  58   const svn_ra_callbacks2_t *callbacks;
  59   void *callback_baton;
  60 } svn_ra_local__session_baton_t;
  61
  62
  63
  64 \f
  65 /** Private routines **/
  66
  67
  68
  69
  70 /* Given a `file://' URL, figure out which portion specifies a
  71    repository on local disk, and return that in REPOS_URL (if not
  72    NULL); URI-decode and return the remainder (the path *within* the
  73    repository's filesystem) in FS_PATH.  Open REPOS to the repository
  74    root (if not NULL).  Allocate the return values in POOL.
  75    Currently, we are not expecting to handle `file://hostname/'-type
  76    URLs; hostname, in this case, is expected to be the empty string or
  77    "localhost". */
  78 svn_error_t *
  79 svn_ra_local__split_URL(svn_repos_t **repos,
  80                         const char **repos_url,
  81                         const char **fs_path,
  82                         const char *URL,
  83                         apr_pool_t *pool);
  84
  85
  86
  87
  88 #ifdef __cplusplus
  89 }
  90 #endif /* __cplusplus */
  91
  92 #endif /* SVN_LIBSVN_RA_LOCAL_H */