eu.cqse.check.util.clang.misra

Enum EEssentialType

java.lang.Object

java.lang.Enum<EEssentialType>

eu.cqse.check.util.clang.misra.EEssentialType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EEssentialType>

public enum EEssentialType
extends java.lang.Enum<EEssentialType>

Enumeration of the essential types defined by MISRA C2012 Section D.1 The essential-type concept in MISRA is a simplification of the C type system used in the definition of several misra guidelines. It does not apply to C++, only to C (MISRA Cpp2008 defines a different concept of "underlying types" which seems to be incompatible). Do not modify the items of this enum. They are copied verbatim from the MISRA definition. The ordering of the types is important (defines the rank and width of the types in the same category).

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOOL
CHAR
DOUBLE
FLOAT
LONG_DOUBLE
NAMED_ENUM All instances of NAMED_ENUM are considered different (MISRA C2012 D.5).
SIGNED_CHAR
SIGNED_INT
SIGNED_LONG
SIGNED_LONG_LONG
SIGNED_SHORT
UNSIGNED_CHAR
UNSIGNED_INT
UNSIGNED_LONG
UNSIGNED_LONG_LONG
UNSIGNED_SHORT

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<EEssentialType>	fromClangResolvedType(eu.cqse.clang.CXType resolvedType) Returns the EEssentialType of the given CXType.
EEssentialTypeCategory	getCategory() Category of this essential type (defined in Misra C:2012)
static java.util.Optional<EEssentialType>	getEssentialTypeOfCursor(eu.cqse.clang.CXCursor cursor) Determines the essential type of the given Cursor.
static EEssentialType	getHighestRankType(EEssentialType type1, EEssentialType type2) Returns the highest-ranking type (and widest) of the given types.
boolean	isWiderThan(EEssentialType other) Returns whether this essential type is wider (needs more bits to be stored) than the given type.
static EEssentialType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EEssentialType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BOOL

public static final EEssentialType BOOL

CHAR

public static final EEssentialType CHAR

SIGNED_CHAR

public static final EEssentialType SIGNED_CHAR

SIGNED_SHORT

public static final EEssentialType SIGNED_SHORT

SIGNED_INT

public static final EEssentialType SIGNED_INT

SIGNED_LONG

public static final EEssentialType SIGNED_LONG

SIGNED_LONG_LONG

public static final EEssentialType SIGNED_LONG_LONG

UNSIGNED_CHAR

public static final EEssentialType UNSIGNED_CHAR

UNSIGNED_SHORT

public static final EEssentialType UNSIGNED_SHORT

UNSIGNED_INT

public static final EEssentialType UNSIGNED_INT

UNSIGNED_LONG

public static final EEssentialType UNSIGNED_LONG

UNSIGNED_LONG_LONG

public static final EEssentialType UNSIGNED_LONG_LONG

NAMED_ENUM

public static final EEssentialType NAMED_ENUM

All instances of NAMED_ENUM are considered different (MISRA C2012 D.5).

FLOAT

public static final EEssentialType FLOAT

DOUBLE

public static final EEssentialType DOUBLE

LONG_DOUBLE

public static final EEssentialType LONG_DOUBLE

Method Detail

values

public static EEssentialType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EEssentialType c : EEssentialType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EEssentialType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getHighestRankType

public static EEssentialType getHighestRankType(EEssentialType type1,
                                                EEssentialType type2)

Returns the highest-ranking type (and widest) of the given types. The given types must be of the same essential-type category.

getEssentialTypeOfCursor

public static java.util.Optional<EEssentialType> getEssentialTypeOfCursor(eu.cqse.clang.CXCursor cursor)

Determines the essential type of the given Cursor.

This implementation is based on Section D of Misra C2012.

fromClangResolvedType

public static java.util.Optional<EEssentialType> fromClangResolvedType(eu.cqse.clang.CXType resolvedType)

Returns the EEssentialType of the given CXType. This can't be done with valueOf(String) since we can't be sure that types in Clang are named identical to the essential-type names in Misra.

isWiderThan

public boolean isWiderThan(EEssentialType other)

Returns whether this essential type is wider (needs more bits to be stored) than the given type.

getCategory

public EEssentialTypeCategory getCategory()

Category of this essential type (defined in Misra C:2012)