apicompatanamdw/compatanalysercmd/headeranalyser/src/Issues.h
author shrivatsa
Mon, 27 Sep 2010 14:51:17 +0530
changeset 12 a0eee409ff14
parent 0 638b9c697799
permissions -rw-r--r--
Updates to CompatibilityAnalyser - The Tool should now work with Symbian^4 - Some minor bug fixes related to Qt headers in the Symbian Platform
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
     1
/*
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
     2
* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies). 
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
     3
* All rights reserved.
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
     4
* This component and the accompanying materials are made available
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
     6
* which accompanies this distribution, and is available
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
     8
*
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
     9
* Initial Contributors:
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    11
*
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    12
* Contributors:
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    13
*
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    14
* Description:  
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    15
*
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    16
*/
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    17
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    18
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    19
#ifndef __ISSUES_H_
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    20
#define __ISSUES_H_
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    21
#include "CmdGlobals.h"
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    22
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    23
#include <xercesc/dom/DOM.hpp>
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    24
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    25
XERCES_CPP_NAMESPACE_USE
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    26
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    27
#include "ReportIssue.h"
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    28
class HANodeIterator;
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    29
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    30
template <TIssueIdentity Identity,TIssueType IssueType>
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    31
string ignoreInfo(const HANodeIterator& baseline,const HANodeIterator& current);	
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    32
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    33
/**
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    34
* In the following the severities and ignore information of issues are defined 
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    35
* through template mechanism. This allows linking time checking that we have 
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    36
* not forgot to define meaningful information for new issues. In order to modify
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    37
* severity information or ignore information first determine the TIssueIdentity
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    38
* and TIssueType /of the issue and then find the correct function 
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    39
* (BCseverityAccessible<TIssueIdentity,TIssueType> and 
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    40
* ignoreInfo<TIssueIdentity,TIssueType>) and modify the function definition to 
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    41
* match with the severity and ignore information.
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    42
*
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    43
* @param accessible that defines if the element is directly accessible
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    44
*                   or only through some inline method
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    45
* @return severity level of the issue
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    46
*/
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    47
template <TIssueIdentity Identity,TIssueType IssueType>
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    48
TBCSeverity BCseverityAccessible(bool accessible);
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    49
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    50
/**
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    51
* In the following the severities and ignore information of issues are defined 
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    52
* through template mechanism. This allows linking time checking that we have 
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    53
* not forgot to define meaningful information for new issues. In order to modify
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    54
* severity information or ignore information first determine the TIssueIdentity
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    55
* and TIssueType /of the issue and then find the correct function 
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    56
* (SCseverityAccessible<TIssueIdentity,TIssueType> and 
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    57
* ignoreInfo<TIssueIdentity,TIssueType>) and modify the function definition to 
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    58
* match with the severity and ignore information.
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    59
*
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    60
* @param accessible that defines if the element is directly accessible
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    61
*                   or only through some inline method
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    62
* @return scseverity level of the issue
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    63
*/
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    64
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    65
template <TIssueIdentity Identity,TIssueType IssueType>
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    66
TSCSeverity SCseverityAccessible(bool accessible);
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    67
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    68
/**
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    69
* Return binary compatibility severity description
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    70
*/
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    71
extern const char* KSeverityDesc[ESeverityCount];
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    72
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    73
/**
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    74
* Return source compatibility severity description
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    75
*/
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    76
extern const char* KSeveritySCDesc[ESeveritySCCount];
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    77
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    78
/**
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    79
* Return identity description
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    80
*/
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    81
extern const char* KIssueIdentityDesc[EIssueIdentityCount];
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    82
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    83
/**
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    84
* Return type description. Issue is removal, addition, change,
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    85
* access, inheritance,etc.
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    86
*/
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    87
extern const char* KIssueTypeDesc[EIssueTypeCount];
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    88
638b9c697799 1. Licenses updated to EPL.
noe\swadi
parents:
diff changeset
    89
#endif