cmnconf.h

彩信MMS的全部代码

/*
 * Copyright (C) Obigo AB, 2002-2005.
 * All rights reserved.
 *
 * This software is covered by the license agreement between
 * the end user and Obigo AB, and may be 
 * used and copied only in accordance with the terms of the 
 * said agreement.
 *
 * Obigo AB assumes no responsibility or 
 * liability for any errors or inaccuracies in this software, 
 * or any consequential, incidental or indirect damage arising
 * out of the use of the software.
 *
 */

/******************************************************************************
 * File:            $Workfile:   cmnconf.h  $
 *
 * Date:            $Date: 2005-01-20 06:58:50 GMT $
 *
 * Revision:        $Revision: \main\47 $
 *
 *****************************************************************************/

/*! \file cmnconf.h
 *  \brief  Configuration variables for common utilities
 */

#ifndef _CMNCONF_H
#define _CMNCONF_H

/* 
 * Change, comment or uncomment the defines below in order to change the 
 * behaviour and/or functionality of the Common Module.
 */

/*--- Definitions/Declarations ---*/

/*
 * Memory handling configuration
 */

/*! If defined, the internal memory allocator will be used. */
#define USE_G_MALLOC

/*
 * Defines for logging
 */
/*! This turns on or off external logging within the Common Module. external 
 *  logging means that all calls to connecor and adapter functions are logged. 
 *  Remove the definition if no logging is wanted. This should ALWAYS be 
 *  turned off before releasing the product!
 */
#define CMN_LOG_EXTERNAL    1

/*! This turns on or off internal logging within the Common Module. Internal 
 *  logging means that additional debug information is logged. Remove the 
 *  definition if no logging is wanted. This should ALWAYS be turned off 
 *  before releasing the product!
 */
#define CMN_LOG_INTERNAL    1

/*! Only valid when #USE_G_MALLOC and #CMN_LOG_INTERNAL are used.
 *
 *  This turns on or off internal logging of memory operations. Remove the 
 *  definition if no logging is wanted. This should ALWAYS be turned off 
 *  before releasing the product!
 *
 *  When memory logging is enabled, you MUST rebuild ALL files 
 *  (i.e. common.lib, mms.lib, whatever.lib, ...) and other libs used 
 *  in the executable.
 */
#define CMN_LOG_MEMORY      1

/*! Category for files containing messages and folders,
 *  see also #CmnClientId.
 */
#define CMN_FILE_CATEGORY_MSG   ((char)'F')

/*! Category for temporary files used to interchange data larger than 
 *  MMS_MAX_CHUNK_SIZE between the MMS Client and the MMS Application.
 *  The file id 0 (zero) is used by the MMS Client and the MMS Application is 
 *  not allowed to use this file in any way.
 */
#define CMN_FILE_CATEGORY_TMP   ((char)'M')

/*! The maximum number of folders that one single application can have in the 
 *  Common Module.
 */
#define CMN_MAX_FOLDERS         1000

/*! The maximum number of messages, notifications, read reports that all 
 *  applications together can have in the Common Module.
 */
#define CMN_MAX_NO_OF_MESSAGES  100

/* The following definitions are used to determine operations that will
 * cause the folder manager to save the MMS Index File to persistent storage.
 * If a specific operation should cause the file to be written, assure that 
 * it is defined to 1. Otherwise, assure that it is defined to 0. Saving the
 * index file too often can cause much overhead. The index file is always saved
 * during normal termination of the software.
 */
#define CMN_INDEX_SAVE_CREATE   1   /*!< Save index file when msg is created */
#define CMN_INDEX_SAVE_DELETE   1   /*!< Save index file when msg is deleted */
#define CMN_INDEX_SAVE_MOVE     1   /*!< Save index file when msg is moved */
#define CMN_INDEX_SAVE_SET_DATE 0   /*!< Save index file when msg date is set */
#define CMN_INDEX_SAVE_SET_FLAG 0   /*!< Save index file when msg flag is set */
#define CMN_INDEX_SAVE_SET_READ 0   /*!< Save index file when msg is set as read */

/*! This definition determines if the backup copy of the index file is saved at 
 * every occasion when the index file is saved. If not definied, the backup 
 * copy will only be written when the MMS Client is stopped in a normal way.
 */
#define CMN_INDEX_ALWAYS_SAVE_BACKUP   1

/*! This definition determines if the index table is created as 'static' 
 *  or as a dynamically allocated array. If definied, the table must be 
 *  allocated in dynamic memory. Otherwise the table is static. Please note,
 *  the configuration setting for the size of the dynamic memory must be 
 *  increased if not using 'static'.
 */
#undef CMN_INDEX_DYNAMIC

/*--- Types ---*/

/* Every client using functions in the Common Module must be 
 * defined in this way. The value is used to distinguish between
 * shared resourses like folders and memory. The value must be a UINT8, as 
 * #CmnClientId
 */
#define CMN_CLIENT_MMS      (UINT8)0    /*!< Multimedia Messaging System */
    /* Add new clients here and increase counter below. */
#define CMN_CLIENT_NUMBER   1           /*!< Number of clients defined above */

#endif /* _CMNCONF_H */