1 /*

     2 * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies). 

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  

    15 *

    16 */

    17 

    18 

    19 #ifndef __ISSUES_H_

    20 #define __ISSUES_H_

    21 #include "CmdGlobals.h"

    22 

    23 #include <xercesc/dom/DOM.hpp>

    24 

    25 XERCES_CPP_NAMESPACE_USE

    26 

    27 #include "ReportIssue.h"

    28 class HANodeIterator;

    29 

    30 template <TIssueIdentity Identity,TIssueType IssueType>

    31 string ignoreInfo(const HANodeIterator& baseline,const HANodeIterator& current);	

    32 

    33 /**

    34 * In the following the severities and ignore information of issues are defined 

    35 * through template mechanism. This allows linking time checking that we have 

    36 * not forgot to define meaningful information for new issues. In order to modify

    37 * severity information or ignore information first determine the TIssueIdentity

    38 * and TIssueType /of the issue and then find the correct function 

    39 * (BCseverityAccessible<TIssueIdentity,TIssueType> and 

    40 * ignoreInfo<TIssueIdentity,TIssueType>) and modify the function definition to 

    41 * match with the severity and ignore information.

    42 *

    43 * @param accessible that defines if the element is directly accessible

    44 *                   or only through some inline method

    45 * @return severity level of the issue

    46 */

    47 template <TIssueIdentity Identity,TIssueType IssueType>

    48 TBCSeverity BCseverityAccessible(bool accessible);

    49 

    50 /**

    51 * In the following the severities and ignore information of issues are defined 

    52 * through template mechanism. This allows linking time checking that we have 

    53 * not forgot to define meaningful information for new issues. In order to modify

    54 * severity information or ignore information first determine the TIssueIdentity

    55 * and TIssueType /of the issue and then find the correct function 

    56 * (SCseverityAccessible<TIssueIdentity,TIssueType> and 

    57 * ignoreInfo<TIssueIdentity,TIssueType>) and modify the function definition to 

    58 * match with the severity and ignore information.

    59 *

    60 * @param accessible that defines if the element is directly accessible

    61 *                   or only through some inline method

    62 * @return scseverity level of the issue

    63 */

    64 

    65 template <TIssueIdentity Identity,TIssueType IssueType>

    66 TSCSeverity SCseverityAccessible(bool accessible);

    67 

    68 /**

    69 * Return binary compatibility severity description

    70 */

    71 extern const char* KSeverityDesc[ESeverityCount];

    72 

    73 /**

    74 * Return source compatibility severity description

    75 */

    76 extern const char* KSeveritySCDesc[ESeveritySCCount];

    77 

    78 /**

    79 * Return identity description

    80 */

    81 extern const char* KIssueIdentityDesc[EIssueIdentityCount];

    82 

    83 /**

    84 * Return type description. Issue is removal, addition, change,

    85 * access, inheritance,etc.

    86 */

    87 extern const char* KIssueTypeDesc[EIssueTypeCount];

    88 

    89 #endif