granicus.if.org Git - apache/blob - os/unix/os.h

   1 /* ====================================================================
   2  * The Apache Software License, Version 1.1
   3  *
   4  * Copyright (c) 2000 The Apache Software Foundation.  All rights
   5  * reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in
  16  *    the documentation and/or other materials provided with the
  17  *    distribution.
  18  *
  19  * 3. The end-user documentation included with the redistribution,
  20  *    if any, must include the following acknowledgment:
  21  *       "This product includes software developed by the
  22  *        Apache Software Foundation (http://www.apache.org/)."
  23  *    Alternately, this acknowledgment may appear in the software itself,
  24  *    if and wherever such third-party acknowledgments normally appear.
  25  *
  26  * 4. The names "Apache" and "Apache Software Foundation" must
  27  *    not be used to endorse or promote products derived from this
  28  *    software without prior written permission. For written
  29  *    permission, please contact apache@apache.org.
  30  *
  31  * 5. Products derived from this software may not be called "Apache",
  32  *    nor may "Apache" appear in their name, without prior written
  33  *    permission of the Apache Software Foundation.
  34  *
  35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46  * SUCH DAMAGE.
  47  * ====================================================================
  48  *
  49  * This software consists of voluntary contributions made by many
  50  * individuals on behalf of the Apache Software Foundation.  For more
  51  * information on the Apache Software Foundation, please see
  52  * <http://www.apache.org/>.
  53  *
  54  * Portions of this software are based upon public domain software
  55  * originally written at the National Center for Supercomputing Applications,
  56  * University of Illinois, Urbana-Champaign.
  57  */
  58
  59 #ifndef APACHE_OS_H
  60 #define APACHE_OS_H
  61
  62 #include "ap_config.h"
  63
  64 #ifndef PLATFORM
  65 #define PLATFORM "Unix"
  66 #endif
  67
  68 /**
  69  * @package OS Specific Functions
  70  */
  71
  72 /*
  73  * This file in included in all Apache source code. It contains definitions
  74  * of facilities available on _this_ operating system (HAVE_* macros),
  75  * and prototypes of OS specific functions defined in os.c or os-inline.c
  76  */
  77
  78 #if !defined(INLINE) && defined(USE_GNU_INLINE)
  79 /* Compiler supports inline, so include the inlineable functions as
  80  * part of the header
  81  */
  82 #define INLINE extern apr_inline
  83
  84 /**
  85  * Is the path an absolute or relative path
  86  * @param file The path to the file
  87  * @return 1 if absolute, 0 otherwise
  88  * @deffunc int ap_os_is_path_absolute(const char *file)
  89  */
  90 INLINE int ap_os_is_path_absolute(const char *file);
  91
  92 #include "os-inline.c"
  93
  94 #else
  95
  96 /* Compiler does not support inline, so prototype the inlineable functions
  97  * as normal
  98  */
  99 extern int ap_os_is_path_absolute(const char *file);
 100 #endif
 101
 102 /* Other ap_os_ routines not used by this platform */
 103
 104 /**
 105  * Perform canonicalization on a given filename.  This means that files on
 106  * all platforms have the same format
 107  * @param p The pool to allocate the canonical filename out of
 108  * @param f The filename to canonicalize
 109  * @return The new filename
 110  * @deffunc char *ap_os_canonical_filename(apr_pool_t *p, const char *f)
 111  */
 112 #define ap_os_canonical_filename(p,f)  (f)
 113
 114 /**
 115  * Perform canonicalization on a given filename, except that the input case
 116  * is preserved.
 117  * @param p The pool to allocate the canonical filename out of
 118  * @param f The filename to canonicalize
 119  * @return The new filename
 120  * @deffunc char *ap_os_case_canonical_filename(apr_pool_t *p, const char *f)
 121  */
 122 #define ap_os_case_canonical_filename(p,f)  (f)
 123
 124 /**
 125  * Tries to match a filename to the existing patch, and returns the pathname
 126  * in the case that is present on the existing path.  This routine also
 127  * converts alias names to long names.
 128  * @param p The pool to allocate out of
 129  * @param f The file to match
 130  * @return The matched file name with the correct case
 131  * @deffunc char *ap_os_systemcase_filename(apr_pool_t *p, const char *f)
 132  */
 133 #define ap_os_systemcase_filename(p,f)  (f)
 134
 135 #endif  /* !APACHE_OS_H */