types.h

Go to the documentation of this file.

/* $Id: types.h 4359 2013-02-21 11:18:36Z bennylp $ */
/* 
 * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
 * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 */
#ifndef __PJ_TYPES_H__
#define __PJ_TYPES_H__


#include <pj/config.h>

PJ_BEGIN_DECL

/* ************************************************************************* */

typedef int             pj_int32_t;

typedef unsigned int    pj_uint32_t;

typedef short           pj_int16_t;

typedef unsigned short  pj_uint16_t;

typedef signed char     pj_int8_t;

typedef unsigned char   pj_uint8_t;

typedef size_t          pj_size_t;

typedef long            pj_ssize_t;

typedef int             pj_status_t;

typedef int             pj_bool_t;

#if defined(PJ_NATIVE_STRING_IS_UNICODE) && PJ_NATIVE_STRING_IS_UNICODE!=0
    typedef wchar_t pj_char_t;
#else
    typedef char pj_char_t;
#endif

#if defined(PJ_NATIVE_STRING_IS_UNICODE) && PJ_NATIVE_STRING_IS_UNICODE!=0
#   define PJ_T(literal_str)    L##literal_str
#else
#   define PJ_T(literal_str)    literal_str
#endif


#define PJ_SUCCESS  0

#define PJ_TRUE     1

#define PJ_FALSE    0

#if defined(PJ_HAS_INT64) && PJ_HAS_INT64!=0
typedef pj_int64_t pj_off_t;
#else
typedef pj_ssize_t pj_off_t;
#endif

/* ************************************************************************* */
/*
 * Data structure types.
 */
struct pj_str_t
{
    char       *ptr;

    pj_ssize_t  slen;
};

typedef union pj_timestamp
{
    struct
    {
#if defined(PJ_IS_LITTLE_ENDIAN) && PJ_IS_LITTLE_ENDIAN!=0
        pj_uint32_t lo;     
        pj_uint32_t hi;     
#else
        pj_uint32_t hi;     
        pj_uint32_t lo;     
#endif
    } u32;                  
#if PJ_HAS_INT64
    pj_uint64_t u64;        
#endif
} pj_timestamp;



typedef void pj_list_type;

typedef struct pj_list pj_list;

typedef struct pj_hash_table_t pj_hash_table_t;

typedef struct pj_hash_entry pj_hash_entry;

typedef struct pj_hash_iterator_t
{
    pj_uint32_t      index;     
    pj_hash_entry   *entry;     
} pj_hash_iterator_t;


typedef struct pj_pool_factory pj_pool_factory;

typedef struct pj_pool_t pj_pool_t;

typedef struct pj_caching_pool pj_caching_pool;

typedef struct pj_str_t pj_str_t;

typedef struct pj_ioqueue_t pj_ioqueue_t;

typedef struct pj_ioqueue_key_t pj_ioqueue_key_t;

typedef struct pj_timer_heap_t pj_timer_heap_t;

typedef struct pj_atomic_t pj_atomic_t;

typedef PJ_ATOMIC_VALUE_TYPE pj_atomic_value_t;
 
/* ************************************************************************* */

typedef struct pj_thread_t pj_thread_t;

typedef struct pj_lock_t pj_lock_t;

typedef struct pj_grp_lock_t pj_grp_lock_t;

typedef struct pj_mutex_t pj_mutex_t;

typedef struct pj_sem_t pj_sem_t;

typedef struct pj_event_t pj_event_t;

typedef struct pj_pipe_t pj_pipe_t;

typedef void *pj_oshandle_t;

typedef long pj_sock_t;

typedef void pj_sockaddr_t;

typedef struct pj_sockaddr_in pj_sockaddr_in;

typedef unsigned int pj_color_t;

typedef int pj_exception_id_t;

/* ************************************************************************* */

#define PJ_ARRAY_SIZE(a)    (sizeof(a)/sizeof(a[0]))

#define PJ_MAXINT32  0x7FFFFFFFL

#define PJ_MAX_OBJ_NAME 32

/* ************************************************************************* */
/*
 * General.
 */
PJ_DECL(pj_status_t) pj_init(void);


PJ_DECL(void) pj_shutdown(void);

typedef void (*pj_exit_callback)(void);

PJ_DECL(pj_status_t) pj_atexit(pj_exit_callback func);



PJ_INLINE(pj_int16_t) pj_swap16(pj_int16_t val16)
{
    pj_uint8_t *p = (pj_uint8_t*)&val16;
    pj_uint8_t tmp = *p;
    *p = *(p+1);
    *(p+1) = tmp;
    return val16;
}

PJ_INLINE(pj_int32_t) pj_swap32(pj_int32_t val32)
{
    pj_uint8_t *p = (pj_uint8_t*)&val32;
    pj_uint8_t tmp = *p;
    *p = *(p+3);
    *(p+3) = tmp;
    tmp = *(p+1);
    *(p+1) = *(p+2);
    *(p+2) = tmp;
    return val32;
}


typedef struct pj_time_val
{
    long    sec;

    long    msec;

} pj_time_val;

PJ_DECL(void) pj_time_val_normalize(pj_time_val *t);

#define PJ_TIME_VAL_MSEC(t)     ((t).sec * 1000 + (t).msec)

#define PJ_TIME_VAL_EQ(t1, t2)  ((t1).sec==(t2).sec && (t1).msec==(t2).msec)

#define PJ_TIME_VAL_GT(t1, t2)  ((t1).sec>(t2).sec || \
                                ((t1).sec==(t2).sec && (t1).msec>(t2).msec))

#define PJ_TIME_VAL_GTE(t1, t2) (PJ_TIME_VAL_GT(t1,t2) || \
                                 PJ_TIME_VAL_EQ(t1,t2))

#define PJ_TIME_VAL_LT(t1, t2)  (!(PJ_TIME_VAL_GTE(t1,t2)))

#define PJ_TIME_VAL_LTE(t1, t2) (!PJ_TIME_VAL_GT(t1, t2))

#define PJ_TIME_VAL_ADD(t1, t2)     do {                            \
                                        (t1).sec += (t2).sec;       \
                                        (t1).msec += (t2).msec;     \
                                        pj_time_val_normalize(&(t1)); \
                                    } while (0)


#define PJ_TIME_VAL_SUB(t1, t2)     do {                            \
                                        (t1).sec -= (t2).sec;       \
                                        (t1).msec -= (t2).msec;     \
                                        pj_time_val_normalize(&(t1)); \
                                    } while (0)


typedef struct pj_parsed_time
{
    int wday;

    /* This represents day of the year, 0-365, where zero means
     *  1st of January.
     */
    /*int yday; */

    int day;

    int mon;

    int year;

    int sec;

    int min;

    int hour;

    int msec;

} pj_parsed_time;


/* ************************************************************************* */
/*
 * Terminal.
 */
enum {
    PJ_TERM_COLOR_R     = 2,    
    PJ_TERM_COLOR_G     = 4,    
    PJ_TERM_COLOR_B     = 1,    
    PJ_TERM_COLOR_BRIGHT = 8    
};




PJ_END_DECL


#endif /* __PJ_TYPES_H__ */