---

/include/recls_platform_types.h

Go to the documentation of this file.

/* 
 * File:        recls_platform_types.h
 *
 * Purpose:     Platform discrimination for the recls API.
 *
 * Created:     18th August 2003
 * Updated:     4th March 2005
 *
 * Home:        http://recls.org/
 *
 * Copyright 2003-2005, Matthew Wilson and Synesis Software
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 *
 * - 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(s) of Matthew Wilson and Synesis Software nor the names of
 *   any contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT OWNER OR 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.
 *
 * 


#ifndef RECLS_INCL_H_RECLS_PLATFORM_TYPES
#define RECLS_INCL_H_RECLS_PLATFORM_TYPES

/* File version */
#ifndef RECLS_DOCUMENTATION_SKIP_SECTION
# define RECLS_VER_H_RECLS_PLATFORM_TYPES_MAJOR     2
# define RECLS_VER_H_RECLS_PLATFORM_TYPES_MINOR     0
# define RECLS_VER_H_RECLS_PLATFORM_TYPES_REVISION  2
# define RECLS_VER_H_RECLS_PLATFORM_TYPES_EDIT      16
#endif /* !RECLS_DOCUMENTATION_SKIP_SECTION */

/* 
 * Includes
 */

#ifndef RECLS_INCL_H_RECLS_PLATFORM
# error recls_platform_types.h must not be included directly. You should include recls.h
#endif /* !RECLS_INCL_H_RECLS_PLATFORM */

#if defined(RECLS_PURE_API) || \
    defined(RECLS_PLATFORM_IS_UNIX)
# include <time.h>
# include <sys/types.h>
#elif defined(RECLS_PLATFORM_IS_WIN32)
# include <windows.h>
#elif defined(RECLS_OVERRIDE_PLATFORM)
 /* You're expected to ensure that the appropriate inclusions are made */
#else
# error Platform not (yet) recognised
#endif /* platform */

/* 
 * Namespace
 */

#if !defined(RECLS_NO_NAMESPACE)
namespace recls
{
#endif /* !RECLS_NO_NAMESPACE */

/* 
 * Platform-dependent types
 */

#if defined(RECLS_PURE_API) || \
    defined(RECLS_PLATFORM_IS_UNIX)

 typedef time_t                     recls_time_t;
 typedef off_t                      recls_filesize_t;

#elif defined(RECLS_PLATFORM_IS_WIN32)

 typedef FILETIME                   recls_time_t;
 typedef ULARGE_INTEGER             recls_filesize_t;

#elif defined(RECLS_OVERRIDE_PLATFORM)

# ifndef RECLS_CUSTOM_TIME_T
#  error Must define RECLS_CUSTOM_TIME_T if compiling with RECLS_OVERRIDE_PLATFORM
# endif /* !RECLS_CUSTOM_TIME_T */

# ifndef RECLS_CUSTOM_FILESIZE_T
#  error Must define RECLS_CUSTOM_FILESIZE_T if compiling with RECLS_OVERRIDE_PLATFORM
# endif /* !RECLS_CUSTOM_TIME_T */

 typedef RECLS_CUSTOM_TIME_T        recls_time_t;
 typedef RECLS_CUSTOM_FILESIZE_T    recls_filesize_t;

#else

# error Platform not (yet) recognised

 typedef <platform-dependent-type>  recls_time_t;
 typedef <platform-dependent-type>  recls_filesize_t;

#endif /* platform */

/* 
 * Typedefs
 */

#if defined(_UNICODE) && \
    !defined(UNICODE)
# define UNICODE
#endif /* _UNICODE && !UNICODE */

#if defined(UNICODE) && \
    !defined(_UNICODE)
# define _UNICODE
#endif /* UNICODE && !_UNICODE */

#ifdef RECLS_CHAR_TYPE_IS_CHAR
# undef RECLS_CHAR_TYPE_IS_CHAR
#endif /* RECLS_CHAR_TYPE_IS_CHAR */

#ifdef RECLS_CHAR_TYPE_IS_WCHAR
# undef RECLS_CHAR_TYPE_IS_WCHAR
#endif /* RECLS_CHAR_TYPE_IS_WCHAR */

#if defined(UNICODE) && \
    !defined(RECLS_NO_UNICODE)
typedef recls_char_w_t              recls_char_t;
# define RECLS_CHAR_TYPE_IS_WCHAR
# define RECLS_LITERAL(x)           L ## x
#else /* ? UNICODE && !RECLS_NO_UNICODE */
typedef recls_char_a_t              recls_char_t;
# define RECLS_CHAR_TYPE_IS_CHAR
# define RECLS_LITERAL(x)           x
#endif /* UNICODE && !RECLS_NO_UNICODE */


struct recls_strptrs_t
{
    recls_char_t const  *begin;
    recls_char_t const  *end;
};

struct recls_strptrsptrs_t
{
    struct recls_strptrs_t const    *begin;
    struct recls_strptrs_t const    *end;
};

#if !defined(RECLS_PURE_API)
struct recls_fileinfo_t
{
    recls_uint32_t              attributes;
    struct recls_strptrs_t      path;
# if defined(RECLS_PLATFORM_IS_WIN32)

    struct recls_strptrs_t      shortFile;
    recls_char_t                drive;
# endif /* RECLS_PLATFORM_IS_WIN32 */

    struct recls_strptrs_t      directory;
    struct recls_strptrs_t      fileName;
    struct recls_strptrs_t      fileExt;
    struct recls_strptrsptrs_t  directoryParts;
# if defined(RECLS_PLATFORM_IS_WIN32)

    recls_time_t                creationTime;
# endif /* RECLS_PLATFORM_IS_WIN32 */

    recls_time_t                modificationTime;
    recls_time_t                lastAccessTime;
# if defined(RECLS_PLATFORM_IS_UNIX)

    recls_time_t                lastStatusChangeTime;
# endif /* RECLS_PLATFORM_IS_UNIX */

    recls_filesize_t            size;
/* data */
    recls_byte_t                data[1];
    /*
     *
     * - full path
     * - directory parts
     *
     */
};
#endif /* !RECLS_PURE_API */

/* 
 * Namespace
 */

#if !defined(RECLS_NO_NAMESPACE)
} /* namespace recls */
#endif /* !RECLS_NO_NAMESPACE */

/* 

#endif /* !RECLS_INCL_H_RECLS_PLATFORM_TYPES */

/* 

recls Library documentation © Synesis Software Pty Ltd, 2001-2005