include/sphinxbase/filename.h

   1 /* -*- c-basic-offset: 4; indent-tabs-mode: nil -*- */
   2 /* ====================================================================
   3  * Copyright (c) 1999-2004 Carnegie Mellon University.  All rights
   4  * reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  *
  18  * This work was supported in part by funding from the Defense Advanced
  19  * Research Projects Agency and the National Science Foundation of the
  20  * United States of America, and the CMU Sphinx Speech Consortium.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY ``AS IS'' AND
  23  * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  24  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  25  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY
  26  * NOR ITS EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  *
  34  * ====================================================================
  35  *
  36  */
  37 /*
  38  * filename.h -- File and path name operations.
  39  *
  40  * **********************************************
  41  * CMU ARPA Speech Project
  42  *
  43  * Copyright (c) 1999 Carnegie Mellon University.
  44  * ALL RIGHTS RESERVED.
  45  * **********************************************
  46  *
  47  * HISTORY
  48  * $Log: filename.h,v $
  49  * Revision 1.7  2005/06/22 03:01:07  arthchan2003
  50  * Added  keyword
  51  *
  52  * Revision 1.3  2005/03/30 01:22:48  archan
  53  * Fixed mistakes in last updates. Add
  54  *
  55  *
  56  * 30-Oct-1997  M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon University.
  57  *              Started.
  58  */
  59
  60
  61 #ifndef _LIBUTIL_FILENAME_H_
  62 #define _LIBUTIL_FILENAME_H_
  63
  64 /* Win32/WinCE DLL gunk */
  65 #include <sphinxbase/sphinxbase_export.h>
  66 #include <sphinxbase/prim_type.h>
  67
  68 /**\file filename.h
  69  *\brief File names related operation
  70  */
  71 #ifdef __cplusplus
  72 extern "C" {
  73 #endif
  74 #if 0
  75 /* Fool Emacs. */
  76 }
  77 #endif
  78
  79 /**
  80  * Strip off leading path components from the given path and copy the base into base.
  81  * Caller must have allocated base (hint: it's always shorter than path).
  82  */
  83 SPHINXBASE_EXPORT
  84 void path2basename(const char *path, char *base);
  85
  86 /**
  87  * Strip off filename from the given path and copy the directory name into dir
  88  * Caller must have allocated dir (hint: it's always shorter than path).
  89  */
  90 SPHINXBASE_EXPORT
  91 void path2dirname(const char *path, char *dir);
  92
  93
  94 /**
  95  * Strip off the smallest trailing file-extension suffix and copy
  96  * the rest into the given root argument.  Caller must have
  97  * allocated root.
  98  */
  99 SPHINXBASE_EXPORT
 100 void strip_fileext(const char *file, char *root);
 101
 102 /**
 103  * Test whether a pathname is absolute for the current OS.
 104  */
 105 SPHINXBASE_EXPORT
 106 int path_is_absolute(const char *file);
 107
 108 #ifdef __cplusplus
 109 }
 110 #endif
 111
 112
 113 #endif