Event_Manager_Defines.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Event_Manager_Defines.h
//! @brief      Event manager defines header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Engine/Event_Manager_Defines.h $
//!             $Revision: 2076 $
//!             $Date: 2020-09-12 20:30:44 +0500 (Sa, 12 Sep 2020) $
//!             $Author: minch $
//------------------------------------------------------------------------------
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. 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.
//
// 3. Neither the name of ANVILEX nor the names of its 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 HOLDER 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.
//
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// System includes
//------------------------------------------------------------------------------
 
#include "Defines.h"
 
//------------------------------------------------------------------------------
// Global macro definitions
//------------------------------------------------------------------------------
 
//! @brief Event descriptor memory mapping attribute definition
#define EVENT_DESCRIPTOR_DATABASE __attribute__( ( section ( "EVENT_DESCRIPTOR_DATABASE" ) ) )
 
//------------------------------------------------------------------------------
// Global type definitions
//------------------------------------------------------------------------------
 
//! @brief Event description structure with language index
typedef struct
{
 
  //! @brief Two character language code according ISO 639-1
  union
  {
 
    //! @brief Language code as 2 character ISO code string
    C8 c8_Index[ 2 ];
 
    //! @brief Language code represented as U16
    U16 u16_Index;
 
  } struct_Language;
 
  //! @brief Description text format
  TText_Encoding enum_Encoding;
 
  //! @brief Pointer to the event description string
  C8* pc8_Description_Text;
 
} TEvent_Description_Descriptor;
 
//------------------------------------------------------------------------------
 
//!< Event descriptor structure
typedef struct
{
 
  //! @brief Event ID
  U64 u64_ID;
 
  //! @brief Pointer to the description string
  TEvent_Description_Descriptor *struct_Description;
 
} TEvent_Descriptor;
 
//------------------------------------------------------------------------------
 
//! @brief Event code descriptor structure. Will be depricated in the future.
typedef struct
{
 
  //! @brief Event code
  U32 u32_Event_Code;
 
  //! @brief Pointer to event code description
  C8 *pc8_Event_Code_Description;
 
} TEvent_Code_Descriptor;
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------