include/alp/hs_common.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright (c) 1999-2008 ACCESS CO., LTD. All rights reserved.
 * Copyright (c) 2006 PalmSource, Inc (an ACCESS company). All rights reserved.
 *****************************************************************************/
#if PRAGMA_ONCE
#pragma once
#endif

#ifndef _HS_COMMON_H_
#define _HS_COMMON_H_


#ifdef WIN32
#include <stdlib.h>
#include <tchar.h>
#define PATH_MAX _MAX_PATH
#else
#include <limits.h>
#define _TCHAR char
#define _T(x) x
#endif
#include <alp/hs_status.h>
#include <alp/hs_id_mgr.h>


#ifdef __cplusplus
extern "C" {
#endif

/*****************************************************************************
* Defines
*****************************************************************************/
#define ALP_HS_URI_SIZE             255
#define ALP_HS_AGENT_ID_SIZE        127
#define ALP_HS_MIME_TYPE_SIZE       255
#define ALP_HS_MIME_VERSION_SIZE    127

#define ALP_HS_COMPARATOR_ID_SIZE   127

#define ALP_HS_COMPARATOR_NAME_SIZE 31

#define ALP_HS_NODE_NAME_SIZE        127


#define ALP_HS_DEFAULT_NODE_NAME            _T("local")
#define ALP_HS_DEFAULT_DESKTOP_NODE_NAME        _T("com.access-company.access desktop")

#define ALP_HS_EXT_COMPONENT_SIZE    4

// @}

/*****************************************************************************
* Enums
*****************************************************************************/
typedef enum _AlpHsObjectState {
    kObjectStateModified  = 1,
    kObjectStateDeleted   = 2,
    kObjectStateArchived  = 3,
    kObjectStateNew       = 4,
    kObjectStateEnumLimit = 5
} AlpHsObjectState;

typedef enum _AlpHsSupportedDbType {
    kDbTypeUnsupported = 0,
    kDbTypeSQLite      = 1,
    kDbTypeEnumLimit   = 2
} AlpHsSupportedDbType;

typedef enum _AlpHsChangeMgrType
{
    kChMgrTypeInvalid   = 0,
    kChMgrTypeHotsync   = 1,
    kChMgrTypeExternal  = 2,
    kChMgrTypeEnumLimit = 3,
} AlpHsChangeMgrType;

typedef enum _AlpHsObjectComparatorType {
    kComparatorTypeInvalid   = 0,
    kComparatorTypeExternal  = 1,
    kComparatorTypeCanonical = 2,
    kComparatorTypeInternal  = 3,
    kComparatorTypeEnumLimit = 4
} AlpHsObjectComparatorType;

typedef enum _AlpHsDataStoreVersionType {
    kVersionTypeCapabilities  = 1,
    kVersionTypeStringTable   = 2,
    kVersionTypeEnumLimit     = 3
} AlpHsDataStoreVersionType;

/*****************************************************************************
* Typedefs
*****************************************************************************/
#ifdef WIN32
#define ALP_HS_APPID_DATACHANGE_NOTIFICATION _T("/alp/datamodel")
#else
#define ALP_HS_APPID_DATACHANGE_NOTIFICATION "/alp/datamodel"
#endif

// typedef AlpHsObjectState AlpDatamodelChangeType;
typedef struct _AlpDatamodelChangeData AlpDatamodelChangeData;
typedef AlpDatamodelChangeData* AlpDatamodelChangeDataPtr;
struct _AlpDatamodelChangeData
{
        int                                                                                     notificationId;
        
    _TCHAR                                                      last32bytesOfLocURI  [33]; 
        AlpHsObjectState/*AlpDatamodelChangeType*/      changeType;

        AlpLuid                                                                         luid;      
};

typedef void*   AlpHsChangeMgrHandle;  /* really a ChangeMgr ptr */
typedef void*   AlpHsDbPtr;            /* really a Database ptr */
typedef struct  _AlpHsDataStoreRegistration AlpHsDataStoreRegistration;
typedef AlpHsDataStoreRegistration* AlpHsDataStoreRegistrationPtr;
struct  _AlpHsDataStoreRegistration {
    _TCHAR                  locURI  [ALP_HS_URI_SIZE];
    _TCHAR                  tgtURI  [ALP_HS_URI_SIZE];
    _TCHAR                  agentId [ALP_HS_AGENT_ID_SIZE];
    _TCHAR                  location[PATH_MAX];
    AlpHsSupportedDbType    dbType;
    AlpHsChangeMgrType      chMgrType;
    int                     maxExtIDLen;

    _TCHAR                                      notifyType[ALP_HS_URI_SIZE];
        
        _TCHAR                                  nodeName[ALP_HS_NODE_NAME_SIZE];
    bool                    isPrimary;
};
typedef struct _AlpHsObjectType AlpHsObjectType;
typedef AlpHsObjectType* AlpHsObjectTypePtr;
struct _AlpHsObjectType {
    uint32_t    reserved;
    _TCHAR      mimeType   [ALP_HS_MIME_TYPE_SIZE];
    _TCHAR      mimeVersion[ALP_HS_MIME_VERSION_SIZE];
};

typedef struct  _AlpHsObjectComparatorInfo AlpHsObjectComparatorInfo;
typedef AlpHsObjectComparatorInfo* AlpHsObjectComparatorInfoPtr;
struct _AlpHsObjectComparatorInfo {
    _TCHAR                      id          [ALP_HS_COMPARATOR_ID_SIZE];   
    uint32_t                    version;                                   
    _TCHAR                      name        [ALP_HS_COMPARATOR_NAME_SIZE]; 
    AlpHsObjectComparatorType   cmpType;                                   
    AlpHsObjectType             objType;                                   
    _TCHAR                      tgtURI      [ALP_HS_URI_SIZE];             
    uint32_t                    userId;                                    
};

typedef alp_status_t (*AlpHsObjectComparatorFnPtr)(void*    pContext,
                                                  const _TCHAR*   mimeType,
                                                  const _TCHAR*   mimeVersion,
                                                  const _TCHAR*   targetURI,
                                                  uint16_t  size1,
                                                  const _TCHAR*   buffer1,
                                                  uint16_t  size2,
                                                  const _TCHAR*   buffer2,
                                                  int*      result);

typedef struct _AlpHsExternalID
{
  void* external_id;    
  int16_t buff_size;    
  int16_t id_size;      
} AlpHsExternalID;

typedef struct _AlpHsExternalObject AlpHsExternalObject;
typedef AlpHsExternalObject* AlpHsExternalObjectPtr;
struct _AlpHsExternalObject
{
    AlpHsObjectState   state;  
    AlpHsExternalID    externalId;
    int                componentExtIdSize;                         
    AlpHsExternalID    componentExtIds[ALP_HS_EXT_COMPONENT_SIZE]; 
};


typedef void*   AlpHsDataStoreHandle;
typedef void*   AlpHsDbHandle;



#ifdef __cplusplus
}
#endif

#endif // _HS_COMMON_H_

---

Generated on Wed Jul 30 07:06:39 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.