New conversion methods for solr sorting

[yaz-moved-to-github.git] / include / yaz / tpath.h

diff --git a/include/yaz/tpath.h b/include/yaz/tpath.h
index ae7f7c2..f45eb60 100644 (file)
--- a/include/yaz/tpath.h
+++ b/include/yaz/tpath.h
@@ -1,31 +1,30 @@
-/*
- * Copyright (C) 1995-2006, Index Data ApS
- *
- * Permission to use, copy, modify, distribute, and sell this software and
- * its documentation, in whole or in part, for any purpose, is hereby granted,
- * provided that:
- *
- * 1. This copyright and permission notice appear in all copies of the
- * software and its documentation. Notices of copyright or attribution
- * which appear at the beginning of any file must remain unchanged.
+/* This file is part of the YAZ toolkit.
+ * Copyright (C) 1995-2012 Index Data.
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:

  *
  *

- * 2. The names of Index Data or the individual authors may not be used to
- * endorse or promote products derived from this software without specific
- * prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
- * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
- * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
- * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
- * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
- * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
- * OF THIS SOFTWARE.
- *
- * $Id: tpath.h,v 1.11 2006-05-02 12:11:08 adam Exp $
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Index Data nor the names of its contributors
+ *       may be used to endorse or promote products derived from this
+ *       software without specific prior written permission.

  *
  *

+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

  */
  */

+

 /**
  * \file tpath.h
  * \brief File Path utilities
 /**
  * \file tpath.h
  * \brief File Path utilities

@@ -41,44 +40,53 @@ YAZ_BEGIN_CDECL
 
 /** \brief checks whether path is absolute
     \param path path to checked
 
 /** \brief checks whether path is absolute
     \param path path to checked

-
-    Returns 1 if path is absolute, 0 if relative
+    \retval 1 path is absolute
+    \retval 0 path is relative
+*/
+YAZ_EXPORT int yaz_is_abspath(const char *path);
+
+/** \brief get next path component in filepath
+    \param path_p pointer to path (updated to "next" entry if any)
+    \param comp upon pointer to component (if component is found)
+    \retval 0 no component found (and no more componennts)
+    \retval >0 length of component (length of *comp)
+
+    A filepath has components separted by colon. For example
+    /usr/lib/modules:c:/my:/:lib
+    which has these components
+    "/usr/lib/modules", "c:/my", "/", "lib"

 */
 */

-YAZ_EXPORT int yaz_is_abspath (const char *path);
+YAZ_EXPORT size_t yaz_filepath_comp(const char **path_p, const char **comp);
+

 
 

-/** \brief resolve file on path 
+/** \brief resolve file on path

     \param fname "short" filename (without path)
     \param path the path (dir1:dir2,..) - ala Unix
     \param base can be added to relative paths (NULL for no append)
     \param fname "short" filename (without path)
     \param path the path (dir1:dir2,..) - ala Unix
     \param base can be added to relative paths (NULL for no append)

-    \param fullpath the full path to filename (if succesful)
+    \param fullpath the full path to filename (if successful)
+    \returns fullpath or NULL if file could not be found

 
 

-    Returns 0/NULL if no fname could be found in path; 
-    pointer to fullpath if fname could be found.
-    We assume fullpath is 1024 bytes in length!
+    Be sure to allocate at least 1024 bytes for fullpath

 */
 YAZ_EXPORT char *yaz_filepath_resolve(const char *fname, const char *path,
                                       const char *base, char *fullpath);
 
 
 */
 YAZ_EXPORT char *yaz_filepath_resolve(const char *fname, const char *path,
                                       const char *base, char *fullpath);
 
 

-/** \brief opens first file in path in path 
+/** \brief opens first file in path in path

     \param fname "short" filename (without path)
     \param mode mode as in fopen(3)
     \param path the path (dir1:dir2,..) - ala Unix
     \param base can be added to relative paths (NULL for no append)
     \param fname "short" filename (without path)
     \param mode mode as in fopen(3)
     \param path the path (dir1:dir2,..) - ala Unix
     \param base can be added to relative paths (NULL for no append)

-
-    Returns 0/NULL if no fname could be found in path; 
-    FILE pointer if fname could be found.
+    \returns FILE pointer if fname could be found; NULL otherwise

 */
 YAZ_EXPORT FILE *yaz_fopen(const char *path, const char *fname,
                            const char *mode, const char *base);
 
 */
 YAZ_EXPORT FILE *yaz_fopen(const char *path, const char *fname,
                            const char *mode, const char *base);
 

-/** \brief opens first file in path in path 
+/** \brief opens first file in path in path

     \param fname "short" filename (without path)
     \param mode mode as in fopen(3)
     \param path the path (dir1:dir2,..) - ala Unix
     \param fname "short" filename (without path)
     \param mode mode as in fopen(3)
     \param path the path (dir1:dir2,..) - ala Unix

-
-    Returns 0/NULL if no fname could be found in path; 
-    FILE pointer if fname could be found.
+    \returns FILE pointer if fname could be found; NULL otherwise

 */
 YAZ_EXPORT FILE *yaz_path_fopen(const char *path, const char *fname,
                                 const char *mode);
 */
 YAZ_EXPORT FILE *yaz_path_fopen(const char *path, const char *fname,
                                 const char *mode);

@@ -86,7 +94,8 @@ YAZ_EXPORT FILE *yaz_path_fopen(const char *path, const char *fname,
 /** \brief closes file
     \param f FILE handle
 
 /** \brief closes file
     \param f FILE handle
 

-    Returns -1 on failure; 0 on success
+    \retval -1 on failure
+    \retval 0 on success

 */
 YAZ_EXPORT int yaz_fclose(FILE *f);
 
 */
 YAZ_EXPORT int yaz_fclose(FILE *f);
 

@@ -97,6 +106,7 @@ YAZ_END_CDECL
 /*
  * Local variables:
  * c-basic-offset: 4
 /*
  * Local variables:
  * c-basic-offset: 4

+ * c-file-style: "Stroustrup"

  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab